@openfin/workspace-platform 24.1.0-alpha.ad7de216 → 24.1.1

package/client-api/src/internal/providers.d.ts

@@ -1,10 +1,36 @@
 import { ProviderType } from '../../../common/src/api/provider';
+/**
+ * Error thrown when attempting to use a provider that is not registered.
+ * @example
+ * ```typescript
+ * throw new ProviderNotRegisteredError('dock', 'my-dock-id');
+ * // Error: Dock Provider. Dock Provider with id my-dock-id is not currently registered.
+ * ```
+ */
 export declare class ProviderNotRegisteredError extends Error {
     constructor(providerType: ProviderType, id?: string);
 }
+/**
+ * Error thrown when attempting to register a provider that is already registered.
+ * Call `deregister` before registering again.
+ * @example
+ * ```typescript
+ * throw new ProviderAlreadyRegisteredError('home', 'my-home-id');
+ * // Error: Home Provider. Home Provider with id my-home-id is already registered.
+ * ```
+ */
 export declare class ProviderAlreadyRegisteredError extends Error {
     constructor(providerType: ProviderType, id?: string);
 }
+/**
+ * Error thrown when failing to retrieve a provider by ID.
+ * Typically thrown by `getProviderOrFail` when the requested provider does not exist.
+ * @example
+ * ```typescript
+ * throw new FailedToGetProviderError('storefront', 'unknown-id');
+ * // Error: Failed to get Storefront Provider. Storefront Provider with id unknown-id is not currently registered.
+ * ```
+ */
 export declare class FailedToGetProviderError extends Error {
     constructor(providerType: ProviderType, id?: string);
 }

package/client-api-platform/src/api/controllers/__tests__/theme-storage-controller-store.test.d.ts

@@ -0,0 +1,2 @@
+import '@common/test/fin-mocks';
+import '@common/test/logger-mock';

package/client-api-platform/src/api/controllers/theme-storage-controller.d.ts

