@openfin/core 29.73.3 → 29.73.5

package/src/api/interop/fdc3/shapes/fdc3v1.d.ts

@@ -0,0 +1,53 @@
+import type { DisplayMetadata } from 'fdc3v1/src/api/DisplayMetadata';
+import type { Listener } from 'fdc3v1/src/api/Listener';
+import type { AppMetadata } from 'fdc3v1/src/api/AppMetadata';
+import type { AppIntent } from 'fdc3v1/src/api/AppIntent';
+import type { ImplementationMetadata } from 'fdc3v1/src/api/ImplementationMetadata';
+export type { DisplayMetadata } from 'fdc3v1/src/api/DisplayMetadata';
+export type { Listener } from 'fdc3v1/src/api/Listener';
+export type { AppMetadata } from 'fdc3v1/src/api/AppMetadata';
+export type { AppIntent } from 'fdc3v1/src/api/AppIntent';
+export type { ImplementationMetadata } from 'fdc3v1/src/api/ImplementationMetadata';
+export declare type ContextHandler = (context: Context) => void;
+export declare type TargetApp = string | AppMetadata;
+export interface Context {
+    id?: {
+        [key: string]: string;
+    };
+    name?: string;
+    type: string;
+}
+export interface IntentResolution {
+    source: TargetApp;
+    data?: object;
+    version: string;
+}
+export interface Channel {
+    id: string;
+    type: string;
+    displayMetadata?: DisplayMetadata;
+    broadcast(context: Context): void;
+    getCurrentContext(contextType?: string): Promise<Context | null>;
+    addContextListener(contextType: string | null, handler: ContextHandler): Listener & Promise<Listener>;
+}
+export declare type SystemChannel = Omit<Channel, 'addContextListener' | 'broadcast' | 'getCurrentContext'> & {
+    addContextListener(): Error;
+    broadcast(): Error;
+    getCurrentContext(): Error;
+};
+export interface DesktopAgent {
+    open(app: TargetApp, context?: Context): Promise<void>;
+    findIntent(intent: string, context?: Context): Promise<AppIntent>;
+    findIntentsByContext(context: Context): Promise<Array<AppIntent>>;
+    broadcast(context: Context): void;
+    raiseIntent(intent: string, context: Context, app?: TargetApp): Promise<IntentResolution>;
+    raiseIntentForContext(context: Context, app?: TargetApp): Promise<IntentResolution>;
+    addIntentListener(intent: string, handler: ContextHandler): Listener;
+    joinChannel(channelId: string): Promise<void>;
+    leaveCurrentChannel(): Promise<void>;
+    getInfo(): ImplementationMetadata;
+    addContextListener(contextType: string | null, handler: ContextHandler): Listener & Promise<Listener>;
+    getOrCreateChannel(channelId: string): Promise<Channel>;
+    getSystemChannels(): Promise<SystemChannel[]>;
+    getCurrentChannel(): Promise<Channel | null>;
+}

package/src/api/interop/fdc3/shapes/fdc3v1.js

@@ -0,0 +1,4 @@
+"use strict";
+/* eslint-disable import/no-extraneous-dependencies */
+/* eslint-disable no-restricted-imports */
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/api/interop/fdc3/shapes/fdc3v2.d.ts

