@openfin/cloud-interop-core-api 0.0.1-alpha.384d88e → 0.0.1-alpha.47835ce

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

@@ -13,13 +13,9 @@ export type ConnectParameters = {
      */
     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;
     /**
      * The maximum number of times to retry connecting to the cloud interop service when the connection is dropped
      * defaults to 30
@@ -77,49 +73,13 @@ export type ConnectParameters = {
 export type CloudInteropSettings = {
     url: string;
 };
-/**
- * Represents a session
- */
-export type InteropSession = {
+export type CreateSessionResponse = {
     sessionId: string;
-};
-/**
- * Represents a source session
- */
-export type Source = {
-    /**
-     * Source session id
-     */
-    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 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 = {
-    /**
-     * The context group
-     */
-    contextGroup: string;
-    /**
-     * The context object
-     */
-    context: object;
-    /**
-     * The source of the context
-     */
-    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.384d88e",
+    "version": "0.0.1-alpha.47835ce",
     "type": "module",
     "description": "",
     "files": [
@@ -8,7 +8,7 @@
     ],
     "main": "./dist/index.cjs",
     "browser": "./dist/index.mjs",
-    "types": "./dist/src/index.d.ts",
+    "types": "./dist/index.d.ts",
     "scripts": {
         "build": "rimraf dist && rollup -c",
         "build:watch": "rollup -c --watch",
@@ -42,7 +42,7 @@
         "typescript": "^5.6.3"
     },
     "dependencies": {
-        "@openfin-direct/shared-utils": "file:../shared-utils",
+        "@openfin/shared-utils": "file:../shared-utils",
         "mqtt": "^5.3.1"
     },
     "eslintConfig": {

package/dist/src/index.d.ts

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

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

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

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

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

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

@@ -1,128 +0,0 @@
-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 {};