@flowcore/pathways 0.2.1 → 0.2.2

package/esm/pathways/kv/kv-adapter.d.ts

@@ -9,17 +9,17 @@ export interface KvAdapter {
      * Retrieves a value from storage by key
      *
      * @template T The expected type of the stored value
-     * @param {string} key The key to retrieve
-     * @returns {(Promise<T | null> | T | null)} The stored value or null if not found
+     * @param key The key to retrieve
+     * @returns The stored value or null if not found
      */
     get<T>(key: string): (Promise<T | null> | T | null);
     /**
      * Stores a value in storage with the specified key and TTL
      *
-     * @param {string} key The key to store the value under
-     * @param {unknown} value The value to store
-     * @param {number} ttlMs Time-to-live in milliseconds
-     * @returns {(Promise<void> | void)}
+     * @param key The key to store the value under
+     * @param value The value to store
+     * @param ttlMs Time-to-live in milliseconds
+     * @returns Promise or void when the operation completes
      */
     set(key: string, value: unknown, ttlMs: number): (Promise<void> | void);
 }
@@ -28,7 +28,7 @@ export interface KvAdapter {
  *
  * Attempts to use Bun KV adapter if running in Bun, falls back to Node adapter otherwise
  *
- * @returns {Promise<KvAdapter>} A KV adapter instance
+ * @returns A KV adapter instance for the current runtime
  */
 export declare function createKvAdapter(): Promise<KvAdapter>;
 //# sourceMappingURL=kv-adapter.d.ts.map

package/esm/pathways/kv/kv-adapter.js

@@ -3,7 +3,7 @@
  *
  * Attempts to use Bun KV adapter if running in Bun, falls back to Node adapter otherwise
  *
- * @returns {Promise<KvAdapter>} A KV adapter instance
+ * @returns A KV adapter instance for the current runtime
  */
 export async function createKvAdapter() {
     try {

package/esm/pathways/kv/node-kv-adapter.d.ts

@@ -3,8 +3,6 @@ import type { KvAdapter } from "./kv-adapter.js";
  * KV adapter implementation for Node.js runtime
  *
  * Uses node-cache for in-memory key-value storage
- *
- * @implements {KvAdapter}
  */
 export declare class NodeKvAdapter implements KvAdapter {
     /**
@@ -16,17 +14,17 @@ export declare class NodeKvAdapter implements KvAdapter {
      * Retrieves a value from the Node.js cache
      *
      * @template T The expected type of the stored value
-     * @param {string} key The key to retrieve
-     * @returns {Promise<T | null>} The stored value or null if not found
+     * @param key The key to retrieve
+     * @returns The stored value or null if not found
      */
     get<T>(key: string): Promise<T | null>;
     /**
      * Stores a value in the Node.js cache with the specified TTL
      *
-     * @param {string} key The key to store the value under
-     * @param {unknown} value The value to store
-     * @param {number} ttlMs Time-to-live in milliseconds
-     * @returns {Promise<void>}
+     * @param key The key to store the value under
+     * @param value The value to store
+     * @param ttlMs Time-to-live in milliseconds
+     * @returns Promise that resolves when the operation completes
      */
     set(key: string, value: unknown, ttlMs: number): Promise<void>;
 }

package/esm/pathways/kv/node-kv-adapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"node-kv-adapter.d.ts","sourceRoot":"","sources":["../../../src/pathways/kv/node-kv-adapter.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAEjD;;;;;;GAMG;AACH,qBAAa,aAAc,YAAW,SAAS;IAC7C;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAmB;IAEtC;;;;;;OAMG;IACG,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAK5C;;;;;;;OAOG;IACG,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAGrE"}
+{"version":3,"file":"node-kv-adapter.d.ts","sourceRoot":"","sources":["../../../src/pathways/kv/node-kv-adapter.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAEjD;;;;GAIG;AACH,qBAAa,aAAc,YAAW,SAAS;IAC7C;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAmB;IAEtC;;;;;;OAMG;IACG,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAK5C;;;;;;;OAOG;IACG,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAGrE"}

package/esm/pathways/kv/node-kv-adapter.js

@@ -3,8 +3,6 @@ import NodeCache from "node-cache";
  * KV adapter implementation for Node.js runtime
  *
  * Uses node-cache for in-memory key-value storage
- *
- * @implements {KvAdapter}
  */
 export class NodeKvAdapter {
     constructor() {
@@ -23,8 +21,8 @@ export class NodeKvAdapter {
      * Retrieves a value from the Node.js cache
      *
      * @template T The expected type of the stored value
-     * @param {string} key The key to retrieve
-     * @returns {Promise<T | null>} The stored value or null if not found
+     * @param key The key to retrieve
+     * @returns The stored value or null if not found
      */
     async get(key) {
         const result = await this.kv.get(key);
@@ -33,10 +31,10 @@ export class NodeKvAdapter {
     /**
      * Stores a value in the Node.js cache with the specified TTL
      *
-     * @param {string} key The key to store the value under
-     * @param {unknown} value The value to store
-     * @param {number} ttlMs Time-to-live in milliseconds
-     * @returns {Promise<void>}
+     * @param key The key to store the value under
+     * @param value The value to store
+     * @param ttlMs Time-to-live in milliseconds
+     * @returns Promise that resolves when the operation completes
      */
     async set(key, value, ttlMs) {
         await this.kv.set(key, value, (ttlMs / 1000));

package/esm/pathways/logger.d.ts

@@ -23,26 +23,69 @@ export interface Logger {
     /**
      * Log error messages
      * @param message The message to log
+     * @param error Optional error object
      * @param context Optional context data to include
      */
-    error(message: string, context?: Record<string, unknown>): void;
+    error(message: string, error?: Error, context?: Record<string, unknown>): void;
 }
 /**
  * A default console logger that logs to the console
  */
 export declare class ConsoleLogger implements Logger {
+    /**
+     * Log debug information to the console
+     * @param message The message to log
+     * @param context Optional context data to include
+     */
     debug(message: string, context?: Record<string, unknown>): void;
+    /**
+     * Log informational messages to the console
+     * @param message The message to log
+     * @param context Optional context data to include
+     */
     info(message: string, context?: Record<string, unknown>): void;
+    /**
+     * Log warning messages to the console
+     * @param message The message to log
+     * @param context Optional context data to include
+     */
     warn(message: string, context?: Record<string, unknown>): void;
-    error(message: string, context?: Record<string, unknown>): void;
+    /**
+     * Log error messages to the console
+     * @param message The message to log
+     * @param error Optional error object
+     * @param context Optional context data to include
+     */
+    error(message: string, error?: Error, context?: Record<string, unknown>): void;
 }
 /**
  * A no-operation logger that does nothing
  */
 export declare class NoopLogger implements Logger {
+    /**
+     * No-op debug log
+     * @param _message The message to log (ignored)
+     * @param _context Optional context data (ignored)
+     */
     debug(_message: string, _context?: Record<string, unknown>): void;
+    /**
+     * No-op info log
+     * @param _message The message to log (ignored)
+     * @param _context Optional context data (ignored)
+     */
     info(_message: string, _context?: Record<string, unknown>): void;
+    /**
+     * No-op warning log
+     * @param _message The message to log (ignored)
+     * @param _context Optional context data (ignored)
+     */
     warn(_message: string, _context?: Record<string, unknown>): void;
-    error(_message: string, _context?: Record<string, unknown>): void;
+    /**
+     * No-op error log
+     * @param _message The message to log (ignored)
+     * @param _error Optional error object (ignored)
+     * @param _context Optional context data (ignored)
+     */
+    error(_message: string, _error?: Error, _context?: Record<string, unknown>): void;
 }
 //# sourceMappingURL=logger.d.ts.map

package/esm/pathways/logger.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/pathways/logger.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;;;OAIG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAE/D;;;;OAIG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAE9D;;;;OAIG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAE9D;;;;OAIG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAChE;AAED;;GAEG;AACH,qBAAa,aAAc,YAAW,MAAM;IAC1C,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAI/D,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAI9D,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAI9D,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;CAGhE;AAED;;GAEG;AACH,qBAAa,UAAW,YAAW,MAAM;IACvC,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IACjE,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAChE,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAChE,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;CAClE"}
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/pathways/logger.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;;;OAIG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAE/D;;;;OAIG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAE9D;;;;OAIG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAE9D;;;;;OAKG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC/E;AAED;;GAEG;AACH,qBAAa,aAAc,YAAW,MAAM;IAC1C;;;;OAIG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAI/D;;;;OAIG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAI9D;;;;OAIG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAI9D;;;;;OAKG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;CAG/E;AAED;;GAEG;AACH,qBAAa,UAAW,YAAW,MAAM;IACvC;;;;OAIG;IACH,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAEjE;;;;OAIG;IACH,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAEhE;;;;OAIG;IACH,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAEhE;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;CAClF"}

package/esm/pathways/logger.js

@@ -2,25 +2,67 @@
  * A default console logger that logs to the console
  */
 export class ConsoleLogger {
+    /**
+     * Log debug information to the console
+     * @param message The message to log
+     * @param context Optional context data to include
+     */
     debug(message, context) {
         console.debug(message, context ? JSON.stringify(context) : '');
     }
+    /**
+     * Log informational messages to the console
+     * @param message The message to log
+     * @param context Optional context data to include
+     */
     info(message, context) {
         console.info(message, context ? JSON.stringify(context) : '');
     }
+    /**
+     * Log warning messages to the console
+     * @param message The message to log
+     * @param context Optional context data to include
+     */
     warn(message, context) {
         console.warn(message, context ? JSON.stringify(context) : '');
     }
-    error(message, context) {
-        console.error(message, context ? JSON.stringify(context) : '');
+    /**
+     * Log error messages to the console
+     * @param message The message to log
+     * @param error Optional error object
+     * @param context Optional context data to include
+     */
+    error(message, error, context) {
+        console.error(message, error, context ? JSON.stringify(context) : '');
     }
 }
 /**
  * A no-operation logger that does nothing
  */
 export class NoopLogger {
+    /**
+     * No-op debug log
+     * @param _message The message to log (ignored)
+     * @param _context Optional context data (ignored)
+     */
     debug(_message, _context) { }
+    /**
+     * No-op info log
+     * @param _message The message to log (ignored)
+     * @param _context Optional context data (ignored)
+     */
     info(_message, _context) { }
+    /**
+     * No-op warning log
+     * @param _message The message to log (ignored)
+     * @param _context Optional context data (ignored)
+     */
     warn(_message, _context) { }
-    error(_message, _context) { }
+    /**
+     * No-op error log
+     * @param _message The message to log (ignored)
+     * @param _error Optional error object (ignored)
+     * @param _context Optional context data (ignored)
+     */
+    error(_message, _error, _context) { }
 }

package/esm/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/esm/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/esm/pathways/postgres/index.js

@@ -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/esm/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/esm/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/esm/pathways/postgres/postgres-adapter.js

@@ -1,13 +1,11 @@
 /**
  * Implementation of PostgresAdapter using the postgres.js library
- *
- * @implements {PostgresAdapter}
  */
 export 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 */
@@ -47,8 +45,8 @@ export 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 {
@@ -63,8 +61,7 @@ export 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) {
@@ -74,11 +71,10 @@ export 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) {
@@ -88,10 +84,9 @@ export 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) {
@@ -103,8 +98,8 @@ export class 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
  */
 export async function createPostgresAdapter(config) {
     const adapter = new PostgresJsAdapter(config);

package/esm/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/esm/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/esm/pathways/postgres/postgres-pathway-state.js

@@ -4,8 +4,6 @@ import { createPostgresAdapter } from "./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}
  */
 export class PostgresPathwayState {
     /**
@@ -179,8 +177,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
  */
 export function createPostgresPathwayState(config) {
     const state = new PostgresPathwayState(config);

package/esm/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 {};