feat: add release.entry.createWithId method [DX-61] (#2724)

* feat: add release.entry.createWithId method [DX-61]

* fix: update types for release entry params

* test: debug integration tests

* test: update unit tests and remove changes to integration tests

Author: whitelisab

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

@@ -1,13 +1,14 @@
 import type { AxiosInstance } from 'contentful-sdk-core'
 import type {
   GetReleaseEntryParams,
-  GetSpaceEnvironmentParams,
+  GetManyReleaseEntryParams,
   KeyValueMap,
   PatchReleaseEntryParams,
   QueryParams,
   UpdateReleaseEntryParams,
+  CreateWithIdReleaseEntryParams,
 } from '../../../common-types'
-import type { EntryProps } from '../../../entities/entry'
+import type { CreateEntryProps, EntryProps } from '../../../entities/entry'
 import copy from 'fast-copy'
 import type { RestEndpoint } from '../types'
 import * as raw from './raw'
@@ -28,7 +29,7 @@ export const get: RestEndpoint<'ReleaseEntry', 'get'> = (
 
 export const getMany: RestEndpoint<'ReleaseEntry', 'getMany'> = (
   http: AxiosInstance,
-  params: GetSpaceEnvironmentParams & QueryParams & { releaseId: string }
+  params: GetManyReleaseEntryParams & QueryParams
 ) => {
   params.query = { ...params.query, 'sys.schemaVersion': 'Release.V2' }
 
@@ -40,7 +41,7 @@ export const getMany: RestEndpoint<'ReleaseEntry', 'getMany'> = (
 
 export const update: RestEndpoint<'ReleaseEntry', 'update'> = <T extends KeyValueMap = KeyValueMap>(
   http: AxiosInstance,
-  params: UpdateReleaseEntryParams & { entryId: string } & QueryParams & { releaseId: string },
+  params: UpdateReleaseEntryParams & QueryParams,
   rawData: EntryProps<T>,
   headers?: RawAxiosRequestHeaders
 ) => {
@@ -75,10 +76,7 @@ export const update: RestEndpoint<'ReleaseEntry', 'update'> = <T extends KeyValu
 
 export const patch: RestEndpoint<'ReleaseEntry', 'patch'> = <T extends KeyValueMap = KeyValueMap>(
   http: AxiosInstance,
-  params: PatchReleaseEntryParams & {
-    entryId: string
-    version: number
-  } & QueryParams,
+  params: PatchReleaseEntryParams & QueryParams,
   data: OpPatch[],
   headers?: RawAxiosRequestHeaders
 ) => {
@@ -96,3 +94,40 @@ export const patch: RestEndpoint<'ReleaseEntry', 'patch'> = <T extends KeyValueM
     }
   )
 }
+
+export const createWithId: RestEndpoint<'ReleaseEntry', 'createWithId'> = <
+  T extends KeyValueMap = KeyValueMap
+>(
+  http: AxiosInstance,
+  params: CreateWithIdReleaseEntryParams & QueryParams,
+  rawData: CreateEntryProps<T>,
+  headers?: RawAxiosRequestHeaders
+) => {
+  params.query = { ...params.query, 'sys.schemaVersion': 'Release.V2' }
+  const data = copy(rawData)
+
+  return raw.put<
+    EntryProps<
+      T,
+      {
+        release: {
+          sys: {
+            type: 'Link'
+            linkType: 'Entry' | 'Asset'
+            id: string
+          }
+        }
+      }
+    >
+  >(
+    http,
+    `/spaces/${params.spaceId}/environments/${params.environmentId}/releases/${params.releaseId}/entries/${params.entryId}`,
+    data,
+    {
+      headers: {
+        'X-Contentful-Content-Type': params.contentTypeId,
+        ...headers,
+      },
+    }
+  )
+}

lib/common-types.ts

@@ -714,6 +714,13 @@ type MRInternal<UA extends boolean> = {
     'ReleaseAction',
     'queryForRelease'
   >
+
+  (opts: MROpts<'ReleaseEntry', 'get', UA>): MRReturn<'ReleaseEntry', 'get'>
+  (opts: MROpts<'ReleaseEntry', 'getMany', UA>): MRReturn<'ReleaseEntry', 'getMany'>
+  (opts: MROpts<'ReleaseEntry', 'update', UA>): MRReturn<'ReleaseEntry', 'update'>
+  (opts: MROpts<'ReleaseEntry', 'patch', UA>): MRReturn<'ReleaseEntry', 'patch'>
+  (opts: MROpts<'ReleaseEntry', 'createWithId', UA>): MRReturn<'ReleaseEntry', 'createWithId'>
+
   (opts: MROpts<'Resource', 'getMany', UA>): MRReturn<'Resource', 'getMany'>
   (opts: MROpts<'ResourceProvider', 'get', UA>): MRReturn<'ResourceProvider', 'get'>
   (opts: MROpts<'ResourceProvider', 'upsert', UA>): MRReturn<'ResourceProvider', 'upsert'>
@@ -1892,6 +1899,27 @@ export type MRActions = {
         }
       >
     }
+    createWithId: {
+      params: GetSpaceEnvironmentParams & {
+        releaseId: string
+        entryId: string
+        contentTypeId: string
+      }
+      payload: CreateEntryProps<any>
+      headers?: RawAxiosRequestHeaders
+      return: EntryProps<
+        any,
+        {
+          release: {
+            sys: {
+              type: 'Link'
+              linkType: 'Entry' | 'Asset'
+              id: string
+            }
+          }
+        }
+      >
+    }
   }
   ReleaseAction: {
     get: {
@@ -2376,19 +2404,21 @@ export type GetReleaseEntryParams = GetSpaceEnvironmentParams & {
   releaseId?: string
   entryId: string
 }
-
-export type GetManyReleaseEntryParams = GetSpaceEnvironmentParams & {
-  releaseId: string
-}
-
+export type GetManyReleaseEntryParams = GetSpaceEnvironmentParams & { releaseId: string }
 export type UpdateReleaseEntryParams = GetSpaceEnvironmentParams & {
   releaseId: string
+  entryId: string
 }
-
 export type PatchReleaseEntryParams = GetSpaceEnvironmentParams & {
   releaseId: string
+  entryId: string
+  version: number
+}
+export type CreateWithIdReleaseEntryParams = GetSpaceEnvironmentParams & {
+  releaseId: string
+  entryId: string
+  contentTypeId: string
 }
-
 export type GetSnapshotForContentTypeParams = GetSpaceEnvironmentParams & { contentTypeId: string }
 export type GetSnapshotForEntryParams = GetSpaceEnvironmentParams & { entryId: string }
 export type GetSpaceEnvAliasParams = GetSpaceParams & { environmentAliasId: string }

lib/plain/common-types.ts

@@ -3,6 +3,7 @@ import type { OpPatch } from 'json-patch'
 import type {
   BasicCursorPaginationOptions,
   CollectionProp,
+  CreateWithIdReleaseEntryParams,
   CursorPaginatedCollectionProp,
   EnvironmentTemplateParams,
   GetBulkActionParams,
@@ -456,7 +457,7 @@ export type PlainClientAPI = {
   release: {
     entry: {
       get<T extends KeyValueMap = KeyValueMap>(
-        params: OptionalDefaults<GetReleaseEntryParams>
+        params: OptionalDefaults<GetReleaseEntryParams & QueryParams>
       ): Promise<
         EntryProps<
           T,
@@ -472,7 +473,7 @@ export type PlainClientAPI = {
         >
       >
       getMany<T extends KeyValueMap = KeyValueMap>(
-        params: OptionalDefaults<GetManyReleaseEntryParams>
+        params: OptionalDefaults<GetManyReleaseEntryParams & QueryParams>
       ): Promise<
         CollectionProp<
           EntryProps<
@@ -490,7 +491,7 @@ export type PlainClientAPI = {
         >
       >
       update<T extends KeyValueMap = KeyValueMap>(
-        params: OptionalDefaults<UpdateReleaseEntryParams & { entryId: string }>,
+        params: OptionalDefaults<UpdateReleaseEntryParams & QueryParams>,
         rawData: EntryProps<T>,
         headers?: RawAxiosRequestHeaders
       ): Promise<
@@ -508,7 +509,7 @@ export type PlainClientAPI = {
         >
       >
       patch<T extends KeyValueMap = KeyValueMap>(
-        params: OptionalDefaults<PatchReleaseEntryParams & { entryId: string; version: number }>,
+        params: OptionalDefaults<PatchReleaseEntryParams & QueryParams>,
         rawData: OpPatch[],
         headers?: RawAxiosRequestHeaders
       ): Promise<
@@ -525,6 +526,24 @@ export type PlainClientAPI = {
           }
         >
       >
+      createWithId<T extends KeyValueMap = KeyValueMap>(
+        params: OptionalDefaults<CreateWithIdReleaseEntryParams & QueryParams>,
+        rawData: CreateEntryProps<T>,
+        headers?: RawAxiosRequestHeaders
+      ): Promise<
+        EntryProps<
+          T,
+          {
+            release: {
+              sys: {
+                type: 'Link'
+                linkType: 'Entry' | 'Asset'
+                id: string
+              }
+            }
+          }
+        >
+      >
     }
     archive(params: OptionalDefaults<GetReleaseParams & { version: number }>): Promise<ReleaseProps>
     get(params: OptionalDefaults<GetReleaseParams>): Promise<ReleaseProps>

lib/plain/plain-client.ts

@@ -347,6 +347,7 @@ export const createPlainClient = (
         getMany: wrap(wrapParams, 'ReleaseEntry', 'getMany'),
         update: wrap(wrapParams, 'ReleaseEntry', 'update'),
         patch: wrap(wrapParams, 'ReleaseEntry', 'patch'),
+        createWithId: wrap(wrapParams, 'ReleaseEntry', 'createWithId'),
       },
       archive: wrap(wrapParams, 'Release', 'archive'),
       get: wrap(wrapParams, 'Release', 'get'),