@@ -0,0 +1,74 @@
+import { Channel as ChannelV1, SystemChannel } from './fdc3v1';
+import type { Listener } from 'fdc3v2/src/api/Listener';
+import type { AppIntent } from 'fdc3v2/src/api/AppIntent';
+import type { ImplementationMetadata } from 'fdc3v2/src/api/ImplementationMetadata';
+import type { ContextMetadata } from 'fdc3v2/src/api/ContextMetadata';
+import type { AppIdentifier } from 'fdc3v2/src/api/AppIdentifier';
+import type { AppMetadata } from 'fdc3v2/src/api/AppMetadata';
+import type { DisplayMetadata } from 'fdc3v2/src/api/DisplayMetadata';
+export type { Listener } from 'fdc3v2/src/api/Listener';
+export type { AppIntent } from 'fdc3v2/src/api/AppIntent';
+export type { ImplementationMetadata } from 'fdc3v2/src/api/ImplementationMetadata';
+export type { ContextMetadata } from 'fdc3v2/src/api/ContextMetadata';
+export type { AppIdentifier } from 'fdc3v2/src/api/AppIdentifier';
+export type { AppMetadata } from 'fdc3v2/src/api/AppMetadata';
+export type { DisplayMetadata } from 'fdc3v2/src/api/DisplayMetadata';
+export declare type ContextHandler = (context: Context, metadata?: ContextMetadata) => void;
+export declare type IntentHandler = (context: Context, metadata?: ContextMetadata) => Promise<IntentResult> | void;
+export declare type IntentResult = Context | Channel | PrivateChannel;
+export interface Context {
+    id?: {
+        [key: string]: string;
+    };
+    name?: string;
+    type: string;
+    contextMetadata?: ContextMetadata;
+    metadata?: any;
+}
+export interface Intent {
+    name: string;
+    context: Context;
+    metadata: OpenFin.IntentMetadata;
+}
+export interface IntentResolution {
+    source: AppIdentifier;
+    intent: string;
+    version?: string;
+    getResult(): Promise<IntentResult>;
+}
+export interface Channel {
+    readonly id: string;
+    readonly type: 'user' | 'app' | 'private';
+    readonly displayMetadata?: DisplayMetadata;
+    broadcast(context: Context): Promise<void>;
+    getCurrentContext(contextType?: string): Promise<Context | null>;
+    addContextListener(contextType: string | null, handler: ContextHandler): Listener & Promise<Listener>;
+}
+export declare type PrivateChannel = Omit<Channel, 'addContextListener'> & {
+    addContextListener(contextType: string | null, handler: ContextHandler): Promise<Listener>;
+    onAddContextListener(handler: (contextType?: string) => void): Listener;
+    onUnsubscribe(handler: (contextType?: string) => void): Listener;
+    onDisconnect(handler: () => void): Listener;
+    disconnect(): void;
+};
+export interface DesktopAgent {
+    open(app: AppIdentifier, context?: Context): Promise<AppIdentifier>;
+    findIntent(intent: string, context?: Context, resultType?: string): Promise<AppIntent>;
+    findIntentsByContext(context: Context, resultType?: string): Promise<Array<AppIntent>>;
+    findInstances(app: AppIdentifier): Promise<Array<AppIdentifier>>;
+    broadcast(context: Context): Promise<void>;
+    raiseIntent(intent: string, context: Context, app?: AppIdentifier): Promise<IntentResolution>;
+    raiseIntentForContext(context: Context, app?: AppIdentifier): Promise<IntentResolution>;
+    addIntentListener(intent: string, handler: IntentHandler): Promise<Listener>;
+    addContextListener(contextType: string | null, handler: ContextHandler): Promise<Listener>;
+    getUserChannels(): Promise<Array<SystemChannel>>;
+    joinUserChannel(channelId: string): Promise<void>;
+    getOrCreateChannel(channelId: string): Promise<ChannelV1>;
+    createPrivateChannel(): Promise<PrivateChannel>;
+    getCurrentChannel(): Promise<ChannelV1 | null>;
+    leaveCurrentChannel(): Promise<void>;
+    getInfo(): Promise<ImplementationMetadata>;
+    getAppMetadata(app: AppIdentifier): Promise<AppMetadata>;
+    getSystemChannels(): Promise<Array<SystemChannel>>;
+    joinChannel(channelId: string): Promise<void>;
+}

package/src/api/interop/fdc3/shapes/fdc3v2.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/api/interop/fdc3/utils.d.ts

