@openfin/cloud-interop-core-api 0.0.1-alpha.e6793f0 → 0.0.1-alpha.ebcbdf6

package/dist/{interfaces.d.ts → interfaces/connect.interface.d.ts}

@@ -9,27 +9,23 @@ export type CloudInteropLogger = (level: LogLevel, message: string) => void;
 export type ConnectParameters = {
     /**
      * ID for a group of shared applications.
+     * This acts as a namespace for the interop messages that allows separation of messages between different groups of applications for the same user
      */
     platformId: string;
     /**
-     * An identifier for the source environment e.g. a hostname, a browser name etc.
+     * An user-friendly identifier for the source session e.g. Windows Desktop, Android Phone, 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;
+    sourceId: string;
     /**
      * The maximum number of times to retry connecting to the cloud interop service when the connection is dropped
      * defaults to 30
      */
     reconnectRetryLimit?: number;
+    /**
+     * Specifies how often keep alive messages should be sent to the cloud interop service in seconds
+     * defaults to 30
+     */
+    keepAliveIntervalSeconds?: number;
     /**
      * Optional function to call with any logging messages to allow integration with the host application's logging
      *
@@ -77,57 +73,13 @@ export type ConnectParameters = {
 export type CloudInteropSettings = {
     url: string;
 };
-/**
- * Represents a session
- */
-export type InteropSession = {
-    sessionId: string;
-};
-/**
- * Represents a source session
- */
-export type Source = {
-    /**
-     * Source session id
-     */
+export type CreateSessionResponse = {
     sessionId: string;
-    /**
-     * source environment id
-     */
+    sessionRootTopic: string;
+    url: string;
+    token: string;
+    orgId: string;
+    sub: string;
+    platformId: string;
     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;
 };

package/dist/interfaces/event.interface.d.ts

@@ -0,0 +1,15 @@
+import { AggregateIntentDetailsEvent, ContextEvent, IntentDetailsEvent, IntentResultEvent, RaiseIntentEvent, ReportIntentsEvent } from '@openfin/shared-utils';
+export type EventMap = {
+    reconnected: () => void;
+    disconnected: () => void;
+    context: (event: ContextEvent) => void;
+    reconnecting: (attemptNo: number) => void;
+    error: (error: Error) => void;
+    'session-expired': () => void;
+    'report-intents': (event: ReportIntentsEvent) => void;
+    'intent-details': (event: IntentDetailsEvent) => void;
+    'aggregate-intent-details': (event: AggregateIntentDetailsEvent) => void;
+    'raise-intent': (event: RaiseIntentEvent) => void;
+    'intent-result': (event: IntentResultEvent) => void;
+};
+export type EventListenersMap = Map<keyof EventMap, Array<(...args: Parameters<EventMap[keyof EventMap]>) => void>>;

package/dist/interfaces/index.d.ts

@@ -0,0 +1,3 @@
+export * from './connect.interface';
+export * from './event.interface';
+export * from './intents.interface';

package/dist/interfaces/intents.interface.d.ts

@@ -0,0 +1,22 @@
+import { AppIdentifier, FindIntentOptions, RaiseIntentOptions } from '@openfin/shared-utils';
+/**
+ * Options used to start an Intent Discovery Operation, with possible constraints for the responses
+ */
+export type StartIntentDiscoveryOptions = {
+    findOptions: FindIntentOptions;
+    /**
+     * The timeout in ms.
+     *
+     * Discovery will wait for all connected sessions to respond or until the timeout is reached.
+     *
+     * Defaults to 3000ms if not provided, minimum value 500ms
+     */
+    timeout?: number;
+};
+/**
+ * Options used to raise an Intent
+ */
+export type RaiseIntentAPIOptions = {
+    raiseOptions: RaiseIntentOptions;
+    appId: AppIdentifier | string;
+};

package/dist/utils.d.ts

@@ -0,0 +1,25 @@
+import { AppIdentifier, AppIntent, Source } from '@openfin/shared-utils';
+import { ConnectParameters, CreateSessionResponse } from './interfaces';
+export declare const APP_ID_DELIM = "::";
+export declare const getRequestHeaders: (connectionParameters: ConnectParameters) => HeadersInit;
+/**
+ * Encodes all app intents in the format: `appId::sourceId::sessionId`,
+ * where sourceId and sessionId are URI encoded
+ * @param appIntents
+ * @param source
+ * @returns
+ */
+export declare const encodeAppIntents: (appIntents: AppIntent[], { sessionId, sourceId }: Source) => AppIntent[];
+/**
+ * Decodes all app intents by URI decoding the parts previously encoded by `encodeAppIntents`
+ * @param appIntents
+ * @returns
+ */
+export declare const decodeAppIntents: (appIntents: AppIntent[]) => AppIntent[];
+/**
+ * Decodes the app id to extract the sessionId, returns '' if not able to parse
+ * @param app
+ * @returns
+ */
+export declare const parseSessionId: (appId: AppIdentifier | string) => any;
+export declare const getSourceFromSession: (sessionDetails: CreateSessionResponse) => Source;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/cloud-interop-core-api",
-    "version": "0.0.1-alpha.e6793f0",
+    "version": "0.0.1-alpha.ebcbdf6",
     "type": "module",
     "description": "",
     "files": [
@@ -10,7 +10,7 @@
     "browser": "./dist/index.mjs",
     "types": "./dist/index.d.ts",
     "scripts": {
-        "build": "rollup -c",
+        "build": "rimraf dist && rollup -c",
         "build:watch": "rollup -c --watch",
         "typecheck": "tsc --noEmit",
         "test": "jest --coverage",
@@ -25,7 +25,7 @@
         "@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",
         "eslint": "^8.57.0",
@@ -42,7 +42,7 @@
         "typescript": "^5.6.3"
     },
     "dependencies": {
-        "axios": "^1.6.2",
+        "@openfin/shared-utils": "file:../shared-utils",
         "mqtt": "^5.3.1"
     },
     "eslintConfig": {