@openfin/workspace-platform 45.2.0 → 45.2.2

package/common/src/utils/view-tab-appearance.d.ts

@@ -0,0 +1,59 @@
+import type OpenFin from '@openfin/core';
+import type { ViewTabAppearanceOptions, ViewTabColorRole } from '../../../common/src/api/shapes/view-tab';
+export declare const VIEW_TAB_STATES: readonly ["default", "hover", "active", "focus"];
+export type ViewTabState = (typeof VIEW_TAB_STATES)[number];
+/** A color that was discarded during sanitization, for the caller to log. */
+export interface RejectedViewTabColor {
+    role: ViewTabColorRole;
+    /** Absent when the whole role was malformed rather than one of its states. */
+    state?: ViewTabState;
+    value: unknown;
+}
+/**
+ * Drops every state whose value is not a supported CSS color, returning what survived alongside what was
+ * discarded. Tab color is decoration, so a malformed value degrades that state to its theme default instead
+ * of failing the operation that carried it.
+ *
+ * Only the two color roles are validated. Every other `viewTab` option — `controls`, and whatever follows it
+ * — is carried through untouched, so a bad color cannot take an unrelated tab option down with it. Appearance
+ * is omitted only when nothing at all is left, which keeps a wholly-invalid object out of persistence.
+ */
+export declare const sanitizeViewTabAppearance: (viewTab: unknown) => {
+    appearance?: ViewTabAppearanceOptions;
+    rejected: RejectedViewTabColor[];
+};
+/** Formats a rejected color for a log line, e.g. `viewTab.fontColor.default "##EDE8D0"`. */
+export declare const describeRejectedViewTabColor: ({ role, state, value }: RejectedViewTabColor) => string;
+type ViewOptionsWithWorkspacePlatform = {
+    workspacePlatform?: {
+        viewTab?: ViewTabAppearanceOptions;
+    };
+};
+/**
+ * True when this `view-options-changed` diff touched `workspacePlatform.viewTab`, so that unrelated view
+ * option changes do not repaint tabs.
+ *
+ * `oldVal` is checked as well as `newVal` because clearing the appearance drops `viewTab` from `newVal`
+ * entirely — that case only shows up on the old side, and it still needs a repaint to restore the theme
+ * defaults.
+ */
+export declare const hasViewTabAppearanceDiff: (diff: unknown) => boolean;
+export declare const getViewTabAppearanceFromViewOptions: (options: ViewOptionsWithWorkspacePlatform) => ViewTabAppearanceOptions | undefined;
+/**
+ * Reads view tab appearance from the view. Core persists `workspacePlatform` on view options across create,
+ * `updateOptions`, snapshot, and `getOptions`, so `getOptions` is the single source of truth.
+ */
+export declare const getViewTabAppearanceFromView: (view: OpenFin.View) => Promise<ViewTabAppearanceOptions | undefined>;
+/**
+ * Writes the per-state custom properties for a single tab element. Values are set inline so that sibling tabs
+ * in the same tab strip are unaffected.
+ */
+export declare const applyViewTabAppearance: (tab: HTMLElement, appearance?: ViewTabAppearanceOptions) => void;
+export declare const applyViewTabAppearanceFromViewOptions: (tab: HTMLElement, view: OpenFin.View) => Promise<void>;
+/**
+ * A single listener shared by every view in the window. View `options-changed` propagates to the parent
+ * window as `view-options-changed`, so one subscription covers all layouts — and nothing leaks when a view is
+ * reparented, which moves it between windows without destroying it.
+ */
+export declare const registerWindowViewTabAppearanceListener: (win: OpenFin.Window, getTab: (viewIdentity: OpenFin.Identity) => HTMLElement | null | undefined) => (() => void);
+export {};

package/externals.report.json

@@ -45,14 +45,6 @@
             "issuer": "common/src/utils/layout.ts"
         }
     ],
-    "title-case": [
-        {
-            "type": "explicit",
-            "version": "3.0.3",
-            "packageName": "common/package.json",
-            "issuer": "common/src/utils/color-linking.ts"
-        }
-    ],
     "dexie": [
         {
             "type": "explicit",
@@ -60,6 +52,12 @@
             "packageName": "common/package.json",
             "issuer": "common/src/api/pages/idb.ts"
         },
+        {
+            "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",
@@ -69,14 +67,16 @@
         {
             "type": "explicit",
             "version": "^4.0.11",
-            "packageName": "client-api-platform/package.json",
-            "issuer": "client-api-platform/src/api/dock/idb.ts"
-        },
+            "packageName": "common/package.json",
+            "issuer": "common/src/utils/create-and-migrate-ibd-store.ts"
+        }
+    ],
+    "title-case": [
         {
             "type": "explicit",
-            "version": "^4.0.11",
+            "version": "3.0.3",
             "packageName": "common/package.json",
-            "issuer": "common/src/utils/create-and-migrate-ibd-store.ts"
+            "issuer": "common/src/utils/color-channels.ts"
         }
     ]
 }