@@ -31,7 +31,8 @@ export declare class ThemeStorageController {
     private generatedPalettes?;
     private workspaceStorage?;
     private recreateFactory?;
-    constructor(providerStorage: Pick<Storage, 'getItem' | 'setItem'>);
+    private isLegacySinglePaletteTheme;
+    constructor(providerStorage: Pick<Storage, 'getItem' | 'setItem' | 'removeItem'>);
     /**
      * Set the current Storage Proxy to enable Workspace Storage properties to be populated.
      */
@@ -63,6 +64,8 @@ export declare class ThemeStorageController {
     /**
      * Synchronize the current palette and scheme with workspace's storage instance if
      * storage based theming is enabled. Only syncs when user has explicitly selected a scheme.
+     *
+     * Wrapped in try/catch so it does not throw
      */
     trySynchronizeWorkspaceStorage: () => Promise<void>;
     /**
@@ -84,6 +87,11 @@ export declare class ThemeStorageController {
      * @param scheme 'light', 'dark' or 'system'.
      */
     setScheme(scheme: ColorSchemeOptionType): void;
+    /**
+     * Clears an explicit user scheme choice (e.g. from Appearance) so resolution falls back to theme default.
+     */
+    clearUserSelectedSchemePreference(): void;
+    setLegacySinglePaletteTheme(value: boolean): void;
     /**
      * Set the theme's default scheme from palette configuration
      * @param scheme The default scheme specified in the palette

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

@@ -26,10 +26,15 @@ export declare const getActivePageIdForWindow: (identity: OpenFin.Identity) => P
  *
  * If the name is not unique, it will append a number to the end of the name.
  *
+ * When `BrowserInitConfig.allowDuplicatePageTitles` is `true`, this function
+ * short-circuits and returns the supplied name (or the default title) as-is,
+ * without appending a numeric suffix.
+ *
  * @param initialName The initial name to test
- * @returns string: a unique page name
+ * @param allowDuplicatePageTitles Whether duplicate page titles are permitted
+ * @returns string: a unique page name (or the input unchanged when duplicates are allowed)
  */
-export declare function getUniquePageTitle(initialName?: string): Promise<string>;
+export declare function getUniquePageTitle(initialName?: string, allowDuplicatePageTitles?: boolean): Promise<string>;
 export declare function handleSaveModalOnPageClose({ page }: HandleSaveModalOnPageClosePayload): Promise<SaveModalOnPageCloseResult>;
 /**
  * Default implementation of shouldPageClose. If enableBeforeUnload isn't set to true, always returns True (proceed with close).

package/client-api-platform/src/api/theming.set-scheme.test.d.ts

@@ -0,0 +1 @@
+import '@common/test/fin-mocks';

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

@@ -3,7 +3,7 @@ export type StorageProxy = {
     setItem: (data: string, value: string) => Promise<void>;
     destroy: () => Promise<void>;
 };
-export declare const createStorageProxy: (url: string) => Promise<StorageProxy>;
+export declare const createStorageProxy: (url: string, isEnterprise: boolean) => Promise<StorageProxy>;
 /**
  * Ensure the workspace storage proxy window exists. Recreates it if it was previously destroyed
  * (e.g. when the last browser window closed with preventQuitOnLastWindowClosed true and a new

package/client-api-platform/src/api/utils.test.d.ts

@@ -0,0 +1 @@
+import '@common/test/fin-mocks';

package/client-api-platform/src/init/override-callback/browser-defaults.d.ts

@@ -4,4 +4,4 @@ import { BrowserInitConfig } from '../../../../client-api-platform/src/shapes';
 /**
  * Applies default options to the creation of browser windows.
  */
-export declare function applyBrowserDefaults(options: OpenFin.PlatformWindowCreationOptions, initOptions: Pick<BrowserInitConfig, 'defaultWindowOptions' | 'defaultPageOptions' | 'defaultViewOptions' | 'browserIconSize'> | undefined, themeData?: PreloadedThemeData): Promise<OpenFin.PlatformWindowCreationOptions>;
+export declare function applyBrowserDefaults(options: OpenFin.PlatformWindowCreationOptions, initOptions: Pick<BrowserInitConfig, 'defaultWindowOptions' | 'defaultPageOptions' | 'defaultViewOptions' | 'browserIconSize' | 'allowDuplicatePageTitles'> | undefined, themeData?: PreloadedThemeData): Promise<OpenFin.PlatformWindowCreationOptions>;

package/client-api-platform/src/init/override-callback/page-defaults.d.ts

@@ -1,4 +1,4 @@
 import OpenFin from '@openfin/core';
 import type { AttachedPage, AttachedPageInternal } from '../../../../common/src/api/pages/shapes';
 import { BrowserInitConfig } from '../..';
-export declare const applyPageDefaults: (pages: AttachedPage[], initOptions?: Pick<BrowserInitConfig, "defaultPageOptions" | "defaultViewOptions" | "defaultWindowOptions">, overrideOptions?: OpenFin.PlatformWindowCreationOptions) => Promise<AttachedPageInternal[]>;
+export declare const applyPageDefaults: (pages: AttachedPage[], initOptions?: Pick<BrowserInitConfig, "defaultPageOptions" | "defaultViewOptions" | "defaultWindowOptions" | "allowDuplicatePageTitles">, overrideOptions?: OpenFin.PlatformWindowCreationOptions) => Promise<AttachedPageInternal[]>;

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

@@ -2456,6 +2456,15 @@ export interface BrowserInitConfig {
      * https://developer.openfin.co/docs/javascript/stable/classes/OpenFin.InteropBroker.html
      */
     interopOverride?: OpenFin.OverrideCallback<OpenFin.InteropBroker, OpenFin.InteropBroker>;
+    /**
+     * When true, allows multiple pages to share the same title across browser
+     * windows. No numeric suffixes are appended and attach/add operations
+     * will not reject on title collision. `pageId` remains the unique
+     * identifier for all page operations.
+     *
+     * Defaults to `false` (current unique-title behavior preserved).
+     */
+    allowDuplicatePageTitles?: boolean;
 }
 interface WorkspaceMetadata {
     APIVersion: string;

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

@@ -61,11 +61,6 @@ export declare const updatePageForWindow: (payload: ExtendedUpdatePageForWindowP
  * @param identity the identity of the window to save the pages of in window options.
  */
 export declare const updatePagesWindowOptions: (identity: OpenFin.Identity) => Promise<void>;
-/**
- * Check if the window identity is currently detaching pages.
- * @param identity the OF window identity to check.
- */
-export declare const isDetachingPages: (identity: OpenFin.Identity) => Promise<boolean>;
 /**
  * Check if the window identity is in the middle of changing active pages.
  * @param identity the OF window identity to check.

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

@@ -34,6 +34,8 @@ export interface Page {
     contextGroup?: string;
     /** 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. */
+    isPublished?: boolean;
 }
 type AttachedPageMetadata = {
     /** The window the page is currently attached to. */

package/common/src/api/protocol/browser.d.ts

@@ -52,7 +52,6 @@ export declare enum PageChannelAction {
     ReorderPagesForWindow = "reorder-pages-for-window",
     UpdatePageForWindow = "update-page-for-window",
     UpdatePagesWindowOptions = "update-pages-window-options",
-    IsDetachingPages = "is-detaching-pages",
     IsActivePageChanging = "is-active-page-changing"
 }
 export declare enum CompanionDockChannelAction {
@@ -77,7 +76,6 @@ export declare const BrowserChannelAction: {
     ReorderPagesForWindow: PageChannelAction.ReorderPagesForWindow;
     UpdatePageForWindow: PageChannelAction.UpdatePageForWindow;
     UpdatePagesWindowOptions: PageChannelAction.UpdatePagesWindowOptions;
-    IsDetachingPages: PageChannelAction.IsDetachingPages;
     IsActivePageChanging: PageChannelAction.IsActivePageChanging;
     CloseBrowserWindow: GeneralBrowserChannelActions.CloseBrowserWindow;
     QuitPlatform: GeneralBrowserChannelActions.QuitPlatform;

package/common/src/test/logger-mock.d.ts

@@ -0,0 +1,5 @@
+export declare const mockLogger: {
+    debug: jest.Mock<any, any, any>;
+    warn: jest.Mock<any, any, any>;
+    error: jest.Mock<any, any, any>;
+};

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

@@ -24,6 +24,7 @@ export declare enum WindowName {
     ZoomControlsDialog = "here-zoom-controls-dialog",
     UpdateVersionModal = "here-update-version-modal",
     ApplyAndPublishModal = "here-apply-and-publish-modal",
+    PublishOnCloseModal = "here-publish-on-close-modal",
     DesktopSignalsModal = "here-desktop-signals-modal",
     IntentsResolverModal = "here-intents-resolver-modal"
 }

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

@@ -35,6 +35,9 @@ export declare const showUpdateVersionModal: ({ identity, title, description }:
     description: string;
 }) => Promise<ModalResponseEvent["data"]>;
 export declare const showApplyAndPublishModal: (identity: OpenFin.Identity) => Promise<boolean>;
+export declare const showPublishOnCloseModal: (windowIdentity: OpenFin.Identity) => Promise<{
+    data: ModalResponseEvent["data"];
+}>;
 /**
  * Shows the intents resolver modal and returns the user's selection
  * @param request - The request containing modal configuration