@ddd-ts-kit/events 0.0.0-stage → 0.1.1

package/dist/asyncapi/generate-async-api.js

@@ -0,0 +1,116 @@
+import { asSchema } from '../internal/json-schema/as-schema.js';
+import { compareText } from '../internal/json-schema/compare-text.js';
+import { rewriteLocalRefs } from '../internal/json-schema/rewrite-local-refs.js';
+import { sortKeys } from '../internal/json-schema/sort-keys.js';
+import { splitDefinitions } from '../internal/json-schema/split-definitions.js';
+/**
+ * One channel per event type (its address is the type), one message per version, one `send`
+ * operation per channel. The output depends only on the registry content, never on the
+ * registration order, so the document can be committed and diffed in CI.
+ */
+export function generateAsyncApi(options) {
+    const channels = {};
+    const operations = {};
+    const messages = {};
+    const schemas = {};
+    for (const [type, versions] of groupByType(options.registry.all())) {
+        const channelMessages = collectMessages(versions, { messages, schemas });
+        channels[type] = channel(type, versions.at(-1)?.description, channelMessages);
+        operations[`send.${type}`] = sendOperation(type, channelMessages);
+    }
+    return {
+        asyncapi: '3.0.0',
+        info: infoOf(options.info),
+        ...(options.servers === undefined ? {} : { servers: sortKeys(options.servers) }),
+        channels,
+        operations,
+        components: {
+            messages,
+            ...(Object.keys(schemas).length === 0 ? {} : { schemas: sortKeys(schemas) }),
+        },
+    };
+}
+// `all()` is sorted by type then version, so the groups and their content come out sorted.
+function groupByType(definitions) {
+    const groups = new Map();
+    for (const definition of definitions) {
+        groups.set(definition.type, [...(groups.get(definition.type) ?? []), definition]);
+    }
+    return groups;
+}
+/** Adds every version to the components and returns the references the channel lists. */
+function collectMessages(versions, components) {
+    const channelMessages = {};
+    for (const definition of versions) {
+        const messageId = `${definition.type}.v${definition.version}`;
+        components.messages[messageId] = message(definition, messageId, components.schemas);
+        channelMessages[`v${definition.version}`] = { $ref: `#/components/messages/${messageId}` };
+    }
+    return channelMessages;
+}
+function message(definition, messageId, schemas) {
+    return {
+        name: definition.type,
+        title: `${definition.type} v${definition.version}`,
+        ...(definition.description === undefined ? {} : { summary: definition.description }),
+        ...(definition.deprecated ? { deprecated: true } : {}),
+        contentType: 'application/json',
+        tags: [{ name: definition.producer }],
+        payload: envelope(definition, payloadSchema(definition, messageId, schemas)),
+    };
+}
+/**
+ * Local definitions (`$defs`) of a payload schema are moved to `components.schemas` under the
+ * message id, because a `#/$defs/...` pointer means nothing once the schema is embedded.
+ */
+function payloadSchema(definition, messageId, schemas) {
+    const { schema, definitions } = splitDefinitions(definition.payload.toJsonSchema());
+    const names = Object.keys(definitions).sort(compareText);
+    const rename = (name) => names.includes(name) ? `#/components/schemas/${messageId}.${name}` : undefined;
+    for (const name of names) {
+        schemas[`${messageId}.${name}`] = asSchema(rewriteLocalRefs(definitions[name], rename));
+    }
+    return asSchema(rewriteLocalRefs(schema, rename));
+}
+function envelope(definition, payload) {
+    return {
+        type: 'object',
+        required: ['id', 'type', 'version', 'occurredAt', 'payload'],
+        properties: {
+            id: { type: 'string', description: 'Unique id of the event: the idempotency key.' },
+            type: { type: 'string', const: definition.type },
+            version: { type: 'integer', const: definition.version },
+            occurredAt: { type: 'string', format: 'date-time' },
+            payload,
+            traceparent: {
+                type: 'string',
+                description: 'W3C traceparent captured at publication.',
+            },
+            correlationId: { type: 'string' },
+        },
+    };
+}
+function channel(type, description, channelMessages) {
+    return {
+        address: type,
+        ...(description === undefined ? {} : { description }),
+        messages: channelMessages,
+    };
+}
+function sendOperation(type, channelMessages) {
+    return {
+        action: 'send',
+        channel: { $ref: `#/channels/${type}` },
+        messages: Object.keys(channelMessages).map((key) => ({
+            $ref: `#/channels/${type}/messages/${key}`,
+        })),
+    };
+}
+function infoOf(info) {
+    return {
+        title: info.title,
+        version: info.version,
+        ...(info.description === undefined ? {} : { description: info.description }),
+    };
+}
+//# sourceMappingURL=generate-async-api.js.map

