[RFC] Messaging RequestBody and ResponseBody type export #334

Activity

1. louisgv

   added

   enhancementNew feature or requestNew feature or request

   on Dec 13, 2022
2. louisgv

   self-assigned this

   on Apr 16, 2023
3. louisgv commented on Apr 16, 2023

   

   louisgv

   on Apr 16, 2023

   Last edited by louisgv

   ContributorAuthor

   More actions

   import "@plasmohq/messaging"
   
   import {
     type RequestBody,
     type RequestResponse
   } from "~background/messages/hash-tx"
   
   interface MmMetadata {
     "get-manifest": {}
     "hash-tx": {
       req: RequestBody
       res: RequestResponse
     }
     "math/add": {}
   }
   
   interface MpMetadata {
     mail: {}
   }
   
   declare module "@plasmohq/messaging" {
     interface MessagesMetadata extends MmMetadata {}
     interface PortsMetadata extends MpMetadata {}
   
     namespace PlasmoMessaging {
       interface SendFx<TName = string> {
         <RequestBody = any, ResponseBody = any>(
           request: Request<TName, RequestBody>
         ): Promise<ResponseBody>
       }
     }
   }
   
   type d = MmMetadata["hash-tx"]["req"]

   This feature atm is pretty hard lol I need a TS expert to go through it with

   Basically, we need an expert at type inference and type generation. How can I infer MmMetadata["hash-tx"]["req"] to the sendToBackground call like this:

   sendToBackground({
     name: "hash-tx",
     body: {}// <- this should have the type of MmMetadata["hash-tx"]["req"]
   })// This should return Promise<MmMetadata["hash-tx"]["res"]>

   I'm basically stumped.
4. louisgv

   added

   help wantedExtra attention is neededExtra attention is needed

   on Apr 16, 2023
5. louisgv commented on Apr 16, 2023

   

   louisgv

   on Apr 16, 2023

   ContributorAuthor

   More actions

   This is another attempt:

     export interface MessageSendFx {
       (
         request: Request<MessageName, MessagesMetadata[MessageName]["req"]>
       ): Promise<MessagesMetadata[MessageName]["res"]>
     }

   But it will not infer the exact ReqBody/ResBody pair given the name. It will just merge them all up. Is there a way to infer them???
6. louisgv commented on Apr 17, 2023

   

   louisgv

   on Apr 17, 2023

   ContributorAuthor

   More actions

   Some other refs from tRPC for inspo:

   • https://github.com/trpc/trpc/blob/main/packages/client/src/createTRPCClient.ts
   • https://github.com/trpc/trpc/blob/main/packages/server/src/shared/jsonify.ts
7. dmwyatt commented on Jun 16, 2023

   

   dmwyatt

   on Jun 16, 2023

   More actions

   I was doing something vaguely similar in a different project. I'm completely new to Plasmo so this is probably not even what you're wanting.

   This is just me typing out my thoughts. I want to reiterate I probably don't even understand the problem!

   I think this will select the types based on the message name instead of just merging the request/response?

   type MmMetadata = {
     "get-manifest": {}
     "hash-tx": {
       req: RequestBody
       res: RequestResponse
     }
     "math/add": {}
   }
   
   type RequestBody = {
     a: string
     b: number
   }
   
   type RequestResponse = {
     c: boolean
   }
   
   // Map over MmMetadata to create a new type with request and response types for each message
   type MessageTypes = {
     [K in keyof MmMetadata]: MmMetadata[K] extends { req: infer R, res: infer S } ? { request: R, response: S } : never
   }
   
   // Now you can use a conditional type in sendToBackground to select the correct types
   declare function sendToBackground<TName extends keyof MessageTypes>(
     request: { name: TName, body: MessageTypes[TName]['request'] }
   ): Promise<MessageTypes[TName]['response']>;
   
   // Usage example
   let result = sendToBackground({
     name: "hash-tx",
     body: {
       a: "string",
       b: 1
     }
   }); // result is of type Promise<RequestResponse>

   👍React with 👍1Reacted by Piotr

   ❤️React with ❤️1Reacted by L
8. Dan-RewardedInterest commented on Dec 20, 2024

   

   Dan-RewardedInterest

   on Dec 20, 2024

   More actions

   Hey team. Just wondering if there was any progress on this.

   Happy to help if there is anything to be done.

   Thanks for such an awesome project!!!

   ❤️React with ❤️1Reacted by Omar_7ioo