@openfin/fdc3-api 38.82.67 → 38.83.70

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

@@ -3463,6 +3463,10 @@ declare type ConstViewOptions = {
          */
         enabled: boolean;
     };
+    /**
+     * Control which options to ignore when creating a Platform View.
+     */
+    excludeOptions: ExcludeOptions;
 };
 
 /**
@@ -3707,6 +3711,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;
 };
 
 /**
@@ -4740,7 +4748,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.
@@ -4885,6 +4893,18 @@ declare type EventType_9 = Event_12['type'];
 
 /* Excluded from this release type: EventWithId */
 
+/**
+ * @interface
+ */
+declare type ExcludeOptions = {
+    /**
+     * @defaultValue false
+     *
+     * When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
+     */
+    preloadScripts: boolean;
+};
+
 /* Excluded from this release type: ExcludeRequested */
 
 declare type ExistingConnectConfig = ConfigWithUuid & {
@@ -4900,6 +4920,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}.
@@ -8123,10 +8242,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[];
 };
 
 /**
@@ -9431,6 +9547,7 @@ declare namespace OpenFin {
         ViewVisibilityOptions,
         WindowState,
         AutoplayPolicyOptions,
+        ExcludeOptions,
         ConstWindowOptions,
         InheritableOptions,
         PolicyOptions,
@@ -9468,6 +9585,9 @@ declare namespace OpenFin {
         ViewOptions,
         ConstViewOptions,
         ViewState,
+        ViewCreationSuccess,
+        ViewCreationFailure,
+        ViewCreationResult,
         Certificate,
         HostContextChangedPayload,
         ApplySnapshotOptions,
@@ -9711,6 +9831,7 @@ declare namespace OpenFin {
         RoutingInfo,
         DownloadShelfOptions,
         ViewShowAtOptions,
+        ExtensionInfo,
         ApplicationEvents,
         BaseEvents,
         ExternalApplicationEvents,
@@ -11270,6 +11391,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>;
 }
 
 /**
@@ -12355,6 +12515,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;
@@ -13043,6 +13211,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']>;
@@ -14934,6 +15117,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[]>;
 }
 
 /**
@@ -14964,6 +15157,14 @@ declare namespace SystemEvents {
         ApplicationCreatedEvent,
         DesktopIconClickedEvent,
         SystemShutdownEvent,
+        ExtensionsEnabledEvent,
+        ExtensionsDisabledEvent,
+        ExtensionsExcludedEvent,
+        ExtensionsInstalledEvent,
+        ExtensionInstalledEvent,
+        ExtensionsInstallFailedEvent,
+        ExtensionInstallFailedEvent,
+        ExtensionsInitializationFailedEvent,
         Event_11 as Event,
         SystemEvent,
         EventType_8 as EventType,
@@ -16038,6 +16239,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}.
  *
@@ -16053,6 +16272,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.
@@ -16214,6 +16452,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.