@openfin/node-adapter 36.78.6 → 36.78.7

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/package.json

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