@openfin/node-adapter 37.81.19 → 37.81.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -934,7 +934,7 @@ declare type ApplicationIdentity_2 = {
934
934
  * @interface
935
935
  */
936
936
  declare type ApplicationInfo = {
937
- initialOptions: ApplicationCreationOptions | PlatformOptions;
937
+ initialOptions: WithUserAppConfigArgs & (ApplicationCreationOptions | PlatformOptions);
938
938
  launchMode: string;
939
939
  manifest: Manifest & {
940
940
  [key: string]: any;
@@ -7516,9 +7516,7 @@ declare class InteropClient extends Base {
7516
7516
  * ```
7517
7517
  *
7518
7518
  *
7519
- * We are also testing the ability to add a context handler for specific contexts. If you would like to use
7520
- * this, please make sure you add your context handlers at the top level of your application, on a page that
7521
- * does not navigate/reload/re-render, to avoid memory leaks. This feature is experimental:
7519
+ * Passing in a context type as the second parameter will cause the handler to only be invoked with that context type.
7522
7520
  *
7523
7521
  * ```js
7524
7522
  * function handleInstrumentContext(contextInfo) {
@@ -9828,6 +9826,7 @@ declare namespace OpenFin {
9828
9826
  AppVersionError,
9829
9827
  AppVersionRuntimeInfo,
9830
9828
  LaunchEmitter,
9829
+ UserAppConfigArgs,
9831
9830
  RvmLaunchOptions,
9832
9831
  ShortCutConfig,
9833
9832
  TerminateExternalRequestType,
@@ -12635,7 +12634,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
12635
12634
  declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
12636
12635
  topic: 'application';
12637
12636
  type: 'run-requested';
12638
- userAppConfigArgs: Record<string, any>;
12637
+ userAppConfigArgs: OpenFin.UserAppConfigArgs;
12639
12638
  manifest: OpenFin.Manifest;
12640
12639
  };
12641
12640
 
@@ -12750,7 +12749,7 @@ declare type RvmLaunchOptions = {
12750
12749
  * True if no UI when launching
12751
12750
  */
12752
12751
  noUi?: boolean;
12753
- userAppConfigArgs?: object;
12752
+ userAppConfigArgs?: UserAppConfigArgs;
12754
12753
  /**
12755
12754
  * Timeout in seconds until RVM launch request expires.
12756
12755
  */
@@ -15248,6 +15247,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
15248
15247
  httpStatusText: string;
15249
15248
  });
15250
15249
 
15250
+ /**
15251
+ * @interface
15252
+ */
15253
+ declare type UserAppConfigArgs = Record<string, string | string[]>;
15254
+
15251
15255
  /**
15252
15256
  * A general user bounds change event without event type.
15253
15257
  * @interface
@@ -18634,6 +18638,32 @@ declare type WithPositioningOptions<T extends {} = {}> = T & {
18634
18638
  positioningOptions?: OpenFin.PositioningOptions;
18635
18639
  };
18636
18640
 
18641
+ declare type WithUserAppConfigArgs = {
18642
+ /**
18643
+ * Represents the key-value pairs for the parameters passed into any fin:// or fins:// link
18644
+ * that launches this application.
18645
+ *
18646
+ * @remarks
18647
+ * In the link, user defined parameters are separated by the `$$` delimeter, for example:
18648
+ * `fins://path.to/app/manifest.json?$$use-last-configuration=true`
18649
+ *
18650
+ * Results in the following object:
18651
+ * ```json
18652
+ * {
18653
+ * "use-last-configuration": true"
18654
+ * }
18655
+ * ```
18656
+ *
18657
+ * These args can be accessed via the {@link ApplicationInfo.initialOptions} object:
18658
+ * ```typescript
18659
+ * const appInfo = await fin.Application.getCurrentSync().getInfo();
18660
+ * const { userAppConfigArgs } = appInfo.initialOptions;
18661
+ * console.log(userAppConfigArgs['use-last-configuration']); // 'true'
18662
+ * ```
18663
+ */
18664
+ userAppConfigArgs?: UserAppConfigArgs;
18665
+ };
18666
+
18637
18667
  /* Excluded from this release type: WorkspacePlatformOptions */
18638
18668
 
18639
18669
  /**
@@ -934,7 +934,7 @@ declare type ApplicationIdentity_2 = {
934
934
  * @interface
935
935
  */
936
936
  declare type ApplicationInfo = {
937
- initialOptions: ApplicationCreationOptions | PlatformOptions;
937
+ initialOptions: WithUserAppConfigArgs & (ApplicationCreationOptions | PlatformOptions);
938
938
  launchMode: string;
939
939
  manifest: Manifest & {
940
940
  [key: string]: any;
@@ -7516,9 +7516,7 @@ declare class InteropClient extends Base {
7516
7516
  * ```
7517
7517
  *
7518
7518
  *
7519
- * We are also testing the ability to add a context handler for specific contexts. If you would like to use
7520
- * this, please make sure you add your context handlers at the top level of your application, on a page that
7521
- * does not navigate/reload/re-render, to avoid memory leaks. This feature is experimental:
7519
+ * Passing in a context type as the second parameter will cause the handler to only be invoked with that context type.
7522
7520
  *
7523
7521
  * ```js
7524
7522
  * function handleInstrumentContext(contextInfo) {
@@ -9828,6 +9826,7 @@ declare namespace OpenFin {
9828
9826
  AppVersionError,
9829
9827
  AppVersionRuntimeInfo,
9830
9828
  LaunchEmitter,
9829
+ UserAppConfigArgs,
9831
9830
  RvmLaunchOptions,
9832
9831
  ShortCutConfig,
9833
9832
  TerminateExternalRequestType,
@@ -12635,7 +12634,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
12635
12634
  declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
12636
12635
  topic: 'application';
12637
12636
  type: 'run-requested';
12638
- userAppConfigArgs: Record<string, any>;
12637
+ userAppConfigArgs: OpenFin.UserAppConfigArgs;
12639
12638
  manifest: OpenFin.Manifest;
12640
12639
  };
12641
12640
 
@@ -12750,7 +12749,7 @@ declare type RvmLaunchOptions = {
12750
12749
  * True if no UI when launching
12751
12750
  */
12752
12751
  noUi?: boolean;
12753
- userAppConfigArgs?: object;
12752
+ userAppConfigArgs?: UserAppConfigArgs;
12754
12753
  /**
12755
12754
  * Timeout in seconds until RVM launch request expires.
12756
12755
  */
@@ -15248,6 +15247,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
15248
15247
  httpStatusText: string;
15249
15248
  });
15250
15249
 
15250
+ /**
15251
+ * @interface
15252
+ */
15253
+ declare type UserAppConfigArgs = Record<string, string | string[]>;
15254
+
15251
15255
  /**
15252
15256
  * A general user bounds change event without event type.
15253
15257
  * @interface
@@ -18634,6 +18638,32 @@ declare type WithPositioningOptions<T extends {} = {}> = T & {
18634
18638
  positioningOptions?: OpenFin.PositioningOptions;
18635
18639
  };
18636
18640
 
18641
+ declare type WithUserAppConfigArgs = {
18642
+ /**
18643
+ * Represents the key-value pairs for the parameters passed into any fin:// or fins:// link
18644
+ * that launches this application.
18645
+ *
18646
+ * @remarks
18647
+ * In the link, user defined parameters are separated by the `$$` delimeter, for example:
18648
+ * `fins://path.to/app/manifest.json?$$use-last-configuration=true`
18649
+ *
18650
+ * Results in the following object:
18651
+ * ```json
18652
+ * {
18653
+ * "use-last-configuration": true"
18654
+ * }
18655
+ * ```
18656
+ *
18657
+ * These args can be accessed via the {@link ApplicationInfo.initialOptions} object:
18658
+ * ```typescript
18659
+ * const appInfo = await fin.Application.getCurrentSync().getInfo();
18660
+ * const { userAppConfigArgs } = appInfo.initialOptions;
18661
+ * console.log(userAppConfigArgs['use-last-configuration']); // 'true'
18662
+ * ```
18663
+ */
18664
+ userAppConfigArgs?: UserAppConfigArgs;
18665
+ };
18666
+
18637
18667
  /* Excluded from this release type: WorkspacePlatformOptions */
18638
18668
 
18639
18669
  /**
@@ -934,7 +934,7 @@ declare type ApplicationIdentity_2 = {
934
934
  * @interface
935
935
  */
936
936
  declare type ApplicationInfo = {
937
- initialOptions: ApplicationCreationOptions | PlatformOptions;
937
+ initialOptions: WithUserAppConfigArgs & (ApplicationCreationOptions | PlatformOptions);
938
938
  launchMode: string;
939
939
  manifest: Manifest & {
940
940
  [key: string]: any;
@@ -7516,9 +7516,7 @@ declare class InteropClient extends Base {
7516
7516
  * ```
7517
7517
  *
7518
7518
  *
7519
- * We are also testing the ability to add a context handler for specific contexts. If you would like to use
7520
- * this, please make sure you add your context handlers at the top level of your application, on a page that
7521
- * does not navigate/reload/re-render, to avoid memory leaks. This feature is experimental:
7519
+ * Passing in a context type as the second parameter will cause the handler to only be invoked with that context type.
7522
7520
  *
7523
7521
  * ```js
7524
7522
  * function handleInstrumentContext(contextInfo) {
@@ -9828,6 +9826,7 @@ declare namespace OpenFin {
9828
9826
  AppVersionError,
9829
9827
  AppVersionRuntimeInfo,
9830
9828
  LaunchEmitter,
9829
+ UserAppConfigArgs,
9831
9830
  RvmLaunchOptions,
9832
9831
  ShortCutConfig,
9833
9832
  TerminateExternalRequestType,
@@ -12635,7 +12634,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
12635
12634
  declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
12636
12635
  topic: 'application';
12637
12636
  type: 'run-requested';
12638
- userAppConfigArgs: Record<string, any>;
12637
+ userAppConfigArgs: OpenFin.UserAppConfigArgs;
12639
12638
  manifest: OpenFin.Manifest;
12640
12639
  };
12641
12640
 
@@ -12750,7 +12749,7 @@ declare type RvmLaunchOptions = {
12750
12749
  * True if no UI when launching
12751
12750
  */
12752
12751
  noUi?: boolean;
12753
- userAppConfigArgs?: object;
12752
+ userAppConfigArgs?: UserAppConfigArgs;
12754
12753
  /**
12755
12754
  * Timeout in seconds until RVM launch request expires.
12756
12755
  */
@@ -15248,6 +15247,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
15248
15247
  httpStatusText: string;
15249
15248
  });
15250
15249
 
15250
+ /**
15251
+ * @interface
15252
+ */
15253
+ declare type UserAppConfigArgs = Record<string, string | string[]>;
15254
+
15251
15255
  /**
15252
15256
  * A general user bounds change event without event type.
15253
15257
  * @interface
@@ -18634,6 +18638,32 @@ declare type WithPositioningOptions<T extends {} = {}> = T & {
18634
18638
  positioningOptions?: OpenFin.PositioningOptions;
18635
18639
  };
18636
18640
 
18641
+ declare type WithUserAppConfigArgs = {
18642
+ /**
18643
+ * Represents the key-value pairs for the parameters passed into any fin:// or fins:// link
18644
+ * that launches this application.
18645
+ *
18646
+ * @remarks
18647
+ * In the link, user defined parameters are separated by the `$$` delimeter, for example:
18648
+ * `fins://path.to/app/manifest.json?$$use-last-configuration=true`
18649
+ *
18650
+ * Results in the following object:
18651
+ * ```json
18652
+ * {
18653
+ * "use-last-configuration": true"
18654
+ * }
18655
+ * ```
18656
+ *
18657
+ * These args can be accessed via the {@link ApplicationInfo.initialOptions} object:
18658
+ * ```typescript
18659
+ * const appInfo = await fin.Application.getCurrentSync().getInfo();
18660
+ * const { userAppConfigArgs } = appInfo.initialOptions;
18661
+ * console.log(userAppConfigArgs['use-last-configuration']); // 'true'
18662
+ * ```
18663
+ */
18664
+ userAppConfigArgs?: UserAppConfigArgs;
18665
+ };
18666
+
18637
18667
  /* Excluded from this release type: WorkspacePlatformOptions */
18638
18668
 
18639
18669
  /**
@@ -940,7 +940,7 @@ declare type ApplicationIdentity_2 = {
940
940
  * @interface
941
941
  */
942
942
  declare type ApplicationInfo = {
943
- initialOptions: ApplicationCreationOptions | PlatformOptions;
943
+ initialOptions: WithUserAppConfigArgs & (ApplicationCreationOptions | PlatformOptions);
944
944
  launchMode: string;
945
945
  manifest: Manifest & {
946
946
  [key: string]: any;
@@ -7650,9 +7650,7 @@ declare class InteropClient extends Base {
7650
7650
  * ```
7651
7651
  *
7652
7652
  *
7653
- * We are also testing the ability to add a context handler for specific contexts. If you would like to use
7654
- * this, please make sure you add your context handlers at the top level of your application, on a page that
7655
- * does not navigate/reload/re-render, to avoid memory leaks. This feature is experimental:
7653
+ * Passing in a context type as the second parameter will cause the handler to only be invoked with that context type.
7656
7654
  *
7657
7655
  * ```js
7658
7656
  * function handleInstrumentContext(contextInfo) {
@@ -10165,6 +10163,7 @@ declare namespace OpenFin {
10165
10163
  AppVersionError,
10166
10164
  AppVersionRuntimeInfo,
10167
10165
  LaunchEmitter,
10166
+ UserAppConfigArgs,
10168
10167
  RvmLaunchOptions,
10169
10168
  ShortCutConfig,
10170
10169
  TerminateExternalRequestType,
@@ -13050,7 +13049,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
13050
13049
  declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
13051
13050
  topic: 'application';
13052
13051
  type: 'run-requested';
13053
- userAppConfigArgs: Record<string, any>;
13052
+ userAppConfigArgs: OpenFin.UserAppConfigArgs;
13054
13053
  manifest: OpenFin.Manifest;
13055
13054
  };
13056
13055
 
@@ -13165,7 +13164,7 @@ declare type RvmLaunchOptions = {
13165
13164
  * True if no UI when launching
13166
13165
  */
13167
13166
  noUi?: boolean;
13168
- userAppConfigArgs?: object;
13167
+ userAppConfigArgs?: UserAppConfigArgs;
13169
13168
  /**
13170
13169
  * Timeout in seconds until RVM launch request expires.
13171
13170
  */
@@ -15676,6 +15675,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
15676
15675
  httpStatusText: string;
15677
15676
  });
15678
15677
 
15678
+ /**
15679
+ * @interface
15680
+ */
15681
+ declare type UserAppConfigArgs = Record<string, string | string[]>;
15682
+
15679
15683
  /**
15680
15684
  * A general user bounds change event without event type.
15681
15685
  * @interface
@@ -19108,6 +19112,32 @@ declare type WithPositioningOptions<T extends {} = {}> = T & {
19108
19112
  positioningOptions?: OpenFin.PositioningOptions;
19109
19113
  };
19110
19114
 
19115
+ declare type WithUserAppConfigArgs = {
19116
+ /**
19117
+ * Represents the key-value pairs for the parameters passed into any fin:// or fins:// link
19118
+ * that launches this application.
19119
+ *
19120
+ * @remarks
19121
+ * In the link, user defined parameters are separated by the `$$` delimeter, for example:
19122
+ * `fins://path.to/app/manifest.json?$$use-last-configuration=true`
19123
+ *
19124
+ * Results in the following object:
19125
+ * ```json
19126
+ * {
19127
+ * "use-last-configuration": true"
19128
+ * }
19129
+ * ```
19130
+ *
19131
+ * These args can be accessed via the {@link ApplicationInfo.initialOptions} object:
19132
+ * ```typescript
19133
+ * const appInfo = await fin.Application.getCurrentSync().getInfo();
19134
+ * const { userAppConfigArgs } = appInfo.initialOptions;
19135
+ * console.log(userAppConfigArgs['use-last-configuration']); // 'true'
19136
+ * ```
19137
+ */
19138
+ userAppConfigArgs?: UserAppConfigArgs;
19139
+ };
19140
+
19111
19141
  /**
19112
19142
  * @internal
19113
19143
  * @interface
@@ -15682,9 +15682,7 @@ function requireInteropClient () {
15682
15682
  * ```
15683
15683
  *
15684
15684
  *
15685
- * We are also testing the ability to add a context handler for specific contexts. If you would like to use
15686
- * this, please make sure you add your context handlers at the top level of your application, on a page that
15687
- * does not navigate/reload/re-render, to avoid memory leaks. This feature is experimental:
15685
+ * Passing in a context type as the second parameter will cause the handler to only be invoked with that context type.
15688
15686
  *
15689
15687
  * ```js
15690
15688
  * function handleInstrumentContext(contextInfo) {
@@ -15713,7 +15711,6 @@ function requireInteropClient () {
15713
15711
  let handlerId;
15714
15712
  if (contextType) {
15715
15713
  handlerId = `invokeContextHandler-${contextType}-${(0, utils_1.generateId)()}`;
15716
- console.warn(`Warning: By providing a contextType (${contextType}), you are using the experimental addContextHandler. To avoid issues, make sure you are adding your context handlers at the top level in your application.`);
15717
15714
  }
15718
15715
  else {
15719
15716
  handlerId = 'invokeContextHandler';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/node-adapter",
3
- "version": "37.81.19",
3
+ "version": "37.81.20",
4
4
  "description": "See README.md",
5
5
  "main": "out/node-adapter.js",
6
6
  "types": "out/node-adapter.d.ts",