@openfin/workspace-platform 22.5.21 → 23.0.1

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

@@ -0,0 +1,22 @@
+export declare const log: {
+    /**
+     * Calls console.debug with provided parameters and stringifies JS objects prior to logging
+     */
+    debug: (...args: unknown[]) => void;
+    /**
+     * Calls console.info with provided parameters and stringifies JS objects prior to logging
+     */
+    info: (...args: unknown[]) => void;
+    /**
+     * Calls console.warn with provided parameters and stringifies JS objects prior to logging
+     */
+    warn: (...args: unknown[]) => void;
+    /**
+     * Calls console.error with provided parameters and stringifies JS objects prior to logging
+     */
+    error: (...args: unknown[]) => void;
+    /**
+     * Calls console.trace with provided parameters and stringifies JS objects prior to logging
+     */
+    trace: (...args: unknown[]) => void;
+};

package/common/src/utils/menu-window-provider.d.ts

@@ -17,12 +17,12 @@ export interface ModalResponseEvent {
 }
 export declare const menuEvents: {
     emit: <EventKey extends keyof MenuEventTypes>(event: EventKey, ...payload: MenuEventTypes[EventKey]) => Promise<void>;
-    addListener: <EventKey_1 extends keyof MenuEventTypes>(event: EventKey_1, listener: (...payload: MenuEventTypes[EventKey_1]) => void) => void;
-    addListenerWithUUID: (uuid: string) => <EventKey_1 extends keyof MenuEventTypes>(event: EventKey_1, listener: (...payload: MenuEventTypes[EventKey_1]) => void) => void;
-    removeListener: <EventKey_2 extends keyof MenuEventTypes>(event: EventKey_2, listener: (...payload: MenuEventTypes[EventKey_2]) => void) => void;
-    once: <EventKey_3 extends keyof MenuEventTypes>(event: EventKey_3, listener: (...payload: MenuEventTypes[EventKey_3]) => void) => void;
+    addListener: <EventKey extends keyof MenuEventTypes>(event: EventKey, listener: (...payload: MenuEventTypes[EventKey]) => void) => void;
+    addListenerWithUUID: (uuid: string) => <EventKey extends keyof MenuEventTypes>(event: EventKey, listener: (...payload: MenuEventTypes[EventKey]) => void) => void;
+    removeListener: <EventKey extends keyof MenuEventTypes>(event: EventKey, listener: (...payload: MenuEventTypes[EventKey]) => void) => void;
+    once: <EventKey extends keyof MenuEventTypes>(event: EventKey, listener: (...payload: MenuEventTypes[EventKey]) => void) => void;
 };
