@flowcore/pathways 0.16.4 → 0.17.0

package/esm/deps/jsr.io/@flowcore/sdk/1.71.0/src/common/notification-client.js

@@ -0,0 +1,259 @@
+import * as dntShim from "../../../../../../../_dnt.shims.js";
+import { defaultLogger } from "../utils/logger.js";
+import { FlowcoreClient } from "./flowcore-client.js";
+import { Buffer } from "node:buffer";
+import { DataCoreFetchCommand } from "../commands/data-core/data-core.fetch.js";
+import { FlowTypeFetchCommand } from "../commands/flow-type/flow-type.fetch.js";
+import { EventTypeFetchCommand } from "../commands/event-type/event-type.fetch.js";
+// Maximum reconnection interval in milliseconds
+const MAX_RECONNECT_INTERVAL = 30_000;
+/**
+ * Client for handling WebSocket connections to the Flowcore notification system.
+ * Manages connection lifecycle, authentication, and event handling.
+ */
+export class NotificationClient {
+    /**
+     * Creates a new NotificationClient instance
+     * @param observer - RxJS Subject for emitting notification events
+     * @param authOptions - Auth options for the client
+     * @param subscriptionSpec - Specification for what notifications to subscribe to
+     * @param options - Configuration options for the client
+     */
+    constructor(observer, authOptions, subscriptionSpec, options) {
+        Object.defineProperty(this, "observer", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: observer
+        });
+        Object.defineProperty(this, "authOptions", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: authOptions
+        });
+        Object.defineProperty(this, "subscriptionSpec", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: subscriptionSpec
+        });
+        Object.defineProperty(this, "url", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: "wss://tenant.api.flowcore.io/notifications"
+        });
+        Object.defineProperty(this, "webSocket", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "options", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "logger", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "eventCount", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 0
+        });
+        Object.defineProperty(this, "reconnectInterval", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "reconnectAttempts", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 0
+        });
+        Object.defineProperty(this, "_isOpen", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
+        });
+        Object.defineProperty(this, "_isConnecting", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
+        });
+        this.options = {
+            reconnectInterval: 1000,
+            ...options,
+        };
+        this.logger = options?.logger ?? defaultLogger;
+        this.reconnectInterval = options?.reconnectInterval ?? 1000;
+    }
+    /**
+     * Is the websocket connection open
+     */
+    get isOpen() {
+        return this._isOpen;
+    }
+    /**
+     * Is the websocket connection currently connecting
+     */
+    get isConnecting() {
+        return this._isConnecting;
+    }
+    /**
+     * Establishes WebSocket connection and sets up event handlers
+     */
+    async connect() {
+        if (this._isConnecting || this._isOpen) {
+            this.logger.debug("Is already connecting or open");
+            return;
+        }
+        this._isConnecting = true;
+        let flowcoreClient = null;
+        const urlParams = new URLSearchParams();
+        if ("oidcClient" in this.authOptions) {
+            const oidcClient = this.authOptions.oidcClient;
+            flowcoreClient = new FlowcoreClient({
+                getBearerToken: async () => (await oidcClient.getToken()).accessToken,
+            });
+            urlParams.set("token", (await oidcClient.getToken()).accessToken);
+        }
+        else {
+            flowcoreClient = new FlowcoreClient({
+                apiKey: this.authOptions.apiKey,
+                apiKeyId: this.authOptions.apiKeyId,
+            });
+            urlParams.set("api_key", this.authOptions.apiKey);
+            urlParams.set("api_key_id", this.authOptions.apiKeyId);
+        }
+        const dataCore = await flowcoreClient.execute(new DataCoreFetchCommand({
+            tenant: this.subscriptionSpec.tenant,
+            dataCore: this.subscriptionSpec.dataCore,
+        }));
+        let flowType;
+        let eventType;
+        if (this.subscriptionSpec.flowType) {
+            flowType = await flowcoreClient.execute(new FlowTypeFetchCommand({
+                dataCoreId: dataCore.id,
+                flowType: this.subscriptionSpec.flowType,
+            }));
+            if (this.subscriptionSpec.eventType) {
+                eventType = await flowcoreClient.execute(new EventTypeFetchCommand({
+                    flowTypeId: flowType?.id,
+                    eventType: this.subscriptionSpec.eventType,
+                }));
+            }
+        }
+        this.webSocket = new dntShim.WebSocket(`${this.url}?${urlParams.toString()}`);
+        this.webSocket.onopen = () => {
+            this._isOpen = true;
+            this._isConnecting = false;
+            this.logger.info("WebSocket connection opened.");
+            this.reconnectInterval = this.options.reconnectInterval;
+            this.reconnectAttempts = 0;
+            this.webSocket.send(JSON.stringify({
+                tenant: this.subscriptionSpec.tenant,
+                dataCoreId: dataCore.id,
+                flowTypeId: flowType?.id,
+                eventTypeId: eventType?.id,
+            }));
+        };
+        this.webSocket.onmessage = (event) => {
+            let parsedData;
+            if (event.data instanceof ArrayBuffer) {
+                parsedData = new TextDecoder().decode(event.data);
+            }
+            else if (Buffer.isBuffer(event.data)) {
+                parsedData = event.data.toString();
+            }
+            else if (Array.isArray(event.data)) {
+                // Handle Buffer arrays by concatenating them
+                parsedData = Buffer.concat(event.data).toString();
+            }
+            else {
+                parsedData = event.data;
+            }
+            const data = JSON.parse(parsedData);
+            if (data.type === "validation") {
+                this.logger.error(`Bad request: ${data.summary} - ${data.message} - ${data.found} - ${data.errors}`);
+                return;
+            }
+            const parsed = JSON.parse(data.message);
+            this.logger.debug(`Received event: ${parsed.pattern}`);
+            this.observer.next({
+                pattern: parsed.pattern,
+                data: {
+                    tenant: parsed.data.tenantId,
+                    eventId: parsed.data.eventId,
+                    dataCoreId: parsed.data.dataCore,
+                    flowType: parsed.data.aggregator,
+                    eventType: parsed.data.eventType,
+                    validTime: parsed.data.validTime,
+                },
+            });
+            this.eventCount++;
+            if (this.options.maxEvents && this.options.maxEvents <= this.eventCount) {
+                this.observer.complete();
+                this.eventCount = 0;
+                this.webSocket.close(1000, "Max events received");
+            }
+        };
+        this.webSocket.onclose = (event) => {
+            this._isOpen = false;
+            this.logger.info(`Connection closed: Code [${event.code}], Reason: ${event.reason}`);
+            if (![1000].includes(event.code)) {
+                this.attemptReconnect();
+                return;
+            }
+            this._isConnecting = false;
+            this.observer.complete();
+        };
+        this.webSocket.onerror = (error) => {
+            this.logger.error(`WebSocket encountered error: ${error}`);
+            this.observer.error(error);
+            this.webSocket.close();
+        };
+    }
+    /**
+     * Attempts to reconnect to the WebSocket server using exponential backoff
+     */
+    attemptReconnect() {
+        if (this.options.maxReconnects && this.reconnectAttempts >= this.options.maxReconnects) {
+            this.logger.error(`Max reconnect attempts ${this.reconnectAttempts}/${this.options.maxReconnects} reached. Giving up.`);
+            return;
+        }
+        this.reconnectAttempts++;
+        this._isConnecting = true;
+        this.logger.info(`Attempting reconnection ${this.reconnectAttempts}${this.options.maxReconnects ? `/${this.options.maxReconnects}` : ""} in ${this.reconnectInterval} ms...`);
+        setTimeout(() => {
+            this.connect();
+        }, this.reconnectInterval);
+        this.reconnectInterval = Math.min(MAX_RECONNECT_INTERVAL, this.reconnectInterval * 2);
+    }
+    /**
+     * Closes the WebSocket connection
+     */
+    disconnect() {
+        if (this.webSocket) {
+            this.webSocket.close(1000, "Disconnected by user");
+        }
+    }
+    /**
+     * Overrides the base WebSocket URL for testing or different environments
+     * @param url - The new base URL to use
+     */
+    overrideBaseUrl(url) {
+        this.url = url;
+    }
+}

