@openfin/core 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_2.ApplicationEvent> {
825
825
  */
826
826
  showTrayIconPopupMenu<Data>(options: OpenFin_2.ShowTrayIconPopupMenuOptions<Data>): Promise<OpenFin_2.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;
@@ -9899,6 +9899,7 @@ declare namespace OpenFin_2 {
9899
9899
  AppVersionError,
9900
9900
  AppVersionRuntimeInfo,
9901
9901
  LaunchEmitter,
9902
+ UserAppConfigArgs,
9902
9903
  RvmLaunchOptions,
9903
9904
  ShortCutConfig,
9904
9905
  TerminateExternalRequestType,
@@ -12725,7 +12726,7 @@ declare type RunRequestedEvent = OpenFin_2.ApplicationEvents.RunRequestedEvent;
12725
12726
  declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
12726
12727
  topic: 'application';
12727
12728
  type: 'run-requested';
12728
- userAppConfigArgs: Record<string, any>;
12729
+ userAppConfigArgs: OpenFin_2.UserAppConfigArgs;
12729
12730
  manifest: OpenFin_2.Manifest;
12730
12731
  };
12731
12732
 
@@ -12840,7 +12841,7 @@ declare type RvmLaunchOptions = {
12840
12841
  * True if no UI when launching
12841
12842
  */
12842
12843
  noUi?: boolean;
12843
- userAppConfigArgs?: object;
12844
+ userAppConfigArgs?: UserAppConfigArgs;
12844
12845
  /**
12845
12846
  * Timeout in seconds until RVM launch request expires.
12846
12847
  */
@@ -15369,6 +15370,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
15369
15370
  httpStatusText: string;
15370
15371
  });
15371
15372
 
15373
+ /**
15374
+ * @interface
15375
+ */
15376
+ declare type UserAppConfigArgs = Record<string, string | string[]>;
15377
+
15372
15378
  /**
15373
15379
  * A general user bounds change event without event type.
15374
15380
  * @interface
@@ -18775,6 +18781,32 @@ declare type WithPositioningOptions<T extends {} = {}> = T & {
18775
18781
  positioningOptions?: OpenFin_2.PositioningOptions;
18776
18782
  };
18777
18783
 
18784
+ declare type WithUserAppConfigArgs = {
18785
+ /**
18786
+ * Represents the key-value pairs for the parameters passed into any fin:// or fins:// link
18787
+ * that launches this application.
18788
+ *
18789
+ * @remarks
18790
+ * In the link, user defined parameters are separated by the `$$` delimeter, for example:
18791
+ * `fins://path.to/app/manifest.json?$$use-last-configuration=true`
18792
+ *
18793
+ * Results in the following object:
18794
+ * ```json
18795
+ * {
18796
+ * "use-last-configuration": true"
18797
+ * }
18798
+ * ```
18799
+ *
18800
+ * These args can be accessed via the {@link ApplicationInfo.initialOptions} object:
18801
+ * ```typescript
18802
+ * const appInfo = await fin.Application.getCurrentSync().getInfo();
18803
+ * const { userAppConfigArgs } = appInfo.initialOptions;
18804
+ * console.log(userAppConfigArgs['use-last-configuration']); // 'true'
18805
+ * ```
18806
+ */
18807
+ userAppConfigArgs?: UserAppConfigArgs;
18808
+ };
18809
+
18778
18810
  /* Excluded from this release type: WorkspacePlatformOptions */
18779
18811
 
18780
18812
  /**
@@ -825,7 +825,7 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
825
825
  */
826
826
  showTrayIconPopupMenu<Data>(options: OpenFin_2.ShowTrayIconPopupMenuOptions<Data>): Promise<OpenFin_2.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;
@@ -9899,6 +9899,7 @@ declare namespace OpenFin_2 {
9899
9899
  AppVersionError,
9900
9900
  AppVersionRuntimeInfo,
9901
9901
  LaunchEmitter,
9902
+ UserAppConfigArgs,
9902
9903
  RvmLaunchOptions,
9903
9904
  ShortCutConfig,
9904
9905
  TerminateExternalRequestType,
@@ -12725,7 +12726,7 @@ declare type RunRequestedEvent = OpenFin_2.ApplicationEvents.RunRequestedEvent;
12725
12726
  declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
12726
12727
  topic: 'application';
12727
12728
  type: 'run-requested';
12728
- userAppConfigArgs: Record<string, any>;
12729
+ userAppConfigArgs: OpenFin_2.UserAppConfigArgs;
12729
12730
  manifest: OpenFin_2.Manifest;
12730
12731
  };
12731
12732
 
