@openfin/fdc3-api 38.81.29 → 38.81.31

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

@@ -825,7 +825,7 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
      */
     showTrayIconPopupMenu<Data>(options: OpenFin.ShowTrayIconPopupMenuOptions<Data>): Promise<OpenFin.MenuResult<Data>>;
     /**
-     * CLoses the tray icon menu.
+     * Closes the tray icon menu.
      *
      * @throws if the application has no tray icon set
      * @example
@@ -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;
@@ -3432,6 +3432,13 @@ declare type ConstViewOptions = {
      * Initial bounds given relative to the window.
      */
     bounds: Bounds;
+    /**
+     * API permissions for code running in the view.
+     *
+     * @remarks Superseded by {@link DomainSettings.default.api.permissions} - if present, this setting will be **ignored**.
+     * It is recommended for users to migrate to a domain-based security model, since it is more natural to assign trust
+     * to the source of the page content than to the context rendering it.
+     */
     permissions: Partial<Permissions_2>;
     /**
      * String tag that attempts to group like-tagged renderers together. Will only be used if pages are on the same origin.
@@ -3632,6 +3639,13 @@ declare type ConstWindowOptions = {
      * The name of the window.
      */
     name: string;
+    /**
+     * API permissions for code running in the window.
+     *
+     * @remarks Superseded by {@link DomainSettings.default.api.permissions} - if present, this setting will be **ignored**.
+     * It is recommended for users to migrate to a domain-based security model, since it is more natural to assign trust
+     * to the source of the page content than to the context rendering it.
+     */
     permissions: Partial<Permissions_2>;
     /**
      * Scripts that run before page load.  When omitted, inherits from the parent application.
@@ -4712,6 +4726,10 @@ declare type DomainSettings = {
     rules: DomainSettingsRule[];
     /**
      * Default values for settings in {@link DomainSettingsRule}.
+     *
+     * @remarks If {@link PerDomainSettings.content} or {@link PerDomainSettings.api.fin} are given a default value
+     * here, they will supersede any equivalent functionality in {@link WindowOptions} or {@link ViewOptions}.  For
+     * more information, see the documentation for the individual properties.
      */
     default?: PerDomainSettings;
 };
@@ -10243,6 +10261,7 @@ declare namespace OpenFin {
         AppVersionError,
         AppVersionRuntimeInfo,
         LaunchEmitter,
+        UserAppConfigArgs,
         RvmLaunchOptions,
         ShortCutConfig,
         TerminateExternalRequestType,
@@ -10551,7 +10570,7 @@ declare type PerDomainSettings = {
      * Whether DOM content can be loaded (by navigation or redirect).
      *
      * @remarks If this is included in {@link DomainSettings.default}, then {@link ContentNavigation} and
-     * {@link ContentRedirect} will be **ignored**.
+     * {@link ContentRedirect} in {@link WindowOptions} and {@link ViewOptions} will be **ignored**.
      */
     content?: ContentPermission;
 };
@@ -13068,7 +13087,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;
 };
 
@@ -13183,7 +13202,7 @@ declare type RvmLaunchOptions = {
      * True if no UI when launching
      */
     noUi?: boolean;
-    userAppConfigArgs?: object;
+    userAppConfigArgs?: UserAppConfigArgs;
     /**
      * Timeout in seconds until RVM launch request expires.
      */
@@ -15712,6 +15731,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
@@ -19118,6 +19142,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

@@ -825,7 +825,7 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
      */
     showTrayIconPopupMenu<Data>(options: OpenFin.ShowTrayIconPopupMenuOptions<Data>): Promise<OpenFin.MenuResult<Data>>;
     /**
-     * CLoses the tray icon menu.
+     * Closes the tray icon menu.
      *
      * @throws if the application has no tray icon set
      * @example
@@ -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;
@@ -3432,6 +3432,13 @@ declare type ConstViewOptions = {
      * Initial bounds given relative to the window.
      */
     bounds: Bounds;
+    /**
+     * API permissions for code running in the view.
+     *
+     * @remarks Superseded by {@link DomainSettings.default.api.permissions} - if present, this setting will be **ignored**.
+     * It is recommended for users to migrate to a domain-based security model, since it is more natural to assign trust
+     * to the source of the page content than to the context rendering it.
+     */
     permissions: Partial<Permissions_2>;
     /**
      * String tag that attempts to group like-tagged renderers together. Will only be used if pages are on the same origin.
@@ -3632,6 +3639,13 @@ declare type ConstWindowOptions = {
      * The name of the window.
      */
     name: string;
+    /**
+     * API permissions for code running in the window.
+     *
+     * @remarks Superseded by {@link DomainSettings.default.api.permissions} - if present, this setting will be **ignored**.
+     * It is recommended for users to migrate to a domain-based security model, since it is more natural to assign trust
+     * to the source of the page content than to the context rendering it.
+     */
     permissions: Partial<Permissions_2>;
     /**
      * Scripts that run before page load.  When omitted, inherits from the parent application.
@@ -4712,6 +4726,10 @@ declare type DomainSettings = {
     rules: DomainSettingsRule[];
     /**
      * Default values for settings in {@link DomainSettingsRule}.
+     *
+     * @remarks If {@link PerDomainSettings.content} or {@link PerDomainSettings.api.fin} are given a default value
+     * here, they will supersede any equivalent functionality in {@link WindowOptions} or {@link ViewOptions}.  For
+     * more information, see the documentation for the individual properties.
      */
     default?: PerDomainSettings;
 };
