@openfin/core 25.68.30 → 25.70.2

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

@@ -1,17 +1,17 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.registerFdc3Shim = exports.versionMap = void 0;
-const fdc3_1_2_1 = require("./fdc3-1.2");
-exports.versionMap = {
-    '1.2': fdc3_1_2_1.default
-};
-function registerFdc3Shim(version, transport) {
-    if (Object.keys(exports.versionMap).includes(version)) {
-        const Api = exports.versionMap[version];
-        window.fdc3 = new Api(transport);
-    }
-    else {
-        console.error(`FDC3 API version ${version} is not supported`);
-    }
-}
-exports.registerFdc3Shim = registerFdc3Shim;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerFdc3Shim = exports.versionMap = void 0;
+const fdc3_1_2_1 = require("./fdc3-1.2");
+exports.versionMap = {
+    '1.2': fdc3_1_2_1.default
+};
+function registerFdc3Shim(version, transport) {
+    if (Object.keys(exports.versionMap).includes(version)) {
+        const Api = exports.versionMap[version];
+        window.fdc3 = new Api(transport);
+    }
+    else {
+        console.error(`FDC3 API version ${version} is not supported`);
+    }
+}
+exports.registerFdc3Shim = registerFdc3Shim;

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

@@ -1,6 +1,6 @@
-export declare class UnsupportedError extends Error {
-    constructor(apiName: string);
-}
-export declare class UnsupportedChannelApiError extends Error {
-    constructor(apiName: string);
-}
+export declare class UnsupportedError extends Error {
+    constructor(apiName: string);
+}
+export declare class UnsupportedChannelApiError extends Error {
+    constructor(apiName: string);
+}

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

@@ -1,17 +1,17 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UnsupportedChannelApiError = exports.UnsupportedError = void 0;
-class UnsupportedError extends Error {
-    constructor(apiName) {
-        super(apiName);
-        this.message = `${apiName} is not a supported API`;
-    }
-}
-exports.UnsupportedError = UnsupportedError;
-class UnsupportedChannelApiError extends Error {
-    constructor(apiName) {
-        super(apiName);
-        this.message = `Calling ${apiName} on an instance of a System Channel returned by fdc3.getSystemChannels is not supported. If you would like to use a System Channel, please use fdc3.joinChannel, fdc3.addContextListener, and fdc3.broadcast instead.`;
-    }
-}
-exports.UnsupportedChannelApiError = UnsupportedChannelApiError;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnsupportedChannelApiError = exports.UnsupportedError = void 0;
+class UnsupportedError extends Error {
+    constructor(apiName) {
+        super(apiName);
+        this.message = `${apiName} is not a supported API`;
+    }
+}
+exports.UnsupportedError = UnsupportedError;
+class UnsupportedChannelApiError extends Error {
+    constructor(apiName) {
+        super(apiName);
+        this.message = `Calling ${apiName} on an instance of a System Channel returned by fdc3.getSystemChannels is not supported. If you would like to use a System Channel, please use fdc3.joinChannel, fdc3.addContextListener, and fdc3.broadcast instead.`;
+    }
+}
+exports.UnsupportedChannelApiError = UnsupportedChannelApiError;

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

@@ -1,4 +1,4 @@
-import InteropModule from './Factory';
-export default InteropModule;
-export * from './InteropClient';
-export * from './InteropBroker';
+import InteropModule from './Factory';
+export default InteropModule;
+export * from './InteropClient';
+export * from './InteropBroker';

package/src/api/interop/index.js

@@ -1,16 +1,16 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
-}
-Object.defineProperty(exports, "__esModule", { value: true });
-const Factory_1 = require("./Factory");
-exports.default = Factory_1.default;
-__exportStar(require("./InteropClient"), exports);
-__exportStar(require("./InteropBroker"), exports);
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
+}
+Object.defineProperty(exports, "__esModule", { value: true });
+const Factory_1 = require("./Factory");
+exports.default = Factory_1.default;
+__exportStar(require("./InteropClient"), exports);
+__exportStar(require("./InteropBroker"), exports);

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

