* add getMessageType function

kibertoad · Jun 19, 2024 · b10bb07 · b10bb07
1 parent 0cab04f
commit b10bb07
Showing 1 changed file with 85 additions and 86 deletions.
diff --git a/packages/schemas/lib/messages/baseMessageSchemas.ts b/packages/schemas/lib/messages/baseMessageSchemas.ts
@@ -1,37 +1,37 @@
 import z, {
-    type ZodLiteral,
-    type ZodObject,
-    type ZodOptional,
-    type ZodString,
-    type ZodRawShape,
+  type ZodLiteral,
+  type ZodObject,
+  type ZodOptional,
+  type ZodString,
+  type ZodRawShape,
 } from 'zod'
 
 import {
-    CONSUMER_BASE_EVENT_SCHEMA,
-    GENERATED_BASE_EVENT_SCHEMA,
-    OPTIONAL_GENERATED_BASE_EVENT_SCHEMA,
+  CONSUMER_BASE_EVENT_SCHEMA,
+  GENERATED_BASE_EVENT_SCHEMA,
+  OPTIONAL_GENERATED_BASE_EVENT_SCHEMA,
 } from '../events/baseEventSchemas'
-import type {CommonEventDefinition} from '../events/eventTypes'
+import type { CommonEventDefinition } from '../events/eventTypes'
 
 // External message metadata that describe the context in which the message was created, primarily used for debugging purposes
 export const MESSAGE_METADATA_SCHEMA = z
-    .object({
-        schemaVersion: z.string().min(1).describe('message schema version'),
-        // this is always set to a service that created the message
-        producedBy: z.string().min(1).describe('app/service that produced the message'),
-        // this is always propagated within the message chain. For the first message in the chain it is equal to "producedBy"
-        originatedFrom: z
-            .string()
-            .min(1)
-            .describe('app/service that initiated entire workflow that led to creating this message'),
-        // this is always propagated within the message chain.
-        correlationId: z.string().describe('unique identifier passed to all events in workflow chain'),
-    })
-    .describe('external message metadata')
+  .object({
+    schemaVersion: z.string().min(1).describe('message schema version'),
+    // this is always set to a service that created the message
+    producedBy: z.string().min(1).describe('app/service that produced the message'),
+    // this is always propagated within the message chain. For the first message in the chain it is equal to "producedBy"
+    originatedFrom: z
+      .string()
+      .min(1)
+      .describe('app/service that initiated entire workflow that led to creating this message'),
+    // this is always propagated within the message chain.
+    correlationId: z.string().describe('unique identifier passed to all events in workflow chain'),
+  })
+  .describe('external message metadata')
 
 export const MESSAGE_SCHEMA_EXTENSION = {
-    // For internal domain events that did not originate within a message chain metadata field can be omitted, producer should then assume it is initiating a new chain
-    metadata: MESSAGE_METADATA_SCHEMA.optional(),
+  // For internal domain events that did not originate within a message chain metadata field can be omitted, producer should then assume it is initiating a new chain
+  metadata: MESSAGE_METADATA_SCHEMA.optional(),
 }
 
 export const BASE_MESSAGE_SCHEMA = CONSUMER_BASE_EVENT_SCHEMA.extend(MESSAGE_SCHEMA_EXTENSION)
@@ -41,82 +41,81 @@ export type BaseMessageType = z.infer<typeof BASE_MESSAGE_SCHEMA>
 export type MessageMetadataType = z.infer<typeof MESSAGE_METADATA_SCHEMA>
 
 export type CommonMessageDefinitionSchemaType<T extends CommonEventDefinition> = z.infer<