package/dist/asyncapi/generate-async-api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-async-api.js","sourceRoot":"","sources":["../../src/asyncapi/generate-async-api.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,sCAAsC,CAAC;AAChE,OAAO,EAAE,WAAW,EAAE,MAAM,yCAAyC,CAAC;AACtE,OAAO,EAAE,gBAAgB,EAAE,MAAM,+CAA+C,CAAC;AACjF,OAAO,EAAE,QAAQ,EAAE,MAAM,sCAAsC,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,8CAA8C,CAAC;AAYhF;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,OAAgC;IAC/D,MAAM,QAAQ,GAA+B,EAAE,CAAC;IAChD,MAAM,UAAU,GAA+B,EAAE,CAAC;IAClD,MAAM,QAAQ,GAA+B,EAAE,CAAC;IAChD,MAAM,OAAO,GAA+B,EAAE,CAAC;IAE/C,KAAK,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC;QACnE,MAAM,eAAe,GAAG,eAAe,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;QAEzE,QAAQ,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,eAAe,CAAC,CAAC;QAC9E,UAAU,CAAC,QAAQ,IAAI,EAAE,CAAC,GAAG,aAAa,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;IACpE,CAAC;IAED,OAAO;QACL,QAAQ,EAAE,OAAO;QACjB,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;QAC1B,GAAG,CAAC,OAAO,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QAChF,QAAQ;QACR,UAAU;QACV,UAAU,EAAE;YACV,QAAQ;YACR,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;SAC7E;KACF,CAAC;AACJ,CAAC;AAED,2FAA2F;AAC3F,SAAS,WAAW,CAClB,WAAqD;IAErD,MAAM,MAAM,GAAG,IAAI,GAAG,EAA2C,CAAC;IAElE,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;QACrC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC;IACpF,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAOD,yFAAyF;AACzF,SAAS,eAAe,CACtB,QAAkD,EAClD,UAAsB;IAEtB,MAAM,eAAe,GAA+B,EAAE,CAAC;IAEvD,KAAK,MAAM,UAAU,IAAI,QAAQ,EAAE,CAAC;QAClC,MAAM,SAAS,GAAG,GAAG,UAAU,CAAC,IAAI,KAAK,UAAU,CAAC,OAAO,EAAE,CAAC;QAE9D,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,UAAU,EAAE,SAAS,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;QACpF,eAAe,CAAC,IAAI,UAAU,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,yBAAyB,SAAS,EAAE,EAAE,CAAC;IAC7F,CAAC;IAED,OAAO,eAAe,CAAC;AACzB,CAAC;AAED,SAAS,OAAO,CACd,UAAyC,EACzC,SAAiB,EACjB,OAAmC;IAEnC,OAAO;QACL,IAAI,EAAE,UAAU,CAAC,IAAI;QACrB,KAAK,EAAE,GAAG,UAAU,CAAC,IAAI,KAAK,UAAU,CAAC,OAAO,EAAE;QAClD,GAAG,CAAC,UAAU,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC;QACpF,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACtD,WAAW,EAAE,kBAAkB;QAC/B,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,QAAQ,EAAE,CAAC;QACrC,OAAO,EAAE,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC,UAAU,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;KAC7E,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,SAAS,aAAa,CACpB,UAAyC,EACzC,SAAiB,EACjB,OAAmC;IAEnC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,gBAAgB,CAAC,UAAU,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;IACpF,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAEzD,MAAM,MAAM,GAAG,CAAC,IAAY,EAAsB,EAAE,CAClD,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,wBAAwB,SAAS,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IAEjF,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,OAAO,CAAC,GAAG,SAAS,IAAI,IAAI,EAAE,CAAC,GAAG,QAAQ,CAAC,gBAAgB,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;IAC1F,CAAC;IAED,OAAO,QAAQ,CAAC,gBAAgB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AACpD,CAAC;AAED,SAAS,QAAQ,CAAC,UAAyC,EAAE,OAAmB;IAC9E,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,CAAC;QAC5D,UAAU,EAAE;YACV,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,8CAA8C,EAAE;YACnF,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,CAAC,IAAI,EAAE;YAChD,OAAO,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE;YACvD,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE;YACnD,OAAO;YACP,WAAW,EAAE;gBACX,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,0CAA0C;aACxD;YACD,aAAa,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;SAClC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,OAAO,CACd,IAAY,EACZ,WAA+B,EAC/B,eAA2C;IAE3C,OAAO;QACL,OAAO,EAAE,IAAI;QACb,GAAG,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC;QACrD,QAAQ,EAAE,eAAe;KAC1B,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,IAAY,EAAE,eAA2C;IAC9E,OAAO;QACL,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,EAAE,IAAI,EAAE,cAAc,IAAI,EAAE,EAAE;QACvC,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YACnD,IAAI,EAAE,cAAc,IAAI,aAAa,GAAG,EAAE;SAC3C,CAAC,CAAC;KACJ,CAAC;AACJ,CAAC;AAED,SAAS,MAAM,CAAC,IAAkB;IAChC,OAAO;QACL,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,GAAG,CAAC,IAAI,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC;KAC7E,CAAC;AACJ,CAAC"}

package/dist/asyncapi/stringify-async-api.d.ts

@@ -0,0 +1,4 @@
+import type { AsyncApiDocument } from './async-api-document.js';
+/** The exact bytes to commit: two-space JSON and a trailing newline. */
+export declare function stringifyAsyncApi(document: AsyncApiDocument): string;
+//# sourceMappingURL=stringify-async-api.d.ts.map

package/dist/asyncapi/stringify-async-api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stringify-async-api.d.ts","sourceRoot":"","sources":["../../src/asyncapi/stringify-async-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAEhE,wEAAwE;AACxE,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,MAAM,CAEpE"}

package/dist/asyncapi/stringify-async-api.js

@@ -0,0 +1,5 @@
+/** The exact bytes to commit: two-space JSON and a trailing newline. */
+export function stringifyAsyncApi(document) {
+    return `${JSON.stringify(document, null, 2)}\n`;
+}
+//# sourceMappingURL=stringify-async-api.js.map

