@openfin/core 33.76.36 → 33.77.1

package/src/transport/wire.d.ts

@@ -1,77 +0,0 @@
-/// <reference types="node" />
-import EventEmitter = NodeJS.EventEmitter;
-export type Wire = EventEmitter & {
-    connect(address: string, WsConstructor: typeof WebSocket): Promise<any>;
-    connectSync(): any;
-    send(data: any): Promise<any>;
-    shutdown(): Promise<void>;
-    getPort(): string;
-};
-export type WireConstructor = {
-    new (onmessage: (data: any) => void): Wire;
-};
-export type RuntimeConfig = {
-    version: string;
-    fallbackVersion?: string;
-    securityRealm?: string;
-    verboseLogging?: boolean;
-    arguments?: string;
-    rvmDir?: string;
-};
-export type ServiceConfig = {
-    name: string;
-    manifestUrl: string;
-};
-export type BaseConfig = {
-    uuid?: string;
-    address?: string;
-    name?: string;
-    nonPersistent?: boolean;
-    runtimeClient?: boolean;
-    licenseKey?: string;
-    client?: any;
-    manifestUrl?: string;
-    startupApp?: any;
-    lrsUrl?: string;
-    assetsUrl?: string;
-    devToolsPort?: number;
-    installerUI?: boolean;
-    runtime?: RuntimeConfig;
-    services?: ServiceConfig[];
-    appAssets?: [
-        {
-            src: string;
-            alias: string;
-            target: string;
-            version: string;
-            args: string;
-        }
-    ];
-    customItems?: [any];
-    timeout?: number;
-};
-export type ConfigWithUuid = BaseConfig & {
-    uuid: string;
-};
-export type ExistingConnectConfig = ConfigWithUuid & {
-    address: string;
-};
-export type ConfigWithRuntime = BaseConfig & {
-    runtime: RuntimeConfig;
-};
-export type ExternalConfig = BaseConfig & {
-    manifestUrl: string;
-};
-export type NewConnectConfig = ConfigWithUuid & ConfigWithRuntime;
-export type PortDiscoveryConfig = (ExternalConfig & ConfigWithRuntime) | NewConnectConfig;
-export type ConnectConfig = ExistingConnectConfig | NewConnectConfig | ExternalConfig;
-export type InternalConnectConfig = ExistingConnectConfig | NewConnectConfig;
-export interface RemoteConfig extends ExistingConnectConfig {
-    token: string;
-}
-export declare function isExternalConfig(config: ConnectConfig): config is ExternalConfig;
-export declare function isExistingConnectConfig(config: any): config is ExistingConnectConfig;
-export declare function isRemoteConfig(config: any): config is RemoteConfig;
-export declare function isNewConnectConfig(config: any): config is NewConnectConfig;
-export declare function isPortDiscoveryConfig(config: any): config is PortDiscoveryConfig;
-export declare function isInternalConnectConfig(config: any): config is InternalConnectConfig;

package/src/transport/wire.js

@@ -1,36 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isInternalConnectConfig = exports.isPortDiscoveryConfig = exports.isNewConnectConfig = exports.isRemoteConfig = exports.isExistingConnectConfig = exports.isExternalConfig = void 0;
-function isExternalConfig(config) {
-    if (typeof config.manifestUrl === 'string') {
-        return true;
-    }
-    return false;
-}
-exports.isExternalConfig = isExternalConfig;
-function isExistingConnectConfig(config) {
-    return hasUuid(config) && typeof config.address === 'string';
-}
-exports.isExistingConnectConfig = isExistingConnectConfig;
-function isRemoteConfig(config) {
-    return isExistingConnectConfig(config) && typeof config.token === 'string';
-}
-exports.isRemoteConfig = isRemoteConfig;
-function hasUuid(config) {
-    return typeof config.uuid === 'string';
-}
-function hasRuntimeVersion(config) {
-    return config.runtime && typeof config.runtime.version === 'string';
-}
-function isNewConnectConfig(config) {
-    return hasUuid(config) && hasRuntimeVersion(config);
-}
-exports.isNewConnectConfig = isNewConnectConfig;
-function isPortDiscoveryConfig(config) {
-    return (isExternalConfig(config) && hasRuntimeVersion(config)) || isNewConnectConfig(config);
-}
-exports.isPortDiscoveryConfig = isPortDiscoveryConfig;
-function isInternalConnectConfig(config) {
-    return isExistingConnectConfig(config) || isNewConnectConfig(config);
-}
-exports.isInternalConnectConfig = isInternalConnectConfig;

