fix: update types, add tests, and cleanup [DX-397] (#2755)

Author: whitelisab

lib/adapters/REST/endpoints/entry.ts

@@ -5,30 +5,25 @@ import type { OpPatch } from 'json-patch'
 import type { SetOptional } from 'type-fest'
 import type {
   CollectionProp,
-  GetEntryParams,
-  GetManyEntryParams,
+  CreateReleaseEntryParams,
   CreateWithIdReleaseEntryParams,
+  GetManyReleaseEntryParams,
+  GetReleaseEntryParams,
   GetSpaceEnvironmentParams,
   KeyValueMap,
-  PatchEntryParams,
   PatchReleaseEntryParams,
   QueryParams,
-  UpdateEntryParams,
   UpdateReleaseEntryParams,
-  CreateReleaseEntryParams,
-  GetManyReleaseEntryParams,
-  GetReleaseEntryParams,
 } from '../../../common-types'
 import type { CreateEntryProps, EntryProps, EntryReferenceProps } from '../../../entities/entry'
 import type { RestEndpoint } from '../types'
 import * as raw from './raw'
-import { createWithId as createWithIdReleaseEntry } from './release-entry'
-import { normalizeSelect } from './utils'
 import * as releaseEntry from './release-entry'
+import { normalizeSelect } from './utils'
 
 export const get: RestEndpoint<'Entry', 'get'> = <T extends KeyValueMap = KeyValueMap>(
   http: AxiosInstance,
-  params: GetEntryParams & QueryParams & { releaseId?: string },
+  params: GetSpaceEnvironmentParams & { entryId: string; releaseId?: string } & QueryParams,
   rawData?: unknown,
   headers?: RawAxiosRequestHeaders
 ) => {
@@ -66,7 +61,7 @@ export const getPublished: RestEndpoint<'Entry', 'getPublished'> = <
 
 export const getMany: RestEndpoint<'Entry', 'getMany'> = <T extends KeyValueMap = KeyValueMap>(
   http: AxiosInstance,
-  params: GetManyEntryParams & QueryParams & { releaseId?: string },
+  params: GetSpaceEnvironmentParams & QueryParams & { releaseId?: string },
   rawData?: unknown,
   headers?: RawAxiosRequestHeaders
 ) => {
@@ -86,7 +81,7 @@ export const getMany: RestEndpoint<'Entry', 'getMany'> = <T extends KeyValueMap
 
 export const patch: RestEndpoint<'Entry', 'patch'> = <T extends KeyValueMap = KeyValueMap>(
   http: AxiosInstance,
-  params: PatchEntryParams & QueryParams,
+  params: GetSpaceEnvironmentParams & { entryId: string; version: number; releaseId?: string },
   data: OpPatch[],
   headers?: RawAxiosRequestHeaders
 ) => {
@@ -110,7 +105,7 @@ export const patch: RestEndpoint<'Entry', 'patch'> = <T extends KeyValueMap = Ke
 
 export const update: RestEndpoint<'Entry', 'update'> = <T extends KeyValueMap = KeyValueMap>(
   http: AxiosInstance,
-  params: UpdateEntryParams & QueryParams,
+  params: GetSpaceEnvironmentParams & { entryId: string; releaseId?: string },
   rawData: EntryProps<T>,
   headers?: RawAxiosRequestHeaders
 ) => {
@@ -209,7 +204,7 @@ export const unarchive: RestEndpoint<'Entry', 'unarchive'> = <T extends KeyValue
 
 export const create: RestEndpoint<'Entry', 'create'> = <T extends KeyValueMap = KeyValueMap>(
   http: AxiosInstance,
-  params: GetSpaceEnvironmentParams & { contentTypeId: string; releaseId?: string } & QueryParams,
+  params: GetSpaceEnvironmentParams & { contentTypeId: string; releaseId?: string },
   rawData: CreateEntryProps<T>
 ) => {
   if (params.releaseId) {
@@ -242,21 +237,20 @@ export const createWithId: RestEndpoint<'Entry', 'createWithId'> = <
   rawData: CreateEntryProps<T>
 ) => {
   if (params.releaseId) {
-    return createWithIdReleaseEntry(http, params as CreateWithIdReleaseEntryParams, rawData, {})
-  } else {
-    const data = copy(rawData)
-
-    return raw.put<EntryProps<T>>(
-      http,
-      `/spaces/${params.spaceId}/environments/${params.environmentId}/entries/${params.entryId}`,
-      data,
-      {
-        headers: {
-          'X-Contentful-Content-Type': params.contentTypeId,
-        },
-      }
-    )
+    return releaseEntry.createWithId(http, params as CreateWithIdReleaseEntryParams, rawData, {})
   }
+  const data = copy(rawData)
+
+  return raw.put<EntryProps<T>>(
+    http,
+    `/spaces/${params.spaceId}/environments/${params.environmentId}/entries/${params.entryId}`,
+    data,
+    {
+      headers: {
+        'X-Contentful-Content-Type': params.contentTypeId,
+      },
+    }
+  )
 }
 
 export const references: RestEndpoint<'Entry', 'references'> = (

lib/adapters/REST/endpoints/release-asset.ts

@@ -1,29 +1,29 @@
+import type { RawAxiosRequestHeaders } from 'axios'
 import { errorHandler, type AxiosInstance } from 'contentful-sdk-core'
+import copy from 'fast-copy'
+import type { SetOptional } from 'type-fest'
 import type {
+  CollectionProp,
   CreateReleaseAssetParams,
-  GetReleaseAssetParams,
+  CreateWithFilesReleaseAssetParams,
+  CreateWithIdReleaseAssetParams,
   GetManyReleaseAssetParams,
-  QueryParams,
-  UpdateReleaseAssetParams,
+  GetReleaseAssetParams,
   Link,
-  CollectionProp,
-  CreateWithIdReleaseAssetParams,
-  CreateWithFilesReleaseAssetParams,
-  ProcessForLocaleReleaseAssetParams,
   ProcessForAllLocalesReleaseAssetParams,
+  ProcessForLocaleReleaseAssetParams,
+  QueryParams,
+  UpdateReleaseAssetParams,
 } from '../../../common-types'
 import type {
-  CreateAssetProps,
-  AssetProps,
   AssetFileProp,
   AssetProcessingForLocale,
+  AssetProps,
+  CreateAssetProps,
 } from '../../../entities/asset'
-import copy from 'fast-copy'
+import { getUploadHttpClient } from '../../../upload-http-client'
 import type { RestEndpoint } from '../types'
 import * as raw from './raw'
-import type { RawAxiosRequestHeaders } from 'axios'
-import type { SetOptional } from 'type-fest'
-import { getUploadHttpClient } from '../../../upload-http-client'
 import { create as createUpload } from './upload'
 import { normalizeSelect } from './utils'
 

lib/adapters/REST/endpoints/release-entry.ts

@@ -1,34 +1,34 @@
+import type { RawAxiosRequestHeaders } from 'axios'
 import type { AxiosInstance } from 'contentful-sdk-core'
+import copy from 'fast-copy'
+import type { OpPatch } from 'json-patch'
+import type { SetOptional } from 'type-fest'
 import type {
+  CollectionProp,
   CreateReleaseEntryParams,
-  GetReleaseEntryParams,
+  CreateWithIdReleaseEntryParams,
   GetManyReleaseEntryParams,
+  GetReleaseEntryParams,
   KeyValueMap,
+  Link,
   PatchReleaseEntryParams,
   QueryParams,
   UpdateReleaseEntryParams,
-  CreateWithIdReleaseEntryParams,
-  Link,
-  CollectionProp,
 } from '../../../common-types'
 import type { CreateEntryProps, EntryProps } from '../../../entities/entry'
-import copy from 'fast-copy'
 import type { RestEndpoint } from '../types'
 import * as raw from './raw'
-import type { RawAxiosRequestHeaders } from 'axios'
-import type { SetOptional } from 'type-fest'
-import type { OpPatch } from 'json-patch'
 import { normalizeSelect } from './utils'
 
-type ReleaseEntryProps = EntryProps<unknown, { release: Link<'Release'> }>
+type ReleaseEntryProps<T> = EntryProps<T, { release: Link<'Release'> }>
 
-export const get: RestEndpoint<'ReleaseEntry', 'get'> = (
+export const get: RestEndpoint<'ReleaseEntry', 'get'> = <T extends KeyValueMap = KeyValueMap>(
   http: AxiosInstance,
   params: GetReleaseEntryParams & QueryParams,
   rawData?: unknown,
   headers?: RawAxiosRequestHeaders
 ) => {
-  return raw.get<ReleaseEntryProps>(
+  return raw.get<ReleaseEntryProps<T>>(
     http,
     `/spaces/${params.spaceId}/environments/${params.environmentId}/releases/${params.releaseId}/entries/${params.entryId}`,
     {
@@ -38,13 +38,15 @@ export const get: RestEndpoint<'ReleaseEntry', 'get'> = (
   )
 }
 
-export const getMany: RestEndpoint<'ReleaseEntry', 'getMany'> = (
+export const getMany: RestEndpoint<'ReleaseEntry', 'getMany'> = <
+  T extends KeyValueMap = KeyValueMap
+>(
   http: AxiosInstance,
   params: GetManyReleaseEntryParams & QueryParams,
   rawData?: unknown,
   headers?: RawAxiosRequestHeaders
 ) => {
-  return raw.get<CollectionProp<ReleaseEntryProps>>(
+  return raw.get<CollectionProp<ReleaseEntryProps<T>>>(
     http,
     `/spaces/${params.spaceId}/environments/${params.environmentId}/releases/${params.releaseId}/entries`,
     {
@@ -62,7 +64,7 @@ export const update: RestEndpoint<'ReleaseEntry', 'update'> = <T extends KeyValu
 ) => {
   const data: SetOptional<typeof rawData, 'sys'> = copy(rawData)
   delete data.sys
-  return raw.put<ReleaseEntryProps>(
+  return raw.put<ReleaseEntryProps<T>>(
     http,
     `/spaces/${params.spaceId}/environments/${params.environmentId}/releases/${params.releaseId}/entries/${params.entryId}`,
     data,
@@ -81,7 +83,7 @@ export const patch: RestEndpoint<'ReleaseEntry', 'patch'> = <T extends KeyValueM
   data: OpPatch[],
   headers?: RawAxiosRequestHeaders
 ) => {
-  return raw.patch<ReleaseEntryProps>(
+  return raw.patch<ReleaseEntryProps<T>>(
     http,
     `/spaces/${params.spaceId}/environments/${params.environmentId}/releases/${params.releaseId}/entries/${params.entryId}`,
     data,
@@ -103,7 +105,7 @@ export const create: RestEndpoint<'ReleaseEntry', 'create'> = <T extends KeyValu
 ) => {
   const data = copy(rawData)
 
-  return raw.post<ReleaseEntryProps>(
+  return raw.post<ReleaseEntryProps<T>>(
     http,
     `/spaces/${params.spaceId}/environments/${params.environmentId}/releases/${params.releaseId}/entries`,
     data,
@@ -126,7 +128,7 @@ export const createWithId: RestEndpoint<'ReleaseEntry', 'createWithId'> = <
 ) => {
   const data = copy(rawData)
 
-  return raw.put<ReleaseEntryProps>(
+  return raw.put<ReleaseEntryProps<T>>(
     http,
     `/spaces/${params.spaceId}/environments/${params.environmentId}/releases/${params.releaseId}/entries/${params.entryId}`,
     data,

lib/adapters/REST/endpoints/release.ts

@@ -1,6 +1,6 @@
 import type { RawAxiosRequestHeaders } from 'axios'
 import type { AxiosInstance } from 'contentful-sdk-core'
-import type { ReleaseEnvironmentParams, GetReleaseParams } from '../../../common-types'
+import type { GetReleaseParams, ReleaseEnvironmentParams } from '../../../common-types'
 import type {
   ReleasePayload,
   ReleasePayloadV2,

lib/common-types.ts

@@ -1645,21 +1645,21 @@ export type MRActions = {
       return: CollectionProp<EntryProps<any>>
     }
     getMany: {
-      params: GetManyEntryParams & QueryParams & { releaseId?: string }
-      return: CollectionProp<EntryProps<any, any>>
+      params: GetSpaceEnvironmentParams & QueryParams & { releaseId?: string }
+      return: CollectionProp<EntryProps<any>>
     }
     get: {
-      params: GetEntryParams & QueryParams & { releaseId?: string }
-      return: EntryProps<any, any>
+      params: GetSpaceEnvironmentParams & { entryId: string; releaseId?: string } & QueryParams
+      return: EntryProps<any>
     }
     patch: {
-      params: PatchEntryParams & QueryParams & { releaseId?: string }
+      params: GetSpaceEnvironmentParams & { entryId: string; version: number; releaseId?: string }
       payload: OpPatch[]
       headers?: RawAxiosRequestHeaders
       return: EntryProps<any>
     }
     update: {
-      params: UpdateEntryParams & QueryParams & { releaseId?: string }
+      params: GetSpaceEnvironmentParams & { entryId: string; releaseId?: string }
       payload: EntryProps<any>
       headers?: RawAxiosRequestHeaders
       return: EntryProps<any>
@@ -1686,7 +1686,7 @@ export type MRActions = {
       params: GetSpaceEnvironmentParams & {
         contentTypeId: string
         releaseId?: string
-      } & QueryParams
+      }
       payload: CreateEntryProps<any>
       return: EntryProps<any>
     }
@@ -1697,7 +1697,7 @@ export type MRActions = {
         releaseId?: string
       }
       payload: CreateEntryProps<any>
-      return: EntryProps<any, any>
+      return: EntryProps<any>
     }
     references: {
       params: GetSpaceEnvironmentParams & {
@@ -1866,11 +1866,11 @@ export type MRActions = {
       return: ReleaseProps
     }
     query: {
-      params: GetSpaceEnvironmentParams & { query?: ReleaseQueryOptions }
+      params: ReleaseEnvironmentParams & { query?: ReleaseQueryOptions }
       return: CollectionProp<ReleaseProps>
     }
     create: {
-      params: GetSpaceEnvironmentParams
+      params: ReleaseEnvironmentParams
       payload: ReleasePayload | ReleasePayloadV2
       return: ReleaseProps
     }
@@ -1949,12 +1949,12 @@ export type MRActions = {
     get: {
       params: GetReleaseEntryParams & QueryParams
       headers?: RawAxiosRequestHeaders
-      return: EntryProps<any, any>
+      return: EntryProps<any, { release: Link<'Release'> }>
     }
     getMany: {
       params: GetManyReleaseEntryParams & QueryParams
       headers?: RawAxiosRequestHeaders
-      return: CollectionProp<EntryProps<any, any>>
+      return: CollectionProp<EntryProps<any, { release: Link<'Release'> }>>
     }
     update: {
       params: UpdateReleaseEntryParams & QueryParams
@@ -2457,13 +2457,6 @@ export type GetCommentParams = (GetEntryParams | GetCommentParentEntityParams) &
 export type GetContentTypeParams = GetSpaceEnvironmentParams & { contentTypeId: string }
 export type GetEditorInterfaceParams = GetSpaceEnvironmentParams & { contentTypeId: string }
 export type GetEntryParams = GetSpaceEnvironmentParams & { entryId: string }
-export type GetManyEntryParams = GetSpaceEnvironmentParams
-export type PatchEntryParams = GetSpaceEnvironmentParams & {
-  entryId: string
-  version: number
-  releaseId?: string
-}
-export type UpdateEntryParams = GetSpaceEnvironmentParams & { entryId: string; releaseId?: string }
 export type GetExtensionParams = GetSpaceEnvironmentParams & { extensionId: string }
 export type GetEnvironmentTemplateParams = GetOrganizationParams & { environmentTemplateId: string }
 export type GetFunctionParams = GetAppDefinitionParams & { functionId: string }

lib/create-environment-api.ts

@@ -37,7 +37,6 @@ import type {
   ReleasePayload,
   ReleaseQueryOptions,
   ReleaseValidatePayload,
-  ReleasePayloadV2,
 } from './entities/release'
 import { wrapRelease, wrapReleaseCollection } from './entities/release'
 
@@ -398,15 +397,15 @@ export default function createEnvironmentApi(makeRequest: MakeRequest) {
      *
      * // Using Thenables
      * client.getSpace('<space_id>')
-     * .then((space) => space.getEnvironment('<environment-id>'))
+     * .then((space) => space.getEnvironment('<environment_id>'))
      * .then((environment) => environment.createUnpublishBulkAction(payload))
      * .then((bulkAction) => console.log(bulkAction.waitProcessing()))
      * .catch(console.error)
      *
      * // Using async/await
      * try {
      *  const space = await clientgetSpace('<space_id>')
-     *  const environment = await space.getEnvironment('<environment-id>')
+     *  const environment = await space.getEnvironment('<environment_id>')
      *  const bulkActionInProgress = await environment.createUnpublishBulkAction(payload)
      *
      *  // You can wait for a recently created BulkAction to be processed by using `bulkAction.waitProcessing()`
@@ -867,7 +866,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest) {
      *
      * // Get entry references
      * client.getSpace('<space_id>')
-     * .then((space) => space.getEnvironment('<environment-id>'))
+     * .then((space) => space.getEnvironment('<environment_id>'))
      * .then((environment) => environment.getEntryReferences('<entry_id>', {include: number}))
      * .then((entry) => console.log(entry.includes))
      * // or
@@ -2109,7 +2108,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest) {
       version,
     }: {
       releaseId: string
-      payload: ReleasePayload | ReleasePayloadV2
+      payload: ReleasePayload
       version: number
     }) {
       const raw: EnvironmentProps = this.toPlainObject()
@@ -2482,7 +2481,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest) {
      * })
      *
      * client.getSpace('<space_id>')
-     * .then((space) => space.getEnvironment('<environment-id>'))
+     * .then((space) => space.getEnvironment('<environment_id>'))
      * .then((environment) => environment.getResourceTypes({limit: 10}))
      * .then((installations) => console.log(installations.items))
      * .catch(console.error)