@flowcore/sdk 1.10.2 → 1.11.1

package/script/common/notification-client.d.ts

@@ -0,0 +1,80 @@
+import type { Subject } from "rxjs";
+import { type Logger } from "../utils/logger.js";
+/**
+ * Represents an event notification from the Flowcore system
+ */
+export type NotificationEvent = {
+    pattern: string;
+    data: {
+        tenant: string;
+        eventId: string;
+        dataCoreId: string;
+        flowType: string;
+        eventType: string;
+        validTime: string;
+    };
+};
+/**
+ * Interface for OIDC authentication client
+ */
+export type OidcClient = {
+    getToken: () => Promise<{
+        accessToken: string;
+    }>;
+};
+/**
+ * Configuration options for the NotificationClient
+ */
+export type NotificationClientOptions = {
+    reconnectInterval: number;
+    maxReconnects?: number;
+    maxEvents?: number;
+    logger?: Logger;
+};
+/**
+ * Client for handling WebSocket connections to the Flowcore notification system.
+ * Manages connection lifecycle, authentication, and event handling.
+ */
+export declare class NotificationClient {
+    private readonly observer;
+    private readonly oidcClient;
+    private readonly subscriptionSpec;
+    private url;
+    private webSocket;
+    private options;
+    private logger;
+    private eventCount;
+    private reconnectInterval;
+    private reconnectAttempts;
+    /**
+     * Creates a new NotificationClient instance
+     * @param observer - RxJS Subject for emitting notification events
+     * @param oidcClient - Client for handling OIDC authentication
+     * @param subscriptionSpec - Specification for what notifications to subscribe to
+     * @param options - Configuration options for the client
+     */
+    constructor(observer: Subject<NotificationEvent>, oidcClient: OidcClient, subscriptionSpec: {
+        tenant: string;
+        dataCore: string;
+        flowType?: string;
+        eventType?: string;
+    }, options?: Partial<NotificationClientOptions>);
+    /**
+     * Establishes WebSocket connection and sets up event handlers
+     */
+    connect(): Promise<void>;
+    /**
+     * Attempts to reconnect to the WebSocket server using exponential backoff
+     */
+    private attemptReconnect;
+    /**
+     * Closes the WebSocket connection
+     */
+    disconnect(): void;
+    /**
+     * Overrides the base WebSocket URL for testing or different environments
+     * @param url - The new base URL to use
+     */
+    overrideBaseUrl(url: string): void;
+}
+//# sourceMappingURL=notification-client.d.ts.map

package/script/common/notification-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"notification-client.d.ts","sourceRoot":"","sources":["../../src/common/notification-client.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AASnC,OAAO,EAAiB,KAAK,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAU/D;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE;QACJ,MAAM,EAAE,MAAM,CAAA;QACd,OAAO,EAAE,MAAM,CAAA;QACf,UAAU,EAAE,MAAM,CAAA;QAClB,QAAQ,EAAE,MAAM,CAAA;QAChB,SAAS,EAAE,MAAM,CAAA;QACjB,SAAS,EAAE,MAAM,CAAA;KAClB,CAAA;CACF,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,QAAQ,EAAE,MAAM,OAAO,CAAC;QACtB,WAAW,EAAE,MAAM,CAAA;KACpB,CAAC,CAAA;CACH,CAAA;AAcD;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,iBAAiB,EAAE,MAAM,CAAA;IACzB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAKD;;;GAGG;AACH,qBAAa,kBAAkB;IAiB3B,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,gBAAgB;IAlBnC,OAAO,CAAC,GAAG,CAA+C;IAC1D,OAAO,CAAC,SAAS,CAAoB;IACrC,OAAO,CAAC,OAAO,CAA2B;IAC1C,OAAO,CAAC,MAAM,CAAQ;IACtB,OAAO,CAAC,UAAU,CAAI;IACtB,OAAO,CAAC,iBAAiB,CAAQ;IACjC,OAAO,CAAC,iBAAiB,CAAI;IAE7B;;;;;;OAMG;gBAEgB,QAAQ,EAAE,OAAO,CAAC,iBAAiB,CAAC,EACpC,UAAU,EAAE,UAAU,EACtB,gBAAgB,EAAE;QACjC,MAAM,EAAE,MAAM,CAAA;QACd,QAAQ,EAAE,MAAM,CAAA;QAChB,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,SAAS,CAAC,EAAE,MAAM,CAAA;KACnB,EACD,OAAO,CAAC,EAAE,OAAO,CAAC,yBAAyB,CAAC;IAU9C;;OAEG;IACG,OAAO;IAyHb;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAqBxB;;OAEG;IACH,UAAU;IAMV;;;OAGG;IACI,eAAe,CAAC,GAAG,EAAE,MAAM;CAGnC"}

package/script/common/notification-client.js

