refactor: use message event type down the line

src/handlers/signer.handlers.spec.ts

@@ -6,6 +6,7 @@ import type {
 } from '../types/icrc-requests';
 import type {IcrcReadyResponse, IcrcSupportedStandardsResponse} from '../types/icrc-responses';
 import {JSON_RPC_VERSION_2, type RpcId, type RpcResponseWithError} from '../types/rpc';
+import type {SignerMessageEvent} from '../types/signer';
 import {handleStatusRequest, handleSupportedStandards, notifyError} from './signer.handlers';
 
 describe('Signer handlers', () => {
@@ -44,7 +45,10 @@ describe('Signer handlers', () => {
 
   describe('notifyReady', () => {
     it('should post a message with the msg', () => {
-      const {handled} = handleStatusRequest({data: statusRequest, origin});
+      const {handled} = handleStatusRequest({
+        data: statusRequest,
+        origin
+      } as unknown as SignerMessageEvent);
 
       expect(handled).toBeTruthy();
 
@@ -58,7 +62,10 @@ describe('Signer handlers', () => {
     });
 
     it('should not handle msg if not status request', () => {
-      const {handled} = handleStatusRequest({data: supportedStandardsRequest, origin});
+      const {handled} = handleStatusRequest({
+        data: supportedStandardsRequest,
+        origin
+      } as unknown as SignerMessageEvent);
 
       expect(handled).toBeFalsy();
     });
@@ -85,7 +92,10 @@ describe('Signer handlers', () => {
 
   describe('notifySupportedStandards', () => {
     it('should post a message with the msg', () => {
-      const {handled} = handleSupportedStandards({data: supportedStandardsRequest, origin});
+      const {handled} = handleSupportedStandards({
+        data: supportedStandardsRequest,
+        origin
+      } as unknown as SignerMessageEvent);
 
       expect(handled).toBeTruthy();
 
@@ -100,7 +110,10 @@ describe('Signer handlers', () => {
       expect(postMessageMock).toHaveBeenCalledWith(expectedMessage, origin);
     });
     it('should not handle msg if not status request', () => {
-      const {handled} = handleSupportedStandards({data: statusRequest, origin});
+      const {handled} = handleSupportedStandards({
+        data: statusRequest,
+        origin
+      } as unknown as SignerMessageEvent);
 
       expect(handled).toBeFalsy();
     });

src/handlers/signer.handlers.ts

@@ -1,5 +1,4 @@
 import {SIGNER_SUPPORTED_STANDARDS} from '../constants/signer.constants';
-import type {SignerMessageEventData} from '../signer';
 import {
   IcrcWalletStatusRequestSchema,
   IcrcWalletSupportedStandardsRequestSchema
@@ -12,22 +11,17 @@ import {
   type RpcResponseError,
   type RpcResponseWithError
 } from '../types/rpc';
+import type {SignerMessageEvent} from '../types/signer';
 
-interface Notify {
-  id: RpcId;
-  origin: string;
-}
+type Notify = {id: RpcId} & Pick<SignerMessageEvent, 'origin'>;
 
-export const handleStatusRequest = ({
-  data,
-  ...rest
-}: {data: SignerMessageEventData} & Pick<Notify, 'origin'>): {handled: boolean} => {
+export const handleStatusRequest = ({data, origin}: SignerMessageEvent): {handled: boolean} => {
   const {success: isStatusRequest, data: statusData} =
     IcrcWalletStatusRequestSchema.safeParse(data);
 
   if (isStatusRequest) {
     const {id} = statusData;
-    notifyReady({id, ...rest});
+    notifyReady({id, origin});
     return {handled: true};
   }
 
@@ -46,14 +40,14 @@ const notifyReady = ({id, origin}: Notify): void => {
 
 export const handleSupportedStandards = ({
   data,
-  ...rest
-}: {data: SignerMessageEventData} & Pick<Notify, 'origin'>): {handled: boolean} => {
+  origin
+}: SignerMessageEvent): {handled: boolean} => {
   const {success: isSupportedStandardsRequest, data: supportedStandardsData} =
     IcrcWalletSupportedStandardsRequestSchema.safeParse(data);
 
   if (isSupportedStandardsRequest) {
     const {id} = supportedStandardsData;
-    notifySupportedStandards({id, ...rest});
+    notifySupportedStandards({id, origin});
     return {handled: true};
   }
 

src/signer.spec.ts

@@ -1,9 +1,10 @@
 import {type MockInstance} from 'vitest';
 import {SIGNER_SUPPORTED_STANDARDS, SignerErrorCode} from './constants/signer.constants';
 import * as signerHandlers from './handlers/signer.handlers';
-import {Signer, type SignerMessageEventData, type SignerParameters} from './signer';
+import {Signer, type SignerParameters} from './signer';
 import {ICRC25_SUPPORTED_STANDARDS, ICRC29_STATUS} from './types/icrc';
 import {JSON_RPC_VERSION_2} from './types/rpc';
+import type {SignerMessageEventData} from './types/signer';
 
 describe('Signer', () => {
   const mockParameters: SignerParameters = {};
@@ -121,10 +122,12 @@ describe('Signer', () => {
 
       window.dispatchEvent(messageEvent);
 
-      expect(handleStatusRequestSpy).toHaveBeenCalledWith({
-        data: messageEvent.data,
-        origin: testOrigin
-      });
+      expect(handleStatusRequestSpy).toHaveBeenCalledWith(
+        expect.objectContaining({
+          data: messageEvent.data,
+          origin: testOrigin
+        })
+      );
     });
 
     it('should notify an error if a message from different origin is dispatched', () => {

src/signer.ts

@@ -5,13 +5,8 @@ import {
   handleSupportedStandards,
   notifyError
 } from './handlers/signer.handlers';
-import type {
-  IcrcWalletPermissionsRequest,
-  IcrcWalletRequestPermissionsRequest,
-  IcrcWalletStatusRequest,
-  IcrcWalletSupportedStandardsRequest
-} from './types/icrc-requests';
 import {RpcRequestSchema} from './types/rpc';
+import type {SignerMessageEvent} from './types/signer';
 
 /**
  * The parameters to initialize a signer.
@@ -20,15 +15,6 @@ import {RpcRequestSchema} from './types/rpc';
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
 export interface SignerParameters {}
 
-export type SignerMessageEventData = Partial<
-  | IcrcWalletStatusRequest
-  | IcrcWalletRequestPermissionsRequest
-  | IcrcWalletPermissionsRequest
-  | IcrcWalletSupportedStandardsRequest
->;
-
-type SignerMessageEvent = MessageEvent<SignerMessageEventData>;
-
 export class Signer {
   #walletOrigin: string | undefined | null;
 
@@ -61,28 +47,24 @@ export class Signer {
     void this.onMessage(message);
   };
 
-  private readonly onMessage = async ({
-    data: msgData,
-    origin
-  }: SignerMessageEvent): Promise<void> => {
-    const {success, data: requestData} = RpcRequestSchema.safeParse(msgData);
+  private readonly onMessage = async (message: SignerMessageEvent): Promise<void> => {
+    const {data, origin} = message;
+
+    const {success, data: requestData} = RpcRequestSchema.safeParse(data);
 
     if (!success) {
       // We are only interested in JSON-RPC messages, so we are ignoring any other messages emitted at the window level, as the consumer might be using other events.
       return;
     }
 
-    this.assertAndSetOrigin({msgData, origin});
+    this.assertAndSetOrigin(message);
 
-    const {handled: statusRequestHandled} = handleStatusRequest({origin, data: msgData});
+    const {handled: statusRequestHandled} = handleStatusRequest(message);
     if (statusRequestHandled) {
       return;
     }
 
-    const {handled: supportedStandardsRequestHandled} = handleSupportedStandards({
-      origin,
-      data: msgData
-    });
+    const {handled: supportedStandardsRequestHandled} = handleSupportedStandards(message);
     if (supportedStandardsRequestHandled) {
       return;
     }
@@ -97,13 +79,7 @@ export class Signer {
     });
   };
 
-  private assertAndSetOrigin({
-    msgData,
-    origin
-  }: {
-    origin: string;
-    msgData: SignerMessageEventData;
-  }): void {
+  private assertAndSetOrigin({data: msgData, origin}: SignerMessageEvent): void {
     if (nonNullish(this.#walletOrigin) && this.#walletOrigin !== origin) {
       const {data} = RpcRequestSchema.safeParse(msgData);
 

src/types/signer.ts

@@ -0,0 +1,15 @@
+import type {
+  IcrcWalletPermissionsRequest,
+  IcrcWalletRequestPermissionsRequest,
+  IcrcWalletStatusRequest,
+  IcrcWalletSupportedStandardsRequest
+} from './icrc-requests';
+
+export type SignerMessageEventData = Partial<
+  | IcrcWalletStatusRequest
+  | IcrcWalletRequestPermissionsRequest
+  | IcrcWalletPermissionsRequest
+  | IcrcWalletSupportedStandardsRequest
+>;
+
+export type SignerMessageEvent = MessageEvent<SignerMessageEventData>;