@openfin/core 34.78.50 → 34.78.52

package/out/mock.js

@@ -26,9 +26,9 @@ var application$1 = {};
  * child {@link OpenFin.Window windows} and {@link OpenFin.View views} are defined in the {@link OpenFin.WindowEvents} and
  * {@link OpenFin.ViewEvents} namespaces.  For a list of valid string keys for *all* application events, see {@link Application.on Application.on}.
  *
- * {@link NativeApplicationEvent Native application events} (i.e. those that have not propagated from {@link OpenFin.ViewEvents Views}
+ * {@link ApplicationSourcedEvent Application-sourced events} (i.e. those that have not propagated from {@link OpenFin.ViewEvents Views}
  * or {@link OpenFin.WindowEvents Windows} re-propagate to {@link OpenFin.SystemEvents System} with their type string prefixed with `application-`.
- * {@link OpenFin.ApplicationEvents.ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
+ * {@link ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
  * are propagated to `System` without any type string prefixing.
  *
  * "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
@@ -36,6 +36,18 @@ var application$1 = {};
  * @packageDocumentation
  */
 Object.defineProperty(application$1, "__esModule", { value: true });
+application$1.ApplicationWindowEventTypes = void 0;
+/**
+ * Array of valid `type` values for an {@link ApplicationWindowEvent}.
+ */
+application$1.ApplicationWindowEventTypes = [
+    'window-alert-requested',
+    'window-created',
+    'window-end-load',
+    'window-not-responding',
+    'window-responding',
+    'window-start-load'
+];
 
 var base$1 = {};
 
@@ -151,7 +163,7 @@ var window$2 = {};
  * propagate from `View` are defined in {@link OpenFin.ViewEvents}. For a list of valid string keys for *all* Window events, see
  * {@link Window.on Window.on}
  *
- * {@link OpenFin.WindowEvents.NativeWindowEvent Native window events} (i.e. those that are not propagated from a
+ * {@link OpenFin.WindowEvents.WindowSourcedEvent Window-sourced events} (i.e. those that are not propagated from a
  * {@link OpenFin.ViewEvents View}) propagate to their parent {@link OpenFin.ApplicationEvents Application} and
  * {@link OpenFin.SystemEvents System} with their event types prefixed with `'window-'`).
  *
@@ -196,10 +208,10 @@ Object.defineProperty(window$2, "__esModule", { value: true });
  * finally to the OpenFin runtime itself at the "system" level.  For details on propagation semantics, see the namespace for
  * the propagating (or propagated-to) entity.
  *
- * If you need the payload type for a specific type of event (especially propagated events), use the emitting topic's `EventPayload`
- * (e.g. {@link WindowEvents.WindowEventPayload}) generic with the event's `type` string.  For example, the payload of
+ * If you need the payload type for a specific type of event (especially propagated events), use the emitting topic's `Payload` generic
+ * (e.g. {@link WindowEvents.Payload}) with the event's `type` string.  For example, the payload of
  * a {@link ViewEvents.CreatedEvent} after it has propagated to its parent {@link WindowEvents Window} can be found with
- * `WindowEventPayload<'view-created'>`.
+ * `WindowEvents.Payload<'view-created'>`.
  *
  * @packageDocumentation
  */
@@ -1312,14 +1324,14 @@ _LayoutNode_client = new WeakMap();
 /**
  * @ignore
  * @internal
- * Encapsulates Api consumption of {@link LayoutEntitiesController} with a relayed dispatch
+ * Encapsulates Api consumption of {@link LayoutEntitiesClient} with a relayed dispatch
  * @param client
  * @param controllerId
  * @param identity
  * @returns a new instance of {@link LayoutEntitiesClient} with bound to the controllerId
  */
 LayoutNode.newLayoutEntitiesClient = async (client, controllerId, identity) => {
-    const dispatch = (0, channel_api_relay_1.createRelayedDispatch)(client, identity, 'layout-relay', 'You are trying to interact with a layout component on a window that has been destroyed.');
+    const dispatch = (0, channel_api_relay_1.createRelayedDispatch)(client, identity, 'layout-relay', 'You are trying to interact with a layout component on a window that does not exist or has been destroyed.');
     const consumer = new api_exposer_1.ApiConsumer(new api_exposer_1.ChannelsConsumer({ dispatch }));
     return consumer.consume({ id: controllerId });
 };
@@ -1629,8 +1641,9 @@ _ColumnOrRow_client = new WeakMap();
 var layout_constants = {};
 
 Object.defineProperty(layout_constants, "__esModule", { value: true });
-layout_constants.LAYOUT_CONTROLLER_ID = void 0;
+layout_constants.DEFAULT_LAYOUT_KEY = layout_constants.LAYOUT_CONTROLLER_ID = void 0;
 layout_constants.LAYOUT_CONTROLLER_ID = 'layout-entities';
+layout_constants.DEFAULT_LAYOUT_KEY = 'default';
 
 var main = {};
 
@@ -3206,8 +3219,24 @@ function requireInstance$2 () {
 	            this.wire.sendAction('view-get-parent-layout', { ...this.identity }).catch(() => {
 	                // don't expose
 	            });
-	            const currentWindow = await this.getCurrentWindow();
-	            return currentWindow.getLayout();
+	            const layoutWindow = await this.getCurrentWindow();
+	            try {
+	                const providerChannelClient = await __classPrivateFieldGet(this, _View_providerChannelClient, "f").getValue();
+	                const client = await layout_entities_1.LayoutNode.newLayoutEntitiesClient(providerChannelClient, layout_constants_1.LAYOUT_CONTROLLER_ID, layoutWindow.identity);
+	                const layoutIdentity = await client.getLayoutIdentityForViewOrThrow(this.identity);
+	                return this.fin.Platform.Layout.wrap(layoutIdentity);
+	            }
+	            catch (e) {
+	                const allowedErrors = [
+	                    'No action registered at target for',
+	                    'getLayoutIdentityForViewOrThrow is not a function'
+	                ];
+	                if (!allowedErrors.some((m) => e.message.includes(m))) {
+	                    throw e;
+	                }
+	                // fallback logic for missing endpoint
+	                return this.fin.Platform.Layout.wrap(layoutWindow.identity);
+	            }
 	        };
 	        /**
 	         * Gets the View's options.
@@ -5639,15 +5668,15 @@ function requireInstance () {
 	     * ```
 	     * @experimental
 	     */
-	    async getLayout() {
+	    async getLayout(layoutIdentity) {
 	        this.wire.sendAction('window-get-layout', this.identity).catch((e) => {
 	            // don't expose
 	        });
 	        const opts = await this.getOptions();
-	        if (!opts.layout) {
+	        if (!opts.layout || !opts.layoutSnapshot) {
 	            throw new Error('Window does not have a Layout');
 	        }
-	        return this.fin.Platform.Layout.wrap(this.identity);
+	        return this.fin.Platform.Layout.wrap(layoutIdentity ?? this.identity);
 	    }
 	    /**
 	     * Gets the current settings of the window.
@@ -7639,6 +7668,79 @@ class System extends base_1$j.EmitterBase {
     openUrlWithBrowser(url) {
         return this.wire.sendAction('open-url-with-browser', { url }).then(() => undefined);
     }
+    /**
+     * Creates a new registry entry under the HKCU root Windows registry key if the given custom protocol name doesn't exist or
+     * overwrites the existing registry entry if the given custom protocol name already exists.
+     *
+     * Note: This method is restricted by default and must be enabled via
+     * {@link https://developers.openfin.co/docs/api-security API security settings}. It requires RVM 12 or higher version.
+     *
+     *
+     * @remarks These protocols are reserved and cannot be registered:
+     * - fin
+     * - fins
+     * - openfin
+     * - URI Schemes registered with {@link https://en.wikipedia.org/wiki/List_of_URI_schemes#Official_IANA-registered_schemes IANA}
+     *
+     * @throws if a given custom protocol failed to be registered.
+     * @throws if a manifest URL contains the '%1' string.
+     * @throws if a manifest URL contains a query string parameter which name equals to the Protocol Launch Request Parameter Name.
+     * @throws if the full length of the command string that is to be written to the registry exceeds 2048 bytes.
+     *
+     * @example
+     * ```js
+     * fin.System.registerCustomProtocol({protocolName:'protocol1'}).then(console.log).catch(console.error);
+     * ```
+     */
+    async registerCustomProtocol(options) {
+        if (typeof options !== 'object') {
+            throw new Error('Must provide an object with a `protocolName` property having a string value.');
+        }
+        await this.wire.sendAction('register-custom-protocol', options);
+    }
+    /**
+     * Removes the registry entry for a given custom protocol.
+     *
+     * Note: This method is restricted by default and must be enabled via
+     * {@link https://developers.openfin.co/docs/api-security API security settings}. It requires RVM 12 or higher version.
+     *
+     *
+     * @remarks These protocols are reserved and cannot be unregistered:
+     * - fin
+     * - fins
+     * - openfin
+     * - URI Schemes registered with {@link https://en.wikipedia.org/wiki/List_of_URI_schemes#Official_IANA-registered_schemes IANA}
+     *
+     * @throws if a protocol entry failed to be removed in registry.
+     *
+     * @example
+     * ```js
+     * await fin.System.unregisterCustomProtocol('protocol1');
+     * ```
+     */
+    async unregisterCustomProtocol(protocolName) {
+        await this.wire.sendAction('unregister-custom-protocol', { protocolName });
+    }
+    /**
+     * Retrieves the registration state for a given custom protocol.
+     *
+     * Note: This method is restricted by default and must be enabled via
+     * {@link https://developers.openfin.co/docs/api-security API security settings}. It requires RVM 12 or higher version.
+     *
+     * @remarks These protocols are reserved and cannot get states for them:
+     * - fin
+     * - fins
+     * - openfin
+     * - URI Schemes registered with {@link https://en.wikipedia.org/wiki/List_of_URI_schemes#Official_IANA-registered_schemes IANA}
+     *
+     *
+     * @example
+     * ```js
+     * const protocolState = await fin.System.getCustomProtocolState('protocol1');
+     */
+    async getCustomProtocolState(protocolName) {
+        return this.wire.sendAction('get-custom-protocol-state', { protocolName }).then(({ payload }) => payload.data);
+    }
     /**
      * Removes the process entry for the passed UUID obtained from a prior call
      * of fin.System.launchExternalProcess().
@@ -11622,6 +11724,8 @@ class GlobalHotkey extends base_1$8.EmitterBase {
      * Registers a global hotkey with the operating system.
      * @param hotkey a hotkey string
      * @param listener called when the registered hotkey is pressed by the user.
+     * @throws If the `hotkey` is reserved, see list below.
+     * @throws if the `hotkey` is already registered by another application.
      *
      * @remarks The `hotkey` parameter expects an electron compatible [accelerator](https://github.com/electron/electron/blob/master/docs/api/accelerator.md) and the `listener` will be called if the `hotkey` is pressed by the user.
      * If successfull, the hotkey will be 'claimed' by the application, meaning that this register call can be called multiple times from within the same application but will fail if another application has registered the hotkey.
@@ -11714,7 +11818,7 @@ class GlobalHotkey extends base_1$8.EmitterBase {
         return undefined;
     }
     /**
-     * Checks if a given hotkey has been registered
+     * Checks if a given hotkey has been registered by an application within the current runtime.
      * @param hotkey a hotkey string
      *
      * @example
@@ -12920,6 +13024,7 @@ class Layout extends base_1$6.Base {
             // don't expose
         });
         const client = await this.platform.getClient();
+        console.log(`Layout::toConfig() called!`);
         return client.dispatch('get-frame-snapshot', {
             target: this.identity
         });
@@ -12969,7 +13074,7 @@ class Layout extends base_1$6.Base {
             // don't expose
         });
         const client = await __classPrivateFieldGet$5(this, _Layout_layoutClient, "f").getValue();
-        const root = await client.getRoot();
+        const root = await client.getRoot(this.identity);
         return layout_entities_1.LayoutNode.getEntity(root, client);
     }
 }
@@ -12987,10 +13092,9 @@ var __classPrivateFieldSet$4 = (commonjsGlobal && commonjsGlobal.__classPrivateF
     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 _LayoutModule_layoutInitializationAttempted;
+var _LayoutModule_instances, _LayoutModule_layoutInitializationAttempted, _LayoutModule_layoutManager, _LayoutModule_throwIfLayoutManagerNotInitialized;
 Object.defineProperty(Factory$2, "__esModule", { value: true });
 Factory$2.LayoutModule = void 0;
-/* eslint-disable no-undef, import/prefer-default-export */
 const base_1$5 = base;
 const Instance_1$2 = Instance$1;
 /**
@@ -12999,7 +13103,9 @@ const Instance_1$2 = Instance$1;
 class LayoutModule extends base_1$5.Base {
     constructor() {
         super(...arguments);
+        _LayoutModule_instances.add(this);
         _LayoutModule_layoutInitializationAttempted.set(this, false);
+        _LayoutModule_layoutManager.set(this, null);
         /**
          * Initialize the window's Layout.
          *
@@ -13046,10 +13152,43 @@ class LayoutModule extends base_1$5.Base {
                 throw new Error('Layout.init can only be called from a Window context.');
             }
             else if (__classPrivateFieldGet$4(this, _LayoutModule_layoutInitializationAttempted, "f")) {
-                throw new Error('Layout for this window already initialized, please use Layout.replace call to replace the layout.');
+                throw new Error('Layout.init was already called, please use Layout.create to add additional layouts.');
             }
             __classPrivateFieldSet$4(this, _LayoutModule_layoutInitializationAttempted, true, "f");
-            return this.wire.environment.initLayout(this.fin, this.wire, options);
+            __classPrivateFieldSet$4(this, _LayoutModule_layoutManager, await this.wire.environment.initLayout(this.fin, this.wire, options), "f");
+            // back-compat ONLY if layoutManagerOverride not provided
+            if (!options.layoutManagerOverride) {
+                const layoutInstance = await __classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f").resolveLayout();
+                const layout = this.wrapSync(layoutInstance.identity);
+                // Backward compat - undocumented / not typed layoutInstance as layoutManager
+                return Object.assign(layout, { layoutManager: layoutInstance });
+            }
+            // Warn user if they do not create any layouts in the next 10 seconds
+            setTimeout(() => {
+                const layoutSize = Object.keys(__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f").getLayouts()).length;
+                if (layoutSize === 0) {
+                    console.warn(`[Layout.init] Layout.init was called but no layouts have been created yet. Make sure you ` +
+                        `override LayoutManager.applyLayoutSnapshot, and then call fin.Platform.Layout.create()`);
+                }
+            }, 10000);
+            return this.wrapSync(this.fin.me.identity);
+        };
+        /**
+         * Returns the layout manager for the current window
+         * @returns
+         */
+        this.getCurrentLayoutManagerSync = () => {
+            __classPrivateFieldGet$4(this, _LayoutModule_instances, "m", _LayoutModule_throwIfLayoutManagerNotInitialized).call(this);
+            // @ts-expect-error User may have implemented their own snapshot type when overriding LayoutManager
+            return __classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f");
+        };
+        this.create = async (options) => {
+            __classPrivateFieldGet$4(this, _LayoutModule_instances, "m", _LayoutModule_throwIfLayoutManagerNotInitialized).call(this);
+            return this.wire.environment.createLayout(__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f"), options);
+        };
+        this.destroy = async (layoutIdentity) => {
+            __classPrivateFieldGet$4(this, _LayoutModule_instances, "m", _LayoutModule_throwIfLayoutManagerNotInitialized).call(this);
+            return this.wire.environment.destroyLayout(__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f"), layoutIdentity);
         };
     }
     /**
@@ -13147,7 +13286,11 @@ class LayoutModule extends base_1$5.Base {
     }
 }
 Factory$2.LayoutModule = LayoutModule;
-_LayoutModule_layoutInitializationAttempted = new WeakMap();
+_LayoutModule_layoutInitializationAttempted = new WeakMap(), _LayoutModule_layoutManager = new WeakMap(), _LayoutModule_instances = new WeakSet(), _LayoutModule_throwIfLayoutManagerNotInitialized = function _LayoutModule_throwIfLayoutManagerNotInitialized() {
+    if (!__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f")) {
+        throw new Error('You must call init before using this API');
+    }
+};
 
 (function (exports) {
 	/**
@@ -16725,7 +16868,7 @@ var transport = {};
 var wire = {};
 
 Object.defineProperty(wire, "__esModule", { value: true });
-wire.isInternalConnectConfig = wire.isPortDiscoveryConfig = wire.isNewConnectConfig = wire.isRemoteConfig = wire.isExistingConnectConfig = wire.isExternalConfig = void 0;
+wire.isInternalConnectConfig = wire.isPortDiscoveryConfig = wire.isNewConnectConfig = wire.isConfigWithReceiver = wire.isRemoteConfig = wire.isExistingConnectConfig = wire.isExternalConfig = void 0;
 function isExternalConfig(config) {
     if (typeof config.manifestUrl === 'string') {
         return true;
@@ -16741,6 +16884,10 @@ function isRemoteConfig(config) {
     return isExistingConnectConfig(config) && typeof config.token === 'string';
 }
 wire.isRemoteConfig = isRemoteConfig;
+function isConfigWithReceiver(config) {
+    return typeof config.receiver === 'object' && isRemoteConfig({ ...config, address: '' });
+}
+wire.isConfigWithReceiver = isConfigWithReceiver;
 function hasUuid(config) {
     return typeof config.uuid === 'string';
 }
@@ -16890,13 +17037,13 @@ class Transport extends events_1$1.EventEmitter {
     }
     getFin() {
         if (!__classPrivateFieldGet(this, _Transport_fin, "f")) {
-            throw new Error("No Fin object registered for this transport");
+            throw new Error('No Fin object registered for this transport');
         }
         return __classPrivateFieldGet(this, _Transport_fin, "f");
     }
     registerFin(_fin) {
         if (__classPrivateFieldGet(this, _Transport_fin, "f")) {
-            throw new Error("Fin object has already been registered for this transport");
+            throw new Error('Fin object has already been registered for this transport');
         }
         __classPrivateFieldSet(this, _Transport_fin, _fin, "f");
     }
@@ -16905,6 +17052,10 @@ class Transport extends events_1$1.EventEmitter {
         return wire.shutdown();
     }
     async connect(config) {
+        if ((0, wire_1.isConfigWithReceiver)(config)) {
+            await __classPrivateFieldGet(this, _Transport_wire, "f").connect(config.receiver);
+            return this.authorize(config);
+        }
         if ((0, wire_1.isRemoteConfig)(config)) {
             return this.connectRemote(config);
         }
@@ -16918,14 +17069,14 @@ class Transport extends events_1$1.EventEmitter {
         return undefined;
     }
     async connectRemote(config) {
-        await __classPrivateFieldGet(this, _Transport_wire, "f").connect(config.address, this.environment.getWsConstructor());
+        await __classPrivateFieldGet(this, _Transport_wire, "f").connect(new (this.environment.getWsConstructor())(config.address));
         return this.authorize(config);
     }
     async connectByPort(config) {
         const { address, uuid } = config;
         const reqAuthPayload = { ...config, type: 'file-token' };
         const wire = __classPrivateFieldGet(this, _Transport_wire, "f");
-        await wire.connect(address, this.environment.getWsConstructor());
+        await wire.connect(new (this.environment.getWsConstructor())(config.address));
         const requestExtAuthRet = await this.sendAction('request-external-authorization', {
             uuid,
             type: 'file-token'
@@ -16945,7 +17096,9 @@ class Transport extends events_1$1.EventEmitter {
             throw new transport_errors_1.RuntimeError(requestAuthRet.payload);
         }
     }
-    sendAction(action, payload = {}, uncorrelated = false) {
+    sendAction(action, payload = {}, uncorrelated = false
+    // specialResponse type is only used for 'requestAuthorization'
+    ) {
         // eslint-disable-next-line @typescript-eslint/no-empty-function
         let cancel = () => { };
         // We want the callsite from the caller of this function, not from here.
@@ -16995,7 +17148,10 @@ class Transport extends events_1$1.EventEmitter {
             this.uncorrelatedListener = resolve;
         }
         else if (this.wireListeners.has(id)) {
-            handleNack({ reason: 'Duplicate handler id', error: (0, errors_1.errorToPOJO)(new transport_errors_1.DuplicateCorrelationError(String(id))) });
+            handleNack({
+                reason: 'Duplicate handler id',
+                error: (0, errors_1.errorToPOJO)(new transport_errors_1.DuplicateCorrelationError(String(id)))
+            });
         }
         else {
             this.wireListeners.set(id, { resolve, handleNack });
@@ -17071,6 +17227,12 @@ class MockEnvironment {
     initLayout() {
         throw new Error(me_1.environmentUnsupportedMessage);
     }
+    async createLayout() {
+        throw new Error(me_1.environmentUnsupportedMessage);
+    }
+    async destroyLayout() {
+        throw new Error(me_1.environmentUnsupportedMessage);
+    }
     initPlatform() {
         throw new Error(me_1.environmentUnsupportedMessage);
     }
@@ -17122,7 +17284,7 @@ Object.defineProperty(mockWire, "__esModule", { value: true });
 mockWire.MockWire = void 0;
 const events_1 = require$$0;
 class MockWire extends events_1.EventEmitter {
-    connect(address) {
+    connect() {
         throw new Error('You are not running in OpenFin.');
     }
     connectSync() {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/core",
-    "version": "34.78.50",
+    "version": "34.78.52",
     "description": "The core renderer entry point of OpenFin",
     "license": "SEE LICENSE IN LICENSE.MD",
     "main": "out/mock.js",