@openfin/cloud-interop-core-api 0.0.1-alpha.fba3468 → 0.0.1-alpha.fe79c9b

package/package.json

@@ -1,231 +1,18 @@
 {
-    "name": "@openfin/cloud-interop-core-api",
-    "version": "0.0.1-alpha.fba3468",
-    "type": "module",
-    "description": "",
-    "files": [
-        "./dist/*"
-    ],
-    "main": "./dist/index.cjs",
-    "browser": "./dist/index.mjs",
-    "types": "./dist/index.d.ts",
-    "scripts": {
-        "build": "rollup -c",
-        "build:watch": "rollup -c --watch",
-        "typecheck": "tsc --noEmit",
-        "test": "jest --coverage",
-        "lint": "eslint . --max-warnings 0",
-        "lint:fix": "eslint . --fix --max-warnings 0"
-    },
-    "author": "",
-    "license": "SEE LICENSE IN LICENSE.md",
-    "devDependencies": {
-        "@rollup/plugin-commonjs": "^28.0.1",
-        "@rollup/plugin-inject": "^5.0.5",
-        "@rollup/plugin-node-resolve": "^15.2.3",
-        "@rollup/plugin-typescript": "^11.1.6",
-        "@types/jest": "^29.5.14",
-        "@types/node": "^20.10.0",
-        "@typescript-eslint/eslint-plugin": "^7.5.0",
-        "@typescript-eslint/parser": "^7.15.0",
-        "eslint": "^8.57.0",
-        "eslint-config-prettier": "^9.1.0",
-        "eslint-plugin-check-file": "^2.8.0",
-        "eslint-plugin-prettier": "^5.2.1",
-        "eslint-plugin-simple-import-sort": "^12.1.1",
-        "eslint-plugin-unicorn": "^55.0.0",
-        "eslint-plugin-unused-imports": "^4.1.4",
-        "jest": "^29.7.0",
-        "prettier": "^3.3.3",
-        "rollup": "^4.9.6",
-        "ts-jest": "^29.2.5",
-        "typescript": "^5.6.3"
-    },
-    "dependencies": {
-        "axios": "^1.6.2",
-        "mqtt": "^5.3.1"
-    },
-    "eslintConfig": {
-        "env": {
-            "browser": true,
-            "node": true
-        },
-        "parser": "@typescript-eslint/parser",
-        "parserOptions": {
-            "ecmaVersion": "latest",
-            "project": true,
-            "sourceType": "module"
-        },
-        "extends": [
-            "eslint:recommended",
-            "plugin:@typescript-eslint/recommended",
-            "plugin:@typescript-eslint/strict",
-            "plugin:unicorn/recommended",
-            "plugin:prettier/recommended"
-        ],
-        "plugins": [
-            "prettier",
-            "check-file",
-            "simple-import-sort",
-            "unused-imports"
-        ],
-        "rules": {
-            "unused-imports/no-unused-imports": "warn",
-            "unicorn/prevent-abbreviations": [
-                "error",
-                {
-                    "replacements": {
-                        "props": false,
-                        "prop": false,
-                        "ref": false,
-                        "args": false,
-                        "arg": false,
-                        "src": false,
-                        "dev": false,
-                        "str": false,
-                        "req": false,
-                        "res": false
-                    }
-                }
-            ],
-            "@typescript-eslint/no-non-null-assertion": "error",
-            "unicorn/no-nested-ternary": "off",
-            "unicorn/no-array-for-each": "off",
-            "unicorn/no-useless-undefined": "off",
-            "unicorn/no-null": "off",
-            "eqeqeq": [
-                "error",
-                "always"
-            ],
-            "no-alert": "error",
-            "no-eval": "error",
-            "prettier/prettier": "warn",
-            "simple-import-sort/imports": [
-                "error",
-                {
-                    "groups": [
-                        [
-                            "^react$"
-                        ],
-                        [
-                            "^react"
-                        ],
-                        [
-                            "^next"
-                        ],
-                        [
-                            "^zod"
-                        ],
-                        [
-                            "^@radix-ui/"
-                        ],
-                        [
-                            "^[^.]"
-                        ],
-                        [
-                            "@/components/ui/.*"
-                        ],
-                        [
-                            "@/components/.*"
-                        ],
-                        [
-                            "@/config/.*"
-                        ],
-                        [
-                            "@/lib/.*"
-                        ],
-                        [
-                            "^\\.\\.(?!/?$)",
-                            "^\\.\\./?$"
-                        ],
-                        [
-                            "^\\./(?=.*/)(?!/?$)",
-                            "^\\.(?!/?$)",
-                            "^\\./?$"
-                        ],
-                        [
-                            "^.+\\.s?css$"
-                        ]
-                    ]
-                }
-            ],
-            "check-file/no-index": "off",
-            "check-file/filename-naming-convention": [
-                "error",
-                {
-                    "**/*.{jsx,tsx}": "KEBAB_CASE",
-                    "**/*.{js,ts}": "KEBAB_CASE"
-                },
-                {
-                    "ignoreMiddleExtensions": true
-                }
-            ],
-            "check-file/filename-blocklist": [
-                "error",
-                {
-                    "**/*.spec.js": "*.test.js",
-                    "**/*.spec.jsx": "*.test.jsx",
-                    "**/*.spec.ts": "*.test.ts",
-                    "**/*.spec.tsx": "*.test.tsx"
-                }
-            ],
-            "no-restricted-syntax": [
-                "error",
-                {
-                    "selector": "TSEnumDeclaration",
-                    "message": "Prefer string unions to enums."
-                }
-            ],
-            "curly": [
-                "error",
-                "multi-line"
-            ],
-            "@typescript-eslint/consistent-type-definitions": [
-                "error",
-                "type"
-            ],
-            "@typescript-eslint/no-unused-vars": [
-                "warn",
-                {
-                    "argsIgnorePattern": "^_",
-                    "varsIgnorePattern": "^_"
-                }
-            ],
-            "@typescript-eslint/no-explicit-any": "warn"
-        },
-        "ignorePatterns": [
-            "node_modules",
-            "out",
-            "build",
-            "dist",
-            "coverage",
-            "tests",
-            "rollup.config.mjs",
-            "examples"
-        ]
-    },
-    "jest": {
-        "collectCoverage": true,
-        "collectCoverageFrom": [
-            "src/**/*.ts"
-        ],
-        "coverageReporters": [
-            "lcov",
-            "text-summary"
-        ],
-        "preset": "ts-jest",
-        "restoreMocks": true,
-        "setupFiles": [],
-        "testMatch": [
-            "**/tests/*.test.ts"
-        ],
-        "testTimeout": 100000
-    },
-    "prettier": {
-        "printWidth": 160,
-        "semi": true,
-        "singleQuote": true,
-        "tabWidth": 4,
-        "trailingComma": "all"
-    }
+  "name": "@openfin/cloud-interop-core-api",
+  "version": "0.0.1-alpha.fe79c9b",
+  "type": "module",
+  "description": "",
+  "main": "./index.cjs",
+  "browser": "./index.mjs",
+  "types": "./bundle.d.ts",
+  "author": "",
+  "license": "SEE LICENSE IN LICENSE.md",
+  "dependencies": {
+    "mqtt": "^5.13.0",
+    "zod": "^3.24.4"
+  },
+  "optionalDependencies": {
+    "@rollup/rollup-linux-x64-gnu": "*"
+  }
 }