@@ -1,8 +1,10 @@
+import { TargetApp } from './shapes/fdc3v1';
+import { AppIdentifier, IntentResolution, Channel, PrivateChannel, Context } from './shapes/fdc3v2';
 import { PrivateChannelClient } from './PrivateChannelClient';
 interface UnsupportedChannelApis {
     addContextListener(): Error;
     broadcast(): Error;
-    getCurrentChannel(): Error;
+    getCurrentContext(): Error;
 }
 export declare const getUnsupportedChannelApis: (channelType?: string) => UnsupportedChannelApis;
 export declare class UnsupportedChannelApiError extends Error {
@@ -18,8 +20,8 @@ export declare enum ResultError {
      */
     IntentHandlerRejected = "IntentHandlerRejected"
 }
-export declare const buildPrivateChannelObject: (privateChannelClient: PrivateChannelClient) => FDC3v2.PrivateChannel;
-export declare const buildAppChannelObject: (sessionContextGroup: OpenFin.SessionContextGroup) => FDC3.Channel;
-export declare const connectPrivateChannel: (channelId: string) => Promise<FDC3v2.PrivateChannel>;
-export declare const getIntentResolution: (interopModule: OpenFin.InteropClient, context: OpenFin.Context, app?: FDC3v2.AppIdentifier | FDC3.TargetApp, intent?: string) => Promise<FDC3v2.IntentResolution>;
+export declare const buildPrivateChannelObject: (privateChannelClient: PrivateChannelClient) => PrivateChannel;
+export declare const buildAppChannelObject: (sessionContextGroup: OpenFin.SessionContextGroup) => Channel;
+export declare const connectPrivateChannel: (channelId: string) => Promise<PrivateChannel>;
+export declare const getIntentResolution: (interopModule: OpenFin.InteropClient, context: Context, app?: AppIdentifier | TargetApp, intent?: string) => Promise<IntentResolution>;
 export {};

package/src/api/interop/fdc3/utils.js

@@ -11,8 +11,8 @@ const getUnsupportedChannelApis = (channelType) => {
         broadcast: () => {
             throw new UnsupportedChannelApiError('Channel.broadcast', channelType);
         },
-        getCurrentChannel: () => {
-            throw new UnsupportedChannelApiError('Channel.getCurrentChannel', channelType);
+        getCurrentContext: () => {
+            throw new UnsupportedChannelApiError('Channel.getCurrentContext', channelType);
         }
     };
 };

package/src/api/interop/utils.d.ts

@@ -15,3 +15,4 @@ export declare const BROKER_ERRORS: {
     fdc3GetInfo: string;
 };
 export declare const wrapIntentHandler: (handler: OpenFin.IntentHandler, handlerId: string) => (intent: OpenFin.Intent) => Promise<void>;
+export declare const generateDefaultLoggingOptions: () => OpenFin.InteropLoggingOptions;

package/src/api/interop/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.wrapIntentHandler = exports.BROKER_ERRORS = exports.generateOverrideWarning = exports.generateOverrideError = exports.wrapContextHandler = exports.wrapInTryCatch = exports.generateId = void 0;
+exports.generateDefaultLoggingOptions = exports.wrapIntentHandler = exports.BROKER_ERRORS = exports.generateOverrideWarning = exports.generateOverrideError = exports.wrapContextHandler = exports.wrapInTryCatch = exports.generateId = void 0;
 const generateId = () => `${Math.random()}${Date.now()}`;
 exports.generateId = generateId;
 const wrapInTryCatch = (f, prefix) => (...args) => {
@@ -59,3 +59,11 @@ const wrapIntentHandler = (handler, handlerId) => {
     };
 };
 exports.wrapIntentHandler = wrapIntentHandler;
+const generateDefaultLoggingOptions = () => {
+    const loggingActions = ['beforeAction', 'afterAction'];
+    const options = loggingActions.reduce((accumulator, loggingOption) => {
+        return { ...accumulator, [loggingOption]: { enabled: true } };
+    }, {});
+    return options;
+};
+exports.generateDefaultLoggingOptions = generateDefaultLoggingOptions;

package/src/api/platform/Instance.d.ts

@@ -64,6 +64,18 @@ export declare class Platform extends EmitterBase<PlatformEvents> {
      * @tutorial Platform.getSnapshot
      */
     getSnapshot(): Promise<OpenFin.Snapshot>;
+    /**
+     * Returns a snapshot of a single view's options in its current state.
+     *
+     * Can be used to restore a view to a previous state.
+     *
+     * NOTE: this method is meant for advanced usage only, it is not recommended to manage the state of individual views.
+     *
+     * @param { Identity } viewIdentity View identity
+     * @returns { Promise<ViewState> }
+     * @tutorial Platform.getViewSnapshot
+     */
+    getViewSnapshot(viewIdentity: OpenFin.Identity): Promise<OpenFin.ViewState>;
     /**
      * Adds a snapshot to a running Platform.
      * Requested snapshot must be a valid Snapshot object, or a url or filepath to such an object.

package/src/api/platform/Instance.js

@@ -173,6 +173,21 @@ class Platform extends base_1.EmitterBase {
         const client = await this.getClient();
         return client.dispatch('get-snapshot');
     }
+    /**
+     * Returns a snapshot of a single view's options in its current state.
+     *
+     * Can be used to restore a view to a previous state.
+     *
+     * NOTE: this method is meant for advanced usage only, it is not recommended to manage the state of individual views.
+     *
+     * @param { Identity } viewIdentity View identity
+     * @returns { Promise<ViewState> }
+     * @tutorial Platform.getViewSnapshot
+     */
+    async getViewSnapshot(viewIdentity) {
+        const client = await this.getClient();
+        return client.dispatch('get-view-snapshot', { viewIdentity });
+    }
     /**
      * Adds a snapshot to a running Platform.
      * Requested snapshot must be a valid Snapshot object, or a url or filepath to such an object.

package/src/api/platform/layout/utils/bounds-observer.d.ts

@@ -16,4 +16,4 @@ export declare const isDomRectEqual: (a: DOMRect, b: DOMRect) => boolean;
  * @returns Function which disposes the observers when invoked.
  * @ignore
  */
-export declare const observeBounds: (element: Element, onChange: (bounds: DOMRect) => void) => () => void;
+export declare const observeBounds: (element: Element, onChange: (bounds: DOMRect) => Promise<void> | void) => (() => void);

package/src/api/platform/layout/utils/bounds-observer.js

@@ -32,11 +32,11 @@ exports.isDomRectEqual = isDomRectEqual;
  */
 const observeBounds = (element, onChange) => {
     let lastBounds;
-    const checkBounds = () => {
+    const checkBounds = async () => {
         const currentBounds = element.getBoundingClientRect();
         if (!lastBounds || !(0, exports.isDomRectEqual)(lastBounds, currentBounds)) {
             lastBounds = currentBounds;
-            onChange(element.getBoundingClientRect());
+            await onChange(element.getBoundingClientRect());
         }
     };
     const resizeObserver = new ResizeObserver(() => checkBounds());