feat: 🎸 Updated messages schemes and types

Author: kostysh

examples/client/src/App.tsx

@@ -16,6 +16,8 @@ const defaultExpire = '30s';
 /** Default topic to publish requests the same as for the supplier node */
 const defaultTopic = 'hello';
 
+type RequestsRegistryRecord = Required<RequestRecord<RequestQuery, OfferOptions>>;
+
 interface FormValues {
   topic: string;
   message: string;
@@ -27,7 +29,7 @@ interface RequestFormProps {
 }
 
 interface RequestsProps {
-  requests: Required<RequestRecord<RequestQuery, OfferOptions>>[];
+  requests: RequestsRegistryRecord[];
   subscribed?: (id: string) => boolean;
   onClear(): void;
   onCancel(id: string): void;
@@ -147,7 +149,7 @@ export const Requests = ({ requests, subscribed, onClear, onCancel }: RequestsPr
 export const App = () => {
   const client = useRef<Client<RequestQuery, OfferOptions> | undefined>();
   const [connected, setConnected] = useState<boolean>(false);
-  const [requests, setRequests] = useState<Required<RequestRecord<RequestQuery, OfferOptions>>[]>(
+  const [requests, setRequests] = useState<RequestsRegistryRecord[]>(
     [],
   );
   const [error, setError] = useState<string | undefined>();

src/client/index.ts

@@ -329,10 +329,10 @@ export class Client<
         }
 
         /** Check is the message is an offer */
-        const offer = createOfferDataSchema<
-          z.ZodType<CustomRequestQuery>,
-          z.ZodType<CustomOfferOptions>
-        >(this.querySchema, this.offerOptionsSchema).parse(JSON.parse(decodeText(detail.data)));
+        const offer = createOfferDataSchema<CustomRequestQuery, CustomOfferOptions>(
+          this.querySchema,
+          this.offerOptionsSchema,
+        ).parse(JSON.parse(decodeText(detail.data)));
         logger.trace('Offer received:', offer);
 
         // Verify the offer

src/client/requestsRegistry.ts

@@ -19,24 +19,29 @@ const logger = createLogger('RequestsRegistry');
 /**
  * Creates request record schema
  *
- * @param {z.ZodType} querySchema Custom request query schema
- * @param {z.ZodType} offerOptionsSchema
+ * @template {CustomRequestQuery}
+ * @template {CustomOfferOptions}
+ * @param {z.ZodType<CustomRequestQuery>} querySchema Custom request query schema
+ * @param {z.ZodType<CustomOfferOptions>} offerOptionsSchema
  * @returns {z.ZodType} Request record schema
  */
 export const createRequestRecordSchema = <
-  TQuery extends z.ZodTypeAny,
-  TOfferOptions extends z.ZodTypeAny,
+  CustomRequestQuery extends GenericQuery,
+  CustomOfferOptions extends GenericOfferOptions,
 >(
-  querySchema: TQuery,
-  offerOptionsSchema: TOfferOptions,
+  querySchema: z.ZodType<CustomRequestQuery>,
+  offerOptionsSchema: z.ZodType<CustomOfferOptions>,
 ) =>
   z
     .object({
       /** Raw request data */
-      data: createRequestDataSchema<TQuery>(querySchema),
+      data: createRequestDataSchema<CustomRequestQuery>(querySchema),
       /** Offers associated with a request*/
       offers: z.array(
-        createOfferDataSchema<TQuery, TOfferOptions>(querySchema, offerOptionsSchema),
+        createOfferDataSchema<CustomRequestQuery, CustomOfferOptions>(
+          querySchema,
+          offerOptionsSchema,
+        ),
       ),
       /** Request cancelation flag */
       cancelled: z.boolean().default(false),
@@ -84,11 +89,7 @@ export type RequestsRegistryOptions<
 export type RequestRecord<
   CustomRequestQuery extends GenericQuery,
   CustomOfferOptions extends GenericOfferOptions,
-> = z.infer<
-  ReturnType<
-    typeof createRequestRecordSchema<z.ZodType<CustomRequestQuery>, z.ZodType<CustomOfferOptions>>
-  >
->;
+> = z.infer<ReturnType<typeof createRequestRecordSchema<CustomRequestQuery, CustomOfferOptions>>>;
 
 /**
  * Request manager events interface
@@ -260,10 +261,10 @@ export class RequestsRegistry<
 
       for (let requestRecord of rawRecords) {
         try {
-          requestRecord = createRequestRecordSchema<
-            z.ZodType<CustomRequestQuery>,
-            z.ZodType<CustomOfferOptions>
-          >(this.client.querySchema, this.client.offerOptionsSchema).parse(requestRecord);
+          requestRecord = createRequestRecordSchema<CustomRequestQuery, CustomOfferOptions>(
+            this.client.querySchema,
+            this.client.offerOptionsSchema,
+          ).parse(requestRecord);
 
           // `record.data` marked as optional because of Zod generics issue
           this.requests.set(
@@ -379,13 +380,11 @@ export class RequestsRegistry<
       throw new Error('Client not connected to the coordination server yet');
     }
 
-    request = createRequestDataSchema<z.ZodType<CustomRequestQuery>>(this.client.querySchema).parse(
-      request,
-    );
-    const requestRecord = createRequestRecordSchema<
-      z.ZodType<CustomRequestQuery>,
-      z.ZodType<CustomOfferOptions>
-    >(this.client.querySchema, this.client.offerOptionsSchema).parse({
+    request = createRequestDataSchema<CustomRequestQuery>(this.client.querySchema).parse(request);
+    const requestRecord = createRequestRecordSchema<CustomRequestQuery, CustomOfferOptions>(
+      this.client.querySchema,
+      this.client.offerOptionsSchema,
+    ).parse({
       data: request,
       offers: [],
     });
@@ -452,7 +451,7 @@ export class RequestsRegistry<
 
     this.requests.set(
       id,
-      createRequestRecordSchema<z.ZodType<CustomRequestQuery>, z.ZodType<CustomOfferOptions>>(
+      createRequestRecordSchema<CustomRequestQuery, CustomOfferOptions>(
         this.client.querySchema,
         this.client.offerOptionsSchema,
       ).parse(record),
@@ -512,7 +511,7 @@ export class RequestsRegistry<
    * @memberof RequestsRegistry
    */
   addOffer(offer: OfferData<CustomRequestQuery, CustomOfferOptions>) {
-    offer = createOfferDataSchema<z.ZodType<CustomRequestQuery>, z.ZodType<CustomOfferOptions>>(
+    offer = createOfferDataSchema<CustomRequestQuery, CustomOfferOptions>(
       this.client.querySchema,
       this.client.offerOptionsSchema,
     ).parse(offer);
@@ -529,7 +528,7 @@ export class RequestsRegistry<
 
     this.requests.set(
       requestId,
-      createRequestRecordSchema<z.ZodType<CustomRequestQuery>, z.ZodType<CustomOfferOptions>>(
+      createRequestRecordSchema<CustomRequestQuery, CustomOfferOptions>(
         this.client.querySchema,
         this.client.offerOptionsSchema,
       ).parse({

src/node/index.ts

@@ -249,7 +249,7 @@ export class Node<
     }
 
     const offer = await buildOffer<CustomRequestQuery, CustomOfferOptions>(
-      createBuildOfferOptions<z.ZodType<CustomRequestQuery>, z.ZodType<CustomOfferOptions>>(
+      createBuildOfferOptions<CustomRequestQuery, CustomOfferOptions>(
         this.querySchema,
         this.offerOptionsSchema,
       ).parse({

src/node/requestManager.ts

@@ -45,7 +45,7 @@ export class RequestManager<CustomRequestQuery extends GenericQuery> extends Eve
   }
 
   add(topic: string, data: string) {
-    const requestData = createRequestDataSchema<typeof this.querySchema>(this.querySchema).parse(
+    const requestData = createRequestDataSchema<CustomRequestQuery>(this.querySchema).parse(
       JSON.parse(data),
     );
 

src/shared/messages.ts

@@ -36,10 +36,13 @@ export type GenericQuery = z.infer<typeof GenericQuerySchema>;
 /**
  * Creates request data structure schema
  *
- * @param {z.ZodType} querySchema
+ * @template {CustomRequestQuery}
+ * @param {z.ZodType<CustomRequestQuery>} querySchema
  * @returns {z.ZodType}
  */
-export const createRequestDataSchema = <T extends z.ZodTypeAny>(querySchema: T) =>
+export const createRequestDataSchema = <CustomRequestQuery extends GenericQuery>(
+  querySchema: z.ZodType<CustomRequestQuery>,
+) =>
   GenericMessageSchema.extend({
     /** Request topic */
     topic: z.string(),
@@ -51,16 +54,19 @@ export const createRequestDataSchema = <T extends z.ZodTypeAny>(querySchema: T)
  * Request data type
  */
 export type RequestData<CustomRequestQuery extends GenericQuery> = z.infer<
-  ReturnType<typeof createRequestDataSchema<z.ZodType<CustomRequestQuery>>>
+  ReturnType<typeof createRequestDataSchema<CustomRequestQuery>>
 >;
 
 /**
  * Creates schema for buildRequest method options
  *
- * @param {z.ZodType} querySchema
+ * @template {CustomRequestQuery}
+ * @param {z.ZodType<CustomRequestQuery>} querySchema
  * @returns {z.ZodType}
  */
-export const createBuildRequestOptions = <T extends z.ZodTypeAny>(querySchema: T) =>
+export const createBuildRequestOptions = <CustomRequestQuery extends GenericQuery>(
+  querySchema: z.ZodType<CustomRequestQuery>,
+) =>
   z
     .object({
       /** Expiration time */
@@ -82,23 +88,25 @@ export const createBuildRequestOptions = <T extends z.ZodTypeAny>(querySchema: T
  * buildRequest method options type
  */
 export type BuildRequestOptions<CustomRequestQuery extends GenericQuery> = z.infer<
-  ReturnType<typeof createBuildRequestOptions<z.ZodType<CustomRequestQuery>>>
+  ReturnType<typeof createBuildRequestOptions<CustomRequestQuery>>
 >;
 
 /**
  * Builds a request
  *
- * @template CustomRequestQuery
+ * @template {CustomRequestQuery}
  * @param {BuildRequestOptions<CustomRequestQuery>} requestOptions
  * @returns
  */
 export const buildRequest = async <CustomRequestQuery extends GenericQuery>(
   requestOptions: BuildRequestOptions<CustomRequestQuery>,
 ) => {
-  const { expire, nonce, topic, query, querySchema, idOverride } = createBuildRequestOptions<
-    typeof requestOptions.querySchema
-  >(requestOptions.querySchema).parse(requestOptions);
-  const request = createRequestDataSchema<typeof querySchema>(querySchema);
+  const { expire, nonce, topic, query, idOverride } = createBuildRequestOptions<CustomRequestQuery>(
+    requestOptions.querySchema as z.ZodType<CustomRequestQuery>,
+  ).parse(requestOptions);
+  const request = createRequestDataSchema<CustomRequestQuery>(
+    requestOptions.querySchema as z.ZodType<CustomRequestQuery>,
+  );
   return (await request.parseAsync({
     id: idOverride ?? uuid4(),
     expire: typeof expire === 'number' ? parseSeconds(expire) : nowSec() + parseSeconds(expire),
@@ -178,21 +186,21 @@ export type GenericOfferOptions = z.infer<typeof GenericOfferOptionsSchema>;
 /**
  * Creates a final offer data schema
  *
- * @template TQuery
- * @template TOfferOptions
- * @param {TQuery} querySchema
- * @param {TOfferOptions} offerOptionsSchema
+ * @template {CustomRequestQuery}
+ * @template {CustomOfferOptions}
+ * @param {z.ZodType<CustomRequestQuery>} querySchema
+ * @param {z.ZodType<CustomOfferOptions>} offerOptionsSchema
  */
 export const createOfferDataSchema = <
-  TQuery extends z.ZodTypeAny,
-  TOfferOptions extends z.ZodTypeAny,
+  CustomRequestQuery extends GenericQuery,
+  CustomOfferOptions extends GenericOfferOptions,
 >(
-  querySchema: TQuery,
-  offerOptionsSchema: TOfferOptions,
+  querySchema: z.ZodType<CustomRequestQuery>,
+  offerOptionsSchema: z.ZodType<CustomOfferOptions>,
 ) =>
   GenericMessageSchema.extend({
     /** Copy of request */
-    request: createRequestDataSchema<TQuery>(querySchema),
+    request: createRequestDataSchema<CustomRequestQuery>(querySchema),
     /** Offer options */
     options: offerOptionsSchema,
     /** Payment options */
@@ -211,11 +219,7 @@ export const createOfferDataSchema = <
 export type OfferData<
   CustomRequestQuery extends GenericQuery,
   CustomOfferOptions extends GenericOfferOptions,
-> = z.infer<
-  ReturnType<
-    typeof createOfferDataSchema<z.ZodType<CustomRequestQuery>, z.ZodType<CustomOfferOptions>>
-  >
->;
+> = z.infer<ReturnType<typeof createOfferDataSchema<CustomRequestQuery, CustomOfferOptions>>>;
 
 /**
  * EIP-712 JSON schema types for offer
@@ -260,17 +264,17 @@ export const offerEip712Types: Record<string, Array<TypedDataField>> = {
 /**
  * Creates a schema for `buildOffer` method options
  *
- * @template TQuery
- * @template TOfferOptions
- * @param {TQuery} querySchema
- * @param {TOfferOptions} offerOptionsSchema
+ * @template {CustomRequestQuery}
+ * @template {CustomOfferOptions}
+ * @param {z.ZodType<CustomRequestQuery>} querySchema
+ * @param {z.ZodType<CustomOfferOptions>} offerOptionsSchema
  */
 export const createBuildOfferOptions = <
-  TQuery extends z.ZodTypeAny,
-  TOfferOptions extends z.ZodTypeAny,
+  CustomRequestQuery extends GenericQuery,
+  CustomOfferOptions extends GenericOfferOptions,
 >(
-  querySchema: TQuery,
-  offerOptionsSchema: TOfferOptions,
+  querySchema: z.ZodType<CustomRequestQuery>,
+  offerOptionsSchema: z.ZodType<CustomOfferOptions>,
 ) =>
   z
     .object({
@@ -280,7 +284,7 @@ export const createBuildOfferOptions = <
       optionsSchema: z.instanceof(z.ZodType),
       supplierId: z.string(),
       expire: z.string().or(z.number()),
-      request: createRequestDataSchema<TQuery>(querySchema),
+      request: createRequestDataSchema<CustomRequestQuery>(querySchema),
       options: offerOptionsSchema,
       payment: z.array(PaymentOptionSchema),
       cancel: z.array(CancelOptionSchema),
@@ -293,26 +297,17 @@ export const createBuildOfferOptions = <
 
 /**
  * Type for `buildOffer` method options
- *
- * @template TQuery
- * @template TOfferOptions
- * @param {TQuery} querySchema
- * @param {TOfferOptions} offerOptionsSchema
  */
 export type BuildOfferOptions<
   CustomRequestQuery extends GenericQuery,
   CustomOfferOptions extends GenericOfferOptions,
-> = z.infer<
-  ReturnType<
-    typeof createBuildOfferOptions<z.ZodType<CustomRequestQuery>, z.ZodType<CustomOfferOptions>>
-  >
->;
+> = z.infer<ReturnType<typeof createBuildOfferOptions<CustomRequestQuery, CustomOfferOptions>>>;
 
 /**
  * Builds an offer
  *
- * @template CustomRequestQuery
- * @template CustomOfferOptions
+ * @template {CustomRequestQuery}
+ * @template {CustomOfferOptions}
  * @param {BuildOfferOptions<CustomRequestQuery, CustomOfferOptions>} offerOptions
  * @returns
  */
@@ -333,13 +328,11 @@ export const buildOffer = async <
     transferable,
     signer,
     signatureOverride,
-    querySchema,
-    optionsSchema,
     idOverride,
     expire,
-  } = createBuildOfferOptions<typeof offerOptions.querySchema, typeof offerOptions.optionsSchema>(
-    offerOptions.querySchema,
-    offerOptions.optionsSchema,
+  } = createBuildOfferOptions<CustomRequestQuery, CustomOfferOptions>(
+    offerOptions.querySchema as z.ZodType<CustomRequestQuery>,
+    offerOptions.optionsSchema as z.ZodType<CustomOfferOptions>,
   ).parse(offerOptions);
 
   const unsignedOfferPayload = UnsignedOfferPayloadSchema.parse({
@@ -372,10 +365,10 @@ export const buildOffer = async <
     throw new Error('Either signer or signatureOverride must be provided');
   }
 
-  const offerSchema = createOfferDataSchema<
-    typeof offerOptions.querySchema,
-    typeof offerOptions.optionsSchema
-  >(querySchema, optionsSchema);
+  const offerSchema = createOfferDataSchema<CustomRequestQuery, CustomOfferOptions>(
+    offerOptions.querySchema as z.ZodType<CustomRequestQuery>,
+    offerOptions.optionsSchema as z.ZodType<CustomOfferOptions>,
+  );
 
   return (await offerSchema.parseAsync({
     id: idOverride ?? uuid4(),
@@ -393,8 +386,8 @@ export const buildOffer = async <
 /**
  * Verifies signed offer
  *
- * @template CustomRequestQuery
- * @template CustomOfferOptions
+ * @template {CustomRequestQuery}
+ * @template {CustomOfferOptions}
  * @param {ContractConfig} contract
  * @param {string} supplierAddress
  * @param {OfferData<CustomRequestQuery, CustomOfferOptions>} offer