@@ -1,11 +1,11 @@
-export declare const generateId: () => string;
-export declare const wrapInTryCatch: <T>(f: (...args: any[]) => T, prefix?: string) => (...args: any[]) => T;
-export declare const wrapContextHandler: (handler: OpenFin.ContextHandler, handlerId: string) => (context: OpenFin.Context) => Promise<void>;
-export declare const generateOverrideError: (clientApi: string, brokerApi: string) => string;
-export declare const generateOverrideWarning: (interopClientApi: string, fdc3ClientApi: string, brokerApi: string, identity: OpenFin.ClientIdentity) => string;
-export declare const BROKER_ERRORS: {
-    fireIntent: string;
-    fireIntentForContext: string;
-    getInfoForIntent: string;
-    getInfoForIntentsByContext: string;
-};
+export declare const generateId: () => string;
+export declare const wrapInTryCatch: <T>(f: (...args: any[]) => T, prefix?: string) => (...args: any[]) => T;
+export declare const wrapContextHandler: (handler: OpenFin.ContextHandler, handlerId: string) => (context: OpenFin.Context) => Promise<void>;
+export declare const generateOverrideError: (clientApi: string, brokerApi: string) => string;
+export declare const generateOverrideWarning: (interopClientApi: string, fdc3ClientApi: string, brokerApi: string, identity: OpenFin.ClientIdentity) => string;
+export declare const BROKER_ERRORS: {
+    fireIntent: string;
+    fireIntentForContext: string;
+    getInfoForIntent: string;
+    getInfoForIntentsByContext: string;
+};

package/src/api/interop/utils.js

@@ -1,36 +1,36 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BROKER_ERRORS = exports.generateOverrideWarning = exports.generateOverrideError = exports.wrapContextHandler = exports.wrapInTryCatch = exports.generateId = void 0;
-exports.generateId = () => `${Math.random()}${Date.now()}`;
-exports.wrapInTryCatch = (f, prefix) => (...args) => {
-    try {
-        return f(...args);
-    }
-    catch (e) {
-        throw new Error((prefix || '') + e);
-    }
-};
-exports.wrapContextHandler = (handler, handlerId) => {
-    return async (context) => {
-        try {
-            await handler(context);
-        }
-        catch (error) {
-            console.error(`Error thrown by handler ${handlerId} for context type ${context.type}: ${error}`);
-            throw error;
-        }
-    };
-};
-exports.generateOverrideError = (clientApi, brokerApi) => {
-    return `You have tried to to use ${clientApi} but ${brokerApi} has not been overridden in the Interop Broker. Please override this function. Refer to our documentation for more info.`;
-};
-exports.generateOverrideWarning = (interopClientApi, fdc3ClientApi, brokerApi, identity) => {
-    const { uuid, name } = identity;
-    return `Entity with identity: ${uuid}/${name} has called ${interopClientApi} or ${fdc3ClientApi} but ${brokerApi} has not been overridden.`;
-};
-exports.BROKER_ERRORS = {
-    fireIntent: exports.generateOverrideError('fireIntent', 'handleFiredIntent'),
-    fireIntentForContext: exports.generateOverrideError('fireIntentForContext', 'handleFiredIntentForContext'),
-    getInfoForIntent: exports.generateOverrideError('getInfoForIntent', 'handleInfoForIntent'),
-    getInfoForIntentsByContext: exports.generateOverrideError('getInfoForIntentsByContext', 'handleInfoForIntentsByContext')
-};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BROKER_ERRORS = exports.generateOverrideWarning = exports.generateOverrideError = exports.wrapContextHandler = exports.wrapInTryCatch = exports.generateId = void 0;
+exports.generateId = () => `${Math.random()}${Date.now()}`;
+exports.wrapInTryCatch = (f, prefix) => (...args) => {
+    try {
+        return f(...args);
+    }
+    catch (e) {
+        throw new Error((prefix || '') + e);
+    }
+};
+exports.wrapContextHandler = (handler, handlerId) => {
+    return async (context) => {
+        try {
+            await handler(context);
+        }
+        catch (error) {
+            console.error(`Error thrown by handler ${handlerId} for context type ${context.type}: ${error}`);
+            throw error;
+        }
+    };
+};
+exports.generateOverrideError = (clientApi, brokerApi) => {
+    return `You have tried to to use ${clientApi} but ${brokerApi} has not been overridden in the Interop Broker. Please override this function. Refer to our documentation for more info.`;
+};
+exports.generateOverrideWarning = (interopClientApi, fdc3ClientApi, brokerApi, identity) => {
+    const { uuid, name } = identity;
+    return `Entity with identity: ${uuid}/${name} has called ${interopClientApi} or ${fdc3ClientApi} but ${brokerApi} has not been overridden.`;
+};
+exports.BROKER_ERRORS = {
+    fireIntent: exports.generateOverrideError('fireIntent', 'handleFiredIntent'),
+    fireIntentForContext: exports.generateOverrideError('fireIntentForContext', 'handleFiredIntentForContext'),
+    getInfoForIntent: exports.generateOverrideError('getInfoForIntent', 'handleInfoForIntent'),
+    getInfoForIntentsByContext: exports.generateOverrideError('getInfoForIntentsByContext', 'handleInfoForIntentsByContext')
+};