package/dist/asyncapi/stringify-async-api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stringify-async-api.js","sourceRoot":"","sources":["../../src/asyncapi/stringify-async-api.ts"],"names":[],"mappings":"AAEA,wEAAwE;AACxE,MAAM,UAAU,iBAAiB,CAAC,QAA0B;IAC1D,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC;AAClD,CAAC"}

package/dist/asyncapi.d.ts

@@ -0,0 +1,7 @@
+export * from './asyncapi/async-api-document.js';
+export * from './asyncapi/async-api-info.js';
+export * from './asyncapi/async-api-server.js';
+export * from './asyncapi/check-async-api-drift.js';
+export * from './asyncapi/generate-async-api.js';
+export * from './asyncapi/stringify-async-api.js';
+//# sourceMappingURL=asyncapi.d.ts.map

package/dist/asyncapi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"asyncapi.d.ts","sourceRoot":"","sources":["../src/asyncapi.ts"],"names":[],"mappings":"AAAA,cAAc,kCAAkC,CAAC;AACjD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,qCAAqC,CAAC;AACpD,cAAc,kCAAkC,CAAC;AACjD,cAAc,mCAAmC,CAAC"}

package/dist/asyncapi.js

@@ -0,0 +1,7 @@
+export * from './asyncapi/async-api-document.js';
+export * from './asyncapi/async-api-info.js';
+export * from './asyncapi/async-api-server.js';
+export * from './asyncapi/check-async-api-drift.js';
+export * from './asyncapi/generate-async-api.js';
+export * from './asyncapi/stringify-async-api.js';
+//# sourceMappingURL=asyncapi.js.map

package/dist/asyncapi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"asyncapi.js","sourceRoot":"","sources":["../src/asyncapi.ts"],"names":[],"mappings":"AAAA,cAAc,kCAAkC,CAAC;AACjD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,qCAAqC,CAAC;AACpD,cAAc,kCAAkC,CAAC;AACjD,cAAc,mCAAmC,CAAC"}

package/dist/catalog/generate-event-catalog.d.ts

@@ -0,0 +1,12 @@
+import type { EventRegistry } from '../registry/event-registry.js';
+export interface EventCatalogOptions {
+    readonly title?: string;
+    /** Consuming contexts by event type. Declared by hand: a producer does not know them. */
+    readonly consumers?: Readonly<Record<string, readonly string[]>>;
+}
+/**
+ * A Markdown catalog of every declared event, grouped by producer context. Deterministic:
+ * commit the file and let CI fail when the regenerated content differs.
+ */
+export declare function generateEventCatalog(registry: EventRegistry, options?: EventCatalogOptions): string;
+//# sourceMappingURL=generate-event-catalog.d.ts.map

package/dist/catalog/generate-event-catalog.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-event-catalog.d.ts","sourceRoot":"","sources":["../../src/catalog/generate-event-catalog.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAInE,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,yFAAyF;IACzF,QAAQ,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC,CAAC,CAAC;CAClE;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,aAAa,EAAE,OAAO,GAAE,mBAAwB,GAAG,MAAM,CAmBvG"}

package/dist/catalog/generate-event-catalog.js

@@ -0,0 +1,63 @@
+import { compareText } from '../internal/json-schema/compare-text.js';
+import { payloadFields } from './payload-fields.js';
+/**
+ * A Markdown catalog of every declared event, grouped by producer context. Deterministic:
+ * commit the file and let CI fail when the regenerated content differs.
+ */
+export function generateEventCatalog(registry, options = {}) {
+    const definitions = registry.all();
+    const producers = [...new Set(definitions.map((definition) => definition.producer))].sort(compareText);
+    const lines = [
+        `# ${options.title ?? 'Event catalog'}`,
+        '',
+        'Generated from the integration event declarations. Do not edit by hand: regenerate.',
+        ...producers.flatMap((producer) => producerSection(producer, definitions.filter((definition) => definition.producer === producer), options)),
+    ];
+    return `${lines.join('\n')}\n`;
+}
+function producerSection(producer, owned, options) {
+    const types = [...new Set(owned.map((definition) => definition.type))];
+    return [
+        '',
+        `## ${producer}`,
+        ...types.flatMap((type) => eventSection(type, owned.filter((definition) => definition.type === type), options.consumers?.[type] ?? [])),
+    ];
+}
+function eventSection(type, versions, consumers) {
+    const names = [...consumers].sort(compareText);
+    return [
+        '',
+        `### ${type}`,
+        '',
+        ...versionsTable(versions),
+        ...(names.length === 0 ? [] : ['', `Consumers: ${names.map((name) => `\`${name}\``).join(', ')}`]),
+        ...versions.flatMap((definition) => [
+            '',
+            `#### Payload of version ${definition.version}`,
+            '',
+            ...payloadTable(payloadFields(definition.payload.toJsonSchema())),
+        ]),
+    ];
+}
+function versionsTable(versions) {
+    return table(['Type', 'Version', 'Description', 'Deprecated'], versions.map((definition) => [
+        `\`${definition.type}\``,
+        String(definition.version),
+        definition.description ?? '',
+        definition.deprecated ? 'yes' : 'no',
+    ]));
+}
+function payloadTable(fields) {
+    if (fields.length === 0) {
+        return ['No documented field.'];
+    }
+    return table(['Field', 'Type', 'Required', 'Description'], fields.map((field) => [`\`${field.path}\``, field.type, field.required ? 'yes' : 'no', field.description]));
+}
+function table(header, rows) {
+    const line = (cells) => `| ${cells.map(escapeCell).join(' | ')} |`;
+    return [line(header), line(header.map(() => '---')), ...rows.map(line)];
+}
+function escapeCell(text) {
+    return text.replaceAll('|', '\\|').replaceAll(/\s*\n\s*/g, ' ');
+}
+//# sourceMappingURL=generate-event-catalog.js.map

