@openfin/cloud-interop-core-api 0.0.1-alpha.380eb94 → 0.0.1-alpha.384d88e

package/dist/{api.d.ts → src/api.d.ts}

@@ -1,5 +1,6 @@
+import { EndReportIntentsEvent, Intent, IntentDetailsEvent, IntentResultEvent, InvokeIntentEvent, ReportIntentsEvent } from '@openfin-direct/shared-utils';
 import mqtt from 'mqtt';
-import { CloudInteropSettings, ConnectParameters as ConnectParameters, ContextEvent } from './interfaces';
+import { CloudInteropSettings, ConnectParameters, ContextEvent } from './interfaces';
 type CreateSessionResponse = {
     sessionId: string;
     sessionRootTopic: string;
@@ -17,6 +18,11 @@ type EventMap = {
     reconnecting: (attemptNo: number) => void;
     error: (error: Error) => void;
     'session-expired': () => void;
+    'report-intents': (event: ReportIntentsEvent) => void;
+    'end-report-intents': (event: EndReportIntentsEvent) => void;
+    'intent-details': (event: IntentDetailsEvent) => void;
+    'invoke-intent': (event: InvokeIntentEvent) => void;
+    'intent-result': (event: IntentResultEvent) => void;
 };
 /**
  * Represents a single connection to a Cloud Interop service
@@ -57,6 +63,25 @@ export declare class CloudInteropAPI {
      * @memberof CloudInteropAPI
      */
     setContext(contextGroup: string, context: object): Promise<void>;
+    /**
+     * Starts an intent discovery operation
+     *
+     * @return {*}  {Promise<void>}
+     * @memberof CloudInteropAPI
+     * @throws {CloudInteropAPIError} - If an error occurs during intent discovery
+     */
+    startIntentDiscovery(): Promise<void>;
+    /**
+     * Ends an intent discovery operation
+     *
+     * @return {*}  {Promise<void>}
+     * @memberof CloudInteropAPI
+     * @throws {CloudInteropAPIError} - If an error occurs during stopping intent discovery
+     */
+    endIntentDiscovery(): Promise<void>;
+    raiseIntent(intent: Intent, targetSessionId: string): Promise<void>;
+    reportSupportedIntents(discoveryId: string, intents: Intent[]): Promise<void>;
+    sendIntentResult(resultEvent: IntentResultEvent): Promise<void>;
     addEventListener<K extends keyof EventMap>(type: K, callback: EventMap[K]): void;
     removeEventListener<K extends keyof EventMap>(type: K, callback: EventMap[K]): void;
 }

package/dist/{interfaces.d.ts → src/interfaces.d.ts}

@@ -9,27 +9,27 @@ 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.
      */
-    sourceId?: string;
+    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;
+    /**
+     * 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
      *
@@ -100,23 +100,6 @@ export type Source = {
      */
     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
  *

package/dist/tests/connect.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/context.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/mocks/fetch.mock.d.ts