package/src/api/me.d.ts

@@ -1,35 +1,38 @@
-import Transport from '../transport/transport';
-import type { InteropClient } from './interop';
-import EntityType = OpenFin.EntityType;
-export declare type EntityTypeHelpers<T extends EntityType> = T extends 'view' ? {
-    isView: true;
-    isWindow: false;
-    isExternal: false;
-    isFrame: false;
-} : T extends 'window' ? {
-    isView: false;
-    isWindow: true;
-    isExternal: false;
-    isFrame: false;
-} : T extends 'iframe' ? {
-    isView: false;
-    isWindow: false;
-    isExternal: false;
-    isFrame: true;
-} : T extends 'external connection' ? {
-    isView: false;
-    isWindow: false;
-    isExternal: true;
-    isFrame: false;
-} : T extends 'unknown' ? {
-    isView: false;
-    isWindow: false;
-    isExternal: false;
-    isFrame: false;
-} : never;
-export declare function getBaseMe<T extends EntityType = EntityType>(entityType: T, uuid: string, name: string): OpenFin.EntityInfo & EntityTypeHelpers<T>;
-export interface WithInterop {
-    interop: InteropClient;
-}
-export declare type Me<MeType extends EntityType> = OpenFin.EntityInfo & (MeType extends 'view' ? EntityTypeHelpers<'view'> & OpenFin.View & WithInterop : MeType extends 'window' ? EntityTypeHelpers<'window'> & OpenFin.Window & WithInterop : MeType extends 'iframe' ? EntityTypeHelpers<'iframe'> & OpenFin.Frame & WithInterop : EntityTypeHelpers<MeType> & WithInterop);
-export declare function getMe<MeType extends EntityType>(wire: Transport<MeType>): Me<MeType>;
+import type Transport from '../transport/transport';
+import type { InteropClient } from './interop';
+export declare const environmentUnsupportedMessage = "You are not running in OpenFin.";
+import EntityType = OpenFin.EntityType;
+export declare type EntityTypeHelpers<T extends EntityType> = T extends 'view' ? {
+    isView: true;
+    isWindow: false;
+    isExternal: false;
+    isFrame: false;
+} : T extends 'window' ? {
+    isView: false;
+    isWindow: true;
+    isExternal: false;
+    isFrame: false;
+} : T extends 'iframe' ? {
+    isView: false;
+    isWindow: false;
+    isExternal: false;
+    isFrame: true;
+} : T extends 'external connection' ? {
+    isView: false;
+    isWindow: false;
+    isExternal: true;
+    isFrame: false;
+} : T extends 'unknown' ? {
+    isView: false;
+    isWindow: false;
+    isExternal: false;
+    isFrame: false;
+} : never;
+export declare function getBaseMe<T extends EntityType = EntityType>(entityType: T, uuid: string, name: string): OpenFin.EntityInfo & EntityTypeHelpers<T>;
+export interface WithInterop {
+    interop: InteropClient;
+}
+export declare type Me<MeType extends EntityType> = OpenFin.EntityInfo & (MeType extends 'view' ? EntityTypeHelpers<'view'> & OpenFin.View & WithInterop : MeType extends 'window' ? EntityTypeHelpers<'window'> & OpenFin.Window & WithInterop : MeType extends 'iframe' ? EntityTypeHelpers<'iframe'> & OpenFin.Frame & WithInterop : EntityTypeHelpers<MeType> & WithInterop) & {
+    isOpenFin: boolean;
+};
+export declare function getMe<MeType extends EntityType>(wire: Transport<MeType>): Me<MeType>;

