@flowcore/pathways 0.2.1

package/script/contracts/event.d.ts

@@ -0,0 +1,20 @@
+import { type Static, type TObject, type TRecord, type TString, type TUnknown } from "@sinclair/typebox";
+/**
+ * The schema for an event
+ */
+export declare const FlowcoreEventSchema: TObject<{
+    eventId: TString;
+    timeBucket: TString;
+    tenant: TString;
+    dataCoreId: TString;
+    flowType: TString;
+    eventType: TString;
+    metadata: TRecord<TString, TUnknown>;
+    payload: TRecord<TString, TUnknown>;
+    validTime: TString;
+}>;
+/**
+ * The type for an event
+ */
+export type FlowcoreEvent = Static<typeof FlowcoreEventSchema>;
+//# sourceMappingURL=event.d.ts.map

package/script/contracts/event.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"event.d.ts","sourceRoot":"","sources":["../../src/contracts/event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,QAAQ,EAAQ,MAAM,mBAAmB,CAAA;AAE9G;;GAEG;AACH,eAAO,MAAM,mBAAmB,EAAE,OAAO,CAAC;IACxC,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,EAAE,OAAO,CAAA;IACnB,MAAM,EAAE,OAAO,CAAA;IACf,UAAU,EAAE,OAAO,CAAA;IACnB,QAAQ,EAAE,OAAO,CAAA;IACjB,SAAS,EAAE,OAAO,CAAA;IAClB,QAAQ,EAAE,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;IACpC,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;IACnC,SAAS,EAAE,OAAO,CAAA;CACnB,CAUC,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,OAAO,mBAAmB,CAAC,CAAA"}

package/script/contracts/event.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FlowcoreEventSchema = void 0;
+const typebox_1 = require("@sinclair/typebox");
+/**
+ * The schema for an event
+ */
+exports.FlowcoreEventSchema = typebox_1.Type.Object({
+    eventId: typebox_1.Type.String(),
+    timeBucket: typebox_1.Type.String(),
+    tenant: typebox_1.Type.String(),
+    dataCoreId: typebox_1.Type.String(),
+    flowType: typebox_1.Type.String(),
+    eventType: typebox_1.Type.String(),
+    metadata: typebox_1.Type.Record(typebox_1.Type.String(), typebox_1.Type.Unknown()),
+    payload: typebox_1.Type.Record(typebox_1.Type.String(), typebox_1.Type.Unknown()),
+    validTime: typebox_1.Type.String(),
+});

package/script/contracts/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Export all contract types and schemas for Flowcore events
+ */
+export * from "./event.js";
+//# sourceMappingURL=index.d.ts.map

package/script/contracts/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/contracts/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,cAAc,YAAY,CAAC"}

package/script/contracts/index.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 });
+/**
+ * Export all contract types and schemas for Flowcore events
+ */
+__exportStar(require("./event.js"), exports);

package/script/mod.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Main export module for Flowcore Pathways
+ *
+ * This module re-exports all the components needed to work with Flowcore Pathways:
+ * - Common types and utilities
+ * - Event contracts and schemas
+ * - Pathway definitions and builders
+ * - Event routing functionality
+ */
+export * from "./common/index.js";
+export * from "./contracts/index.js";
+export * from "./pathways/index.js";
+export * from "./router/index.js";
+//# sourceMappingURL=mod.d.ts.map

package/script/mod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC"}

package/script/mod.js

@@ -0,0 +1,29 @@
+"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 });
+/**
+ * Main export module for Flowcore Pathways
+ *
+ * This module re-exports all the components needed to work with Flowcore Pathways:
+ * - Common types and utilities
+ * - Event contracts and schemas
+ * - Pathway definitions and builders
+ * - Event routing functionality
+ */
+__exportStar(require("./common/index.js"), exports);
+__exportStar(require("./contracts/index.js"), exports);
+__exportStar(require("./pathways/index.js"), exports);
+__exportStar(require("./router/index.js"), exports);

package/script/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/script/pathways/builder.d.ts

