@openfin/core 45.100.71 → 45.100.73

package/out/mock-public.d.ts

@@ -3104,6 +3104,53 @@ declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
     childOptions: OpenFin_2.WindowOptions;
 };
 
+/**
+ * End of Interop Client Events
+ */
+/**
+ * Client-side handle for the chrome-browser feature.
+ *
+ * For Chrome extension integration to be active on a window, that window must be
+ * created with `chromeBrowser: true` in its window options. There is no separate
+ * `init()` step.
+ */
+declare interface ChromeBrowser {
+    /**
+     * Extension action surface — observe and invoke installed Chrome extension actions.
+     */
+    readonly Actions: ChromeBrowserActions;
+}
+
+/**
+ * APIs for interacting with Chromium extension actions from an initialized ChromeBrowser window.
+ *
+ * @interface
+ */
+declare interface ChromeBrowserActions {
+    /**
+     * Returns the current list of extension actions with the minimal render state
+     * required to build a toolbar UI.
+     */
+    getExtensionActions(): Promise<ExtensionActionListItem[]>;
+    /**
+     * Executes the specified extension action.
+     *
+     * @remarks
+     * This may trigger an extension popup to be shown by the Runtime if the extension
+     * has a popup configured for the currently active tab.
+     */
+    invokeExtensionAction(options: ExtensionActionInvokeOptions): Promise<void>;
+    /**
+     * Hides the active extension popup, if any.
+     */
+    hideActiveExtensionPopup(): Promise<void>;
+    /**
+     * Reactive value reflecting the current extension action list.
+     * Compatible with React's `useSyncExternalStore`.
+     */
+    readonly state: Readable<ExtensionActionListItem[]>;
+}
+
 /**
  * Control behavior for Chromium policies
  *
@@ -3144,6 +3191,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;
 };
 
 /**
@@ -3186,6 +3238,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;
 };
 
 /**
@@ -5421,6 +5478,33 @@ declare type ExitCode = {
     exitCode: number;
 };
 
+/**
+ * Options for invoking an extension action.
+ *
+ * @interface
+ */
+declare type ExtensionActionInvokeOptions = {
+    extensionId: ExtensionId;
+    /** Anchor in window client coordinates (from getBoundingClientRect). */
+    anchor: Anchor;
+};
+
+/**
+ * Minimal UI model required to render a list of extension actions.
+ *
+ * @interface
+ */
+declare type ExtensionActionListItem = {
+    /** Stable ID for the extension that owns this action. */
+    extensionId: ExtensionId;
+    /** Whether to show the action button for the current context (active tab). */
+    isVisible: boolean;
+    /** Accessible label / title for the action button. */
+    title: string;
+    /** Renderer-safe icon (data URL). */
+    iconDataUrl: string;
+};
+
 declare type ExtensionEvent = SecurityRealmEvent & {
     /**
      * Runtime extension whose status has been (possibly) modified
@@ -5428,6 +5512,13 @@ declare type ExtensionEvent = SecurityRealmEvent & {
     extension: string;
 };
 
+/**
+ * Unique identifier of a Chromium extension.
+ *
+ * @interface
+ */
+declare type ExtensionId = string;
+
 /**
  * @interface
  */
@@ -5872,6 +5963,7 @@ declare interface FinApi<MeType extends OpenFin_2.EntityType> {
     readonly Interop: InteropModule;
     readonly SnapshotSource: SnapshotSourceModule;
     readonly NotificationManager: NotificationManagerModule;
+    readonly ChromeBrowser: OpenFin_2.ChromeBrowser;
     /**
      * Provides access to the OpenFin representation of the current code context (usually an entity
      * such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
@@ -10257,6 +10349,7 @@ declare namespace OpenFin_2 {
         SnapshotSource,
         SnapshotSourceModule,
         System,
+        Readable,
         LayoutEntityDefinition,
         LayoutEntityTypes,
         LayoutPosition,
@@ -10289,6 +10382,10 @@ declare namespace OpenFin_2 {
         AnchorLocation,
         Anchor,
         DownloadBubbleOptions,
+        ExtensionId,
+        ExtensionActionListItem,
+        ExtensionActionInvokeOptions,
+        ChromeBrowserActions,
         DisplayMetadata,
         LegacyWinOptionsInAppOptions,
         Snapshot,
@@ -10654,6 +10751,7 @@ declare namespace OpenFin_2 {
         InteropClientEvent,
         ClientChangedContextGroup,
         InteropClientEvents,
+        ChromeBrowser,
         ApplicationEvents,
         BaseEvents,
         ExternalApplicationEvents,
@@ -12325,6 +12423,38 @@ declare interface PlatformProvider {
      * @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
      */
     shouldWindowPreventQuit(windowIdentity: OpenFin_2.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_2.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
      */
@@ -13135,7 +13265,7 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
     }>;
     'destroy-view': IdentityCall;
     'attach-view': IdentityCall<{
-        target: OpenFin_2.Identity;
+        target: OpenFin_2.Identity | OpenFin_2.LayoutIdentity;
     }>;
     'set-view-bounds': IdentityCall<{
         bounds: OpenFin_2.Bounds;
@@ -13796,6 +13926,14 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
         };
         response: void;
     };
+    'chrome-browser-get-extension-actions': ApiCall<{}, {
+        actions: OpenFin_2.ExtensionActionListItem[];
+    }>;
+    'chrome-browser-invoke-extension-action': ApiCall<{
+        extensionId: string;
+        anchor: OpenFin_2.Anchor;
+    }, void>;
+    'chrome-browser-hide-active-extension-popup': ApiCall<{}, void>;
 };
 
 declare type ProtocolOffer = ClassicProtocolOffer | RTCProtocolOffer;
