@openfin/remote-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;
@@ -7551,9 +7551,7 @@ declare class InteropClient extends Base {
7551
7551
  * ```
7552
7552
  *
7553
7553
  *
7554
- * We are also testing the ability to add a context handler for specific contexts. If you would like to use
7555
- * this, please make sure you add your context handlers at the top level of your application, on a page that
7556
- * does not navigate/reload/re-render, to avoid memory leaks. This feature is experimental:
7554
+ * Passing in a context type as the second parameter will cause the handler to only be invoked with that context type.
7557
7555
  *
7558
7556
  * ```js
7559
7557
  * function handleInstrumentContext(contextInfo) {
@@ -9861,6 +9859,7 @@ declare namespace OpenFin {
9861
9859
  AppVersionError,
9862
9860
  AppVersionRuntimeInfo,
9863
9861
  LaunchEmitter,
9862
+ UserAppConfigArgs,
9864
9863
  RvmLaunchOptions,
9865
9864
  ShortCutConfig,
9866
9865
  TerminateExternalRequestType,
@@ -12667,7 +12666,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
12667
12666
  declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
12668
12667
  topic: 'application';
12669
12668
  type: 'run-requested';
12670
- userAppConfigArgs: Record<string, any>;
12669
+ userAppConfigArgs: OpenFin.UserAppConfigArgs;
12671
12670
  manifest: OpenFin.Manifest;
12672
12671
  };
12673
12672
 
@@ -12782,7 +12781,7 @@ declare type RvmLaunchOptions = {
12782
12781
  * True if no UI when launching
12783
12782
  */
12784
12783
  noUi?: boolean;
12785
- userAppConfigArgs?: object;
12784
+ userAppConfigArgs?: UserAppConfigArgs;
12786
12785
  /**
12787
12786
  * Timeout in seconds until RVM launch request expires.
12788
12787
  */
@@ -15280,6 +15279,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
15280
15279
  httpStatusText: string;
15281
15280
  });
15282
15281
 
15282
+ /**
15283
+ * @interface
15284
+ */
15285
+ declare type UserAppConfigArgs = Record<string, string | string[]>;
15286
+
15283
15287
  /**
15284
15288
  * A general user bounds change event without event type.
15285
15289
  * @interface
@@ -18666,6 +18670,32 @@ declare type WithPositioningOptions<T extends {} = {}> = T & {
18666
18670
  positioningOptions?: OpenFin.PositioningOptions;
18667
18671
  };
18668
18672
 
18673
+ declare type WithUserAppConfigArgs = {
18674
+ /**
18675
+ * Represents the key-value pairs for the parameters passed into any fin:// or fins:// link
18676
+ * that launches this application.
18677
+ *
18678
+ * @remarks
18679
+ * In the link, user defined parameters are separated by the `$$` delimeter, for example:
18680
+ * `fins://path.to/app/manifest.json?$$use-last-configuration=true`
18681
+ *
18682
+ * Results in the following object:
18683
+ * ```json
18684
+ * {
18685
+ * "use-last-configuration": true"
18686
+ * }
18687
+ * ```
18688
+ *
18689
+ * These args can be accessed via the {@link ApplicationInfo.initialOptions} object:
18690
+ * ```typescript
18691
+ * const appInfo = await fin.Application.getCurrentSync().getInfo();
18692
+ * const { userAppConfigArgs } = appInfo.initialOptions;
18693
+ * console.log(userAppConfigArgs['use-last-configuration']); // 'true'
18694
+ * ```
18695
+ */
18696
+ userAppConfigArgs?: UserAppConfigArgs;
18697
+ };
18698
+
18669
18699
  /* Excluded from this release type: WorkspacePlatformOptions */
18670
18700
 
