@openfin/fdc3-api 39.83.4 → 39.83.7

package/out/fdc3-api.d.ts

@@ -2993,6 +2993,18 @@ declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
     childOptions: OpenFin.WindowOptions;
 };
 
+/**
+ * Control behavior for Chromium policies
+ *
+ * @interface
+ */
+declare type ChromiumPolicies = {
+    /**
+     * Disable AutofillAddressEnabled policy for a Window or View.
+     */
+    AutofillAddressEnabled?: PolicyOptions;
+};
+
 declare interface ClassicProtocolOffer extends ProtocolPacketBase {
     type: 'classic';
 }
@@ -3507,6 +3519,10 @@ declare type ConstViewOptions = {
          */
         enabled: boolean;
     };
+    /**
+     * Control which options to ignore when creating a Platform View.
+     */
+    excludeOptions: ExcludeOptions;
 };
 
 /**
@@ -3751,6 +3767,10 @@ declare type ConstWindowOptions = {
      * 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>;
+    /**
+     * Control which options to ignore when creating a Platform Window.
+     */
+    excludeOptions: ExcludeOptions;
 };
 
 /**
@@ -4790,7 +4810,7 @@ declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotApplie
  *  under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
  *  from which they propagate).
  */
-declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
+declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent | ExtensionsEnabledEvent | ExtensionsDisabledEvent | ExtensionsExcludedEvent | ExtensionsInstalledEvent | ExtensionInstalledEvent | ExtensionsInstallFailedEvent | ExtensionInstallFailedEvent | ExtensionsInitializationFailedEvent;
 
 /**
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by the HTMLElement Layout container.
@@ -4944,6 +4964,18 @@ declare type EventWithId<Event extends AppVersionEvent> = Event extends infer E
     appVersionId: string;
 } : never;
 
+/**
+ * @interface
+ */
+declare type ExcludeOptions = {
+    /**
+     * @defaultValue false
+     *
+     * When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
+     */
+    preloadScripts: boolean;
+};
+
 /**
  * @internal
  *
@@ -4968,6 +5000,105 @@ declare type ExitCode = {
     exitCode: number;
 };
 
+declare type ExtensionEvent = SecurityRealmEvent & {
+    /**
+     * Runtime extension whose status has been (possibly) modified
+     */
+    extension: string;
+};
+
+/**
+ * @interface
+ */
+declare type ExtensionInfo = {
+    extensionId: string;
+    name: string;
+    enabled: boolean;
+};
+
+/**
+ * An event that fires when an extension is installed in the security realm.
+ *
+ * @interface
+ */
+declare type ExtensionInstalledEvent = ExtensionEvent & {
+    type: 'extension-installed';
+};
+
+/**
+ * An event that fires when an extension fails to install in the security realm.
+ *
+ * @interface
+ */
+declare type ExtensionInstallFailedEvent = ExtensionEvent & {
+    type: 'extension-install-failed';
+};
+
+/**
+ * An event that fires when extensions are disabled in the security realm.
+ *
+ * @interface
+ */
+declare type ExtensionsDisabledEvent = ExtensionsEvent & {
+    type: 'extensions-disabled';
+};
+
+/**
+ * An event that fires when extensions are enabled in the security realm.
+ *
+ * @interface
+ */
+declare type ExtensionsEnabledEvent = ExtensionsEvent & {
+    type: 'extensions-enabled';
+};
+
+declare type ExtensionsEvent = SecurityRealmEvent & {
+    /**
+     * Runtime extensions whose status has been (possibly) modified
+     */
+    extensions: string[];
+};
+
+/**
+ * An event that fires when requested extensions are not allowed to be installed in the security realm.
+ *
+ * @interface
+ */
+declare type ExtensionsExcludedEvent = ExtensionsEvent & {
+    type: 'extensions-excluded';
+};
+
+/**
+ * An event that fires when extension initialization fails on initial app launch.  Users may attempt to
+ * re-initialize extensions by calling {@link System.refreshExtensions}.  This event will not fire in response
+ * to manual extension refreshes (users should catch the error normally).
+ */
+declare type ExtensionsInitializationFailedEvent = Omit<ExtensionsEvent, 'extensions'> & {
+    type: 'extensions-initialization-failed';
+    /**
+     * The error that caused the extension initialization failure
+     */
+    error: Error;
+};
+
+/**
+ * An event that fires when extensions are installed in the security realm.
+ *
+ * @interface
+ */
+declare type ExtensionsInstalledEvent = ExtensionsEvent & {
+    type: 'extensions-installed';
+};
+
+/**
+ * An event that fires when extensions fail to install in the security realm.
+ *
+ * @interface
+ */
+declare type ExtensionsInstallFailedEvent = ExtensionsEvent & {
+    type: 'extensions-install-failed';
+};
+
 /**
  * An ExternalApplication object representing native language adapter connections to the runtime. Allows
  * the developer to listen to {@link OpenFin.ExternalApplicationEvents external application events}.
@@ -8150,6 +8281,29 @@ declare class Layout extends Base {
      * ```
      */
     applyPreset: (options: PresetLayoutOptions) => Promise<void>;