@@ -13892,6 +14030,21 @@ declare type QueryPermissionResult = {
     rawValue?: unknown;
 };
 
+/**
+ * A readonly implementation of the observable pattern.
+ * Frameworks and vanilla consumers use this to read state and subscribe to changes.
+ */
+declare interface Readable<T> {
+    /** Synchronously returns the current value. */
+    get(): T;
+    /**
+     * Subscribes to changes.
+     * @param listener A callback that is invoked when the value changes.
+     * @returns An unsubscribe function to clean up the listener.
+     */
+    subscribe(listener: () => void): () => void;
+}
+
 /**
  * @interface
  */
@@ -14932,13 +15085,15 @@ declare class System extends EmitterBase<OpenFin_2.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));
      * ```
@@ -14963,12 +15118,16 @@ declare class System extends EmitterBase<OpenFin_2.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
@@ -17426,7 +17585,7 @@ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
      * ```
      * @experimental
      */
-    attach: (target: OpenFin_2.Identity) => Promise<void>;
+    attach: (target: OpenFin_2.Identity | OpenFin_2.LayoutIdentity) => Promise<void>;
     /**
      * Destroys the current view
      *
@@ -17850,7 +18009,7 @@ declare type ViewCreationFailure = {
 declare type ViewCreationOptions = Partial<ViewOptions> & {
     name: string;
     url: string;
-    target: Identity_4;
+    target: Identity_4 | LayoutIdentity;
 };
 
 declare type ViewCreationOrReference = OpenFin_2.Identity | OpenFin_2.PlatformViewCreationOptions;

package/out/stub.d.ts

@@ -3160,6 +3160,53 @@ declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
     childOptions: OpenFin_2.WindowOptions;
 };
 
+/**
+ * End of Interop Client Events
+ */
+/**
+ * Client-side handle for the chrome-browser feature.
+ *
+ * For Chrome extension integration to be active on a window, that window must be
+ * created with `chromeBrowser: true` in its window options. There is no separate
+ * `init()` step.
+ */
+declare interface ChromeBrowser {
+    /**
+     * Extension action surface — observe and invoke installed Chrome extension actions.
+     */
+    readonly Actions: ChromeBrowserActions;
+}
+
+/**
+ * APIs for interacting with Chromium extension actions from an initialized ChromeBrowser window.
+ *
+ * @interface
+ */
+declare interface ChromeBrowserActions {
+    /**
+     * Returns the current list of extension actions with the minimal render state
+     * required to build a toolbar UI.
+     */
+    getExtensionActions(): Promise<ExtensionActionListItem[]>;
+    /**
+     * Executes the specified extension action.
+     *
+     * @remarks
+     * This may trigger an extension popup to be shown by the Runtime if the extension
+     * has a popup configured for the currently active tab.
+     */
+    invokeExtensionAction(options: ExtensionActionInvokeOptions): Promise<void>;
+    /**
+     * Hides the active extension popup, if any.
+     */
+    hideActiveExtensionPopup(): Promise<void>;
+    /**
+     * Reactive value reflecting the current extension action list.
+     * Compatible with React's `useSyncExternalStore`.
+     */
+    readonly state: Readable<ExtensionActionListItem[]>;
+}
+
 /**
  * Control behavior for Chromium policies
  *
@@ -3200,6 +3247,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;
 };
 
 /**
@@ -3242,6 +3294,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;
 };
 
 /**
@@ -5503,6 +5560,33 @@ declare type ExitCode = {
     exitCode: number;
 };
 
+/**
+ * Options for invoking an extension action.
+ *
+ * @interface
+ */
+declare type ExtensionActionInvokeOptions = {
+    extensionId: ExtensionId;
+    /** Anchor in window client coordinates (from getBoundingClientRect). */
+    anchor: Anchor;
+};
+
+/**
+ * Minimal UI model required to render a list of extension actions.
+ *
+ * @interface
+ */
+declare type ExtensionActionListItem = {
+    /** Stable ID for the extension that owns this action. */
+    extensionId: ExtensionId;
+    /** Whether to show the action button for the current context (active tab). */
+    isVisible: boolean;
+    /** Accessible label / title for the action button. */
+    title: string;
+    /** Renderer-safe icon (data URL). */
+    iconDataUrl: string;
+};
+
 declare type ExtensionEvent = SecurityRealmEvent & {
     /**
      * Runtime extension whose status has been (possibly) modified
@@ -5510,6 +5594,13 @@ declare type ExtensionEvent = SecurityRealmEvent & {
     extension: string;
 };
 
+/**
+ * Unique identifier of a Chromium extension.
+ *
+ * @interface
+ */
+declare type ExtensionId = string;
+
 /**
  * @interface
  */
@@ -5957,6 +6048,7 @@ declare interface FinApi<MeType extends OpenFin_2.EntityType> {
     readonly Interop: InteropModule;
     readonly SnapshotSource: SnapshotSourceModule;
     readonly NotificationManager: NotificationManagerModule;
+    readonly ChromeBrowser: OpenFin_2.ChromeBrowser;
     /**
      * Provides access to the OpenFin representation of the current code context (usually an entity
      * such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
@@ -10591,6 +10683,7 @@ declare namespace OpenFin_2 {
         SnapshotSource,
         SnapshotSourceModule,
         System,
+        Readable,
         LayoutEntityDefinition,
         LayoutEntityTypes,
         LayoutPosition,
@@ -10623,6 +10716,10 @@ declare namespace OpenFin_2 {
         AnchorLocation,
         Anchor,
         DownloadBubbleOptions,
+        ExtensionId,
+        ExtensionActionListItem,
+        ExtensionActionInvokeOptions,
+        ChromeBrowserActions,
         DisplayMetadata,
         LegacyWinOptionsInAppOptions,
         Snapshot,
@@ -10988,6 +11085,7 @@ declare namespace OpenFin_2 {
         InteropClientEvent,
         ClientChangedContextGroup,
         InteropClientEvents,
+        ChromeBrowser,
         ApplicationEvents,
         BaseEvents,
         ExternalApplicationEvents,
@@ -12742,6 +12840,38 @@ declare interface PlatformProvider {
      * @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
      */
     shouldWindowPreventQuit(windowIdentity: OpenFin_2.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_2.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
      */
@@ -13552,7 +13682,7 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
     }>;
     'destroy-view': IdentityCall;
     'attach-view': IdentityCall<{
-        target: OpenFin_2.Identity;
+        target: OpenFin_2.Identity | OpenFin_2.LayoutIdentity;
     }>;
     'set-view-bounds': IdentityCall<{
         bounds: OpenFin_2.Bounds;
@@ -14213,6 +14343,14 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
         };
         response: void;
     };
+    'chrome-browser-get-extension-actions': ApiCall<{}, {
+        actions: OpenFin_2.ExtensionActionListItem[];
+    }>;
+    'chrome-browser-invoke-extension-action': ApiCall<{
+        extensionId: string;
+        anchor: OpenFin_2.Anchor;
+    }, void>;
+    'chrome-browser-hide-active-extension-popup': ApiCall<{}, void>;
 };
 
 declare type ProtocolOffer = ClassicProtocolOffer | RTCProtocolOffer;
