@openfin/workspace 23.0.9 → 23.0.12

package/client-api/src/notifications.d.ts

@@ -1,6 +1,6 @@
-import * as Notifications from '@here-io/notifications';
+import * as Notifications from '@openfin/notifications';
 import type { NotificationsPlatform, NotificationsRegisterOptions } from './shapes/notifications';
-export * from '@here-io/notifications';
+export * from '@openfin/notifications';
 export * from './shapes/notifications';
 /**
  * @deprecated Use `register` with {@link NotificationsRegisterOptions | options?: NotificationsRegisterOptions} argument instead.

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

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

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

@@ -1,5 +1,5 @@
 /**
- * This module exports only notifications types that are not defined in '@here-io/notifications' npm package
+ * This module exports only notifications types that are not defined in '@openfin/notifications' npm package
  */
 import { NotificationsCustomManifestOptions } from '../../../common/src/api/shapes/notifications';
 /**

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.View | OpenFin.Identity | OpenFin.Platform | OpenFin.Application>;
+export declare function launchApp({ app, target }: LaunchAppRequest): Promise<void | OpenFin.Identity | OpenFin.Platform | OpenFin.View | OpenFin.Application>;
 export declare const enterpriseAppDirectoryChannelClient: () => Promise<OpenFin.ChannelClient>;
 export declare function getResults(payload: {
     req: SearchSitesRequest;

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

@@ -266,6 +266,40 @@ export type InternalOpenGlobalContextMenuRequest = OpenGlobalContextMenuRequest
     rect?: DOMRect;
 };
 export type ViewTabContextMenuTemplate = OpenFin.MenuItemTemplate<ViewTabMenuData>;
+/**
+ * UI elements within a view tab that can be navigated to via keyboard.
+ */
+export type ViewTabElements = 'inactive-tab' | 'active-tab' | 'inactive-tab-close-button' | 'active-tab-close-button' | 'add-tab-button';
+/**
+ * Configuration options for view tab keyboard navigation behavior.
+ */
+export interface ViewTabOptions {
+    /**
+     * Elements in the view tab that are able to be focused using
+     * arrow keys when an element in the view is selected.
+     * The order of the items in the array have no impact.
+     * Note: these are not mutually exclusive and can overlap.
+     * Default (when undefined): ["inactive-tab","active-tab","active-tab-close-button","inactive-tab-close-button","add-tab-button"]
+     */
+    arrowNavigation?: ViewTabElements[];
+    /**
+     * Elements in the view tab that are able to be focused using
+     * tab and shift+tab when an element in the view is selected.
+     * The order of the items in the array have no impact.
+     * Note: these are not mutually exclusive and can overlap.
+     * Default (when undefined): ["active-tab","add-tab-button"]
+     */
+    tabNavigation?: ViewTabElements[];
+}
+/**
+ * Configuration options for accessibility features in the Browser.
+ */
+export interface AccessibilityOptions {
+    /**
+     * View tab keyboard navigation options.
+     */
+    viewTabOptions?: ViewTabOptions;
+}
 /**
  * Request for opening a view tab context menu in Browser.
  */
@@ -682,6 +716,30 @@ export interface BrowserWorkspacePlatformWindowOptions {
         minWidth?: string;
         maxWidth?: string;
     };
+    /**
+     * Accessibility options for the browser window.
+     * These options override the default accessibility options set at the platform or browser initialization level.
+     *
+     * @example
+     * ```ts
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
+     *
+     * const platform = WorkspacePlatform.getCurrentSync();
+     * const browserWin = platform.Browser.createWindow({
+     *   ...,
+     *   workspacePlatform: {
+     *     ...,
+     *     accessibilityOptions: {
+     *       viewTabOptions: {
+     *         arrowNavigation: ["inactive-tab", "active-tab"],
+     *         tabNavigation: ["active-tab"]
+     *       }
+     *     }
+     *   }
+     * });
+     * ```
+     */
+    accessibilityOptions?: AccessibilityOptions;
     /**
      * Use when you want to display navigation buttons in Browser toolbar. Disabled by default.
      *
@@ -2012,7 +2070,7 @@ export interface WorkspacePlatformModule extends OpenFin.Platform {
      * @internal
      */
     _focusAndExpandSearchInternal(): Promise<void>;
