@openfin/core 25.68.30 → 25.70.2

package/src/mock.js

@@ -1,90 +1,91 @@
-"use strict";
-var _a;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fin = void 0;
-/* eslint-disable import/prefer-default-export */
-/* eslint-disable spaced-comment */
-/* eslint-disable @typescript-eslint/triple-slash-reference */
-/* eslint-disable @typescript-eslint/explicit-function-return-type */
-/* eslint-disable class-methods-use-this */
-/// <reference path="../OpenFin.d.ts"/>
-const events_1 = require("events");
-const fin_1 = require("./api/fin");
-const transport_1 = require("./transport/transport");
-class MockWire extends events_1.EventEmitter {
-    connect(address) {
-        throw new Error('You are not running in OpenFin.');
-    }
-    connectSync() {
-        throw new Error('You are not running in OpenFin.');
-    }
-    send(data) {
-        throw new Error('You are not running in OpenFin.');
-    }
-    shutdown() {
-        throw new Error('You are not running in OpenFin.');
-    }
-    // eslint-disable-next-line no-useless-constructor
-    constructor() {
-        super();
-    }
-}
-class MockEnvironment {
-    constructor() {
-        this.childViews = true;
-    }
-    getDefaultChannelOptions() {
-        throw new Error('Method not implemented.');
-    }
-    getRtcPeer() {
-        throw new Error('Method not implemented.');
-    }
-    getManagerConstructor() {
-        throw new Error('Method not implemented.');
-    }
-    getProviderInitializer() {
-        throw new Error('Method not implemented.');
-    }
-    writeToken(path, token) {
-        throw new Error('Method not implemented.');
-    }
-    retrievePort(config) {
-        throw new Error('Method not implemented.');
-    }
-    getNextMessageId() {
-        throw new Error('Method not implemented.');
-    }
-    getRandomId() {
-        throw new Error('Method not implemented.');
-    }
-    createChildContent(options) {
-        throw new Error('Method not implemented.');
-    }
-    getWebWindow(identity) {
-        throw new Error('Method not implemented.');
-    }
-    getCurrentEntityIdentity() {
-        throw new Error('Method not implemented.');
-    }
-    getCurrentEntityType() {
-        return 'unknown';
-    }
-    raiseEvent(eventName, eventArgs) {
-        throw new Error('Method not implemented.');
-    }
-    getUrl() {
-        throw new Error('Method not implemented.');
-    }
-    whenReady() {
-        throw new Error('Method not implemented.');
-    }
-}
-exports.fin = ((typeof window !== 'undefined' && ((_a = window) === null || _a === void 0 ? void 0 : _a.fin)) ||
-    (() => {
-        const environment = new MockEnvironment();
-        const transport = new transport_1.default(MockWire, environment, {
-            uuid: '',
-            name: ''
-        });
-        return new fin_1.default(transport);
-    })());
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fin = void 0;
+/* eslint-disable import/prefer-default-export */
+/* eslint-disable spaced-comment */
+/* eslint-disable @typescript-eslint/triple-slash-reference */
+/* eslint-disable @typescript-eslint/explicit-function-return-type */
+/* eslint-disable class-methods-use-this */
+/// <reference path="../OpenFin.d.ts"/>
+const events_1 = require("events");
+const fin_1 = require("./api/fin");
+const transport_1 = require("./transport/transport");
+const me_1 = require("./api/me");
+class MockWire extends events_1.EventEmitter {
+    connect(address) {
+        throw new Error('You are not running in OpenFin.');
+    }
+    connectSync() {
+        throw new Error('You are not running in OpenFin.');
+    }
+    send(data) {
+        throw new Error('You are not running in OpenFin.');
+    }
+    shutdown() {
+        throw new Error('You are not running in OpenFin.');
+    }
+    // eslint-disable-next-line no-useless-constructor
+    constructor() {
+        super();
+    }
+}
+class MockEnvironment {
+    constructor() {
+        this.childViews = true;
+    }
+    getDefaultChannelOptions() {
+        throw new Error(me_1.environmentUnsupportedMessage);
+    }
+    getRtcPeer() {
+        throw new Error(me_1.environmentUnsupportedMessage);
+    }
+    getManagerConstructor() {
+        throw new Error(me_1.environmentUnsupportedMessage);
+    }
+    getProviderInitializer() {
+        throw new Error(me_1.environmentUnsupportedMessage);
+    }
+    writeToken(path, token) {
+        throw new Error(me_1.environmentUnsupportedMessage);
+    }
+    retrievePort(config) {
+        throw new Error(me_1.environmentUnsupportedMessage);
+    }
+    getNextMessageId() {
+        throw new Error(me_1.environmentUnsupportedMessage);
+    }
+    getRandomId() {
+        throw new Error(me_1.environmentUnsupportedMessage);
+    }
+    createChildContent(options) {
+        throw new Error(me_1.environmentUnsupportedMessage);
+    }
+    getWebWindow(identity) {
+        throw new Error(me_1.environmentUnsupportedMessage);
+    }
+    getCurrentEntityIdentity() {
+        throw new Error(me_1.environmentUnsupportedMessage);
+    }
+    getCurrentEntityType() {
+        return 'unknown';
+    }
+    raiseEvent(eventName, eventArgs) {
+        throw new Error(me_1.environmentUnsupportedMessage);
+    }
+    getUrl() {
+        throw new Error(me_1.environmentUnsupportedMessage);
+    }
+    whenReady() {
+        throw new Error(me_1.environmentUnsupportedMessage);
+    }
+}
+exports.fin = ((typeof window !== 'undefined' && ((_a = window) === null || _a === void 0 ? void 0 : _a.fin)) ||
+    (() => {
+        const environment = new MockEnvironment();
+        const transport = new transport_1.default(MockWire, environment, {
+            uuid: '',
+            name: ''
+        });
+        return new fin_1.default(transport);
+    })());

