@openfin/remote-adapter 38.81.29 → 38.81.30

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.
@@ -825,7 +825,7 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
825
825
  */
826
826
  showTrayIconPopupMenu<Data>(options: OpenFin.ShowTrayIconPopupMenuOptions<Data>): Promise<OpenFin.MenuResult<Data>>;
827
827
  /**
828
- * CLoses the tray icon menu.
828
+ * Closes the tray icon menu.
829
829
  *
830
830
  * @throws if the application has no tray icon set
831
831
  * @example
@@ -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;
@@ -9942,6 +9942,7 @@ declare namespace OpenFin {
9942
9942
  AppVersionError,
9943
9943
  AppVersionRuntimeInfo,
9944
9944
  LaunchEmitter,
9945
+ UserAppConfigArgs,
9945
9946
  RvmLaunchOptions,
9946
9947
  ShortCutConfig,
9947
9948
  TerminateExternalRequestType,
@@ -12767,7 +12768,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
12767
12768
  declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
12768
12769
  topic: 'application';
12769
12770
  type: 'run-requested';
12770
- userAppConfigArgs: Record<string, any>;
12771
+ userAppConfigArgs: OpenFin.UserAppConfigArgs;
12771
12772
  manifest: OpenFin.Manifest;
12772
12773
  };
12773
12774
 
@@ -12882,7 +12883,7 @@ declare type RvmLaunchOptions = {
12882
12883
  * True if no UI when launching
12883
12884
  */
12884
12885
  noUi?: boolean;
12885
- userAppConfigArgs?: object;
12886
+ userAppConfigArgs?: UserAppConfigArgs;
12886
12887
  /**
12887
12888
  * Timeout in seconds until RVM launch request expires.
12888
12889
  */
@@ -15411,6 +15412,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
15411
15412
  httpStatusText: string;
15412
15413
  });
15413
15414
 
15415
+ /**
15416
+ * @interface
15417
+ */
15418
+ declare type UserAppConfigArgs = Record<string, string | string[]>;
15419
+
15414
15420
  /**
15415
15421
  * A general user bounds change event without event type.
15416
15422
  * @interface
@@ -18817,6 +18823,32 @@ declare type WithPositioningOptions<T extends {} = {}> = T & {
18817
18823
  positioningOptions?: OpenFin.PositioningOptions;
18818
18824
  };
18819
18825
 
18826
+ declare type WithUserAppConfigArgs = {
18827
+ /**
18828
+ * Represents the key-value pairs for the parameters passed into any fin:// or fins:// link
18829
+ * that launches this application.
18830
+ *
18831
+ * @remarks
18832
+ * In the link, user defined parameters are separated by the `$$` delimeter, for example:
18833
+ * `fins://path.to/app/manifest.json?$$use-last-configuration=true`
18834
+ *
18835
+ * Results in the following object:
18836
+ * ```json
18837
+ * {
18838
+ * "use-last-configuration": true"
18839
+ * }
18840
+ * ```
18841
+ *
18842
+ * These args can be accessed via the {@link ApplicationInfo.initialOptions} object:
18843
+ * ```typescript
18844
+ * const appInfo = await fin.Application.getCurrentSync().getInfo();
18845
+ * const { userAppConfigArgs } = appInfo.initialOptions;
18846
+ * console.log(userAppConfigArgs['use-last-configuration']); // 'true'
18847
+ * ```
18848
+ */
18849
+ userAppConfigArgs?: UserAppConfigArgs;
18850
+ };
18851
+
18820
18852
  /* Excluded from this release type: WorkspacePlatformOptions */
18821
18853
 
18822
18854
  /**
@@ -825,7 +825,7 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
825
825
  */
826
826
  showTrayIconPopupMenu<Data>(options: OpenFin.ShowTrayIconPopupMenuOptions<Data>): Promise<OpenFin.MenuResult<Data>>;
827
827
  /**
828
- * CLoses the tray icon menu.
828
+ * Closes the tray icon menu.
829
829
  *
830
830
  * @throws if the application has no tray icon set
831
831
  * @example
@@ -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;
@@ -9942,6 +9942,7 @@ declare namespace OpenFin {
9942
9942
  AppVersionError,
9943
9943
  AppVersionRuntimeInfo,
9944
9944
  LaunchEmitter,
9945
+ UserAppConfigArgs,
9945
9946
  RvmLaunchOptions,
9946
9947
  ShortCutConfig,
9947
9948
  TerminateExternalRequestType,
@@ -12767,7 +12768,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
12767
12768
  declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
12768
12769
  topic: 'application';
12769
12770
  type: 'run-requested';
12770
- userAppConfigArgs: Record<string, any>;
12771
+ userAppConfigArgs: OpenFin.UserAppConfigArgs;
12771
12772
  manifest: OpenFin.Manifest;
12772
12773
  };
12773
12774
 
@@ -12882,7 +12883,7 @@ declare type RvmLaunchOptions = {
12882
12883
  * True if no UI when launching
12883
12884
  */
