@openfin/fdc3-api 44.101.1 → 44.101.3

package/out/fdc3-api-public.d.ts

@@ -42,6 +42,16 @@ declare type Accelerator = {
     zoom: boolean;
 };
 
+/**
+ * @interface
+ * Shared context available to all aria label functions.
+ */
+declare type AccessibilityContext = {
+    arrowNavigationEnabled: boolean;
+    deleteKeyCloseEnabled: boolean;
+    homeEndNavigationEnabled: boolean;
+};
+
 /**
  * Generated when a View is added to a layout.
  * @interface
@@ -51,6 +61,14 @@ declare type AddedToLayoutEvent = BaseEvent_4 & {
     layoutIdentity: OpenFin.LayoutIdentity;
 };
 
+/**
+ * @interface
+ * Context for add tab button aria-label functions.
+ */
+declare type AddTabButtonAriaLabelContext = AccessibilityContext & {
+    tabCount: number;
+};
+
 /**
  * Options to use when adding a view to a {@link TabStack}.
  *
@@ -1596,6 +1614,17 @@ declare type AppVersionRuntimeStatusEvent = {
 
 /* Excluded from this release type: AppVersionTypeFromIdEvent */
 
+/**
+ * @interface
+ * Custom aria-label providers for accessibility.
+ */
+declare type AriaLabelOptions = {
+    activeTab?: string | ((ctx: TabAriaLabelContext) => string);
+    inactiveTab?: string | ((ctx: TabAriaLabelContext) => string);
+    closeButton?: string | ((ctx: CloseButtonAriaLabelContext) => string);
+    addTabButton?: string | ((ctx: AddTabButtonAriaLabelContext) => string);
+};
+
 declare interface AuthorizationPayload {
     token: string;
     file: string;
@@ -3112,6 +3141,11 @@ declare type ClearCacheOption = {
      * browser data that can be used across sessions
      */
     localStorage?: boolean;
+    /**
+     * Clears saved window-state data written for windows that use `saveWindowState`.
+     * After this data is cleared, previously persisted bounds and state (Maximized/Minimized) will not be restored until new state is written again.
+     */
+    windowState?: boolean;
 };
 
 /**
@@ -3154,6 +3188,11 @@ declare type ClearDataOptions = {
      * - `origin-in-all-contexts` - Storage is matched on origin only in all contexts.
      */
     originMatchingMode?: 'third-parties-included' | 'origin-in-all-contexts';
+    /**
+     * Clears saved window-state data written for windows that use `saveWindowState`.
+     * After this data is cleared, previously persisted bounds and state (Maximized/Minimized) will not be restored until new state is written again.
+     */
+    windowState?: boolean;
 };
 
 /**
@@ -3441,6 +3480,15 @@ declare type ClipboardPermissions = {
  */
 declare type ClipboardSelectionType = 'clipboard' | 'selection';
 
+/**
+ * @interface
+ * Context for close button aria-label functions.
+ */
+declare type CloseButtonAriaLabelContext = AccessibilityContext & {
+    title: string;
+    isActive: boolean;
+};
+
 /**
  * Generated when an application is closed.
  * @interface
@@ -4453,6 +4501,10 @@ declare type CreateLayoutOptions = {
      * @experimental
      */
     renderCustomHeaderControls?: (controlsElement: HTMLElement, context: HeaderControlsContext) => (() => void) | void;