package/dist/api.d.ts

@@ -1,63 +0,0 @@
-import mqtt from 'mqtt';
-import { CloudInteropSettings, ConnectParameters as ConnectParameters, ContextEvent } from './interfaces';
-type CreateSessionResponse = {
-    sessionId: string;
-    sessionRootTopic: string;
-    url: string;
-    token: string;
-    orgId: string;
-    sub: string;
-    platformId: string;
-    sourceId: string;
-};
-type EventMap = {
-    reconnected: () => void;
-    disconnected: () => void;
-    context: (event: ContextEvent) => void;
-    reconnecting: (attemptNo: number) => void;
-    error: (error: Error) => void;
-    'session-expired': () => void;
-};
-/**
- * Represents a single connection to a Cloud Interop service
- *
- * @export
- * @class CloudInteropAPI
- * @implements {Client}
- */
-export declare class CloudInteropAPI {
-    #private;
-    constructor(cloudInteropSettings: CloudInteropSettings);
-    get sessionDetails(): CreateSessionResponse | undefined;
-    get mqttClient(): mqtt.MqttClient | undefined;
-    /**
-     * Connects and creates a session on the Cloud Interop service
-     *
-     * @param {ConnectParameters} parameters - The parameters to use to connect
-     * @return {*}  {Promise<void>}
-     * @memberof CloudInteropAPI
-     * @throws {CloudInteropAPIError} - If an error occurs during connection
-     * @throws {AuthorizationError} - If the connection is unauthorized
-     */
-    connect(parameters: ConnectParameters): Promise<void>;
-    /**
-     * Disconnects from the Cloud Interop service
-     *
-     * @return {*}  {Promise<void>}
-     * @memberof CloudInteropAPI
-     * @throws {CloudInteropAPIError} - If an error occurs during disconnection
-     */
-    disconnect(): Promise<void>;
-    /**
-     * Publishes a new context for the given context group to the other connected sessions
-     *
-     * @param {string} contextGroup - The context group to publish to
-     * @param {object} context - The context to publish
-     * @return {*}  {Promise<void>}
-     * @memberof CloudInteropAPI
-     */
-    setContext(contextGroup: string, context: object): Promise<void>;
-    addEventListener<K extends keyof EventMap>(type: K, callback: EventMap[K]): void;
-    removeEventListener<K extends keyof EventMap>(type: K, callback: EventMap[K]): void;
-}
-export {};

