@openfin/workspace-platform 24.1.1 → 24.1.2

package/client-api-platform/src/init/index.d.ts

@@ -35,4 +35,4 @@ import { WorkspacePlatformInitConfig } from '../../../client-api-platform/src/sh
  * ```
  * @param options options for configuring the platform.
  */
-export declare const init: ({ theme, customActions, language, ...rest }: WorkspacePlatformInitConfig) => Promise<OpenFin.Platform>;
+export declare const init: (config: WorkspacePlatformInitConfig) => Promise<OpenFin.Platform>;

package/client-api-platform/src/shapes.d.ts

@@ -1,5 +1,6 @@
 import type OpenFin from '@openfin/core';
 import type { IconProps, IconType, Languages } from '@openfin/ui-library';
+import type { WorkspaceIndicatorConfig } from '../../common/src/utils/indicators/workspace-indicators';
 import type { AnalyticsEvent } from '../../common/src/utils/usage-register';
 import type { CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/action';
 import type { AddDefaultPagePayload, AttachedPage, BookmarkNode, CopyPagePayload, HandlePagesAndWindowClosePayload, HandlePagesAndWindowCloseResult, HandleSaveModalOnPageClosePayload, Page, PageLayoutsWithSelectedViews, PageWithUpdatableRuntimeAttribs, SaveModalOnPageCloseResult, SetActivePageForWindowPayload, ShouldPageClosePayload, ShouldPageCloseResult, ViewsPreventingUnloadPayload } from '../../common/src/api/pages/shapes';
@@ -154,7 +155,7 @@ export declare enum PageTabContextMenuOptionType {
     Rename = "Rename",
     Save = "Save",
     SaveAs = "Save As",
-    NewPage = "New Page",
+    NewPage = "New Page",// Enterprise
     DeletePage = "Delete Page",// Enterprise
     SaveWorkspaceAs = "SaveWorkspaceAs",// Enterprise
     Refresh = "Refresh",// Enterprise
@@ -2465,6 +2466,23 @@ export interface BrowserInitConfig {
      * Defaults to `false` (current unique-title behavior preserved).
      */
     allowDuplicatePageTitles?: boolean;
+    /**
+     * Opt-in suppression flags for workspace success indicators.
+     * Both flags default to `false`; existing platforms see no behaviour change.
+     *
+     * @example
+     * ```ts
+     * await WorkspacePlatform.init({
+     *   browser: {
+     *     indicators: {
+     *       suppressWorkspaceSwitched: true,
+     *       suppressWorkspaceSaved: true,
+     *     },
+     *   },
+     * });
+     * ```
+     */
+    indicators?: WorkspaceIndicatorConfig;
 }
 interface WorkspaceMetadata {
     APIVersion: string;

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

@@ -32,6 +32,8 @@ export interface Page {
     panels?: PanelConfig[];
     /** Used to define the context group for the page */
     contextGroup?: string;
+    /** When true, view tab headers within this Supertab are hidden. */
+    viewTabsHidden?: boolean;
     /** Optional property to attach custom metadata to the page object, such as version or timestamp. Must be serializable. */
     customData?: any;
     /** True when this page is an admin-published supertab. */

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

@@ -50,6 +50,13 @@ export declare function showSuccess(payload: ShowSuccessPayload): Promise<void>;
  */
 export declare function showInfo(payload: ShowInfoPayload): Promise<void>;
 /**
- * Creates a window centered on monitor containing a success indicator for switching workspaces
+ * Creates a window centered on monitor containing a success indicator for switching workspaces.
+ * No-ops when `suppressWorkspaceSwitched` has been set via `BrowserInitConfig.indicators`.
  */
 export declare function showSwitchWorkspaceSuccess(): Promise<void>;
+/**
+ * Creates a success indicator for workspace save and save-as operations.
+ * No-ops when `suppressWorkspaceSaved` has been set via `BrowserInitConfig.indicators`.
+ * Rename operations are intentionally unaffected — use `showSuccess` directly for those.
+ */
+export declare const showWorkspaceSavedSuccess: (payload: ShowSuccessPayload) => Promise<void>;

package/common/src/utils/indicators/workspace-indicators.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Configuration for suppressing workspace success indicators.
+ */
+export interface WorkspaceIndicatorConfig {
+    /** Suppress the "Workspace Switched" indicator on all applyWorkspace calls. @default false */
+    suppressWorkspaceSwitched?: boolean;
+    /** Suppress the "Workspace Saved" indicator on regular workspace save only. Save-as and rename are unaffected. @default false */
+    suppressWorkspaceSaved?: boolean;
+}
+export declare const initWorkspaceIndicators: (config?: WorkspaceIndicatorConfig) => void;
+export declare const getSuppressWorkspaceSwitched: () => boolean;
+/** Returns true when the "Workspace Saved" indicator should be suppressed (save only; save-as and rename are unaffected). */
+export declare const getSuppressWorkspaceSaved: () => boolean;

package/externals.report.json

@@ -37,14 +37,6 @@
             "issuer": "common/src/api/i18next.ts"
         }
     ],
-    "lodash.clonedeep": [
-        {
-            "type": "explicit",
-            "version": "4.5.0",
-            "packageName": "common/package.json",
-            "issuer": "common/src/utils/layout.ts"
-        }
-    ],
     "dexie": [
         {
             "type": "root-implicit",
@@ -70,5 +62,13 @@
             "packageName": "common/package.json",
             "issuer": "common/src/utils/create-and-migrate-ibd-store.ts"
         }
+    ],
+    "lodash.clonedeep": [
+        {
+            "type": "explicit",
+            "version": "4.5.0",
+            "packageName": "common/package.json",
+            "issuer": "common/src/utils/layout.ts"
+        }
     ]
 }