feat: add delete method to componentType API [DX-636]

lib/adapters/REST/endpoints/component-type.ts

@@ -24,10 +24,17 @@ export const getMany: RestEndpoint<'ComponentType', 'getMany'> = (
 
 export const get: RestEndpoint<'ComponentType', 'get'> = (
   http: AxiosInstance,
-  params: GetSpaceEnvironmentParams & { componentId: string },
+  params: GetSpaceEnvironmentParams & { componentTypeId: string },
   headers?: RawAxiosRequestHeaders,
 ) => {
-  return raw.get<ComponentTypeProps>(http, getBaseUrl(params) + `/${params.componentId}`, {
+  return raw.get<ComponentTypeProps>(http, getBaseUrl(params) + `/${params.componentTypeId}`, {
     headers,
   })
 }
+
+export const del: RestEndpoint<'ComponentType', 'delete'> = (
+  http: AxiosInstance,
+  params: GetSpaceEnvironmentParams & { componentTypeId: string },
+) => {
+  return raw.del(http, getBaseUrl(params) + `/${params.componentTypeId}`)
+}

lib/common-types.ts

@@ -267,7 +267,7 @@
   select?: string
   links_to_entry?: string
 
   [key: string]: any
 }
 
 export interface SpaceQueryOptions extends PaginationQueryOptions {
@@ -576,6 +576,7 @@
 
   (opts: MROpts<'ComponentType', 'getMany', UA>): MRReturn<'ComponentType', 'getMany'>
   (opts: MROpts<'ComponentType', 'get', UA>): MRReturn<'ComponentType', 'get'>
+  (opts: MROpts<'ComponentType', 'delete', UA>): MRReturn<'ComponentType', 'delete'>
 
   (opts: MROpts<'Concept', 'get', UA>): MRReturn<'Concept', 'get'>
   (opts: MROpts<'Concept', 'getMany', UA>): MRReturn<'Concept', 'getMany'>
@@ -1475,9 +1476,10 @@
       return: CollectionProp<ComponentTypeProps>
     }
     get: {
-      params: GetSpaceEnvironmentParams & { componentId: string }
+      params: GetSpaceEnvironmentParams & { componentTypeId: string }
       return: ComponentTypeProps
     }
+    delete: { params: GetSpaceEnvironmentParams & { componentTypeId: string }; return: void }
   }
   Concept: {
     create: {

lib/plain/entities/component-type.ts

@@ -32,7 +32,6 @@ export type ComponentTypePlainClientAPI = {
   /**
    * Fetches a single component type by ID
    * @param params the space, environment, and component type IDs
-   * @param params.componentId the component type ID
    * @returns the component type
    * @throws if the request fails, or the space, environment, or component type is not found
    * @internal - Experimental endpoint, subject to breaking changes without notice
@@ -41,11 +40,29 @@ export type ComponentTypePlainClientAPI = {
    * const componentType = await client.componentType.get({
    *   spaceId: '<space_id>',
    *   environmentId: '<environment_id>',
-   *   componentId: '<component_id>',
+   *   componentTypeId: '<component_id>',
    * });
    * ```
    */
   get(
-    params: OptionalDefaults<GetSpaceEnvironmentParams & { componentId: string }>,
+    params: OptionalDefaults<GetSpaceEnvironmentParams & { componentTypeId: string }>,
   ): Promise<ComponentTypeProps>
+
+  /**
+   * Deletes a single component type
+   * @param params the space, environment, and component type IDs
+   * @throws if the request fails, or the component type is not found
+   * @internal - Experimental endpoint, subject to breaking changes without notice
+   * @example
+   * ```javascript
+   * await client.componentType.delete({
+   *   spaceId: '<space_id>',
+   *   environmentId: '<environment_id>',
+   *   componentTypeId: '<component_id>',
+   * });
+   * ```
+   */
+  delete(
+    params: OptionalDefaults<GetSpaceEnvironmentParams & { componentTypeId: string }>,
+  ): Promise<void>
 }

lib/plain/plain-client.ts

@@ -226,6 +226,7 @@ export const createPlainClient = (
     componentType: {
       getMany: wrap(wrapParams, 'ComponentType', 'getMany'),
       get: wrap(wrapParams, 'ComponentType', 'get'),
+      delete: wrap(wrapParams, 'ComponentType', 'delete'),
     },
     contentType: {
       get: wrap(wrapParams, 'ContentType', 'get'),

test/unit/adapters/REST/endpoints/component-type.test.ts

@@ -92,7 +92,7 @@ describe('Rest ComponentType', { concurrent: true }, () => {
         params: {
           spaceId: 'space123',
           environmentId: 'master',
-          componentId: 'component123',
+          componentTypeId: 'component123',
         },
       })
       .then((r) => {
@@ -102,4 +102,25 @@ describe('Rest ComponentType', { concurrent: true }, () => {
         )
       })
   })
+
+  test('delete calls correct URL', async () => {
+    const { httpMock, adapterMock } = setupRestAdapter(Promise.resolve({ data: '' }))
+
+    return adapterMock
+      .makeRequest({
+        entityType: 'ComponentType',
+        action: 'delete',
+        userAgent: 'mocked',
+        params: {
+          spaceId: 'space123',
+          environmentId: 'master',
+          componentTypeId: 'component123',
+        },
+      })
+      .then(() => {
+        expect(httpMock.delete.mock.calls[0][0]).to.eql(
+          '/spaces/space123/environments/master/component_types/component123',
+        )
+      })
+  })
 })