@openfin/core 33.76.36 → 33.77.1

package/src/api/snapshot-source/Instance.d.ts

@@ -1,53 +0,0 @@
-import type * as OpenFin from '../../OpenFin';
-import { Base } from '../base';
-import { Transport } from '../../transport/transport';
-/**
- * Enables configuring a SnapshotSource with custom getSnapshot and applySnapshot methods.
- *
- */
-export declare class SnapshotSource<T = any> extends Base {
-    #private;
-    /**
-     * @internal
-     */
-    constructor(wire: Transport, id: OpenFin.ApplicationIdentity);
-    get identity(): OpenFin.ApplicationIdentity;
-    /**
-     * Method to determine if the SnapshotSource has been initialized.
-     *
-     * @remarks Use when the parent application is starting up to ensure the SnapshotSource is able to accept and
-     * apply a snapshot using the {@link SnapshotSource#applySnapshot applySnapshot} method.
-     *
-     * @example
-     * ```js
-     * let snapshotSource = fin.SnapshotSource.wrapSync(fin.me);
-     *
-     * const snapshotProvider = {
-     *     async getSnapshot() { return 'foo' },
-     *     async applySnapshot(snapshot) {
-     *       console.log(snapshot);
-     *       return undefined;
-     *     }
-     * }
-     * await fin.SnapshotSource.init(snapshotProvider);
-     *
-     * try {
-     *   await snapshotSource.ready();
-     *   await snapshotSource.applySnapshot('foo');
-     * } catch (err) {
-     *   console.log(err)
-     * }
-     * ```
-     */
-    ready(): Promise<void>;
-    /**
-     * Call the SnapshotSource's getSnapshot method defined by {@link SnapshotSource.SnapshotSourceModule#init init}.
-     *
-     */
-    getSnapshot(): Promise<T>;
-    /**
-     * Call the SnapshotSource's applySnapshot method defined by {@link SnapshotSource.SnapshotSourceModule#init init}.
-     *
-     */
-    applySnapshot(snapshot: T): Promise<void>;
-}

package/src/api/snapshot-source/Instance.js