-    /** Shows a popup window for Here About page with provided data parameters
+    /** Shows a popup window for HERE About page with provided data parameters
      * @internal
      */
     _showAboutPagePopup(payload: AboutPageConfig): Promise<OpenFin.Window>;
@@ -2814,6 +2872,28 @@ export interface BrowserInitConfig {
      * that are PNGs you will need to update these assets for best results.
      */
     browserIconSize?: IconSize;
+    /**
+     * Default accessibility options that will be applied to all browser windows.
+     * These options can be overridden at the window creation level via workspacePlatform.accessibilityOptions.
+     *
+     * @example
+     * ```ts
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
+     *
+     * await WorkspacePlatform.init({
+     *   browser: {
+     *     title: "My Browser",
+     *     accessibilityOptions: {
+     *       viewTabOptions: {
+     *         arrowNavigation: ["inactive-tab", "active-tab"],
+     *         tabNavigation: ["active-tab"]
+     *       }
+     *     }
+     *   }
+     * });
+     * ```
+     */
+    accessibilityOptions?: AccessibilityOptions;
     /**
      * Override workspace platform behavior
      *

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

@@ -11,7 +11,7 @@ export declare const isDocumentDefined: boolean;
 export declare const isWindowDefinedWithIndexDB: boolean;
 export declare const finUUID: string;
 export declare const finName: string;
-export declare const finEntityType: "" | "window" | "view";
+export declare const finEntityType: "" | "view" | "window";
 export declare const isEnvLocal: boolean;
 export declare const isEnvDev: boolean;
 export declare const isEnvStaging: boolean;

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

@@ -5,6 +5,8 @@ export type FindInPageChannelMessagePayload = {
     value: string;
 } | {
     type: 'focus-input';
+} | {
+    type: 'hide-from-search-menu';
 } | {
     type: 'next-result';
 } | {

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

@@ -11,12 +11,22 @@ export type LayoutDOMEventType =
  * Fired when a tab is created in a container. (Emmitted by core)
  */
  | 'tab-created'
+/**
+ * Fired when a new container/stack is created. (Emitted by Golden Layout)
+ */
+ | 'container-created'
 /**
  * Fired when the layout container is ready to be used. (Emitted by us)
  */
- | 'container-resized' | 'tab-closed';
+ | 'container-resized'
+/**
+ * Fired when a view item container is resized (e.g., via separator drag). (Emitted by us)
+ */
+ | 'view-container-resized' | 'tab-closed';
 export type LayoutDOMEvent = {
     type: Extract<LayoutDOMEventType, 'container-resized'>;
+} | {
+    type: Extract<LayoutDOMEventType, 'view-container-resized'>;
 } | {
     type: Extract<LayoutDOMEventType, 'tab-created' | 'tab-closed'>;
     detail: {
@@ -30,6 +40,14 @@ export type LayoutDOMEvent = {
     };
     isInitialized: boolean;
     target: HTMLElement;
+} | {
+    type: Extract<LayoutDOMEventType, 'container-created'>;
+    detail?: {
+        containerSelector?: string;
+        [key: string]: any;
+    };
+    target?: HTMLElement;
+    originalElement?: HTMLElement;
 } | {
     type: Extract<LayoutDOMEventType, 'tabs-list-resized'>;
 };
@@ -85,6 +103,13 @@ export declare const isLayoutTabActive: (tabSelector: string) => boolean;
 export declare const containerId = "layout_container";
 export declare const viewTabslistSelectors = ".lm_tabs";
 export declare const addLayoutEventListener: (event: LayoutDOMEventType, listener: LayoutDOMEventListener) => void;
+export declare const removeLayoutEventListener: (event: LayoutDOMEventType, listener: LayoutDOMEventListener) => void;
+/**
+ * Cleans up ResizeObservers and event listeners for a specific layout.
+ * Should be called when a layout is destroyed to prevent memory leaks.
+ * @param layoutName The layoutName/layoutContainerKey to cleanup
+ */
+export declare const cleanupLayoutObservers: (layoutName: string) => void;
 /**
  * Initialize the layout for the current OF window.
  */

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

@@ -34,7 +34,7 @@ declare enum BrowserRoute {
     ZoomControlsDialog = "/zoom-controls-dialog/",
     DesktopSignalsModal = "/popup-menu/desktop-signals-modal/",
     IntentsResolverModal = "/popup-menu/intents-resolver-modal/",
-    FindInPageModal = "/find-in-page-modal/"
+    FindInPageModal = "/popup-menu/find-in-page-modal/"
 }
 declare const PageRoute: {
     Browser: BrowserRoute.Browser;

package/dock3/src/api/utils.d.ts

@@ -0,0 +1,11 @@
+import type { CompanionDockConfig } from '../shapes/enterprise';
+import type { DockAllowedWindowOptions } from '../shapes/shapes';
+export declare const getSnapZone: (config: CompanionDockConfig | unknown, options?: DockAllowedWindowOptions) => {
+    enabled: boolean;
+    threshold?: number;
+    locationPreference?: Array<"top" | "bottom">;
+} | {
+    enabled: boolean;
+    threshold: number;
+    locationPreference: readonly ["top", "bottom"];
+};

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

@@ -6,6 +6,11 @@ export type { EnterpriseDockChannelClient, EnterpriseDockChannelProvider } from
  * @internal
  */
 export type DockCompanionButton = Exclude<Dock3Button, 'store'> | 'bookmarks' | 'searchShortcut' | 'collectionMenu';
+/**
+ * @internal
+ * Supported context menu template items for the dock companion window
+ */
+export type DockContextMenuItem = 'snapToTop' | 'snapToBottom' | 'inspect';
 /**
  * @internal
  */
@@ -21,4 +26,21 @@ export type CompanionDockConfig = Omit<Dock3Config, 'defaultDockButtons'> & {
     defaultDockButtons?: DockCompanionButton[];
     windowType?: 'enterprise';
     collectionMenu?: Collection[];
+    /**
+     * Experimental snapzone configuration for the dock companion
+     */
+    experimental?: {
+        snapZone?: {
+            enabled: boolean;
+            threshold?: number;
+            locationPreference?: Array<'top' | 'bottom'>;
+        };
+    };
+    /**
+     * Context menu options for the dock companion window
+     */
+    contextMenuOptions?: {
+        enabled: boolean;
+        template?: DockContextMenuItem[];
+    };
 };

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

@@ -83,4 +83,8 @@ export type DockAllowedWindowOptions = Partial<Pick<OpenFin.PlatformWindowOption
             locationPreference?: Array<'top' | 'bottom'>;
         };
     };
+    contextMenuOptions?: {
+        enabled?: boolean;
+        template?: Array<'snapToTop' | 'snapToBottom' | 'inspect'>;
+    };
 };

package/externals.report.json

@@ -1,12 +1,20 @@
 {
-    "@here-io/notifications": [
+    "@openfin/notifications": [
         {
             "type": "explicit",
-            "version": "npm:@openfin/notifications@2.13.0-alpha-4391",
+            "version": "2.13.0-alpha-4399",
             "packageName": "client-api/package.json",
             "issuer": "client-api/src/notifications.ts"
         }
     ],
+    "@openfin/microsoft365": [
+        {
+            "type": "explicit",
+            "version": "^1.0.1",
+            "packageName": "client-api/package.json",
+            "issuer": "client-api/src/integrations/microsoft.ts"
+        }
+    ],
     "title-case": [
         {
             "type": "explicit",
@@ -21,14 +29,6 @@
             "issuer": "common/src/utils/color-linking.ts"
         }
     ],
-    "@openfin/microsoft365": [
-        {
-            "type": "explicit",
-            "version": "^1.0.1",
-            "packageName": "client-api/package.json",
-            "issuer": "client-api/src/integrations/microsoft.ts"
-        }
-    ],
     "lodash.debounce": [
         {
             "type": "explicit",