@@ -0,0 +1,91 @@
+import type { Static, TSchema } from "@sinclair/typebox";
+import type { WebhookSendOptions } from "@flowcore/sdk-transformer-core";
+import type { FlowcoreEvent } from "../contracts/event.js";
+import type { Logger } from "./logger.js";
+import type { EventMetadata, PathwayContract, PathwayKey, PathwayState, PathwayWriteOptions, WritablePathway } from "./types.js";
+export type AuditMode = "user" | "system";
+export type AuditHandler = (path: string, event: FlowcoreEvent) => void;
+export type UserIdResolver = () => Promise<string>;
+export interface AuditWebhookSendOptions extends WebhookSendOptions {
+    headers?: Record<string, string>;
+}
+export declare class PathwaysBuilder<TPathway extends Record<string, unknown> = {}, TWritablePaths extends keyof TPathway = never> {
+    private readonly pathways;
+    private readonly handlers;
+    private readonly beforeObservable;
+    private readonly afterObservers;
+    private readonly errorObservers;
+    private readonly globalErrorSubject;
+    private readonly writers;
+    private readonly schemas;
+    private readonly writable;
+    private readonly timeouts;
+    private readonly maxRetries;
+    private readonly retryDelays;
+    private readonly filePathways;
+    private readonly webhookBuilderFactory;
+    private pathwayState;
+    private pathwayTimeoutMs;
+    private auditHandler?;
+    private userIdResolver?;
+    private readonly logger;
+    constructor({ baseUrl, tenant, dataCore, apiKey, pathwayTimeoutMs, logger, }: {
+        baseUrl: string;
+        tenant: string;
+        dataCore: string;
+        apiKey: string;
+        pathwayTimeoutMs?: number;
+        logger?: Logger;
+    });
+    withPathwayState(state: PathwayState): PathwaysBuilder<TPathway, TWritablePaths>;
+    /**
+     * Configures the PathwaysBuilder to use audit functionality
+     * @param handler The handler function that receives pathway and event information
+     * @param userIdResolver An async function that resolves to the current user ID
+     * @returns The PathwaysBuilder instance with audit configured
+     */
+    withAudit(handler: AuditHandler, userIdResolver: UserIdResolver): PathwaysBuilder<TPathway, TWritablePaths>;
+    /**
+     * Process a pathway event with error handling and retries
+     * @param pathway The pathway to process
+     * @param data The event data to process
+     * @returns Promise that resolves when processing is complete
+     */
+    process(pathway: keyof TPathway, data: FlowcoreEvent): Promise<void>;
+    register<F extends string, E extends string, S extends TSchema, W extends boolean = true>(contract: PathwayContract<F, E, S> & {
+        writable?: W;
+        maxRetries?: number;
+        retryDelayMs?: number;
+    }): PathwaysBuilder<TPathway & Record<PathwayKey<F, E>, Static<S>>, TWritablePaths | WritablePathway<PathwayKey<F, E>, W>>;
+    get<TPath extends keyof TPathway>(path: TPath): TPathway[TPath];
+    handle<TPath extends keyof TPathway>(path: TPath, handler: (event: FlowcoreEvent) => (Promise<void> | void)): void;
+    /**
+     * Subscribe to pathway events (before or after processing)
+     * @param path The pathway to subscribe to
+     * @param handler The handler function for the events
+     * @param type The event type to subscribe to (before, after, or all)
+     */
+    subscribe<TPath extends keyof TPathway>(path: TPath, handler: (event: FlowcoreEvent) => void, type?: "before" | "after" | "all"): void;
+    /**
+     * Subscribe to errors for a specific pathway
+     * @param path The pathway to subscribe to errors for
+     * @param handler The handler function that receives the error and event
+     */
+    onError<TPath extends keyof TPathway>(path: TPath, handler: (error: Error, event: FlowcoreEvent) => void): void;
+    /**
+     * Subscribe to errors for all pathways
+     * @param handler The handler function that receives the error, event, and pathway name
+     */
+    onAnyError(handler: (error: Error, event: FlowcoreEvent, pathway: string) => void): void;
+    /**
+     * Writes data to a pathway with optional audit metadata
+     * @param path The pathway to write to
+     * @param data The data to write
+     * @param metadata Optional metadata to include with the event
+     * @param options Optional write options
+     * @returns A promise that resolves to the event ID(s)
+     */
+    write<TPath extends TWritablePaths>(path: TPath, data: TPathway[TPath], metadata?: EventMetadata, options?: PathwayWriteOptions): Promise<string | string[]>;
+    private waitForPathwayToBeProcessed;
+}
+//# sourceMappingURL=builder.d.ts.map