package/dist/catalog/generate-event-catalog.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-event-catalog.js","sourceRoot":"","sources":["../../src/catalog/generate-event-catalog.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,yCAAyC,CAAC;AAGtE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAQpD;;;GAGG;AACH,MAAM,UAAU,oBAAoB,CAAC,QAAuB,EAAE,OAAO,GAAwB,EAAE;IAC7F,MAAM,WAAW,GAAG,QAAQ,CAAC,GAAG,EAAE,CAAC;IAEnC,MAAM,SAAS,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAEvG,MAAM,KAAK,GAAG;QACZ,KAAK,OAAO,CAAC,KAAK,IAAI,eAAe,EAAE;QACvC,EAAE;QACF,qFAAqF;QACrF,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE,CAChC,eAAe,CACb,QAAQ,EACR,WAAW,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,QAAQ,KAAK,QAAQ,CAAC,EACpE,OAAO,CACR,CACF;KACF,CAAC;IAEF,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;AACjC,CAAC;AAED,SAAS,eAAe,CACtB,QAAgB,EAChB,KAA+C,EAC/C,OAA4B;IAE5B,MAAM,KAAK,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAEvE,OAAO;QACL,EAAE;QACF,MAAM,QAAQ,EAAE;QAChB,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CACxB,YAAY,CACV,IAAI,EACJ,KAAK,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,KAAK,IAAI,CAAC,EACtD,OAAO,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAChC,CACF;KACF,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CACnB,IAAY,EACZ,QAAkD,EAClD,SAA4B;IAE5B,MAAM,KAAK,GAAG,CAAC,GAAG,SAAS,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAE/C,OAAO;QACL,EAAE;QACF,OAAO,IAAI,EAAE;QACb,EAAE;QACF,GAAG,aAAa,CAAC,QAAQ,CAAC;QAC1B,GAAG,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,cAAc,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAClG,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC;YAClC,EAAE;YACF,2BAA2B,UAAU,CAAC,OAAO,EAAE;YAC/C,EAAE;YACF,GAAG,YAAY,CAAC,aAAa,CAAC,UAAU,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;SAClE,CAAC;KACH,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,QAAkD;IACvE,OAAO,KAAK,CACV,CAAC,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,YAAY,CAAC,EAChD,QAAQ,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC;QAC3B,KAAK,UAAU,CAAC,IAAI,IAAI;QACxB,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC;QAC1B,UAAU,CAAC,WAAW,IAAI,EAAE;QAC5B,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI;KACrC,CAAC,CACH,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,MAA+B;IACnD,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAClC,CAAC;IAED,OAAO,KAAK,CACV,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,aAAa,CAAC,EAC5C,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,KAAK,CAAC,IAAI,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC,CAC3G,CAAC;AACJ,CAAC;AAED,SAAS,KAAK,CAAC,MAAyB,EAAE,IAAoC;IAC5E,MAAM,IAAI,GAAG,CAAC,KAAwB,EAAU,EAAE,CAAC,KAAK,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;IAE9F,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;AAC1E,CAAC;AAED,SAAS,UAAU,CAAC,IAAY;IAC9B,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,UAAU,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;AAClE,CAAC"}

package/dist/catalog/payload-field.d.ts

@@ -0,0 +1,8 @@
+export interface PayloadField {
+    /** Dotted path; an array is written `lines[]` and its item fields `lines[].sku`. */
+    readonly path: string;
+    readonly type: string;
+    readonly required: boolean;
+    readonly description: string;
+}
+//# sourceMappingURL=payload-field.d.ts.map

package/dist/catalog/payload-field.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload-field.d.ts","sourceRoot":"","sources":["../../src/catalog/payload-field.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,YAAY;IAC3B,oFAAoF;IACpF,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC9B"}

package/dist/catalog/payload-field.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=payload-field.js.map

package/dist/catalog/payload-field.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload-field.js","sourceRoot":"","sources":["../../src/catalog/payload-field.ts"],"names":[],"mappings":""}

package/dist/catalog/payload-fields.d.ts

@@ -0,0 +1,7 @@
+import type { PayloadField } from './payload-field.js';
+/**
+ * Flattens the object properties of a JSON Schema: nested objects with dotted paths, one
+ * level of arrays as `name[]`. Fields keep the order of the schema.
+ */
+export declare function payloadFields(jsonSchema: Record<string, unknown>): PayloadField[];
+//# sourceMappingURL=payload-fields.d.ts.map

package/dist/catalog/payload-fields.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload-fields.d.ts","sourceRoot":"","sources":["../../src/catalog/payload-fields.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAEvD;;;GAGG;AACH,wBAAgB,aAAa,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,YAAY,EAAE,CAIjF"}

package/dist/catalog/payload-fields.js