18671
18701
  /**
@@ -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;
@@ -7551,9 +7551,7 @@ declare class InteropClient extends Base {
7551
7551
  * ```
7552
7552
  *
7553
7553
  *
7554
- * We are also testing the ability to add a context handler for specific contexts. If you would like to use
7555
- * this, please make sure you add your context handlers at the top level of your application, on a page that
7556
- * does not navigate/reload/re-render, to avoid memory leaks. This feature is experimental:
7554
+ * Passing in a context type as the second parameter will cause the handler to only be invoked with that context type.
7557
7555
  *
7558
7556
  * ```js
7559
7557
  * function handleInstrumentContext(contextInfo) {
@@ -9861,6 +9859,7 @@ declare namespace OpenFin {
9861
9859
  AppVersionError,
9862
9860
  AppVersionRuntimeInfo,
9863
9861
  LaunchEmitter,
9862
+ UserAppConfigArgs,
9864
9863
  RvmLaunchOptions,
9865
9864
  ShortCutConfig,
9866
9865
  TerminateExternalRequestType,
@@ -12667,7 +12666,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
12667
12666
  declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
12668
12667
  topic: 'application';
12669
12668
  type: 'run-requested';
12670
- userAppConfigArgs: Record<string, any>;
12669
+ userAppConfigArgs: OpenFin.UserAppConfigArgs;
12671
12670
  manifest: OpenFin.Manifest;
12672
12671
  };
12673
12672
 
@@ -12782,7 +12781,7 @@ declare type RvmLaunchOptions = {
12782
12781
  * True if no UI when launching
12783
12782
  */
12784
12783
  noUi?: boolean;
12785
- userAppConfigArgs?: object;
12784
+ userAppConfigArgs?: UserAppConfigArgs;
12786
12785
  /**
12787
12786
  * Timeout in seconds until RVM launch request expires.
12788
12787
  */
@@ -15280,6 +15279,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
15280
15279
  httpStatusText: string;
15281
15280
  });
15282
15281
 
15282
+ /**
15283
+ * @interface
15284
+ */
15285
+ declare type UserAppConfigArgs = Record<string, string | string[]>;
15286
+
15283
15287
  /**
15284
15288
  * A general user bounds change event without event type.
15285
15289
  * @interface
@@ -18666,6 +18670,32 @@ declare type WithPositioningOptions<T extends {} = {}> = T & {
18666
18670
  positioningOptions?: OpenFin.PositioningOptions;
18667
18671
  };
18668
18672
 
18673
+ declare type WithUserAppConfigArgs = {
18674
+ /**
18675
+ * Represents the key-value pairs for the parameters passed into any fin:// or fins:// link
18676
+ * that launches this application.
18677
+ *
18678
+ * @remarks
18679
+ * In the link, user defined parameters are separated by the `$$` delimeter, for example:
18680
+ * `fins://path.to/app/manifest.json?$$use-last-configuration=true`
18681
+ *
18682
+ * Results in the following object:
18683
+ * ```json
18684
+ * {
18685
+ * "use-last-configuration": true"
18686
+ * }
18687
+ * ```
18688
+ *
18689
+ * These args can be accessed via the {@link ApplicationInfo.initialOptions} object:
18690
+ * ```typescript
18691
+ * const appInfo = await fin.Application.getCurrentSync().getInfo();
18692
+ * const { userAppConfigArgs } = appInfo.initialOptions;
18693
+ * console.log(userAppConfigArgs['use-last-configuration']); // 'true'
18694
+ * ```
18695
+ */
18696
+ userAppConfigArgs?: UserAppConfigArgs;
18697
+ };
18698
+
18669
18699
  /* Excluded from this release type: WorkspacePlatformOptions */
18670
18700
 
