@openfin/workspace-platform 23.0.0 → 23.0.2

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

@@ -1,5 +1,5 @@
 /**
- * WARNING: Do not export from './notifications' here. Not unless we move 'openfin-notifications' here.
+ * WARNING: Do not export from './notifications' here. Not unless we move '@here-io/notifications' here.
  */
 export * from './common';
 export * from './home';

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

@@ -1,5 +1,5 @@
 import { GeneratedPalettes } from '../../../../common/src/api/theming';
 import { ThemeStorageController } from '../../../../client-api-platform/src/api/controllers/theme-storage-controller';
 import { CustomThemes } from '../../../../client-api-platform/src/shapes';
-export declare const initialiseStoragePalettes: (customThemes: CustomThemes | undefined, isWindows: boolean) => CustomThemes | GeneratedPalettes;
+export declare const initialiseStoragePalettes: (customThemes: CustomThemes | undefined, isWindows: boolean) => GeneratedPalettes;
 export declare const getThemeStorageController: () => ThemeStorageController;

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

@@ -62,7 +62,7 @@ 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.
      */
-    trySynchronizeWorkspaceStorage: () => void;
+    trySynchronizeWorkspaceStorage: () => Promise<void>;
     /**
      * Set the current Palette to be used by workspace. This palette will be converted into
      * css vars and combined into a single stylesheet. This stylesheet is exposed in localstorage

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

@@ -1,4 +1,4 @@
-import { ContentMenuEntry } from '@openfin/ui-library';
+import type { ContentMenuEntry } from '@openfin/ui-library';
 import { DockCompanionButton, DockEntry, LaunchDockEntryPayload, Collection } from '../../../client-api-platform/src/shapes';
 export declare const DockCompanionUpdatesPrefix = "dock-companion-updates";
 export declare const refreshDockBookmarksPanel: () => Promise<void>;

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

@@ -1,2 +1,2 @@
 import { OpenFin } from '@openfin/core';
-export declare const createNonLayoutViewComponents: (overrideOptions: OpenFin.PlatformWindowCreationOptions) => Promise<void>;
+export declare const createNonLayoutViewComponents: (isEnterprise: boolean, overrideOptions: OpenFin.PlatformWindowCreationOptions) => Promise<void[]>;

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

@@ -1,6 +1,6 @@
 import { GeneratedPalettes } from '../../../common/src/api/theming';
 import { CustomThemes } from '../shapes';
-export declare const getThemes: () => CustomThemes | GeneratedPalettes;
+export declare const getThemes: () => GeneratedPalettes;
 /**
  * initTheming()
  * @param customThemes array of theme objects

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

@@ -1,11 +1,11 @@
 import type OpenFin from '@openfin/core';
-import { IconProps, IconType, Languages } from '@openfin/ui-library';
+import type { IconProps, IconType, Languages } from '@openfin/ui-library';
 import type { AnalyticsEvent } from '../../common/src/utils/usage-register';
-import { CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/action';
-import { AddDefaultPagePayload, AttachedPage, BookmarkNode, CopyPagePayload, HandlePagesAndWindowClosePayload, HandlePagesAndWindowCloseResult, HandleSaveModalOnPageClosePayload, Page, PageLayoutsWithSelectedViews, PageWithUpdatableRuntimeAttribs, SaveModalOnPageCloseResult, SetActivePageForWindowPayload, ShouldPageClosePayload, ShouldPageCloseResult, ViewsPreventingUnloadPayload } from '../../common/src/api/pages/shapes';
-import { NotificationsCustomManifestOptions } from '../../common/src/api/shapes/notifications';
+import type { CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/action';
+import type { AddDefaultPagePayload, AttachedPage, BookmarkNode, CopyPagePayload, HandlePagesAndWindowClosePayload, HandlePagesAndWindowCloseResult, HandleSaveModalOnPageClosePayload, Page, PageLayoutsWithSelectedViews, PageWithUpdatableRuntimeAttribs, SaveModalOnPageCloseResult, SetActivePageForWindowPayload, ShouldPageClosePayload, ShouldPageCloseResult, ViewsPreventingUnloadPayload } from '../../common/src/api/pages/shapes';
+import type { NotificationsCustomManifestOptions } from '../../common/src/api/shapes/notifications';
 import type { CustomThemes, GeneratedPalettes } from '../../common/src/api/theming';
-import { App, DockProviderConfigWithIdentity, StoreButtonConfig } from '../../client-api/src/shapes';
+import type { App, DockProviderConfigWithIdentity, StoreButtonConfig } from '../../client-api/src/shapes';
 import type { WorkflowIntegration } from '../../client-api/src/shapes/integrations';
 export * from '../../dock3/src/shapes';
 export { AppManifestType } from '../../client-api/src/shapes';
@@ -119,6 +119,7 @@ export declare enum GlobalContextMenuOptionType {
     Downloads = "Downloads",
     OpenStorefront = "OpenStorefront",
     ManageDesktopSignals = "ManageDesktopSignals",
+    FindInPage = "FindInPage",
     Appearance = "Appearance",
     Quit = "Quit",
     Custom = "Custom"
@@ -363,6 +364,7 @@ export declare enum BrowserButtonType {
     LockUnlockPage = "LockUnlockPage",
     SaveMenu = "SaveMenu",
     SavePage = "SavePage",
+    Download = "Download",
     Minimise = "Minimise",
     Maximise = "Maximise",
     Close = "Close",
@@ -1591,6 +1593,7 @@ export interface WorkspacePlatformModule extends OpenFin.Platform {
     setLanguage(locale: Locale): Promise<void>;
     /**
      * Implementation for getting the notifications workspace platform configuration.
+     * @deprecated Notifications config is now part of the platform manifest and is automatically resolved by the notifications API. Do not use this method as it will not return the correct configuration.
      */
     getNotificationsConfig(): Promise<NotificationsCustomManifestOptions | undefined>;
     /**
@@ -2085,6 +2088,7 @@ export interface WorkspacePlatformInitConfig {
     /**
      * Config for overriding default notifications behaviour.
      * Leave undefined to use OpenFin hosted Notification Center.
+     * @deprecated Notifications config is now part of the platform manifest and is automatically resolved by the notifications API. Do not use this property as it will not have any effect.
      */
     notifications?: NotificationsCustomManifestOptions;
     /**

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

@@ -1,5 +1,6 @@
 import type OpenFin from '@openfin/core';
 import { ColorSchemeOptionType } from '../../../../client-api-platform/src/shapes';
+import { NotificationsCustomManifestOptions } from '../shapes/notifications';
 export declare const NOTIFICATIONS_SYNC_CHANNEL = "of-workspace-notifications-sync";
 export declare enum NotificationsChannelAction {
     UpdatePlatformThemeScheme = "update-platform-theme-scheme"
@@ -10,5 +11,11 @@ export interface UpdatePlatformSchemePayload {
 interface NotificationsSyncChannelClient extends OpenFin.ChannelClient {
     dispatch(action: NotificationsChannelAction.UpdatePlatformThemeScheme, payload: UpdatePlatformSchemePayload): Promise<void>;
 }
+export type ManifestNotificationsConfig = {
+    notifications?: {
+        customManifest?: NotificationsCustomManifestOptions;
+    };
+};
+export declare function getNotificationCenterUuid(): Promise<string>;
 export declare const getNotificationsSyncChannelClient: () => Promise<NotificationsSyncChannelClient>;
 export {};

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

@@ -78,7 +78,7 @@ export declare enum WorkspacePlatformChannelAction {
     HandleRequestNavigationInternal = "handleRequestNavigationInternal",// Enterprise
     RefreshBookmarksInternal = "refreshBookmarksInternal",// Enterprise
     LaunchBookmarkInternal = "launchBookmarkInternal",// Enterprise
-    GetNotificationsConfig = "getNotificationsConfig",
+    GetNotificationsConfig = "getNotificationsConfig",// Deprecated
     UpdateDockFavoritesInternal = "updateDockFavoritesInternal",// Enterprise
     UpdateContentMenuInternal = "updateContentMenuInternal",// Enterprise
     LaunchDockEntryInternal = "launchDockEntryInternal",// Enterprise

package/common/src/api/shapes/notifications.d.ts

@@ -1,5 +1,6 @@
 /**
  * Options for using privately hosted notification service.
+ * @deprecated Custom manifest is now part of the platform manifest and is automatically resolved by the notifications API. Do not use this type as it will be ignored.
  */
 export type NotificationsCustomManifestOptions = {
     /**

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

@@ -1,8 +1,13 @@
 import type { DefaultTheme } from 'styled-components';
 import type OpenFin from '@openfin/core';
-import { type ColorSchemeType, type ThemeSet, Palette } from '@openfin/ui-library';
+import type { ColorSchemeType, ThemeSet } from '@openfin/ui-library';
 import { ColorSchemeOptionType } from '../../../client-api-platform/src/shapes';
 import type { generateTheme } from '@openfin/theme-engine';
+export declare const ColorScheme: {
+    light: string;
+    dark: string;
+    system: string;
+};
 export type WorkspaceComponentSetSelectedSchemePayload = {
     newScheme: ColorSchemeOptionType;
     identity: OpenFin.Identity;
@@ -275,16 +280,11 @@ export declare const OpenFinDarkTheme: {
 };
 export declare const DefaultOpenFinTheme: CustomThemes;
 export declare const getComputedPaletteSets: (customTheme: CustomThemeOptions | CustomThemeOptionsWithScheme) => WorkspaceThemeSet;
-/**
- * Transforms input {@link CustomThemes} to {@link ComputedThemes} used by Workspace Platform / Notifications Platform.
- *
- * @param customThemes array of themes to transform
- * @param storedScheme sets the default scheme if provided
- * @returns array of {@link ComputedThemes | computed themes}
- */
-export declare const computeThemes: (customThemes: CustomThemes | GeneratedPalettes, storedScheme?: ColorSchemeOptionType) => ComputedThemes;
-export declare const getComputedPlatformTheme: (platformIdentity: OpenFin.Identity) => Promise<ComputedTheme>;
+export declare const getComputedPlatformTheme: (platformIdentity: OpenFin.Identity) => Promise<{
+    theme: GeneratedPalettes | CustomThemes;
+    defaultScheme: ColorSchemeOptionType;
+}>;
 export declare const setSelectedScheme: (ctx: ColorSchemeOptionType) => Promise<void>;
 export declare const getComputedScheme: (identity?: OpenFin.Identity) => Promise<Exclude<ColorSchemeType, "system">>;
-export declare const getComputedBackgroundColor: (paletteKey: keyof typeof Palette, defaultColor?: string) => Promise<string>;
+export declare const getComputedBackgroundColor: () => Promise<string>;
 export {};

package/common/src/utils/find-in-page/findInPageChannel.d.ts

@@ -0,0 +1,35 @@
+export type FindInPageChannelMessagePayload = {
+    type: 'close';
+} | {
+    type: 'find-text-changed';
+    value: string;
+} | {
+    type: 'focus-input';
+} | {
+    type: 'next-result';
+} | {
+    type: 'previous-result';
+} | {
+    type: 'show';
+} | {
+    type: 'update-state';
+    currentResultIndex?: number | null;
+    totalResults?: number | null;
+    value?: string | null;
+} | {
+    type: 'view-ready';
+} | {
+    type: 'window-ready';
+};
+/**
+ * Closes the find in page channel
+ */
+export declare const closeFindInPageChannel: (channel: BroadcastChannel) => void;
+/**
+ * Creates a new find in page channel
+ */
+export declare const createFindInPageChannel: (windowName?: string) => Promise<BroadcastChannel>;
+/**
+ * Sends a message via the find in page channel
+ */
+export declare const sendFindInPageMessage: (channel: BroadcastChannel, message: FindInPageChannelMessagePayload) => void;

package/common/src/utils/find-in-page/showFindInPageHandler.d.ts

@@ -0,0 +1,2 @@
+import type OpenFin from '@openfin/core';
+export declare const showFindInPageInTargetWindow: (windowIdentity: OpenFin.Identity) => Promise<void>;

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

@@ -74,6 +74,13 @@ export declare const manageDesktopSignals: () => {
         type: WP.GlobalContextMenuOptionType;
     };
 };
