@openfin/workspace-platform 23.0.18 → 23.1.1

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

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

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

@@ -4,5 +4,5 @@ type DefaultViewOptions = Partial<OpenFin.MutableViewOptions> & {
     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<OpenFin.ViewOptions>, initViewOptions?: Partial<OpenFin.ViewOptions>): any;
 export {};

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

@@ -23,10 +23,3 @@ export type ApplicationInfoExtended = OpenFin.ApplicationInfo & {
 };
 export declare const getCurrentOFApplication: () => OpenFin.Application;
 export declare const getWorkspaceOFApplication: () => OpenFin.Application;
-/**
- * Gets the application manifest, caching the result after the first call.
- * The manifest never changes during the application lifecycle, so this avoids redundant async calls.
- * Uses promise-based caching to prevent race conditions when multiple calls occur before the first completes.
- * @returns A Promise resolving to the application manifest
- */
-export declare const getCachedManifest: () => Promise<OpenFin.Manifest>;

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

@@ -61,13 +61,6 @@ export declare const getFirstActiveViewFromLayout: (identity: OpenFin.LayoutIden
  * @returns A mapped copy of the layout
  */
 export declare const mapLayoutViewComponents: (node: any, callback: (arg0: any) => any) => any;
-/**
- * Recursively clones a layout object, calling a passed async callback on each `componentState` in the tree.
- * @param node Either the layout object itself, or one of the items in its tree.
- * @param callback Async callback to be called on each component's `componentState`
- * @returns A Promise resolving to a mapped copy of the layout
- */
-export declare const mapLayoutViewComponentsAsync: (node: any, callback: (arg0: any) => Promise<any>) => Promise<any>;
 /**
  * Copies the componentState and generates a name if it's not there
  * @param componentState view's componentState in the layout object, corresponds to View options
@@ -87,9 +80,9 @@ export declare const generateViewNameAndIdentifierNameIfNotExists: <T extends {
 /**
  * Deep clones a layout and converts view options (add names if necessary, apply defaults).
  * @param layout The Layout to be cloned
- * @returns A Promise resolving to a copy of the layout with view options converted
+ * @returns 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<OpenFin.ViewOptions>) => any;
 export declare const cloneViewComponentWithoutName: (componentState: any) => any;
 /**
  * Deep clones a layout and removes view names.

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

@@ -1,6 +1,80 @@
+/**
+ * Logger Utility for OpenFin Workspace Monorepo
+ *
+ * Provides structured, contextual logging with consistent formatting
+ * across all workspaces and modules.
+ */
+export interface LogData {
+    [key: string]: any;
+}
+export interface Logger {
+    debug: (method: string, message: string, data?: LogData | (() => LogData)) => void;
+    info: (method: string, message: string, data?: LogData | (() => LogData)) => void;
+    warn: (method: string, message: string, data?: LogData | (() => LogData)) => void;
+    error: (method: string, message: string, data?: LogData | (() => LogData)) => void;
+}
+/**
+ * Configuration for the logger
+ */
+export interface LoggerConfig {
+    /** Include timestamp in logs (default: true) */
+    includeTimestamp?: boolean;
+    /** Custom prefix for logs */
+    customPrefix?: string;
+}
+/**
+ * Create a structured logger for a specific context
+ *
+ * @param context - The context identifier (workspace, module, or component name)
+ * @param config - Optional configuration for the logger
+ * @returns Enhanced logger instance
+ *
+ * @example
+ * ```typescript
+ * const logger = createLogger('browser.TabList');
+ *
+ * logger.info('addTab', 'Adding new tab', { pageId: '123' });
+ * logger.error('addTab', 'Failed to add tab', { error: err.message });
+ * ```
+ */
+export declare const createLogger: (context: string, config?: LoggerConfig) => Logger;
+/**
+ * Create a logger with performance monitoring capabilities
+ * Useful for tracking execution times and performance metrics
+ */
+export declare const createPerformanceLogger: (context: string, config?: LoggerConfig) => {
+    /**
+     * Start a performance timer
+     */
+    startTimer: (timerId: string, method: string, message: string, data?: LogData) => void;
+    /**
+     * Clear a specific timer without logging
+     */
+    clearTimer: (timerId: string) => void;
+    /**
+     * End a performance timer and log the duration
+     */
+    endTimer: (timerId: string, method: string, message: string, data?: LogData) => void;
+    debug: (method: string, message: string, data?: LogData | (() => LogData)) => void;
+    info: (method: string, message: string, data?: LogData | (() => LogData)) => void;
+    warn: (method: string, message: string, data?: LogData | (() => LogData)) => void;
+    error: (method: string, message: string, data?: LogData | (() => LogData)) => void;
+};
+export type EnhancedLogger = ReturnType<typeof createPerformanceLogger>;
+/**
+ * Middleware function for wrapping async operations with logging
+ */
+export declare const withLogging: <T extends any[], R>(logger: Logger, method: string, operation: (...args: T) => Promise<R> | R) => (...args: T) => Promise<R>;
+/**
+ * Legacy logger instance for backwards compatibility.
+ * Use `createLogger` for new code to get structured, contextual logging.
+ *
+ * @deprecated Use createLogger() instead for new code
+ */
 export declare const log: {
     /**
-     * Calls console.debug with provided parameters and stringifies JS objects prior to logging
+     * Calls console.debug with provided parameters and stringifies JS objects prior to logging.
+     * Only logs when LOG_DEBUG is enabled.
      */
     debug: (...args: unknown[]) => void;
     /**

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

@@ -7,6 +7,8 @@ type MenuEventTypes = {
     'update': [string, Partial<OpenFin.Bounds>, string];
     'modal-opened': [string];
     'modal-closed': [string];
+    'search-menu-opening': [string];
+    'search-menu-closed': [string];
 };
 export interface ModalResponseEvent {
     data: {

package/externals.report.json

@@ -38,18 +38,18 @@
         }
     ],
     "dexie": [
-        {
-            "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",
             "packageName": "dock3/package.json",
             "issuer": "dock3/src/api/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",