@openfin/workspace-platform 22.2.7 → 22.2.9

package/client-api/src/dock.d.ts

@@ -59,34 +59,34 @@ export declare const register: (provider: DockProvider) => Promise<DockProviderR
  */
 export declare const deregister: () => Promise<void>;
 /**
- * API function to show the Dock UI.
+ * API function to minimize the Dock UI.
  *
  * @remarks A Workspace Platform must be initialized, and at least one Dock provider must be registered for this function to take effect.
  *
- * @returns a promise that resolves once the Dock UI is hidden
+ * @returns a promise that resolves once the Dock UI is minimized
  *
- * @example Show a Dock provider.
+ * @example Minimize a Dock provider.
  *
  * ```ts
  * import { Dock } from '@openfin/workspace';
  *
- * await Dock.show();
+ * await Dock.minimize();
  * ```
  */
 export declare const minimize: () => Promise<void>;
 /**
- * API function to hide the Dock UI.
+ * API function to show the Dock UI.
  *
  * @remarks A Workspace Platform must be initialized, and at least one Dock provider must be registered for this function to take effect.
  *
- * @returns a promise that resolves once the Dock UI is hidden
+ * @returns a promise that resolves once the Dock UI is shown
  *
- * @example Hide a Dock provider.
+ * @example Show a Dock provider.
  *
  * ```ts
  * import { Dock } from '@openfin/workspace';
  *
- * await Dock.hide();
+ * await Dock.show();
  * ```
  */
 export declare const show: () => Promise<void>;

package/common/src/api/pages/enterprise-shapes.d.ts

@@ -44,6 +44,8 @@ type AttachedPageMetadata = {
     hasUnsavedChanges?: boolean;
     /** Panel config with all view identities in place */
     panels?: ExtendedPanelConfig[];
+    /** The name of the layout this page contains, useful for interacting with OpenFin Core APIs. */
+    layoutName?: string;
 };
 export type AttachedPage = Page & AttachedPageMetadata;
 export type AttachedPageInternal = {
@@ -51,5 +53,7 @@ export type AttachedPageInternal = {
     singleViewName?: string;
     attachedPageType?: 'singleView' | 'multiView' | undefined;
     isLayoutCreated?: boolean;
+    pageIcon?: string;
+    isLayoutReady?: boolean;
 } & AttachedPage;
 export {};

package/common/src/api/pages/shapes.d.ts

@@ -92,6 +92,7 @@ export type AttachedPageInternal = {
     singleViewName?: string;
     attachedPageType?: 'singleView' | 'multiView' | undefined;
     isLayoutCreated?: boolean;
+    pageIcon?: string;
 } & AttachedPage;
 export type ReparentAttachedPage = AttachedPage & {
     multiInstanceViewBehavior?: 'reparent';

package/common/src/utils/indicators/browser.d.ts

@@ -1,6 +1,7 @@
 import type OpenFin from '@openfin/core';
+import { IconType } from '@openfin/ui-library';
 import { IndicatorType } from '../../../../common/src/components/Indicator/Indicator.constants';
-export type BrowserIndicatorIcon = 'LockClosedIcon' | 'LockOpen1Icon' | 'PageIcon' | 'BlockedIcon';
+export type BrowserIndicatorIcon = Extract<IconType, 'LockClosedIcon' | 'LockOpen1Icon' | 'PageIcon' | 'BlockedIcon' | 'SupertabIcon'>;
 export interface ShowBrowserIndicatorPayload {
     type: IndicatorType;
     message: string;

package/externals.report.json

@@ -38,18 +38,18 @@
         }
     ],
     "dexie": [
-        {
-            "type": "explicit",
-            "version": "^4.0.11",
-            "packageName": "client-api-platform/package.json",
-            "issuer": "client-api-platform/src/api/dock/idb.ts"
-        },
         {
             "type": "root-implicit",
             "version": "^4.0.11",
             "packageName": "common/package.json",
             "issuer": "common/src/api/pages/idb.ts"
         },
+        {
+            "type": "explicit",
+            "version": "^4.0.11",
+            "packageName": "client-api-platform/package.json",
+            "issuer": "client-api-platform/src/api/dock/idb.ts"
+        },
         {
             "type": "root-implicit",
             "version": "^4.0.11",