12884
12885
  noUi?: boolean;
12885
- userAppConfigArgs?: object;
12886
+ userAppConfigArgs?: UserAppConfigArgs;
12886
12887
  /**
12887
12888
  * Timeout in seconds until RVM launch request expires.
12888
12889
  */
@@ -15411,6 +15412,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
15411
15412
  httpStatusText: string;
15412
15413
  });
15413
15414
 
15415
+ /**
15416
+ * @interface
15417
+ */
15418
+ declare type UserAppConfigArgs = Record<string, string | string[]>;
15419
+
15414
15420
  /**
15415
15421
  * A general user bounds change event without event type.
15416
15422
  * @interface
@@ -18817,6 +18823,32 @@ declare type WithPositioningOptions<T extends {} = {}> = T & {
18817
18823
  positioningOptions?: OpenFin.PositioningOptions;
18818
18824
  };
18819
18825
 
18826
+ declare type WithUserAppConfigArgs = {
18827
+ /**
18828
+ * Represents the key-value pairs for the parameters passed into any fin:// or fins:// link
18829
+ * that launches this application.
18830
+ *
18831
+ * @remarks
18832
+ * In the link, user defined parameters are separated by the `$$` delimeter, for example:
18833
+ * `fins://path.to/app/manifest.json?$$use-last-configuration=true`
18834
+ *
18835
+ * Results in the following object:
18836
+ * ```json
18837
+ * {
18838
+ * "use-last-configuration": true"
18839
+ * }
18840
+ * ```
18841
+ *
18842
+ * These args can be accessed via the {@link ApplicationInfo.initialOptions} object:
18843
+ * ```typescript
18844
+ * const appInfo = await fin.Application.getCurrentSync().getInfo();
18845
+ * const { userAppConfigArgs } = appInfo.initialOptions;
18846
+ * console.log(userAppConfigArgs['use-last-configuration']); // 'true'
18847
+ * ```
18848
+ */
18849
+ userAppConfigArgs?: UserAppConfigArgs;
18850
+ };
18851
+
18820
18852
  /* Excluded from this release type: WorkspacePlatformOptions */
18821
18853
 
18822
18854
  /**
@@ -825,7 +825,7 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
825
825
  */
826
826
  showTrayIconPopupMenu<Data>(options: OpenFin.ShowTrayIconPopupMenuOptions<Data>): Promise<OpenFin.MenuResult<Data>>;
827
827
  /**
828
- * CLoses the tray icon menu.
828
+ * Closes the tray icon menu.
829
829
  *
830
830
  * @throws if the application has no tray icon set
831
831
  * @example
@@ -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;
@@ -9942,6 +9942,7 @@ declare namespace OpenFin {
9942
9942
  AppVersionError,
9943
9943
  AppVersionRuntimeInfo,
9944
9944
  LaunchEmitter,
9945
+ UserAppConfigArgs,
9945
9946
  RvmLaunchOptions,
9946
9947
  ShortCutConfig,
9947
9948
  TerminateExternalRequestType,
@@ -12767,7 +12768,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
12767
12768
  declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
12768
12769
  topic: 'application';
12769
12770
  type: 'run-requested';
12770
- userAppConfigArgs: Record<string, any>;
12771
+ userAppConfigArgs: OpenFin.UserAppConfigArgs;
12771
12772
  manifest: OpenFin.Manifest;
12772
12773
  };
12773
12774
 
@@ -12882,7 +12883,7 @@ declare type RvmLaunchOptions = {
12882
12883
  * True if no UI when launching
12883
12884
  */
12884
12885
  noUi?: boolean;
12885
- userAppConfigArgs?: object;
12886
+ userAppConfigArgs?: UserAppConfigArgs;
12886
12887
  /**
12887
12888
  * Timeout in seconds until RVM launch request expires.
12888
12889
  */
@@ -15411,6 +15412,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
15411
15412
  httpStatusText: string;
15412
15413
  });
15413
15414
 
15415
+ /**
15416
+ * @interface
15417
+ */
15418
+ declare type UserAppConfigArgs = Record<string, string | string[]>;
15419
+
15414
15420
  /**
15415
15421
  * A general user bounds change event without event type.
15416
15422
  * @interface
@@ -18817,6 +18823,32 @@ declare type WithPositioningOptions<T extends {} = {}> = T & {
18817
18823
  positioningOptions?: OpenFin.PositioningOptions;
18818
18824
  };
18819
18825
 
18826
+ declare type WithUserAppConfigArgs = {
18827
+ /**
18828
+ * Represents the key-value pairs for the parameters passed into any fin:// or fins:// link
18829
+ * that launches this application.
18830
+ *
18831
+ * @remarks
18832
+ * In the link, user defined parameters are separated by the `$$` delimeter, for example:
18833
+ * `fins://path.to/app/manifest.json?$$use-last-configuration=true`
18834
+ *
18835
+ * Results in the following object:
18836
+ * ```json
18837
+ * {
18838
+ * "use-last-configuration": true"
18839
+ * }
18840
+ * ```
18841
+ *
18842
+ * These args can be accessed via the {@link ApplicationInfo.initialOptions} object:
18843
+ * ```typescript
18844
+ * const appInfo = await fin.Application.getCurrentSync().getInfo();
18845
+ * const { userAppConfigArgs } = appInfo.initialOptions;
18846
+ * console.log(userAppConfigArgs['use-last-configuration']); // 'true'
18847
+ * ```
18848
+ */
18849
+ userAppConfigArgs?: UserAppConfigArgs;
18850
+ };
18851
+
18820
18852
  /* Excluded from this release type: WorkspacePlatformOptions */
