Adds external message handler type

PlasmoHQ · Apr 25, 2024 · ce2e0d3 · ce2e0d3
1 parent 4b20b0b
commit ce2e0d3
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/api/messaging/src/types.ts b/api/messaging/src/types.ts
@@ -22,6 +22,11 @@ export namespace PlasmoMessaging {
     targetOrigin?: string
   }
 
+  export type ExternalRequest<TName = any, TBody = Record<any, any>> = {
+    name: TName
+    sender: chrome.runtime.MessageSender
+  } & TBody
+
   export type RelayMessage<TName = any, TBody = any> = Request<TName, TBody> & {
     /**
      * Used to resolve corresponding window.postMessage messages
@@ -49,6 +54,15 @@ export namespace PlasmoMessaging {
     response: Response<ResponseBody>
   ) => void | Promise<void> | boolean
 
+  export type ExternalHandler<
+    RequestName = string,
+    RequestBody = any,
+    ResponseBody = any
+  > = (
+    request: ExternalRequest<RequestName, RequestBody>,
+    response: Response<ResponseBody>
+  ) => void | Promise<void> | boolean
+
   export type PortHandler<RequestBody = any, ResponseBody = any> = Handler<
     PortName,
     RequestBody,
@@ -61,6 +75,11 @@ export namespace PlasmoMessaging {
     ResponseBody
   >
 
+  export type ExternalMessageHandler<
+    RequestBody = any,
+    ResponseBody = any
+  > = ExternalHandler<string, RequestBody, ResponseBody>
+
   export interface SendFx<TName = string> {
     <RequestBody = any, ResponseBody = any>(
       request: Request<TName, RequestBody>,