@openfin/core 34.78.63 → 34.78.66

package/out/mock-alpha.d.ts

@@ -3490,6 +3490,10 @@ declare type ConstructorOverride<T> = (Base: Constructor<T>) => Constructor<T>;
  * @interface
  */
 declare type ConstViewOptions = {
+    /**
+     * Configurations for API injection.
+     */
+    api: Api;
     /**
      * The name of the view.
      */
@@ -3570,9 +3574,13 @@ declare type ConstViewOptions = {
     /**
      * Controls interaction of the view with its parent window's download shelf.
      */
-    downloadShelf?: {
+    downloadShelf: {
         /**
-         * Whether downloads in this view trigger opening the download shelf on its parent BrowserWindow
+         * Whether downloads in this view trigger opening the download shelf on its parent BrowserWindow.
+         *
+         * @remarks If `enabled: true`, downloads from this view will cause the download shelf to display
+         * on the parent window even if that parent window's {@link DownloadShelfOptions} specify
+         * `enabled: false`.
          */
         enabled: boolean;
     };
@@ -3688,6 +3696,12 @@ declare type ConstWindowOptions = {
      * launches in favor of the cached value.
      */
     defaultWidth: number;
+    /**
+     * Controls the styling and behavior of the window download shelf.
+     *
+     * @remarks This will control the styling for the download shelf regardless of whether its display was
+     * triggered by the window itself, or a view targeting the window.
+     */
     downloadShelf: DownloadShelfOptions;
     height: number;
     layout: any;
@@ -4828,14 +4842,24 @@ declare type DownloadRule = {
  * @interface
  *
  * Controls the styling and behavior of the window download shelf.
+ *
+ * @remarks This will control the styling for the download shelf regardless of whether its display was
+ * triggered by the window itself, or a view targeting the window.
  */
 declare type DownloadShelfOptions = {
     /**
-     * Whether downloads in this window trigger opening the download shelf.
+     * Whether downloads in this window trigger display of the download shelf.
+     *
+     * @remarks Setting this to false will *not* prevent the download shelf from opening if a child view
+     * with `downloadShelf: { enabled: true }` initiates a download.
      */
     enabled: boolean;
     /**
      * Styling options for the download shelf border.
+     *
+     * @remarks These apply regardless of whether download shelf display was
+     * triggered by this window itself, or a view targeting the window.  Individual views
+     * cannot control the rendering of their parent window's download shelf.
      */
     border?: {
         /**
@@ -4845,7 +4869,7 @@ declare type DownloadShelfOptions = {
          */
         size?: number;
         /**
-         * Color of the border, either a string name or a hex code.  Defaults to chromium theme
+         * Color of the border.  Must be a 6-character hex code prefixed by #.  Defaults to chromium theme
          * if absent.
          */
         color?: string;
@@ -7791,8 +7815,6 @@ declare type InteropBrokerOptions = {
  *
  */
 /**
- * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
- *
  * The Interop Client API is broken up into two groups:
  *
  * **Content Facing APIs** - For Application Developers putting Views into a Platform Window, who care about Context. These are APIs that send out and receive the Context data that flows between applications. Think of this as the Water in the Interop Pipes.
@@ -8195,7 +8217,7 @@ declare class InteropClient extends Base {
      * ```
      */
     onDisconnection(listener: OpenFin_2.InteropClientOnDisconnectionListener): Promise<void>;
-    static ferryFdc3Call(interopClient: OpenFin_2.InteropClient, action: string, payload?: any): Promise<any>;
+    /* Excluded from this release type: ferryFdc3Call */
 }
 
 /**
@@ -9130,7 +9152,7 @@ declare type LayoutOptions = {
          * @defaultValue false
          *
          * Limits the area to which tabs can be dragged.
-         * If true, stack headers are the only areas where tabs can be dropped.
+         * If true, the layout container is the only area where tabs can be dropped.
          */
         constrainDragToContainer?: boolean;
         /**
@@ -9922,7 +9944,7 @@ declare type MutableWindowOptions = {
     showTaskbarIcon: boolean;
     interop: InteropConfig;
     /* Excluded from this release type: _internalWorkspaceData */
-    workspacePlatform: unknown;
+    /* Excluded from this release type: workspacePlatform */
 };
 
 declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;

package/out/mock-beta.d.ts

@@ -3490,6 +3490,10 @@ declare type ConstructorOverride<T> = (Base: Constructor<T>) => Constructor<T>;
  * @interface
  */
 declare type ConstViewOptions = {
+    /**
+     * Configurations for API injection.
+     */
+    api: Api;
     /**
      * The name of the view.
      */
@@ -3570,9 +3574,13 @@ declare type ConstViewOptions = {
     /**
      * Controls interaction of the view with its parent window's download shelf.
      */
-    downloadShelf?: {
+    downloadShelf: {
         /**
-         * Whether downloads in this view trigger opening the download shelf on its parent BrowserWindow
+         * Whether downloads in this view trigger opening the download shelf on its parent BrowserWindow.
+         *
+         * @remarks If `enabled: true`, downloads from this view will cause the download shelf to display
+         * on the parent window even if that parent window's {@link DownloadShelfOptions} specify
+         * `enabled: false`.
          */
         enabled: boolean;
     };
@@ -3688,6 +3696,12 @@ declare type ConstWindowOptions = {
      * launches in favor of the cached value.
      */
     defaultWidth: number;
+    /**
+     * Controls the styling and behavior of the window download shelf.
+     *
+     * @remarks This will control the styling for the download shelf regardless of whether its display was
+     * triggered by the window itself, or a view targeting the window.
+     */
     downloadShelf: DownloadShelfOptions;
     height: number;
     layout: any;
@@ -4828,14 +4842,24 @@ declare type DownloadRule = {
  * @interface
  *
  * Controls the styling and behavior of the window download shelf.
+ *
+ * @remarks This will control the styling for the download shelf regardless of whether its display was
+ * triggered by the window itself, or a view targeting the window.
  */
 declare type DownloadShelfOptions = {
     /**
-     * Whether downloads in this window trigger opening the download shelf.
+     * Whether downloads in this window trigger display of the download shelf.
+     *
+     * @remarks Setting this to false will *not* prevent the download shelf from opening if a child view
+     * with `downloadShelf: { enabled: true }` initiates a download.
      */
     enabled: boolean;
     /**
      * Styling options for the download shelf border.
+     *
+     * @remarks These apply regardless of whether download shelf display was
+     * triggered by this window itself, or a view targeting the window.  Individual views
+     * cannot control the rendering of their parent window's download shelf.
      */
     border?: {
         /**
@@ -4845,7 +4869,7 @@ declare type DownloadShelfOptions = {
          */
         size?: number;
         /**
-         * Color of the border, either a string name or a hex code.  Defaults to chromium theme
+         * Color of the border.  Must be a 6-character hex code prefixed by #.  Defaults to chromium theme
          * if absent.
          */
         color?: string;
@@ -7791,8 +7815,6 @@ declare type InteropBrokerOptions = {
  *
  */
 /**
- * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
- *
  * The Interop Client API is broken up into two groups:
  *
  * **Content Facing APIs** - For Application Developers putting Views into a Platform Window, who care about Context. These are APIs that send out and receive the Context data that flows between applications. Think of this as the Water in the Interop Pipes.
@@ -8195,7 +8217,7 @@ declare class InteropClient extends Base {
      * ```
      */
     onDisconnection(listener: OpenFin_2.InteropClientOnDisconnectionListener): Promise<void>;
-    static ferryFdc3Call(interopClient: OpenFin_2.InteropClient, action: string, payload?: any): Promise<any>;
+    /* Excluded from this release type: ferryFdc3Call */
 }
 
 /**
@@ -9130,7 +9152,7 @@ declare type LayoutOptions = {
          * @defaultValue false
          *
          * Limits the area to which tabs can be dragged.
-         * If true, stack headers are the only areas where tabs can be dropped.
+         * If true, the layout container is the only area where tabs can be dropped.
          */
         constrainDragToContainer?: boolean;
         /**
@@ -9922,7 +9944,7 @@ declare type MutableWindowOptions = {
     showTaskbarIcon: boolean;
     interop: InteropConfig;
     /* Excluded from this release type: _internalWorkspaceData */
-    workspacePlatform: unknown;
+    /* Excluded from this release type: workspacePlatform */
 };
 
 declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;

package/out/mock-public.d.ts

@@ -3490,6 +3490,10 @@ declare type ConstructorOverride<T> = (Base: Constructor<T>) => Constructor<T>;
  * @interface
  */
 declare type ConstViewOptions = {
+    /**
+     * Configurations for API injection.
+     */
+    api: Api;
     /**
      * The name of the view.
      */
@@ -3570,9 +3574,13 @@ declare type ConstViewOptions = {
     /**
      * Controls interaction of the view with its parent window's download shelf.
      */
-    downloadShelf?: {
+    downloadShelf: {
         /**
-         * Whether downloads in this view trigger opening the download shelf on its parent BrowserWindow
+         * Whether downloads in this view trigger opening the download shelf on its parent BrowserWindow.
+         *
+         * @remarks If `enabled: true`, downloads from this view will cause the download shelf to display
+         * on the parent window even if that parent window's {@link DownloadShelfOptions} specify
+         * `enabled: false`.
          */
         enabled: boolean;
     };
@@ -3688,6 +3696,12 @@ declare type ConstWindowOptions = {
      * launches in favor of the cached value.
      */
     defaultWidth: number;
+    /**
+     * Controls the styling and behavior of the window download shelf.
+     *
+     * @remarks This will control the styling for the download shelf regardless of whether its display was
+     * triggered by the window itself, or a view targeting the window.
+     */
     downloadShelf: DownloadShelfOptions;
     height: number;
     layout: any;
@@ -4828,14 +4842,24 @@ declare type DownloadRule = {
  * @interface
  *
  * Controls the styling and behavior of the window download shelf.
+ *
+ * @remarks This will control the styling for the download shelf regardless of whether its display was
+ * triggered by the window itself, or a view targeting the window.
  */
 declare type DownloadShelfOptions = {
     /**
-     * Whether downloads in this window trigger opening the download shelf.
+     * Whether downloads in this window trigger display of the download shelf.
+     *
+     * @remarks Setting this to false will *not* prevent the download shelf from opening if a child view
+     * with `downloadShelf: { enabled: true }` initiates a download.
      */
     enabled: boolean;
     /**
      * Styling options for the download shelf border.
+     *
+     * @remarks These apply regardless of whether download shelf display was
+     * triggered by this window itself, or a view targeting the window.  Individual views
+     * cannot control the rendering of their parent window's download shelf.
      */
     border?: {
         /**
@@ -4845,7 +4869,7 @@ declare type DownloadShelfOptions = {
          */
         size?: number;
         /**
-         * Color of the border, either a string name or a hex code.  Defaults to chromium theme
+         * Color of the border.  Must be a 6-character hex code prefixed by #.  Defaults to chromium theme
          * if absent.
          */
         color?: string;
@@ -7791,8 +7815,6 @@ declare type InteropBrokerOptions = {
  *
  */
 /**
- * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
- *
  * The Interop Client API is broken up into two groups:
  *
  * **Content Facing APIs** - For Application Developers putting Views into a Platform Window, who care about Context. These are APIs that send out and receive the Context data that flows between applications. Think of this as the Water in the Interop Pipes.
@@ -8195,7 +8217,7 @@ declare class InteropClient extends Base {
      * ```
      */
     onDisconnection(listener: OpenFin_2.InteropClientOnDisconnectionListener): Promise<void>;
-    static ferryFdc3Call(interopClient: OpenFin_2.InteropClient, action: string, payload?: any): Promise<any>;
+    /* Excluded from this release type: ferryFdc3Call */
 }
 
 /**
@@ -9130,7 +9152,7 @@ declare type LayoutOptions = {
          * @defaultValue false
          *
          * Limits the area to which tabs can be dragged.
-         * If true, stack headers are the only areas where tabs can be dropped.
+         * If true, the layout container is the only area where tabs can be dropped.
          */
         constrainDragToContainer?: boolean;
         /**
@@ -9922,7 +9944,7 @@ declare type MutableWindowOptions = {
     showTaskbarIcon: boolean;
     interop: InteropConfig;
     /* Excluded from this release type: _internalWorkspaceData */
-    workspacePlatform: unknown;
+    /* Excluded from this release type: workspacePlatform */
 };
 
 declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;

package/out/mock.d.ts

@@ -3533,6 +3533,10 @@ declare type ConstructorOverride<T> = (Base: Constructor<T>) => Constructor<T>;
  * @interface
  */
 declare type ConstViewOptions = {
+    /**
+     * Configurations for API injection.
+     */
+    api: Api;
     /**
      * The name of the view.
      */
@@ -3613,9 +3617,13 @@ declare type ConstViewOptions = {
     /**
      * Controls interaction of the view with its parent window's download shelf.
      */
-    downloadShelf?: {
+    downloadShelf: {
         /**
-         * Whether downloads in this view trigger opening the download shelf on its parent BrowserWindow
+         * Whether downloads in this view trigger opening the download shelf on its parent BrowserWindow.
+         *
+         * @remarks If `enabled: true`, downloads from this view will cause the download shelf to display
+         * on the parent window even if that parent window's {@link DownloadShelfOptions} specify
+         * `enabled: false`.
          */
         enabled: boolean;
     };
@@ -3731,6 +3739,12 @@ declare type ConstWindowOptions = {
      * launches in favor of the cached value.
      */
     defaultWidth: number;
+    /**
+     * Controls the styling and behavior of the window download shelf.
+     *
+     * @remarks This will control the styling for the download shelf regardless of whether its display was
+     * triggered by the window itself, or a view targeting the window.
+     */
     downloadShelf: DownloadShelfOptions;
     height: number;
     layout: any;
@@ -4871,14 +4885,24 @@ declare type DownloadRule = {
  * @interface
  *
  * Controls the styling and behavior of the window download shelf.
+ *
+ * @remarks This will control the styling for the download shelf regardless of whether its display was
+ * triggered by the window itself, or a view targeting the window.
  */
 declare type DownloadShelfOptions = {
     /**
-     * Whether downloads in this window trigger opening the download shelf.
+     * Whether downloads in this window trigger display of the download shelf.
+     *
+     * @remarks Setting this to false will *not* prevent the download shelf from opening if a child view
+     * with `downloadShelf: { enabled: true }` initiates a download.
      */
     enabled: boolean;
     /**
      * Styling options for the download shelf border.
+     *
+     * @remarks These apply regardless of whether download shelf display was
+     * triggered by this window itself, or a view targeting the window.  Individual views
+     * cannot control the rendering of their parent window's download shelf.
      */
     border?: {
         /**
@@ -4888,7 +4912,7 @@ declare type DownloadShelfOptions = {
          */
         size?: number;
         /**
-         * Color of the border, either a string name or a hex code.  Defaults to chromium theme
+         * Color of the border.  Must be a 6-character hex code prefixed by #.  Defaults to chromium theme
          * if absent.
          */
         color?: string;
@@ -7884,8 +7908,6 @@ declare type InteropBrokerOptions = {
  *
  */
 /**
- * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
- *
  * The Interop Client API is broken up into two groups:
  *
  * **Content Facing APIs** - For Application Developers putting Views into a Platform Window, who care about Context. These are APIs that send out and receive the Context data that flows between applications. Think of this as the Water in the Interop Pipes.
@@ -8291,6 +8313,11 @@ declare class InteropClient extends Base {
      * ```
      */
     onDisconnection(listener: OpenFin_2.InteropClientOnDisconnectionListener): Promise<void>;
+    /**
+     * @internal
+     *
+     * Used to ferry fdc3-only calls from the fdc3 shim to the Interop Broker
+     */
     static ferryFdc3Call(interopClient: OpenFin_2.InteropClient, action: string, payload?: any): Promise<any>;
 }
 
@@ -9402,7 +9429,7 @@ declare type LayoutOptions = {
          * @defaultValue false
          *
          * Limits the area to which tabs can be dragged.
-         * If true, stack headers are the only areas where tabs can be dropped.
+         * If true, the layout container is the only area where tabs can be dropped.
          */
         constrainDragToContainer?: boolean;
         /**
@@ -10202,7 +10229,11 @@ declare type MutableWindowOptions = {
      * Used by Workspace to store custom data. Overwriting or modifying this field may impact the functionality of Workspace
      */
     _internalWorkspaceData: any;
-    workspacePlatform: unknown;
+    /**
+     * @internal
+     * Used by workspace to stork platform specific options. Overwriting or modifying this field may impact the functionality of Workspace
+     */
+    workspacePlatform: WorkspacePlatformOptions;
 };
 
 declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;

package/out/mock.js

@@ -12975,7 +12975,7 @@ 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_instances, _LayoutModule_layoutInitializationAttempted, _LayoutModule_layoutManager, _LayoutModule_getBackCompatLayoutManager, _LayoutModule_throwIfLayoutManagerNotInitialized;
+var _LayoutModule_instances, _LayoutModule_layoutInitializationAttempted, _LayoutModule_layoutManager, _LayoutModule_waitForBackCompatLayoutManager, _LayoutModule_throwIfLayoutManagerNotInitialized;
 Object.defineProperty(Factory$2, "__esModule", { value: true });
 Factory$2.LayoutModule = void 0;
 const base_1$5 = base;
@@ -13039,12 +13039,17 @@ class LayoutModule extends base_1$5.Base {
             }
             __classPrivateFieldSet$4(this, _LayoutModule_layoutInitializationAttempted, true, "f");
             __classPrivateFieldSet$4(this, _LayoutModule_layoutManager, await this.wire.environment.initLayoutManager(this.fin, this.wire, options), "f");
+            // in single-layout case, we return the undocumented layoutManager type (deprecate with CORE-1081)
+            let backCompatLayoutPromise;
+            if (!options.layoutManagerOverride) {
+                backCompatLayoutPromise = __classPrivateFieldGet$4(this, _LayoutModule_waitForBackCompatLayoutManager, "f").call(this, this.fin);
+            }
             // apply the initial snapshot which in turn will call fin.Platform.Layout.create()
             const platformClient = await this.fin.Platform.getCurrentSync().getClient();
             const snapshot = await platformClient.dispatch('get-initial-layout-snapshot');
             await __classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f").applyLayoutSnapshot(snapshot);
-            if (!options.layoutManagerOverride) {
-                return __classPrivateFieldGet$4(this, _LayoutModule_getBackCompatLayoutManager, "f").call(this, this.fin);
+            if (backCompatLayoutPromise) {
+                return backCompatLayoutPromise;
             }
             // warn user if they do not call create() in the next 30 seconds
             setTimeout(() => {
@@ -13055,7 +13060,8 @@ class LayoutModule extends base_1$5.Base {
             }, 30000);
             return this.wrapSync(this.fin.me.identity);
         };
-        _LayoutModule_getBackCompatLayoutManager.set(this, async (fin) => {
+        // deprecate with CORE-1081
+        _LayoutModule_waitForBackCompatLayoutManager.set(this, async (fin) => {
             let layoutManager;
             let resolve;
             const layoutResolved = new Promise((r) => {
@@ -13063,6 +13069,7 @@ class LayoutModule extends base_1$5.Base {
             });
             // wait for a layout to be created
             await fin.me.once('layout-ready', async ({ layoutIdentity }) => {
+                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
                 layoutManager = await this.wire.environment.resolveLayout(__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f"), layoutIdentity);
                 // Backward compat - undocumented / not typed openfin-layout as layoutManager
                 // TODO: eventually deprecate this
@@ -13183,7 +13190,7 @@ class LayoutModule extends base_1$5.Base {
     }
 }
 Factory$2.LayoutModule = LayoutModule;
-_LayoutModule_layoutInitializationAttempted = new WeakMap(), _LayoutModule_layoutManager = new WeakMap(), _LayoutModule_getBackCompatLayoutManager = new WeakMap(), _LayoutModule_instances = new WeakSet(), _LayoutModule_throwIfLayoutManagerNotInitialized = function _LayoutModule_throwIfLayoutManagerNotInitialized(method) {
+_LayoutModule_layoutInitializationAttempted = new WeakMap(), _LayoutModule_layoutManager = new WeakMap(), _LayoutModule_waitForBackCompatLayoutManager = new WeakMap(), _LayoutModule_instances = new WeakSet(), _LayoutModule_throwIfLayoutManagerNotInitialized = function _LayoutModule_throwIfLayoutManagerNotInitialized(method) {
     if (!__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f")) {
         throw new Error(`You must call init before using the API ${method}`);
     }
@@ -15664,8 +15671,6 @@ const utils_1$2 = utils$1;
  *
  */
 /**
- * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
- *
  * The Interop Client API is broken up into two groups:
  *
  * **Content Facing APIs** - For Application Developers putting Views into a Platform Window, who care about Context. These are APIs that send out and receive the Context data that flows between applications. Think of this as the Water in the Interop Pipes.
@@ -16231,7 +16236,11 @@ class InteropClient extends base_1$2.Base {
             listener({ type: 'interop-broker', topic: 'disconnected', brokerName: uuid });
         });
     }
-    // used to ferry fdc3-only calls from the fdc3 shim to the Interop Broker
+    /**
+     * @internal
+     *
+     * Used to ferry fdc3-only calls from the fdc3 shim to the Interop Broker
+     */
     static async ferryFdc3Call(interopClient, action, payload) {
         const client = await __classPrivateFieldGet$2(interopClient, _InteropClient_clientPromise, "f");
         return client.dispatch(action, payload || null);

package/package.json

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