feat: client.publish payload (#2597)

Author: cemreyuksel

lib/adapters/REST/endpoints/ai-action.ts

@@ -73,8 +73,8 @@ export const del: RestEndpoint<'AiAction', 'delete'> = (
 
 export const publish: RestEndpoint<'AiAction', 'publish'> = (
   http: AxiosInstance,
-  params: GetSpaceParams & { aiActionId: string },
-  rawData: AiActionProps,
+  params: GetSpaceParams & { aiActionId: string; version: number },
+  rawData?: unknown,
   headers?: RawAxiosRequestHeaders
 ) => {
   return raw.put<AiActionProps>(
@@ -83,7 +83,7 @@ export const publish: RestEndpoint<'AiAction', 'publish'> = (
     null,
     {
       headers: {
-        'X-Contentful-Version': rawData.sys.version,
+        'X-Contentful-Version': params.version,
         ...headers,
       },
     }

lib/common-types.ts

@@ -965,8 +965,7 @@ export type MRActions = {
     }
     delete: { params: GetSpaceParams & { aiActionId: string }; return: any }
     publish: {
-      params: GetSpaceParams & { aiActionId: string }
-      payload: AiActionProps
+      params: GetSpaceParams & { aiActionId: string; version: number }
       headers?: RawAxiosRequestHeaders
       return: AiActionProps
     }

lib/create-space-api.ts

@@ -1608,14 +1608,12 @@ export default function createSpaceApi(makeRequest: MakeRequest) {
      *   .catch(console.error)
      * ```
      */
-    publishAiAction(aiActionId: string, data: AiActionProps) {
+    publishAiAction(aiActionId: string, { version }: { version: number }) {
       const raw = this.toPlainObject() as SpaceProps
       return makeRequest({
         entityType: 'AiAction',
         action: 'publish',
-        params: { spaceId: raw.sys.id, aiActionId },
-        payload: data,
-        headers: { 'X-Contentful-Version': data.sys.version },
+        params: { spaceId: raw.sys.id, aiActionId, version },
       }).then((response) => wrapAiAction(makeRequest, response))
     },
 

lib/entities/ai-action.ts

@@ -150,8 +150,11 @@ function createAiActionApi(makeRequest: MakeRequest) {
       return makeRequest({
         entityType: 'AiAction',
         action: 'publish',
-        params: getParams(self),
-        payload: self,
+        params: {
+          aiActionId: self.sys.id,
+          spaceId: self.sys.space.sys.id,
+          version: self.sys.version,
+        },
       }).then((data) => wrapAiAction(makeRequest, data))
     },
 

lib/plain/entities/ai-action.ts

@@ -65,14 +65,13 @@ export type AiActionPlainClientAPI = {
   /**
    * Publishes the AI Action.
    * @param params Entity IDs to identify the AI Action.
-   * @param payload The AI Action details.
    * @param headers Optional headers for the request.
    * @returns The published AI Action and its metadata.
    * @throws if the request fails or the payload is malformed.
    */
   publish(
-    params: OptionalDefaults<GetSpaceParams & { aiActionId: string }>,
-    payload: AiActionProps,
+    params: OptionalDefaults<GetSpaceParams & { aiActionId: string; version: number }>,
+    payload?: unknown,
     headers?: Partial<RawAxiosRequestHeaders>
   ): Promise<AiActionProps>
   /**

test/integration/ai-action-integration.test.ts

@@ -127,7 +127,7 @@ describe('AiAction api', { sequential: true }, () => {
       })
       .then((aiAction) => {
         return space
-          .publishAiAction(aiAction.sys.id, aiAction)
+          .publishAiAction(aiAction.sys.id, { version: aiAction.sys.version })
           .then((publishedAction) => {
             expect(publishedAction.sys.publishedVersion).to.be.ok
             return space.unpublishAiAction(publishedAction.sys.id)
@@ -164,7 +164,7 @@ describe('AiAction api', { sequential: true }, () => {
       })
       .then((aiAction) => {
         return space
-          .publishAiAction(aiAction.sys.id, aiAction)
+          .publishAiAction(aiAction.sys.id, { version: aiAction.sys.version })
           .then((publishedAction) =>
             environment.invokeAiAction(publishedAction.sys.id, {
               outputFormat: 'PlainText',

test/integration/ai-action-invocation-integration.test.ts

@@ -67,7 +67,7 @@ describe('AiActionInvocation api', { sequential: true }, () => {
       testCases: [],
     })
 
-    await space.publishAiAction(aiAction.sys.id, aiAction)
+    await space.publishAiAction(aiAction.sys.id, { version: aiAction.sys.version })
 
     // First invoke the action
     invocation = await environment.invokeAiAction(aiAction.sys.id, {
@@ -144,7 +144,7 @@ describe('AiActionInvocation api', { sequential: true }, () => {
       testCases: [],
     })
 
-    await space.publishAiAction(otherAiAction.sys.id, otherAiAction)
+    await space.publishAiAction(otherAiAction.sys.id, { version: otherAiAction.sys.version })
 
     try {
       await environment.getAiActionInvocation({

test/unit/create-space-api.test.ts

@@ -550,10 +550,11 @@ describe('A createSpaceApi', () => {
     const { api, makeRequest, entitiesMock } = setup(Promise.resolve(aiAction))
     entitiesMock.aiAction.wrapAiAction.mockReturnValue(aiAction)
 
-    await api.publishAiAction('aiActionId', aiAction).then((r) => {
+    await api.publishAiAction('aiActionId', { version: aiAction.sys.version }).then((r) => {
       expect(r).to.eql(aiAction)
-      expect(makeRequest.mock.calls[0][0].payload).to.eql(aiAction)
+
       expect(makeRequest.mock.calls[0][0].params.aiActionId).to.eql('aiActionId')
+      expect(makeRequest.mock.calls[0][0].params.version).to.eql(aiAction.sys.version)
       expect(makeRequest.mock.calls[0][0].action).to.eql('publish')
     })
   })
@@ -564,7 +565,7 @@ describe('A createSpaceApi', () => {
     const aiAction = cloneMock('aiAction')
 
     try {
-      await api.publishAiAction('aiActionId', aiAction)
+      await api.publishAiAction('aiActionId', { version: aiAction.sys.version })
     } catch (e) {
       expect(e).to.eq(error)
     }