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

package/dist/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,12 +73,6 @@ export type ConnectParameters = {
 export type CloudInteropSettings = {
     url: string;
 };
-/**
- * Represents a session
- */
-export type InteropSession = {
-    sessionId: string;
-};
 export type CreateSessionResponse = {
     sessionId: string;
     sessionRootTopic: string;

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

@@ -1,4 +1,4 @@
-import { ContextEvent, EndReportIntentsEvent, IntentDetailsEvent, IntentResultEvent, InvokeIntentEvent, ReportIntentsEvent } from '@openfin/shared-utils';
+import { AggregateIntentDetailsEvent, ContextEvent, IntentDetailsEvent, IntentResultEvent, RaiseIntentEvent, ReportIntentsEvent } from '@openfin/shared-utils';
 export type EventMap = {
     reconnected: () => void;
     disconnected: () => void;
@@ -7,9 +7,9 @@ export type EventMap = {
     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;
+    '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

@@ -1,2 +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.e7138f8",
+    "version": "0.0.1-alpha.ebcbdf6",
     "type": "module",
     "description": "",
     "files": [