-export declare const emitMenuResponse: (data: ModalResponseEvent['data']) => Promise<void>;
+export declare const emitMenuResponse: (data: ModalResponseEvent["data"]) => Promise<void>;
 type WindowOptionsWithBounds = OptionalExceptFor<OpenFin.WindowOptions, 'name' | 'url'> & {
     top: number;
     left: number;
@@ -49,6 +49,6 @@ export declare function createMenuPosition(windowOptions: OptionalExceptFor<Open
 }>;
 export declare function showChildWindow({ options, parameters }: ShowChildOptions): Promise<OpenFin.Window>;
 export declare const waitForModalResponse: ({ options, content, parameters }: ResponseModalOptions) => Promise<{
-    data: ModalResponseEvent['data'];
+    data: ModalResponseEvent["data"];
 }>;
 export {};

package/common/src/utils/modal-bounds.d.ts

@@ -16,7 +16,7 @@ export declare const getCenterOfParentWindowMonitor: (parentWindowIdentity?: Ope
  * @param centerOnMonitor whether the modal should be centered on the monitor
  * @returns the bounds for where the modal is to be displayed
  */
-export declare const getResponseModalBounds: (modalOptions: Pick<ResponseModalConfig['windowOptions'], 'defaultWidth' | 'defaultHeight'>, parentWindowIdentity?: OpenFin.Identity, centerOnMonitor?: boolean) => Promise<OpenFin.Bounds>;
+export declare const getResponseModalBounds: (modalOptions: Pick<ResponseModalConfig["windowOptions"], "defaultWidth" | "defaultHeight">, parentWindowIdentity?: OpenFin.Identity, centerOnMonitor?: boolean) => Promise<OpenFin.Bounds>;
 export declare function getResponseModalBoundsAndCenterParentIfModalOffScreen(modalOptions: Parameters<typeof getResponseModalBounds>[0], parentWindowIdentity?: OpenFin.Identity, centerOnMonitor?: boolean, relativeBounds?: boolean): Promise<OpenFin.Bounds>;
 /**
  * Adjusts the given bounds to be within the closest monitor's available bounds if they are offscreen.

package/common/src/utils/namespaced-local-storage.d.ts

@@ -1,4 +1,4 @@
-export declare const createNamespacedLocalStorage: <TKey extends string>(namespace: string) => Pick<Storage, 'setItem' | 'getItem' | 'removeItem'>;
+export declare const createNamespacedLocalStorage: <TKey extends string>(namespace: string) => Pick<Storage, "setItem" | "getItem" | "removeItem">;
 export declare const setItem: (key: string, value: string) => void;
-export declare const getItem: (key: string) => string;
+export declare const getItem: (key: string) => string | null;
 export declare const removeItem: (key: string) => void;

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

@@ -3,6 +3,12 @@ import { UserMenuParams } from '../../../common/src/utils/menu';
 import { OptionalExceptFor } from '../../../common/src/utils/types';
 import { AnchorBehavior } from '../../../client-api-platform/src/api/context-menu';
 import { Site, SiteAction } from '../../../client-api-platform/src/shapes';
+export type ViewMoreButton = {
+    type: 'view-more-result';
+    id: string;
+    providerId: string;
+};
+export type SelectableResult = Site | ViewMoreButton;
 export declare enum SaveMenuType {
     Save = "Save",
     SaveAs = "SaveAs"
@@ -116,8 +122,17 @@ export type SearchMenuChannelResponse = {
 } | {
     type: 'keyboard-event';
     keyboardEvent: BrowserSearchMenuKeyboardEvent;
+} | {
+    type: 'focused-changed';
+    payload: SelectableResult;
 } | {
     type: 'search-provider-changed';
+} | {
+    type: 'all-providers-results-announcement';
+    message: string;
+} | {
+    type: 'single-provider-results-announcement';
+    message: string;
 };
 export declare function showPopupWin<T extends keyof UserMenuParams>(parentWindow: OpenFin.Window, params: UserMenuParams[T], windowOpts: OpenFin.PopupOptions): Promise<OpenFin.PopupResult>;
 export {};

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/shared-emitter.d.ts

@@ -5,12 +5,12 @@ export default function makeSharedEmitter<EventMap extends {
     [key: string | number]: any[];
 }>(id: string): {
     emit: <EventKey extends keyof EventMap>(event: EventKey, ...payload: EventMap[EventKey]) => Promise<void>;
-    addListener: <EventKey_1 extends keyof EventMap>(event: EventKey_1, listener: (...payload: EventMap[EventKey_1]) => void) => void;
+    addListener: <EventKey extends keyof EventMap>(event: EventKey, listener: (...payload: EventMap[EventKey]) => void) => void;
     /**
      * Creates a listener for a particular UUID instead of ApplicationUUID.Workspace.
      * @param uuid The UUID of the application to subscribe to.
      */
-    addListenerWithUUID: (uuid: string) => <EventKey_1 extends keyof EventMap>(event: EventKey_1, listener: (...payload: EventMap[EventKey_1]) => void) => void;
-    removeListener: <EventKey_2 extends keyof EventMap>(event: EventKey_2, listener: (...payload: EventMap[EventKey_2]) => void) => void;
-    once: <EventKey_3 extends keyof EventMap>(event: EventKey_3, listener: (...payload: EventMap[EventKey_3]) => void) => void;
+    addListenerWithUUID: (uuid: string) => <EventKey extends keyof EventMap>(event: EventKey, listener: (...payload: EventMap[EventKey]) => void) => void;
+    removeListener: <EventKey extends keyof EventMap>(event: EventKey, listener: (...payload: EventMap[EventKey]) => void) => void;
+    once: <EventKey extends keyof EventMap>(event: EventKey, listener: (...payload: EventMap[EventKey]) => void) => void;
 };

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

@@ -54,5 +54,5 @@ type MissingKeys<T, U> = Exclude<keyof T, U>;
  * fooChecker(['bar', 'qux', 'baz']); // 'baz' is not assignable to type keyof Foo;
  * ```
  */
-export declare const makeKeyChecker: <T extends object>() => <K extends (keyof T)[]>(arr: K & (Exclude<keyof T, K[number]> extends never ? unknown : `Error: Missing keys: ${string & Exclude<keyof T, K[number]>}`)) => K;
+export declare const makeKeyChecker: <T extends object>() => <K extends (keyof T)[]>(arr: K & (MissingKeys<T, K[number]> extends never ? unknown : `Error: Missing keys: ${string & MissingKeys<T, K[number]>}`)) => K;
 export {};

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

@@ -1,4 +1,5 @@
 import type OpenFin from '@openfin/core';
+import type { SearchProviderInfo } from '../../../search-api/src/shapes';
 import { ApplicationUUID } from './application';
 export declare enum WindowName {
     Home = "openfin-home",
@@ -21,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;
@@ -173,6 +175,13 @@ export declare const getComponentWindowStatus: () => Promise<{
 }>;
 export declare const deserializeWindowBounds: (serialized: string) => OpenFin.WindowBounds | null;
 export declare const serializeWindowBounds: (bounds: OpenFin.WindowBounds) => string;
+/**
+ * Calculates the dynamic height for the home window based on subheader configuration
+ * @param baseHeight - The base height for the home window
+ * @param subHeaderConfig - The subheader configuration from search provider
+ * @returns The calculated height based on missing subheader elements
+ */
+export declare const calculateHomeWindowHeight: (baseHeight: number, subHeaderConfig?: SearchProviderInfo["subHeader"]) => number;
 export declare const getWindowBounds: (window: OpenFin.Window) => Promise<OpenFin.RectangleByEdgePositions>;
 /**
  * calculates the percenage of the window that is present within the monitor (float in range 0-1)

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

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

package/dock3/src/shapes/shapes.d.ts

@@ -75,4 +75,12 @@ export interface Dock3Config {
         };
     };
 }
-export type DockAllowedWindowOptions = Partial<Pick<OpenFin.PlatformWindowOptions, 'defaultCentered' | 'saveWindowState' | 'taskbarIconGroup' | 'defaultTop' | 'defaultLeft'>>;
+export type DockAllowedWindowOptions = Partial<Pick<OpenFin.PlatformWindowOptions, 'defaultCentered' | 'saveWindowState' | 'taskbarIconGroup' | 'defaultTop' | 'defaultLeft'>> & {
+    experimental?: {
+        snapZone?: {
+            enabled: boolean;
+            threshold?: number;
+            locationPreference?: Array<'top' | 'bottom'>;
+        };
+    };
+};