+    /**
+     * Accessibility options for the layout. Controls ARIA attributes and keyboard navigation.
+     */
+    accessibilityOptions?: LayoutAccessibilityOptions;
 };
 
 /**
@@ -5136,7 +5188,7 @@ declare interface Environment {
     layoutAllowedInContext(fin: OpenFin.Fin<OpenFin.EntityType>): boolean;
     initLayoutManager(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, options: OpenFin.InitLayoutOptions): Promise<OpenFin.LayoutManager<OpenFin.LayoutSnapshot>>;
     applyLayoutSnapshot(fin: OpenFin.Fin<OpenFin.EntityType>, layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.InitLayoutOptions): Promise<void>;
-    createLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.CreateLayoutOptions): Promise<void>;
+    createLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.CreateLayoutOptions): Promise<OpenFin.LayoutSyncApi>;
     destroyLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<void>;
     resolveLayout(layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, layoutIdentity: OpenFin.LayoutIdentity): Promise<any>;
     initPlatform(fin: OpenFin.Fin<OpenFin.EntityType>, ...args: Parameters<OpenFin.Fin['Platform']['init']>): ReturnType<OpenFin.Fin['Platform']['init']>;
@@ -8734,6 +8786,27 @@ declare class Layout extends Base {
     closeView(viewIdentity: OpenFin.Identity): Promise<void>;
 }
 
+/**
+ * @interface
+ * Accessibility options for layout tab navigation and ARIA support.
+ */
+declare type LayoutAccessibilityOptions = {
+    viewTabOptions?: ViewTabAccessibilityOptions;
+    /**
+     * Keyboard shortcut used to move focus from a tab header element into the active tab's web content.
+     *
+     * - Accepts an accelerator-like string, e.g. `'Ctrl+Enter'`, `'Meta+Enter'`, `'Alt+Enter'`, `'Mod+Enter'`.
+     * - `'Mod'`/`'CmdOrCtrl'`/`'CtrlOrMeta'` means Ctrl on Windows/Linux or Meta on macOS.
+     * - Set to `false` to disable this shortcut.
+     * - In core-web, reverse focus transfer (from iframe web content back to tab header) is not reliably supportable
+     *   due to browser iframe security and cross-origin focus restrictions. This hotkey is intentionally one-way:
+     *   tab header -> web content.
+     *
+     * @defaultValue 'Mod+Enter'
+     */
+    focusContentHotkey?: string | false;
+};
+
 /**
  * @interface
  */
@@ -9117,7 +9190,7 @@ declare class LayoutModule extends Base {
      * @returns
      */
     getCurrentLayoutManagerSync: <UserSnapshotType extends OpenFin.LayoutSnapshot>() => OpenFin.LayoutManager<UserSnapshotType>;
-    create: (options: OpenFin.CreateLayoutOptions) => Promise<void>;
+    create: (options: OpenFin.CreateLayoutOptions) => Promise<OpenFin.LayoutSyncApi>;
     destroy: (layoutIdentity: OpenFin.LayoutIdentity) => Promise<void>;
 }
 
@@ -9319,6 +9392,19 @@ declare type LayoutStateChangedEvent = LayoutDOMEvent & {
     type: 'layout-state-changed';
 };
 
+/**
+ * @interface
+ * Sync API returned from Layout.create() for operations that don't require IPC.
+ * Only available in the window context that owns the layout.
+ */
+declare type LayoutSyncApi = {
+    /**
+     * Updates accessibility options at runtime without recreating the layout.
+     * @param options Partial accessibility options to merge with existing options
+     */
+    updateAccessibilityOptions(options: Partial<LayoutAccessibilityOptions>): void;
+};
+
 /**
  * @interface
  */