@@ -14309,6 +14447,21 @@ declare type QueryPermissionResult = {
     rawValue?: unknown;
 };
 
+/**
+ * A readonly implementation of the observable pattern.
+ * Frameworks and vanilla consumers use this to read state and subscribe to changes.
+ */
+declare interface Readable<T> {
+    /** Synchronously returns the current value. */
+    get(): T;
+    /**
+     * Subscribes to changes.
+     * @param listener A callback that is invoked when the value changes.
+     * @returns An unsubscribe function to clean up the listener.
+     */
+    subscribe(listener: () => void): () => void;
+}
+
 /**
  * @interface
  */
@@ -15355,13 +15508,15 @@ declare class System extends EmitterBase<OpenFin_2.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));
      * ```
@@ -15386,12 +15541,16 @@ declare class System extends EmitterBase<OpenFin_2.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
@@ -17859,7 +18018,7 @@ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
      * ```
      * @experimental
      */
-    attach: (target: OpenFin_2.Identity) => Promise<void>;
+    attach: (target: OpenFin_2.Identity | OpenFin_2.LayoutIdentity) => Promise<void>;
     /**
      * Destroys the current view
      *
@@ -18317,7 +18476,7 @@ declare type ViewCreationFailure = {
 declare type ViewCreationOptions = Partial<ViewOptions> & {
     name: string;
     url: string;
-    target: Identity_4;
+    target: Identity_4 | LayoutIdentity;
 };
 
 declare type ViewCreationOrReference = OpenFin_2.Identity | OpenFin_2.PlatformViewCreationOptions;