package/src/api/me.js

@@ -1,60 +1,128 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getMe = exports.getBaseMe = void 0;
-const view_1 = require("./view");
-const frame_1 = require("./frame");
-const window_1 = require("./window");
-function getBaseMe(entityType, uuid, name) {
-    const entityTypeHelpers = {
-        isView: entityType === 'view',
-        isWindow: entityType === 'window',
-        isFrame: entityType === 'iframe',
-        isExternal: entityType === 'external connection'
-    };
-    return { ...entityTypeHelpers, uuid, name, entityType };
-}
-exports.getBaseMe = getBaseMe;
-// We need to do a lot of casting as unknown here because the compiler get's confused about matching types. What matters is that it works on the outside
-function getMe(wire) {
-    const { uuid, name, entityType } = wire.me;
-    const interopObject = {
-        setContext() {
-            throw new Error('Interop API has not been instantiated. Either connection has failed or you have not declared interop in your config.');
-        },
-        addContextHandler() {
-            throw new Error('Interop API has not been instantiated. Either connection has failed or you have not declared interop in your config.');
-        },
-        getContextGroups() {
-            throw new Error('Interop API has not been instantiated. Either connection has failed or you have not declared interop in your config.');
-        },
-        joinContextGroup() {
-            throw new Error('Interop API has not been instantiated. Either connection has failed or you have not declared interop in your config.');
-        },
-        removeFromContextGroup() {
-            throw new Error('Interop API has not been instantiated. Either connection has failed or you have not declared interop in your config.');
-        },
-        getAllClientsInContextGroup() {
-            throw new Error('Interop API has not been instantiated. Either connection has failed or you have not declared interop in your config.');
-        },
-        getInfoForContextGroup() {
-            throw new Error('Interop API has not been instantiated. Either connection has failed or you have not declared interop in your config.');
-        }
-    };
-    switch (entityType) {
-        case 'view':
-            return Object.assign(new view_1.View(wire, { uuid, name }), getBaseMe(entityType, uuid, name), {
-                interop: interopObject
-            });
-        case 'window':
-            return Object.assign(new window_1._Window(wire, { uuid, name }), getBaseMe(entityType, uuid, name), {
-                interop: interopObject
-            });
-        case 'iframe':
-            return Object.assign(new frame_1._Frame(wire, { uuid, name }), getBaseMe(entityType, uuid, name), {
-                interop: interopObject
-            });
-        default:
-            return { ...getBaseMe(entityType, uuid, name) };
-    }
-}
-exports.getMe = getMe;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMe = exports.getBaseMe = exports.environmentUnsupportedMessage = void 0;
+const view_1 = require("./view");
+const frame_1 = require("./frame");
+const window_1 = require("./window");
+exports.environmentUnsupportedMessage = 'You are not running in OpenFin.';
+function getBaseMe(entityType, uuid, name) {
+    const entityTypeHelpers = {
+        isView: entityType === 'view',
+        isWindow: entityType === 'window',
+        isFrame: entityType === 'iframe',
+        isExternal: entityType === 'external connection'
+    };
+    return { ...entityTypeHelpers, uuid, name, entityType };
+}
+exports.getBaseMe = getBaseMe;
+// We need to do a lot of casting as unknown here because the compiler get's confused about matching types. What matters is that it works on the outside
+function getMe(wire) {
+    const { uuid, name, entityType } = wire.me;
+    const unsupportedInterop = {
+        setContext() {
+            throw new Error(exports.environmentUnsupportedMessage);
+        },
+        addContextHandler() {
+            throw new Error(exports.environmentUnsupportedMessage);
+        },
+        getContextGroups() {
+            throw new Error(exports.environmentUnsupportedMessage);
+        },
+        joinContextGroup() {
+            throw new Error(exports.environmentUnsupportedMessage);
+        },
+        removeFromContextGroup() {
+            throw new Error(exports.environmentUnsupportedMessage);
+        },
+        getAllClientsInContextGroup() {
+            throw new Error(exports.environmentUnsupportedMessage);
+        },
+        getInfoForContextGroup() {
+            throw new Error(exports.environmentUnsupportedMessage);
+        }
+    };
+    const fallbackErrorMessage = 'Interop API has not been instantiated. Either connection has failed or you have not declared interop in your config.';
+    const fallbackInterop = {
+        setContext() {
+            throw new Error(fallbackErrorMessage);
+        },
+        addContextHandler() {
+            throw new Error(fallbackErrorMessage);
+        },
+        getContextGroups() {
+            throw new Error(fallbackErrorMessage);
+        },
+        joinContextGroup() {
+            throw new Error(fallbackErrorMessage);
+        },
+        removeFromContextGroup() {
+            throw new Error(fallbackErrorMessage);
+        },
+        getAllClientsInContextGroup() {
+            throw new Error(fallbackErrorMessage);
+        },
+        getInfoForContextGroup() {
+            throw new Error(fallbackErrorMessage);
+        }
+    };
+    const unsupportedEventBase = {
+        eventNames: () => {
+            throw new Error(exports.environmentUnsupportedMessage);
+        },
+        emit: () => {
+            throw new Error(exports.environmentUnsupportedMessage);
+        },
+        listeners: () => {
+            throw new Error(exports.environmentUnsupportedMessage);
+        },
+        listenerCount: () => {
+            throw new Error(exports.environmentUnsupportedMessage);
+        },
+        on: () => {
+            throw new Error(exports.environmentUnsupportedMessage);
+        },
+        addListener: () => {
+            throw new Error(exports.environmentUnsupportedMessage);
+        },
+        once: () => {
+            throw new Error(exports.environmentUnsupportedMessage);
+        },
+        prependListener: () => {
+            throw new Error(exports.environmentUnsupportedMessage);
+        },
+        prependOnceListener: () => {
+            throw new Error(exports.environmentUnsupportedMessage);
+        },
+        removeListener: () => {
+            throw new Error(exports.environmentUnsupportedMessage);
+        },
+        removeAllListeners: () => {
+            throw new Error(exports.environmentUnsupportedMessage);
+        }
+    };
+    switch (entityType) {
+        case 'view':
+            return Object.assign(new view_1.View(wire, { uuid, name }), getBaseMe(entityType, uuid, name), {
+                interop: fallbackInterop,
+                isOpenFin: true
+            });
+        case 'window':
+            return Object.assign(new window_1._Window(wire, { uuid, name }), getBaseMe(entityType, uuid, name), {
+                interop: fallbackInterop,
+                isOpenFin: true
+            });
+        case 'iframe':
+            return Object.assign(new frame_1._Frame(wire, { uuid, name }), getBaseMe(entityType, uuid, name), {
+                interop: fallbackInterop,
+                isOpenFin: true
+            });
+        default:
+            return {
+                ...getBaseMe(entityType, uuid, name),
+                ...unsupportedEventBase,
+                interop: unsupportedInterop,
+                isOpenFin: false
+            };
+    }
+}
+exports.getMe = getMe;