@openfin/core 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;
@@ -7508,9 +7508,7 @@ declare class InteropClient extends Base {
7508
7508
  * ```
7509
7509
  *
7510
7510
  *
7511
- * We are also testing the ability to add a context handler for specific contexts. If you would like to use
7512
- * this, please make sure you add your context handlers at the top level of your application, on a page that
7513
- * does not navigate/reload/re-render, to avoid memory leaks. This feature is experimental:
7511
+ * Passing in a context type as the second parameter will cause the handler to only be invoked with that context type.
7514
7512
  *
7515
7513
  * ```js
7516
7514
  * function handleInstrumentContext(contextInfo) {
@@ -9818,6 +9816,7 @@ declare namespace OpenFin_2 {
9818
9816
  AppVersionError,
9819
9817
  AppVersionRuntimeInfo,
9820
9818
  LaunchEmitter,
9819
+ UserAppConfigArgs,
9821
9820
  RvmLaunchOptions,
9822
9821
  ShortCutConfig,
9823
9822
  TerminateExternalRequestType,
@@ -12625,7 +12624,7 @@ declare type RunRequestedEvent = OpenFin_2.ApplicationEvents.RunRequestedEvent;
12625
12624
  declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
12626
12625
  topic: 'application';
12627
12626
  type: 'run-requested';
12628
- userAppConfigArgs: Record<string, any>;
12627
+ userAppConfigArgs: OpenFin_2.UserAppConfigArgs;
12629
12628
  manifest: OpenFin_2.Manifest;
12630
12629
  };
12631
12630
 
@@ -12740,7 +12739,7 @@ declare type RvmLaunchOptions = {
12740
12739
  * True if no UI when launching
12741
12740
  */
12742
12741
  noUi?: boolean;
12743
- userAppConfigArgs?: object;
12742
+ userAppConfigArgs?: UserAppConfigArgs;
12744
12743
  /**
12745
12744
  * Timeout in seconds until RVM launch request expires.
12746
12745
  */
@@ -15238,6 +15237,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
15238
15237
  httpStatusText: string;
15239
15238
  });
15240
15239
 
15240
+ /**
15241
+ * @interface
15242
+ */
15243
+ declare type UserAppConfigArgs = Record<string, string | string[]>;
15244
+
15241
15245
  /**
15242
15246
  * A general user bounds change event without event type.
15243
15247
  * @interface
@@ -18624,6 +18628,32 @@ declare type WithPositioningOptions<T extends {} = {}> = T & {
18624
18628
  positioningOptions?: OpenFin_2.PositioningOptions;
18625
18629
  };
18626
18630
 
18631
+ declare type WithUserAppConfigArgs = {
18632
+ /**
18633
+ * Represents the key-value pairs for the parameters passed into any fin:// or fins:// link
18634
+ * that launches this application.
18635
+ *
18636
+ * @remarks
18637
+ * In the link, user defined parameters are separated by the `$$` delimeter, for example:
18638
+ * `fins://path.to/app/manifest.json?$$use-last-configuration=true`
18639
+ *
18640
+ * Results in the following object:
18641
+ * ```json
18642
+ * {
18643
+ * "use-last-configuration": true"
18644
+ * }
18645
+ * ```
18646
+ *
18647
+ * These args can be accessed via the {@link ApplicationInfo.initialOptions} object:
18648
+ * ```typescript
18649
+ * const appInfo = await fin.Application.getCurrentSync().getInfo();
18650
+ * const { userAppConfigArgs } = appInfo.initialOptions;
18651
+ * console.log(userAppConfigArgs['use-last-configuration']); // 'true'
18652
+ * ```
18653
+ */
18654
+ userAppConfigArgs?: UserAppConfigArgs;
18655
+ };
18656
+
18627
18657
  /* Excluded from this release type: WorkspacePlatformOptions */
18628
18658
 