18821
18853
 
18822
18854
  /**
@@ -831,7 +831,7 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
831
831
  */
832
832
  showTrayIconPopupMenu<Data>(options: OpenFin.ShowTrayIconPopupMenuOptions<Data>): Promise<OpenFin.MenuResult<Data>>;
833
833
  /**
834
- * CLoses the tray icon menu.
834
+ * Closes the tray icon menu.
835
835
  *
836
836
  * @throws if the application has no tray icon set
837
837
  * @example
@@ -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;
@@ -10257,6 +10257,7 @@ declare namespace OpenFin {
10257
10257
  AppVersionError,
10258
10258
  AppVersionRuntimeInfo,
10259
10259
  LaunchEmitter,
10260
+ UserAppConfigArgs,
10260
10261
  RvmLaunchOptions,
10261
10262
  ShortCutConfig,
10262
10263
  TerminateExternalRequestType,
@@ -13160,7 +13161,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
13160
13161
  declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
13161
13162
  topic: 'application';
13162
13163
  type: 'run-requested';
13163
- userAppConfigArgs: Record<string, any>;
13164
+ userAppConfigArgs: OpenFin.UserAppConfigArgs;
13164
13165
  manifest: OpenFin.Manifest;
13165
13166
  };
13166
13167
 
@@ -13275,7 +13276,7 @@ declare type RvmLaunchOptions = {
13275
13276
  * True if no UI when launching
13276
13277
  */
13277
13278
  noUi?: boolean;
13278
- userAppConfigArgs?: object;
13279
+ userAppConfigArgs?: UserAppConfigArgs;
13279
13280
  /**
13280
13281
  * Timeout in seconds until RVM launch request expires.
13281
13282
  */
@@ -15817,6 +15818,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
15817
15818
  httpStatusText: string;
15818
15819
  });
15819
15820
 
15821
+ /**
15822
+ * @interface
15823
+ */
15824
+ declare type UserAppConfigArgs = Record<string, string | string[]>;
15825
+
15820
15826
  /**
15821
15827
  * A general user bounds change event without event type.
15822
15828
  * @interface
@@ -19269,6 +19275,32 @@ declare type WithPositioningOptions<T extends {} = {}> = T & {
19269
19275
  positioningOptions?: OpenFin.PositioningOptions;
19270
19276
  };
19271
19277
 
19278
+ declare type WithUserAppConfigArgs = {
19279
+ /**
19280
+ * Represents the key-value pairs for the parameters passed into any fin:// or fins:// link
19281
+ * that launches this application.
19282
+ *
19283
+ * @remarks
19284
+ * In the link, user defined parameters are separated by the `$$` delimeter, for example:
19285
+ * `fins://path.to/app/manifest.json?$$use-last-configuration=true`
19286
+ *
19287
+ * Results in the following object:
19288
+ * ```json
19289
+ * {
19290
+ * "use-last-configuration": true"
19291
+ * }
19292
+ * ```
19293
+ *
19294
+ * These args can be accessed via the {@link ApplicationInfo.initialOptions} object:
19295
+ * ```typescript
19296
+ * const appInfo = await fin.Application.getCurrentSync().getInfo();
19297
+ * const { userAppConfigArgs } = appInfo.initialOptions;
19298
+ * console.log(userAppConfigArgs['use-last-configuration']); // 'true'
19299
+ * ```
19300
+ */
19301
+ userAppConfigArgs?: UserAppConfigArgs;
19302
+ };
19303
+
19272
19304
  /**
19273
19305
  * @internal
19274
19306
  * @interface
@@ -7259,7 +7259,7 @@ function requireInstance$2 () {
7259
7259
  return payload.data;
7260
7260
  }
7261
7261
  /**
7262
- * CLoses the tray icon menu.
7262
+ * Closes the tray icon menu.
7263
7263
  *
7264
7264
  * @throws if the application has no tray icon set
7265
7265
  * @example
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/remote-adapter",
3
- "version": "38.81.29",
3
+ "version": "38.81.30",
4
4
  "description": "Establish intermachine runtime connections using webRTC.",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "private": false,