+    /**
+     * Adds a view to the platform layout. Behaves like @link{Platform#createView} with the current layout as the target.
+     *
+     * @param viewOptions - The options for creating the view.
+     * @param options - Optional parameters for adding the view.
+     * @param options.location - The location where the view should be added.
+     * @param options.targetView - The target view to which the new view should be added.
+     * @returns A promise that resolves to an object containing the identity of the added view.
+     */
+    addView(viewOptions: OpenFin.PlatformViewCreationOptions, { location, targetView }?: {
+        location?: OpenFin.CreateViewTarget['location'];
+        targetView?: OpenFin.Identity;
+    }): Promise<{
+        identity: OpenFin.Identity;
+    }>;
+    /**
+     * Closes a view by its identity. Throws an error if the view does not belong to the current layout.
+     * Behaves like @link{Platform#closeView} but only closes the view if it belongs the current layout.
+     *
+     * @param viewIdentity - The identity of the view to close.
+     * @returns A promise that resolves when the view is closed.
+     */
+    closeView(viewIdentity: OpenFin.Identity): Promise<void>;
 }
 
 /**
@@ -8162,7 +8316,7 @@ declare type LayoutColumn = LayoutItemConfig & {
 /**
  * @interface
  */
-declare type LayoutComponent = LayoutItemConfig & {
+declare type LayoutComponent = Omit<LayoutItemConfig, 'content' | 'type'> & {
     /**
      * Only a component type will have this property and it should be set to view.
      */
@@ -8171,6 +8325,7 @@ declare type LayoutComponent = LayoutItemConfig & {
      * Only a component type will have this property and it represents the view options of a given component.
      */
     componentState?: Partial<ViewCreationOptions>;
+    type: 'component';
 };
 
 declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent>;
@@ -8254,10 +8409,7 @@ declare type LayoutIdentity = Identity_4 & {
 declare type LayoutInitializedEvent = BaseEvent_5 & {
     type: 'layout-initialized';
     layoutIdentity: OpenFin.LayoutIdentity;
-    ofViews: {
-        identity: OpenFin.Identity;
-        entityType: 'view';
-    }[];
+    ofViews: OpenFin.ViewCreationResult[];
 };
 
 /**
@@ -8365,7 +8517,7 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
     /**
      * @experimental
      */
-    getLayoutIdentityForView(viewIdentity: Identity_4): LayoutIdentity;
+    getLayoutIdentityForView(viewIdentity: Identity_4): LayoutIdentity | undefined;
     /**
      * @experimental
      */
@@ -9290,6 +9442,10 @@ declare type MutableViewOptions = {
      * @defaultValue 'enabled'
      */
     throttling: ViewThrottling;
+    /**
+     * {@inheritDoc ChromiumPolicies}
+     */
+    chromiumPolicies: ChromiumPolicies;
 };
 
 /**
@@ -9555,6 +9711,10 @@ declare type MutableWindowOptions = {
      * @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
      */
     throttling: WindowThrottling;
+    /**
+     * {@inheritDoc ChromiumPolicies}
+     */
+    chromiumPolicies: ChromiumPolicies;
 };
 
 declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
@@ -9775,8 +9935,11 @@ declare namespace OpenFin {
         ViewVisibilityOptions,
         WindowState,
         AutoplayPolicyOptions,
+        ExcludeOptions,
         ConstWindowOptions,
         InheritableOptions,
+        PolicyOptions,
+        ChromiumPolicies,
         MutableWindowOptions,
         WorkspacePlatformOptions,
         WebRequestHeader,
@@ -9810,6 +9973,9 @@ declare namespace OpenFin {
         ViewOptions,
         ConstViewOptions,
         ViewState,
+        ViewCreationSuccess,
+        ViewCreationFailure,
+        ViewCreationResult,
         Certificate,
         HostContextChangedPayload,
         ApplySnapshotOptions,
@@ -10055,6 +10221,7 @@ declare namespace OpenFin {
         RoutingInfo,
         DownloadShelfOptions,
         ViewShowAtOptions,
+        ExtensionInfo,
         ApplicationEvents,
         BaseEvents,
         ExternalApplicationEvents,
@@ -10256,6 +10423,10 @@ declare type PerDomainSettings = {
      * {@link ContentRedirect} in {@link WindowOptions} and {@link ViewOptions} will be **ignored**.
      */
     content?: ContentPermission;
+    /**
+     * {@inheritdoc ChromiumPolicies}
+     */
+    chromiumPolicies?: ChromiumPolicies;
 };
 
 /**
@@ -11688,6 +11859,45 @@ declare interface PlatformProvider {
      * @returns {Promise<void>}
      */
     handleRunRequested({ manifest, userAppConfigArgs }: RunRequestedEvent): Promise<void>;
+    /**
+     * @experimental
+     *
+     * This method is called to handle errors with view creation and initial navigation during layout creation.
+     * Overriding this method enables catching the error and correcting behavior (ie navigating to an error page).
+     * * To indicate that the error has been handled, view creation should be treated as successful return {identity: viewIdentity, success: true}.
+     * * Not returning anything will cause the layout-initialized event to include the view as failed with the original error.
+     * * Throwing an error will update the error on the event payload of layout-initialized to the thrown error.
+     *
+     * @param viewIdentity Identity of the view
+     * @param error error thrown during a view creation
+     * @returns {Promise<OpenFin.ViewCreationSuccess | void>}
+     *
+     * @example
+     *
+     * ```js
+     * const overrideCallback = (PlatformProvider) => {
+     *     class Override extends PlatformProvider {
+     *         async handleFailedViewCreation(viewIdentity, error) {
+     *              const view = fin.View.wrapSync(viewId);
+     *              try {
+     *                  // navigate to an error page
+     *                  await view.navigate('http://localhost:3000/errorPage.html');
+     *                  // resolve a success result after redirecting to a error page
+     *                  return {identity: viewIdentity, success: true};
+     *              } catch(e) {
+     *                  // layout-initialized event will include this view with the error
+     *                  throw error;
+     *              }
+     *         }
+     *     }
+     *     return new Override();
+     * }
+     *
+     * fin.Platform.init({ overrideCallback });
+     *
+     * ```
+     */
+    handleFailedViewCreation(viewIdentity: OpenFin.Identity, error: Error): Promise<OpenFin.ViewCreationSuccess | void>;
 }
 
 /**
@@ -11752,6 +11962,12 @@ declare type PointTopLeft = {
     left: number;
 };
 
+/**
+ * When set to `disable`, disables the policy
+ * When set to `defer-to-group-policy`, respects Group Policy settings
+ */
+declare type PolicyOptions = 'disable' | 'defer-to-group-policy';
+
 declare type PopupBaseBehavior = 'close' | 'hide';
 
 declare type PopupBlurBehavior = 'modal' | PopupBaseBehavior;
@@ -12767,6 +12983,14 @@ declare interface ProtocolMap extends ProtocolMapBase {
     }, void>;
     'system-register-shutdown-handler': VoidCall;
     'get-permissions': GetterCall<any>;
+    'refresh-extensions': {
+        request: void;
+        response: string[] | undefined;
+    };
+    'get-installed-extensions': {
+        request: void;
+        response: OpenFin.ExtensionInfo[];
+    };
     'fdc3-add-context-listener': VoidCall;
     'fdc3-add-intent-listener': VoidCall;
     'fdc3-raise-intent': VoidCall;
@@ -13455,6 +13679,21 @@ declare type ScreenshotPrintOptions = {
     content: 'screenshot';
 };
 
+/**
+ * An event generated when an application modifies the runtime in a way that affects all other applications in the
+ * application runtime/security realm.
+ */
+declare type SecurityRealmEvent = BaseEvent_9 & {
+    /**
+     * Config URL of the application that modified the security realm's extensions
+     */
+    configUrl: string;
+    /**
+     * Identity of the application that modified the security realm's extensions
+     */
+    applicationIdentity: OpenFin.ApplicationIdentity;
+};
+
 declare type SendActionResponse<T extends keyof ProtocolMap> = Message<{
     data: ProtocolMap[T]['response'];
 } & ProtocolMap[T]['specialResponse']>;
@@ -15352,6 +15591,16 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
      * ```
      */
     setDomainSettings(domainSettings: OpenFin.DefaultDomainSettings): Promise<void>;
+    /**
+     * Attempts to install and enable extensions for the security realm.  Users may want to call this function in response
+     * to an `extensions-install-failed` event.  Only extensions allowed by every application on the current security realm
+     * will be installed/enabled.
+     */
+    refreshExtensions(): Promise<string[] | undefined>;
+    /**
+     * Gets the currently-installed
+     */
+    getInstalledExtensions(): Promise<OpenFin.ExtensionInfo[]>;
 }
 
 /**
@@ -15382,6 +15631,14 @@ declare namespace SystemEvents {
         ApplicationCreatedEvent,
         DesktopIconClickedEvent,
         SystemShutdownEvent,
+        ExtensionsEnabledEvent,
+        ExtensionsDisabledEvent,
+        ExtensionsExcludedEvent,
+        ExtensionsInstalledEvent,
+        ExtensionInstalledEvent,
+        ExtensionsInstallFailedEvent,
+        ExtensionInstallFailedEvent,
+        ExtensionsInitializationFailedEvent,
         Event_11 as Event,
         SystemEvent,
         EventType_8 as EventType,
@@ -16500,6 +16757,24 @@ declare type ViewContentCreationRule = BaseContentCreationRule & {
     options?: Partial<ViewOptions>;
 };
 
+/**
+ * @interface
+ */
+declare type ViewCreationFailure = {
+    /**
+     * The identity of the created view
+     */
+    identity: Identity_4;
+    /**
+     * Whether the view was created with errors
+     */
+    success: false;
+    /**
+     * Error thrown during view creation
+     */
+    error: Error;
+};
+
 /**
  * The options object required by {@link View.ViewModule.create View.create}.
  *
@@ -16515,6 +16790,25 @@ declare type ViewCreationOptions = Partial<ViewOptions> & {
 
 declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCreationOptions;
 
+/**
+ * A view creation state
+ */
+declare type ViewCreationResult = ViewCreationSuccess | ViewCreationFailure;
+
+/**
+ * @interface
+ */
+declare type ViewCreationSuccess = {
+    /**
+     * The identity of the created view
+     */
+    identity: Identity_4;
+    /**
+     * Whether the view was created without errors
+     */
+    success: true;
+};
+
 /**
  * Generated when a window has a view detached from it.
  * @remarks Will fire when a view is destroyed in which case `target` will be null.
@@ -16676,6 +16970,9 @@ declare class ViewModule extends Base {
  */
 declare type ViewOptions = ConstViewOptions & MutableViewOptions;
 
+/**
+ * @interface
+ */
 declare type ViewShowAtOptions = {
     /**
      * Sets the view as the top level view. See {@link OpenFin.View.bringToFront} for more information.

package/package.json

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