@openfin/node-adapter 36.78.6 → 36.78.8

package/out/node-adapter-alpha.d.ts

@@ -111,6 +111,13 @@ declare type ApiClient<T extends Record<any, any>> = {
     [key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
 };
 
+/**
+ * @interface
+ */
+declare type ApiInjection = {
+    fin: InjectionType;
+};
+
 /**
  * Generated when a new Platform's API becomes responsive.
  * @interface
@@ -1244,10 +1251,13 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
      */
     apiDiagnostics: boolean;
     /**
-     * Define the file download rules.
-     * See [here](https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads) for more details.
+     * @deprecated Please use {@link domainSettings} instead
      */
     defaultDomainSettings: DefaultDomainSettings;
+    /**
+     * Define the {@link https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads file download rules} and domain-based api injection rules.
+     */
+    domainSettings: DomainSettings;
     /**
      * @defaultValue false
      *
@@ -4511,21 +4521,15 @@ declare type CustomRequestHeaders = {
 declare type DataChannelReadyState = RTCDataChannel['readyState'];
 
 /**
+ * @deprecated Use {@link OpenFin.DomainSettings} instead.
  * @interface
  */
-declare type DefaultDomainSettings = {
-    rules: DefaultDomainSettingsRule[];
-};
+declare type DefaultDomainSettings = DomainSettings;
 
 /**
- * @interface
+ * @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
  */
-declare type DefaultDomainSettingsRule = {
-    match: string[];
-    options: {
-        downloadSettings: FileDownloadSettings;
-    };
-};
+declare type DefaultDomainSettingsRule = DomainSettingsRule;
 
 declare interface DesktopAgent {
     open(app: TargetApp, context?: Context): Promise<void>;
@@ -4770,6 +4774,25 @@ declare type DisplayMetadata_3 = {
     readonly glyph?: string;
 };
 
+/**
+ * @interface
+ * Define the {@link https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads file download rules} and domain-based api injection rules.
+ */
+declare type DomainSettings = {
+    rules: DomainSettingsRule[];
+};
+
+/**
+ * @interface
+ */
+declare type DomainSettingsRule = {
+    match: string[];
+    options: {
+        downloadSettings?: FileDownloadSettings;
+        api?: ApiInjection;
+    };
+};
+
 /**
  * Metadata returned from a preload script download request.
  *
@@ -6654,6 +6677,11 @@ declare type InitPlatformOptions = {
     interopOverride?: OverrideCallback<InteropBroker> | ConstructorOverride<InteropBroker>[];
 };
 
+/**
+ * * 'none': The `fin` API will be not available from within this context.
+ * * 'global': The entire `fin` API will be available from within this context.
+ * @defaultValue 'global'
+ */
 declare type InjectionType = 'none' | 'global';
 
 /**
@@ -8909,7 +8937,7 @@ declare type LayoutOptions = {
 declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
 
 /**
- * @interface
+ * Layout preset type.
  */
 declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
 
@@ -9961,6 +9989,9 @@ declare namespace OpenFin {
         RuntimeInfo,
         DefaultDomainSettings,
         DefaultDomainSettingsRule,
+        DomainSettings,
+        ApiInjection,
+        DomainSettingsRule,
         FileDownloadBehaviorNames,
         FileDownloadSettings,
         DownloadRule,

package/out/node-adapter-beta.d.ts

@@ -111,6 +111,13 @@ declare type ApiClient<T extends Record<any, any>> = {
     [key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
 };
 
+/**
+ * @interface
+ */
+declare type ApiInjection = {
+    fin: InjectionType;
+};
+
 /**
  * Generated when a new Platform's API becomes responsive.
  * @interface
@@ -1244,10 +1251,13 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
      */
     apiDiagnostics: boolean;
     /**
-     * Define the file download rules.
-     * See [here](https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads) for more details.
+     * @deprecated Please use {@link domainSettings} instead
      */
     defaultDomainSettings: DefaultDomainSettings;
+    /**
+     * Define the {@link https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads file download rules} and domain-based api injection rules.
+     */
+    domainSettings: DomainSettings;
     /**
      * @defaultValue false
      *
@@ -4511,21 +4521,15 @@ declare type CustomRequestHeaders = {
 declare type DataChannelReadyState = RTCDataChannel['readyState'];
 
 /**
+ * @deprecated Use {@link OpenFin.DomainSettings} instead.
  * @interface
  */
-declare type DefaultDomainSettings = {
-    rules: DefaultDomainSettingsRule[];
-};
+declare type DefaultDomainSettings = DomainSettings;
 
 /**
- * @interface
+ * @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
  */
-declare type DefaultDomainSettingsRule = {
-    match: string[];
-    options: {
-        downloadSettings: FileDownloadSettings;
-    };
-};
+declare type DefaultDomainSettingsRule = DomainSettingsRule;
 
 declare interface DesktopAgent {
     open(app: TargetApp, context?: Context): Promise<void>;
@@ -4770,6 +4774,25 @@ declare type DisplayMetadata_3 = {
     readonly glyph?: string;
 };
 
+/**
+ * @interface
+ * Define the {@link https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads file download rules} and domain-based api injection rules.
+ */
+declare type DomainSettings = {
+    rules: DomainSettingsRule[];
+};
+
+/**
+ * @interface
+ */
+declare type DomainSettingsRule = {
+    match: string[];
+    options: {
+        downloadSettings?: FileDownloadSettings;
+        api?: ApiInjection;
+    };
+};
+
 /**
  * Metadata returned from a preload script download request.
  *
@@ -6654,6 +6677,11 @@ declare type InitPlatformOptions = {
     interopOverride?: OverrideCallback<InteropBroker> | ConstructorOverride<InteropBroker>[];
 };
 
+/**
+ * * 'none': The `fin` API will be not available from within this context.
+ * * 'global': The entire `fin` API will be available from within this context.
+ * @defaultValue 'global'
+ */
 declare type InjectionType = 'none' | 'global';
 
 /**
@@ -8909,7 +8937,7 @@ declare type LayoutOptions = {
 declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
 
 /**
- * @interface
+ * Layout preset type.
  */
 declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
 
@@ -9961,6 +9989,9 @@ declare namespace OpenFin {
         RuntimeInfo,
         DefaultDomainSettings,
         DefaultDomainSettingsRule,
+        DomainSettings,
+        ApiInjection,
+        DomainSettingsRule,
         FileDownloadBehaviorNames,
         FileDownloadSettings,
         DownloadRule,

package/out/node-adapter-public.d.ts

@@ -111,6 +111,13 @@ declare type ApiClient<T extends Record<any, any>> = {
     [key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
 };
 
+/**
+ * @interface
+ */
+declare type ApiInjection = {
+    fin: InjectionType;
+};
+
 /**
  * Generated when a new Platform's API becomes responsive.
  * @interface
@@ -1244,10 +1251,13 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
      */
     apiDiagnostics: boolean;
     /**
-     * Define the file download rules.
-     * See [here](https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads) for more details.
+     * @deprecated Please use {@link domainSettings} instead
      */
     defaultDomainSettings: DefaultDomainSettings;
+    /**
+     * Define the {@link https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads file download rules} and domain-based api injection rules.
+     */
+    domainSettings: DomainSettings;
     /**
      * @defaultValue false
      *
@@ -4511,21 +4521,15 @@ declare type CustomRequestHeaders = {
 declare type DataChannelReadyState = RTCDataChannel['readyState'];
 
 /**
+ * @deprecated Use {@link OpenFin.DomainSettings} instead.
  * @interface
  */
-declare type DefaultDomainSettings = {
-    rules: DefaultDomainSettingsRule[];
-};
+declare type DefaultDomainSettings = DomainSettings;
 
 /**
- * @interface
+ * @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
  */
-declare type DefaultDomainSettingsRule = {
-    match: string[];
-    options: {
-        downloadSettings: FileDownloadSettings;
-    };
-};
+declare type DefaultDomainSettingsRule = DomainSettingsRule;
 
 declare interface DesktopAgent {
     open(app: TargetApp, context?: Context): Promise<void>;
@@ -4770,6 +4774,25 @@ declare type DisplayMetadata_3 = {
     readonly glyph?: string;
 };
 
+/**
+ * @interface
+ * Define the {@link https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads file download rules} and domain-based api injection rules.
+ */
+declare type DomainSettings = {
+    rules: DomainSettingsRule[];
+};
+
+/**
+ * @interface
+ */
+declare type DomainSettingsRule = {
+    match: string[];
+    options: {
+        downloadSettings?: FileDownloadSettings;
+        api?: ApiInjection;
+    };
+};
+
 /**
  * Metadata returned from a preload script download request.
  *
@@ -6654,6 +6677,11 @@ declare type InitPlatformOptions = {
     interopOverride?: OverrideCallback<InteropBroker> | ConstructorOverride<InteropBroker>[];
 };
 
+/**
+ * * 'none': The `fin` API will be not available from within this context.
+ * * 'global': The entire `fin` API will be available from within this context.
+ * @defaultValue 'global'
+ */
 declare type InjectionType = 'none' | 'global';
 
 /**
@@ -8909,7 +8937,7 @@ declare type LayoutOptions = {
 declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
 
 /**
- * @interface
+ * Layout preset type.
  */
 declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
 
@@ -9961,6 +9989,9 @@ declare namespace OpenFin {
         RuntimeInfo,
         DefaultDomainSettings,
         DefaultDomainSettingsRule,
+        DomainSettings,
+        ApiInjection,
+        DomainSettingsRule,
         FileDownloadBehaviorNames,
         FileDownloadSettings,
         DownloadRule,

package/out/node-adapter.d.ts

@@ -111,6 +111,13 @@ declare type ApiClient<T extends Record<any, any>> = {
     [key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
 };
 
+/**
+ * @interface
+ */
+declare type ApiInjection = {
+    fin: InjectionType;
+};
+
 /**
  * Generated when a new Platform's API becomes responsive.
  * @interface
@@ -1250,10 +1257,13 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
      */
     apiDiagnostics: boolean;
     /**
-     * Define the file download rules.
-     * See [here](https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads) for more details.
+     * @deprecated Please use {@link domainSettings} instead
      */
     defaultDomainSettings: DefaultDomainSettings;
+    /**
+     * Define the {@link https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads file download rules} and domain-based api injection rules.
+     */
+    domainSettings: DomainSettings;
     /**
      * @defaultValue false
      *
@@ -4554,21 +4564,15 @@ declare type CustomRequestHeaders = {
 declare type DataChannelReadyState = RTCDataChannel['readyState'];
 
 /**
+ * @deprecated Use {@link OpenFin.DomainSettings} instead.
  * @interface
  */
-declare type DefaultDomainSettings = {
-    rules: DefaultDomainSettingsRule[];
-};
+declare type DefaultDomainSettings = DomainSettings;
 
 /**
- * @interface
+ * @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
  */
-declare type DefaultDomainSettingsRule = {
-    match: string[];
-    options: {
-        downloadSettings: FileDownloadSettings;
-    };
-};
+declare type DefaultDomainSettingsRule = DomainSettingsRule;
 
 declare interface DesktopAgent {
     open(app: TargetApp, context?: Context): Promise<void>;
@@ -4813,6 +4817,25 @@ declare type DisplayMetadata_3 = {
     readonly glyph?: string;
 };
 
+/**
+ * @interface
+ * Define the {@link https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads file download rules} and domain-based api injection rules.
+ */
+declare type DomainSettings = {
+    rules: DomainSettingsRule[];
+};
+
+/**
+ * @interface
+ */
+declare type DomainSettingsRule = {
+    match: string[];
+    options: {
+        downloadSettings?: FileDownloadSettings;
+        api?: ApiInjection;
+    };
+};
+
 /**
  * Metadata returned from a preload script download request.
  *
@@ -6754,6 +6777,11 @@ declare type InitPlatformOptions = {
     interopOverride?: OverrideCallback<InteropBroker> | ConstructorOverride<InteropBroker>[];
 };
 
+/**
+ * * 'none': The `fin` API will be not available from within this context.
+ * * 'global': The entire `fin` API will be available from within this context.
+ * @defaultValue 'global'
+ */
 declare type InjectionType = 'none' | 'global';
 
 /**
@@ -9208,7 +9236,7 @@ declare type LayoutOptions = {
 declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
 
 /**
- * @interface
+ * Layout preset type.
  */
 declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
 
@@ -10278,6 +10306,9 @@ declare namespace OpenFin {
         RuntimeInfo,
         DefaultDomainSettings,
         DefaultDomainSettingsRule,
+        DomainSettings,
+        ApiInjection,
+        DomainSettingsRule,
         FileDownloadBehaviorNames,
         FileDownloadSettings,
         DownloadRule,

package/out/node-adapter.js

@@ -11735,7 +11735,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_getSafeLayoutManager;
+var _LayoutModule_instances, _LayoutModule_layoutInitializationAttempted, _LayoutModule_layoutManager, _LayoutModule_getBackCompatLayoutManager, _LayoutModule_getSafeLayoutManager;
 Object.defineProperty(Factory$2, "__esModule", { value: true });
 Factory$2.LayoutModule = void 0;
 const base_1$5 = base$1;
@@ -11788,7 +11788,7 @@ class LayoutModule extends base_1$5.Base {
          * ```
          */
         this.init = async (options = {}) => {
-            this.wire.sendAction('layout-init').catch(() => {
+            this.wire.sendAction('layout-init').catch((e) => {
                 // don't expose
             });
             if (!this.fin.me.isWindow) {
@@ -11803,6 +11803,9 @@ class LayoutModule extends base_1$5.Base {
             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);
+            }
             // warn user if they do not call create() in the next 30 seconds
             setTimeout(() => {
                 if (__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f")?.size() === 0) {
@@ -11812,6 +11815,22 @@ class LayoutModule extends base_1$5.Base {
             }, 30000);
             return this.wrapSync(this.fin.me.identity);
         };
+        _LayoutModule_getBackCompatLayoutManager.set(this, async (fin) => {
+            let layoutManager;
+            let resolve;
+            const layoutResolved = new Promise((r) => {
+                resolve = r;
+            });
+            // 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
+                resolve(Object.assign(this.wrapSync(layoutIdentity), { layoutManager }));
+            });
+            return layoutResolved;
+        });
         /**
          * Returns the layout manager for the current window
          * @returns
@@ -11846,7 +11865,7 @@ class LayoutModule extends base_1$5.Base {
      * ```
      */
     async wrap(identity) {
-        this.wire.sendAction('layout-wrap').catch(() => {
+        this.wire.sendAction('layout-wrap').catch((e) => {
             // don't expose
         });
         return new Instance_1$2.Layout(identity, this.wire);
@@ -11871,7 +11890,7 @@ class LayoutModule extends base_1$5.Base {
      * ```
      */
     wrapSync(identity) {
-        this.wire.sendAction('layout-wrap-sync').catch(() => {
+        this.wire.sendAction('layout-wrap-sync').catch((e) => {
             // don't expose
         });
         return new Instance_1$2.Layout(identity, this.wire);
@@ -11887,7 +11906,7 @@ class LayoutModule extends base_1$5.Base {
      * ```
      */
     async getCurrent() {
-        this.wire.sendAction('layout-get-current').catch(() => {
+        this.wire.sendAction('layout-get-current').catch((e) => {
             // don't expose
         });
         if (!this.fin.me.isWindow) {
@@ -11910,7 +11929,7 @@ class LayoutModule extends base_1$5.Base {
      * ```
      */
     getCurrentSync() {
-        this.wire.sendAction('layout-get-current-sync').catch(() => {
+        this.wire.sendAction('layout-get-current-sync').catch((e) => {
             // don't expose
         });
         if (!this.fin.me.isWindow) {
@@ -11921,7 +11940,7 @@ class LayoutModule extends base_1$5.Base {
     }
 }
 Factory$2.LayoutModule = LayoutModule;
-_LayoutModule_layoutInitializationAttempted = new WeakMap(), _LayoutModule_layoutManager = new WeakMap(), _LayoutModule_instances = new WeakSet(), _LayoutModule_getSafeLayoutManager = function _LayoutModule_getSafeLayoutManager(method) {
+_LayoutModule_layoutInitializationAttempted = new WeakMap(), _LayoutModule_layoutManager = new WeakMap(), _LayoutModule_getBackCompatLayoutManager = new WeakMap(), _LayoutModule_instances = new WeakSet(), _LayoutModule_getSafeLayoutManager = function _LayoutModule_getSafeLayoutManager(method) {
     if (!__classPrivateFieldGet$4(this, _LayoutModule_layoutManager, "f")) {
         throw new Error(`You must call init before using the API ${method}`);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/node-adapter",
-    "version": "36.78.6",
+    "version": "36.78.8",
     "description": "See README.md",
     "main": "out/node-adapter.js",
     "types": "out/node-adapter.d.ts",