@openfin/cloud-interop-core-api 0.0.1-alpha.6b2fbd5 → 0.0.1-alpha.6d7b62b

package/dist/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@openfin/cloud-interop-core-api",
+  "version": "0.0.1-alpha",
+  "type": "module",
+  "description": "",
+  "main": "./index.cjs",
+  "browser": "./index.mjs",
+  "types": "./bundle.d.ts",
+  "author": "",
+  "license": "SEE LICENSE IN LICENSE.md",
+  "optionalDependencies": {
+    "@rollup/rollup-linux-x64-gnu": "*"
+  },
+  "dependencies": {
+    "mqtt": "^5.3.1",
+    "zod": "^3.24.1"
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/cloud-interop-core-api",
-    "version": "0.0.1-alpha.6b2fbd5",
+    "version": "0.0.1-alpha.6d7b62b",
     "type": "module",
     "description": "",
     "files": [
@@ -8,26 +8,29 @@
     ],
     "main": "./dist/index.cjs",
     "browser": "./dist/index.mjs",
-    "types": "./dist/index.d.ts",
+    "types": "./dist/bundle.d.ts",
     "scripts": {
-        "build": "rollup -c",
-        "build:watch": "rollup -c --watch",
+        "build": "rimraf dist && tsx scripts/build.ts",
+        "build:watch": "NODE_ENV=development npx nodemon --watch ./src -e .ts -x \"npm run build || exit 1\"",
         "typecheck": "tsc --noEmit",
         "test": "jest --coverage",
         "lint": "eslint . --max-warnings 0",
-        "lint:fix": "eslint . --fix --max-warnings 0"
+        "lint:fix": "eslint . --fix --max-warnings 0",
+        "pack": "pushd dist && npm pack && popd"
     },
     "author": "",
     "license": "SEE LICENSE IN LICENSE.md",
     "devDependencies": {
+        "@microsoft/api-extractor": "^7.49.1",
         "@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",
+        "@types/node": "^22.7.7",
         "@typescript-eslint/eslint-plugin": "^7.5.0",
         "@typescript-eslint/parser": "^7.15.0",
+        "dotenv-defaults": "^5.0.2",
         "eslint": "^8.57.0",
         "eslint-config-prettier": "^9.1.0",
         "eslint-plugin-check-file": "^2.8.0",
@@ -36,14 +39,20 @@
         "eslint-plugin-unicorn": "^55.0.0",
         "eslint-plugin-unused-imports": "^4.1.4",
         "jest": "^29.7.0",
+        "nodemon": "^3.1.9",
         "prettier": "^3.3.3",
-        "rollup": "^4.9.6",
+        "rollup": "^4.30.1",
         "ts-jest": "^29.2.5",
-        "typescript": "^5.6.3"
+        "tsx": "^4.19.2",
+        "typescript": "^5.7.3"
+    },
+    "optionalDependencies": {
+        "@rollup/rollup-linux-x64-gnu": "*"
     },
     "dependencies": {
-        "axios": "^1.6.2",
-        "mqtt": "^5.3.1"
+        "@openfin/shared-utils": "file:../shared-utils",
+        "mqtt": "^5.3.1",
+        "zod": "^3.24.1"
     },
     "eslintConfig": {
         "env": {
@@ -197,6 +206,7 @@
             "node_modules",
             "out",
             "build",
+            "scripts",
             "dist",
             "coverage",
             "tests",

package/dist/api.d.ts

@@ -1,70 +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 = {
-    connected: () => void;
-    disconnected: () => void;
-    context: (event: ContextEvent) => void;
-    reconnecting: (attemptNo: number) => void;
-    error: (error: Error) => void;
-};
-/**
- * Represents a single connection to a Cloud Interop service
- *
- * @export
- * @class CloudInteropAPI
- * @implements {Client}
- */
-export declare class CloudInteropAPI {
-    #private;
-    private cloudInteropSettings;
-    private _sessionDetails?;
-    private _mqttClient?;
-    private reconnectRetryLimit;
-    private logger;
-    private reconnectRetries;
-    private connectionParams?;
-    private eventListeners;
-    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.d.ts

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

package/dist/interfaces.d.ts

@@ -1,133 +0,0 @@
-export type LogLevel = 'log' | 'debug' | 'info' | 'warn' | 'error';
-/**
- * Represents a logging function to be used by the cloud interop client
- */
-export type CloudInteropLogger = (level: LogLevel, message: string) => void;
-/**
- * Represents the parameters to use to connect to an interop server
- */
-export type ConnectParameters = {
-    /**
-     * ID for a group of shared applications.
-     */
-    platformId: string;
-    /**
-     * An identifier for the source environment e.g. a hostname, a browser name etc.
-     */
-    sourceId?: string;
-    /**
-     * A display name for the source environment e.g. Andys Mobile
-     */
-    sourceDisplayName?: string;
-    /**
-     * Specifies an optional extra divider to use that allows separation of interop messages for the
-     * same user
-     * defaults to "default"
-     */
-    realm?: string;
-    /**
-     * The maximum number of times to retry connecting to the cloud interop service when the connection is dropped
-     * defaults to 30
-     */
-    reconnectRetryLimit?: number;
-    /**
-     * Optional function to call with any logging messages to allow integration with the host application's logging
-     *
-     * defaults to console.log
-     */
-    logger?: CloudInteropLogger;
-    /**
-     * Determines the type of authentication to use with the service gateway
-     * defaults to 'none'
-     *
-     * 'jwt' - Use JWT authentication, in this case jwtAuthenticationParameters must also be provided
-     * 'basic' - Use basic authentication, in this case basicAuthenticationParameters must also be provided
-     * 'default' - Authentication will be inherited from the current session
-     */
-    authenticationType?: 'jwt' | 'basic' | 'default';
-    /**
-     * Optional parameters for basic authentication
-     */
-    basicAuthenticationParameters?: {
-        /**
-         * The username to use for basic authentication
-         */
-        username: string;
-        /**
-         * The password to use for basic authentication
-         */
-        password: string;
-    };
-    /**
-     * Optional parameters for JWT authentication
-     */
-    jwtAuthenticationParameters?: {
-        /**
-         * When JWT authentication is being used, this will be invoked just whenever a JWT token is required for a request
-         */
-        jwtRequestCallback: () => string | object;
-        /**
-         * The id of the service gateway JWT authentication definition to use
-         *
-         * Note: Contact Here support to to get your organization's authentication id
-         */
-        authenticationId: string;
-    };
-};
-export type CloudInteropSettings = {
-    url: string;
-};
-/**
- * Represents a session
- */
-export type InteropSession = {
-    sessionId: string;
-};
-/**
- * Represents a source session
- */
-export type Source = {
-    /**
-     * Source session id
-     */
-    sessionId: string;
-    /**
-     * source environment id
-     */
-    sourceId: string;
-    /**
-     * source environment display name
-     */
-    sourceDisplayName: string;
-};
-/**
- * Represents the details of an intent found during discovery
- */
-export type IntentDetail = {
-    /**
-     * The location of the intent implementation
-     */
-    source: Source;
-    /**
-     * The instance id of the intent
-     */
-    intentInstanceId: string;
-    /**
-     * The name of the intent
-     */
-    intentName: string;
-};
-/**
- * Represents a context received from another cloud interop publisher
- *
- * @export
- * @type ContextEvent
- * @property {string} contextGroup - The context group
- * @property {object} context - The context
- * @property {Source} source - The source of the context
- */
-export type ContextEvent = {
-    contextGroup: string;
-    context: object;
-    source: Source;
-};