package/dist/errors/api.error.d.ts

@@ -1,7 +0,0 @@
-export declare class CloudInteropAPIError extends Error {
-    code: string;
-    constructor(message?: string, code?: string, cause?: unknown);
-}
-export declare class AuthorizationError extends CloudInteropAPIError {
-    constructor(message?: string, code?: string);
-}

package/dist/index.cjs

@@ -1,296 +0,0 @@
-'use strict';
-
-var axios = require('axios');
-var mqtt = require('mqtt');
-
-class CloudInteropAPIError extends Error {
-    code;
-    constructor(message = 'An unexpected error has occurred', code = 'UNEXPECTED_ERROR', cause) {
-        super(message, { cause: cause });
-        this.name = this.constructor.name;
-        this.code = code;
-    }
-}
-class AuthorizationError extends CloudInteropAPIError {
-    constructor(message = 'Not authorized', code = 'ERR_UNAUTHORIZED') {
-        super(message, code, undefined);
-    }
-}
-
-// Error codes as defined in https://docs.emqx.com/en/cloud/latest/connect_to_deployments/mqtt_client_error_codes.html
-const BadUserNamePasswordError = 134;
-/**
- * Represents a single connection to a Cloud Interop service
- *
- * @export
- * @class CloudInteropAPI
- * @implements {Client}
- */
-class CloudInteropAPI {
-    #cloudInteropSettings;
-    #sessionDetails;
-    #mqttClient;
-    #reconnectRetryLimit = 30;
-    #keepAliveIntervalSeconds = 30;
-    #logger = (level, message) => {
-        console[level](message);
-    };
-    #reconnectRetries = 0;
-    #connectionParams;
-    #eventListeners = new Map();
-    #attemptingToReconnect = false;
-    constructor(cloudInteropSettings) {
-        this.#cloudInteropSettings = cloudInteropSettings;
-    }
-    get sessionDetails() {
-        return this.#sessionDetails;
-    }
-    get mqttClient() {
-        return this.#mqttClient;
-    }
-    /**
-     * Connects and creates a session on the Cloud Interop service
-     *
-     * @param {ConnectParameters} parameters - The parameters to use to connect
-     * @return {*}  {Promise<void>}
-     * @memberof CloudInteropAPI
-     * @throws {CloudInteropAPIError} - If an error occurs during connection
-     * @throws {AuthorizationError} - If the connection is unauthorized
-     */
-    async connect(parameters) {
-        this.#validateConnectParams(parameters);
-        this.#connectionParams = parameters;
-        this.#reconnectRetryLimit = parameters.reconnectRetryLimit || this.#reconnectRetryLimit;
-        this.#keepAliveIntervalSeconds = parameters.keepAliveIntervalSeconds || this.#keepAliveIntervalSeconds;
-        this.#logger = parameters.logger || this.#logger;
-        const { sourceId, platformId } = this.#connectionParams;
-        try {
-            const createSessionResponse = await axios.post(`${this.#cloudInteropSettings.url}/api/sessions`, {
-                sourceId,
-                platformId,
-            }, {
-                headers: this.#getRequestHeaders(),
-            });
-            if (createSessionResponse.status !== 201) {
-                throw new CloudInteropAPIError(`Failed to connect to the Cloud Interop service: ${this.#cloudInteropSettings.url}`, 'ERR_CONNECT', createSessionResponse.status);
-            }
-            this.#sessionDetails = createSessionResponse.data;
-            const sessionRootTopic = this.#sessionDetails.sessionRootTopic;
-            const clientOptions = {
-                keepalive: this.#keepAliveIntervalSeconds,
-                clientId: this.#sessionDetails.sessionId,
-                clean: true,
-                protocolVersion: 5,
-                // The "will" message will be published on an unexpected disconnection
-                // The server can then tidy up.  So it needs every for this client to do that, the session details is perfect
-                will: {
-                    topic: 'interop/lastwill',
-                    payload: Buffer.from(JSON.stringify(this.#sessionDetails)),
-                    qos: 0,
-                    retain: false,
-                    properties: {
-                        willDelayInterval: 10,
-                    },
-                },
-                username: this.#sessionDetails.token,
-            };
-            this.#mqttClient = await mqtt.connectAsync(this.#sessionDetails.url, clientOptions);
-            this.#logger('log', `Cloud Interop successfully connected to ${this.#cloudInteropSettings.url}`);
-            this.#mqttClient.on('error', async (error) => {
-                // We will receive errors for each failed reconnection attempt
-                // We don't won't to disconnect on these else we will never reconnect
-                if (!this.#attemptingToReconnect) {
-                    await this.#disconnect(false);
-                }
-                if (error instanceof mqtt.ErrorWithReasonCode) {
-                    switch (error.code) {
-                        case BadUserNamePasswordError: {
-                            await this.#disconnect(false);
-                            this.#logger('warn', `Session expired`);
-                            this.#emitEvent('session-expired');
-                            return;
-                        }
-                        default: {
-                            this.#logger('error', `Unknown Infrastructure Error Code ${error.code} : ${error.message}${this.#attemptingToReconnect ? ' during reconnection attempt' : ''}`);
-                            // As we are in the middle of a reconnect, lets not emit an error to cut down on the event noise
-                            if (!this.#attemptingToReconnect) {
-                                this.#emitEvent('error', new CloudInteropAPIError(`Unknown Infrastructure Error Code ${error.code} : ${error.message}`, 'ERR_INFRASTRUCTURE', error));
-                                break;
-                            }
-                        }
-                    }
-                }
-                else {
-                    this.#logger('error', `Unknown Error${this.#attemptingToReconnect ? ' during reconnection attempt' : ''}: ${error}`);
-                    // As we are in the middle of a reconnect, lets not emit an error to cut down on the event noise
-                    if (!this.#attemptingToReconnect) {
-                        this.#emitEvent('error', new CloudInteropAPIError(`Unknown Error`, 'ERR_UNKNOWN', error));
-                    }
-                }
-            });
-            this.#mqttClient.on('reconnect', () => {
-                this.#attemptingToReconnect = true;
-                this.#reconnectRetries += 1;
-                this.#logger('debug', `Cloud Interop attempting reconnection - ${this.#reconnectRetries}...`);
-                if (this.#reconnectRetries === this.#reconnectRetryLimit) {
-                    this.#logger('warn', `Cloud Interop reached max reconnection attempts - ${this.#reconnectRetryLimit}...`);
-                    this.#disconnect(true);
-                }
-                this.#emitEvent('reconnecting', this.#reconnectRetries);
-            });
-            // Does not fire on initial connection, only successful reconnection attempts
-            this.#mqttClient.on('connect', () => {
-                this.#logger('debug', `Cloud Interop successfully reconnected after ${this.#reconnectRetries} attempts`);
-                this.#reconnectRetries = 0;
-                this.#attemptingToReconnect = false;
-                this.#emitEvent('reconnected');
-            });
-            this.#mqttClient.on('message', (topic, message) => {
-                if (!this.#sessionDetails) {
-                    this.#logger('warn', 'Received message when session not connected');
-                    return;
-                }
-                this.#handleCommand(topic, message, this.#sessionDetails);
-            });
-            // Subscribe to all context groups
-            this.#mqttClient.subscribe(`${sessionRootTopic}/context-groups/#`);
-            // Listen out for global commands
-            this.#mqttClient.subscribe(`${sessionRootTopic}/commands`);
-        }
-        catch (error) {
-            if (axios.isAxiosError(error)) {
-                if (error.response?.status === 401 || error.response?.status === 403) {
-                    throw new AuthorizationError();
-                }
-                throw new CloudInteropAPIError();
-            }
-            throw error;
-        }
-    }
-    /**
-     * Disconnects from the Cloud Interop service
-     *
-     * @return {*}  {Promise<void>}
-     * @memberof CloudInteropAPI
-     * @throws {CloudInteropAPIError} - If an error occurs during disconnection
-     */
-    async disconnect() {
-        await this.#disconnect(true);
-    }
-    /**
-     * Publishes a new context for the given context group to the other connected sessions
-     *
-     * @param {string} contextGroup - The context group to publish to
-     * @param {object} context - The context to publish
-     * @return {*}  {Promise<void>}
-     * @memberof CloudInteropAPI
-     */
-    async setContext(contextGroup, context) {
-        if (!this.#sessionDetails || !this.#connectionParams) {
-            throw new Error('Session not connected');
-        }
-        const payload = {
-            context,
-            timestamp: Date.now(),
-        };
-        await axios.post(`${this.#cloudInteropSettings.url}/api/context-groups/${this.#sessionDetails.sessionId}/${contextGroup}`, payload, {
-            headers: this.#getRequestHeaders(),
-        });
-    }
-    addEventListener(type, callback) {
-        const listeners = this.#eventListeners.get(type) || [];
-        listeners.push(callback);
-        this.#eventListeners.set(type, listeners);
-    }
-    removeEventListener(type, callback) {
-        const listeners = this.#eventListeners.get(type) || [];
-        const index = listeners.indexOf(callback);
-        if (index !== -1) {
-            listeners.splice(index, 1);
-        }
-        this.#eventListeners.set(type, listeners);
-    }
-    async #disconnect(fireDisconnectedEvent) {
-        if (!this.#sessionDetails) {
-            return;
-        }
-        try {
-            const disconnectResponse = await axios.delete(`${this.#cloudInteropSettings.url}/api/sessions/${this.#sessionDetails.sessionId}`, {
-                headers: this.#getRequestHeaders(),
-            });
-            if (disconnectResponse.status !== 200) {
-                throw new CloudInteropAPIError('Error during session tear down - unexpected status', 'ERR_DISCONNECT', disconnectResponse.status);
-            }
-        }
-        catch {
-            throw new CloudInteropAPIError('Error during disconnection', 'ERR_DISCONNECT');
-        }
-        finally {
-            this.#mqttClient?.removeAllListeners();
-            await this.#mqttClient?.endAsync(true);
-            this.#sessionDetails = undefined;
-            this.#mqttClient = undefined;
-            this.#reconnectRetries = 0;
-            this.#attemptingToReconnect = false;
-            if (fireDisconnectedEvent) {
-                this.#emitEvent('disconnected');
-            }
-        }
-    }
-    #handleCommand(topic, message, sessionDetails) {
-        if (message.length === 0 || !sessionDetails) {
-            // Ignore clean up messages
-            return;
-        }
-        const messageEnvelope = JSON.parse(message.toString());
-        if (topic.startsWith(`${sessionDetails.sessionRootTopic}/context-groups/`)) {
-            if (messageEnvelope.source.sessionId === sessionDetails.sessionId) {
-                return;
-            }
-            const { channelName: contextGroup, payload: context, source, history } = messageEnvelope;
-            this.#emitEvent('context', { contextGroup, context, source, history: { ...history, clientReceived: Date.now() } });
-        }
-    }
-    #emitEvent(type, ...args) {
-        const listeners = this.#eventListeners.get(type) || [];
-        listeners.forEach((listener) => listener(...args));
-    }
-    #validateConnectParams = (parameters) => {
-        if (!parameters) {
-            throw new Error('Connect parameters must be provided');
-        }
-        if (parameters.authenticationType === 'jwt' &&
-            (!parameters.jwtAuthenticationParameters?.jwtRequestCallback || !parameters.jwtAuthenticationParameters?.authenticationId)) {
-            throw new Error('jwtAuthenticationParameters must be provided when using jwt authentication');
-        }
-        if (parameters.authenticationType === 'basic' &&
-            (!parameters.basicAuthenticationParameters?.username || !parameters.basicAuthenticationParameters?.password)) {
-            throw new Error('basicAuthenticationParameters must be provided when using basic authentication');
-        }
-    };
-    #getRequestHeaders = () => {
-        if (!this.#connectionParams) {
-            throw new Error('Connect parameters must be provided');
-        }
-        const headers = new axios.AxiosHeaders();
-        headers['Content-Type'] = 'application/json';
-        if (this.#connectionParams.authenticationType === 'jwt' && this.#connectionParams.jwtAuthenticationParameters) {
-            const tokenResult = this.#connectionParams.jwtAuthenticationParameters.jwtRequestCallback();
-            if (!tokenResult) {
-                throw new Error('jwtRequestCallback must return a token');
-            }
-            headers['x-of-auth-id'] = this.#connectionParams.jwtAuthenticationParameters.authenticationId;
-            headers['Authorization'] =
-                typeof tokenResult === 'string' ? `Bearer ${tokenResult}` : `Bearer ${Buffer.from(JSON.stringify(tokenResult)).toString('base64')}`;
-        }
-        if (this.#connectionParams.authenticationType === 'basic' && this.#connectionParams.basicAuthenticationParameters) {
-            const { username, password } = this.#connectionParams.basicAuthenticationParameters;
-            headers['Authorization'] = `Basic ${Buffer.from(`${username}:${password}`).toString('base64')}`;
-        }
-        return headers;
-    };
-}
-
-exports.AuthorizationError = AuthorizationError;
-exports.CloudInteropAPI = CloudInteropAPI;
-exports.CloudInteropAPIError = CloudInteropAPIError;

package/dist/index.d.ts

@@ -1,3 +0,0 @@
-export * from './api';
-export * from './errors/api.error';
-export * from './interfaces';