@openfin/fdc3-api 36.79.18 → 36.80.1

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

@@ -966,7 +966,7 @@ declare type ApplicationIdentity_2 = {
  * @interface
  */
 declare type ApplicationInfo = {
-    initialOptions: ApplicationCreationOptions;
+    initialOptions: ApplicationCreationOptions | PlatformOptions;
     launchMode: string;
     manifest: Manifest & {
         [key: string]: any;
@@ -1280,6 +1280,10 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
      * Define the {@link https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads file download rules} and domain-based api injection rules.
      */
     domainSettings: DomainSettings;
+    /**
+     * The permissions for secured APIs.
+     */
+    permissions?: Partial<Permissions_2>;
     /**
      * @defaultValue false
      *
@@ -3835,6 +3839,10 @@ declare type ConstWindowOptions = {
      * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
      */
     viewVisibility?: ViewVisibilityOptions;
+    /**
+     * Controls whether an option is inherited from the parent application. The option is set as part of the window options for the parent application in either the {@link Manifest.startup_app} or {@link Manifest.platform} properties in the manifest or in {@link ApplicationOptions.mainWindowOptions} when calling {@link Application.ApplicationModule.start Application.start}. Use { [option]: false } to disable a specific [option]. All inheritable properties will be inherited by default if omitted.
+     */
+    inheritance?: Partial<InheritableOptions>;
 };
 
 declare interface Container extends EventEmitter_2 {
@@ -6223,6 +6231,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
      * Returns a frame info object representing the window that the referenced iframe is
      * currently embedded in.
      *
+     * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
+     *
      * @example
      * ```js
      * async function getParentWindow() {
@@ -7068,6 +7078,13 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
     metadata?: MetadataType;
 };
 
+declare type InheritableOptions = {
+    customContext: boolean;
+    customData: boolean;
+    icon: boolean;
+    preloadScripts: boolean;
+};
+
 /**
  * Generated when an application has initialized.
  * @interface
@@ -8669,6 +8686,7 @@ declare type LaunchExternalProcessRule = {
  */
 declare type LaunchIntoPlatformPayload = {
     manifest: any;
+    manifestUrl?: string;
 };
 
 /**
@@ -10299,6 +10317,7 @@ declare namespace OpenFin {
         WindowState,
         AutoplayPolicyOptions,
         ConstWindowOptions,
+        InheritableOptions,
         MutableWindowOptions,
         WorkspacePlatformOptions,
         WebRequestHeader,
@@ -11535,9 +11554,13 @@ declare type PlatformOptions = ApplicationCreationOptions & {
      */
     providerUrl?: string;
     /**
-     * The permissions for secured APIs.
+     * @defaultValue true
+     *
+     * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
+     *
+     * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
      */
-    permissions?: Partial<Permissions_2>;
+    allowLaunchIntoPlatform?: boolean;
 };
 
 /**
@@ -12297,7 +12320,7 @@ declare type PreloadScriptInfoRunning = {
  * @interface
  */
 declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
-    type: 'preload-script-state-changed';
+    type: 'preload-scripts-state-changed';
 };
 
 /**
@@ -12314,7 +12337,7 @@ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
  * @interface
  */
 declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
-    type: 'preload-script-state-changing';
+    type: 'preload-scripts-state-changing';
 };
 
 declare type PresetLayoutOptions = OpenFin.PresetLayoutOptions;

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

@@ -966,7 +966,7 @@ declare type ApplicationIdentity_2 = {
  * @interface
  */
 declare type ApplicationInfo = {
-    initialOptions: ApplicationCreationOptions;
+    initialOptions: ApplicationCreationOptions | PlatformOptions;
     launchMode: string;
     manifest: Manifest & {
         [key: string]: any;
@@ -1280,6 +1280,10 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
      * Define the {@link https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads file download rules} and domain-based api injection rules.
      */
     domainSettings: DomainSettings;
+    /**
+     * The permissions for secured APIs.
+     */
+    permissions?: Partial<Permissions_2>;
     /**
      * @defaultValue false
      *
@@ -3835,6 +3839,10 @@ declare type ConstWindowOptions = {
      * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
      */
     viewVisibility?: ViewVisibilityOptions;
+    /**
+     * Controls whether an option is inherited from the parent application. The option is set as part of the window options for the parent application in either the {@link Manifest.startup_app} or {@link Manifest.platform} properties in the manifest or in {@link ApplicationOptions.mainWindowOptions} when calling {@link Application.ApplicationModule.start Application.start}. Use { [option]: false } to disable a specific [option]. All inheritable properties will be inherited by default if omitted.
+     */
+    inheritance?: Partial<InheritableOptions>;
 };
 
 declare interface Container extends EventEmitter_2 {
@@ -6223,6 +6231,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
      * Returns a frame info object representing the window that the referenced iframe is
      * currently embedded in.
      *
+     * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
+     *
      * @example
      * ```js
      * async function getParentWindow() {
@@ -7068,6 +7078,13 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
     metadata?: MetadataType;
 };
 
+declare type InheritableOptions = {
+    customContext: boolean;
+    customData: boolean;
+    icon: boolean;
+    preloadScripts: boolean;
+};
+
 /**
  * Generated when an application has initialized.
  * @interface
@@ -8669,6 +8686,7 @@ declare type LaunchExternalProcessRule = {
  */
 declare type LaunchIntoPlatformPayload = {
     manifest: any;
+    manifestUrl?: string;
 };
 
 /**
@@ -10299,6 +10317,7 @@ declare namespace OpenFin {
         WindowState,
         AutoplayPolicyOptions,
         ConstWindowOptions,
+        InheritableOptions,
         MutableWindowOptions,
         WorkspacePlatformOptions,
         WebRequestHeader,
@@ -11535,9 +11554,13 @@ declare type PlatformOptions = ApplicationCreationOptions & {
      */
     providerUrl?: string;
     /**
-     * The permissions for secured APIs.
+     * @defaultValue true
+     *
+     * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
+     *
+     * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
      */
-    permissions?: Partial<Permissions_2>;
+    allowLaunchIntoPlatform?: boolean;
 };
 
 /**
@@ -12297,7 +12320,7 @@ declare type PreloadScriptInfoRunning = {
  * @interface
  */
 declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
-    type: 'preload-script-state-changed';
+    type: 'preload-scripts-state-changed';
 };
 
 /**
@@ -12314,7 +12337,7 @@ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
  * @interface
  */
 declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
-    type: 'preload-script-state-changing';
+    type: 'preload-scripts-state-changing';
 };
 
 declare type PresetLayoutOptions = OpenFin.PresetLayoutOptions;

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