package/src/shapes/ERROR_BOX_TYPES.d.ts

@@ -0,0 +1 @@
+export declare type ERROR_BOX_TYPES = 'OF_error_box:app_initialization' | 'OF_error_box:main_process' | 'OF_error_box:renderer_crash';

package/src/shapes/ERROR_BOX_TYPES.js

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

package/src/shapes/WebOptions.d.ts

@@ -0,0 +1,12 @@
+export interface WebOptions {
+    preloadScripts?: OpenFin.PreloadScript[];
+    uuid: string;
+    name: string;
+    contentCreation?: OpenFin.ContentCreationOptions;
+    contentRedirect?: Partial<OpenFin.ContentRedirect>;
+    customContext?: any;
+    experimental?: any;
+    processAffinity?: string;
+    backgroundThrottling?: boolean;
+    interop?: OpenFin.InteropConfig;
+}

package/src/shapes/WebOptions.js

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

package/src/shapes/WindowOptions.d.ts

@@ -0,0 +1,42 @@
+import { ERROR_BOX_TYPES } from './ERROR_BOX_TYPES';
+import { WebOptions } from './WebOptions';
+export interface WindowOptions extends Partial<OpenFin.WindowOptions>, Partial<WindowInternalOptions> {
+    name: string;
+    uuid: string;
+}
+export interface WindowInternalOptions extends WebOptions {
+    'alwaysOnBottom': boolean;
+    'appLogFlushInterval': number;
+    'center': boolean;
+    'description': string;
+    'disableIabSecureLogging': boolean;
+    'draggable': boolean;
+    'enableAppLogging': boolean;
+    'enable-plugins': boolean;
+    'enableLargerThanScreen': boolean;
+    'exitOnClose': boolean;
+    'experimental': any;
+    'hasLoaded': boolean;
+    'hideOnBlur': boolean;
+    'hideOnClose': boolean;
+    'hideWhileChildrenVisible': boolean;
+    'isRawWindowOpen': boolean;
+    'launchExternal': string;
+    'loadErrorMessage': string;
+    'nonPersistent': boolean;
+    'nonPersistant': boolean;
+    'plugins': boolean;
+    'preload': string | OpenFin.PreloadScript[];
+    'resize': boolean;
+    'show': boolean;
+    'skipTaskbar': boolean;
+    'taskbarIcon': string;
+    'title': string;
+    'toShowOnRun': boolean;
+    'transparent': boolean;
+    '_type': ERROR_BOX_TYPES;
+    'webPreferences': {
+        nodeIntegration: boolean;
+        plugins: boolean;
+    };
+}

package/src/shapes/WindowOptions.js

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

package/src/shapes/protocol.d.ts

