@openfin/core 30.73.20 → 30.73.22

package/src/api/interop/fdc3/fdc3-2.0.js

@@ -181,7 +181,7 @@ class Fdc3Module2 extends base_1.Base {
      * Find all the available instances for a particular application.
      * @param { AppIdentifier } app
      * @returns { Promise<Array<AppIdentifier>> }
-     * @tutorial fdc3v2.findInstances
+     * @tutorial findInstances
      */
     async findInstances(app) {
         this.wire.sendAction('fdc3-find-instances').catch((e) => {
@@ -199,7 +199,7 @@ class Fdc3Module2 extends base_1.Base {
      * Retrieves the AppMetadata for an AppIdentifier, which provides additional metadata (such as icons, a title and description) from the App Directory record for the application, that may be used for display purposes.
      * @param { AppIdentifier } app
      * @returns { Promise<AppMetadata(2)> }
-     * @tutorial fdc3v2.getAppMetadata
+     * @tutorial getAppMetadata
      */
     async getAppMetadata(app) {
         this.wire.sendAction('fdc3-get-app-metadata').catch((e) => {
@@ -277,7 +277,7 @@ class Fdc3Module2 extends base_1.Base {
      * @param { Context } context
      * @param { string } [resultType] The type of result returned for any intent specified during resolution.
      * @returns { Promise<Array<AppIntent(2)>> }
-     * @tutorial fdc3v2.findIntentsByContext
+     * @tutorial findIntentsByContext
      */
     async findIntentsByContext(context, resultType) {
         this.wire.sendAction('fdc3-find-intents-by-context').catch((e) => {
@@ -298,7 +298,7 @@ class Fdc3Module2 extends base_1.Base {
      * @param { Context } context Context associated with the Intent
      * @param { AppIdentifier | TargetApp } [app]
      * @returns { Promise<IntentResolution(2)> }
-     * @tutorial fdc3v2.raiseIntent
+     * @tutorial raiseIntent
      */
     async raiseIntent(intent, context, app) {
         this.wire.sendAction('fdc3-raise-intent').catch((e) => {
@@ -317,7 +317,7 @@ class Fdc3Module2 extends base_1.Base {
      * @param { Context } context Context associated with the Intent
      * @param { AppIdentifier | TargetApp } [app]
      * @returns { Promise<IntentResolution(2)> }
-     * @tutorial fdc3v2.raiseIntentForContext
+     * @tutorial raiseIntentForContext
      */
     async raiseIntentForContext(context, app) {
         // TODO: We have to do the same thing we do for raiseIntent here as well.
@@ -385,7 +385,7 @@ class Fdc3Module2 extends base_1.Base {
     /**
      * Returns a Channel with an auto-generated identity that is intended for private communication between applications. Primarily used to create channels that will be returned to other applications via an IntentResolution for a raised intent.
      * @returns { Promise<PrivateChannel> }
-     * @tutorial fdc3v2.createPrivateChannel
+     * @tutorial createPrivateChannel
      */
     async createPrivateChannel() {
         const channelId = (0, utils_1.generateId)();
@@ -398,7 +398,7 @@ class Fdc3Module2 extends base_1.Base {
     /**
      * Retrieves a list of the User Channels available for the app to join.
      * @returns { Promise<Channel[]>}
-     * @tutorial fdc3v2.getUserChannels
+     * @tutorial getUserChannels
      */
     async getUserChannels() {
         const channels = await this.fin.me.interop.getContextGroups();
@@ -422,7 +422,7 @@ class Fdc3Module2 extends base_1.Base {
      * Join an app to a specified User channel.
      * @param { string } channelId Channel name
      * @returns { Promise<void> }
-     * @tutorial fdc3v2.joinUserChannel
+     * @tutorial joinUserChannel
      */
     async joinUserChannel(channelId) {
         return this.fdc3Module.joinChannel(channelId);
@@ -457,7 +457,7 @@ class Fdc3Module2 extends base_1.Base {
      * Retrieves information about the FDC3 implementation, including the supported version of the FDC3 specification, the name of the provider of the implementation, its own version number, details of whether optional API features are implemented and the metadata of the calling application according to the desktop agent.
      * fdc3HandleGetInfo must be overridden in the InteropBroker so that the ImplementationMetadata will have the appMetadata info.
      * @returns { Promise<ImplementationMetadata(2)> }
-     * @tutorial fdc3v2.getInfo
+     * @tutorial getInfo
      */
     async getInfo() {
         return InteropClient_1.InteropClient.ferryFdc3Call(this.fin.me.interop, 'fdc3v2GetInfo', { fdc3Version: '2.0' });

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

@@ -0,0 +1,13 @@
+import Fdc3Module from './fdc3-1.2';
+import Fdc3Module2 from './fdc3-2.0';
+import type Transport from '../../../transport/transport';
+declare global {
+    interface Window {
+        fdc3: Fdc3Module | Fdc3Module2;
+    }
+}
+declare type Fdc3Versions = '1.2' | '2.0';
+export declare const versionMap: Record<Fdc3Versions, typeof Fdc3Module | typeof Fdc3Module2>;
+export declare function registerFdc3Shim(version: string, transport: Transport): void;
+export declare function getFdc3(transport: Transport, version?: Fdc3Versions): Fdc3Module | Fdc3Module2;
+export {};

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,75 @@
+import * as OpenFin from '../../../../OpenFin';
+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,10 +1,11 @@
-import { FDC3, FDC3v2 } from '../../../../fdc3';
+import { TargetApp } from './shapes/fdc3v1';
+import { AppIdentifier, IntentResolution, Channel, PrivateChannel, Context } from './shapes/fdc3v2';
 import * as OpenFin from '../../../OpenFin';
 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 {
@@ -20,8 +21,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/platform/Instance.d.ts

@@ -4,7 +4,7 @@ import { EmitterBase } from '../base';
 import { Channel } from '../interappbus/channel/index';
 import ChannelClient from '../interappbus/channel/client';
 import { LayoutModule } from './layout';
-import PlatformEvents = OpenFin.PlatformEvents;
+declare type PlatformEvents = OpenFin.PlatformEvents;
 /** Manages the life cycle of windows and views in the application.
  *
  * Enables taking snapshots of itself and applying them to restore a previous configuration
@@ -65,6 +65,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.
@@ -133,3 +145,4 @@ export declare class Platform extends EmitterBase<PlatformEvents> {
         skipBeforeUnload: boolean;
     }): Promise<void>;
 }
+export {};

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());