package/src/util/asyncFilter.d.ts

@@ -1 +0,0 @@
-export declare function asyncFilter<T>(values: T[], callback: (value: T) => Promise<boolean>): Promise<T[]>;

package/src/util/asyncFilter.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.asyncFilter = void 0;
-async function asyncFilter(values, callback) {
-    return Promise.all(values.map(callback)).then((results) => values.filter((_, i) => results[i]));
-}
-exports.asyncFilter = asyncFilter;

package/src/util/channel-api-relay.d.ts

@@ -1,13 +0,0 @@
-import type * as OpenFin from '../OpenFin';
-/**
- * @internal
- * Create a channel relay for a given channel exposition, allowing a single provider to route
- * actions to the designated clients.
- *
- * Designed to be used in conjunction with @expose
- *
- * @param channelProvider The channel provider to relay the actions on.
- * @param config Determines which actions to relay. Please ensure action prefix matches the exposed api.
- */
-export declare const relayChannelClientApi: (channelProvider: OpenFin.ChannelProvider, relayId: string) => Promise<void>;
-export declare const createRelayedDispatch: (client: OpenFin.ChannelClient, target: OpenFin.Identity, relayId: string, relayErrorMsg?: string) => OpenFin.ChannelClient['dispatch'];

package/src/util/channel-api-relay.js

@@ -1,47 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createRelayedDispatch = exports.relayChannelClientApi = void 0;
-const EXPECTED_ERRORS = [
-    'no longer connected',
-    'RTCDataChannel closed unexpectedly',
-    'The client you are trying to dispatch from is disconnected from the target provider',
-];
-// Checks possible error messages that we want to trap, client error message can originate
-// from ChannelProvider::dispatch OR ClassicStrategy::closeEndpoint OR RTCEndPoint::dataChannel::onclose
-const isDisconnectedError = (errorMsg) => {
-    return EXPECTED_ERRORS.some(e => errorMsg.includes(e));
-};
-/**
- * @internal
- * Create a channel relay for a given channel exposition, allowing a single provider to route
- * actions to the designated clients.
- *
- * Designed to be used in conjunction with @expose
- *
- * @param channelProvider The channel provider to relay the actions on.
- * @param config Determines which actions to relay. Please ensure action prefix matches the exposed api.
- */
-const relayChannelClientApi = async (channelProvider, relayId) => {
-    channelProvider.register(`relay:${relayId}`, ({ action, target, payload }) => {
-        return channelProvider.dispatch(target, action, payload);
-    });
-    await Promise.resolve();
-};
-exports.relayChannelClientApi = relayChannelClientApi;
-const createRelayedDispatch = (client, target, relayId, relayErrorMsg) => async (action, payload) => {
-    try {
-        return await client.dispatch(`relay:${relayId}`, {
-            action,
-            payload,
-            target
-        });
-    }
-    catch (e) {
-        if (isDisconnectedError(e.message) && relayErrorMsg) {
-            throw new Error(relayErrorMsg);
-        }
-        ;
-        throw e;
-    }
-};
-exports.createRelayedDispatch = createRelayedDispatch;

package/src/util/errors.d.ts

@@ -1,10 +0,0 @@
-/**
- * This function converts JS errors into plain objects
- */
-export type ErrorPlainObject = {
-    stack?: string;
-    message: string;
-    name?: string;
-    toString(): string;
-};
-export declare function errorToPOJO(error: Error): ErrorPlainObject;

package/src/util/errors.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.errorToPOJO = void 0;
-function errorToPOJO(error) {
-    return {
-        stack: error.stack,
-        name: error.name,
-        message: error.message,
-        toString: error.toString
-    };
-}
-exports.errorToPOJO = errorToPOJO;

package/src/util/exhaustive.d.ts

@@ -1 +0,0 @@
-export declare function exhaustiveCheck(value: string, allowed?: string[]): never;

package/src/util/exhaustive.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.exhaustiveCheck = void 0;
-function exhaustiveCheck(value, allowed) {
-    throw new Error(`Unsupported value: ${value}${allowed ? `\n Supported values are: ${allowed.join('')}` : ''}`);
-}
-exports.exhaustiveCheck = exhaustiveCheck;