@@ -0,0 +1,178 @@
+import { AuthorizationPayload } from '../transport/transport';
+export interface ProtocolMap extends ProtocolMapBase {
+    'request-external-authorization': {
+        request: any;
+        response: void;
+        specialResponse: AuthorizationPayload;
+    };
+    'application-get-views': {
+        request: OpenFin.ApplicationIdentity;
+        response: OpenFin.Identity[];
+    };
+    'set-jump-list': {
+        request: {
+            config: OpenFin.JumpListCategory[] | null;
+        } & OpenFin.ApplicationIdentity;
+        response: void;
+    };
+    'get-view-window': {
+        request: OpenFin.Identity;
+        response: OpenFin.Identity;
+    };
+    'window-get-views': {
+        request: OpenFin.Identity;
+        response: OpenFin.Identity[];
+    };
+    'hide-view': {
+        request: OpenFin.Identity;
+        response: void;
+    };
+    'launch-manifest': {
+        request: {
+            manifestUrl: string;
+            opts?: OpenFin.RvmLaunchOptions;
+        };
+        response: {
+            manifest: OpenFin.Manifest;
+        };
+    };
+    'get-system-app-configuration': {
+        request: {
+            name: string;
+        };
+        response: any;
+    };
+    'show-popup-menu': {
+        request: OpenFin.Identity & {
+            options: OpenFin.ShowPopupMenuOptions;
+        };
+        response: OpenFin.MenuResult;
+    };
+    'enable-native-window-integration-provider': {
+        request: {
+            permissions: any;
+        };
+        response: OpenFin.NativeWindowIntegrationProviderAuthorization;
+    };
+    'get-permissions': {
+        request: void;
+        response: any;
+    };
+    'set-file-download-location': {
+        request: OpenFin.ApplicationIdentity & {
+            downloadLocation: string;
+        };
+        response: void;
+    };
+    'close-popup-menu': {
+        request: OpenFin.Identity;
+        response: void;
+    };
+    'fdc3-add-context-listener': {
+        request: void;
+        response: void;
+    };
+    'fdc3-broadcast': {
+        request: void;
+        response: void;
+    };
+    'fdc3-get-system-channels': {
+        request: void;
+        response: void;
+    };
+    'fdc3-join-channel': {
+        request: void;
+        response: void;
+    };
+    'fdc3-leave-current-channel': {
+        request: void;
+        response: void;
+    };
+    'interop-connect-sync': {
+        request: void;
+        response: void;
+    };
+    'interop-client-set-context': {
+        request: void;
+        response: void;
+    };
+    'interop-client-add-context-handler': {
+        request: void;
+        response: void;
+    };
+    'interop-client-get-context-groups': {
+        request: void;
+        response: void;
+    };
+    'interop-client-join-context-group': {
+        request: void;
+        response: void;
+    };
+    'interop-client-remove-from-context-group': {
+        request: void;
+        response: void;
+    };
+    'interop-client-get-all-clients-in-context-group': {
+        request: void;
+        response: void;
+    };
+    'interop-client-get-info-for-context-group': {
+        request: void;
+        response: void;
+    };
+    'interop-broker-add-client-to-context-group': {
+        request: void;
+        response: void;
+    };
+    'interop-broker-get-all-clients-in-context-group': {
+        request: void;
+        response: void;
+    };
+    'interop-broker-get-context-groups': {
+        request: void;
+        response: void;
+    };
+    'interop-broker-get-info-for-context-group': {
+        request: void;
+        response: void;
+    };
+    'interop-broker-is-action-authorized': {
+        request: void;
+        response: void;
+    };
+    'interop-broker-is-connection-authorized': {
+        request: void;
+        response: void;
+    };
+    'interop-broker-join-context-group': {
+        request: void;
+        response: void;
+    };
+    'interop-broker-remove-client-from-context-group': {
+        request: void;
+        response: void;
+    };
+    'interop-broker-remove-from-context-group': {
+        request: void;
+        response: void;
+    };
+    'interop-broker-set-context': {
+        request: void;
+        response: void;
+    };
+    'query-permission-for-current-context': {
+        request: {
+            apiName: string;
+            identity: OpenFin.Identity;
+        };
+        response: OpenFin.QueryPermissionResult;
+    };
+}
+interface ProtocolMapBase {
+    [action: string]: {
+        request: any;
+        response: any;
+        specialResponse?: any;
+    };
+}
+export {};

package/src/shapes/protocol.js

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

package/src/transport/fin_store.d.ts

@@ -1,4 +1,4 @@
-import Fin from '../api/fin';
-import Transport from './transport';
-export declare function registerFin(wire: Transport, fin: Fin): void;
-export declare function getFin(wire: Transport): Fin;
+import Fin from '../api/fin';
+import Transport from './transport';
+export declare function registerFin(wire: Transport, fin: Fin): void;
+export declare function getFin(wire: Transport): Fin;

package/src/transport/fin_store.js

