@openfin/core 40.82.19 → 40.82.21

package/out/mock.d.ts

@@ -3716,11 +3716,6 @@ declare type ConstWindowOptions = {
      * @deprecated - use `icon` instead.
      */
     taskbarIcon: string;
-    /**
-     * Specify a taskbar group for the window.
-     * _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
-     */
-    taskbarIconGroup: string;
     /**
      * @defaultValue "about:blank"
      *
@@ -4763,6 +4758,7 @@ declare interface Environment {
     getInteropInfo(fin: OpenFin_2.Fin<OpenFin_2.EntityType>): Promise<InternalInteropBrokerOptions & {
         fdc3Version?: Version;
     }>;
+    getViewWindowIdentity(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, identity: OpenFin_2.Identity): Promise<OpenFin_2.Identity>;
     readonly type: EnvironmentType;
 }
 
@@ -7638,6 +7634,10 @@ declare type LaunchIntoPlatformPayload = {
  */
 declare class Layout extends Base {
     #private;
+    /**
+     * @internal
+     */
+    static getClient(layout: Layout): Promise<LayoutEntitiesClient>;
     /**
      * @internal
      */
@@ -7743,6 +7743,16 @@ declare class Layout extends Base {
      * ```
      */
     getRootItem(): Promise<OpenFin_2.ColumnOrRow | OpenFin_2.TabStack>;
+    /**
+     * Retrieves the OpenFin.TabStack instance which the View belongs to.
+     *
+     * @example
+     * ```js
+     * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
+     * const stack = await fin.View.wrapSync(viewIdentity).getStackByViewIdentity(viewIdentity);
+     * console.log(await stack.getViews());
+     * ```
+     */
     getStackByViewIdentity(identity: OpenFin_2.Identity): Promise<OpenFin_2.TabStack>;
     /**
      * Replaces the specified view with a view with the provided configuration.
@@ -7901,10 +7911,7 @@ declare type LayoutIdentity = Identity_4 & {
 declare type LayoutInitializedEvent = BaseEvent_5 & {
     type: 'layout-initialized';
     layoutIdentity: OpenFin_2.LayoutIdentity;
-    ofViews: {
-        identity: OpenFin_2.Identity;
-        entityType: 'view';
-    }[];
+    ofViews: OpenFin_2.ViewCreationResult[];
 };
 
 /**
@@ -8113,6 +8120,17 @@ declare class LayoutModule extends Base {
      * ```
      */
     getCurrentSync(): OpenFin_2.Layout;
+    /**
+     * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
+     *
+     * @example
+     * ```js
+     * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
+     * const layout = await fin.Platform.Layout.getLayoutByViewIdentity(viewIdentity);
+     * console.log(await layout.getCurrentViews());
+     * ```
+     */
+    getLayoutByViewIdentity(viewIdentity: OpenFin_2.Identity): Promise<OpenFin_2.Layout>;
     /**
      * Initialize the window's Layout.
      *
@@ -9166,6 +9184,12 @@ declare type MutableWindowOptions = {
      * Shows the window's icon in the taskbar.
      */
     showTaskbarIcon: boolean;
+    /**
+     * Specify a taskbar group for the window.
+     * _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
+     * @remarks It's only updatable when `enableJumpList` is set to false.
+     */
+    taskbarIconGroup: string;
     interop: InteropConfig;
     /**
      * @internal
@@ -9440,6 +9464,9 @@ declare namespace OpenFin_2 {
         ViewOptions,
         ConstViewOptions,
         ViewState,
+        ViewCreationSuccess,
+        ViewCreationFailure,
+        ViewCreationResult,
         Certificate,
         HostContextChangedPayload,
         ApplySnapshotOptions,
@@ -11326,6 +11353,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_2.Identity, error: Error): Promise<OpenFin_2.ViewCreationSuccess | void>;
 }
 
 /**
@@ -15834,7 +15900,7 @@ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
      */
     getInfo: () => Promise<OpenFin_2.ViewInfo>;
     /**
-     * Retrieves the layout for the window the view is attached to.
+     * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
      *
      * @example
      * ```js
@@ -16032,6 +16098,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}.
  *
@@ -16047,6 +16131,25 @@ declare type ViewCreationOptions = Partial<ViewOptions> & {
 
 declare type ViewCreationOrReference = OpenFin_2.Identity | OpenFin_2.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.