@openfin/core 30.73.5 → 30.73.7

package/src/namespaces.d.ts

@@ -0,0 +1,21 @@
+export * as OpenFin from './OpenFin';
+export * as Application from './api/application';
+export * as ExternalApplication from './api/external-application';
+export * as Frame from './api/frame';
+export * as Interop from './api/interop';
+export * as InteropBroker from './api/interop/InteropBroker';
+export * as InteropClient from './api/interop/InteropClient';
+export * as InterApplicationBus from './api/interappbus';
+export * as Channel from './api/interappbus/channel';
+export * as ChannelProvider from './api/interappbus/channel/provider';
+export * as ChannelClient from './api/interappbus/channel/client';
+export * as Platform from './api/platform';
+export * as PlatformProvider from './api/platform/provider';
+export * as Layout from './api/platform/layout';
+export * as View from './api/view';
+export * as Window from './api/window';
+export * as SnapshotSource from './api/snapshot-source';
+export * as GlobalHotkey from './api/global-hotkey';
+export * as Clipboard from './api/clipboard';
+export * as Fin from './api/fin';
+export * as System from './api/system';

package/src/namespaces.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.System = exports.Fin = exports.Clipboard = exports.GlobalHotkey = exports.SnapshotSource = exports.Window = exports.View = exports.Layout = exports.PlatformProvider = exports.Platform = exports.ChannelClient = exports.ChannelProvider = exports.Channel = exports.InterApplicationBus = exports.InteropClient = exports.InteropBroker = exports.Interop = exports.Frame = exports.ExternalApplication = exports.Application = exports.OpenFin = void 0;
+exports.OpenFin = require("./OpenFin");
+exports.Application = require("./api/application");
+exports.ExternalApplication = require("./api/external-application");
+exports.Frame = require("./api/frame");
+exports.Interop = require("./api/interop");
+exports.InteropBroker = require("./api/interop/InteropBroker");
+exports.InteropClient = require("./api/interop/InteropClient");
+exports.InterApplicationBus = require("./api/interappbus");
+exports.Channel = require("./api/interappbus/channel");
+exports.ChannelProvider = require("./api/interappbus/channel/provider");
+exports.ChannelClient = require("./api/interappbus/channel/client");
+exports.Platform = require("./api/platform");
+exports.PlatformProvider = require("./api/platform/provider");
+exports.Layout = require("./api/platform/layout");
+exports.View = require("./api/view");
+exports.Window = require("./api/window");
+exports.SnapshotSource = require("./api/snapshot-source");
+exports.GlobalHotkey = require("./api/global-hotkey");
+exports.Clipboard = require("./api/clipboard");
+exports.Fin = require("./api/fin");
+exports.System = require("./api/system");

package/src/shapes/WebOptions.d.ts