@@ -1,16 +1,16 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFin = exports.registerFin = void 0;
-const finMap = new WeakMap();
-function registerFin(wire, fin) {
-    finMap.set(wire, fin);
-}
-exports.registerFin = registerFin;
-function getFin(wire) {
-    const fin = finMap.get(wire);
-    if (!fin) {
-        throw new Error('Could not locate fin api for given transport');
-    }
-    return fin;
-}
-exports.getFin = getFin;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFin = exports.registerFin = void 0;
+const finMap = new WeakMap();
+function registerFin(wire, fin) {
+    finMap.set(wire, fin);
+}
+exports.registerFin = registerFin;
+function getFin(wire) {
+    const fin = finMap.get(wire);
+    if (!fin) {
+        throw new Error('Could not locate fin api for given transport');
+    }
+    return fin;
+}
+exports.getFin = getFin;

package/src/transport/transport-errors.d.ts

@@ -1,18 +1,18 @@
-import ReadyState = OpenFin.ReadyState;
-export declare class DisconnectedError extends Error {
-    constructor(readyState: ReadyState);
-    readyState: ReadyState;
-}
-export declare class UnexpectedActionError extends Error {
-}
-export declare class DuplicateCorrelationError extends Error {
-}
-export declare class NoAckError extends Error {
-}
-export declare class NotImplementedError extends Error {
-}
-export declare class NotSupportedError extends Error {
-}
-export declare class RuntimeError extends Error {
-    constructor(data: any);
-}
+export declare type ReadyState = 'CONNECTING' | 'OPEN' | 'CLOSING' | 'CLOSED';
+export declare class DisconnectedError extends Error {
+    constructor(readyState: ReadyState);
+    readyState: ReadyState;
+}
+export declare class UnexpectedActionError extends Error {
+}
+export declare class DuplicateCorrelationError extends Error {
+}
+export declare class NoAckError extends Error {
+}
+export declare class NotImplementedError extends Error {
+}
+export declare class NotSupportedError extends Error {
+}
+export declare class RuntimeError extends Error {
+    constructor(data: any);
+}

package/src/transport/transport-errors.js

@@ -1,37 +1,37 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RuntimeError = exports.NotSupportedError = exports.NotImplementedError = exports.NoAckError = exports.DuplicateCorrelationError = exports.UnexpectedActionError = exports.DisconnectedError = void 0;
-class DisconnectedError extends Error {
-    constructor(readyState) {
-        super(`Expected websocket state OPEN but found ${readyState}`);
-        this.readyState = readyState;
-    }
-}
-exports.DisconnectedError = DisconnectedError;
-class UnexpectedActionError extends Error {
-}
-exports.UnexpectedActionError = UnexpectedActionError;
-class DuplicateCorrelationError extends Error {
-}
-exports.DuplicateCorrelationError = DuplicateCorrelationError;
-class NoAckError extends Error {
-}
-exports.NoAckError = NoAckError;
-class NotImplementedError extends Error {
-}
-exports.NotImplementedError = NotImplementedError;
-class NotSupportedError extends Error {
-}
-exports.NotSupportedError = NotSupportedError;
-class RuntimeError extends Error {
-    constructor(data) {
-        const payload = data.payload || data;
-        const { reason, error } = payload;
-        super(reason);
-        this.name = 'RuntimeError';
-        if (error === null || error === void 0 ? void 0 : error.stack) {
-            this.stack = error.stack;
-        }
-    }
-}
-exports.RuntimeError = RuntimeError;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RuntimeError = exports.NotSupportedError = exports.NotImplementedError = exports.NoAckError = exports.DuplicateCorrelationError = exports.UnexpectedActionError = exports.DisconnectedError = void 0;
+class DisconnectedError extends Error {
+    constructor(readyState) {
+        super(`Expected websocket state OPEN but found ${readyState}`);
+        this.readyState = readyState;
+    }
+}
+exports.DisconnectedError = DisconnectedError;
+class UnexpectedActionError extends Error {
+}
+exports.UnexpectedActionError = UnexpectedActionError;
+class DuplicateCorrelationError extends Error {
+}
+exports.DuplicateCorrelationError = DuplicateCorrelationError;
+class NoAckError extends Error {
+}
+exports.NoAckError = NoAckError;
+class NotImplementedError extends Error {
+}
+exports.NotImplementedError = NotImplementedError;
+class NotSupportedError extends Error {
+}
+exports.NotSupportedError = NotSupportedError;
+class RuntimeError extends Error {
+    constructor(data) {
+        const payload = data.payload || data;
+        const { reason, error } = payload;
+        super(reason);
+        this.name = 'RuntimeError';
+        if (error === null || error === void 0 ? void 0 : error.stack) {
+            this.stack = error.stack;
+        }
+    }
+}
+exports.RuntimeError = RuntimeError;