@@ -0,0 +1,105 @@
+import { isRecord } from '../internal/json-schema/is-record.js';
+import { localRefName } from '../internal/json-schema/local-ref-name.js';
+import { splitDefinitions } from '../internal/json-schema/split-definitions.js';
+/**
+ * Flattens the object properties of a JSON Schema: nested objects with dotted paths, one
+ * level of arrays as `name[]`. Fields keep the order of the schema.
+ */
+export function payloadFields(jsonSchema) {
+    const { schema, definitions } = splitDefinitions(jsonSchema);
+    return fieldsOf(schema, '', { definitions, insideArray: false, visiting: [] });
+}
+function fieldsOf(node, prefix, walk) {
+    const resolved = resolve(node, walk);
+    if (resolved === undefined || !isRecord(resolved.schema['properties'])) {
+        return [];
+    }
+    const inner = resolved.walk;
+    const required = Array.isArray(resolved.schema['required']) ? resolved.schema['required'] : [];
+    return Object.entries(resolved.schema['properties']).flatMap(([name, property]) => {
+        const target = resolve(property, inner)?.schema ?? {};
+        const field = (path) => ({
+            path,
+            type: typeLabel(property, inner),
+            required: required.includes(name),
+            description: describe(property, target),
+        });
+        if (target['type'] !== 'array') {
+            return [field(prefix + name), ...fieldsOf(property, `${prefix}${name}.`, inner)];
+        }
+        const items = inner.insideArray
+            ? []
+            : fieldsOf(target['items'], `${prefix}${name}[].`, { ...inner, insideArray: true });
+        return [field(`${prefix}${name}[]`), ...items];
+    });
+}
+/** Follows local references and unwraps "X or null" down to the schema that has the shape. */
+function resolve(node, walk) {
+    if (!isRecord(node)) {
+        return undefined;
+    }
+    const name = localRefName(node['$ref']);
+    if (name !== undefined) {
+        if (walk.visiting.includes(name)) {
+            return undefined;
+        }
+        return resolve(walk.definitions[name], { ...walk, visiting: [...walk.visiting, name] });
+    }
+    const meaningful = alternatives(node).filter((alternative) => !isRecord(alternative) || alternative['type'] !== 'null');
+    if (meaningful.length === 1 && alternatives(node).length > 1) {
+        return resolve(meaningful[0], walk);
+    }
+    return { schema: node, walk };
+}
+function alternatives(node) {
+    const list = node['anyOf'] ?? node['oneOf'];
+    return Array.isArray(list) ? list : [];
+}
+function typeLabel(node, walk) {
+    if (!isRecord(node)) {
+        return 'any';
+    }
+    const name = localRefName(node['$ref']);
+    if (name !== undefined) {
+        return walk.visiting.includes(name)
+            ? name
+            : typeLabel(walk.definitions[name], { ...walk, visiting: [...walk.visiting, name] });
+    }
+    const literal = literalLabel(node);
+    if (literal !== undefined) {
+        return literal;
+    }
+    const options = alternatives(node);
+    if (options.length > 0) {
+        return [...new Set(options.map((option) => typeLabel(option, walk)))].join(' | ');
+    }
+    return declaredTypeLabel(node, walk);
+}
+function literalLabel(node) {
+    if ('const' in node) {
+        return `const ${JSON.stringify(node['const'])}`;
+    }
+    if (Array.isArray(node['enum'])) {
+        return `enum (${node['enum'].map((value) => JSON.stringify(value)).join(', ')})`;
+    }
+    return undefined;
+}
+function declaredTypeLabel(node, walk) {
+    const type = node['type'];
+    if (Array.isArray(type)) {
+        return type.map(String).join(' | ');
+    }
+    if (type === 'array') {
+        return `array of ${typeLabel(node['items'], walk)}`;
+    }
+    if (typeof type !== 'string') {
+        return 'any';
+    }
+    return typeof node['format'] === 'string' ? `${type} (${node['format']})` : type;
+}
+function describe(property, target) {
+    const own = isRecord(property) ? property['description'] : undefined;
+    const description = own ?? target['description'];
+    return typeof description === 'string' ? description : '';
+}
+//# sourceMappingURL=payload-fields.js.map