package/esm/deps/jsr.io/@flowcore/sdk/1.71.0/src/common/tenant.cache.d.ts

@@ -0,0 +1,11 @@
+import { LocalCache } from "../utils/local-cache.js";
+type DedicatedTenant = {
+    isDedicated: boolean;
+    instance: {
+        status: string;
+        domain: string;
+    } | null;
+};
+export declare const tenantCache: LocalCache<DedicatedTenant>;
+export {};
+//# sourceMappingURL=tenant.cache.d.ts.map

package/esm/deps/jsr.io/@flowcore/sdk/1.71.0/src/common/tenant.cache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tenant.cache.d.ts","sourceRoot":"","sources":["../../../../../../../../src/deps/jsr.io/@flowcore/sdk/1.71.0/src/common/tenant.cache.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AAEpD,KAAK,eAAe,GAAG;IACrB,WAAW,EAAE,OAAO,CAAA;IACpB,QAAQ,EAAE;QACR,MAAM,EAAE,MAAM,CAAA;QACd,MAAM,EAAE,MAAM,CAAA;KACf,GAAG,IAAI,CAAA;CACT,CAAA;AAED,eAAO,MAAM,WAAW,6BAA6C,CAAA"}

package/esm/deps/jsr.io/@flowcore/sdk/1.71.0/src/common/tenant.cache.js

