@openfin/workspace 45.0.13 → 45.1.0-alpha.147d0ebd

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

@@ -1,3 +1,4 @@
+import { PlatformError } from '../../../common/src/errors';
 import { ProviderType } from '../../../common/src/api/provider';
 /**
  * Error thrown when attempting to use a provider that is not registered.
@@ -7,7 +8,7 @@ import { ProviderType } from '../../../common/src/api/provider';
  * // Error: Dock Provider. Dock Provider with id my-dock-id is not currently registered.
  * ```
  */
-export declare class ProviderNotRegisteredError extends Error {
+export declare class ProviderNotRegisteredError extends PlatformError {
     constructor(providerType: ProviderType, id?: string);
 }
 /**
@@ -19,7 +20,7 @@ export declare class ProviderNotRegisteredError extends Error {
  * // Error: Home Provider. Home Provider with id my-home-id is already registered.
  * ```
  */
-export declare class ProviderAlreadyRegisteredError extends Error {
+export declare class ProviderAlreadyRegisteredError extends PlatformError {
     constructor(providerType: ProviderType, id?: string);
 }
 /**
@@ -31,7 +32,7 @@ export declare class ProviderAlreadyRegisteredError extends Error {
  * // Error: Failed to get Storefront Provider. Storefront Provider with id unknown-id is not currently registered.
  * ```
  */
-export declare class FailedToGetProviderError extends Error {
+export declare class FailedToGetProviderError extends PlatformError {
     constructor(providerType: ProviderType, id?: string);
 }
 /**

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

@@ -3,11 +3,12 @@ export declare function getLanguage(): Locale;
 export declare const dispatchLanguageToBrowserWindows: (language: Locale) => Promise<void[]>;
 export declare const setLanguage: (locale: Locale) => Promise<void>;
 export declare function getLanguageResourcesInternal(): {
-    currentLanguage: "en-US" | "ja-JP" | "zh-CN" | "ko-KR" | "ru-RU" | "de-DE" | "zh-Hant";
+    currentLanguage: string;
     resources: import("i18next").Resource;
 };
 /**
  * initLanguage()
- * @param language - optional - ISO language code
+ * @param language - optional - ISO language code. Built-in languages are always accepted.
+ * Any language code defined in the external `translation-override.json` is also accepted.
  */
 export default function initLanguage(language?: Locale): Promise<void>;

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

@@ -1,4 +1,6 @@
 export * from './shapes';
 export * as Dock from '../../dock3/src/api';
+export * as HomeVpw from '../../home-vpw/src/api';
+export * as StorefrontVpw from '../../storefront-vpw/src/api';
 export { init } from './init';
 export { getCurrentSync, wrapSync } from './api';

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

@@ -1,8 +1,9 @@
 import type OpenFin from '@openfin/core';
+import type { BrowserCreateViewRequest } from '../../../../client-api-platform/src/shapes';
 type DefaultViewOptions = Partial<OpenFin.MutableViewOptions> & {
     downloadShelf?: OpenFin.ConstWindowOptions['downloadShelf'];
     hotkeys?: OpenFin.ViewOptions['hotkeys'];
 };
 export declare const DEFAULT_VIEW_OPTIONS: DefaultViewOptions;
-export declare function applyViewDefaults(options: Partial<OpenFin.ViewOptions>, initViewOptions?: Partial<OpenFin.ViewOptions>): Promise<any>;
+export declare function applyViewDefaults(options: Partial<BrowserCreateViewRequest>, initViewOptions?: Partial<BrowserCreateViewRequest>): Promise<any>;
 export {};

package/client-api-platform/src/init/view-tab-new-tab-shortcut-usage.d.ts

@@ -0,0 +1,4 @@
+export declare const registerViewTabNewTabShortcutUsageTracking: () => void;
+export declare const unregisterViewTabNewTabShortcutUsageTracking: () => void;
+/** @internal */
+export declare const resetViewTabNewTabShortcutUsageTrackingForTests: () => void;

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

@@ -1,5 +1,5 @@
 import type OpenFin from '@openfin/core';
-import type { IconProps, IconType, Languages } from '@openfin/ui-library';
+import type { IconProps, IconType } from '@openfin/ui-library';
 import type { ModalResponseEvent } from '../../common/src/utils/menu-window-provider';
 import type { WorkspaceIndicatorConfig } from '../../common/src/utils/indicators/workspace-indicators';
 import type { AnalyticsEvent, AnalyticsEventInternal } from '../../common/src/utils/usage-register';
@@ -14,6 +14,7 @@ import type { WorkflowIntegration } from '../../client-api/src/shapes/integratio
 import type { DockCompanionButton } from '../../dock3/src/shapes/index';
 import type { AddPagesOptions, BasePageOpts, PageOpts } from '../../enterprise-api/src/shapes';
 export * from '../../dock3/src/shapes';
+export * from '../../storefront-vpw/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';
@@ -388,6 +389,14 @@ export declare enum ViewTabMenuOptionType {
      * Prints a screenshot of the browser window.
      */
     PrintScreen = "PrintScreen",
+    /**
+     * Translate the selected view's content to the detected target language.
+     */
+    TranslatePage = "TranslatePage",
+    /**
+     * Revert translated content back to the original language.
+     */
+    RevertTranslation = "RevertTranslation",
     /**
      * Custom context menu option defined by API client.
      */
@@ -2076,9 +2085,9 @@ export interface WorkspacePlatformModule extends OpenFin.Platform {
      */
     restoreLastSavedWorkspace(options?: ApplyWorkspaceOptions): Promise<RestoreLastSavedWorkspaceResult>;
     /**
-     * Returns ISO language code of current set language
+     * Returns the ISO language code of the currently active language.
      *
-     * @returns One of the seven ISO language codes Browser supports
+     * @returns The active language code (e.g. `'en-US'`, `'es-ES'`).
      *
      * @example Example of how to get the current language on Browser
      *
@@ -2633,8 +2642,73 @@ export interface AnalyticsConfig {
      */
     sendToOpenFin: boolean;
 }
+/**
+ * The built-in language codes supported by the Workspace Platform out of the box.
+ *
+ * @deprecated No longer used for language validation. The platform now accepts any language
+ * code that has a resource bundle registered in i18next, including codes defined in an
+ * external `translation-override.json`. This export will be removed in a future major version.
+ */
 export declare const SUPPORTED_LANGUAGES: string[];
-export type Locale = Languages;
+/**
+ * An ISO language code accepted by the Workspace Platform.
+ *
+ * **Built-in languages** (supported out of the box):
+ * - `en-US` — English (default)
+ * - `de-DE` — German
+ * - `ja-JP` — Japanese
+ * - `ko-KR` — Korean
+ * - `ru-RU` — Russian
+ * - `zh-CN` — Chinese (Simplified)
+ * - `zh-Hant` — Chinese (Traditional)
+ *
+ * **Adding custom languages** via `translationOverridesUrl`:
+ *
+ * Supply a `translationOverridesUrl` in your Desktop Owner Settings (DOS) or application manifest
+ * pointing to a `translation-override.json` file. Any language code defined in that file will be
+ * accepted at runtime in addition to the built-in list above.
+ *
+ * Example `translation-override.json`:
+ * ```json
+ * {
+ *   "x.x.x": {
+ *     "es-ES": {
+ *       "global.save": "Guardar",
+ *       "contextMenu.newWindow": "Nueva ventana"
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * The `translationOverridesUrl` can be configured in two ways:
+ *
+ * _Via Desktop Owner Settings_ (`dos.json` on macOS, registry on Windows):
+ * ```json
+ * {
+ *     "desktopSettings": {
+ *         "systemApps": {
+ *             "workspace": {
+ *                 "customConfig": {
+ *                     "translationOverridesUrl": "https://example.com/translation-override.json"
+ *                 }
+ *             }
+ *         }
+ *     }
+ * }
+ * ```
+ *
+ * _Via the application manifest_ (under `platform.workspace`):
+ * ```json
+ * {
+ *   "platform": {
+ *     "workspace": {
+ *       "translationOverridesUrl": "https://example.com/translation-override.json"
+ *     }
+ *   }
+ * }
+ * ```
+ */
+export type Locale = string;
 /**
  * Configures the workspace to self-host using an asar bundle at the
  * specified path.
@@ -2722,8 +2796,12 @@ export interface WorkspacePlatformInitConfig {
      */
     theme?: CustomThemes;
     /**
-     * Set a language on Browser by providing one of the seven languages that Workspace supports
-     * Must specify one of the ISO language codes 'en-US', 'ja-JP', 'zh-CN', 'ko-KR', 'ru-RU', 'de-DE' or 'zh-Hant'
+     * Set the initial language for the Browser.
+     *
+     * The built-in ISO language codes are `'en-US'`, `'ja-JP'`, `'zh-CN'`, `'ko-KR'`,
+     * `'ru-RU'`, `'de-DE'`, and `'zh-Hant'`. Any additional language code defined in an
+     * external `translation-override.json` (configured via `translationOverridesUrl`) is
+     * also accepted.
      *
      * @example
      * ```ts
@@ -2736,7 +2814,7 @@ export interface WorkspacePlatformInitConfig {
      *   }
      * });
      * ```
-     * @default 'en-EN'
+     * @default 'en-US'
      *
      */
     language?: {
@@ -2996,9 +3074,28 @@ export interface BrowserInitConfig {
     /** Default options when creating a new page. If `iconUrl`, `unsavedIconUrl`, `panels` or `closeButton` are not defined when creating a page, setting will default to `defaultPageOptions`. */
     defaultPageOptions?: Pick<Page, 'iconUrl' | 'unsavedIconUrl' | 'closeButton' | 'panels'>;
     /**
-     * The default options when creating a new browser window. Any option not included in WorkspacePlatform.getCurrentSync().Browser.createView(options) call will default to the value provided in this field.
+     * The default options when creating a new view. Any option not included in WorkspacePlatform.getCurrentSync().Browser.createView(options) call will default to the value provided in this field.
+     *
+     * @example
+     * ```ts
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
+     *
+     * await WorkspacePlatform.init({
+     *   browser: {
+     *     defaultViewOptions: {
+     *       workspacePlatform: {
+     *         browserNavigationButtons: {
+     *           back: true,
+     *           forward: true,
+     *           reload: true
+     *         }
+     *       }
+     *     }
+     *   }
+     * });
+     * ```
      */
-    defaultViewOptions?: Partial<OpenFin.ViewOptions>;
+    defaultViewOptions?: Partial<BrowserCreateViewRequest>;
     /**
      * The platform title. UI friendly title for the platform in browser.
      */

package/common/src/api/home-search-host.d.ts

@@ -0,0 +1,8 @@
+import type { SearchProviderInfo, SearchTopic } from '../../../search-api/src/shapes';
+export type HomeSearchHostCallbacks = {
+    onRegister?: (searchProvider?: SearchProviderInfo) => void | Promise<void>;
+    onDeregister?: (searchProvider?: SearchProviderInfo) => void | Promise<void>;
+    onDisconnect?: () => void | Promise<void>;
+};
+export declare const registerHomeSearchHost: (callbacks?: HomeSearchHostCallbacks) => Promise<SearchTopic | null>;
+export declare const createVpwHomeSearchHostCallbacks: () => HomeSearchHostCallbacks;

package/common/src/api/home-vpw-search-channel.d.ts

@@ -0,0 +1,2 @@
+/** Search topic channel for Home VPW — scoped per platform. */
+export declare const getHomeVpwSearchChannelName: () => string;

package/common/src/api/home-vpw-search-host.d.ts

@@ -0,0 +1,4 @@
+import type { SearchProviderInfo, SearchTopic } from '../../../search-api/src/shapes';
+import type { HomeSearchHostCallbacks } from './home-search-host';
+export declare const registerHomeVpwSearchHost: (callbacks?: HomeSearchHostCallbacks) => Promise<SearchTopic | null>;
+export type { SearchProviderInfo };

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

@@ -1,7 +1,7 @@
 import i18next, { type Resource } from 'i18next';
 import { Locale } from '../../../client-api-platform/src/shapes';
-declare function initI18next(language?: Locale): void;
-export declare const setLanguageInI18next: (locale: Locale) => void;
+declare function initI18next(language?: Locale): Promise<void>;
+export declare const setLanguageInI18next: (locale: Locale) => Promise<void>;
 declare const t: import("i18next").TFunction<["translation", ...string[]], undefined>;
 export { initI18next, i18next, t, type Resource };
 export { useTranslation } from 'react-i18next';

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

@@ -7,6 +7,7 @@ export declare const channelName: "__of_workspace_protocol__";
 export declare const getChannelClient: () => Promise<WorkspaceComponentChannelClient>;
 export declare const getClientAPIChannelClient: () => Promise<WorkspaceAPIClientChannelClient>;
 export declare const getSearchClientAPIChannelClient: () => Promise<withDisconnectListener<SearchAPIClientChannelClient>>;
+export declare const getHomeVpwSearchClientAPIChannelClient: () => Promise<withDisconnectListener<SearchAPIClientChannelClient>>;
 /**
  * Launches the Workspace Provider.
  * If the Workspace Provider is already running, does nothing.

package/common/src/api/workspace-events.d.ts

@@ -0,0 +1,53 @@
+import { NavigatePayload } from '../../../common/src/utils/navigate';
+import { ProviderConnectionPayload, ProviderDisconnectionPayload, ProviderUpdatePayload } from './provider';
+/**
+ * All Workspace related events that can be emitted or listened to
+ * by the Workspace Provider or any of the workspace components
+ */
+type EventTypeTypes = {
+    /**
+     * Emitted when a search is invoked.
+     */
+    'search-invoked': [string];
+    /**
+     * Emitted when a new provider is connected.
+     *
+     * For example, when a Dock Provider is successfully registered by the platform provider
+     */
+    'provider-connected': [ProviderConnectionPayload];
+    /**
+     * Emitted when a provider is disconnected.
+     *
+     * For example, when a Dock Provider is deregistered by the platform provider
+     */
+    'provider-disconnected': [ProviderDisconnectionPayload];
+    /**
+     * Emitted when a provider is updated.
+     *
+     * For example, when a Dock Provider is updated by the platform provider
+     */
+    'provider-updated': [ProviderUpdatePayload];
+    /**
+     * Emmitted when notifications is created or destroyed.
+     */
+    'update-notification-running-status': [];
+    /**
+     * Emitted when the list of search providers has been updated.
+     */
+    'search-provider-list-updated': [];
+    /**
+     * Emitted when the list of Storefront VPW providers has been updated.
+     */
+    'storefront-provider-list-updated': [];
+    /**
+     * Emmitted when a component is created or destroyed.
+     */
+    'component-lifecycle-update': [];
+    /**
+     * Emitted when component should be navigated to.
+     * Contains the target provider ID and the component name.
+     */
+    'component-navigation': [NavigatePayload];
+};
+export declare const addListener: <EventKey extends keyof EventTypeTypes>(event: EventKey, listener: (...payload: EventTypeTypes[EventKey]) => void) => void, removeListener: <EventKey extends keyof EventTypeTypes>(event: EventKey, listener: (...payload: EventTypeTypes[EventKey]) => void) => void, addListenerWithUUID: (uuid: string) => <EventKey extends keyof EventTypeTypes>(event: EventKey, listener: (...payload: EventTypeTypes[EventKey]) => void) => void, emit: <EventKey extends keyof EventTypeTypes>(event: EventKey, ...payload: EventTypeTypes[EventKey]) => Promise<void>;
+export {};

package/common/src/errors/AppError.d.ts

@@ -0,0 +1,37 @@
+/**
+ * AppError — base class for all application errors.
+ *
+ * Use a subclass (NetworkError, PlatformError, etc.) — never instantiate AppError directly
+ * in production code. The class identity (`error.name`) is the category; `context` carries
+ * the specifics; `cause` chains the underlying error.
+ *
+ * `instanceof` is the supported way to branch on error type. `toJSON()` is what the
+ * existing logger's safeStringify uses to produce structured output, so logging an
+ * AppError preserves the full chain automatically.
+ */
+export interface ErrorContext {
+    [key: string]: unknown;
+}
+export interface SerializedError {
+    name: string;
+    message: string;
+    context: ErrorContext;
+    stack?: string;
+    cause?: SerializedError;
+    timestamp: string;
+}
+export interface AppErrorOptions {
+    cause?: unknown;
+    context?: ErrorContext;
+}
+export declare class AppError extends Error {
+    readonly context: ErrorContext;
+    readonly timestamp: Date;
+    constructor(message: string, options?: AppErrorOptions);
+    serialize(): SerializedError;
+    /**
+     * Called automatically by JSON.stringify so `safeStringify({ error })` in the logger
+     * produces the full structured form without any logger changes.
+     */
+    toJSON(): SerializedError;
+}

package/common/src/errors/errors.d.ts

@@ -0,0 +1,23 @@
+import { AppError, AppErrorOptions } from './AppError';
+/** Put `{ url, status, method, timeoutMs }` in context as relevant. */
+export declare class NetworkError extends AppError {
+}
+/** Put `{ field, received, expected }` in context. */
+export declare class ValidationError extends AppError {
+}
+/** Put `{ status, scope, userId }` in context as available. */
+export declare class AuthError extends AppError {
+}
+/** OpenFin / runtime / channel / provider failures. Put `{ providerId, channelName, identity }` in context. */
+export declare class PlatformError extends AppError {
+}
+/** Read/write failures against persistent storage. Put `{ key, operation }` in context. */
+export declare class StorageError extends AppError {
+}
+/** Bad or missing configuration discovered at runtime. Put `{ configKey, env }` in context. */
+export declare class ConfigError extends AppError {
+}
+/** Catch-all. Prefer creating via `toAppError(unknown)` rather than directly. */
+export declare class UnknownError extends AppError {
+}
+export type { AppErrorOptions };

package/common/src/errors/index.d.ts

@@ -0,0 +1,6 @@
+export { AppError } from './AppError';
+export type { AppErrorOptions, ErrorContext, SerializedError } from './AppError';
+export { NetworkError, ValidationError, AuthError, PlatformError, StorageError, ConfigError, UnknownError } from './errors';
+export { toAppError } from './toAppError';
+export { ok, err, isOk, isErr, unwrap, mapResult } from './result';
+export type { Ok, Err, Result } from './result';

package/common/src/errors/result.d.ts

@@ -0,0 +1,23 @@
+import { AppError } from './AppError';
+/**
+ * Result<T, E> — opt-in alternative to throwing for operations whose callers
+ * genuinely need to branch on success vs failure (e.g., a save that has a clear
+ * fallback path). Don't blanket-replace throws — invariant violations and
+ * programmer errors should still throw.
+ */
+export type Ok<T> = {
+    readonly ok: true;
+    readonly value: T;
+};
+export type Err<E extends AppError = AppError> = {
+    readonly ok: false;
+    readonly error: E;
+};
+export type Result<T, E extends AppError = AppError> = Ok<T> | Err<E>;
+export declare const ok: <T>(value: T) => Ok<T>;
+export declare const err: <E extends AppError>(error: E) => Err<E>;
+export declare const isOk: <T, E extends AppError>(r: Result<T, E>) => r is Ok<T>;
+export declare const isErr: <T, E extends AppError>(r: Result<T, E>) => r is Err<E>;
+/** Throw on Err, return value on Ok. Use sparingly — defeats the type-level branch. */
+export declare const unwrap: <T, E extends AppError>(r: Result<T, E>) => T;
+export declare const mapResult: <T, U, E extends AppError>(r: Result<T, E>, fn: (value: T) => U) => Result<U, E>;

package/common/src/errors/toAppError.d.ts

@@ -0,0 +1,14 @@
+import { AppError } from './AppError';
+/**
+ * Narrow `unknown` (the type of a catch variable when `useUnknownInCatchVariables` is on)
+ * to an AppError. Pass through existing AppErrors unchanged; wrap raw Errors and other
+ * values in UnknownError, preserving the original via `cause`.
+ *
+ * @example
+ * try {
+ *   await doThing();
+ * } catch (e) {
+ *   throw toAppError(e);
+ * }
+ */
+export declare const toAppError: (caught: unknown, fallbackMessage?: string) => AppError;

package/common/src/utils/color-linking.d.ts

@@ -1,4 +1,41 @@
 import type OpenFin from '@openfin/core';
 import { ViewTabContextMenuTemplate } from '../../../client-api-platform/src/shapes';
 export declare const getChannelsMenuOptions: (channelsForViews: string[], colorGroups: OpenFin.ContextGroupInfo[]) => Promise<ViewTabContextMenuTemplate[]>;
-export declare const ENTERPRISE_COLOR_CHANNELS: Map<string, OpenFin.ContextGroupInfo['displayMetadata']>;
+export declare const ENTERPRISE_COLOR_CHANNELS: {
+    readonly blue: {
+        readonly name: "Blue";
+        readonly color: "#0091EB";
+    };
+    readonly indigo: {
+        readonly name: "Indigo";
+        readonly color: "#6450FF";
+    };
+    readonly pink: {
+        readonly name: "Pink";
+        readonly color: "#E878CF";
+    };
+    readonly teal: {
+        readonly name: "Teal";
+        readonly color: "#24D1D1";
+    };
+    readonly green: {
+        readonly name: "Green";
+        readonly color: "#00AF78";
+    };
+    readonly orange: {
+        readonly name: "Orange";
+        readonly color: "#FF7D37";
+    };
+    readonly red: {
+        readonly name: "Red";
+        readonly color: "#F94144";
+    };
+    readonly yellow: {
+        readonly name: "Yellow";
+        readonly color: "#F9C74F";
+    };
+    readonly gray: {
+        readonly name: "Gray";
+        readonly color: "#828788";
+    };
+};

package/common/src/utils/context-menu.d.ts

@@ -27,4 +27,5 @@ export declare const getBoundsBasedOnAnchorBehavior: (bounds: OpenFin.Bounds, an
     height: number;
     width: number;
 };
+export declare const getTranslateItems: (viewIdentities: OpenFin.Identity[]) => Promise<ViewTabContextMenuTemplate[]>;
 export declare const getPrintOption: () => Promise<ViewTabContextMenuTemplate | PageTabContextMenuItemTemplate>;

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

@@ -1,7 +1,7 @@
 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';
+import type { PagePinnedState } from '../../../common/src/api/pages/shapes';
+import { AttachedPage, BrowserCreateViewRequest, PageLayout } from '../../../client-api-platform/src/shapes';
 export type LayoutDOMEventType = 
 /**
  * Fired when a tab is created in a container. (Emmitted by ??)
@@ -90,7 +90,7 @@ export declare const generateViewNameAndIdentifierNameIfNotExists: <T extends {
  * @param layout The Layout to be cloned
  * @returns A Promise resolving to a copy of the layout with view options converted
  */
-export declare const cloneLayoutAndConvertViewOptions: (layout: PageLayout, initViewOptions?: Partial<OpenFin.ViewOptions>) => Promise<PageLayout>;
+export declare const cloneLayoutAndConvertViewOptions: (layout: PageLayout, initViewOptions?: Partial<BrowserCreateViewRequest>) => Promise<PageLayout>;
 export declare const cloneViewComponentWithoutName: (componentState: any) => any;
 /**
  * Deep clones a layout and removes generated view names.
@@ -155,6 +155,12 @@ export declare const findViewInLayout: (node: any, viewId: OpenFin.Identity) =>
 export declare const countViews: (node: OpenFin.LayoutContent) => number;
 export declare const getLayoutConfig: (layoutContainerKey: string) => Promise<any>;
 export declare const findPageForView: (viewName: string, browserWindowIdentity?: WindowIdentity) => Promise<AttachedPage | undefined>;
+/**
+ * Waits for a specific view to receive focus on the current window, resolving
+ * either when the matching `view-focused` event fires or after a timeout (default 150ms).
+ * Useful for ensuring focus is stable before opening popups that would auto-close on focus shift.
+ */
+export declare const waitForViewFocus: (viewName: string, timeoutMs?: number) => Promise<void>;
 /**
  * Only show the view tab icon when not on the landing page
  */

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

@@ -0,0 +1,23 @@
+import type OpenFin from '@openfin/core';
+import { ComponentName } from '../../../common/src/utils/usage-register';
+/**
+ * Constants for navigation source identifiers
+ */
+export declare const NavigationSource: {
+    readonly DOCK_SEARCH_BUTTON: "dock-search-button";
+    readonly DOCK_STORE_BUTTON: "dock-store-button";
+    readonly HOME_ESC: "home-esc";
+    readonly HOME_COMMAND: "home-command";
+};
+export type NavigationSourceType = (typeof NavigationSource)[keyof typeof NavigationSource];
+export interface NavigatePayload {
+    componentName: ComponentName;
+    platformIdentity: OpenFin.Identity;
+    providerId?: string;
+    source?: NavigationSourceType | null;
+}
+export interface NavigateToOptions {
+    providerId?: string;
+    source?: NavigationSourceType | null;
+}
+export declare const navigateTo: (componentName: ComponentName, platformIdentity: OpenFin.Identity, options?: NavigateToOptions) => Promise<void>;

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

@@ -16,6 +16,7 @@ declare enum WorkspaceRoute {
 }
 declare enum BrowserRoute {
     Browser = "/browser/",
+    BrowserHome = "/home/",
     BrowserPopupMenu = "/popup-menu/",
     BrowserPopupMenuSaveModal = "/popup-menu/save-modal/",
     BrowserPopupMenuLayouts = "/popup-menu/layouts/layouts/",
@@ -40,6 +41,7 @@ declare enum BrowserRoute {
 }
 declare const PageRoute: {
     Browser: BrowserRoute.Browser;
+    BrowserHome: BrowserRoute.BrowserHome;
     BrowserPopupMenu: BrowserRoute.BrowserPopupMenu;
     BrowserPopupMenuSaveModal: BrowserRoute.BrowserPopupMenuSaveModal;
     BrowserPopupMenuLayouts: BrowserRoute.BrowserPopupMenuLayouts;

package/common/src/utils/usage-register.d.ts

@@ -11,22 +11,36 @@ export declare enum ComponentName {
     Dock = "Dock",
     EnterpriseDock = "EnterpriseDock",
     Home = "Home",
+    HomeVpw = "HomeVpw",
     Notification = "Notification",
     Storefront = "Storefront",
     Platform = "Platform",
     Theming = "Theming",
     Microflow = "Microflow",
-    SupertabHideShowTabs = "PRODM-318: Supertab Hide/Show Tab Headers"
+    SuppressWorkspaceSwitched = "SuppressWorkspaceSwitched",
+    SuppressWorkspaceSaved = "SuppressWorkspaceSaved",
+    AllowDuplicatePageTitles = "AllowDuplicatePageTitles",
+    PagePinning = "PagePinning",
+    ViewTabNewTabShortcut = "ViewTabNewTabShortcut",
+    SupertabHideShowTabs = "PRODM-318: Supertab Hide/Show Tab Headers",
+    StorefrontVpw = "PRODM-171: VPW Storefront"
 }
 export declare const registerBrowserUsage: (status: RegisterUsageStatus) => void;
 export declare const registerHomeUsage: (status: RegisterUsageStatus) => void;
 export declare const registerStorefrontUsage: (status: RegisterUsageStatus) => void;
+export declare const registerHomeVpwUsage: (status: RegisterUsageStatus) => void;
 export declare const registerDockUsage: (status: RegisterUsageStatus) => void;
 export declare const registerNotificationUsage: (status: RegisterUsageStatus) => void;
 export declare const registerPlatformUsage: (status: RegisterUsageStatus) => void;
 export declare const registerThemingUsage: (status: RegisterUsageStatus) => void;
 export declare const registerMicroflowUsage: (microflowName: string, status: RegisterUsageStatus) => void;
+export declare const registerSuppressWorkspaceSwitchedUsage: (status: RegisterUsageStatus) => void;
+export declare const registerSuppressWorkspaceSavedUsage: (status: RegisterUsageStatus) => void;
+export declare const registerAllowDuplicatePageTitlesUsage: (status: RegisterUsageStatus) => void;
+export declare const registerPagePinningUsage: (status: RegisterUsageStatus) => void;
+export declare const registerViewTabNewTabShortcutUsage: (status: RegisterUsageStatus) => void;
 export declare const registerSupertabHideShowTabsUsage: () => void;
+export declare const registerStorefrontVpwUsage: (status: RegisterUsageStatus) => void;
 export type AnalyticsSource = 'Browser' | 'Dock' | 'Home' | 'Notification' | 'Store' | 'Platform' | 'Theming' | 'Interop';
 /**
  * Event for analytics

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

@@ -26,7 +26,9 @@ export declare enum WindowName {
     ApplyAndPublishModal = "here-apply-and-publish-modal",
     PublishOnCloseModal = "here-publish-on-close-modal",
     DesktopSignalsModal = "here-desktop-signals-modal",
-    IntentsResolverModal = "here-intents-resolver-modal"
+    IntentsResolverModal = "here-intents-resolver-modal",
+    /** Browser-zone Home VPW window (platform child window). */
+    HomeVpw = "home-vpw"
 }
 export interface WindowIdentity {
     uuid: ApplicationUUID | string;