18671
18701
  /**
@@ -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;
@@ -7551,9 +7551,7 @@ declare class InteropClient extends Base {
7551
7551
  * ```
7552
7552
  *
7553
7553
  *
7554
- * We are also testing the ability to add a context handler for specific contexts. If you would like to use
7555
- * this, please make sure you add your context handlers at the top level of your application, on a page that
7556
- * does not navigate/reload/re-render, to avoid memory leaks. This feature is experimental:
7554
+ * Passing in a context type as the second parameter will cause the handler to only be invoked with that context type.
7557
7555
  *
7558
7556
  * ```js
7559
7557
  * function handleInstrumentContext(contextInfo) {
@@ -9861,6 +9859,7 @@ declare namespace OpenFin {
9861
9859
  AppVersionError,
9862
9860
  AppVersionRuntimeInfo,
9863
9861
  LaunchEmitter,
9862
+ UserAppConfigArgs,
9864
9863
  RvmLaunchOptions,
9865
9864
  ShortCutConfig,
9866
9865
  TerminateExternalRequestType,
@@ -12667,7 +12666,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
12667
12666
  declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
12668
12667
  topic: 'application';
12669
12668
  type: 'run-requested';
12670
- userAppConfigArgs: Record<string, any>;
12669
+ userAppConfigArgs: OpenFin.UserAppConfigArgs;
12671
12670
  manifest: OpenFin.Manifest;
12672
12671
  };
12673
12672
 
@@ -12782,7 +12781,7 @@ declare type RvmLaunchOptions = {
12782
12781
  * True if no UI when launching
12783
12782
  */
12784
12783
  noUi?: boolean;
12785
- userAppConfigArgs?: object;
12784
+ userAppConfigArgs?: UserAppConfigArgs;
12786
12785
  /**
12787
12786
  * Timeout in seconds until RVM launch request expires.
12788
12787
  */
@@ -15280,6 +15279,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
15280
15279
  httpStatusText: string;
15281
15280
  });
15282
15281
 
15282
+ /**
15283
+ * @interface
15284
+ */
15285
+ declare type UserAppConfigArgs = Record<string, string | string[]>;
15286
+
15283
15287
  /**
15284
15288
  * A general user bounds change event without event type.
15285
15289
  * @interface
@@ -18666,6 +18670,32 @@ declare type WithPositioningOptions<T extends {} = {}> = T & {
18666
18670
  positioningOptions?: OpenFin.PositioningOptions;
18667
18671
  };
18668
18672
 
18673
+ declare type WithUserAppConfigArgs = {
18674
+ /**
18675
+ * Represents the key-value pairs for the parameters passed into any fin:// or fins:// link
18676
+ * that launches this application.
18677
+ *
18678
+ * @remarks
18679
+ * In the link, user defined parameters are separated by the `$$` delimeter, for example:
18680
+ * `fins://path.to/app/manifest.json?$$use-last-configuration=true`
18681
+ *
18682
+ * Results in the following object:
18683
+ * ```json
18684
+ * {
18685
+ * "use-last-configuration": true"
18686
+ * }
18687
+ * ```
18688
+ *
18689
+ * These args can be accessed via the {@link ApplicationInfo.initialOptions} object:
18690
+ * ```typescript
18691
+ * const appInfo = await fin.Application.getCurrentSync().getInfo();
18692
+ * const { userAppConfigArgs } = appInfo.initialOptions;
18693
+ * console.log(userAppConfigArgs['use-last-configuration']); // 'true'
18694
+ * ```
18695
+ */
18696
+ userAppConfigArgs?: UserAppConfigArgs;
18697
+ };
18698
+
18669
18699
  /* Excluded from this release type: WorkspacePlatformOptions */
18670
18700
 
18671
18701
  /**
@@ -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;
@@ -7663,9 +7663,7 @@ declare class InteropClient extends Base {
7663
7663
  * ```
7664
7664
  *
7665
7665
  *
7666
- * We are also testing the ability to add a context handler for specific contexts. If you would like to use
7667
- * this, please make sure you add your context handlers at the top level of your application, on a page that
7668
- * does not navigate/reload/re-render, to avoid memory leaks. This feature is experimental:
7666
+ * Passing in a context type as the second parameter will cause the handler to only be invoked with that context type.
7669
7667
  *
7670
7668
  * ```js
7671
7669
  * function handleInstrumentContext(contextInfo) {
@@ -10176,6 +10174,7 @@ declare namespace OpenFin {
10176
10174
  AppVersionError,
10177
10175
  AppVersionRuntimeInfo,
10178
10176
  LaunchEmitter,
10177
+ UserAppConfigArgs,
10179
10178
  RvmLaunchOptions,
10180
10179
  ShortCutConfig,
10181
10180
  TerminateExternalRequestType,
@@ -13060,7 +13059,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
13060
13059
  declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
13061
13060
  topic: 'application';
13062
13061
  type: 'run-requested';
13063
- userAppConfigArgs: Record<string, any>;
13062
+ userAppConfigArgs: OpenFin.UserAppConfigArgs;
13064
13063
  manifest: OpenFin.Manifest;
13065
13064
  };
13066
13065
 
@@ -13175,7 +13174,7 @@ declare type RvmLaunchOptions = {
13175
13174
  * True if no UI when launching
13176
13175
  */