@@ -0,0 +1,2 @@
+import { LocalCache } from "../utils/local-cache.js";
+export const tenantCache = new LocalCache(60 * 1000);

package/esm/deps/jsr.io/@flowcore/sdk/1.71.0/src/common/websocket-client.d.ts

@@ -0,0 +1,109 @@
+import { Buffer } from "node:buffer";
+import { type Logger } from "../utils/logger.js";
+import type { ClientOptions } from "./flowcore-client.js";
+import type { ActiveStreamInterface, WebSocketCommand } from "./websocket-command.js";
+/**
+ * Interface for OIDC authentication client (reused from NotificationClient context)
+ */
+export type OidcClient = {
+    getToken: () => Promise<{
+        accessToken: string;
+    }>;
+};
+/**
+ * Configuration options for the WebSocketClient
+ */
+export type WebSocketClientOptions = {
+    /** Interval between reconnect attempts (ms). Defaults to 1000. */
+    reconnectInterval?: number;
+    /** Maximum number of reconnect attempts. Defaults to undefined (infinite). */
+    maxReconnects?: number;
+    /** Optional logger instance. */
+    logger?: Logger;
+};
+interface MinimalWebSocket {
+    readyState: number;
+    onopen: (() => void) | null;
+    onmessage: ((event: {
+        data: string | ArrayBuffer | Buffer;
+    }) => void) | null;
+    onclose: ((event: {
+        code: number;
+        reason: string;
+        wasClean: boolean;
+    }) => void) | null;
+    onerror: ((event: Event) => void) | null;
+    send(data: string): void;
+    close(code?: number, reason?: string): void;
+}
+type WebSocketFactory = (url: string) => MinimalWebSocket;
+/**
+ * Generic client for managing a single, persistent WebSocket connection based on a command.
+ * Handles connection lifecycle, authentication, reconnection, and message sending/receiving.
+ */
+export declare class WebSocketClient {
+    private readonly authOptions;
+    private overrideBaseUrl;
+    private webSocket;
+    private options;
+    private logger;
+    private reconnectInterval;
+    private reconnectAttempts;
+    private _isOpen;
+    private _isConnecting;
+    private webSocketFactory;
+    private internalSubject;
+    private currentCommand;
+    private currentConfig;
+    /**
+     * Creates a new WebSocketClient instance.
+     * @param authOptions - Authentication options (Bearer token via OIDC client or API Key).
+     * @param options - Configuration options for the client.
+     * @param webSocketFactory - Optional WebSocket factory for testing.
+     */
+    constructor(authOptions: ClientOptions, options?: WebSocketClientOptions, webSocketFactory?: WebSocketFactory);
+    /**
+     * Override the base URL provided by commands.
+     * @param baseUrl - The new base URL to use (e.g., "wss://staging-server.api.flowcore.io").
+     */
+    setBaseUrl(baseUrl: string): void;
+    /**
+     * Returns true if the WebSocket connection is currently open.
+     */
+    get isOpen(): boolean;
+    /**
+     * Returns true if the client is currently attempting to establish a WebSocket connection.
+     */
+    get isConnecting(): boolean;
+    /**
+     * Establishes WebSocket connection based on the provided command.
+     * Disconnects any existing connection before starting the new one.
+     * @param command - The command defining the stream connection details.
+     * @returns An interface to interact with the active stream.
+     */
+    connect<Config, SendPayload>(command: WebSocketCommand<Config, SendPayload>): Promise<ActiveStreamInterface<SendPayload>>;
+    /**
+     * Sets up the WebSocket event handlers (onopen, onmessage, onclose, onerror).
+     */
+    private setupEventHandlers;
+    /**
+     * Attempts to reconnect to the WebSocket server using exponential backoff.
+     * Requires `currentConfig` to be set.
+     */
+    private attemptReconnect;
+    /**
+     * Sends a message to the currently connected WebSocket.
+     * @param message - The message object to send (e.g., { content: "user input" }).
+     */
+    private sendMessage;
+    /**
+     * Closes the WebSocket connection gracefully.
+     */
+    disconnect(): void;
+    /**
+     * Implements the Disposable interface for clean resource management.
+     */
+    [Symbol.dispose](): void;
+}
+export {};
+//# sourceMappingURL=websocket-client.d.ts.map