package/script/pathways/builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"builder.d.ts","sourceRoot":"","sources":["../../src/pathways/builder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAExD,OAAO,KAAK,EAAyD,kBAAkB,EAAE,MAAM,gCAAgC,CAAA;AAG/H,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AAE1D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAEzC,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,UAAU,EAAE,YAAY,EAAE,mBAAmB,EAA6B,eAAe,EAAE,MAAM,YAAY,CAAA;AAO3J,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,QAAQ,CAAA;AACzC,MAAM,MAAM,YAAY,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,aAAa,KAAK,IAAI,CAAA;AACvE,MAAM,MAAM,cAAc,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,CAAA;AAGlD,MAAM,WAAW,uBAAwB,SAAQ,kBAAkB;IACjE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CACjC;AAED,qBAAa,eAAe,CAE1B,QAAQ,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,EAAE,EAC7C,cAAc,SAAS,MAAM,QAAQ,GAAG,KAAK;IAE7C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA2B;IACpD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAGxB;IACD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAGhC;IACD,OAAO,CAAC,QAAQ,CAAC,cAAc,CAG9B;IACD,OAAO,CAAC,QAAQ,CAAC,cAAc,CAG9B;IACD,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAyE;IAC5G,OAAO,CAAC,QAAQ,CAAC,OAAO,CAGvB;IACD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyE;IACjG,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAyE;IAClG,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAuE;IAChG,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAuE;IAClG,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAuE;IACnG,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAiC;IAC9D,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAA0B;IAChE,OAAO,CAAC,YAAY,CAA2C;IAC/D,OAAO,CAAC,gBAAgB,CAAqC;IAG7D,OAAO,CAAC,YAAY,CAAC,CAAc;IACnC,OAAO,CAAC,cAAc,CAAC,CAAgB;IAGvC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAQ;gBAEnB,EACV,OAAO,EACP,MAAM,EACN,QAAQ,EACR,MAAM,EACN,gBAAgB,EAChB,MAAM,GACP,EAAE;QACD,OAAO,EAAE,MAAM,CAAA;QACf,MAAM,EAAE,MAAM,CAAA;QACd,QAAQ,EAAE,MAAM,CAAA;QAChB,MAAM,EAAE,MAAM,CAAA;QACd,gBAAgB,CAAC,EAAE,MAAM,CAAA;QACzB,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB;IA4BD,gBAAgB,CAAC,KAAK,EAAE,YAAY,GAAG,eAAe,CAAC,QAAQ,EAAE,cAAc,CAAC;IAMhF;;;;;OAKG;IACH,SAAS,CAAC,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,cAAc,GAAG,eAAe,CAAC,QAAQ,EAAE,cAAc,CAAC;IAO3G;;;;;OAKG;IACU,OAAO,CAAC,OAAO,EAAE,MAAM,QAAQ,EAAE,IAAI,EAAE,aAAa;IA8HjE,QAAQ,CACN,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,OAAO,EACjB,CAAC,SAAS,OAAO,GAAG,IAAI,EAExB,QAAQ,EAAE,eAAe,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG;QAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,CAAA;KAAE,GAChG,eAAe,CAChB,QAAQ,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,EAC9C,cAAc,GAAG,eAAe,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CACtD;IA4DD,GAAG,CAAC,KAAK,SAAS,MAAM,QAAQ,EAAE,IAAI,EAAE,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;IAK/D,MAAM,CAAC,KAAK,SAAS,MAAM,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAE,GAAG,IAAI;IAqBnH;;;;;OAKG;IACH,SAAS,CAAC,KAAK,SAAS,MAAM,QAAQ,EACpC,IAAI,EAAE,KAAK,EACX,OAAO,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,EACvC,IAAI,GAAE,QAAQ,GAAG,OAAO,GAAG,KAAgB,GAC1C,IAAI;IA6BP;;;;OAIG;IACH,OAAO,CAAC,KAAK,SAAS,MAAM,QAAQ,EAClC,IAAI,EAAE,KAAK,EACX,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,aAAa,KAAK,IAAI,GACpD,IAAI;IAcP;;;OAGG;IACH,UAAU,CACR,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,GACrE,IAAI;IAMP;;;;;;;OAOG;IACG,KAAK,CAAC,KAAK,SAAS,cAAc,EACtC,IAAI,EAAE,KAAK,EACX,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,EACrB,QAAQ,CAAC,EAAE,aAAa,EACxB,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC;YA4Ff,2BAA2B;CA4C1C"}