feat: [GROOT-1550] add support for taxonomy PUT methods (#2464)

LiamStokingerContentful · web-flow · commit da65d6202de4 · 2024-11-21T09:51:36.000+01:00
* feat: [GROOT-1550] add support for taxonomy PUT methods * feat: [GROOT-1550] introduce proposal for fixing update behavior in taxonomy (#2469) * feat: [GROOT-1550] introduce proposal for fixing update behavior in taxonomy * chore: [GROOT-1550] remove default version for taxonomy updates * fix: [GROOT-1550] remove patch header from taxonomy put method
diff --git a/lib/adapters/REST/endpoints/concept-scheme.ts b/lib/adapters/REST/endpoints/concept-scheme.ts
@@ -58,6 +58,38 @@ export const create: RestEndpoint<'ConceptScheme', 'create'> = (
   return raw.post<ConceptSchemeProps>(http, basePath(params.organizationId), data)
 }
 
+export const createWithId: RestEndpoint<'ConceptScheme', 'createWithId'> = (
+  http: AxiosInstance,
+  params: GetConceptSchemeParams,
+  data: CreateConceptSchemeProps
+) => {
+  return raw.put<ConceptSchemeProps>(
+    http,
+    `${basePath(params.organizationId)}/${params.conceptSchemeId}`,
+    data
+  )
+}
+
+export const patch: RestEndpoint<'ConceptScheme', 'patch'> = (
+  http: AxiosInstance,
+  params: UpdateConceptSchemeParams,
+  data: OpPatch[],
+  headers?: RawAxiosRequestHeaders
+) => {
+  return raw.patch<ConceptSchemeProps>(
+    http,
+    `${basePath(params.organizationId)}/${params.conceptSchemeId}`,
+    data,
+    {
+      headers: {
+        'X-Contentful-Version': params.version,
+        'Content-Type': 'application/json-patch+json',
+        ...headers,
+      },
+    }
+  )
+}
+
 export const update: RestEndpoint<'ConceptScheme', 'update'> = (
   http: AxiosInstance,
   params: UpdateConceptSchemeParams,
@@ -77,3 +109,22 @@ export const update: RestEndpoint<'ConceptScheme', 'update'> = (
     }
   )
 }
+
+export const updatePut: RestEndpoint<'ConceptScheme', 'updatePut'> = (
+  http: AxiosInstance,
+  params: UpdateConceptSchemeParams,
+  data: CreateConceptSchemeProps,
+  headers?: RawAxiosRequestHeaders
+) => {
+  return raw.put<ConceptSchemeProps>(
+    http,
+    `${basePath(params.organizationId)}/${params.conceptSchemeId}`,
+    data,
+    {
+      headers: {
+        'X-Contentful-Version': params.version,
+        ...headers,
+      },
+    }
+  )
+}
diff --git a/lib/adapters/REST/endpoints/concept.ts b/lib/adapters/REST/endpoints/concept.ts
@@ -26,6 +26,34 @@ export const create: RestEndpoint<'Concept', 'create'> = (
   return raw.post<ConceptProps>(http, basePath(params.organizationId), data)
 }
 
+export const createWithId: RestEndpoint<'Concept', 'createWithId'> = (
+  http: AxiosInstance,
+  params: GetConceptParams,
+  data: CreateConceptProps
+) => {
+  return raw.put<ConceptProps>(http, `${basePath(params.organizationId)}/${params.conceptId}`, data)
+}
+
+export const patch: RestEndpoint<'Concept', 'patch'> = (
+  http: AxiosInstance,
+  params: UpdateConceptParams,
+  data: OpPatch[],
+  headers?: RawAxiosRequestHeaders
+) => {
+  return raw.patch<ConceptProps>(
+    http,
+    `${basePath(params.organizationId)}/${params.conceptId}`,
+    data,
+    {
+      headers: {
+        'X-Contentful-Version': params.version,
+        'Content-Type': 'application/json-patch+json',
+        ...headers,
+      },
+    }
+  )
+}
+
 export const update: RestEndpoint<'Concept', 'update'> = (
   http: AxiosInstance,
   params: UpdateConceptParams,
@@ -38,14 +66,33 @@ export const update: RestEndpoint<'Concept', 'update'> = (
     data,
     {
       headers: {
-        'X-Contentful-Version': params.version ?? 0,
+        'X-Contentful-Version': params.version,
         'Content-Type': 'application/json-patch+json',
         ...headers,
       },
     }
   )
 }
 
+export const updatePut: RestEndpoint<'Concept', 'updatePut'> = (
+  http: AxiosInstance,
+  params: UpdateConceptParams,
+  data: CreateConceptProps,
+  headers?: RawAxiosRequestHeaders
+) => {
+  return raw.put<ConceptProps>(
+    http,
+    `${basePath(params.organizationId)}/${params.conceptId}`,
+    data,
+    {
+      headers: {
+        'X-Contentful-Version': params.version,
+        ...headers,
+      },
+    }
+  )
+}
+
 export const get: RestEndpoint<'Concept', 'get'> = (
   http: AxiosInstance,
   params: GetConceptParams
diff --git a/lib/common-types.ts b/lib/common-types.ts
@@ -460,14 +460,20 @@ type MRInternal<UA extends boolean> = {
   (opts: MROpts<'Concept', 'getTotal', UA>): MRReturn<'Concept', 'getTotal'>
   (opts: MROpts<'Concept', 'getDescendants', UA>): MRReturn<'Concept', 'getDescendants'>
   (opts: MROpts<'Concept', 'create', UA>): MRReturn<'Concept', 'create'>
+  (opts: MROpts<'Concept', 'createWithId', UA>): MRReturn<'Concept', 'createWithId'>
+  (opts: MROpts<'Concept', 'patch', UA>): MRReturn<'Concept', 'patch'>
   (opts: MROpts<'Concept', 'update', UA>): MRReturn<'Concept', 'update'>
+  (opts: MROpts<'Concept', 'updatePut', UA>): MRReturn<'Concept', 'updatePut'>
   (opts: MROpts<'Concept', 'delete', UA>): MRReturn<'Concept', 'delete'>
 
   (opts: MROpts<'ConceptScheme', 'get', UA>): MRReturn<'ConceptScheme', 'get'>
   (opts: MROpts<'ConceptScheme', 'getMany', UA>): MRReturn<'ConceptScheme', 'getMany'>
   (opts: MROpts<'ConceptScheme', 'getTotal', UA>): MRReturn<'ConceptScheme', 'getTotal'>
   (opts: MROpts<'ConceptScheme', 'create', UA>): MRReturn<'ConceptScheme', 'create'>
+  (opts: MROpts<'ConceptScheme', 'createWithId', UA>): MRReturn<'ConceptScheme', 'createWithId'>
+  (opts: MROpts<'ConceptScheme', 'patch', UA>): MRReturn<'ConceptScheme', 'patch'>
   (opts: MROpts<'ConceptScheme', 'update', UA>): MRReturn<'ConceptScheme', 'update'>
+  (opts: MROpts<'ConceptScheme', 'updatePut', UA>): MRReturn<'ConceptScheme', 'updatePut'>
   (opts: MROpts<'ConceptScheme', 'delete', UA>): MRReturn<'ConceptScheme', 'delete'>
 
   (opts: MROpts<'ContentType', 'get', UA>): MRReturn<'ContentType', 'get'>
@@ -1194,11 +1200,26 @@ export type MRActions = {
       payload: CreateConceptProps
       return: ConceptProps
     }
+    createWithId: {
+      params: GetConceptParams
+      payload: CreateConceptProps
+      return: ConceptProps
+    }
+    patch: {
+      params: UpdateConceptParams
+      payload: OpPatch[]
+      return: ConceptProps
+    }
     update: {
       params: UpdateConceptParams
       payload: OpPatch[]
       return: ConceptProps
     }
+    updatePut: {
+      params: UpdateConceptParams
+      payload: CreateConceptProps
+      return: ConceptProps
+    }
     delete: {
       params: DeleteConceptParams
       return: void
@@ -1230,11 +1251,26 @@ export type MRActions = {
       payload: CreateConceptSchemeProps
       return: ConceptSchemeProps
     }
+    createWithId: {
+      params: GetConceptSchemeParams
+      payload: CreateConceptSchemeProps
+      return: ConceptSchemeProps
+    }
+    patch: {
+      params: UpdateConceptSchemeParams
+      payload: OpPatch[]
+      return: ConceptSchemeProps
+    }
     update: {
       params: UpdateConceptSchemeParams
       payload: OpPatch[]
       return: ConceptSchemeProps
     }
+    updatePut: {
+      params: UpdateConceptSchemeParams
+      payload: CreateConceptSchemeProps
+      return: ConceptSchemeProps
+    }
     get: {
       params: GetConceptSchemeParams
       return: ConceptSchemeProps
diff --git a/lib/plain/entities/concept-scheme.ts b/lib/plain/entities/concept-scheme.ts
@@ -28,15 +28,36 @@ export type ConceptSchemePlainClientAPI = {
     payload: CreateConceptSchemeProps
   ): Promise<ConceptSchemeProps>
 
+  /**
+   * Create Concept Scheme With Id
+   * @returns the created Concept Scheme
+   * @throws if the request fails
+   * @see {@link https://www.contentful.com/developers/docs/references/content-management-api/#/reference/taxonomy/create-a-concept-scheme-with-user-defined-id}
+   * @example
+   * ```javascript
+   * const concept = await client.conceptScheme.createWithId({
+   *   organizationId: '<organization_id>',
+   *   conceptSchemeId: '<concept_scheme_id>',
+   * }, conceptSchemeProps);
+   * ```
+   */
+  createWithId(
+    params: SetOptional<GetConceptSchemeParams, 'organizationId'>,
+    payload: CreateConceptSchemeProps
+  ): Promise<ConceptSchemeProps>
+
   /**
    * Update Concept Scheme
    * @returns the updated Concept Scheme
    * @throws if the request fails
    * @see {@link https://www.contentful.com/developers/docs/references/content-management-api/#/reference/taxonomy/concept-scheme}
+   * @deprecated The behavior of this method as a PATCH is being deprecated, and will be replaced with a PUT in the next major version. Use the `patch` method instead.
    * @example
    * ```javascript
    * const updatedConcept = await client.conceptScheme.update({
    *   organizationId: '<organization_id>',
+   *   conceptSchemeId: '<concept_scheme_id>',
+   *   version: 1,
    * }, conceptSchemePatch);
    * ```
    */
@@ -45,6 +66,45 @@ export type ConceptSchemePlainClientAPI = {
     payload: OpPatch[]
   ): Promise<ConceptSchemeProps>
 
+  /**
+   * Update Concept Scheme with PUT
+   * @returns the updated Concept Scheme
+   * @throws if the request fails
+   * @see {@link https://www.contentful.com/developers/docs/references/content-management-api/#/reference/taxonomy/concept-scheme}
+   * @deprecated In the next major version, this method will be replaced with the standard `update` method which will be updated to use PUT instead of PATCH.
+   * @example
+   * ```javascript
+   * const updatedConcept = await client.conceptScheme.update({
+   *   organizationId: '<organization_id>',
+   *   conceptSchemeId: '<concept_scheme_id>',
+   *   version: 1,
+   * }, CreateConceptSchemeProps);
+   * ```
+   */
+  updatePut(
+    params: SetOptional<UpdateConceptSchemeParams, 'organizationId'>,
+    payload: CreateConceptSchemeProps
+  ): Promise<ConceptSchemeProps>
+
+  /**
+   * Update Concept Scheme
+   * @returns the updated Concept Scheme
+   * @throws if the request fails
+   * @see {@link https://www.contentful.com/developers/docs/references/content-management-api/#/reference/taxonomy/concept-scheme}
+   * @example
+   * ```javascript
+   * const updatedConcept = await client.conceptScheme.patch({
+   *   organizationId: '<organization_id>',
+   *   conceptSchemeId: '<concept_scheme_id>',
+   *   version: 1,
+   * }, conceptSchemePatch);
+   * ```
+   */
+  patch(
+    params: SetOptional<UpdateConceptSchemeParams, 'organizationId'>,
+    payload: OpPatch[]
+  ): Promise<ConceptSchemeProps>
+
   /**
    * Get Concept Scheme
    * @returns the Concept Scheme
diff --git a/lib/plain/entities/concept.ts b/lib/plain/entities/concept.ts
@@ -29,15 +29,36 @@ export type ConceptPlainClientAPI = {
     payload: CreateConceptProps
   ): Promise<ConceptProps>
 
+  /**
+   * Create Concept With Id
+   * @returns ConceptProps
+   * @throws if the request fails
+   * @see {@link https://www.contentful.com/developers/docs/references/content-management-api/#/reference/taxonomy/create-a-concept-with-user-defined-id}
+   * @example
+   * ```javascript
+   * const concept = await client.concept.createWithId({
+   *   organizationId: '<organization_id>',
+   *   conceptId: '<concept_id>',
+   * }, conceptProps);
+   * ```
+   */
+  createWithId(
+    params: SetOptional<GetConceptParams, 'organizationId'>,
+    payload: CreateConceptProps
+  ): Promise<ConceptProps>
+
   /**
    * Update Concept
    * @returns the updated Concept
    * @throws if the request fails
    * @see {@link https://www.contentful.com/developers/docs/references/content-management-api/#/reference/taxonomy/concept}
+   * @deprecated The behavior of this method as a PATCH is being deprecated, and will be replaced with a PUT in the next major version. Use the `patch` method instead.
    * @example
    * ```javascript
    * const updatedConcept = await client.concept.update({
    *   organizationId: '<organization_id>',
+   *   conceptId: '<concept_id>',
+   *   version: 1,
    * }, patch);
    * ```
    */
@@ -46,6 +67,45 @@ export type ConceptPlainClientAPI = {
     payload: OpPatch[]
   ): Promise<ConceptProps>
 
+  /**
+   * Update Concept with PUT
+   * @returns the updated Concept
+   * @throws if the request fails
+   * @see {@link https://www.contentful.com/developers/docs/references/content-management-api/#/reference/taxonomy/concept}
+   * @deprecated In the next major version, this method will be replaced with the standard `update` method which will be updated to use PUT instead of PATCH.
+   * @example
+   * ```javascript
+   * const updatedConcept = await client.concept.updatePut({
+   *   organizationId: '<organization_id>',
+   *   conceptId: '<concept_id>',
+   *   version: 1,
+   * }, patch);
+   * ```
+   */
+  updatePut(
+    params: SetOptional<UpdateConceptParams, 'organizationId'>,
+    payload: CreateConceptProps
+  ): Promise<ConceptProps>
+
+  /**
+   * Update Concept
+   * @returns the updated Concept
+   * @throws if the request fails
+   * @see {@link https://www.contentful.com/developers/docs/references/content-management-api/#/reference/taxonomy/concept}
+   * @example
+   * ```javascript
+   * const updatedConcept = await client.concept.patch({
+   *   organizationId: '<organization_id>',
+   *   conceptId: '<concept_id>',
+   *   version: 1,
+   * }, patch);
+   * ```
+   */
+  patch(
+    params: SetOptional<UpdateConceptParams, 'organizationId'>,
+    payload: OpPatch[]
+  ): Promise<ConceptProps>
+
   /**
    * Get Concept
    * @returns the Concept
diff --git a/lib/plain/plain-client.ts b/lib/plain/plain-client.ts
@@ -106,9 +106,12 @@ export const createPlainClient = (
     },
     concept: {
       create: wrap(wrapParams, 'Concept', 'create'),
+      createWithId: wrap(wrapParams, 'Concept', 'createWithId'),
       get: wrap(wrapParams, 'Concept', 'get'),
       delete: wrap(wrapParams, 'Concept', 'delete'),
+      patch: wrap(wrapParams, 'Concept', 'patch'),
       update: wrap(wrapParams, 'Concept', 'update'),
+      updatePut: wrap(wrapParams, 'Concept', 'updatePut'),
       getMany: wrap(wrapParams, 'Concept', 'getMany'),
       getDescendants: wrap(wrapParams, 'Concept', 'getDescendants'),
       getAncestors: wrap(wrapParams, 'Concept', 'getAncestors'),
@@ -120,7 +123,10 @@ export const createPlainClient = (
       getTotal: wrap(wrapParams, 'ConceptScheme', 'getTotal'),
       delete: wrap(wrapParams, 'ConceptScheme', 'delete'),
       create: wrap(wrapParams, 'ConceptScheme', 'create'),
+      createWithId: wrap(wrapParams, 'ConceptScheme', 'createWithId'),
+      patch: wrap(wrapParams, 'ConceptScheme', 'patch'),
       update: wrap(wrapParams, 'ConceptScheme', 'update'),
+      updatePut: wrap(wrapParams, 'ConceptScheme', 'updatePut'),
     },
     function: {
       getMany: wrap(wrapParams, 'Function', 'getMany'),
diff --git a/test/integration/taxonomy-integration.ts b/test/integration/taxonomy-integration.ts
diff --git a/test/unit/adapters/REST/endpoints/concept-scheme-test.ts b/test/unit/adapters/REST/endpoints/concept-scheme-test.ts
diff --git a/test/unit/adapters/REST/endpoints/concept-test.ts b/test/unit/adapters/REST/endpoints/concept-test.ts