package/dist/catalog/payload-fields.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload-fields.js","sourceRoot":"","sources":["../../src/catalog/payload-fields.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,sCAAsC,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,2CAA2C,CAAC;AACzE,OAAO,EAAE,gBAAgB,EAAE,MAAM,8CAA8C,CAAC;AAGhF;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,UAAmC;IAC/D,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;IAE7D,OAAO,QAAQ,CAAC,MAAM,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE,WAAW,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC;AACjF,CAAC;AASD,SAAS,QAAQ,CAAC,IAAa,EAAE,MAAc,EAAE,IAAU;IACzD,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAErC,IAAI,QAAQ,KAAK,SAAS,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC;QACvE,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC;IAC5B,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAE/F,OAAO,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE;QAChF,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,MAAM,IAAI,EAAE,CAAC;QAEtD,MAAM,KAAK,GAAG,CAAC,IAAY,EAAgB,EAAE,CAAC,CAAC;YAC7C,IAAI;YACJ,IAAI,EAAE,SAAS,CAAC,QAAQ,EAAE,KAAK,CAAC;YAChC,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC;YACjC,WAAW,EAAE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;SACxC,CAAC,CAAC;QAEH,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,OAAO,EAAE,CAAC;YAC/B,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,GAAG,QAAQ,CAAC,QAAQ,EAAE,GAAG,MAAM,GAAG,IAAI,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;QACnF,CAAC;QAED,MAAM,KAAK,GAAG,KAAK,CAAC,WAAW;YAC7B,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,GAAG,MAAM,GAAG,IAAI,KAAK,EAAE,EAAE,GAAG,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;QAEtF,OAAO,CAAC,KAAK,CAAC,GAAG,MAAM,GAAG,IAAI,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;AACL,CAAC;AAED,8FAA8F;AAC9F,SAAS,OAAO,CACd,IAAa,EACb,IAAU;IAEV,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QACpB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAExC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACjC,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,IAAI,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED,MAAM,UAAU,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC,MAAM,CAC1C,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,WAAW,CAAC,MAAM,CAAC,KAAK,MAAM,CAC1E,CAAC;IAEF,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC7D,OAAO,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IACtC,CAAC;IAED,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;AAChC,CAAC;AAED,SAAS,YAAY,CAAC,IAA6B;IACjD,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC;IAE5C,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;AACzC,CAAC;AAED,SAAS,SAAS,CAAC,IAAa,EAAE,IAAU;IAC1C,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QACpB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAExC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC;YACjC,CAAC,CAAC,IAAI;YACN,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,IAAI,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;IACzF,CAAC;IAED,MAAM,OAAO,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IAEnC,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1B,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,MAAM,OAAO,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IAEnC,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACpF,CAAC;IAED,OAAO,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AACvC,CAAC;AAED,SAAS,YAAY,CAAC,IAA6B;IACjD,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;QACpB,OAAO,SAAS,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;IAClD,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;QAChC,OAAO,SAAS,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;IACnF,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,iBAAiB,CAAC,IAA6B,EAAE,IAAU;IAClE,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;IAE1B,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACtC,CAAC;IAED,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;QACrB,OAAO,YAAY,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC;IACtD,CAAC;IAED,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,IAAI,KAAK,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;AACnF,CAAC;AAED,SAAS,QAAQ,CAAC,QAAiB,EAAE,MAA+B;IAClE,MAAM,GAAG,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACrE,MAAM,WAAW,GAAG,GAAG,IAAI,MAAM,CAAC,aAAa,CAAC,CAAC;IAEjD,OAAO,OAAO,WAAW,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC;AAC5D,CAAC"}

package/dist/definition/any-integration-event-definition.d.ts

@@ -0,0 +1,4 @@
+import type { IntegrationEventDefinition } from './integration-event-definition.js';
+/** A definition whose payload type is not known statically (registry, generators). */
+export type AnyIntegrationEventDefinition = IntegrationEventDefinition<unknown>;
+//# sourceMappingURL=any-integration-event-definition.d.ts.map

package/dist/definition/any-integration-event-definition.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"any-integration-event-definition.d.ts","sourceRoot":"","sources":["../../src/definition/any-integration-event-definition.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,mCAAmC,CAAC;AAEpF,sFAAsF;AACtF,MAAM,MAAM,6BAA6B,GAAG,0BAA0B,CAAC,OAAO,CAAC,CAAC"}

package/dist/definition/any-integration-event-definition.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=any-integration-event-definition.js.map

package/dist/definition/any-integration-event-definition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"any-integration-event-definition.js","sourceRoot":"","sources":["../../src/definition/any-integration-event-definition.ts"],"names":[],"mappings":""}

package/dist/definition/define-integration-event.d.ts

@@ -0,0 +1,15 @@
+import type { Schema } from '@ddd-ts-kit/validation';
+import type { IntegrationEventDefinition } from './integration-event-definition.js';
+export interface DefineIntegrationEventOptions<P> {
+    /** Routing key, `<context>.<aggregate>.<fact>`, each segment in kebab-case. */
+    readonly type: string;
+    /** Positive integer, bumped on every breaking change of the payload. */
+    readonly version: number;
+    readonly payload: Schema<P>;
+    readonly description?: string;
+    /** The bounded context that owns the event. Defaults to the first segment of `type`. */
+    readonly producer?: string;
+    readonly deprecated?: boolean;
+}
+export declare function defineIntegrationEvent<P>(options: DefineIntegrationEventOptions<P>): IntegrationEventDefinition<P>;
+//# sourceMappingURL=define-integration-event.d.ts.map

package/dist/definition/define-integration-event.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"define-integration-event.d.ts","sourceRoot":"","sources":["../../src/definition/define-integration-event.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAGrD,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,mCAAmC,CAAC;AAIpF,MAAM,WAAW,6BAA6B,CAAC,CAAC;IAC9C,+EAA+E;IAC/E,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,wEAAwE;IACxE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAC5B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,wFAAwF;IACxF,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED,wBAAgB,sBAAsB,CAAC,CAAC,EAAE,OAAO,EAAE,6BAA6B,CAAC,CAAC,CAAC,GAAG,0BAA0B,CAAC,CAAC,CAAC,CAkBlH"}

package/dist/definition/define-integration-event.js

