@openfin/workspace-platform 45.0.2 → 45.0.3

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.Platform | OpenFin.Application | OpenFin.View>;
+export declare function launchApp({ app, target }: LaunchAppRequest): Promise<void | OpenFin.Identity | OpenFin.Application | OpenFin.View | OpenFin.Platform>;
 export declare const enterpriseAppDirectoryChannelClient: () => Promise<OpenFin.ChannelClient>;
 export declare function getResults(payload: {
     req: SearchSitesRequest;

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

@@ -1,6 +1,6 @@
 import type OpenFin from '@openfin/core';
-import type { BaseThemeOptions, CustomPaletteSet, CustomTheme, GeneratedPalettes, GenerateThemeParams } from '../../../common/src/api/theming';
-import { ColorSchemeOptionType, ThemeApi } from '../../../client-api-platform/src/shapes';
+import type { GeneratedPalettes, NotificationIndicatorColorsParsed } from '../../../common/src/api/theming';
+import { ColorSchemeOptionType, LegacyNotificationsThemeSet, ThemeApi } from '../../../client-api-platform/src/shapes';
 export declare const getThemingApi: (identity: OpenFin.ApplicationIdentity) => ThemeApi;
 export declare const dispatchThemeToWorkspaceProvider: (themeData: {
     themePaletteSheet: string;
@@ -13,15 +13,9 @@ export declare const dispatchThemeToWorkspaceProvider: (themeData: {
 export declare const setSelectedScheme: (schemeType: ColorSchemeOptionType) => Promise<void>;
 export declare const getSelectedScheme: () => ColorSchemeOptionType | null | undefined;
 export declare const getThemePaletteSheet: () => string | undefined;
-export declare const mapLegacyThemeToCustomTheme: (legacyTheme: CustomTheme) => GenerateThemeParams;
+export { assignIfDefined, mapGeneratedPalettesToLegacyPalettes, mapLegacyBrandIcons, mapLegacyThemeToCustomTheme } from '../../../common/src/api/theme-migration';
 /**
- * Reverse of mapLegacyThemeToCustomTheme.
- * Takes the resolved token maps from a generated theme and maps them back to the
- * legacy CustomPaletteSet shape so that workspace apps still on the legacy theme
- * system can consume them.
+ * Builds a legacy NotificationsThemeSet from generated palettes and indicator colors.
+ * Used by the provider-side handler to serve old Notification Center versions (<=2.13).
  */
-export declare const mapGeneratedPalettesToLegacyPalettes: (generatedPalettes: GeneratedPalettes) => {
-    light: CustomPaletteSet;
-    dark: CustomPaletteSet;
-};
-export declare const mapLegacyBrandIcons: (legacyBrand: BaseThemeOptions["brand"]) => GenerateThemeParams[1];
+export declare const buildLegacyNotificationsTheme: (generatedPalettes: GeneratedPalettes, notificationIndicatorColors: NotificationIndicatorColorsParsed | null) => Promise<LegacyNotificationsThemeSet | null>;

package/client-api-platform/src/init/override-callback/snapshot.page-tab-groups.test.d.ts

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

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

@@ -4,5 +4,12 @@ export declare function convertPanelViewOpts(panels: PanelConfig[], updatePageRe
     identity: OpenFin.Identity;
     pageId: string;
 }): Promise<ExtendedPanelConfig[]>;
-export declare function createPanelViewsForPages(pages: AttachedPage[]): Promise<void>;
+/**
+ * Creates panel views for all pages in parallel. Returns a promise that callers
+ * may optionally await. In the initial window creation path the return value is
+ * intentionally ignored (fire-and-forget) so panel creation doesn't block
+ * `super.createWindow`. In the `attachPagesToWindow` path the promise is awaited
+ * so views exist before the browser dispatches `attachPanelViews`.
+ */
+export declare function createPanelViewsForPages(pages: AttachedPage[]): Promise<PromiseSettledResult<unknown>[]> | undefined;
 export declare function createPanelViews(panels: PanelConfig[]): Promise<(void | OpenFin.View)[]>;

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

@@ -1,9 +1,10 @@
 import { GeneratedPalettes, NotificationIndicatorColorsParsed } from '../../../common/src/api/theming';
-import { CustomThemes } from '../shapes';
+import { CustomThemes, LegacyNotificationsThemeSet } from '../shapes';
 export declare const getThemes: () => CustomThemes | null;
 export declare const getGeneratedPalettes: () => GeneratedPalettes;
 export declare const getThemePaletteSheet: () => string;
 export declare const getNotificationIndicatorColorsInternal: () => NotificationIndicatorColorsParsed;
+export declare const getLegacyNotificationsThemeInternal: () => Promise<LegacyNotificationsThemeSet | null>;
 export declare const isThemePreInitialised: () => boolean;
 /**
  * initTheming()

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

@@ -12,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,7 +155,11 @@ export declare enum PageTabContextMenuOptionType {
     Rename = "Rename",
     Save = "Save",
     SaveAs = "Save As",
-    NewPage = "New Page",// Enterprise
+    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

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/theme-migration.d.ts

@@ -0,0 +1,46 @@
+import type { BaseThemeOptions, CustomPaletteSet, CustomTheme, CustomThemes, GeneratedPalettes, GenerateThemeParams } from './theming';
+export declare const assignIfDefined: (target: Record<string, unknown>, key: string, value: unknown) => void;
+/**
+ * Maps a legacy palette-based theme to theme-engine seed + overrides.
+ *
+ * Legacy themes use `palette` (single scheme) or `palettes` (light/dark) with
+ * explicit color values. This function translates those values into the dotted
+ * token paths that `generateTheme` expects.
+ *
+ * Mapping reference: https://www.figma.com/design/bUbUpAHJl8xGEtFbpYZ5z3/Theme?node-id=0-1&p=f&m=dev
+ */
+export declare const mapLegacyThemeToCustomTheme: (legacyTheme: CustomTheme) => GenerateThemeParams;
+/**
+ * Reverse of mapLegacyThemeToCustomTheme.
+ * Takes the resolved token maps from a generated theme and maps them back to the
+ * legacy CustomPaletteSet shape so that workspace apps still on the legacy theme
+ * system can consume them.
+ */
+export declare const mapGeneratedPalettesToLegacyPalettes: (generatedPalettes: GeneratedPalettes) => {
+    light: CustomPaletteSet;
+    dark: CustomPaletteSet;
+};
+export declare const mapLegacyBrandIcons: (legacyBrand: BaseThemeOptions["brand"]) => GenerateThemeParams[1];
+/**
+ * Converts legacy CustomThemes (from old workspace platforms v23.0.22 and earlier)
+ * into GeneratedPalettes with toCSS() methods and a ready-to-inject palette sheet.
+ *
+ * This is the backward-compatibility bridge: when a new workspace app (home, dock,
+ * storefront) discovers it's running against a legacy platform — detected by
+ * `getGeneratedPalettes()` throwing because the channel action doesn't exist —
+ * it calls `getThemes()` to retrieve the old-format themes and runs them through
+ * this function to produce the same output the new pipeline expects.
+ *
+ * The conversion mirrors `initialiseStoragePalettes` in client-api-platform but
+ * omits storage controller side-effects (setPalettes, setThemePaletteSheet) since
+ * those belong to the platform init path, not the workspace app consumption path.
+ *
+ * Theme shape discrimination:
+ * - `palette`: single palette applied to both schemes (legacy single-scheme theme)
+ * - `palettes`: explicit light/dark palettes (legacy dual-scheme theme)
+ * - `seed`: already a token-based theme (should not reach this path, but handled for safety)
+ */
+export declare const convertLegacyThemesToGeneratedPalettes: (themes: CustomThemes | null | undefined) => {
+    generatedPalettes: GeneratedPalettes;
+    themePaletteSheet: string;
+};

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 = 
@@ -91,12 +92,6 @@ export declare const generateViewNameAndIdentifierNameIfNotExists: <T extends {
  */
 export declare const cloneLayoutAndConvertViewOptions: (layout: PageLayout, initViewOptions?: Partial<OpenFin.ViewOptions>) => Promise<PageLayout>;
 export declare const cloneViewComponentWithoutName: (componentState: any) => any;
-/**
- * Deep clones a layout and removes view names.
- * @param layout The Layout to be cloned
- * @returns A copy of the layout with names removed
- */
-export declare const cloneLayoutAndRemoveNames: (layout: PageLayout) => any;
 /**
  * Deep clones a layout and removes generated view names.
  * @param layout The Layout to be cloned
@@ -121,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;