18629
18659
  /**
@@ -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;
@@ -7508,9 +7508,7 @@ declare class InteropClient extends Base {
7508
7508
  * ```
7509
7509
  *
7510
7510
  *
7511
- * We are also testing the ability to add a context handler for specific contexts. If you would like to use
7512
- * this, please make sure you add your context handlers at the top level of your application, on a page that
7513
- * does not navigate/reload/re-render, to avoid memory leaks. This feature is experimental:
7511
+ * Passing in a context type as the second parameter will cause the handler to only be invoked with that context type.
7514
7512
  *
7515
7513
  * ```js
7516
7514
  * function handleInstrumentContext(contextInfo) {
@@ -9818,6 +9816,7 @@ declare namespace OpenFin_2 {
9818
9816
  AppVersionError,
9819
9817
  AppVersionRuntimeInfo,
9820
9818
  LaunchEmitter,
9819
+ UserAppConfigArgs,
9821
9820
  RvmLaunchOptions,
9822
9821
  ShortCutConfig,
9823
9822
  TerminateExternalRequestType,
@@ -12625,7 +12624,7 @@ declare type RunRequestedEvent = OpenFin_2.ApplicationEvents.RunRequestedEvent;
12625
12624
  declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
12626
12625
  topic: 'application';
12627
12626
  type: 'run-requested';
12628
- userAppConfigArgs: Record<string, any>;
12627
+ userAppConfigArgs: OpenFin_2.UserAppConfigArgs;
12629
12628
  manifest: OpenFin_2.Manifest;
12630
12629
  };
12631
12630
 
@@ -12740,7 +12739,7 @@ declare type RvmLaunchOptions = {
12740
12739
  * True if no UI when launching
12741
12740
  */
12742
12741
  noUi?: boolean;
12743
- userAppConfigArgs?: object;
12742
+ userAppConfigArgs?: UserAppConfigArgs;
12744
12743
  /**
12745
12744
  * Timeout in seconds until RVM launch request expires.
12746
12745
  */
@@ -15238,6 +15237,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
15238
15237
  httpStatusText: string;
15239
15238
  });
15240
15239
 
15240
+ /**
15241
+ * @interface
15242
+ */
15243
+ declare type UserAppConfigArgs = Record<string, string | string[]>;
15244
+
15241
15245
  /**
15242
15246
  * A general user bounds change event without event type.
15243
15247
  * @interface
@@ -18624,6 +18628,32 @@ declare type WithPositioningOptions<T extends {} = {}> = T & {
18624
18628
  positioningOptions?: OpenFin_2.PositioningOptions;
18625
18629
  };
18626
18630
 
18631
+ declare type WithUserAppConfigArgs = {
18632
+ /**
18633
+ * Represents the key-value pairs for the parameters passed into any fin:// or fins:// link
18634
+ * that launches this application.
18635
+ *
18636
+ * @remarks
18637
+ * In the link, user defined parameters are separated by the `$$` delimeter, for example:
18638
+ * `fins://path.to/app/manifest.json?$$use-last-configuration=true`
18639
+ *
18640
+ * Results in the following object:
18641
+ * ```json
18642
+ * {
18643
+ * "use-last-configuration": true"
18644
+ * }
18645
+ * ```
18646
+ *
18647
+ * These args can be accessed via the {@link ApplicationInfo.initialOptions} object:
18648
+ * ```typescript
18649
+ * const appInfo = await fin.Application.getCurrentSync().getInfo();
18650
+ * const { userAppConfigArgs } = appInfo.initialOptions;
18651
+ * console.log(userAppConfigArgs['use-last-configuration']); // 'true'
18652
+ * ```
18653
+ */
18654
+ userAppConfigArgs?: UserAppConfigArgs;
18655
+ };
18656
+
18627
18657
  /* Excluded from this release type: WorkspacePlatformOptions */
18628
18658
 
