@palmetto/dispatch-pubsub 0.1.0

package/README.md

@@ -0,0 +1,68 @@
+# @palmetto/dispatch-pubsub
+
+Shared configurations for Dispatch Service messages.
+
+## Installation
+
+First, install peer dependencies
+
+```sh
+yarn add @palmetto/pubsub amqp-connection-manager amqplib zod
+```
+
+```sh
+yarn add @palmetto/dispatch-pubsub
+```
+
+## Usage
+
+### Get and use a configuration
+
+```ts
+import { SupplierEvent, SupplierMessage, SuppliersPubSubConfig } from "@palmetto/dispatch-pubsub";
+import { MessageResult, RabbitMqSubscriber, Subscriber } from "@palmetto/pubsub";
+
+const rabbitMqSubscriber = new RabbitMqSubscriber(...);
+const subscriber = new Subscriber(console, [rabbitMqSubscriber]);
+
+function onMessage(message: SupplierMessage) {
+  switch (message.event) {
+    case SupplierEvent.Created:
+      console.log(`Got new Supplier: ${message.data.id}`)
+      // ...
+  }
+
+  return MessageResult.Ok;
+};
+
+await subscriber.startSubscribe({
+  retries: 3,               // add custom parameters first
+  ...SuppliersPubSubConfig, // override with shared config
+}, onMessage);
+```
+
+## Events
+
+### `dispatch.accepted`
+
+Fired when a Dispatch's status is changed to `ACCEPTED`. A Dispatch's status is set to `ACCEPTED` via the API when a Supplier choses to accept a Project. Auto-accepted Dispatches do **NOT** fire this event, since the status is not _changed_ into `ACCEPTED`.
+
+### `dispatch.created`
+
+Fired when a Dispatch is created. Dispatches are created when the matching engine pairs a Project with a Supplier. If conditions are met for auto-acceptance, the Dispatch will be created in the `ACCEPTED` status and a [`dispatch.accepted`](#dispatchaccepted) event will **NOT** be fired.
+
+### `dispatch.rejected`
+
+Fired when a Dispatch's status is changed to `REJECTED`. A Dispatch's status is set to `REJECTED` via the API when a Supplier choses to reject a Project.
+
+### `dispatch.withdrawn`
+
+Fired when a Dispatch's status is changed to `WITHDRAWN`. A Dispatch's status is set to `WITHDRAWN` automatically when a Dispatch is not accepted or rejected by a Supplier within a certain timeframe.
+
+### `project.created`
+
+Fired when a Project is created. Projects are created via the API.
+
+### `supplier.created`
+
+Fired when a Supplier is created. Suppliers are created via the API.

package/dist/config.d.ts

@@ -0,0 +1,17 @@
+import { BaseMessage, IdMetaSchema, RabbitQueueExchangeConfiguration } from "@palmetto/pubsub";
+import { $ZodObject, $ZodType } from "zod/v4/core";
+type IdMetaShape = typeof IdMetaSchema.shape;
+export interface MessageSchemaShape<T extends string> extends IdMetaShape {
+    event: $ZodType<T>;
+    data: $ZodObject;
+}
+export type MessageSchema<T extends string> = $ZodObject<Readonly<MessageSchemaShape<T>>>;
+export interface Message<T extends string> extends BaseMessage {
+    event: T;
+    data: Record<string, unknown>;
+}
+export interface PubSubEventConfig<T extends string> extends Omit<RabbitQueueExchangeConfiguration, "schema"> {
+    schema: MessageSchema<T>;
+}
+export declare function rabbitMqConfig<T extends string>(name: string, schema: MessageSchema<T>): PubSubEventConfig<T>;
+export {};

package/dist/config.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rabbitMqConfig = rabbitMqConfig;
+const pubsub_1 = require("@palmetto/pubsub");
+function rabbitMqConfig(name, schema) {
+    return {
+        name,
+        schema,
+        exchangeType: "fanout",
+        transport: pubsub_1.RABBITMQ_TRANSPORT,
+    };
+}
+//# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";;AAgCA,wCAUC;AA1CD,6CAK0B;AA2B1B,SAAgB,cAAc,CAC5B,IAAY,EACZ,MAAwB;IAExB,OAAO;QACL,IAAI;QACJ,MAAM;QACN,YAAY,EAAE,QAAQ;QACtB,SAAS,EAAE,2BAAkB;KAC9B,CAAC;AACJ,CAAC"}

package/dist/configs/dispatches.d.ts

@@ -0,0 +1,18 @@
+import { z } from "zod";
+export declare enum DispatchEvent {
+    Created = "dispatch.created"
+}
+export declare const DispatchMessageSchema: z.ZodObject<{
+    event: z.ZodEnum<typeof DispatchEvent>;
+    data: z.ZodObject<{
+        id: z.ZodString;
+    }, z.core.$strip>;
+    id: z.ZodOptional<z.ZodString>;
+    meta: z.ZodOptional<z.ZodObject<{
+        createdAt: z.ZodOptional<z.ZodISODateTime>;
+        schemaId: z.ZodOptional<z.ZodString>;
+        publishedBy: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type DispatchMessage = z.infer<typeof DispatchMessageSchema>;
+export declare const DispatchesPubSubConfig: import("../config.js").PubSubEventConfig<DispatchEvent>;

package/dist/configs/dispatches.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DispatchesPubSubConfig = exports.DispatchMessageSchema = exports.DispatchEvent = void 0;
+const pubsub_1 = require("@palmetto/pubsub");
+const zod_1 = require("zod");
+const config_js_1 = require("../config.js");
+var DispatchEvent;
+(function (DispatchEvent) {
+    DispatchEvent["Created"] = "dispatch.created";
+})(DispatchEvent || (exports.DispatchEvent = DispatchEvent = {}));
+exports.DispatchMessageSchema = zod_1.z.object(Object.assign(Object.assign({}, pubsub_1.IdMetaSchema.shape), { event: zod_1.z.enum(DispatchEvent), data: zod_1.z.object({
+        id: zod_1.z.string().meta({ description: "ID of the Dispatch" }),
+    }) }));
+exports.DispatchesPubSubConfig = (0, config_js_1.rabbitMqConfig)("dispatch.dispatches", exports.DispatchMessageSchema);
+//# sourceMappingURL=dispatches.js.map

package/dist/configs/dispatches.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dispatches.js","sourceRoot":"","sources":["../../src/configs/dispatches.ts"],"names":[],"mappings":";;;AAAA,6CAAgD;AAEhD,6BAAwB;AAExB,4CAA8C;AAE9C,IAAY,aAEX;AAFD,WAAY,aAAa;IACvB,6CAA4B,CAAA;AAC9B,CAAC,EAFW,aAAa,6BAAb,aAAa,QAExB;AAEY,QAAA,qBAAqB,GAAG,OAAC,CAAC,MAAM,iCACxC,qBAAY,CAAC,KAAK,KACrB,KAAK,EAAE,OAAC,CAAC,IAAI,CAAC,aAAa,CAAC,EAC5B,IAAI,EAAE,OAAC,CAAC,MAAM,CAAC;QACb,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,oBAAoB,EAAE,CAAC;KAC3D,CAAC,IACF,CAAC;AAIU,QAAA,sBAAsB,GAAG,IAAA,0BAAc,EAClD,qBAAqB,EACrB,6BAAqB,CACtB,CAAC"}

package/dist/configs/projects.d.ts

@@ -0,0 +1,18 @@
+import { z } from "zod";
+export declare enum ProjectEvent {
+    Created = "project.created"
+}
+export declare const ProjectMessageSchema: z.ZodObject<{
+    event: z.ZodEnum<typeof ProjectEvent>;
+    data: z.ZodObject<{
+        id: z.ZodString;
+    }, z.core.$strip>;
+    id: z.ZodOptional<z.ZodString>;
+    meta: z.ZodOptional<z.ZodObject<{
+        createdAt: z.ZodOptional<z.ZodISODateTime>;
+        schemaId: z.ZodOptional<z.ZodString>;
+        publishedBy: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type ProjectMessage = z.infer<typeof ProjectMessageSchema>;
+export declare const ProjectsPubSubConfig: import("../config.js").PubSubEventConfig<ProjectEvent>;

package/dist/configs/projects.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProjectsPubSubConfig = exports.ProjectMessageSchema = exports.ProjectEvent = void 0;
+const pubsub_1 = require("@palmetto/pubsub");
+const zod_1 = require("zod");
+const config_js_1 = require("../config.js");
+var ProjectEvent;
+(function (ProjectEvent) {
+    ProjectEvent["Created"] = "project.created";
+})(ProjectEvent || (exports.ProjectEvent = ProjectEvent = {}));
+exports.ProjectMessageSchema = zod_1.z.object(Object.assign(Object.assign({}, pubsub_1.IdMetaSchema.shape), { event: zod_1.z.enum(ProjectEvent), data: zod_1.z.object({
+        id: zod_1.z.string().meta({ description: "ID of the Project" }),
+    }) }));
+exports.ProjectsPubSubConfig = (0, config_js_1.rabbitMqConfig)("dispatch.projects", exports.ProjectMessageSchema);
+//# sourceMappingURL=projects.js.map

package/dist/configs/projects.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"projects.js","sourceRoot":"","sources":["../../src/configs/projects.ts"],"names":[],"mappings":";;;AAAA,6CAAgD;AAEhD,6BAAwB;AAExB,4CAA8C;AAE9C,IAAY,YAEX;AAFD,WAAY,YAAY;IACtB,2CAA2B,CAAA;AAC7B,CAAC,EAFW,YAAY,4BAAZ,YAAY,QAEvB;AAEY,QAAA,oBAAoB,GAAG,OAAC,CAAC,MAAM,iCACvC,qBAAY,CAAC,KAAK,KACrB,KAAK,EAAE,OAAC,CAAC,IAAI,CAAC,YAAY,CAAC,EAC3B,IAAI,EAAE,OAAC,CAAC,MAAM,CAAC;QACb,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,mBAAmB,EAAE,CAAC;KAC1D,CAAC,IACF,CAAC;AAIU,QAAA,oBAAoB,GAAG,IAAA,0BAAc,EAChD,mBAAmB,EACnB,4BAAoB,CACrB,CAAC"}

package/dist/configs/suppliers.d.ts

@@ -0,0 +1,18 @@
+import { z } from "zod";
+export declare enum SupplierEvent {
+    Created = "supplier.created"
+}
+export declare const SupplierMessageSchema: z.ZodObject<{
+    event: z.ZodEnum<typeof SupplierEvent>;
+    data: z.ZodObject<{
+        id: z.ZodString;
+    }, z.core.$strip>;
+    id: z.ZodOptional<z.ZodString>;
+    meta: z.ZodOptional<z.ZodObject<{
+        createdAt: z.ZodOptional<z.ZodISODateTime>;
+        schemaId: z.ZodOptional<z.ZodString>;
+        publishedBy: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type SupplierMessage = z.infer<typeof SupplierMessageSchema>;
+export declare const SuppliersPubSubConfig: import("../config.js").PubSubEventConfig<SupplierEvent>;

package/dist/configs/suppliers.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SuppliersPubSubConfig = exports.SupplierMessageSchema = exports.SupplierEvent = void 0;
+const pubsub_1 = require("@palmetto/pubsub");
+const zod_1 = require("zod");
+const config_js_1 = require("../config.js");
+var SupplierEvent;
+(function (SupplierEvent) {
+    SupplierEvent["Created"] = "supplier.created";
+})(SupplierEvent || (exports.SupplierEvent = SupplierEvent = {}));
+exports.SupplierMessageSchema = zod_1.z.object(Object.assign(Object.assign({}, pubsub_1.IdMetaSchema.shape), { event: zod_1.z.enum(SupplierEvent), data: zod_1.z.object({
+        id: zod_1.z.string().meta({ description: "ID of the Supplier" }),
+    }) }));
+exports.SuppliersPubSubConfig = (0, config_js_1.rabbitMqConfig)("dispatch.suppliers", exports.SupplierMessageSchema);
+//# sourceMappingURL=suppliers.js.map

package/dist/configs/suppliers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"suppliers.js","sourceRoot":"","sources":["../../src/configs/suppliers.ts"],"names":[],"mappings":";;;AAAA,6CAAgD;AAEhD,6BAAwB;AAExB,4CAA8C;AAE9C,IAAY,aAEX;AAFD,WAAY,aAAa;IACvB,6CAA4B,CAAA;AAC9B,CAAC,EAFW,aAAa,6BAAb,aAAa,QAExB;AAEY,QAAA,qBAAqB,GAAG,OAAC,CAAC,MAAM,iCACxC,qBAAY,CAAC,KAAK,KACrB,KAAK,EAAE,OAAC,CAAC,IAAI,CAAC,aAAa,CAAC,EAC5B,IAAI,EAAE,OAAC,CAAC,MAAM,CAAC;QACb,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,oBAAoB,EAAE,CAAC;KAC3D,CAAC,IACF,CAAC;AAIU,QAAA,qBAAqB,GAAG,IAAA,0BAAc,EACjD,oBAAoB,EACpB,6BAAqB,CACtB,CAAC"}

package/dist/main.d.ts

@@ -0,0 +1,4 @@
+export type * from "./config.ts";
+export * from "./configs/dispatches.js";
+export * from "./configs/projects.js";
+export * from "./configs/suppliers.js";

package/dist/main.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./configs/dispatches.js"), exports);
+__exportStar(require("./configs/projects.js"), exports);
+__exportStar(require("./configs/suppliers.js"), exports);
+//# sourceMappingURL=main.js.map

package/dist/main.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.js","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAEA,0DAAwC;AACxC,wDAAsC;AACtC,yDAAuC"}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@palmetto/dispatch-pubsub",
+  "version": "0.1.0",
+  "main": "./dist/main.js",
+  "scripts": {
+    "lint": "yarn run -T eslint --fix ./src",
+    "format": "yarn run -T prettier --write --log-level warn .",
+    "tc": "tsc --noEmit",
+    "test": "yarn test-runner 'vitest run'",
+    "test:watch": "yarn test-runner 'vitest watch'",
+    "build": "yarn clean && yarn ci:build",
+    "start:dev": "yarn ci:build --watch",
+    "clean": "rm -rf ./dist/",
+    "ci:build": "yarn run -T tsc -p tsconfig.build.json",
+    "ci:lint": "yarn run -T eslint . && yarn run -T prettier --check --log-level warn .",
+    "ci:tc": "yarn tc",
+    "ci:test": "yarn run -T ci:test --project @palmetto/dispatch-pubsub",
+    "hook:lint": "eslint --cache --fix",
+    "hook:format": "prettier --write --log-level warn",
+    "hook:tc": "yarn tc",
+    "prepublishOnly": "yarn build",
+    "test-runner": "yarn run -T $0 --project @palmetto/dispatch-pubsub"
+  },
+  "devDependencies": {
+    "@palmetto/pubsub": "^3.5.1",
+    "typescript": "^5.9.3",
+    "vitest": "^4.1.5",
+    "zod": "^4.4.2"
+  },
+  "files": [
+    "dist/**/*",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "@palmetto/pubsub": "^3.5",
+    "zod": "^4.3"
+  }
+}