@openfin/fdc3-api 45.100.71 → 45.100.72

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

@@ -3141,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;
 };
 
 /**
@@ -3183,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;
 };
 
 /**
@@ -12665,6 +12675,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
      */
@@ -13475,7 +13517,7 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
     }>;
     'destroy-view': IdentityCall;
     'attach-view': IdentityCall<{
-        target: OpenFin.Identity;
+        target: OpenFin.Identity | OpenFin.LayoutIdentity;
     }>;
     'set-view-bounds': IdentityCall<{
         bounds: OpenFin.Bounds;
@@ -15272,13 +15314,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));
      * ```
@@ -15303,12 +15347,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
@@ -17872,7 +17920,7 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
      * ```
      * @experimental
      */
-    attach: (target: OpenFin.Identity) => Promise<void>;
+    attach: (target: OpenFin.Identity | OpenFin.LayoutIdentity) => Promise<void>;
     /**
      * Destroys the current view
      *
@@ -18296,7 +18344,7 @@ declare type ViewCreationFailure = {
 declare type ViewCreationOptions = Partial<ViewOptions> & {
     name: string;
     url: string;
-    target: Identity_4;
+    target: Identity_4 | LayoutIdentity;
 };
 
 declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCreationOptions;

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

@@ -3141,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;
 };
 
 /**
@@ -3183,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;
 };
 
 /**
@@ -12665,6 +12675,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
      */
@@ -13475,7 +13517,7 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
     }>;
     'destroy-view': IdentityCall;
     'attach-view': IdentityCall<{
-        target: OpenFin.Identity;
+        target: OpenFin.Identity | OpenFin.LayoutIdentity;
     }>;
     'set-view-bounds': IdentityCall<{
         bounds: OpenFin.Bounds;
@@ -15272,13 +15314,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));
      * ```
@@ -15303,12 +15347,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
@@ -17872,7 +17920,7 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
      * ```
      * @experimental
      */
-    attach: (target: OpenFin.Identity) => Promise<void>;
+    attach: (target: OpenFin.Identity | OpenFin.LayoutIdentity) => Promise<void>;
     /**
      * Destroys the current view
      *
@@ -18296,7 +18344,7 @@ declare type ViewCreationFailure = {
 declare type ViewCreationOptions = Partial<ViewOptions> & {
     name: string;
     url: string;
-    target: Identity_4;
+    target: Identity_4 | LayoutIdentity;
 };
 
 declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCreationOptions;

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

@@ -3141,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;
 };
 
 /**
@@ -3183,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;
 };
 
 /**
@@ -12665,6 +12675,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
      */
@@ -13475,7 +13517,7 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
     }>;
     'destroy-view': IdentityCall;
     'attach-view': IdentityCall<{
-        target: OpenFin.Identity;
+        target: OpenFin.Identity | OpenFin.LayoutIdentity;
     }>;
     'set-view-bounds': IdentityCall<{
         bounds: OpenFin.Bounds;
@@ -15272,13 +15314,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));
      * ```
@@ -15303,12 +15347,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
@@ -17872,7 +17920,7 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
      * ```
      * @experimental
      */
-    attach: (target: OpenFin.Identity) => Promise<void>;
+    attach: (target: OpenFin.Identity | OpenFin.LayoutIdentity) => Promise<void>;
     /**
      * Destroys the current view
      *
@@ -18296,7 +18344,7 @@ declare type ViewCreationFailure = {
 declare type ViewCreationOptions = Partial<ViewOptions> & {
     name: string;
     url: string;
-    target: Identity_4;
+    target: Identity_4 | LayoutIdentity;
 };
 
 declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCreationOptions;

package/out/fdc3-api.d.ts

@@ -3197,6 +3197,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;
 };
 
 /**
@@ -3239,6 +3244,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;
 };
 
 /**
@@ -13082,6 +13092,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
      */
@@ -13892,7 +13934,7 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
     }>;
     'destroy-view': IdentityCall;
     'attach-view': IdentityCall<{
-        target: OpenFin.Identity;
+        target: OpenFin.Identity | OpenFin.LayoutIdentity;
     }>;
     'set-view-bounds': IdentityCall<{
         bounds: OpenFin.Bounds;
@@ -15695,13 +15737,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));
      * ```
@@ -15726,12 +15770,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
@@ -18305,7 +18353,7 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
      * ```
      * @experimental
      */
-    attach: (target: OpenFin.Identity) => Promise<void>;
+    attach: (target: OpenFin.Identity | OpenFin.LayoutIdentity) => Promise<void>;
     /**
      * Destroys the current view
      *
@@ -18763,7 +18811,7 @@ declare type ViewCreationFailure = {
 declare type ViewCreationOptions = Partial<ViewOptions> & {
     name: string;
     url: string;
-    target: Identity_4;
+    target: Identity_4 | LayoutIdentity;
 };
 
 declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCreationOptions;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfin/fdc3-api",
-  "version": "45.100.71",
+  "version": "45.100.72",
   "description": "OpenFin fdc3 module utilities and types.",
   "license": "SEE LICENSE IN LICENSE.md",
   "private": false,