18629
18659
  /**
@@ -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;
@@ -7508,9 +7508,7 @@ declare class InteropClient extends Base {
7508
7508
  * ```
7509
7509
  *
7510
7510
  *
7511
- * We are also testing the ability to add a context handler for specific contexts. If you would like to use
7512
- * this, please make sure you add your context handlers at the top level of your application, on a page that
7513
- * does not navigate/reload/re-render, to avoid memory leaks. This feature is experimental:
7511
+ * Passing in a context type as the second parameter will cause the handler to only be invoked with that context type.
7514
7512
  *
7515
7513
  * ```js
7516
7514
  * function handleInstrumentContext(contextInfo) {
@@ -9818,6 +9816,7 @@ declare namespace OpenFin_2 {
9818
9816
  AppVersionError,
9819
9817
  AppVersionRuntimeInfo,
9820
9818
  LaunchEmitter,
9819
+ UserAppConfigArgs,
9821
9820
  RvmLaunchOptions,
9822
9821
  ShortCutConfig,
9823
9822
  TerminateExternalRequestType,
@@ -12625,7 +12624,7 @@ declare type RunRequestedEvent = OpenFin_2.ApplicationEvents.RunRequestedEvent;
12625
12624
  declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
12626
12625
  topic: 'application';
12627
12626
  type: 'run-requested';
12628
- userAppConfigArgs: Record<string, any>;
12627
+ userAppConfigArgs: OpenFin_2.UserAppConfigArgs;
12629
12628
  manifest: OpenFin_2.Manifest;
12630
12629
  };
12631
12630
 
@@ -12740,7 +12739,7 @@ declare type RvmLaunchOptions = {
12740
12739
  * True if no UI when launching
12741
12740
  */
12742
12741
  noUi?: boolean;
12743
- userAppConfigArgs?: object;
12742
+ userAppConfigArgs?: UserAppConfigArgs;
12744
12743
  /**
12745
12744
  * Timeout in seconds until RVM launch request expires.
12746
12745
  */
@@ -15238,6 +15237,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
15238
15237
  httpStatusText: string;
15239
15238
  });
15240
15239
 
15240
+ /**
15241
+ * @interface
15242
+ */
15243
+ declare type UserAppConfigArgs = Record<string, string | string[]>;
15244
+
15241
15245
  /**
15242
15246
  * A general user bounds change event without event type.
15243
15247
  * @interface
@@ -18624,6 +18628,32 @@ declare type WithPositioningOptions<T extends {} = {}> = T & {
18624
18628
  positioningOptions?: OpenFin_2.PositioningOptions;
18625
18629
  };
18626
18630
 
18631
+ declare type WithUserAppConfigArgs = {
18632
+ /**
18633
+ * Represents the key-value pairs for the parameters passed into any fin:// or fins:// link
18634
+ * that launches this application.
18635
+ *
18636
+ * @remarks
18637
+ * In the link, user defined parameters are separated by the `$$` delimeter, for example:
18638
+ * `fins://path.to/app/manifest.json?$$use-last-configuration=true`
18639
+ *
18640
+ * Results in the following object:
18641
+ * ```json
18642
+ * {
18643
+ * "use-last-configuration": true"
18644
+ * }
18645
+ * ```
18646
+ *
18647
+ * These args can be accessed via the {@link ApplicationInfo.initialOptions} object:
18648
+ * ```typescript
18649
+ * const appInfo = await fin.Application.getCurrentSync().getInfo();
18650
+ * const { userAppConfigArgs } = appInfo.initialOptions;
18651
+ * console.log(userAppConfigArgs['use-last-configuration']); // 'true'
18652
+ * ```
18653
+ */
18654
+ userAppConfigArgs?: UserAppConfigArgs;
18655
+ };
18656
+
18627
18657
  /* Excluded from this release type: WorkspacePlatformOptions */
18628
18658
 
18629
18659
  /**
package/out/mock.d.ts CHANGED
@@ -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;
@@ -7620,9 +7620,7 @@ declare class InteropClient extends Base {
7620
7620
  * ```
7621
7621
  *
7622
7622
  *
7623
- * We are also testing the ability to add a context handler for specific contexts. If you would like to use
7624
- * this, please make sure you add your context handlers at the top level of your application, on a page that
7625
- * does not navigate/reload/re-render, to avoid memory leaks. This feature is experimental:
7623
+ * Passing in a context type as the second parameter will cause the handler to only be invoked with that context type.
7626
7624
  *
7627
7625
  * ```js
7628
7626
  * function handleInstrumentContext(contextInfo) {
@@ -10133,6 +10131,7 @@ declare namespace OpenFin_2 {
10133
10131
  AppVersionError,
10134
10132
  AppVersionRuntimeInfo,
10135
10133
  LaunchEmitter,
10134
+ UserAppConfigArgs,
10136
10135
  RvmLaunchOptions,
10137
10136
  ShortCutConfig,
10138
10137
  TerminateExternalRequestType,
@@ -13018,7 +13017,7 @@ declare type RunRequestedEvent = OpenFin_2.ApplicationEvents.RunRequestedEvent;
13018
13017
  declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
13019
13018
  topic: 'application';
13020
13019
  type: 'run-requested';
13021
- userAppConfigArgs: Record<string, any>;
13020
+ userAppConfigArgs: OpenFin_2.UserAppConfigArgs;
13022
13021
  manifest: OpenFin_2.Manifest;
13023
13022
  };
13024
13023
 
@@ -13133,7 +13132,7 @@ declare type RvmLaunchOptions = {
13133
13132
  * True if no UI when launching
13134
13133
  */