@@ -10243,6 +10261,7 @@ declare namespace OpenFin {
         AppVersionError,
         AppVersionRuntimeInfo,
         LaunchEmitter,
+        UserAppConfigArgs,
         RvmLaunchOptions,
         ShortCutConfig,
         TerminateExternalRequestType,
@@ -10551,7 +10570,7 @@ declare type PerDomainSettings = {
      * Whether DOM content can be loaded (by navigation or redirect).
      *
      * @remarks If this is included in {@link DomainSettings.default}, then {@link ContentNavigation} and
-     * {@link ContentRedirect} will be **ignored**.
+     * {@link ContentRedirect} in {@link WindowOptions} and {@link ViewOptions} will be **ignored**.
      */
     content?: ContentPermission;
 };
@@ -13068,7 +13087,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;
 };
 
@@ -13183,7 +13202,7 @@ declare type RvmLaunchOptions = {
      * True if no UI when launching
      */
     noUi?: boolean;
-    userAppConfigArgs?: object;
+    userAppConfigArgs?: UserAppConfigArgs;
     /**
      * Timeout in seconds until RVM launch request expires.
      */
@@ -15712,6 +15731,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
@@ -19118,6 +19142,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

@@ -825,7 +825,7 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
      */
     showTrayIconPopupMenu<Data>(options: OpenFin.ShowTrayIconPopupMenuOptions<Data>): Promise<OpenFin.MenuResult<Data>>;
     /**
-     * CLoses the tray icon menu.
+     * Closes the tray icon menu.
      *
      * @throws if the application has no tray icon set
      * @example
@@ -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;
@@ -3432,6 +3432,13 @@ declare type ConstViewOptions = {
      * Initial bounds given relative to the window.
      */
     bounds: Bounds;
+    /**
+     * API permissions for code running in the view.
+     *
+     * @remarks Superseded by {@link DomainSettings.default.api.permissions} - if present, this setting will be **ignored**.
+     * It is recommended for users to migrate to a domain-based security model, since it is more natural to assign trust
+     * to the source of the page content than to the context rendering it.
+     */
     permissions: Partial<Permissions_2>;
     /**
      * String tag that attempts to group like-tagged renderers together. Will only be used if pages are on the same origin.
@@ -3632,6 +3639,13 @@ declare type ConstWindowOptions = {
      * The name of the window.
      */
     name: string;
+    /**
+     * API permissions for code running in the window.
+     *
+     * @remarks Superseded by {@link DomainSettings.default.api.permissions} - if present, this setting will be **ignored**.
+     * It is recommended for users to migrate to a domain-based security model, since it is more natural to assign trust
+     * to the source of the page content than to the context rendering it.
+     */
     permissions: Partial<Permissions_2>;
     /**
      * Scripts that run before page load.  When omitted, inherits from the parent application.
@@ -4712,6 +4726,10 @@ declare type DomainSettings = {
     rules: DomainSettingsRule[];
     /**
      * Default values for settings in {@link DomainSettingsRule}.
+     *
+     * @remarks If {@link PerDomainSettings.content} or {@link PerDomainSettings.api.fin} are given a default value
+     * here, they will supersede any equivalent functionality in {@link WindowOptions} or {@link ViewOptions}.  For
+     * more information, see the documentation for the individual properties.
      */
     default?: PerDomainSettings;
 };