@@ -1,3 +1,4 @@
+import type * as OpenFin from '../OpenFin';
 export interface WebOptions {
     preloadScripts?: OpenFin.PreloadScript[];
     uuid: string;

package/src/shapes/WindowOptions.d.ts

@@ -1,3 +1,4 @@
+import type * as OpenFin from '../OpenFin';
 import { ERROR_BOX_TYPES } from './ERROR_BOX_TYPES';
 import { WebOptions } from './WebOptions';
 export interface WindowOptions extends Partial<OpenFin.WindowOptions>, Partial<WindowInternalOptions> {

package/src/shapes/protocol.d.ts

@@ -1,3 +1,4 @@
+import type * as OpenFin from '../OpenFin';
 import { AuthorizationPayload } from '../transport/transport';
 export interface ProtocolMap extends ProtocolMapBase {
     'request-external-authorization': {
@@ -15,22 +16,33 @@ export interface ProtocolMap extends ProtocolMapBase {
         } & 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;
-    };
+    'get-view-window': IdentityCall<{}, OpenFin.Identity>;
+    'create-view': IdentityCall<OpenFin.ViewCreationOptions & {
+        uuid: string;
+    }>;
+    'destroy-view': IdentityCall;
+    'attach-view': IdentityCall<{
+        target: OpenFin.Identity;
+    }>;
+    'set-view-bounds': IdentityCall<{
+        bounds: OpenFin.Bounds;
+    }>;
+    'get-view-bounds': IdentityCall<{}, OpenFin.Bounds>;
+    'get-view-info': IdentityCall<{}, OpenFin.ViewInfo>;
+    'get-view-options': IdentityCall<{}, OpenFin.ViewOptions>;
+    'hide-view': IdentityCall;
+    'show-view': IdentityCall;
+    'update-view-options': IdentityCall<{
+        options: OpenFin.UpdatableViewOptions;
+    }>;
+    'trigger-before-unload': IdentityCall<{}, boolean>;
+    'window-get-views': IdentityCall<{}, OpenFin.Identity[]>;
     'launch-manifest': {
         request: {
             manifestUrl: string;
-            opts?: OpenFin.RvmLaunchOptions;
+            opts?: Omit<OpenFin.RvmLaunchOptions, 'subscribe'> & {
+                appVersionId?: string;
+            };
         };
         response: {
             manifest: OpenFin.Manifest;
@@ -64,10 +76,7 @@ export interface ProtocolMap extends ProtocolMapBase {
         };
         response: void;
     };
-    'close-popup-menu': {
-        request: OpenFin.Identity;
-        response: void;
-    };
+    'close-popup-menu': IdentityCall;
     'fdc3-add-context-listener': VoidCall;
     'fdc3-broadcast': VoidCall;
     'fdc3-get-system-channels': VoidCall;
@@ -113,12 +122,9 @@ export interface ProtocolMap extends ProtocolMapBase {
         };
         response: OpenFin.PopupResult;
     };
-    'dispatch-popup-result': {
-        request: OpenFin.Identity & {
-            data: any;
-        };
-        response: void;
-    };
+    'dispatch-popup-result': IdentityCall<{
+        data: any;
+    }>;
     'render-overlay': {
         request: {
             bounds: OpenFin.Bounds;
@@ -143,10 +149,12 @@ export interface ProtocolMap extends ProtocolMapBase {
         response: OpenFin.PrinterInfo[];
     };
 }
-declare type VoidCall = {
-    request: void;
-    response: void;
+declare type ApiCall<Request, Response> = {
+    request: Request;
+    response: Response;
 };
+declare type VoidCall = ApiCall<void, void>;
+declare type IdentityCall<AdditionalPayload = {}, Response = void> = ApiCall<AdditionalPayload & OpenFin.Identity, Response>;
 interface ProtocolMapBase {
     [action: string]: {
         request: any;

package/src/transport/transport.d.ts

@@ -1,12 +1,13 @@
 /// <reference types="node" />
 import { EventEmitter } from 'events';
-import { Wire, WireConstructor, ExistingConnectConfig, InternalConnectConfig, RemoteConfig } from './wire';
+import type * as OpenFin from '../OpenFin';
+import { ExistingConnectConfig, InternalConnectConfig, RemoteConfig, Wire, WireConstructor } from './wire';
 import { Environment } from '../environment/environment';
-import { RuntimeEvent } from '../api/events/base';
 import EventAggregator from '../api/events/eventAggregator';
 import { EntityTypeHelpers } from '../api/me';
 import { ProtocolMap } from '../shapes/protocol';
-import EntityType = OpenFin.EntityType;
+import { NamedEvent } from '../api/events/base';
+declare type EntityType = OpenFin.EntityType;
 export declare type MessageHandler = (data: any) => boolean;
 declare class Transport<MeType extends EntityType = EntityType> extends EventEmitter {
     #private;
@@ -44,9 +45,9 @@ export interface Message<T> {
     payload: T;
     correlationId?: number;
 }
-export interface EventMessage extends Message<RuntimeEvent> {
+export interface EventMessage extends Message<NamedEvent> {
     action: 'process-desktop-event';
-    payload: RuntimeEvent;
+    payload: NamedEvent;
 }
 export interface Payload {
     success: boolean;

package/src/transport/transport.js

@@ -1,18 +1,16 @@
 "use strict";
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, privateMap, value) {
-    if (!privateMap.has(receiver)) {
-        throw new TypeError("attempted to set private field on non-instance");
-    }
-    privateMap.set(receiver, value);
-    return value;
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
 };
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, privateMap) {
-    if (!privateMap.has(receiver)) {
-        throw new TypeError("attempted to get private field on non-instance");
-    }
-    return privateMap.get(receiver);
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _wire;
+var _Transport_wire;
 Object.defineProperty(exports, "__esModule", { value: true });
 const events_1 = require("events");
 const wire_1 = require("./wire");
@@ -26,9 +24,9 @@ class Transport extends events_1.EventEmitter {
         this.topicRefMap = new Map();
         this.eventAggregator = new eventAggregator_1.default();
         this.messageHandlers = [this.eventAggregator.dispatchEvent];
-        _wire.set(this, void 0);
+        _Transport_wire.set(this, void 0);
         this.connectSync = () => {
-            const wire = __classPrivateFieldGet(this, _wire);
+            const wire = __classPrivateFieldGet(this, _Transport_wire, "f");
             wire.connectSync();
         };
         // This function is only used in our tests.
@@ -36,14 +34,14 @@ class Transport extends events_1.EventEmitter {
             if (this.environment.constructor.name !== 'NodeEnvironment') {
                 throw new transport_errors_1.NotImplementedError('Not Implemented');
             }
-            const wire = __classPrivateFieldGet(this, _wire);
+            const wire = __classPrivateFieldGet(this, _Transport_wire, "f");
             return wire.wire.url.split(':').slice(-1)[0];
         };
-        __classPrivateFieldSet(this, _wire, new WireType(this.onmessage.bind(this)));
+        __classPrivateFieldSet(this, _Transport_wire, new WireType(this.onmessage.bind(this)), "f");
         this.environment = environment;
-        this.sendRaw = __classPrivateFieldGet(this, _wire).send.bind(__classPrivateFieldGet(this, _wire));
+        this.sendRaw = __classPrivateFieldGet(this, _Transport_wire, "f").send.bind(__classPrivateFieldGet(this, _Transport_wire, "f"));
         this.registerMessageHandler(this.handleMessage.bind(this));
-        __classPrivateFieldGet(this, _wire).on('disconnected', () => {
+        __classPrivateFieldGet(this, _Transport_wire, "f").on('disconnected', () => {
             for (const [, { reject }] of this.wireListeners) {
                 reject('Remote connection has closed');
             }
@@ -52,33 +50,33 @@ class Transport extends events_1.EventEmitter {
         });
         const { uuid, name } = config;
         const entityType = this.environment.getCurrentEntityType();
-        this.me = me_1.getBaseMe(entityType, uuid, name);
+        this.me = (0, me_1.getBaseMe)(entityType, uuid, name);
     }
     shutdown() {
-        const wire = __classPrivateFieldGet(this, _wire);
+        const wire = __classPrivateFieldGet(this, _Transport_wire, "f");
         return wire.shutdown();
     }
     async connect(config) {
-        if (wire_1.isRemoteConfig(config)) {
+        if ((0, wire_1.isRemoteConfig)(config)) {
             return this.connectRemote(config);
         }
-        if (wire_1.isExistingConnectConfig(config)) {
+        if ((0, wire_1.isExistingConnectConfig)(config)) {
             return this.connectByPort(config);
         }
-        if (wire_1.isNewConnectConfig(config)) {
+        if ((0, wire_1.isNewConnectConfig)(config)) {
             const port = await this.environment.retrievePort(config);
             return this.connectByPort({ ...config, address: `ws://localhost:${port}` });
         }
         return undefined;
     }
     async connectRemote(config) {
-        await __classPrivateFieldGet(this, _wire).connect(config.address, this.environment.getWsConstructor());
+        await __classPrivateFieldGet(this, _Transport_wire, "f").connect(config.address, this.environment.getWsConstructor());
         return this.authorize(config);
     }
     async connectByPort(config) {
         const { address, uuid } = config;
         const reqAuthPayload = { ...config, type: 'file-token' };
-        const wire = __classPrivateFieldGet(this, _wire);
+        const wire = __classPrivateFieldGet(this, _Transport_wire, "f");
         await wire.connect(address, this.environment.getWsConstructor());
         const requestExtAuthRet = await this.sendAction('request-external-authorization', {
             uuid,
@@ -109,7 +107,7 @@ class Transport extends events_1.EventEmitter {
                 payload,
                 messageId: id
             };
-            const wire = __classPrivateFieldGet(this, _wire);
+            const wire = __classPrivateFieldGet(this, _Transport_wire, "f");
             this.addWireListener(id, resolve, reject, uncorrelated);
             return wire.send(msg).catch(reject);
         });
@@ -121,7 +119,7 @@ class Transport extends events_1.EventEmitter {
             const resolver = (data) => {
                 resolve(data.payload);
             };
-            const wire = __classPrivateFieldGet(this, _wire);
+            const wire = __classPrivateFieldGet(this, _Transport_wire, "f");
             return wire
                 .send(origData)
                 .then(() => this.addWireListener(id, resolver, reject, false))
@@ -183,5 +181,5 @@ class Transport extends events_1.EventEmitter {
         return true;
     }
 }
-_wire = new WeakMap();
+_Transport_wire = new WeakMap();
 exports.default = Transport;

package/src/transport/wire.d.ts

@@ -38,13 +38,15 @@ export declare type BaseConfig = {
     installerUI?: boolean;
     runtime?: RuntimeConfig;
     services?: ServiceConfig[];
-    appAssets?: [{
-        src: string;
-        alias: string;
-        target: string;
-        version: string;
-        args: string;
-    }];
+    appAssets?: [
+        {
+            src: string;
+            alias: string;
+            target: string;
+            version: string;
+            args: string;
+        }
+    ];
     customItems?: [any];
     timeout?: number;
 };

package/src/util/http.d.ts

@@ -7,5 +7,5 @@ export declare const getProxy: () => {
 };
 export declare const getRequestOptions: (url: string) => ClientRequestArgs;
 export declare const fetch: (url: string) => Promise<string>;
-export declare const downloadFile: (url: string, writeLocation: string) => Promise<unknown>;
+export declare const downloadFile: (url: string, writeLocation: string) => Promise<void>;
 export declare const fetchJson: (url: string) => Promise<any>;

package/src/util/http.js

@@ -6,7 +6,7 @@ const fs = require("fs");
 const getProxyVar = () => {
     return process.env.HTTPS_PROXY || process.env.https_proxy || process.env.HTTP_PROXY || process.env.http_proxy;
 };
-exports.getProxy = () => {
+const getProxy = () => {
     const parsedUrl = new url_1.URL(getProxyVar());
     return {
         port: parsedUrl.port,
@@ -15,12 +15,13 @@ exports.getProxy = () => {
         password: parsedUrl.password
     };
 };
-exports.getRequestOptions = (url) => {
+exports.getProxy = getProxy;
+const getRequestOptions = (url) => {
     const parsedUrl = new url_1.URL(url);
     let options;
     if (getProxyVar() && parsedUrl.hostname !== 'localhost' && parsedUrl.hostname.substring(0, 3) !== '127') {
         options = {};
-        const proxy = exports.getProxy();
+        const proxy = (0, exports.getProxy)();
         options.host = proxy.host;
         options.port = proxy.port;
         options.path = url;
@@ -35,12 +36,13 @@ exports.getRequestOptions = (url) => {
     }
     return options;
 };
-exports.fetch = async (url) => {
+exports.getRequestOptions = getRequestOptions;
+const fetch = async (url) => {
     const requestUrl = getProxyVar() ? getProxyVar() : url;
-    const proto = url_1.parse(requestUrl).protocol.slice(0, -1) === 'http' ? 'http' : 'https';
+    const proto = (0, url_1.parse)(requestUrl).protocol.slice(0, -1) === 'http' ? 'http' : 'https';
     const fetcher = await Promise.resolve().then(() => require(proto));
     return new Promise((resolve, reject) => {
-        const options = exports.getRequestOptions(url);
+        const options = (0, exports.getRequestOptions)(url);
         const request = fetcher.get(options, (response) => {
             if (response.statusCode < 200 || response.statusCode > 299) {
                 reject(new Error(`Failed to load url: ${url}, status code:${response.statusCode}`));
@@ -56,13 +58,14 @@ exports.fetch = async (url) => {
         });
     });
 };
-exports.downloadFile = async (url, writeLocation) => {
+exports.fetch = fetch;
+const downloadFile = async (url, writeLocation) => {
     const requestUrl = getProxyVar() ? getProxyVar() : url;
-    const proto = url_1.parse(requestUrl).protocol.slice(0, -1) === 'http' ? 'http' : 'https';
+    const proto = (0, url_1.parse)(requestUrl).protocol.slice(0, -1) === 'http' ? 'http' : 'https';
     const fetcher = await Promise.resolve().then(() => require(proto));
     return new Promise((resolve, reject) => {
         try {
-            const options = exports.getRequestOptions(url);
+            const options = (0, exports.getRequestOptions)(url);
             fetcher.get(options, (response) => {
                 const file = fs.createWriteStream(writeLocation);
                 response.pipe(file);
@@ -77,7 +80,9 @@ exports.downloadFile = async (url, writeLocation) => {
         }
     });
 };
-exports.fetchJson = async (url) => {
-    const res = await exports.fetch(url);
+exports.downloadFile = downloadFile;
+const fetchJson = async (url) => {
+    const res = await (0, exports.fetch)(url);
     return JSON.parse(res);
 };
+exports.fetchJson = fetchJson;

package/src/util/inaccessibleObject.d.ts

@@ -0,0 +1,2 @@
+export declare function createUnusableObject(message: string): Record<any, never>;
+export declare function createWarningObject<T extends {}>(message: string, obj: T): T;

package/src/util/inaccessibleObject.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createWarningObject = exports.createUnusableObject = void 0;
+function createUnusableObject(message) {
+    const handle = () => {
+        throw new Error(message);
+    };
+    return new Proxy({}, {
+        apply: handle,
+        construct: handle,
+        defineProperty: handle,
+        deleteProperty: handle,
+        get: handle,
+        getOwnPropertyDescriptor: handle,
+        getPrototypeOf: handle,
+        has: handle,
+        isExtensible: handle,
+        ownKeys: handle,
+        preventExtensions: handle,
+        set: handle,
+        setPrototypeOf: handle
+    });
+}
+exports.createUnusableObject = createUnusableObject;
+function createWarningObject(message, obj) {
+    return new Proxy(obj, {
+        get: (...args) => {
+            // eslint-disable-next-line no-console
+            console.warn(message);
+            return Reflect.get(...args);
+        },
+        set: (...args) => {
+            // eslint-disable-next-line no-console
+            console.warn(message);
+            return Reflect.set(...args);
+        },
+        getOwnPropertyDescriptor: (...args) => {
+            // eslint-disable-next-line no-console
+            console.warn(message);
+            return Reflect.getOwnPropertyDescriptor(...args);
+        },
+        ownKeys: (...args) => {
+            // eslint-disable-next-line no-console
+            console.warn(message);
+            return Reflect.ownKeys(...args);
+        }
+    });
+}
+exports.createWarningObject = createWarningObject;

package/src/util/normalize-config.js

@@ -9,14 +9,14 @@ const http_1 = require("./http");
 async function readLocalConfig(location) {
     let pathToFile = location;
     if (location.startsWith('file')) {
-        pathToFile = url_1.fileURLToPath(location);
+        pathToFile = (0, url_1.fileURLToPath)(location);
     }
-    const txt = await promises_1.promisify(fs.readFile)(pathToFile);
+    const txt = await (0, promises_1.promisify)(fs.readFile)(pathToFile);
     return JSON.parse(txt.toString());
 }
 async function loadConfig(config) {
     try {
-        return await http_1.fetchJson(config.manifestUrl);
+        return await (0, http_1.fetchJson)(config.manifestUrl);
     }
     catch (e) {
         try {
@@ -29,7 +29,7 @@ async function loadConfig(config) {
 }
 async function normalizeConfig(config) {
     const testThisConfig = config;
-    if (wire_1.isExternalConfig(config)) {
+    if ((0, wire_1.isExternalConfig)(config)) {
         const loadedConfig = await loadConfig(config);
         testThisConfig.runtime = loadedConfig.runtime;
         if (typeof loadedConfig.assetsUrl === 'string') {
@@ -44,7 +44,7 @@ async function normalizeConfig(config) {
 exports.normalizeConfig = normalizeConfig;
 async function validateConfig(config) {
     const normalized = await normalizeConfig(config);
-    if (wire_1.isInternalConnectConfig(normalized)) {
+    if ((0, wire_1.isInternalConnectConfig)(normalized)) {
         return normalized;
     }
     throw new Error('Invalid Config');