package/src/util/http.d.ts

@@ -1,11 +0,0 @@
-import { ClientRequestArgs } from 'http';
-export declare const getProxy: () => {
-    port: string;
-    host: string;
-    username: string;
-    password: string;
-};
-export declare const getRequestOptions: (url: string) => ClientRequestArgs;
-export declare const fetch: (url: string) => Promise<string>;
-export declare const downloadFile: (url: string, writeLocation: string) => Promise<void>;
-export declare const fetchJson: (url: string) => Promise<any>;

package/src/util/http.js

@@ -1,90 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fetchJson = exports.downloadFile = exports.fetch = exports.getRequestOptions = exports.getProxy = void 0;
-const node_url_1 = require("node:url"); // This must explicitly use node builtin to avoid accidentally bundling npm:url.
-const fs = require("fs");
-const getProxyVar = () => {
-    return process.env.HTTPS_PROXY || process.env.https_proxy || process.env.HTTP_PROXY || process.env.http_proxy;
-};
-const getProxy = () => {
-    const parsedUrl = new node_url_1.URL(getProxyVar());
-    return {
-        port: parsedUrl.port,
-        host: parsedUrl.hostname,
-        username: parsedUrl.username,
-        password: parsedUrl.password
-    };
-};
-exports.getProxy = getProxy;
-const getRequestOptions = (url) => {
-    const parsedUrl = new node_url_1.URL(url);
-    let options;
-    if (getProxyVar() && parsedUrl.hostname !== 'localhost' && parsedUrl.hostname.substring(0, 3) !== '127') {
-        options = {};
-        const proxy = (0, exports.getProxy)();
-        options.host = proxy.host;
-        options.port = proxy.port;
-        options.path = url;
-        options.headers = { Host: parsedUrl.hostname };
-        if (proxy.username && proxy.password) {
-            const auth = `Basic ${Buffer.from(`${proxy.username}:${proxy.password}`).toString('base64')}`;
-            Object.assign(options.headers, { 'Proxy-Authorization': auth });
-        }
-    }
-    else {
-        options = parsedUrl;
-    }
-    return options;
-};
-exports.getRequestOptions = getRequestOptions;
-const fetch = async (url) => {
-    var _a;
-    const requestUrl = getProxyVar() ? getProxyVar() : url;
-    const proto = (0, node_url_1.parse)(requestUrl).protocol.slice(0, -1) === 'http' ? 'http' : 'https';
-    const fetcher = await (_a = proto, Promise.resolve().then(() => require(_a)));
-    return new Promise((resolve, reject) => {
-        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}`));
-            }
-            const body = [];
-            response.on('data', (chunk) => {
-                body.push(chunk);
-            });
-            response.on('end', () => resolve(body.join('')));
-        });
-        request.on('error', (err) => {
-            reject(err);
-        });
-    });
-};
-exports.fetch = fetch;
-const downloadFile = async (url, writeLocation) => {
-    var _a;
-    const requestUrl = getProxyVar() ? getProxyVar() : url;
-    const proto = (0, node_url_1.parse)(requestUrl).protocol.slice(0, -1) === 'http' ? 'http' : 'https';
-    const fetcher = await (_a = proto, Promise.resolve().then(() => require(_a)));
-    return new Promise((resolve, reject) => {
-        try {
-            const options = (0, exports.getRequestOptions)(url);
-            fetcher.get(options, (response) => {
-                const file = fs.createWriteStream(writeLocation);
-                response.pipe(file);
-                file.on('finish', () => {
-                    file.close();
-                    resolve();
-                });
-            });
-        }
-        catch (e) {
-            reject(e);
-        }
-    });
-};
-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

@@ -1,2 +0,0 @@
-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

@@ -1,49 +0,0 @@
-"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/lazy.d.ts

@@ -1,34 +0,0 @@
-/**
- * Handy class for managing asynchronous dependencies of classes.
- *
- * Will call the producer function once and only once when getValue is called,
- * returning the resultant value for every subsequent call.
- */
-export declare class Lazy<T> {
-    private producerFn;
-    constructor(producerFn: () => T);
-    private value;
-    /**
-     * Lazily get the value returned by the producer.
-     * @returns The value returned from the producer function
-     */
-    getValue(): T;
-}
-/**
- * Handy class for managing asynchronous dependencies of classes.
- *
- * Will call asynchronous producer only after `getValue` is called.  If the
- * deferred code errors, we can try it again by re-calling `getValue` after
- * the promise rejects.
- */
-export declare class AsyncRetryableLazy<T> {
-    private producerFn;
-    constructor(producerFn: () => Promise<T>);
-    private promise?;
-    /**
-     * Lazily get the value returned by the async producer.
-     *
-     * @returns The value returned from the producer function
-     */
-    getValue(): Promise<T>;
-}

package/src/util/lazy.js

@@ -1,54 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AsyncRetryableLazy = exports.Lazy = void 0;
-/**
- * Handy class for managing asynchronous dependencies of classes.
- *
- * Will call the producer function once and only once when getValue is called,
- * returning the resultant value for every subsequent call.
- */
-class Lazy {
-    // eslint-disable-next-line
-    constructor(producerFn) {
-        this.producerFn = producerFn;
-    }
-    /**
-     * Lazily get the value returned by the producer.
-     * @returns The value returned from the producer function
-     */
-    getValue() {
-        if (!this.value) {
-            this.value = this.producerFn();
-        }
-        return this.value;
-    }
-}
-exports.Lazy = Lazy;
-/**
- * Handy class for managing asynchronous dependencies of classes.
- *
- * Will call asynchronous producer only after `getValue` is called.  If the
- * deferred code errors, we can try it again by re-calling `getValue` after
- * the promise rejects.
- */
-class AsyncRetryableLazy {
-    // eslint-disable-next-line
-    constructor(producerFn) {
-        this.producerFn = producerFn;
-    }
-    /**
-     * Lazily get the value returned by the async producer.
-     *
-     * @returns The value returned from the producer function
-     */
-    async getValue() {
-        if (!this.promise) {
-            this.promise = this.producerFn().catch((e) => {
-                delete this.promise;
-                throw e;
-            });
-        }
-        return this.promise;
-    }
-}
-exports.AsyncRetryableLazy = AsyncRetryableLazy;

package/src/util/normalize-config.d.ts

@@ -1,3 +0,0 @@
-import { ConnectConfig, ExternalConfig, InternalConnectConfig } from '../transport/wire';
-export declare function normalizeConfig(config: ConnectConfig): Promise<InternalConnectConfig | ExternalConfig>;
-export declare function validateConfig(config: ConnectConfig): Promise<InternalConnectConfig>;

package/src/util/normalize-config.js

@@ -1,52 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateConfig = exports.normalizeConfig = void 0;
-const fs = require("fs");
-const node_url_1 = require("node:url"); // This must explicitly use node builtin to avoid accidentally bundling npm:url
-const wire_1 = require("../transport/wire");
-const promises_1 = require("./promises");
-const http_1 = require("./http");
-async function readLocalConfig(location) {
-    let pathToFile = location;
-    if (location.startsWith('file')) {
-        pathToFile = (0, node_url_1.fileURLToPath)(location);
-    }
-    const txt = await (0, promises_1.promisify)(fs.readFile)(pathToFile);
-    return JSON.parse(txt.toString());
-}
-async function loadConfig(config) {
-    try {
-        return await (0, http_1.fetchJson)(config.manifestUrl);
-    }
-    catch (e) {
-        try {
-            return await readLocalConfig(config.manifestUrl);
-        }
-        catch (error) {
-            throw new Error(`Could not locate JSON at supplied manifestUrl: ${config.manifestUrl}`);
-        }
-    }
-}
-async function normalizeConfig(config) {
-    const testThisConfig = config;
-    if ((0, wire_1.isExternalConfig)(config)) {
-        const loadedConfig = await loadConfig(config);
-        testThisConfig.runtime = loadedConfig.runtime;
-        if (typeof loadedConfig.assetsUrl === 'string') {
-            testThisConfig.assetsUrl = loadedConfig.assetsUrl;
-        }
-        if (Array.isArray(loadedConfig.services)) {
-            testThisConfig.services = loadedConfig.services;
-        }
-    }
-    return testThisConfig;
-}
-exports.normalizeConfig = normalizeConfig;
-async function validateConfig(config) {
-    const normalized = await normalizeConfig(config);
-    if ((0, wire_1.isInternalConnectConfig)(normalized)) {
-        return normalized;
-    }
-    throw new Error('Invalid Config');
-}
-exports.validateConfig = validateConfig;

package/src/util/promises.d.ts

@@ -1,5 +0,0 @@
-export declare function promisify(func: Function): (...args: any[]) => Promise<any>;
-export declare function promiseMap<T, S>(arr: T[], asyncF: (x: T, i: number, r: T[]) => Promise<S>): Promise<S[]>;
-export type asyncF<T> = (...args: any[]) => Promise<T>;
-export declare function serial<T>(arr: asyncF<T>[]): Promise<T[]>;
-export declare function promiseMapSerial<T>(arr: any[], func: asyncF<T>): Promise<T[]>;

package/src/util/promises.js

@@ -1,27 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.promiseMapSerial = exports.serial = exports.promiseMap = exports.promisify = void 0;
-function promisify(func) {
-    return (...args) => new Promise((resolve, reject) => {
-        func(...args, (err, val) => (err ? reject(err) : resolve(val)));
-    });
-}
-exports.promisify = promisify;
-async function promiseMap(arr, asyncF) {
-    return Promise.all(arr.map(asyncF));
-}
-exports.promiseMap = promiseMap;
-async function serial(arr) {
-    const ret = [];
-    for (const func of arr) {
-        // eslint-disable-next-line no-await-in-loop
-        const next = await func();
-        ret.push(next);
-    }
-    return ret;
-}
-exports.serial = serial;
-async function promiseMapSerial(arr, func) {
-    return serial(arr.map((value, index, array) => () => func(value, index, array)));
-}
-exports.promiseMapSerial = promiseMapSerial;

package/src/util/ref-counter.d.ts

@@ -1,7 +0,0 @@
-export declare class RefCounter {
-    topicRefMap: Map<any, any>;
-    incRefCount(key: string): number;
-    decRefCount(key: string): number;
-    actOnFirst(key: string, firstAction: () => any, nonFirstAction: () => {}): any;
-    actOnLast(key: string, lastAction: () => any, nonLastAction: () => {}): any;
-}

package/src/util/ref-counter.js

@@ -1,52 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RefCounter = void 0;
-class RefCounter {
-    constructor() {
-        this.topicRefMap = new Map();
-    }
-    // returns the ref count after incrementing
-    incRefCount(key) {
-        const refCount = this.topicRefMap.get(key);
-        let returnCount;
-        if (!refCount) {
-            this.topicRefMap.set(key, 1);
-            returnCount = 1;
-        }
-        else {
-            const newRefCount = refCount + 1;
-            returnCount = newRefCount;
-            this.topicRefMap.set(key, newRefCount);
-        }
-        return returnCount;
-    }
-    // returns the ref count after decrementing, or -1 if the key already had no references
-    decRefCount(key) {
-        const refCount = this.topicRefMap.get(key);
-        let returnCount;
-        if (refCount) {
-            const newRefCount = refCount - 1;
-            this.topicRefMap.set(key, newRefCount);
-            returnCount = newRefCount;
-        }
-        else {
-            returnCount = -1;
-        }
-        return returnCount;
-    }
-    // Execute firstAction if it is the first such ref, else execute nonFirstAction.
-    // In either case the return value is that of the action executed
-    actOnFirst(key, firstAction, nonFirstAction) {
-        const numRefs = this.incRefCount(key);
-        const isFirstRef = numRefs === 1;
-        return isFirstRef ? firstAction() : nonFirstAction();
-    }
-    // Execute lastAction if it is the first such ref, else execute nonLastAction.
-    // In either case the return value is that of the action executed
-    actOnLast(key, lastAction, nonLastAction) {
-        const numRefs = this.decRefCount(key);
-        const isLastRef = numRefs === 0;
-        return isLastRef ? lastAction() : nonLastAction();
-    }
-}
-exports.RefCounter = RefCounter;

package/src/util/reversible-map.d.ts

@@ -1,11 +0,0 @@
-export declare class ReversibleMap<TKey extends string | number | symbol, TValue extends Object | string | number> {
-    private readonly valueToKey;
-    private readonly keyToValue;
-    setUnique: (key: TKey, value: TValue) => void;
-    getKey: (value: TValue) => TKey;
-    getValue(key: TKey): TValue;
-    deleteKey: (key: TKey) => TValue | undefined;
-    deleteValue: (value: TValue) => TKey | undefined;
-    hasKey: (key: TKey) => boolean;
-    hasValue: (value: TValue) => boolean;
-}