+export declare const findInPage: () => {
+    type: MenuItemType;
+    label: string;
+    data: {
+        type: WP.GlobalContextMenuOptionType;
+    };
+};
 export declare const renameWorkspace: () => {
     type: MenuItemType;
     label: string;

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

@@ -33,7 +33,8 @@ declare enum BrowserRoute {
     EnterpriseDock = "/dock/",
     ZoomControlsDialog = "/zoom-controls-dialog/",
     DesktopSignalsModal = "/popup-menu/desktop-signals-modal/",
-    IntentsResolverModal = "/popup-menu/intents-resolver-modal/"
+    IntentsResolverModal = "/popup-menu/intents-resolver-modal/",
+    FindInPageModal = "/find-in-page-modal/"
 }
 declare const PageRoute: {
     Browser: BrowserRoute.Browser;
@@ -55,6 +56,7 @@ declare const PageRoute: {
     ZoomControlsDialog: BrowserRoute.ZoomControlsDialog;
     DesktopSignalsModal: BrowserRoute.DesktopSignalsModal;
     IntentsResolverModal: BrowserRoute.IntentsResolverModal;
+    FindInPageModal: BrowserRoute.FindInPageModal;
     Home: WorkspaceRoute.Home;
     HomeSearch: WorkspaceRoute.HomeSearch;
     HomePagesRename: WorkspaceRoute.HomePagesRename;

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

@@ -22,7 +22,8 @@ export declare enum WindowName {
     ZoomControlsDialog = "here-zoom-controls-dialog",
     AboutPageWindow = "here-about-page",
     DesktopSignalsModal = "here-desktop-signals-modal",
-    IntentsResolverModal = "here-intents-resolver-modal"
+    IntentsResolverModal = "here-intents-resolver-modal",
+    FindInPageViewPrefix = "here-find-in-page-view-"
 }
 export interface WindowIdentity {
     uuid: ApplicationUUID | string;

package/externals.report.json

@@ -62,56 +62,5 @@
             "packageName": "common/package.json",
             "issuer": "common/src/utils/create-and-migrate-ibd-store.ts"
         }
-    ],
-    "@radix-ui/react-icons": [
-        {
-            "type": "explicit-peer",
-            "version": ">=1.3.2 <2.0.0",
-            "rootVersion": "^1.3.2",
-            "packageName": "packages/ui-library/package.json",
-            "issuer": "packages/ui-library/dist/index.js"
-        }
-    ],
-    "framer-motion": [
-        {
-            "type": "explicit-peer",
-            "version": ">=11.13.1 <12.0.0",
-            "rootVersion": "11.13.1",
-            "packageName": "packages/ui-library/package.json",
-            "issuer": "packages/ui-library/dist/index.js"
-        }
-    ],
-    "lodash": [
-        {
-            "packageName": "packages/ui-library/package.json",
-            "issuer": "packages/ui-library/dist/index.js"
-        }
-    ],
-    "react": [
-        {
-            "type": "explicit-peer",
-            "version": ">=18.3.1 <19.0.0",
-            "rootVersion": "18.3.1",
-            "packageName": "packages/ui-library/package.json",
-            "issuer": "packages/ui-library/dist/index.js"
-        }
-    ],
-    "react-calendar": [
-        {
-            "type": "explicit-peer",
-            "version": ">=5.1.0 <6.0.0",
-            "rootVersion": "^5.1.0",
-            "packageName": "packages/ui-library/package.json",
-            "issuer": "packages/ui-library/dist/index.js"
-        }
-    ],
-    "styled-components": [
-        {
-            "type": "explicit-peer",
-            "version": ">=5.3.11 <6.0.0",
-            "rootVersion": "5.3.11",
-            "packageName": "packages/ui-library/package.json",
-            "issuer": "packages/ui-library/dist/index.js"
-        }
     ]
 }