@@ -1,154 +0,0 @@
-"use strict";
-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, 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 _SnapshotSource_identity, _SnapshotSource_getConnection, _SnapshotSource_getClient, _SnapshotSource_startConnection, _SnapshotSource_setUpConnectionListener;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SnapshotSource = void 0;
-/* eslint-disable @typescript-eslint/no-non-null-assertion */
-const base_1 = require("../base");
-const utils_1 = require("./utils");
-const connectionMap = new Map();
-/**
- * Enables configuring a SnapshotSource with custom getSnapshot and applySnapshot methods.
- *
- */
-class SnapshotSource extends base_1.Base {
-    /**
-     * @internal
-     */
-    constructor(wire, id) {
-        super(wire);
-        _SnapshotSource_identity.set(this, void 0);
-        _SnapshotSource_getConnection.set(this, () => {
-            if (!connectionMap.has(this.identity.uuid)) {
-                connectionMap.set(this.identity.uuid, { eventFired: null, clientPromise: null });
-            }
-            return connectionMap.get(this.identity.uuid);
-        });
-        _SnapshotSource_getClient.set(this, () => {
-            if (!__classPrivateFieldGet(this, _SnapshotSource_getConnection, "f").call(this).clientPromise) {
-                __classPrivateFieldGet(this, _SnapshotSource_getConnection, "f").call(this).clientPromise = __classPrivateFieldGet(this, _SnapshotSource_startConnection, "f").call(this);
-            }
-            return __classPrivateFieldGet(this, _SnapshotSource_getConnection, "f").call(this).clientPromise;
-        });
-        _SnapshotSource_startConnection.set(this, async () => {
-            const channelName = (0, utils_1.getSnapshotSourceChannelName)(this.identity);
-            try {
-                if (!__classPrivateFieldGet(this, _SnapshotSource_getConnection, "f").call(this).eventFired) {
-                    await __classPrivateFieldGet(this, _SnapshotSource_setUpConnectionListener, "f").call(this);
-                }
-                const client = await this.fin.InterApplicationBus.Channel.connect(channelName, { wait: false });
-                client.onDisconnection(() => {
-                    __classPrivateFieldGet(this, _SnapshotSource_getConnection, "f").call(this).clientPromise = null;
-                    __classPrivateFieldGet(this, _SnapshotSource_getConnection, "f").call(this).eventFired = null;
-                });
-                return client;
-            }
-            catch (e) {
-                __classPrivateFieldGet(this, _SnapshotSource_getConnection, "f").call(this).clientPromise = null;
-                throw new Error("The targeted SnapshotSource is not currently initialized. Await this object's ready() method.");
-            }
-        });
-        _SnapshotSource_setUpConnectionListener.set(this, async () => {
-            const channelName = (0, utils_1.getSnapshotSourceChannelName)(this.identity);
-            let resolve;
-            let reject;
-            const eventFired = new Promise((y, n) => {
-                resolve = y;
-                reject = n;
-            });
-            __classPrivateFieldGet(this, _SnapshotSource_getConnection, "f").call(this).eventFired = eventFired;
-            const listener = async (e) => {
-                try {
-                    if (e.channelName === channelName) {
-                        resolve();
-                        await this.fin.InterApplicationBus.Channel.removeListener('connected', listener);
-                    }
-                }
-                catch (err) {
-                    reject(err);
-                }
-            };
-            await this.fin.InterApplicationBus.Channel.on('connected', listener);
-        });
-        __classPrivateFieldSet(this, _SnapshotSource_identity, id, "f");
-    }
-    get identity() {
-        return __classPrivateFieldGet(this, _SnapshotSource_identity, "f");
-    }
-    /**
-     * Method to determine if the SnapshotSource has been initialized.
-     *
-     * @remarks Use when the parent application is starting up to ensure the SnapshotSource is able to accept and
-     * apply a snapshot using the {@link SnapshotSource#applySnapshot applySnapshot} method.
-     *
-     * @example
-     * ```js
-     * let snapshotSource = fin.SnapshotSource.wrapSync(fin.me);
-     *
-     * const snapshotProvider = {
-     *     async getSnapshot() { return 'foo' },
-     *     async applySnapshot(snapshot) {
-     *       console.log(snapshot);
-     *       return undefined;
-     *     }
-     * }
-     * await fin.SnapshotSource.init(snapshotProvider);
-     *
-     * try {
-     *   await snapshotSource.ready();
-     *   await snapshotSource.applySnapshot('foo');
-     * } catch (err) {
-     *   console.log(err)
-     * }
-     * ```
-     */
-    async ready() {
-        this.wire.sendAction('snapshot-source-ready').catch((e) => {
-            // don't expose, analytics-only call
-        });
-        // eslint-disable-next-line no-async-promise-executor
-        try {
-            // If getClient was already called before this, do we have a timing issue where the channel might have been created but we missed the event but this still fails?
-            await __classPrivateFieldGet(this, _SnapshotSource_getClient, "f").call(this);
-        }
-        catch (e) {
-            // it was not running.
-            await __classPrivateFieldGet(this, _SnapshotSource_getConnection, "f").call(this).eventFired;
-        }
-    }
-    /**
-     * Call the SnapshotSource's getSnapshot method defined by {@link SnapshotSource.SnapshotSourceModule#init init}.
-     *
-     */
-    async getSnapshot() {
-        this.wire.sendAction('snapshot-source-get-snapshot').catch((e) => {
-            // don't expose, analytics-only call
-        });
-        const client = await __classPrivateFieldGet(this, _SnapshotSource_getClient, "f").call(this);
-        const response = (await client.dispatch('get-snapshot'));
-        return (await response).snapshot;
-    }
-    /**
-     * Call the SnapshotSource's applySnapshot method defined by {@link SnapshotSource.SnapshotSourceModule#init init}.
-     *
-     */
-    async applySnapshot(snapshot) {
-        this.wire.sendAction('snapshot-source-apply-snapshot').catch((e) => {
-            // don't expose, analytics-only call
-        });
-        const client = await __classPrivateFieldGet(this, _SnapshotSource_getClient, "f").call(this);
-        return client.dispatch('apply-snapshot', { snapshot });
-    }
-}
-exports.SnapshotSource = SnapshotSource;
-_SnapshotSource_identity = new WeakMap(), _SnapshotSource_getConnection = new WeakMap(), _SnapshotSource_getClient = new WeakMap(), _SnapshotSource_startConnection = new WeakMap(), _SnapshotSource_setUpConnectionListener = new WeakMap();

package/src/api/snapshot-source/index.d.ts

@@ -1,12 +0,0 @@
-/**
- * Entry point for the OpenFin SnapshotSource namespace.
- *
- * Because TypeDoc does not currently support multiple modules with the same name, the module alias "SnapshotSourceModule" is used for
- * the module containing static members of the `SnapshotSource` namespace (available under `fin.SnapshotSource`), while `SnapshotSource` documents
- * instances of the OpenFin `SnapshotSource` class.
- *
- * @packageDocumentation
- */
-import SnapshotModule from './Factory';
-export default SnapshotModule;
-export * from './Instance';

package/src/api/snapshot-source/index.js

@@ -1,28 +0,0 @@
-"use strict";
-/**
- * Entry point for the OpenFin SnapshotSource namespace.
- *
- * Because TypeDoc does not currently support multiple modules with the same name, the module alias "SnapshotSourceModule" is used for
- * the module containing static members of the `SnapshotSource` namespace (available under `fin.SnapshotSource`), while `SnapshotSource` documents
- * instances of the OpenFin `SnapshotSource` class.
- *
- * @packageDocumentation
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (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" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const Factory_1 = require("./Factory");
-exports.default = Factory_1.default;
-__exportStar(require("./Instance"), exports);

package/src/api/snapshot-source/utils.d.ts

@@ -1,2 +0,0 @@
-import type * as OpenFin from '../../OpenFin';
-export declare const getSnapshotSourceChannelName: (id: OpenFin.ApplicationIdentity) => string;

package/src/api/snapshot-source/utils.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSnapshotSourceChannelName = void 0;
-const channelPrefix = 'snapshot-source-provider-';
-const getSnapshotSourceChannelName = (id) => `${channelPrefix}${id.uuid}`;
-exports.getSnapshotSourceChannelName = getSnapshotSourceChannelName;