@@ -0,0 +1,128 @@
+export declare const DEFAULT_HEADERS: {
+    'Content-Type': string;
+};
+export declare const DEFAULT_AUTH_HEADER: {
+    Authorization: string;
+};
+type Method = 'GET' | 'OPTIONS' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+export declare enum Status {
+    OK = 200,
+    Created = 201,
+    Accepted = 202,
+    NonAuthoritativeInformation = 203,
+    NoContent = 204,
+    ResetContent = 205,
+    PartialContent = 206,
+    MultipleChoices = 300,
+    MovedPermanently = 301,
+    Found = 302,
+    SeeOther = 303,
+    NotModified = 304,
+    UseProxy = 305,
+    Unused = 306,
+    TemporaryRedirect = 307,
+    PermanentRedirect = 308,
+    BadRequest = 400,
+    Unauthorized = 401,
+    PaymentRequired = 402,
+    Forbidden = 403,
+    NotFound = 404,
+    MethodNotAllowed = 405,
+    NotAcceptable = 406,
+    ProxyAuthenticationRequired = 407,
+    RequestTimeout = 408,
+    Conflict = 409,
+    Gone = 410,
+    LengthRequired = 411,
+    PreconditionFailed = 412,
+    RequestEntityTooLarge = 413,
+    RequestURITooLong = 414,
+    UnsupportedMediaType = 415,
+    RequestedRangeNotSatisfiable = 416,
+    ExpectationFailed = 417,
+    Imateapot = 418,
+    MisdirectedRequest = 421,
+    UnprocessableEntity = 422,
+    Locked = 423,
+    TooEarly = 425,
+    UpgradeRequired = 426,
+    PreconditionRequired = 428,
+    TooManyRequests = 429,
+    RequestHeaderFieldsTooLarge = 431,
+    UnavailableForLegalReasons = 451,
+    InternalServerError = 500,
+    NotImplemented = 501,
+    BadGateway = 502,
+    ServiceUnavailable = 503,
+    GatewayTimeout = 504,
+    HTTPVersionNotSupported = 505,
+    VariantAlsoNegotiates = 506,
+    InsufficientStorage = 507,
+    NetworkAuthenticationRequired = 511,
+    Webserverisreturninganunknownerror = 520,
+    Connectiontimedout = 522,
+    Atimeoutoccurred = 524
+}
+/**
+ * Stub API request, response in test cases.
+ * - should be initialized and destroyed within the context of a specific case.
+ * - highly customizable
+ *
+ * <pre>
+ *  describe("Fetch API", () => {
+ *    let fetchResolver!: FetchResolver;
+ *      beforeEach(() => {
+ *      fetchResolver = new FetchResolver();
+ *    });
+ *
+ *    it("should load api", async () => {
+ *      // stub
+ *      fetchResolver.stub( "http://localhost:8080/endpoint", "post", { id: 100 }, { created: true }, 200);
+ *      // fetch
+ *      fetch("http://localhost:8080/endpoint",
+ *        { method: "post", body: JSON.stringify({ id: 100 })}
+ *      ).then((response) => {
+ *        if (response.ok) {
+ *          response.text().then((text) => {
+ *            console.log(text); // { created: true }
+ *            expect(text).toBeEqual({ created: true });
+ *          });
+ *        }
+ *      });
+ *    });
+ *
+ *    afterEach(() => {
+ *      fetchResolver.clear();
+ *    });
+ *  });
+ * </pre>
+ *
+ * Even though jest executes tests in parallel jest instance,
+ * We can't go wrong if stubs are cleaned after its use
+ */
+export declare class FetchResolver {
+    readonly interopUrl: string;
+    readonly sourceId: string;
+    readonly platformId: string;
+    private mocks;
+    fetchSpy: jest.SpyInstance<Promise<Response>, [input: string | URL | Request, init?: RequestInit | undefined], any>;
+    constructor(interopUrl?: string, sourceId?: string, platformId?: string);
+    stubConnect(headers?: Record<string, string>): void;
+    stubDelete(status?: number): void;
+    stubFetchWithSourceAndPlatform(url: string, method: Method, headers: any, payload: any, response: any, status: number): void;
+    stubFetch(url: string, method: Method, headers: any, payload: any, response: any, status: number): void;
+    /**
+     *
+     * @param uri
+     * @param method
+     * @param headers pass null to delete headers from requestInit
+     * @param payload pass null to delete body from requestInit
+     * @param response
+     * @param status
+     */
+    stub(uri: string, method: Method, headers: any, payload: any, response: any, status: Status): void;
+    private prettyPrint;
+    clear(): void;
+    private init;
+}
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/cloud-interop-core-api",
-    "version": "0.0.1-alpha.380eb94",
+    "version": "0.0.1-alpha.384d88e",
     "type": "module",
     "description": "",
     "files": [
@@ -8,9 +8,9 @@
     ],
     "main": "./dist/index.cjs",
     "browser": "./dist/index.mjs",
-    "types": "./dist/index.d.ts",
+    "types": "./dist/src/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-direct/shared-utils": "file:../shared-utils",
         "mqtt": "^5.3.1"
     },
     "eslintConfig": {