13135
13134
  noUi?: boolean;
13136
- userAppConfigArgs?: object;
13135
+ userAppConfigArgs?: UserAppConfigArgs;
13137
13136
  /**
13138
13137
  * Timeout in seconds until RVM launch request expires.
13139
13138
  */
@@ -15644,6 +15643,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
15644
15643
  httpStatusText: string;
15645
15644
  });
15646
15645
 
15646
+ /**
15647
+ * @interface
15648
+ */
15649
+ declare type UserAppConfigArgs = Record<string, string | string[]>;
15650
+
15647
15651
  /**
15648
15652
  * A general user bounds change event without event type.
15649
15653
  * @interface
@@ -19076,6 +19080,32 @@ declare type WithPositioningOptions<T extends {} = {}> = T & {
19076
19080
  positioningOptions?: OpenFin_2.PositioningOptions;
19077
19081
  };
19078
19082
 
19083
+ declare type WithUserAppConfigArgs = {
19084
+ /**
19085
+ * Represents the key-value pairs for the parameters passed into any fin:// or fins:// link
19086
+ * that launches this application.
19087
+ *
19088
+ * @remarks
19089
+ * In the link, user defined parameters are separated by the `$$` delimeter, for example:
19090
+ * `fins://path.to/app/manifest.json?$$use-last-configuration=true`
19091
+ *
19092
+ * Results in the following object:
19093
+ * ```json
19094
+ * {
19095
+ * "use-last-configuration": true"
19096
+ * }
19097
+ * ```
19098
+ *
19099
+ * These args can be accessed via the {@link ApplicationInfo.initialOptions} object:
19100
+ * ```typescript
19101
+ * const appInfo = await fin.Application.getCurrentSync().getInfo();
19102
+ * const { userAppConfigArgs } = appInfo.initialOptions;
19103
+ * console.log(userAppConfigArgs['use-last-configuration']); // 'true'
19104
+ * ```
19105
+ */
19106
+ userAppConfigArgs?: UserAppConfigArgs;
19107
+ };
19108
+
19079
19109
  /**
19080
19110
  * @internal
19081
19111
  * @interface
package/out/mock.js CHANGED
@@ -15909,9 +15909,7 @@ function requireInteropClient () {
15909
15909
  * ```
15910
15910
  *
15911
15911
  *
15912
- * We are also testing the ability to add a context handler for specific contexts. If you would like to use
15913
- * this, please make sure you add your context handlers at the top level of your application, on a page that
15914
- * does not navigate/reload/re-render, to avoid memory leaks. This feature is experimental:
15912
+ * Passing in a context type as the second parameter will cause the handler to only be invoked with that context type.
15915
15913
  *
15916
15914
  * ```js
15917
15915
  * function handleInstrumentContext(contextInfo) {
@@ -15940,7 +15938,6 @@ function requireInteropClient () {
15940
15938
  let handlerId;
15941
15939
  if (contextType) {
15942
15940
  handlerId = `invokeContextHandler-${contextType}-${(0, utils_1.generateId)()}`;
15943
- 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.`);
15944
15941
  }
15945
15942
  else {
15946
15943
  handlerId = 'invokeContextHandler';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/core",
3
- "version": "37.81.19",
3
+ "version": "37.81.20",
4
4
  "description": "The core renderer entry point of OpenFin",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "main": "out/mock.js",