@@ -0,0 +1,73 @@
+import { err, ok } from '@ddd-ts-kit/kernel';
+import { InvalidEventDefinitionError } from './invalid-event-definition-error.js';
+import { InvalidEventPayloadError } from './invalid-event-payload-error.js';
+export function defineIntegrationEvent(options) {
+    const { type, version, payload } = options;
+    assertTypeAndVersion(type, version);
+    const contract = { type, version, payload };
+    return {
+        ...contract,
+        producer: producerOf(options),
+        ...(options.description === undefined ? {} : { description: options.description }),
+        deprecated: options.deprecated === true,
+        create: (input, meta) => createEvent(contract, input, meta),
+        parse: (event) => parseEvent(contract, event),
+        is(event) {
+            return event.type === type && event.version === version;
+        },
+    };
+}
+const SEGMENT = '[a-z][a-z0-9]*(?:-[a-z0-9]+)*';
+const EVENT_TYPE = new RegExp(`^${SEGMENT}\\.${SEGMENT}\\.${SEGMENT}$`);
+const KEBAB_CASE = new RegExp(`^${SEGMENT}$`);
+function assertTypeAndVersion(type, version) {
+    if (!EVENT_TYPE.test(type)) {
+        throw new InvalidEventDefinitionError(`Event type "${type}" must be <context>.<aggregate>.<fact> with kebab-case segments`);
+    }
+    if (!Number.isInteger(version) || version < 1) {
+        throw new InvalidEventDefinitionError(`Version of ${type} must be a positive integer`);
+    }
+}
+function producerOf({ type, producer }) {
+    const name = producer ?? type.slice(0, type.indexOf('.'));
+    if (!KEBAB_CASE.test(name)) {
+        throw new InvalidEventDefinitionError(`Producer of ${type} must be a kebab-case context name`);
+    }
+    return name;
+}
+function createEvent({ type, version, payload }, input, meta) {
+    const parsed = payload.parse(input);
+    if (!parsed.ok) {
+        throw new InvalidEventPayloadError(type, version, parsed.error);
+    }
+    return {
+        id: meta.id,
+        type,
+        version,
+        occurredAt: isoInstant(type, meta.occurredAt),
+        payload: parsed.value,
+        ...(meta.traceparent === undefined ? {} : { traceparent: meta.traceparent }),
+        ...(meta.correlationId === undefined ? {} : { correlationId: meta.correlationId }),
+    };
+}
+function isoInstant(type, occurredAt) {
+    const date = typeof occurredAt === 'string' ? new Date(occurredAt) : occurredAt;
+    if (Number.isNaN(date.getTime())) {
+        throw new InvalidEventDefinitionError(`occurredAt of ${type} is not a valid date`);
+    }
+    return typeof occurredAt === 'string' ? occurredAt : date.toISOString();
+}
+function parseEvent({ type, version, payload }, event) {
+    if (event.type !== type) {
+        return err({ reason: 'type-mismatch', expected: type, actual: event.type });
+    }
+    if (event.version !== version) {
+        return err({ reason: 'version-mismatch', expected: version, actual: event.version });
+    }
+    const parsed = payload.parse(event.payload);
+    if (!parsed.ok) {
+        return err({ reason: 'invalid-payload', issues: parsed.error });
+    }
+    return ok({ ...event, payload: parsed.value });
+}
+//# sourceMappingURL=define-integration-event.js.map

package/dist/definition/define-integration-event.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"define-integration-event.js","sourceRoot":"","sources":["../../src/definition/define-integration-event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,EAAE,EAAsC,MAAM,oBAAoB,CAAC;AAKjF,OAAO,EAAE,2BAA2B,EAAE,MAAM,qCAAqC,CAAC;AAClF,OAAO,EAAE,wBAAwB,EAAE,MAAM,kCAAkC,CAAC;AAc5E,MAAM,UAAU,sBAAsB,CAAI,OAAyC;IACjF,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IAE3C,oBAAoB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAEpC,MAAM,QAAQ,GAAqB,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;IAE9D,OAAO;QACL,GAAG,QAAQ;QACX,QAAQ,EAAE,UAAU,CAAC,OAAO,CAAC;QAC7B,GAAG,CAAC,OAAO,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC;QAClF,UAAU,EAAE,OAAO,CAAC,UAAU,KAAK,IAAI;QACvC,MAAM,EAAE,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC;QAC3D,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,KAAK,CAAC;QAC7C,EAAE,CAAC,KAAK;YACN,OAAO,KAAK,CAAC,IAAI,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,KAAK,OAAO,CAAC;QAC1D,CAAC;KACF,CAAC;AACJ,CAAC;AAID,MAAM,OAAO,GAAG,+BAA+B,CAAC;AAChD,MAAM,UAAU,GAAG,IAAI,MAAM,CAAC,IAAI,OAAO,MAAM,OAAO,MAAM,OAAO,GAAG,CAAC,CAAC;AACxE,MAAM,UAAU,GAAG,IAAI,MAAM,CAAC,IAAI,OAAO,GAAG,CAAC,CAAC;AAE9C,SAAS,oBAAoB,CAAC,IAAY,EAAE,OAAe;IACzD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,2BAA2B,CACnC,eAAe,IAAI,iEAAiE,CACrF,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;QAC9C,MAAM,IAAI,2BAA2B,CAAC,cAAc,IAAI,6BAA6B,CAAC,CAAC;IACzF,CAAC;AACH,CAAC;AAED,SAAS,UAAU,CAAC,EAAE,IAAI,EAAE,QAAQ,EAA0C;IAC5E,MAAM,IAAI,GAAG,QAAQ,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;IAE1D,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,2BAA2B,CAAC,eAAe,IAAI,oCAAoC,CAAC,CAAC;IACjG,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,WAAW,CAAI,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAoB,EAAE,KAAQ,EAAE,IAAe;IAC7F,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAEpC,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,MAAM,IAAI,wBAAwB,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;IAClE,CAAC;IAED,OAAO;QACL,EAAE,EAAE,IAAI,CAAC,EAAE;QACX,IAAI;QACJ,OAAO;QACP,UAAU,EAAE,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC;QAC7C,OAAO,EAAE,MAAM,CAAC,KAAK;QACrB,GAAG,CAAC,IAAI,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC;QAC5E,GAAG,CAAC,IAAI,CAAC,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC;KACnF,CAAC;AACJ,CAAC;AAED,SAAS,UAAU,CAAC,IAAY,EAAE,UAAyB;IACzD,MAAM,IAAI,GAAG,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;IAEhF,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC;QACjC,MAAM,IAAI,2BAA2B,CAAC,iBAAiB,IAAI,sBAAsB,CAAC,CAAC;IACrF,CAAC;IAED,OAAO,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;AAC1E,CAAC;AAED,SAAS,UAAU,CACjB,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAoB,EAC5C,KAAuB;IAEvB,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;QACxB,OAAO,GAAG,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,KAAK,OAAO,EAAE,CAAC;QAC9B,OAAO,GAAG,CAAC,EAAE,MAAM,EAAE,kBAAkB,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAE5C,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,OAAO,EAAE,CAAC,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;AACjD,CAAC"}

