Add update pages context param type (#19)

* add new mutation param for pages.context mutation

* add new mutation param for pages.context mutation

* improve mutation and query differentiation

* fix changeset

Author: azwanazlan

.changeset/new-cooks-cheer.md

@@ -0,0 +1,5 @@
+---
+'@sitecore-marketplace-sdk/core': patch
+---
+
+Added a new shared type for the mutation parameters to support update Pages Context

.changeset/stale-nails-pick.md

@@ -0,0 +1,5 @@
+---
+'@sitecore-marketplace-sdk/client': patch
+---
+
+Added new mutation key to support update Pages context

packages/client/src/__tests__/client.test.ts

@@ -354,7 +354,7 @@ describe('ClientSDK', () => {
     });
 
     // Verify the request was made with correct endpoint and parameters
-    expect(CoreSDK.prototype.request).toHaveBeenCalledWith('pages.reloadCanvas', undefined);
+    expect(CoreSDK.prototype.request).toHaveBeenCalledWith('pages.reloadCanvas:mutation', undefined);
     expect(logger.info).toHaveBeenCalledWith(`Mutation (${mutationKey}) success:`, undefined);
     expect(onSuccessMock).toHaveBeenCalledWith(undefined);
     expect(onErrorMock).not.toHaveBeenCalled();
@@ -680,4 +680,20 @@ describe('ClientSDK', () => {
     await client.closeApp();
     expect(mockRequest).toHaveBeenCalledWith('pages.closeApp', {});
   });
+
+  it('should call coreSdk.request with pages.context in mutate()', async () => {
+    client = await ClientSDK.init(config);
+    const mockRequest = vi.spyOn(client['coreSdk'], 'request').mockResolvedValue(undefined);
+    const params = { itemId: '123', language: 'en', itemVersion: '1' };
+    await client.mutate('pages.context', { params });
+    expect(mockRequest).toHaveBeenCalledWith('pages.context:mutation', params);
+  });
+
+  it('should call coreSdk.request with pages.setValue in mutate()', async () => {
+    client = await ClientSDK.init(config);
+    const mockRequest = vi.spyOn(client['coreSdk'], 'request').mockResolvedValue(undefined);
+    const params = { value: 'test', canvasReload: false };
+    await client.mutate('pages.setValue', { params });
+    expect(mockRequest).toHaveBeenCalledWith('pages.setValue:mutation', params);
+  });
 });

packages/client/src/__tests__/sdk-types.test.ts

@@ -112,6 +112,23 @@ describe('sdk-types', () => {
     expect(mutationMap).toBeDefined();
   });
 
+  it('should validate pages.context MutationMap', () => {
+    const mutationMap: MutationMap = {
+      'pages.reloadCanvas': {
+        params: undefined,
+        response: undefined,
+        subscribe: false,
+      },
+      'pages.context': {
+        params: { itemId: 'item1', language: 'en', itemVersion: '2' },
+        response: undefined,
+        subscribe: false,
+      },
+    };
+    expect(mutationMap['pages.context'].params).toEqual({ itemId: 'item1', language: 'en', itemVersion: '2' });
+    expect(mutationMap['pages.context'].response).toBeUndefined();
+  });
+
   it('should validate QueryKey', () => {
     const queryKey: QueryKey = 'host.user';
     expect(queryKey).toBe('host.user');

packages/client/src/client.ts

@@ -145,9 +145,9 @@ export class ClientSDK {
     return Array.from(this.modules.keys());
   }
 
-  private resolveOperation(keyOrOperationKey: string): { request: Function; operation: string } {
+  private resolveOperation(keyOrOperationKey: string, type: 'query' | 'mutation'): { request: Function; operation: string } {
     let request = this.coreSdk.request.bind(this.coreSdk); // Bind to preserve context
-    let operation = keyOrOperationKey;
+    let operation = keyOrOperationKey + ':' + type; // Default operation name
 
     if (keyOrOperationKey.includes('.')) {
       const firstDotIndex = keyOrOperationKey.indexOf('.');
@@ -216,7 +216,7 @@ export class ClientSDK {
    */
 
   async query<K extends QueryKey>(key: K, queryOptions?: QueryOptions<K>): Promise<QueryResult<K>> {
-    const { request, operation } = this.resolveOperation(key as string);
+    const { request, operation } = this.resolveOperation(key as string, 'query');
 
     const { subscribe, onSuccess, onError, params, timeoutMs } = queryOptions || {};
     const hashedKey = subscribe ? key : await this.generateKeyWithHash(key, queryOptions);
@@ -339,7 +339,7 @@ export class ClientSDK {
     key: K,
     mutationOptions?: MutationOptions<K>,
   ): Promise<MutationMap[K]['response']> {
-    const { request, operation } = this.resolveOperation(key as string);
+    const { request, operation } = this.resolveOperation(key as string, 'mutation');
     const { onSuccess, onError, params, timeoutMs } = mutationOptions || {};
     logger.debug(`Mutation (${key}) initiated with params:`, params, `timeoutMs: ${timeoutMs}`);
 

packages/client/src/sdk-types.ts

@@ -1,5 +1,5 @@
 // Import shared types (e.g. User and ApplicationMetadata)
-import { ApplicationContext, UserInfo } from '@sitecore-marketplace-sdk/core';
+import { ApplicationContext, UserInfo, PagesContextParams } from '@sitecore-marketplace-sdk/core';
 
 // --- Host state types ---
 
@@ -224,6 +224,11 @@ export interface MutationMap {
     response: void;
     subscribe: false;
   };
+  'pages.context': {
+    params: PagesContextParams;
+    response: void;
+    subscribe: false;
+  };
 }
 
 // Utility types for keys

packages/core/src/post-message.ts

@@ -431,7 +431,9 @@ export class PostMessageBridge {
       message,
     );
 
-    const handler = this.requestHandlers.get(message.action);
+    const fullKey = message.action.split(':');
+    const actionWithoutPostfix = fullKey[0];
+    const handler = this.requestHandlers.get(message.action) ?? this.requestHandlers.get(actionWithoutPostfix);
     const catchAllHandler = this.requestHandlers.get('*');
     if (!handler && !catchAllHandler) {
       // No handler registered for this action, send an error response.

packages/core/src/shared-types.ts

@@ -137,3 +137,11 @@ export interface ExternalUrlPayload {
   newTab?: boolean;
 }
 
+/**
+ * Parameters for Pages Context mutation.
+ */
+export interface PagesContextParams {
+  itemId?: string;
+  language?: string;
+  itemVersion?: string;
+}