@palmetto/pubsub 3.2.2 → 3.2.3

package/README.md

@@ -55,7 +55,7 @@ yarn add @palmetto/pubsub zod @palmetto/trace dd-trace
    const publisher = new Publisher(console, [rabbitMqPublisher]);
 
    const message: Model = {
-     id: undefined,
+     id: undefined, // leave id and meta undefined, the publisher will set these
      meta: undefined,
      message: "Hello, world!",
    };

package/dist/interfaces.d.ts

@@ -1,22 +1,28 @@
 import { z } from "zod";
+/**
+ * The schema for the metadata of a message. This is added by the publisher if not provided, but can also be provided by the publisher if they want to set specific values.
+ */
 export declare const MetaSchema: z.ZodObject<{
-    createdAt: z.ZodISODateTime;
-    schemaId: z.ZodString;
-    publishedBy: z.ZodString;
+    createdAt: z.ZodOptional<z.ZodISODateTime>;
+    schemaId: z.ZodOptional<z.ZodString>;
+    publishedBy: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
+/**
+ * The id and meta fields that are added to all messages by the publisher if not provided.
+ */
 export declare const IdMetaSchema: z.ZodObject<{
     id: z.ZodOptional<z.ZodString>;
     meta: z.ZodOptional<z.ZodObject<{
-        createdAt: z.ZodISODateTime;
-        schemaId: z.ZodString;
-        publishedBy: z.ZodString;
+        createdAt: z.ZodOptional<z.ZodISODateTime>;
+        schemaId: z.ZodOptional<z.ZodString>;
+        publishedBy: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>>;
 }, z.core.$strip>;
 export type Meta = z.infer<typeof MetaSchema>;
 /**
  * All messages should be based on this schema
  */
-export type BaseMessage = z.infer<typeof IdMetaSchema>;
+export type BaseMessage = Record<string, unknown> & z.infer<typeof IdMetaSchema>;
 export interface PublishMessageOptions {
     /**
      * The date and time at which the message should be published. Only supported by BullMq at this time.

package/dist/interfaces.js

@@ -2,13 +2,35 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MessageResult = exports.IdMetaSchema = exports.MetaSchema = void 0;
 const zod_1 = require("zod");
+/**
+ * The schema for the metadata of a message. This is added by the publisher if not provided, but can also be provided by the publisher if they want to set specific values.
+ */
 exports.MetaSchema = zod_1.z.object({
-    createdAt: zod_1.z.iso.datetime(),
-    schemaId: zod_1.z.string(),
-    publishedBy: zod_1.z.string(),
+    /**
+     * The date and time at which the message was created.
+     */
+    createdAt: zod_1.z.iso.datetime().optional(),
+    /**
+     * The unique identifier for the schema used by the message. Currently a hash of the JSON schema definition, but could be changed in the future to for example a UUID or a URL where the schema can be found.
+     */
+    schemaId: zod_1.z.string().optional(),
+    /**
+     * The identifier of the entity that published the message. (currently an empty string, but could be used to identify the service that published the message)
+     */
+    publishedBy: zod_1.z.string().optional(),
 });
+/**
+ * The id and meta fields that are added to all messages by the publisher if not provided.
+ */
 exports.IdMetaSchema = zod_1.z.object({
+    /**
+     * A unique identifier for the message. If not provided, one will be generated during publish.
+     */
     id: zod_1.z.string().optional(),
+    /**
+     * Metadata about the message, such as when it was created, which schema it uses, etc.
+     * This is optional when publishing a message, but will be added by the publisher if not provided.
+     */
     meta: exports.MetaSchema.optional(),
 });
 var MessageResult;

package/dist/publisher.js

@@ -80,6 +80,7 @@ class Publisher {
                 }
                 else {
                     msg.meta.schemaId = schemaId;
+                    msg.meta.createdAt = new Date().toISOString();
                 }
                 const check = schema.safeEncode(msg);
                 if (!check.success) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@palmetto/pubsub",
-  "version": "3.2.2",
+  "version": "3.2.3",
   "repository": {
     "type": "git",
     "url": "https://github.com/palmetto/galaxy"