package/dist/definition/event-meta.d.ts

@@ -0,0 +1,7 @@
+export interface EventMeta {
+    readonly id: string;
+    readonly occurredAt: Date | string;
+    readonly correlationId?: string;
+    readonly traceparent?: string;
+}
+//# sourceMappingURL=event-meta.d.ts.map

package/dist/definition/event-meta.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"event-meta.d.ts","sourceRoot":"","sources":["../../src/definition/event-meta.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,UAAU,EAAE,IAAI,GAAG,MAAM,CAAC;IACnC,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B"}

package/dist/definition/event-meta.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=event-meta.js.map

package/dist/definition/event-meta.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"event-meta.js","sourceRoot":"","sources":["../../src/definition/event-meta.ts"],"names":[],"mappings":""}

package/dist/definition/event-parse-error.d.ts

@@ -0,0 +1,14 @@
+import type { ValidationIssue } from '@ddd-ts-kit/validation';
+export type EventParseError = {
+    readonly reason: 'type-mismatch';
+    readonly expected: string;
+    readonly actual: string;
+} | {
+    readonly reason: 'version-mismatch';
+    readonly expected: number;
+    readonly actual: number;
+} | {
+    readonly reason: 'invalid-payload';
+    readonly issues: readonly ValidationIssue[];
+};
+//# sourceMappingURL=event-parse-error.d.ts.map

package/dist/definition/event-parse-error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"event-parse-error.d.ts","sourceRoot":"","sources":["../../src/definition/event-parse-error.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAE9D,MAAM,MAAM,eAAe,GACvB;IAAE,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAC;IAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GACxF;IAAE,QAAQ,CAAC,MAAM,EAAE,kBAAkB,CAAC;IAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GAC3F;IAAE,QAAQ,CAAC,MAAM,EAAE,iBAAiB,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,SAAS,eAAe,EAAE,CAAA;CAAE,CAAC"}

package/dist/definition/event-parse-error.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=event-parse-error.js.map

package/dist/definition/event-parse-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"event-parse-error.js","sourceRoot":"","sources":["../../src/definition/event-parse-error.ts"],"names":[],"mappings":""}

package/dist/definition/integration-event-definition.d.ts

@@ -0,0 +1,20 @@
+import type { IntegrationEvent, Result } from '@ddd-ts-kit/kernel';
+import type { Schema } from '@ddd-ts-kit/validation';
+import type { EventMeta } from './event-meta.js';
+import type { EventParseError } from './event-parse-error.js';
+/** The single declaration of an integration event: its type, its version and its payload contract. */
+export interface IntegrationEventDefinition<P> {
+    readonly type: string;
+    readonly version: number;
+    readonly payload: Schema<P>;
+    readonly producer: string;
+    readonly description?: string;
+    readonly deprecated: boolean;
+    /** Producer side. Throws InvalidEventPayloadError: publishing an invalid event is a bug. */
+    create(payload: P, meta: EventMeta): IntegrationEvent<P>;
+    /** Consumer side. Checks type, version and payload, and never throws. */
+    parse(event: IntegrationEvent): Result<IntegrationEvent<P>, EventParseError>;
+    /** Cheap guard on type and version only. Use `parse` when the payload is not trusted. */
+    is(event: IntegrationEvent): event is IntegrationEvent<P>;
+}
+//# sourceMappingURL=integration-event-definition.d.ts.map

package/dist/definition/integration-event-definition.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"integration-event-definition.d.ts","sourceRoot":"","sources":["../../src/definition/integration-event-definition.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AACnE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAE9D,sGAAsG;AACtG,MAAM,WAAW,0BAA0B,CAAC,CAAC;IAC3C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAC5B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAC7B,4FAA4F;IAC5F,MAAM,CAAC,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,SAAS,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC;IACzD,yEAAyE;IACzE,KAAK,CAAC,KAAK,EAAE,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC;IAC7E,yFAAyF;IACzF,EAAE,CAAC,KAAK,EAAE,gBAAgB,GAAG,KAAK,IAAI,gBAAgB,CAAC,CAAC,CAAC,CAAC;CAC3D"}

package/dist/definition/integration-event-definition.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=integration-event-definition.js.map

package/dist/definition/integration-event-definition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"integration-event-definition.js","sourceRoot":"","sources":["../../src/definition/integration-event-definition.ts"],"names":[],"mappings":""}

package/dist/definition/invalid-event-definition-error.d.ts

@@ -0,0 +1,4 @@
+export declare class InvalidEventDefinitionError extends Error {
+    constructor(message: string);
+}
+//# sourceMappingURL=invalid-event-definition-error.d.ts.map