@openfin/workspace-platform 24.0.14 → 24.0.15

package/client-api-platform/src/api/app-directory.d.ts

@@ -7,7 +7,7 @@ import type { LaunchAppRequest, SearchSitesRequest, SearchSitesResponse, Site }
  * @param app the app directory entry.
  * @param opts launch options.
  */
-export declare function launchApp({ app, target }: LaunchAppRequest): Promise<void | OpenFin.Identity | OpenFin.Application | OpenFin.View | OpenFin.Platform>;
+export declare function launchApp({ app, target }: LaunchAppRequest): Promise<void | OpenFin.Identity | OpenFin.View | OpenFin.Platform | OpenFin.Application>;
 export declare const enterpriseAppDirectoryChannelClient: () => Promise<OpenFin.ChannelClient>;
 export declare function getResults(payload: {
     req: SearchSitesRequest;

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

@@ -36,4 +36,4 @@ export declare const MAX_FIRST_THEME_SYNC_WAIT = 3000;
  * ```
  * @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/init/override-callback/snapshot.page-tab-groups.test.d.ts

@@ -0,0 +1 @@
+export {};

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';
@@ -11,7 +12,7 @@ export * from '../../dock3/src/shapes';
 export { AppManifestType } from '../../client-api/src/shapes';
 export type { App, AppIntent, Image } from '../../client-api/src/shapes';
 export type { CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/action';
-export type { AttachedPage, Page, PageLayout, PageLayoutDetails, PageWithUpdatableRuntimeAttribs, PanelConfigHorizontal, PanelConfigVertical, PanelConfig, ExtendedPanelConfig, CopyPagePayload, HandleSaveModalOnPageClosePayload, SaveModalOnPageCloseResult, SetActivePageForWindowPayload, ShouldPageClosePayload, ShouldPageCloseResult, ViewsPreventingUnloadPayload } from '../../common/src/api/pages/shapes';
+export type { AttachedPage, Page, PagePinnedState, PageLayout, PageLayoutDetails, PageWithUpdatableRuntimeAttribs, PanelConfigHorizontal, PanelConfigVertical, PanelConfig, ExtendedPanelConfig, CopyPagePayload, HandleSaveModalOnPageClosePayload, SaveModalOnPageCloseResult, SetActivePageForWindowPayload, ShouldPageClosePayload, ShouldPageCloseResult, ViewsPreventingUnloadPayload } from '../../common/src/api/pages/shapes';
 export { PanelPosition } from '../../common/src/api/pages/shapes';
 export type { CustomThemes, CustomThemeOptions, ThemeOptions, CustomThemeOptionsWithScheme, CustomPaletteSet, BaseThemeOptions, ThemeExtension, WorkspaceThemeSet, NotificationIndicatorColorsSet, NotificationIndicatorColorsSetDarkScheme, NotificationIndicatorColorsSetLightScheme, NotificationIndicatorColorsWithScheme } from '../../common/src/api/theming';
 export type { AnalyticsEvent } from '../../common/src/utils/usage-register';
@@ -155,6 +156,10 @@ export declare enum PageTabContextMenuOptionType {
     Save = "Save",
     SaveAs = "Save As",
     NewPage = "New Page",
+    /** Workspace Browser: pin a normal tab (sets `pinned: 'user'`). */
+    Pin = "Pin",
+    /** Workspace Browser: unpin a user-pinned tab (clears `pinned`). */
+    Unpin = "Unpin",// Enterprise
     DeletePage = "Delete Page",// Enterprise
     SaveWorkspaceAs = "SaveWorkspaceAs",// Enterprise
     Refresh = "Refresh",// Enterprise
@@ -2472,6 +2477,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

@@ -1,5 +1,6 @@
 import { OpenFin } from '@openfin/core';
 import { ExtendedPanelConfig, PageLayout, PanelConfig } from '../../../../client-api-platform/src/index';
+import type { PagePinnedState } from '../../../../common/src/api/pages/shapes';
 export interface Page {
     /** A UI friendly title for the page. */
     title: string;
@@ -21,6 +22,9 @@ export interface Page {
     layout: PageLayout;
     /** True if the page is locked. */
     isLocked?: boolean;
+    /** Not used by enterprise — page pinning is a workspace-only feature. Declared here because
+     *  shared code (page-tab-context-menu.ts) casts to AttachedPageInternal and accesses this field. */
+    pinned?: PagePinnedState;
     /** Used to manipulate behaviour of a close button on a page tab. If `undefined`, then close button is visible and actionable.
      * If either property true, this page tab's context menu will disable its 'Close Page' option.
      */

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

@@ -12,6 +12,8 @@ export interface PageLayoutDetails {
 export type PageLayout = OpenFin.LayoutOptions & {
     layoutDetails?: PageLayoutDetails;
 };
+/** The pinned state of a page tab. `'platform'` = developer-locked; `'user'` = end-user pinned. */
+export type PagePinnedState = 'platform' | 'user';
 /**
  * Provides configuration options for a set of Workspace Views. An array of Page objects is a required option of the {@link workspacePlatform}
  * property of the {@link BrowserCreateWindowRequest} interface.
@@ -62,6 +64,8 @@ export interface Page {
     layout: PageLayout;
     /** True if the page is locked. */
     isLocked?: boolean;
+    /** Pinned state: `'platform'` (developer-locked), `'user'` (end-user pinned), or omitted (normal). */
+    pinned?: PagePinnedState;
     /** Used to manipulate behaviour of a close button on a page tab. If `undefined`, then close button is visible and actionable.
      * If either property true, this page tab's context menu will disable its 'Close Page' option.
      */
@@ -124,17 +128,21 @@ export interface ReorderPagesForWindowPayload {
     /** The ordered ids of the attached pages. */
     pageIds: string[];
 }
+/** Page fields for update payloads. `null` signals "clear this field" over IPC (null survives JSON serialization, undefined does not). */
+type PageUpdateNullableOverrides = {
+    pinned?: PagePinnedState | null;
+};
 export interface UpdatePageForWindowPayload {
     /** The OF window identity the pages to change the order of. */
     identity: OpenFin.Identity;
     /** The id of the attached page to update. */
     pageId: string;
     /** The partial updated state of the page. */
-    page: Partial<PageWithUpdatableRuntimeAttribs>;
+    page: Omit<Partial<PageWithUpdatableRuntimeAttribs>, 'pinned'> & PageUpdateNullableOverrides;
 }
 export interface ExtendedUpdatePageForWindowPayload extends UpdatePageForWindowPayload {
     /** The partial updated state of the page. */
-    page: Partial<AttachedPage>;
+    page: Omit<Partial<AttachedPage>, 'pinned'> & PageUpdateNullableOverrides;
 }
 export interface AttachPagesToWindowPayload {
     /** The OF window identity to attach the pages to. */

package/common/src/api/theming.d.ts

@@ -307,7 +307,7 @@ export declare const constructThemePaletteSheet: (themes: GeneratedPalettes, leg
     dark: string;
 }) => string;
 export declare const getComputedPlatformTheme: (platformIdentity: OpenFin.Identity) => Promise<{
-    theme: CustomThemes | GeneratedPalettes;
+    theme: GeneratedPalettes | CustomThemes;
     defaultScheme: ColorSchemeOptionType;
     themePaletteSheet: string;
 }>;

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/common/src/utils/layout.d.ts

@@ -1,4 +1,5 @@
 import type OpenFin from '@openfin/core';
+import type { PagePinnedState } from '../../../common/src/api/pages/shapes';
 import { WindowIdentity } from '../../../common/src/utils/window';
 import { AttachedPage, PageLayout } from '../../../client-api-platform/src/shapes';
 export type LayoutDOMEventType = 
@@ -115,6 +116,14 @@ export declare const cleanupLayoutObservers: (layoutName: string) => void;
  * Initialize the layout for the current OF window.
  */
 export declare const initLayoutListeners: () => Promise<void>;
+/**
+ * Returns true when a page's in-page layout should be locked.
+ * This applies for user-locked pages (`isLocked`) and platform-pinned pages (`pinned === 'platform'`).
+ */
+export declare const isPageLayoutLocked: (page: {
+    isLocked?: boolean;
+    pinned?: PagePinnedState;
+}) => boolean;
 /**
  * Deep clones a layout and changes its settings to make it "locked".
  * @param layout The Layout to be locked

package/common/src/utils/popup-window.d.ts

@@ -113,12 +113,31 @@ export type RenameSupertabChannelMessage = BasePopupMenuChannelMessage & {
         pageId: string;
     };
 };
+/**
+ * A row in the tab search list. {@link showPin} / {@link showUnpin} are optional; when omitted, no row action.
+ */
+export type TabSearchListItem = {
+    id: string;
+    title: string;
+    /** When true, show a control to pin (move to the user page group). Core UI + ungrouped only. */
+    showPin?: boolean;
+    /** When true, show a control to unpin (leave the user page group). */
+    showUnpin?: boolean;
+    /**
+     * When true, show a non-interactive lock (workspace / platform locked); ungrouped pages only.
+     * Mutually exclusive with {@link showPin} in the browser; does not replace {@link showUnpin}.
+     */
+    showPlatformLocked?: boolean;
+};
 export type TabSearchModalContent = {
     variant: 'page' | 'view';
-    tabs: {
-        title: string;
-        id: string;
-    }[];
+    tabs: TabSearchListItem[];
+};
+/** Channel action: browser → tab-search popup; refreshes list rows after pin/unpin while open. */
+export declare const TAB_SEARCH_CHANNEL_ACTION_UPDATE_TABS: "update-tabs";
+export type TabSearchUpdateTabsMessage = {
+    requestId: string;
+    tabs: TabSearchListItem[];
 };
 export type TabSearchChannelMessage = BasePopupMenuChannelMessage & {
     type: PopupWindowMenuType.TabSearch;

package/externals.report.json

@@ -21,43 +21,43 @@
             "issuer": "common/src/utils/color-linking.ts"
         }
     ],
-    "react-i18next": [
+    "lodash.clonedeep": [
         {
             "type": "explicit",
-            "version": "15.4.0",
+            "version": "4.5.0",
             "packageName": "common/package.json",
-            "issuer": "common/src/api/i18next.ts"
+            "issuer": "common/src/utils/layout.ts"
         }
     ],
-    "i18next": [
+    "react-i18next": [
         {
             "type": "explicit",
-            "version": "^23.7.16",
+            "version": "15.4.0",
             "packageName": "common/package.json",
             "issuer": "common/src/api/i18next.ts"
         }
     ],
-    "lodash.clonedeep": [
+    "i18next": [
         {
             "type": "explicit",
-            "version": "4.5.0",
+            "version": "^23.7.16",
             "packageName": "common/package.json",
-            "issuer": "common/src/utils/layout.ts"
+            "issuer": "common/src/api/i18next.ts"
         }
     ],
     "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": "dock3/package.json",
             "issuer": "dock3/src/api/idb.ts"
         },
+        {
+            "type": "explicit",
+            "version": "^4.0.11",
+            "packageName": "client-api-platform/package.json",
+            "issuer": "client-api-platform/src/api/dock/idb.ts"
+        },
         {
             "type": "explicit",
             "version": "^4.0.11",