@@ -966,7 +966,7 @@ declare type ApplicationIdentity_2 = {
  * @interface
  */
 declare type ApplicationInfo = {
-    initialOptions: ApplicationCreationOptions;
+    initialOptions: ApplicationCreationOptions | PlatformOptions;
     launchMode: string;
     manifest: Manifest & {
         [key: string]: any;
@@ -1280,6 +1280,10 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
      * Define the {@link https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads file download rules} and domain-based api injection rules.
      */
     domainSettings: DomainSettings;
+    /**
+     * The permissions for secured APIs.
+     */
+    permissions?: Partial<Permissions_2>;
     /**
      * @defaultValue false
      *
@@ -3835,6 +3839,10 @@ declare type ConstWindowOptions = {
      * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
      */
     viewVisibility?: ViewVisibilityOptions;
+    /**
+     * Controls whether an option is inherited from the parent application. The option is set as part of the window options for the parent application in either the {@link Manifest.startup_app} or {@link Manifest.platform} properties in the manifest or in {@link ApplicationOptions.mainWindowOptions} when calling {@link Application.ApplicationModule.start Application.start}. Use { [option]: false } to disable a specific [option]. All inheritable properties will be inherited by default if omitted.
+     */
+    inheritance?: Partial<InheritableOptions>;
 };
 
 declare interface Container extends EventEmitter_2 {
@@ -6223,6 +6231,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
      * Returns a frame info object representing the window that the referenced iframe is
      * currently embedded in.
      *
+     * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
+     *
      * @example
      * ```js
      * async function getParentWindow() {
@@ -7068,6 +7078,13 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
     metadata?: MetadataType;
 };
 
+declare type InheritableOptions = {
+    customContext: boolean;
+    customData: boolean;
+    icon: boolean;
+    preloadScripts: boolean;
+};
+
 /**
  * Generated when an application has initialized.
  * @interface
@@ -8669,6 +8686,7 @@ declare type LaunchExternalProcessRule = {
  */
 declare type LaunchIntoPlatformPayload = {
     manifest: any;
+    manifestUrl?: string;
 };
 
 /**
@@ -10299,6 +10317,7 @@ declare namespace OpenFin {
         WindowState,
         AutoplayPolicyOptions,
         ConstWindowOptions,
+        InheritableOptions,
         MutableWindowOptions,
         WorkspacePlatformOptions,
         WebRequestHeader,
@@ -11535,9 +11554,13 @@ declare type PlatformOptions = ApplicationCreationOptions & {
      */
     providerUrl?: string;
     /**
-     * The permissions for secured APIs.
+     * @defaultValue true
+     *
+     * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
+     *
+     * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
      */
-    permissions?: Partial<Permissions_2>;
+    allowLaunchIntoPlatform?: boolean;
 };
 
 /**
@@ -12297,7 +12320,7 @@ declare type PreloadScriptInfoRunning = {
  * @interface
  */
 declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
-    type: 'preload-script-state-changed';
+    type: 'preload-scripts-state-changed';
 };
 
 /**
@@ -12314,7 +12337,7 @@ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
  * @interface
  */
 declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
-    type: 'preload-script-state-changing';
+    type: 'preload-scripts-state-changing';
 };
 
 declare type PresetLayoutOptions = OpenFin.PresetLayoutOptions;

package/out/fdc3-api.d.ts

@@ -972,7 +972,7 @@ declare type ApplicationIdentity_2 = {
  * @interface
  */
 declare type ApplicationInfo = {
-    initialOptions: ApplicationCreationOptions;
+    initialOptions: ApplicationCreationOptions | PlatformOptions;
     launchMode: string;
     manifest: Manifest & {
         [key: string]: any;
@@ -1286,6 +1286,10 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
      * Define the {@link https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads file download rules} and domain-based api injection rules.
      */
     domainSettings: DomainSettings;
+    /**
+     * The permissions for secured APIs.
+     */
+    permissions?: Partial<Permissions_2>;
     /**
      * @defaultValue false
      *
@@ -3890,6 +3894,10 @@ declare type ConstWindowOptions = {
      * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
      */
     viewVisibility?: ViewVisibilityOptions;
+    /**
+     * Controls whether an option is inherited from the parent application. The option is set as part of the window options for the parent application in either the {@link Manifest.startup_app} or {@link Manifest.platform} properties in the manifest or in {@link ApplicationOptions.mainWindowOptions} when calling {@link Application.ApplicationModule.start Application.start}. Use { [option]: false } to disable a specific [option]. All inheritable properties will be inherited by default if omitted.
+     */
+    inheritance?: Partial<InheritableOptions>;
 };
 
 declare interface Container extends EventEmitter_2 {
@@ -6307,6 +6315,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
      * Returns a frame info object representing the window that the referenced iframe is
      * currently embedded in.
      *
+     * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
+     *
      * @example
      * ```js
      * async function getParentWindow() {
@@ -7158,6 +7168,13 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
     metadata?: MetadataType;
 };
 
+declare type InheritableOptions = {
+    customContext: boolean;
+    customData: boolean;
+    icon: boolean;
+    preloadScripts: boolean;
+};
+
 /**
  * Generated when an application has initialized.
  * @interface
@@ -8782,6 +8799,7 @@ declare type LaunchExternalProcessRule = {
  */
 declare type LaunchIntoPlatformPayload = {
     manifest: any;
+    manifestUrl?: string;
 };
 
 /**
@@ -10610,6 +10628,7 @@ declare namespace OpenFin {
         WindowState,
         AutoplayPolicyOptions,
         ConstWindowOptions,
+        InheritableOptions,
         MutableWindowOptions,
         WorkspacePlatformOptions,
         WebRequestHeader,
@@ -11879,9 +11898,13 @@ declare type PlatformOptions = ApplicationCreationOptions & {
      */
     providerUrl?: string;
     /**
-     * The permissions for secured APIs.
+     * @defaultValue true
+     *
+     * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
+     *
+     * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
      */
-    permissions?: Partial<Permissions_2>;
+    allowLaunchIntoPlatform?: boolean;
 };
 
 /**
@@ -12686,7 +12709,7 @@ declare type PreloadScriptInfoRunning = {
  * @interface
  */
 declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
-    type: 'preload-script-state-changed';
+    type: 'preload-scripts-state-changed';
 };
 
 /**
@@ -12703,7 +12726,7 @@ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
  * @interface
  */
 declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
-    type: 'preload-script-state-changing';
+    type: 'preload-scripts-state-changing';
 };
 
 declare type PresetLayoutOptions = OpenFin.PresetLayoutOptions;

package/package.json

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