@@ -10243,6 +10261,7 @@ declare namespace OpenFin {
         AppVersionError,
         AppVersionRuntimeInfo,
         LaunchEmitter,
+        UserAppConfigArgs,
         RvmLaunchOptions,
         ShortCutConfig,
         TerminateExternalRequestType,
@@ -10551,7 +10570,7 @@ declare type PerDomainSettings = {
      * Whether DOM content can be loaded (by navigation or redirect).
      *
      * @remarks If this is included in {@link DomainSettings.default}, then {@link ContentNavigation} and
-     * {@link ContentRedirect} will be **ignored**.
+     * {@link ContentRedirect} in {@link WindowOptions} and {@link ViewOptions} will be **ignored**.
      */
     content?: ContentPermission;
 };
@@ -13068,7 +13087,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;
 };
 
@@ -13183,7 +13202,7 @@ declare type RvmLaunchOptions = {
      * True if no UI when launching
      */
     noUi?: boolean;
-    userAppConfigArgs?: object;
+    userAppConfigArgs?: UserAppConfigArgs;
     /**
      * Timeout in seconds until RVM launch request expires.
      */
@@ -15712,6 +15731,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
@@ -19118,6 +19142,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

@@ -831,7 +831,7 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
      */
     showTrayIconPopupMenu<Data>(options: OpenFin.ShowTrayIconPopupMenuOptions<Data>): Promise<OpenFin.MenuResult<Data>>;
     /**
-     * CLoses the tray icon menu.
+     * Closes the tray icon menu.
      *
      * @throws if the application has no tray icon set
      * @example
@@ -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;
@@ -3491,6 +3491,13 @@ declare type ConstViewOptions = {
      * Initial bounds given relative to the window.
      */
     bounds: Bounds;
+    /**
+     * API permissions for code running in the view.
+     *
+     * @remarks Superseded by {@link DomainSettings.default.api.permissions} - if present, this setting will be **ignored**.
+     * It is recommended for users to migrate to a domain-based security model, since it is more natural to assign trust
+     * to the source of the page content than to the context rendering it.
+     */
     permissions: Partial<Permissions_2>;
     /**
      * String tag that attempts to group like-tagged renderers together. Will only be used if pages are on the same origin.
@@ -3691,6 +3698,13 @@ declare type ConstWindowOptions = {
      * The name of the window.
      */
     name: string;
+    /**
+     * API permissions for code running in the window.
+     *
+     * @remarks Superseded by {@link DomainSettings.default.api.permissions} - if present, this setting will be **ignored**.
+     * It is recommended for users to migrate to a domain-based security model, since it is more natural to assign trust
+     * to the source of the page content than to the context rendering it.
+     */
     permissions: Partial<Permissions_2>;
     /**
      * Scripts that run before page load.  When omitted, inherits from the parent application.
@@ -4771,6 +4785,10 @@ declare type DomainSettings = {
     rules: DomainSettingsRule[];
     /**
      * Default values for settings in {@link DomainSettingsRule}.
+     *
+     * @remarks If {@link PerDomainSettings.content} or {@link PerDomainSettings.api.fin} are given a default value
+     * here, they will supersede any equivalent functionality in {@link WindowOptions} or {@link ViewOptions}.  For
+     * more information, see the documentation for the individual properties.
      */
     default?: PerDomainSettings;
 };
@@ -10558,6 +10576,7 @@ declare namespace OpenFin {
         AppVersionError,
         AppVersionRuntimeInfo,
         LaunchEmitter,
+        UserAppConfigArgs,
         RvmLaunchOptions,
         ShortCutConfig,
         TerminateExternalRequestType,
@@ -10866,7 +10885,7 @@ declare type PerDomainSettings = {
      * Whether DOM content can be loaded (by navigation or redirect).
      *
      * @remarks If this is included in {@link DomainSettings.default}, then {@link ContentNavigation} and
-     * {@link ContentRedirect} will be **ignored**.
+     * {@link ContentRedirect} in {@link WindowOptions} and {@link ViewOptions} will be **ignored**.
      */
     content?: ContentPermission;
 };
@@ -13461,7 +13480,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;
 };
 
@@ -13576,7 +13595,7 @@ declare type RvmLaunchOptions = {
      * True if no UI when launching
      */
     noUi?: boolean;
-    userAppConfigArgs?: object;
+    userAppConfigArgs?: UserAppConfigArgs;
     /**
      * Timeout in seconds until RVM launch request expires.
      */
@@ -16118,6 +16137,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
@@ -19570,6 +19594,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/package.json

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