@@ -0,0 +1,239 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotificationClient = void 0;
+const dntShim = __importStar(require("../_dnt.shims.js"));
+const mod_js_1 = require("../mod.js");
+const logger_js_1 = require("../utils/logger.js");
+const flowcore_client_js_1 = require("./flowcore-client.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.
+ */
+class NotificationClient {
+    /**
+     * Creates a new NotificationClient instance
+     * @param observer - RxJS Subject for emitting notification events
+     * @param oidcClient - Client for handling OIDC authentication
+     * @param subscriptionSpec - Specification for what notifications to subscribe to
+     * @param options - Configuration options for the client
+     */
+    constructor(observer, oidcClient, subscriptionSpec, options) {
+        Object.defineProperty(this, "observer", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: observer
+        });
+        Object.defineProperty(this, "oidcClient", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: oidcClient
+        });
+        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
+        });
+        this.options = {
+            reconnectInterval: 1000,
+            ...options,
+        };
+        this.logger = options?.logger ?? logger_js_1.defaultLogger;
+        this.reconnectInterval = options?.reconnectInterval ?? 1000;
+    }
+    /**
+     * Establishes WebSocket connection and sets up event handlers
+     */
+    async connect() {
+        const token = await this.oidcClient.getToken();
+        const flowcoreClient = new flowcore_client_js_1.FlowcoreClient({
+            getBearerToken: () => Promise.resolve(token.accessToken),
+        });
+        const tenant = await flowcoreClient.execute(new mod_js_1.TenantFetchCommand({
+            tenant: this.subscriptionSpec.tenant,
+        }));
+        const dataCore = await flowcoreClient.execute(new mod_js_1.DataCoreFetchCommand({
+            tenantId: tenant.id,
+            dataCore: this.subscriptionSpec.dataCore,
+        }));
+        let flowType;
+        let eventType;
+        if (this.subscriptionSpec.flowType) {
+            flowType = await flowcoreClient.execute(new mod_js_1.FlowTypeFetchCommand({
+                dataCoreId: dataCore.id,
+                flowType: this.subscriptionSpec.flowType,
+            }));
+            if (this.subscriptionSpec.eventType) {
+                eventType = await flowcoreClient.execute(new mod_js_1.EventTypeFetchCommand({
+                    flowTypeId: flowType?.id,
+                    eventType: this.subscriptionSpec.eventType,
+                }));
+            }
+        }
+        this.webSocket = new dntShim.WebSocket(`${this.url}?token=${encodeURIComponent(token.accessToken)}`);
+        this.webSocket.onopen = () => {
+            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.logger.info(`Connection closed: Code [${event.code}], Reason: ${event.reason}`);
+            if (event.code !== 1000) {
+                this.attemptReconnect();
+                return;
+            }
+            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.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();
+        }
+    }
+    /**
+     * Overrides the base WebSocket URL for testing or different environments
+     * @param url - The new base URL to use
+     */
+    overrideBaseUrl(url) {
+        this.url = url;
+    }
+}
+exports.NotificationClient = NotificationClient;

package/script/mod.d.ts

@@ -1,6 +1,7 @@
 export * from "./commands/index.js";
 export * from "./common/command.js";
 export * from "./common/flowcore-client.js";
+export * from "./common/notification-client.js";
 export * from "./contracts/index.js";
 export * from "./exceptions/index.js";
 export * from "./utils/parse-response-helper.js";

package/script/mod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAA;AACnC,cAAc,qBAAqB,CAAA;AACnC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,sBAAsB,CAAA;AACpC,cAAc,uBAAuB,CAAA;AACrC,cAAc,kCAAkC,CAAA"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAA;AACnC,cAAc,qBAAqB,CAAA;AACnC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,iCAAiC,CAAA;AAC/C,cAAc,sBAAsB,CAAA;AACpC,cAAc,uBAAuB,CAAA;AACrC,cAAc,kCAAkC,CAAA"}

package/script/mod.js

@@ -17,6 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./commands/index.js"), exports);
 __exportStar(require("./common/command.js"), exports);
 __exportStar(require("./common/flowcore-client.js"), exports);
+__exportStar(require("./common/notification-client.js"), exports);
 __exportStar(require("./contracts/index.js"), exports);
 __exportStar(require("./exceptions/index.js"), exports);
 __exportStar(require("./utils/parse-response-helper.js"), exports);

package/script/utils/logger.d.ts

@@ -0,0 +1,8 @@
+export type Logger = {
+    debug: (message: string, meta?: Record<string, unknown>) => void;
+    info: (message: string, meta?: Record<string, unknown>) => void;
+    warn: (message: string, meta?: Record<string, unknown>) => void;
+    error: (message: string | Error, meta?: Record<string, unknown>) => void;
+};
+export declare const defaultLogger: Logger;
+//# sourceMappingURL=logger.d.ts.map

package/script/utils/logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/utils/logger.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,MAAM,GAAG;IACnB,KAAK,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI,CAAA;IAChE,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI,CAAA;IAC/D,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI,CAAA;IAC/D,KAAK,EAAE,CAAC,OAAO,EAAE,MAAM,GAAG,KAAK,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI,CAAA;CACzE,CAAA;AAED,eAAO,MAAM,aAAa,EAAE,MAa3B,CAAA"}

package/script/utils/logger.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultLogger = void 0;
+exports.defaultLogger = {
+    debug: (message, meta) => {
+        console.debug(message, meta);
+    },
+    info: (message, meta) => {
+        console.info(message, meta);
+    },
+    warn: (message, meta) => {
+        console.warn(message, meta);
+    },
+    error: (message, meta) => {
+        console.error(message, meta);
+    },
+};