@@ -12840,7 +12841,7 @@ declare type RvmLaunchOptions = {
12840
12841
  * True if no UI when launching
12841
12842
  */
12842
12843
  noUi?: boolean;
12843
- userAppConfigArgs?: object;
12844
+ userAppConfigArgs?: UserAppConfigArgs;
12844
12845
  /**
12845
12846
  * Timeout in seconds until RVM launch request expires.
12846
12847
  */
@@ -15369,6 +15370,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
15369
15370
  httpStatusText: string;
15370
15371
  });
15371
15372
 
15373
+ /**
15374
+ * @interface
15375
+ */
15376
+ declare type UserAppConfigArgs = Record<string, string | string[]>;
15377
+
15372
15378
  /**
15373
15379
  * A general user bounds change event without event type.
15374
15380
  * @interface
@@ -18775,6 +18781,32 @@ declare type WithPositioningOptions<T extends {} = {}> = T & {
18775
18781
  positioningOptions?: OpenFin_2.PositioningOptions;
18776
18782
  };
18777
18783
 
18784
+ declare type WithUserAppConfigArgs = {
18785
+ /**
18786
+ * Represents the key-value pairs for the parameters passed into any fin:// or fins:// link
18787
+ * that launches this application.
18788
+ *
18789
+ * @remarks
18790
+ * In the link, user defined parameters are separated by the `$$` delimeter, for example:
18791
+ * `fins://path.to/app/manifest.json?$$use-last-configuration=true`
18792
+ *
18793
+ * Results in the following object:
18794
+ * ```json
18795
+ * {
18796
+ * "use-last-configuration": true"
18797
+ * }
18798
+ * ```
18799
+ *
18800
+ * These args can be accessed via the {@link ApplicationInfo.initialOptions} object:
18801
+ * ```typescript
18802
+ * const appInfo = await fin.Application.getCurrentSync().getInfo();
18803
+ * const { userAppConfigArgs } = appInfo.initialOptions;
18804
+ * console.log(userAppConfigArgs['use-last-configuration']); // 'true'
18805
+ * ```
18806
+ */
18807
+ userAppConfigArgs?: UserAppConfigArgs;
18808
+ };
18809
+
18778
18810
  /* Excluded from this release type: WorkspacePlatformOptions */
18779
18811
 
18780
18812
  /**
@@ -825,7 +825,7 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
825
825
  */
826
826
  showTrayIconPopupMenu<Data>(options: OpenFin_2.ShowTrayIconPopupMenuOptions<Data>): Promise<OpenFin_2.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;
@@ -9899,6 +9899,7 @@ declare namespace OpenFin_2 {
9899
9899
  AppVersionError,
9900
9900
  AppVersionRuntimeInfo,
9901
9901
  LaunchEmitter,
9902
+ UserAppConfigArgs,
9902
9903
  RvmLaunchOptions,
9903
9904
  ShortCutConfig,
9904
9905
  TerminateExternalRequestType,
@@ -12725,7 +12726,7 @@ declare type RunRequestedEvent = OpenFin_2.ApplicationEvents.RunRequestedEvent;
12725
12726
  declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
12726
12727
  topic: 'application';
12727
12728
  type: 'run-requested';
12728
- userAppConfigArgs: Record<string, any>;
12729
+ userAppConfigArgs: OpenFin_2.UserAppConfigArgs;
12729
12730
  manifest: OpenFin_2.Manifest;
12730
12731
  };
12731
12732
 
@@ -12840,7 +12841,7 @@ declare type RvmLaunchOptions = {
12840
12841
  * True if no UI when launching
12841
12842
  */
12842
12843
  noUi?: boolean;
12843
- userAppConfigArgs?: object;
12844
+ userAppConfigArgs?: UserAppConfigArgs;
12844
12845
  /**
12845
12846
  * Timeout in seconds until RVM launch request expires.
12846
12847
  */
@@ -15369,6 +15370,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
15369
15370
  httpStatusText: string;
15370
15371
  });
15371
15372
 
15373
+ /**
15374
+ * @interface
15375
+ */
15376
+ declare type UserAppConfigArgs = Record<string, string | string[]>;
15377
+
15372
15378
  /**
15373
15379
  * A general user bounds change event without event type.
15374
15380
  * @interface
@@ -18775,6 +18781,32 @@ declare type WithPositioningOptions<T extends {} = {}> = T & {
18775
18781
  positioningOptions?: OpenFin_2.PositioningOptions;
18776
18782
  };
18777
18783
 
18784
+ declare type WithUserAppConfigArgs = {
18785
+ /**
18786
+ * Represents the key-value pairs for the parameters passed into any fin:// or fins:// link
18787
+ * that launches this application.
18788
+ *
18789
+ * @remarks
18790
+ * In the link, user defined parameters are separated by the `$$` delimeter, for example:
18791
+ * `fins://path.to/app/manifest.json?$$use-last-configuration=true`
18792
+ *
18793
+ * Results in the following object:
18794
+ * ```json
18795
+ * {
18796
+ * "use-last-configuration": true"
18797
+ * }
18798
+ * ```
18799
+ *
18800
+ * These args can be accessed via the {@link ApplicationInfo.initialOptions} object:
18801
+ * ```typescript
18802
+ * const appInfo = await fin.Application.getCurrentSync().getInfo();
18803
+ * const { userAppConfigArgs } = appInfo.initialOptions;
18804
+ * console.log(userAppConfigArgs['use-last-configuration']); // 'true'
18805
+ * ```
18806
+ */
18807
+ userAppConfigArgs?: UserAppConfigArgs;
18808
+ };
18809
+
18778
18810
  /* Excluded from this release type: WorkspacePlatformOptions */
