@openfin/fdc3-api 37.81.19 → 37.81.20

package/out/fdc3-api-alpha.d.ts

@@ -934,7 +934,7 @@ declare type ApplicationIdentity_2 = {
  * @interface
  */
 declare type ApplicationInfo = {
-    initialOptions: ApplicationCreationOptions | PlatformOptions;
+    initialOptions: WithUserAppConfigArgs & (ApplicationCreationOptions | PlatformOptions);
     launchMode: string;
     manifest: Manifest & {
         [key: string]: any;
@@ -7852,9 +7852,7 @@ declare class InteropClient extends Base {
      * ```
      *
      *
-     * We are also testing the ability to add a context handler for specific contexts. If you would like to use
-     * this, please make sure you add your context handlers at the top level of your application, on a page that
-     * does not navigate/reload/re-render, to avoid memory leaks.  This feature is experimental:
+     * Passing in a context type as the second parameter will cause the handler to only be invoked with that context type.
      *
      * ```js
      * function handleInstrumentContext(contextInfo) {
@@ -10162,6 +10160,7 @@ declare namespace OpenFin {
         AppVersionError,
         AppVersionRuntimeInfo,
         LaunchEmitter,
+        UserAppConfigArgs,
         RvmLaunchOptions,
         ShortCutConfig,
         TerminateExternalRequestType,
@@ -12968,7 +12967,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
 declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
     topic: 'application';
     type: 'run-requested';
-    userAppConfigArgs: Record<string, any>;
+    userAppConfigArgs: OpenFin.UserAppConfigArgs;
     manifest: OpenFin.Manifest;
 };
 
@@ -13083,7 +13082,7 @@ declare type RvmLaunchOptions = {
      * True if no UI when launching
      */
     noUi?: boolean;
-    userAppConfigArgs?: object;
+    userAppConfigArgs?: UserAppConfigArgs;
     /**
      * Timeout in seconds until RVM launch request expires.
      */
@@ -15581,6 +15580,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
     httpStatusText: string;
 });
 
+/**
+ * @interface
+ */
+declare type UserAppConfigArgs = Record<string, string | string[]>;
+
 /**
  * A general user bounds change event without event type.
  * @interface
@@ -18967,6 +18971,32 @@ declare type WithPositioningOptions<T extends {} = {}> = T & {
     positioningOptions?: OpenFin.PositioningOptions;
 };
 
+declare type WithUserAppConfigArgs = {
+    /**
+     * Represents the key-value pairs for the parameters passed into any fin:// or fins:// link
+     * that launches this application.
+     *
+     * @remarks
+     * In the link, user defined parameters are separated by the `$$` delimeter, for example:
+     * `fins://path.to/app/manifest.json?$$use-last-configuration=true`
+     *
+     * Results in the following object:
+     * ```json
+     * {
+     *    "use-last-configuration": true"
+     * }
+     * ```
+     *
+     * These args can be accessed via the {@link ApplicationInfo.initialOptions} object:
+     * ```typescript
+     * const appInfo = await fin.Application.getCurrentSync().getInfo();
+     * const { userAppConfigArgs } = appInfo.initialOptions;
+     * console.log(userAppConfigArgs['use-last-configuration']); // 'true'
+     * ```
+     */
+    userAppConfigArgs?: UserAppConfigArgs;
+};
+
 /* Excluded from this release type: WorkspacePlatformOptions */
 
 /**

package/out/fdc3-api-beta.d.ts

@@ -934,7 +934,7 @@ declare type ApplicationIdentity_2 = {
  * @interface
  */
 declare type ApplicationInfo = {
-    initialOptions: ApplicationCreationOptions | PlatformOptions;
+    initialOptions: WithUserAppConfigArgs & (ApplicationCreationOptions | PlatformOptions);
     launchMode: string;
     manifest: Manifest & {
         [key: string]: any;
@@ -7852,9 +7852,7 @@ declare class InteropClient extends Base {
      * ```
      *
      *
-     * We are also testing the ability to add a context handler for specific contexts. If you would like to use
-     * this, please make sure you add your context handlers at the top level of your application, on a page that
-     * does not navigate/reload/re-render, to avoid memory leaks.  This feature is experimental:
+     * Passing in a context type as the second parameter will cause the handler to only be invoked with that context type.
      *
      * ```js
      * function handleInstrumentContext(contextInfo) {
@@ -10162,6 +10160,7 @@ declare namespace OpenFin {
         AppVersionError,
         AppVersionRuntimeInfo,
         LaunchEmitter,
+        UserAppConfigArgs,
         RvmLaunchOptions,
         ShortCutConfig,
         TerminateExternalRequestType,
@@ -12968,7 +12967,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
 declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
     topic: 'application';
     type: 'run-requested';
-    userAppConfigArgs: Record<string, any>;
+    userAppConfigArgs: OpenFin.UserAppConfigArgs;
     manifest: OpenFin.Manifest;
 };
 
@@ -13083,7 +13082,7 @@ declare type RvmLaunchOptions = {
      * True if no UI when launching
      */
     noUi?: boolean;
-    userAppConfigArgs?: object;
+    userAppConfigArgs?: UserAppConfigArgs;
     /**
      * Timeout in seconds until RVM launch request expires.
      */
@@ -15581,6 +15580,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
     httpStatusText: string;
 });
 
+/**
+ * @interface
+ */
+declare type UserAppConfigArgs = Record<string, string | string[]>;
+
 /**
  * A general user bounds change event without event type.
  * @interface
@@ -18967,6 +18971,32 @@ declare type WithPositioningOptions<T extends {} = {}> = T & {
     positioningOptions?: OpenFin.PositioningOptions;
 };
 
+declare type WithUserAppConfigArgs = {
+    /**
+     * Represents the key-value pairs for the parameters passed into any fin:// or fins:// link
+     * that launches this application.
+     *
+     * @remarks
+     * In the link, user defined parameters are separated by the `$$` delimeter, for example:
+     * `fins://path.to/app/manifest.json?$$use-last-configuration=true`
+     *
+     * Results in the following object:
+     * ```json
+     * {
+     *    "use-last-configuration": true"
+     * }
+     * ```
+     *
+     * These args can be accessed via the {@link ApplicationInfo.initialOptions} object:
+     * ```typescript
+     * const appInfo = await fin.Application.getCurrentSync().getInfo();
+     * const { userAppConfigArgs } = appInfo.initialOptions;
+     * console.log(userAppConfigArgs['use-last-configuration']); // 'true'
+     * ```
+     */
+    userAppConfigArgs?: UserAppConfigArgs;
+};
+
 /* Excluded from this release type: WorkspacePlatformOptions */
 
 /**

package/out/fdc3-api-public.d.ts

@@ -934,7 +934,7 @@ declare type ApplicationIdentity_2 = {
  * @interface
  */
 declare type ApplicationInfo = {
-    initialOptions: ApplicationCreationOptions | PlatformOptions;
+    initialOptions: WithUserAppConfigArgs & (ApplicationCreationOptions | PlatformOptions);
     launchMode: string;
     manifest: Manifest & {
         [key: string]: any;
@@ -7852,9 +7852,7 @@ declare class InteropClient extends Base {
      * ```
      *
      *
-     * We are also testing the ability to add a context handler for specific contexts. If you would like to use
-     * this, please make sure you add your context handlers at the top level of your application, on a page that
-     * does not navigate/reload/re-render, to avoid memory leaks.  This feature is experimental:
+     * Passing in a context type as the second parameter will cause the handler to only be invoked with that context type.
      *
      * ```js
      * function handleInstrumentContext(contextInfo) {
@@ -10162,6 +10160,7 @@ declare namespace OpenFin {
         AppVersionError,
         AppVersionRuntimeInfo,
         LaunchEmitter,
+        UserAppConfigArgs,
         RvmLaunchOptions,
         ShortCutConfig,
         TerminateExternalRequestType,
@@ -12968,7 +12967,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
 declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
     topic: 'application';
     type: 'run-requested';
-    userAppConfigArgs: Record<string, any>;
+    userAppConfigArgs: OpenFin.UserAppConfigArgs;
     manifest: OpenFin.Manifest;
 };
 
@@ -13083,7 +13082,7 @@ declare type RvmLaunchOptions = {
      * True if no UI when launching
      */
     noUi?: boolean;
-    userAppConfigArgs?: object;
+    userAppConfigArgs?: UserAppConfigArgs;
     /**
      * Timeout in seconds until RVM launch request expires.
      */
@@ -15581,6 +15580,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
     httpStatusText: string;
 });
 
+/**
+ * @interface
+ */
+declare type UserAppConfigArgs = Record<string, string | string[]>;
+
 /**
  * A general user bounds change event without event type.
  * @interface
@@ -18967,6 +18971,32 @@ declare type WithPositioningOptions<T extends {} = {}> = T & {
     positioningOptions?: OpenFin.PositioningOptions;
 };
 
+declare type WithUserAppConfigArgs = {
+    /**
+     * Represents the key-value pairs for the parameters passed into any fin:// or fins:// link
+     * that launches this application.
+     *
+     * @remarks
+     * In the link, user defined parameters are separated by the `$$` delimeter, for example:
+     * `fins://path.to/app/manifest.json?$$use-last-configuration=true`
+     *
+     * Results in the following object:
+     * ```json
+     * {
+     *    "use-last-configuration": true"
+     * }
+     * ```
+     *
+     * These args can be accessed via the {@link ApplicationInfo.initialOptions} object:
+     * ```typescript
+     * const appInfo = await fin.Application.getCurrentSync().getInfo();
+     * const { userAppConfigArgs } = appInfo.initialOptions;
+     * console.log(userAppConfigArgs['use-last-configuration']); // 'true'
+     * ```
+     */
+    userAppConfigArgs?: UserAppConfigArgs;
+};
+
 /* Excluded from this release type: WorkspacePlatformOptions */
 
 /**

package/out/fdc3-api.d.ts

@@ -940,7 +940,7 @@ declare type ApplicationIdentity_2 = {
  * @interface
  */
 declare type ApplicationInfo = {
-    initialOptions: ApplicationCreationOptions | PlatformOptions;
+    initialOptions: WithUserAppConfigArgs & (ApplicationCreationOptions | PlatformOptions);
     launchMode: string;
     manifest: Manifest & {
         [key: string]: any;
@@ -7964,9 +7964,7 @@ declare class InteropClient extends Base {
      * ```
      *
      *
-     * We are also testing the ability to add a context handler for specific contexts. If you would like to use
-     * this, please make sure you add your context handlers at the top level of your application, on a page that
-     * does not navigate/reload/re-render, to avoid memory leaks.  This feature is experimental:
+     * Passing in a context type as the second parameter will cause the handler to only be invoked with that context type.
      *
      * ```js
      * function handleInstrumentContext(contextInfo) {
@@ -10477,6 +10475,7 @@ declare namespace OpenFin {
         AppVersionError,
         AppVersionRuntimeInfo,
         LaunchEmitter,
+        UserAppConfigArgs,
         RvmLaunchOptions,
         ShortCutConfig,
         TerminateExternalRequestType,
@@ -13361,7 +13360,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
 declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
     topic: 'application';
     type: 'run-requested';
-    userAppConfigArgs: Record<string, any>;
+    userAppConfigArgs: OpenFin.UserAppConfigArgs;
     manifest: OpenFin.Manifest;
 };
 
@@ -13476,7 +13475,7 @@ declare type RvmLaunchOptions = {
      * True if no UI when launching
      */
     noUi?: boolean;
-    userAppConfigArgs?: object;
+    userAppConfigArgs?: UserAppConfigArgs;
     /**
      * Timeout in seconds until RVM launch request expires.
      */
@@ -15987,6 +15986,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
     httpStatusText: string;
 });
 
+/**
+ * @interface
+ */
+declare type UserAppConfigArgs = Record<string, string | string[]>;
+
 /**
  * A general user bounds change event without event type.
  * @interface
@@ -19419,6 +19423,32 @@ declare type WithPositioningOptions<T extends {} = {}> = T & {
     positioningOptions?: OpenFin.PositioningOptions;
 };
 
+declare type WithUserAppConfigArgs = {
+    /**
+     * Represents the key-value pairs for the parameters passed into any fin:// or fins:// link
+     * that launches this application.
+     *
+     * @remarks
+     * In the link, user defined parameters are separated by the `$$` delimeter, for example:
+     * `fins://path.to/app/manifest.json?$$use-last-configuration=true`
+     *
+     * Results in the following object:
+     * ```json
+     * {
+     *    "use-last-configuration": true"
+     * }
+     * ```
+     *
+     * These args can be accessed via the {@link ApplicationInfo.initialOptions} object:
+     * ```typescript
+     * const appInfo = await fin.Application.getCurrentSync().getInfo();
+     * const { userAppConfigArgs } = appInfo.initialOptions;
+     * console.log(userAppConfigArgs['use-last-configuration']); // 'true'
+     * ```
+     */
+    userAppConfigArgs?: UserAppConfigArgs;
+};
+
 /**
  * @internal
  * @interface

package/out/fdc3-api.js

@@ -1292,9 +1292,7 @@ function requireInteropClient () {
 	     * ```
 	     *
 	     *
-	     * We are also testing the ability to add a context handler for specific contexts. If you would like to use
-	     * this, please make sure you add your context handlers at the top level of your application, on a page that
-	     * does not navigate/reload/re-render, to avoid memory leaks.  This feature is experimental:
+	     * Passing in a context type as the second parameter will cause the handler to only be invoked with that context type.
 	     *
 	     * ```js
 	     * function handleInstrumentContext(contextInfo) {
@@ -1323,7 +1321,6 @@ function requireInteropClient () {
 	        let handlerId;
 	        if (contextType) {
 	            handlerId = `invokeContextHandler-${contextType}-${(0, utils_1.generateId)()}`;
-	            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.`);
 	        }
 	        else {
 	            handlerId = 'invokeContextHandler';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/fdc3-api",
-    "version": "37.81.19",
+    "version": "37.81.20",
     "description": "OpenFin fdc3 module utilities and types.",
     "license": "SEE LICENSE IN LICENSE.MD",
     "private": false,