@flowcore/pathways 0.2.1 → 0.2.3

package/script/pathways/postgres/index.d.ts

@@ -3,6 +3,8 @@
  *
  * This module exports components for using PostgreSQL as a storage backend
  * for pathway state and other persistent data.
+ *
+ * @module
  */
 export * from "./postgres-adapter.js";
 export * from "./postgres-pathway-state.js";

package/script/pathways/postgres/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/pathways/postgres/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,cAAc,uBAAuB,CAAC;AACtC,cAAc,6BAA6B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/pathways/postgres/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,cAAc,uBAAuB,CAAC;AACtC,cAAc,6BAA6B,CAAC"}

package/script/pathways/postgres/index.js

@@ -19,6 +19,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
  *
  * This module exports components for using PostgreSQL as a storage backend
  * for pathway state and other persistent data.
+ *
+ * @module
  */
 __exportStar(require("./postgres-adapter.js"), exports);
 __exportStar(require("./postgres-pathway-state.js"), exports);

package/script/pathways/postgres/postgres-adapter.d.ts

@@ -1,7 +1,5 @@
 /**
  * Configuration options for PostgreSQL connection
- *
- * @interface PostgresConfig
  */
 export interface PostgresConfig {
     /** PostgreSQL server hostname */
@@ -21,40 +19,36 @@ export interface PostgresConfig {
  * Interface for PostgreSQL database operations
  *
  * Provides methods for connecting, querying, and executing SQL statements
- *
- * @interface PostgresAdapter
  */
 export interface PostgresAdapter {
     /**
      * Establishes a connection to the PostgreSQL database
-     * @returns {Promise<void>}
+     * @returns Promise that resolves when the connection is established
      */
     connect(): Promise<void>;
     /**
      * Closes the connection to the PostgreSQL database
-     * @returns {Promise<void>}
+     * @returns Promise that resolves when the connection is closed
      */
     disconnect(): Promise<void>;
     /**
      * Executes a SQL query and returns the results
      * @template T The expected result type
-     * @param {string} sql The SQL query to execute
-     * @param {unknown[]} [params] Optional parameters for the query
-     * @returns {Promise<T>} The query results
+     * @param sql The SQL query to execute
+     * @param params Optional parameters for the query
+     * @returns Promise that resolves to the query results
      */
     query<T>(sql: string, params?: unknown[]): Promise<T>;
     /**
      * Executes a SQL statement without returning results
-     * @param {string} sql The SQL statement to execute
-     * @param {unknown[]} [params] Optional parameters for the statement
-     * @returns {Promise<void>}
+     * @param sql The SQL statement to execute
+     * @param params Optional parameters for the statement
+     * @returns Promise that resolves when the statement has been executed
      */
     execute(sql: string, params?: unknown[]): Promise<void>;
 }
 /**
  * Implementation of PostgresAdapter using the postgres.js library
- *
- * @implements {PostgresAdapter}
  */
 export declare class PostgresJsAdapter implements PostgresAdapter {
     /** The postgres.js client factory function */
@@ -68,45 +62,42 @@ export declare class PostgresJsAdapter implements PostgresAdapter {
     /**
      * Creates a new PostgresJsAdapter instance
      *
-     * @param {PostgresConfig} config The PostgreSQL connection configuration
+     * @param config The PostgreSQL connection configuration
      */
     constructor(config: PostgresConfig);
     /**
      * Establishes a connection to the PostgreSQL database
      *
-     * @returns {Promise<void>}
-     * @throws {Error} If connection fails
+     * @returns Promise that resolves when connection is established
+     * @throws Error if connection fails
      */
     connect(): Promise<void>;
     /**
      * Closes the connection to the PostgreSQL database
-     *
-     * @returns {Promise<void>}
+     * @returns Promise that resolves when the connection is closed
      */
     disconnect(): Promise<void>;
     /**
      * Executes a SQL query and returns the results
-     *
      * @template T The expected result type
-     * @param {string} sql The SQL query to execute
-     * @param {unknown[]} [params=[]] Optional parameters for the query
-     * @returns {Promise<T>} The query results
+     * @param sql The SQL query to execute
+     * @param params Optional parameters for the query
+     * @returns Promise that resolves to the query results
      */
     query<T>(sql: string, params?: unknown[]): Promise<T>;
     /**
      * Executes a SQL statement without returning results
-     *
-     * @param {string} sql The SQL statement to execute
-     * @param {unknown[]} [params=[]] Optional parameters for the statement
-     * @returns {Promise<void>}
+     * @param sql The SQL statement to execute
+     * @param params Optional parameters for the statement
+     * @returns Promise that resolves when the statement has been executed
      */
     execute(sql: string, params?: unknown[]): Promise<void>;
 }
 /**
  * Creates and initializes a PostgreSQL adapter
  *
- * @param {PostgresConfig} config The PostgreSQL connection configuration
- * @returns {Promise<PostgresAdapter>} An initialized PostgreSQL adapter
+ * @param config The PostgreSQL connection configuration
+ * @returns An initialized PostgreSQL adapter
  */
 export declare function createPostgresAdapter(config: PostgresConfig): Promise<PostgresAdapter>;
 //# sourceMappingURL=postgres-adapter.d.ts.map

package/script/pathways/postgres/postgres-adapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"postgres-adapter.d.ts","sourceRoot":"","sources":["../../../src/pathways/postgres/postgres-adapter.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,0BAA0B;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,4CAA4C;IAC5C,GAAG,CAAC,EAAE,OAAO,CAAC;CACf;AAED;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzB;;;OAGG;IACH,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5B;;;;;;OAMG;IACH,KAAK,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAEtD;;;;;OAKG;IACH,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACzD;AAoBD;;;;GAIG;AACH,qBAAa,iBAAkB,YAAW,eAAe;IACvD,8CAA8C;IAC9C,OAAO,CAAC,QAAQ,CAA+D;IAC/E,oCAAoC;IACpC,OAAO,CAAC,GAAG,CAA+B;IAC1C,mCAAmC;IACnC,OAAO,CAAC,MAAM,CAAiB;IAC/B,yDAAyD;IACzD,OAAO,CAAC,gBAAgB,CAAS;IAEjC;;;;OAIG;gBACS,MAAM,EAAE,cAAc;IAQlC;;;;;OAKG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAW9B;;;;OAIG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAOjC;;;;;;;OAOG;IACG,KAAK,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,GAAE,OAAO,EAAO,GAAG,OAAO,CAAC,CAAC,CAAC;IAO/D;;;;;;OAMG;IACG,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,GAAE,OAAO,EAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CAMlE;AAED;;;;;GAKG;AACH,wBAAsB,qBAAqB,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC,CAI5F"}
+{"version":3,"file":"postgres-adapter.d.ts","sourceRoot":"","sources":["../../../src/pathways/postgres/postgres-adapter.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,0BAA0B;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,4CAA4C;IAC5C,GAAG,CAAC,EAAE,OAAO,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzB;;;OAGG;IACH,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5B;;;;;;OAMG;IACH,KAAK,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAEtD;;;;;OAKG;IACH,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACzD;AAoBD;;GAEG;AACH,qBAAa,iBAAkB,YAAW,eAAe;IACvD,8CAA8C;IAC9C,OAAO,CAAC,QAAQ,CAA+D;IAC/E,oCAAoC;IACpC,OAAO,CAAC,GAAG,CAA+B;IAC1C,mCAAmC;IACnC,OAAO,CAAC,MAAM,CAAiB;IAC/B,yDAAyD;IACzD,OAAO,CAAC,gBAAgB,CAAS;IAEjC;;;;OAIG;gBACS,MAAM,EAAE,cAAc;IAQlC;;;;;OAKG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAW9B;;;OAGG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAOjC;;;;;;OAMG;IACG,KAAK,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,GAAE,OAAO,EAAO,GAAG,OAAO,CAAC,CAAC,CAAC;IAO/D;;;;;OAKG;IACG,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,GAAE,OAAO,EAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CAMlE;AAED;;;;;GAKG;AACH,wBAAsB,qBAAqB,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC,CAI5F"}

package/script/pathways/postgres/postgres-adapter.js

@@ -27,14 +27,12 @@ exports.PostgresJsAdapter = void 0;
 exports.createPostgresAdapter = createPostgresAdapter;
 /**
  * Implementation of PostgresAdapter using the postgres.js library
- *
- * @implements {PostgresAdapter}
  */
 class PostgresJsAdapter {
     /**
      * Creates a new PostgresJsAdapter instance
      *
-     * @param {PostgresConfig} config The PostgreSQL connection configuration
+     * @param config The PostgreSQL connection configuration
      */
     constructor(config) {
         /** The postgres.js client factory function */
@@ -74,8 +72,8 @@ class PostgresJsAdapter {
     /**
      * Establishes a connection to the PostgreSQL database
      *
-     * @returns {Promise<void>}
-     * @throws {Error} If connection fails
+     * @returns Promise that resolves when connection is established
+     * @throws Error if connection fails
      */
     async connect() {
         try {
@@ -90,8 +88,7 @@ class PostgresJsAdapter {
     }
     /**
      * Closes the connection to the PostgreSQL database
-     *
-     * @returns {Promise<void>}
+     * @returns Promise that resolves when the connection is closed
      */
     async disconnect() {
         if (this.sql) {
@@ -101,11 +98,10 @@ class PostgresJsAdapter {
     }
     /**
      * Executes a SQL query and returns the results
-     *
      * @template T The expected result type
-     * @param {string} sql The SQL query to execute
-     * @param {unknown[]} [params=[]] Optional parameters for the query
-     * @returns {Promise<T>} The query results
+     * @param sql The SQL query to execute
+     * @param params Optional parameters for the query
+     * @returns Promise that resolves to the query results
      */
     async query(sql, params = []) {
         if (!this.sql) {
@@ -115,10 +111,9 @@ class PostgresJsAdapter {
     }
     /**
      * Executes a SQL statement without returning results
-     *
-     * @param {string} sql The SQL statement to execute
-     * @param {unknown[]} [params=[]] Optional parameters for the statement
-     * @returns {Promise<void>}
+     * @param sql The SQL statement to execute
+     * @param params Optional parameters for the statement
+     * @returns Promise that resolves when the statement has been executed
      */
     async execute(sql, params = []) {
         if (!this.sql) {
@@ -131,8 +126,8 @@ exports.PostgresJsAdapter = PostgresJsAdapter;
 /**
  * Creates and initializes a PostgreSQL adapter
  *
- * @param {PostgresConfig} config The PostgreSQL connection configuration
- * @returns {Promise<PostgresAdapter>} An initialized PostgreSQL adapter
+ * @param config The PostgreSQL connection configuration
+ * @returns An initialized PostgreSQL adapter
  */
 async function createPostgresAdapter(config) {
     const adapter = new PostgresJsAdapter(config);

package/script/pathways/postgres/postgres-pathway-state.d.ts

@@ -1,8 +1,6 @@
 import type { PathwayState } from "../types.js";
 /**
  * Configuration options for PostgreSQL pathway state storage
- *
- * @interface PostgresPathwayStateConfig
  */
 export interface PostgresPathwayStateConfig {
     /** PostgreSQL server hostname */
@@ -27,8 +25,6 @@ export interface PostgresPathwayStateConfig {
  *
  * This class provides persistent storage of pathway state using a PostgreSQL database,
  * which allows for state to be shared across multiple instances of the application.
- *
- * @implements {PathwayState}
  */
 export declare class PostgresPathwayState implements PathwayState {
     private config;
@@ -106,8 +102,8 @@ export declare class PostgresPathwayState implements PathwayState {
 /**
  * Creates a new PostgreSQL pathway state instance
  *
- * @param {PostgresPathwayStateConfig} config The PostgreSQL configuration
- * @returns {PostgresPathwayState} A new PostgresPathwayState instance
+ * @param config The PostgreSQL configuration
+ * @returns A new PostgresPathwayState instance
  */
 export declare function createPostgresPathwayState(config: PostgresPathwayStateConfig): PostgresPathwayState;
 //# sourceMappingURL=postgres-pathway-state.d.ts.map

package/script/pathways/postgres/postgres-pathway-state.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"postgres-pathway-state.d.ts","sourceRoot":"","sources":["../../../src/pathways/postgres/postgres-pathway-state.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAIhD;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,0BAA0B;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,4CAA4C;IAC5C,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,sEAAsE;IACtE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,6EAA6E;IAC7E,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;GAOG;AACH,qBAAa,oBAAqB,YAAW,YAAY;IA0C3C,OAAO,CAAC,MAAM;IAzC1B;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAiB;IAEvD;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,kBAAkB,CAAmB;IAE7D;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAkB;IAElC;;;OAGG;IACH,OAAO,CAAC,SAAS,CAAS;IAE1B;;;OAGG;IACH,OAAO,CAAC,KAAK,CAAS;IAEtB;;;OAGG;IACH,OAAO,CAAC,WAAW,CAAS;IAE5B;;;;OAIG;gBACiB,MAAM,EAAE,0BAA0B;IAMtD;;;;;OAKG;YACW,UAAU;IAgCxB;;;;;OAKG;IACG,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAcpD;;;;;OAKG;IACG,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAelD;;;;;OAKG;YACW,cAAc;IAQ5B;;;;OAIG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAK7B;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CAAC,MAAM,EAAE,0BAA0B,GAAG,oBAAoB,CAGnG"}
+{"version":3,"file":"postgres-pathway-state.d.ts","sourceRoot":"","sources":["../../../src/pathways/postgres/postgres-pathway-state.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAIhD;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,0BAA0B;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,4CAA4C;IAC5C,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,sEAAsE;IACtE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,6EAA6E;IAC7E,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;GAKG;AACH,qBAAa,oBAAqB,YAAW,YAAY;IA0C3C,OAAO,CAAC,MAAM;IAzC1B;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAiB;IAEvD;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,kBAAkB,CAAmB;IAE7D;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAkB;IAElC;;;OAGG;IACH,OAAO,CAAC,SAAS,CAAS;IAE1B;;;OAGG;IACH,OAAO,CAAC,KAAK,CAAS;IAEtB;;;OAGG;IACH,OAAO,CAAC,WAAW,CAAS;IAE5B;;;;OAIG;gBACiB,MAAM,EAAE,0BAA0B;IAMtD;;;;;OAKG;YACW,UAAU;IAgCxB;;;;;OAKG;IACG,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAcpD;;;;;OAKG;IACG,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAelD;;;;;OAKG;YACW,cAAc;IAQ5B;;;;OAIG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAK7B;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CAAC,MAAM,EAAE,0BAA0B,GAAG,oBAAoB,CAGnG"}

package/script/pathways/postgres/postgres-pathway-state.js

@@ -8,8 +8,6 @@ const postgres_adapter_js_1 = require("./postgres-adapter.js");
  *
  * This class provides persistent storage of pathway state using a PostgreSQL database,
  * which allows for state to be shared across multiple instances of the application.
- *
- * @implements {PathwayState}
  */
 class PostgresPathwayState {
     /**
@@ -184,8 +182,8 @@ Object.defineProperty(PostgresPathwayState, "DEFAULT_TABLE_NAME", {
 /**
  * Creates a new PostgreSQL pathway state instance
  *
- * @param {PostgresPathwayStateConfig} config The PostgreSQL configuration
- * @returns {PostgresPathwayState} A new PostgresPathwayState instance
+ * @param config The PostgreSQL configuration
+ * @returns A new PostgresPathwayState instance
  */
 function createPostgresPathwayState(config) {
     const state = new PostgresPathwayState(config);

package/script/pathways/types.d.ts

@@ -2,19 +2,29 @@ import type { TSchema } from "@sinclair/typebox";
 import type { WebhookFileData, WebhookSendOptions } from "@flowcore/sdk-transformer-core";
 /**
  * Helper type to create a custom type error for non-writable pathways
+ * @template T The string type to create an error for
  */
 type NonWritablePathwayError<T extends string> = T & {
     readonly __nonWritablePathwayError: "This pathway is not writable. To make it writable, remove 'writable: false' from the pathway contract.";
 };
 /**
  * Contract for defining a pathway
- * @template F - The flow type
- * @template E - The event type
- * @template T - The schema type
+ * @template F The flow type
+ * @template E The event type
+ * @template T The schema type
  */
 export interface PathwayContract<F extends string, E extends string, T extends TSchema> {
+    /**
+     * The flow type for this pathway
+     */
     flowType: F;
+    /**
+     * The event type for this pathway
+     */
     eventType: E;
+    /**
+     * The schema that defines the structure of events for this pathway
+     */
     schema: T;
     /**
      * Whether the pathway is writable. Use `false as const` to make the pathway non-writable at compile time.
@@ -63,24 +73,59 @@ export interface PathwayContract<F extends string, E extends string, T extends T
      */
     isFilePathway?: boolean;
 }
+/**
+ * Creates a string key from flow type and event type in the format `flowType/eventType`
+ * @template F The flow type
+ * @template E The event type
+ */
 export type PathwayKey<F extends string, E extends string> = `${F}/${E}`;
+/**
+ * Interface for event metadata, extending Record<string, unknown>
+ */
 export interface EventMetadata extends Record<string, unknown> {
 }
+/**
+ * Function type for sending an event to a webhook
+ * @template EventPayload The type of the event payload
+ */
 export type SendWebhook<EventPayload> = (payload: EventPayload, metadata?: EventMetadata, options?: WebhookSendOptions) => Promise<string>;
+/**
+ * Function type for sending a file to a webhook
+ */
 export type SendFilehook = (payload: WebhookFileData, metadata?: EventMetadata, options?: WebhookSendOptions) => Promise<string[]>;
 /**
  * Helper type to create a better error message for non-writable pathways
+ * @template T The string type for the pathway
+ * @template IsWritable Boolean indicating if the pathway is writable
  */
 export type WritablePathway<T extends string, IsWritable extends boolean> = IsWritable extends false ? NonWritablePathwayError<T> : T;
+/**
+ * Interface for managing pathway processing state
+ */
 export type PathwayState = {
+    /**
+     * Checks if an event has been processed
+     * @param eventId The ID of the event to check
+     * @returns Boolean indicating if the event has been processed
+     */
     isProcessed: (eventId: string) => (boolean | Promise<boolean>);
+    /**
+     * Marks an event as processed
+     * @param eventId The ID of the event to mark as processed
+     */
     setProcessed: (eventId: string) => (void | Promise<void>);
 };
 /**
  * Options for pathway writes, extending WebhookSendOptions
  */
 export type PathwayWriteOptions = WebhookSendOptions & {
+    /**
+     * If true, doesn't wait for confirmation of event delivery
+     */
     fireAndForget?: boolean;
+    /**
+     * Additional HTTP headers to include with the request
+     */
     headers?: Record<string, string>;
 };
 export {};

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/pathways/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAA;AAEzF;;GAEG;AACH,KAAK,uBAAuB,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,GAAG;IACnD,QAAQ,CAAC,yBAAyB,EAAE,wGAAwG,CAAA;CAC7I,CAAA;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,OAAO;IACpF,QAAQ,EAAE,CAAC,CAAA;IACX,SAAS,EAAE,CAAC,CAAA;IACZ,MAAM,EAAE,CAAC,CAAA;IACT;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;CACxB;AAED,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,IAAI,GAAG,CAAC,IAAI,CAAC,EAAE,CAAA;AAExE,MAAM,WAAW,aAAc,SAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAAG;AAEjE,MAAM,MAAM,WAAW,CAAC,YAAY,IAAI,CAAC,OAAO,EAAE,YAAY,EAAE,QAAQ,CAAC,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,kBAAkB,KAAK,OAAO,CAAC,MAAM,CAAC,CAAA;AAC1I,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,EAAE,eAAe,EAAE,QAAQ,CAAC,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,kBAAkB,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC,CAAA;AAElI;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,MAAM,EAAE,UAAU,SAAS,OAAO,IAAI,UAAU,SAAS,KAAK,GAAG,uBAAuB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;AAErI,MAAM,MAAM,YAAY,GAAG;IACzB,WAAW,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAA;IAC9D,YAAY,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAA;CAC1D,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,kBAAkB,GAAG;IACrD,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CACjC,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/pathways/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAA;AAEzF;;;GAGG;AACH,KAAK,uBAAuB,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,GAAG;IACnD,QAAQ,CAAC,yBAAyB,EAAE,wGAAwG,CAAA;CAC7I,CAAA;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,OAAO;IACpF;;OAEG;IACH,QAAQ,EAAE,CAAC,CAAA;IAEX;;OAEG;IACH,SAAS,EAAE,CAAC,CAAA;IAEZ;;OAEG;IACH,MAAM,EAAE,CAAC,CAAA;IAET;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAA;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;CACxB;AAED;;;;GAIG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,IAAI,GAAG,CAAC,IAAI,CAAC,EAAE,CAAA;AAExE;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAAG;AAEjE;;;GAGG;AACH,MAAM,MAAM,WAAW,CAAC,YAAY,IAAI,CAAC,OAAO,EAAE,YAAY,EAAE,QAAQ,CAAC,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,kBAAkB,KAAK,OAAO,CAAC,MAAM,CAAC,CAAA;AAE1I;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,EAAE,eAAe,EAAE,QAAQ,CAAC,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,kBAAkB,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC,CAAA;AAElI;;;;GAIG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,MAAM,EAAE,UAAU,SAAS,OAAO,IAAI,UAAU,SAAS,KAAK,GAAG,uBAAuB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;AAErI;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;;;OAIG;IACH,WAAW,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAA;IAE9D;;;OAGG;IACH,YAAY,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAA;CAC1D,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,kBAAkB,GAAG;IACrD;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CACjC,CAAA"}

package/script/router/index.d.ts

@@ -1,10 +1,16 @@
+/**
+ * Router module for Flowcore Pathways
+ *
+ * This module provides routing functionality to direct incoming events
+ * to the appropriate pathway handlers based on flow type and event type.
+ *
+ * @module
+ */
 import type { FlowcoreLegacyEvent } from "../common/flowcore.type.js";
 import type { PathwaysBuilder } from "../pathways/index.js";
 import type { Logger } from "../pathways/logger.js";
 /**
  * Router class that handles directing events to the appropriate pathway handlers
- *
- * @class PathwayRouter
  */
 export declare class PathwayRouter {
     private readonly pathways;
@@ -13,19 +19,19 @@ export declare class PathwayRouter {
     /**
      * Creates a new instance of PathwayRouter
      *
-     * @param {PathwaysBuilder<Record<string, any>>} pathways - The pathways builder instance that contains all registered pathways
-     * @param {string} secretKey - Secret key used for authentication when processing events
-     * @param {Logger} [logger] - Optional logger instance (defaults to NoopLogger if not provided)
-     * @throws {Error} Will throw an error if secretKey is empty or not provided
+     * @param pathways The pathways builder instance that contains all registered pathways
+     * @param secretKey Secret key used for authentication when processing events
+     * @param logger Optional logger instance (defaults to NoopLogger if not provided)
+     * @throws Error if secretKey is empty or not provided
      */
     constructor(pathways: PathwaysBuilder<Record<string, any>>, secretKey: string, logger?: Logger);
     /**
-     * Processes an incoming event by routing it to the appropriate pathway
+     * Process an incoming event by routing it to the appropriate pathway handler
      *
-     * @param {FlowcoreLegacyEvent} event - The event to process
-     * @param {string} providedSecret - The secret key provided for authentication
-     * @returns {Promise<{ success: boolean; message: string }>} Result of the event processing
-     * @throws {Error} Will throw an error if authentication fails, pathway is not found, or processing fails
+     * @param event The event to process
+     * @param providedSecret The secret key provided for authentication
+     * @returns Result of the event processing with success status and message
+     * @throws Error if authentication fails, pathway is not found, or processing fails
      */
     processEvent(event: FlowcoreLegacyEvent, providedSecret: string): Promise<{
         success: boolean;

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/router/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAA;AAErE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAC3D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAA;AAGnD;;;;GAIG;AACH,qBAAa,aAAa;IAatB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAb5B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAEhC;;;;;;;OAOG;gBAGgB,QAAQ,EAAE,eAAe,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,EAC9C,SAAS,EAAE,MAAM,EAClC,MAAM,CAAC,EAAE,MAAM;IAYjB;;;;;;;OAOG;IACG,YAAY,CAAC,KAAK,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;CAoDvH"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/router/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAA;AAErE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAC3D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAA;AAGnD;;GAEG;AACH,qBAAa,aAAa;IAatB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAb5B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAEhC;;;;;;;OAOG;gBAGgB,QAAQ,EAAE,eAAe,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,EAC9C,SAAS,EAAE,MAAM,EAClC,MAAM,CAAC,EAAE,MAAM;IAajB;;;;;;;OAOG;IACG,YAAY,CAAC,KAAK,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;CAkDvH"}

package/script/router/index.js

@@ -4,17 +4,15 @@ exports.PathwayRouter = void 0;
 const logger_js_1 = require("../pathways/logger.js");
 /**
  * Router class that handles directing events to the appropriate pathway handlers
- *
- * @class PathwayRouter
  */
 class PathwayRouter {
     /**
      * Creates a new instance of PathwayRouter
      *
-     * @param {PathwaysBuilder<Record<string, any>>} pathways - The pathways builder instance that contains all registered pathways
-     * @param {string} secretKey - Secret key used for authentication when processing events
-     * @param {Logger} [logger] - Optional logger instance (defaults to NoopLogger if not provided)
-     * @throws {Error} Will throw an error if secretKey is empty or not provided
+     * @param pathways The pathways builder instance that contains all registered pathways
+     * @param secretKey Secret key used for authentication when processing events
+     * @param logger Optional logger instance (defaults to NoopLogger if not provided)
+     * @throws Error if secretKey is empty or not provided
      */
     constructor(
     // deno-lint-ignore no-explicit-any
@@ -39,24 +37,26 @@ class PathwayRouter {
         });
         this.logger = logger ?? new logger_js_1.NoopLogger();
         if (!secretKey || secretKey.trim() === "") {
-            this.logger.error("Secret key is required for PathwayRouter");
-            throw new Error("Secret key is required for PathwayRouter");
+            const errorMsg = "Secret key is required for PathwayRouter";
+            this.logger.error(errorMsg, new Error(errorMsg));
+            throw new Error(errorMsg);
         }
         this.logger.debug("PathwayRouter initialized");
     }
     /**
-     * Processes an incoming event by routing it to the appropriate pathway
+     * Process an incoming event by routing it to the appropriate pathway handler
      *
-     * @param {FlowcoreLegacyEvent} event - The event to process
-     * @param {string} providedSecret - The secret key provided for authentication
-     * @returns {Promise<{ success: boolean; message: string }>} Result of the event processing
-     * @throws {Error} Will throw an error if authentication fails, pathway is not found, or processing fails
+     * @param event The event to process
+     * @param providedSecret The secret key provided for authentication
+     * @returns Result of the event processing with success status and message
+     * @throws Error if authentication fails, pathway is not found, or processing fails
      */
     async processEvent(event, providedSecret) {
         // Validate secret key
         if (!providedSecret || providedSecret !== this.secretKey) {
-            this.logger.error("Invalid secret key provided");
-            throw new Error("Invalid secret key");
+            const errorMsg = "Invalid secret key";
+            this.logger.error(errorMsg, new Error(errorMsg));
+            throw new Error(errorMsg);
         }
         const compatibleEvent = {
             ...event,
@@ -68,9 +68,9 @@ class PathwayRouter {
         });
         const pathway = this.pathways.get(pathwayKey);
         if (!pathway) {
-            const error = `Pathway ${pathwayKey} not found`;
-            this.logger.error(error);
-            throw new Error(error);
+            const errorMsg = `Pathway ${pathwayKey} not found`;
+            this.logger.error(errorMsg, new Error(errorMsg));
+            throw new Error(errorMsg);
         }
         try {
             this.logger.debug(`Delegating event processing to pathway handler`, {
@@ -85,15 +85,12 @@ class PathwayRouter {
             return { success: true, message: `Event processed through pathway ${pathwayKey}` };
         }
         catch (error) {
-            const errorMessage = error instanceof Error
-                ? error.message
-                : String(error);
-            this.logger.error(`Error processing pathway ${pathwayKey}`, {
-                error: errorMessage,
+            const errorObj = error instanceof Error ? error : new Error(String(error));
+            this.logger.error(`Error processing pathway ${pathwayKey}`, errorObj, {
                 eventId: compatibleEvent.eventId
             });
             // Rethrow the error with additional context
-            throw new Error(`Failed to process event in pathway ${pathwayKey}: ${errorMessage}`);
+            throw new Error(`Failed to process event in pathway ${pathwayKey}: ${errorObj.message}`);
         }
     }
 }