-    T['consumerSchema']
+  T['consumerSchema']
 >
 
 type ReturnType<T extends ZodObject<Y>, Y extends ZodRawShape, Z extends string> = {
-    consumerSchema: ZodObject<{
-        id: ZodString
-        timestamp: ZodString
-        type: ZodLiteral<Z>
-        payload: T
-        metadata: ZodOptional<
-            ZodObject<{
-                schemaVersion: ZodString
-                producedBy: ZodString
-                originatedFrom: ZodString
-                correlationId: ZodString
-            }>
-        >
-    }>
-
-    publisherSchema: ZodObject<{
-        id: ZodOptional<ZodString>
-        timestamp: ZodOptional<ZodString>
-        type: ZodLiteral<Z>
-        payload: T
-        metadata: ZodOptional<
-            ZodObject<{
-                schemaVersion: ZodString
-                producedBy: ZodString
-                originatedFrom: ZodString
-                correlationId: ZodString
-            }>
-        >
-    }>
+  consumerSchema: ZodObject<{
+    id: ZodString
+    timestamp: ZodString
+    type: ZodLiteral<Z>
+    payload: T
+    metadata: ZodOptional<
+      ZodObject<{
+        schemaVersion: ZodString
+        producedBy: ZodString
+        originatedFrom: ZodString
+        correlationId: ZodString
+      }>
+    >
+  }>
+
+  publisherSchema: ZodObject<{
+    id: ZodOptional<ZodString>
+    timestamp: ZodOptional<ZodString>
+    type: ZodLiteral<Z>
+    payload: T
+    metadata: ZodOptional<
+      ZodObject<{
+        schemaVersion: ZodString
+        producedBy: ZodString
+        originatedFrom: ZodString
+        correlationId: ZodString
+      }>
+    >
+  }>
 }
 
 export type SchemaMetadata = {
-    description: string
+  description: string
 }
 
 export function enrichMessageSchemaWithBaseStrict<
-    T extends ZodObject<Y>,
-    Y extends ZodRawShape,
-    Z extends string,
+  T extends ZodObject<Y>,
+  Y extends ZodRawShape,
+  Z extends string,
 >(type: Z, payloadSchema: T, schemaMetadata: SchemaMetadata): ReturnType<T, Y, Z> {
-    return enrichMessageSchemaWithBase(type, payloadSchema, schemaMetadata)
+  return enrichMessageSchemaWithBase(type, payloadSchema, schemaMetadata)
 }
 
 export function enrichMessageSchemaWithBase<
-    T extends ZodObject<Y>,
-    Y extends ZodRawShape,
-    Z extends string,
+  T extends ZodObject<Y>,
+  Y extends ZodRawShape,
+  Z extends string,
 >(type: Z, payloadSchema: T, schemaMetadata?: Partial<SchemaMetadata>): ReturnType<T, Y, Z> {
-    const baseSchema = z.object({
-        type: z.literal(type),
-        payload: payloadSchema,
-    })
-
-    let consumerSchema =
-        GENERATED_BASE_EVENT_SCHEMA.merge(baseSchema).extend(MESSAGE_SCHEMA_EXTENSION)
-    let publisherSchema =
-        OPTIONAL_GENERATED_BASE_EVENT_SCHEMA.merge(baseSchema).extend(MESSAGE_SCHEMA_EXTENSION)
-
-    if (schemaMetadata?.description) {
-        consumerSchema = consumerSchema.describe(schemaMetadata.description)
-        publisherSchema = publisherSchema.describe(schemaMetadata.description)
-    }
-
-    return {
-        consumerSchema: consumerSchema,
-        publisherSchema: publisherSchema,
-    }
+  const baseSchema = z.object({
+    type: z.literal(type),
+    payload: payloadSchema,
+  })
+
+  let consumerSchema =
+    GENERATED_BASE_EVENT_SCHEMA.merge(baseSchema).extend(MESSAGE_SCHEMA_EXTENSION)
+  let publisherSchema =
+    OPTIONAL_GENERATED_BASE_EVENT_SCHEMA.merge(baseSchema).extend(MESSAGE_SCHEMA_EXTENSION)
+
+  if (schemaMetadata?.description) {
+    consumerSchema = consumerSchema.describe(schemaMetadata.description)
+    publisherSchema = publisherSchema.describe(schemaMetadata.description)
+  }
+
+  return {
+    consumerSchema: consumerSchema,
+    publisherSchema: publisherSchema,
+  }
 }
 
-export function getMessageType<T extends ZodObject<Y>,
-    Y extends ZodRawShape,
-    Z extends string>
-(richMessageSchema: ReturnType<T, Y, Z>): Z {
-    return richMessageSchema.consumerSchema.shape.type.value
+export function getMessageType<T extends ZodObject<Y>, Y extends ZodRawShape, Z extends string>(
+  richMessageSchema: ReturnType<T, Y, Z>,
+): Z {
+  return richMessageSchema.consumerSchema.shape.type.value
 }