18779
18811
 
18780
18812
  /**
package/out/mock.d.ts CHANGED
@@ -831,7 +831,7 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
831
831
  */
832
832
  showTrayIconPopupMenu<Data>(options: OpenFin_2.ShowTrayIconPopupMenuOptions<Data>): Promise<OpenFin_2.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;
@@ -10214,6 +10214,7 @@ declare namespace OpenFin_2 {
10214
10214
  AppVersionError,
10215
10215
  AppVersionRuntimeInfo,
10216
10216
  LaunchEmitter,
10217
+ UserAppConfigArgs,
10217
10218
  RvmLaunchOptions,
10218
10219
  ShortCutConfig,
10219
10220
  TerminateExternalRequestType,
@@ -13118,7 +13119,7 @@ declare type RunRequestedEvent = OpenFin_2.ApplicationEvents.RunRequestedEvent;
13118
13119
  declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
13119
13120
  topic: 'application';
13120
13121
  type: 'run-requested';
13121
- userAppConfigArgs: Record<string, any>;
13122
+ userAppConfigArgs: OpenFin_2.UserAppConfigArgs;
13122
13123
  manifest: OpenFin_2.Manifest;
13123
13124
  };
13124
13125
 
@@ -13233,7 +13234,7 @@ declare type RvmLaunchOptions = {
13233
13234
  * True if no UI when launching
13234
13235
  */
13235
13236
  noUi?: boolean;
13236
- userAppConfigArgs?: object;
13237
+ userAppConfigArgs?: UserAppConfigArgs;
13237
13238
  /**
13238
13239
  * Timeout in seconds until RVM launch request expires.
13239
13240
  */
@@ -15775,6 +15776,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
15775
15776
  httpStatusText: string;
15776
15777
  });
15777
15778
 
15779
+ /**
15780
+ * @interface
15781
+ */
15782
+ declare type UserAppConfigArgs = Record<string, string | string[]>;
15783
+
15778
15784
  /**
15779
15785
  * A general user bounds change event without event type.
15780
15786
  * @interface
@@ -19227,6 +19233,32 @@ declare type WithPositioningOptions<T extends {} = {}> = T & {
19227
19233
  positioningOptions?: OpenFin_2.PositioningOptions;
19228
19234
  };
19229
19235
 
19236
+ declare type WithUserAppConfigArgs = {
19237
+ /**
19238
+ * Represents the key-value pairs for the parameters passed into any fin:// or fins:// link
19239
+ * that launches this application.
19240
+ *
19241
+ * @remarks
19242
+ * In the link, user defined parameters are separated by the `$$` delimeter, for example:
19243
+ * `fins://path.to/app/manifest.json?$$use-last-configuration=true`
19244
+ *
19245
+ * Results in the following object:
19246
+ * ```json
19247
+ * {
19248
+ * "use-last-configuration": true"
19249
+ * }
19250
+ * ```
19251
+ *
19252
+ * These args can be accessed via the {@link ApplicationInfo.initialOptions} object:
19253
+ * ```typescript
19254
+ * const appInfo = await fin.Application.getCurrentSync().getInfo();
19255
+ * const { userAppConfigArgs } = appInfo.initialOptions;
19256
+ * console.log(userAppConfigArgs['use-last-configuration']); // 'true'
19257
+ * ```
19258
+ */
19259
+ userAppConfigArgs?: UserAppConfigArgs;
19260
+ };
19261
+
19230
19262
  /**
19231
19263
  * @internal
19232
19264
  * @interface
package/out/mock.js CHANGED
@@ -4026,7 +4026,7 @@ function requireInstance$1 () {
4026
4026
  return payload.data;
4027
4027
  }
4028
4028
  /**
4029
- * CLoses the tray icon menu.
4029
+ * Closes the tray icon menu.
4030
4030
  *
4031
4031
  * @throws if the application has no tray icon set
4032
4032
  * @example
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/core",
3
- "version": "38.81.29",
3
+ "version": "38.81.30",
4
4
  "description": "The core renderer entry point of OpenFin",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "main": "out/mock.js",