@openfin/workspace-platform 45.0.14 → 45.1.1

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/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/view-tab-new-tab-shortcut-usage.d.ts

@@ -0,0 +1,2 @@
+export declare const registerViewTabNewTabShortcutUsageTracking: () => void;
+export declare const unregisterViewTabNewTabShortcutUsageTracking: () => void;

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

@@ -342,6 +342,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.
      */

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/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/usage-register.d.ts

@@ -16,6 +16,11 @@ export declare enum ComponentName {
     Platform = "Platform",
     Theming = "Theming",
     Microflow = "Microflow",
+    SuppressWorkspaceSwitched = "SuppressWorkspaceSwitched",
+    SuppressWorkspaceSaved = "SuppressWorkspaceSaved",
+    AllowDuplicatePageTitles = "AllowDuplicatePageTitles",
+    PagePinning = "PagePinning",
+    ViewTabNewTabShortcut = "ViewTabNewTabShortcut",
     SupertabHideShowTabs = "PRODM-318: Supertab Hide/Show Tab Headers"
 }
 export declare const registerBrowserUsage: (status: RegisterUsageStatus) => void;
@@ -26,6 +31,11 @@ export declare const registerNotificationUsage: (status: RegisterUsageStatus) =>
 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 type AnalyticsSource = 'Browser' | 'Dock' | 'Home' | 'Notification' | 'Store' | 'Platform' | 'Theming' | 'Interop';
 /**

package/externals.report.json

@@ -21,14 +21,6 @@
             "issuer": "common/src/utils/color-linking.ts"
         }
     ],
-    "lodash.clonedeep": [
-        {
-            "type": "explicit",
-            "version": "4.5.0",
-            "packageName": "common/package.json",
-            "issuer": "common/src/utils/layout.ts"
-        }
-    ],
     "react-i18next": [
         {
             "type": "explicit",
@@ -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"
+        }
     ]
 }