@@ -10832,6 +10918,15 @@ declare namespace OpenFin {
         HeaderControlsContext,
         CreateLayoutOptions,
         MultiInstanceViewBehavior,
+        LayoutAccessibilityOptions,
+        ViewTabElements,
+        ViewTabAccessibilityOptions,
+        AccessibilityContext,
+        TabAriaLabelContext,
+        CloseButtonAriaLabelContext,
+        AddTabButtonAriaLabelContext,
+        AriaLabelOptions,
+        LayoutSyncApi,
         PresetLayoutOptions_2 as PresetLayoutOptions,
         ResultBehavior,
         PopupBaseBehavior,
@@ -12563,6 +12658,38 @@ declare interface PlatformProvider {
      * @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
      */
     shouldWindowPreventQuit(windowIdentity: OpenFin.Identity): Promise<boolean>;
+    /**
+     * Returns the platform's keyboard commands. Default implementation returns the manifest's
+     * `platform.commands`. Override to inject additional default commands.
+     * Called once during Platform.init; the result is cached for the lifetime
+     * of the platform.
+     *
+     * @remarks
+     * The returned commands are merged with core's built-in default commands
+     * (unless `disableDefaultCommands` is set).
+     * Overriders receive the raw manifest commands from `super` and can prepend
+     * their own defaults — returned commands override default commands by command name.
+     *
+     * @example
+     * ```js
+     * const overrideCallback = (PlatformProvider) => {
+     *     class Override extends PlatformProvider {
+     *         getKeyboardCommands() {
+     *             const manifestCommands = super.getKeyboardCommands();
+     *             const myCommands = [{ command: 'myApp.search', keys: 'Ctrl+K' }];
+     *             return [
+     *                 ...myCommands,
+     *                 ...manifestCommands
+     *             ];
+     *         }
+     *     }
+     *     return new Override();
+     * }
+     *
+     * fin.Platform.init({ overrideCallback });
+     * ```
+     */
+    getKeyboardCommands(): OpenFin.ShortcutOverride[];
     /**
      * Method that is called every time an error occurs when processing an action in the Platform Provider. It is meant to be overriden, as a means to debug Platform applications
      */
@@ -15170,13 +15297,15 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
      * * cookies: browser [cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies)
      * * localStorage: browser data that can be used across sessions ([local storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage))
      * * appcache: html5 [application cache](https://developer.mozilla.org/en-US/docs/Web/HTML/Using_the_application_cache)
+     * * windowState: clears data written for windows using `saveWindowState`; after clearing, previously saved bounds and state will not be restored until new state is written
      * @example
      * ```js
      * const clearCacheOptions = {
      *     appcache: true,
      *     cache: true,
      *     cookies: true,
-     *     localStorage: true
+     *     localStorage: true,
+     *     windowState: true
      * };
      * fin.System.clearCache(clearCacheOptions).then(() => console.log('Cache cleared')).catch(err => console.log(err));
      * ```
@@ -15201,12 +15330,16 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
      *
      * @param options - Optional configuration for what data to clear
      *
+     * @remarks Set `windowState: true` to also clear data written for windows using `saveWindowState`.
+     * After this data is cleared, previously saved bounds and state will not be restored until new state is written again.
+     *
      * @example
      * ```js
      * // Clear only cookies and localStorage for a specific origin
      * await fin.System.clearCacheData({
      *     dataTypes: ['cookies', 'localStorage'],
-     *     origins: ['http://localhost:8081']
+     *     origins: ['http://localhost:8081'],
+     *     windowState: true
      * });
      *
      * // Clear everything except for a specific origin
@@ -16786,6 +16919,13 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
 declare class SystemContentTracing extends Base {
     /**
      * Gets the currently known tracing category groups.
+     *
+     * @example
+     * ```ts
+     * const categories = await fin.System.ContentTracing.getCategories();
+     * const sorted = [...new Set(categories)].sort((a, b) => a.localeCompare(b));
+     * console.log(`Loaded ${sorted.length} tracing categories`);
+     * ```
      */
     getCategories(): Promise<string[]>;
     /**
@@ -16793,6 +16933,29 @@ declare class SystemContentTracing extends Base {
      *
      * Only one content tracing session may be active across the runtime at a time.
      * This method rejects if another identity already owns the active session.
+     *
+     * @example
+     * ```ts
+     * await fin.System.ContentTracing.startRecording({
+     *     recording_mode: 'record-as-much-as-possible',
+     *     included_categories: [
+     *         '*',
+     *         'disabled-by-default-blink.invalidation',
+     *         'disabled-by-default-cc.debug',
+     *         'disabled-by-default-viz.surface_id_flow'
+     *     ]
+     * });
+     *
+     * console.log('Content tracing started. Call stopRecording() when ready to collect the trace.');
+     * ```
+     *
+     * @example
+     * ```ts
+     * await fin.System.ContentTracing.startRecording({
+     *     categoryFilter: 'electron,blink,cc',
+     *     traceOptions: 'record-until-full,enable-sampling'
+     * });
+     * ```
      */
     startRecording(options: OpenFin.TraceConfig | OpenFin.TraceCategoriesAndOptions): Promise<void>;
     /**
@@ -16800,12 +16963,29 @@ declare class SystemContentTracing extends Base {
      *
      * The calling identity must match the identity that started the active tracing session.
      * This method rejects if tracing is not active or is owned by another identity.
+     *
+     * @example
+     * ```ts
+     * const tracePath = await fin.System.ContentTracing.stopRecording();
+     * console.log('Trace written to:', tracePath);
+     * // Load the file in chrome://tracing or https://ui.perfetto.dev/
+     * ```
      */
     stopRecording(): Promise<string>;
     /**
      * Returns the current maximum trace buffer usage across processes.
      *
      * This method is not supported on macOS and rejects on that platform.
+     *
+     * @example
+     * ```ts
+     * try {
+     *     const usage = await fin.System.ContentTracing.getTraceBufferUsage();
+     *     console.log(`Buffer usage: ${usage.percentage}% (${usage.value})`);
+     * } catch (error) {
+     *     console.warn('Trace buffer usage is not available on this platform.', error);
+     * }
+     * ```
      */
     getTraceBufferUsage(): Promise<OpenFin.TraceBufferUsage>;
 }
@@ -16928,6 +17108,17 @@ declare type SystemShutdownHandler = (shutdownEvent: {
     proceed: () => void;
 }) => void;
 
+/**
+ * @interface
+ * Context for tab aria-label functions.
+ */
+declare type TabAriaLabelContext = AccessibilityContext & {
+    title: string;
+    isActive: boolean;
+    tabIndex: number;
+    tabCount: number;
+};
+
 /**
  * Generated when a Layout Tab Component was closed.
  * @interface
@@ -18402,6 +18593,53 @@ declare interface ViewStatuses {
     viewsNotPreventingUnload: Identity_4[];
 }
 
+/**
+ * @interface
+ * Accessibility options for view tab navigation.
+ */
+declare type ViewTabAccessibilityOptions = {
+    /**
+     * Controls which elements are reachable via Tab key navigation.
+     * Uses roving tabindex pattern - only one element focusable at a time.
+     * @default ['active-tab', 'add-tab-button']
+     */
+    tabNavigation?: ViewTabElements[];
+    /**
+     * Controls which elements are navigable via Arrow keys.
+     * @default ['inactive-tab', 'active-tab', 'active-tab-close-button', 'inactive-tab-close-button', 'add-tab-button']
+     */
+    arrowNavigation?: ViewTabElements[];
+    /**
+     * Whether Delete/Backspace keys close the focused tab.
+     * @default false
+     */
+    enableDeleteKeyClose?: boolean;
+    /**
+     * Whether Home/End keys jump to first/last navigable element.
+     * @default false
+     */
+    enableHomeEndNavigation?: boolean;
+    /**
+     * Custom aria-label providers. Can be a static string or a function receiving context.
+     */
+    ariaLabels?: AriaLabelOptions;
+    /**
+     * Whether to announce tab changes via aria-live.
+     * @default true
+     */
+    announceTabChanges?: boolean;
+    /**
+     * Focus behavior when a tab is closed via keyboard.
+     * @default 'next'
+     */
+    focusOnCloseStrategy?: 'next' | 'previous' | 'active';
+};
+
+/**
+ * Elements that can be navigated in view tabs.
+ */
+declare type ViewTabElements = 'active-tab' | 'inactive-tab' | 'active-tab-close-button' | 'inactive-tab-close-button' | 'add-tab-button';
+
 /**
  * View throttling state.
  *