package/esm/deps/jsr.io/@flowcore/sdk/1.71.0/src/common/websocket-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket-client.d.ts","sourceRoot":"","sources":["../../../../../../../../src/deps/jsr.io/@flowcore/sdk/1.71.0/src/common/websocket-client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAGpC,OAAO,EAAiB,KAAK,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAC/D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,KAAK,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AAIrF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,QAAQ,EAAE,MAAM,OAAO,CAAC;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;CACjD,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,kEAAkE;IAClE,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,8EAA8E;IAC9E,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,gCAAgC;IAChC,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAMD,UAAU,gBAAgB;IACxB,UAAU,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,IAAI,CAAA;IAC3B,SAAS,EAAE,CAAC,CAAC,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,GAAG,WAAW,GAAG,MAAM,CAAA;KAAE,KAAK,IAAI,CAAC,GAAG,IAAI,CAAA;IAC5E,OAAO,EAAE,CAAC,CAAC,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,OAAO,CAAA;KAAE,KAAK,IAAI,CAAC,GAAG,IAAI,CAAA;IACtF,OAAO,EAAE,CAAC,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC,GAAG,IAAI,CAAA;IACxC,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC5C;AAGD,KAAK,gBAAgB,GAAG,CAAC,GAAG,EAAE,MAAM,KAAK,gBAAgB,CAAA;AAEzD;;;GAGG;AACH,qBAAa,eAAe;IAyBxB,OAAO,CAAC,QAAQ,CAAC,WAAW;IAxB9B,OAAO,CAAC,eAAe,CAAoB;IAC3C,OAAO,CAAC,SAAS,CAAmB;IACpC,OAAO,CAAC,OAAO,CAE6C;IAC5D,OAAO,CAAC,MAAM,CAAQ;IACtB,OAAO,CAAC,iBAAiB,CAAQ;IACjC,OAAO,CAAC,iBAAiB,CAAI;IAC7B,OAAO,CAAC,OAAO,CAAiB;IAChC,OAAO,CAAC,aAAa,CAAiB;IACtC,OAAO,CAAC,gBAAgB,CAAkB;IAE1C,OAAO,CAAC,eAAe,CAAmD;IAE1E,OAAO,CAAC,cAAc,CAAkD;IACxE,OAAO,CAAC,aAAa,CAAuB;IAE5C;;;;;OAKG;gBAEgB,WAAW,EAAE,aAAa,EAC3C,OAAO,CAAC,EAAE,sBAAsB,EAChC,gBAAgB,CAAC,EAAE,gBAAgB;IAarC;;;OAGG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAKjC;;OAEG;IACH,IAAW,MAAM,IAAI,OAAO,CAE3B;IAED;;OAEG;IACH,IAAW,YAAY,IAAI,OAAO,CAEjC;IAED;;;;;OAKG;IAEG,OAAO,CAAC,MAAM,EAAE,WAAW,EAC/B,OAAO,EAAE,gBAAgB,CAAC,MAAM,EAAE,WAAW,CAAC,GAC7C,OAAO,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC;IAyD9C;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAwF1B;;;OAGG;IACH,OAAO,CAAC,gBAAgB;IAiFxB;;;OAGG;IACH,OAAO,CAAC,WAAW;IAmBnB;;OAEG;IACH,UAAU;IAyBV;;OAEG;IACH,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,IAAI;CAGzB"}