13177
13176
  noUi?: boolean;
13178
- userAppConfigArgs?: object;
13177
+ userAppConfigArgs?: UserAppConfigArgs;
13179
13178
  /**
13180
13179
  * Timeout in seconds until RVM launch request expires.
13181
13180
  */
@@ -15686,6 +15685,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
15686
15685
  httpStatusText: string;
15687
15686
  });
15688
15687
 
15688
+ /**
15689
+ * @interface
15690
+ */
15691
+ declare type UserAppConfigArgs = Record<string, string | string[]>;
15692
+
15689
15693
  /**
15690
15694
  * A general user bounds change event without event type.
15691
15695
  * @interface
@@ -19118,6 +19122,32 @@ declare type WithPositioningOptions<T extends {} = {}> = T & {
19118
19122
  positioningOptions?: OpenFin.PositioningOptions;
19119
19123
  };
19120
19124
 
19125
+ declare type WithUserAppConfigArgs = {
19126
+ /**
19127
+ * Represents the key-value pairs for the parameters passed into any fin:// or fins:// link
19128
+ * that launches this application.
19129
+ *
19130
+ * @remarks
19131
+ * In the link, user defined parameters are separated by the `$$` delimeter, for example:
19132
+ * `fins://path.to/app/manifest.json?$$use-last-configuration=true`
19133
+ *
19134
+ * Results in the following object:
19135
+ * ```json
19136
+ * {
19137
+ * "use-last-configuration": true"
19138
+ * }
19139
+ * ```
19140
+ *
19141
+ * These args can be accessed via the {@link ApplicationInfo.initialOptions} object:
19142
+ * ```typescript
19143
+ * const appInfo = await fin.Application.getCurrentSync().getInfo();
19144
+ * const { userAppConfigArgs } = appInfo.initialOptions;
19145
+ * console.log(userAppConfigArgs['use-last-configuration']); // 'true'
19146
+ * ```
19147
+ */
19148
+ userAppConfigArgs?: UserAppConfigArgs;
19149
+ };
19150
+
19121
19151
  /**
19122
19152
  * @internal
19123
19153
  * @interface
@@ -1817,9 +1817,7 @@ function requireInteropClient () {
1817
1817
  * ```
1818
1818
  *
1819
1819
  *
1820
- * We are also testing the ability to add a context handler for specific contexts. If you would like to use
1821
- * this, please make sure you add your context handlers at the top level of your application, on a page that
1822
- * does not navigate/reload/re-render, to avoid memory leaks. This feature is experimental:
1820
+ * Passing in a context type as the second parameter will cause the handler to only be invoked with that context type.
1823
1821
  *
1824
1822
  * ```js
1825
1823
  * function handleInstrumentContext(contextInfo) {
@@ -1848,7 +1846,6 @@ function requireInteropClient () {
1848
1846
  let handlerId;
1849
1847
  if (contextType) {
1850
1848
  handlerId = `invokeContextHandler-${contextType}-${(0, utils_1.generateId)()}`;
1851
- 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.`);
1852
1849
  }
1853
1850
  else {
1854
1851
  handlerId = 'invokeContextHandler';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/remote-adapter",
3
- "version": "37.81.19",
3
+ "version": "37.81.20",
4
4
  "description": "Establish intermachine runtime connections using webRTC.",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "private": false,