@openfin/fdc3-api 41.100.106 → 41.100.108

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

@@ -1827,10 +1827,6 @@ declare type BaseLoadFailedEvent = NamedEvent & {
     isMainFrame: boolean;
 };
 
-declare type BaseStructuredContentBehavior = {
-    behavior: BaseContentBehavior;
-};
-
 declare type BaseUrlEvent = NamedEvent & {
     type: 'url-changed';
     url: string;
@@ -1931,11 +1927,15 @@ declare type BoundsDidChangeEvent = BoundsChangeEvent & {
 
 declare type BoundsEvent = BaseEvent_5 & OpenFin.Bounds;
 
+/**
+ * Opens matched URLs in the browser.
+ *
+ * @interface
+ */
 declare type BrowserContentBehavior = {
     behavior: 'browser';
     /**
-     * Additional property that can be specified when setting the behavior to browser.
-     * When set to true will close the Window or View that tried to navigate or redirect to the blocked URL.
+     * When true, closes the window or view that initiated the navigation.
      */
     closeExisting?: boolean;
 };
@@ -3246,6 +3246,7 @@ declare type ClipboardPasteBlockedEvent = NamedEvent & {
 
 /**
  * Clipboard Permissions
+ * @interface
  */
 declare type ClipboardPermissions = {
     copy?: CopyPermissions;
@@ -3805,7 +3806,7 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
 };
 
 /**
- * Sets the behavior for when a Window or View navigates or redirects to a matching URL
+ * Behavior when displaying content from matched URLs.
  *
  * 'allow': The content url is allowed.
  * 'block': The content url is blocked.
@@ -4042,6 +4043,7 @@ declare type CopyBlockedEventReason = 'disabled';
 
 /**
  * Control copy operations for a matched URL.
+ * @interface
  */
 declare type CopyPermissions = {
     /**
@@ -4294,6 +4296,7 @@ declare type DefaultDomainSettings = DomainSettings;
 
 /**
  * @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
+ * @interface
  */
 declare type DefaultDomainSettingsRule = DomainSettingsRule;
 
@@ -4497,9 +4500,8 @@ declare type DomainSettings = {
 };
 
 /**
- * @interface
- *
  * Defines domain-conditional settings for an OpenFin application.
+ * @interface
  */
 declare type DomainSettingsRule = {
     /**
@@ -4636,12 +4638,6 @@ declare type Dpi = {
     vertical?: number;
 };
 
-/**
- * @interface
- * Controls whether HTML5 dragging for this content is allowed or blocked.
- */
-declare type DragBehavior = 'allow' | 'block';
-
 /**
  * Generated when a window has been embedded.
  * @interface
@@ -5810,6 +5806,7 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
  * Domain-conditional rules for file downloads.
  *
  * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
+ * @interface
  */
 declare type FileDownloadSettings = {
     /**
@@ -10017,13 +10014,11 @@ declare namespace OpenFin {
         DomainApiSettings,
         BaseContentBehavior,
         ContentBehavior,
-        BaseStructuredContentBehavior,
         BrowserContentBehavior,
         StructuredContentBehavior,
         StructuredContentPermissions,
         ContentPermission,
         ScreenCaptureBehavior,
-        DragBehavior,
         PerDomainSettings,
         CopyPermissions,
         PastePermissions,
@@ -10216,6 +10211,7 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
 
 /**
  * Control copy operations for a matched URL.
+ * @interface
  */
 declare type PastePermissions = {
     /**
@@ -10381,11 +10377,17 @@ declare type PerDomainSettings = {
          * {@inheritdoc ClipboardPermissions}
          */
         clipboard?: ClipboardPermissions;
+        /**
+         * Whether the content can be printed.
+         * Defaults to 'allow'.
+         * Disables the `print` option in the context menu, and prevents printing via both OpenFin and browser APIs.
+         */
+        print?: 'allow' | 'block';
+        /**
+         * * Controls whether HTML5 dragging for this content is allowed or blocked.
+         */
+        drag?: 'allow' | 'block';
     };
-    /**
-     * * Controls whether HTML5 dragging for this content is allowed or blocked.
-     */
-    drag?: DragBehavior;
 };
 
 /**
@@ -11780,6 +11782,14 @@ declare interface PlatformProvider {
      * ```
      */
     handleFailedViewCreation(viewIdentity: OpenFin.Identity, error: Error): Promise<OpenFin.ViewCreationSuccess | void>;
+    /**
+     * Determines whether a given window should prevent the application from quitting when it is closed.
+     * This method is called when checking if closing a window should trigger application termination.
+     *
+     * @param windowIdentity - The identity of the window being checked.
+     * @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
+     */
+    shouldWindowPreventQuit(windowIdentity: OpenFin.Identity): Promise<boolean>;
 }
 
 /**
@@ -13570,7 +13580,6 @@ declare type RvmLaunchOptions = {
 };
 
 /**
- * @interface
  * Controls whether this content should be allowed or blocked when capturing the screen.
  */
 declare type ScreenCaptureBehavior = 'allow' | 'block';
@@ -14062,12 +14071,15 @@ declare type StartedEvent = BaseEvents.IdentityEvent & {
 };
 
 /**
- * Allows more control over content behaviors
+ * Behavior when displaying content from matched URLs.
  */
-declare type StructuredContentBehavior = BaseStructuredContentBehavior | BrowserContentBehavior;
+declare type StructuredContentBehavior = {
+    behavior: BaseContentBehavior;
+} | BrowserContentBehavior;
 
 /**
- * Specify rules for specific actions.
+ * Behavior when displaying content from matched URLs. Varies depending on type of navigation.
+ * @interface
  */
 declare type StructuredContentPermissions = {
     /**

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

@@ -1827,10 +1827,6 @@ declare type BaseLoadFailedEvent = NamedEvent & {
     isMainFrame: boolean;
 };
 
-declare type BaseStructuredContentBehavior = {
-    behavior: BaseContentBehavior;
-};
-
 declare type BaseUrlEvent = NamedEvent & {
     type: 'url-changed';
     url: string;
@@ -1931,11 +1927,15 @@ declare type BoundsDidChangeEvent = BoundsChangeEvent & {
 
 declare type BoundsEvent = BaseEvent_5 & OpenFin.Bounds;
 
+/**
+ * Opens matched URLs in the browser.
+ *
+ * @interface
+ */
 declare type BrowserContentBehavior = {
     behavior: 'browser';
     /**
-     * Additional property that can be specified when setting the behavior to browser.
-     * When set to true will close the Window or View that tried to navigate or redirect to the blocked URL.
+     * When true, closes the window or view that initiated the navigation.
      */
     closeExisting?: boolean;
 };
@@ -3246,6 +3246,7 @@ declare type ClipboardPasteBlockedEvent = NamedEvent & {
 
 /**
  * Clipboard Permissions
+ * @interface
  */
 declare type ClipboardPermissions = {
     copy?: CopyPermissions;
@@ -3805,7 +3806,7 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
 };
 
 /**
- * Sets the behavior for when a Window or View navigates or redirects to a matching URL
+ * Behavior when displaying content from matched URLs.
  *
  * 'allow': The content url is allowed.
  * 'block': The content url is blocked.
@@ -4042,6 +4043,7 @@ declare type CopyBlockedEventReason = 'disabled';
 
 /**
  * Control copy operations for a matched URL.
+ * @interface
  */
 declare type CopyPermissions = {
     /**
@@ -4294,6 +4296,7 @@ declare type DefaultDomainSettings = DomainSettings;
 
 /**
  * @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
+ * @interface
  */
 declare type DefaultDomainSettingsRule = DomainSettingsRule;
 
@@ -4497,9 +4500,8 @@ declare type DomainSettings = {
 };
 
 /**
- * @interface
- *
  * Defines domain-conditional settings for an OpenFin application.
+ * @interface
  */
 declare type DomainSettingsRule = {
     /**
@@ -4636,12 +4638,6 @@ declare type Dpi = {
     vertical?: number;
 };
 
-/**
- * @interface
- * Controls whether HTML5 dragging for this content is allowed or blocked.
- */
-declare type DragBehavior = 'allow' | 'block';
-
 /**
  * Generated when a window has been embedded.
  * @interface
@@ -5810,6 +5806,7 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
  * Domain-conditional rules for file downloads.
  *
  * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
+ * @interface
  */
 declare type FileDownloadSettings = {
     /**
@@ -10017,13 +10014,11 @@ declare namespace OpenFin {
         DomainApiSettings,
         BaseContentBehavior,
         ContentBehavior,
-        BaseStructuredContentBehavior,
         BrowserContentBehavior,
         StructuredContentBehavior,
         StructuredContentPermissions,
         ContentPermission,
         ScreenCaptureBehavior,
-        DragBehavior,
         PerDomainSettings,
         CopyPermissions,
         PastePermissions,
@@ -10216,6 +10211,7 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
 
 /**
  * Control copy operations for a matched URL.
+ * @interface
  */
 declare type PastePermissions = {
     /**
@@ -10381,11 +10377,17 @@ declare type PerDomainSettings = {
          * {@inheritdoc ClipboardPermissions}
          */
         clipboard?: ClipboardPermissions;
+        /**
+         * Whether the content can be printed.
+         * Defaults to 'allow'.
+         * Disables the `print` option in the context menu, and prevents printing via both OpenFin and browser APIs.
+         */
+        print?: 'allow' | 'block';
+        /**
+         * * Controls whether HTML5 dragging for this content is allowed or blocked.
+         */
+        drag?: 'allow' | 'block';
     };
-    /**
-     * * Controls whether HTML5 dragging for this content is allowed or blocked.
-     */
-    drag?: DragBehavior;
 };
 
 /**
@@ -11780,6 +11782,14 @@ declare interface PlatformProvider {
      * ```
      */
     handleFailedViewCreation(viewIdentity: OpenFin.Identity, error: Error): Promise<OpenFin.ViewCreationSuccess | void>;
+    /**
+     * Determines whether a given window should prevent the application from quitting when it is closed.
+     * This method is called when checking if closing a window should trigger application termination.
+     *
+     * @param windowIdentity - The identity of the window being checked.
+     * @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
+     */
+    shouldWindowPreventQuit(windowIdentity: OpenFin.Identity): Promise<boolean>;
 }
 
 /**
@@ -13570,7 +13580,6 @@ declare type RvmLaunchOptions = {
 };
 
 /**
- * @interface
  * Controls whether this content should be allowed or blocked when capturing the screen.
  */
 declare type ScreenCaptureBehavior = 'allow' | 'block';
@@ -14062,12 +14071,15 @@ declare type StartedEvent = BaseEvents.IdentityEvent & {
 };
 
 /**
- * Allows more control over content behaviors
+ * Behavior when displaying content from matched URLs.
  */
-declare type StructuredContentBehavior = BaseStructuredContentBehavior | BrowserContentBehavior;
+declare type StructuredContentBehavior = {
+    behavior: BaseContentBehavior;
+} | BrowserContentBehavior;
 
 /**
- * Specify rules for specific actions.
+ * Behavior when displaying content from matched URLs. Varies depending on type of navigation.
+ * @interface
  */
 declare type StructuredContentPermissions = {
     /**

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

@@ -1827,10 +1827,6 @@ declare type BaseLoadFailedEvent = NamedEvent & {
     isMainFrame: boolean;
 };
 
-declare type BaseStructuredContentBehavior = {
-    behavior: BaseContentBehavior;
-};
-
 declare type BaseUrlEvent = NamedEvent & {
     type: 'url-changed';
     url: string;
@@ -1931,11 +1927,15 @@ declare type BoundsDidChangeEvent = BoundsChangeEvent & {
 
 declare type BoundsEvent = BaseEvent_5 & OpenFin.Bounds;
 
+/**
+ * Opens matched URLs in the browser.
+ *
+ * @interface
+ */
 declare type BrowserContentBehavior = {
     behavior: 'browser';
     /**
-     * Additional property that can be specified when setting the behavior to browser.
-     * When set to true will close the Window or View that tried to navigate or redirect to the blocked URL.
+     * When true, closes the window or view that initiated the navigation.
      */
     closeExisting?: boolean;
 };
@@ -3246,6 +3246,7 @@ declare type ClipboardPasteBlockedEvent = NamedEvent & {
 
 /**
  * Clipboard Permissions
+ * @interface
  */
 declare type ClipboardPermissions = {
     copy?: CopyPermissions;
@@ -3805,7 +3806,7 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
 };
 
 /**
- * Sets the behavior for when a Window or View navigates or redirects to a matching URL
+ * Behavior when displaying content from matched URLs.
  *
  * 'allow': The content url is allowed.
  * 'block': The content url is blocked.
@@ -4042,6 +4043,7 @@ declare type CopyBlockedEventReason = 'disabled';
 
 /**
  * Control copy operations for a matched URL.
+ * @interface
  */
 declare type CopyPermissions = {
     /**
@@ -4294,6 +4296,7 @@ declare type DefaultDomainSettings = DomainSettings;
 
 /**
  * @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
+ * @interface
  */
 declare type DefaultDomainSettingsRule = DomainSettingsRule;
 
@@ -4497,9 +4500,8 @@ declare type DomainSettings = {
 };
 
 /**
- * @interface
- *
  * Defines domain-conditional settings for an OpenFin application.
+ * @interface
  */
 declare type DomainSettingsRule = {
     /**
@@ -4636,12 +4638,6 @@ declare type Dpi = {
     vertical?: number;
 };
 
-/**
- * @interface
- * Controls whether HTML5 dragging for this content is allowed or blocked.
- */
-declare type DragBehavior = 'allow' | 'block';
-
 /**
  * Generated when a window has been embedded.
  * @interface
@@ -5810,6 +5806,7 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
  * Domain-conditional rules for file downloads.
  *
  * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
+ * @interface
  */
 declare type FileDownloadSettings = {
     /**
@@ -10017,13 +10014,11 @@ declare namespace OpenFin {
         DomainApiSettings,
         BaseContentBehavior,
         ContentBehavior,
-        BaseStructuredContentBehavior,
         BrowserContentBehavior,
         StructuredContentBehavior,
         StructuredContentPermissions,
         ContentPermission,
         ScreenCaptureBehavior,
-        DragBehavior,
         PerDomainSettings,
         CopyPermissions,
         PastePermissions,
@@ -10216,6 +10211,7 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
 
 /**
  * Control copy operations for a matched URL.
+ * @interface
  */
 declare type PastePermissions = {
     /**
@@ -10381,11 +10377,17 @@ declare type PerDomainSettings = {
          * {@inheritdoc ClipboardPermissions}
          */
         clipboard?: ClipboardPermissions;
+        /**
+         * Whether the content can be printed.
+         * Defaults to 'allow'.
+         * Disables the `print` option in the context menu, and prevents printing via both OpenFin and browser APIs.
+         */
+        print?: 'allow' | 'block';
+        /**
+         * * Controls whether HTML5 dragging for this content is allowed or blocked.
+         */
+        drag?: 'allow' | 'block';
     };
-    /**
-     * * Controls whether HTML5 dragging for this content is allowed or blocked.
-     */
-    drag?: DragBehavior;
 };
 
 /**
@@ -11780,6 +11782,14 @@ declare interface PlatformProvider {
      * ```
      */
     handleFailedViewCreation(viewIdentity: OpenFin.Identity, error: Error): Promise<OpenFin.ViewCreationSuccess | void>;
+    /**
+     * Determines whether a given window should prevent the application from quitting when it is closed.
+     * This method is called when checking if closing a window should trigger application termination.
+     *
+     * @param windowIdentity - The identity of the window being checked.
+     * @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
+     */
+    shouldWindowPreventQuit(windowIdentity: OpenFin.Identity): Promise<boolean>;
 }
 
 /**
@@ -13570,7 +13580,6 @@ declare type RvmLaunchOptions = {
 };
 
 /**
- * @interface
  * Controls whether this content should be allowed or blocked when capturing the screen.
  */
 declare type ScreenCaptureBehavior = 'allow' | 'block';
@@ -14062,12 +14071,15 @@ declare type StartedEvent = BaseEvents.IdentityEvent & {
 };
 
 /**
- * Allows more control over content behaviors
+ * Behavior when displaying content from matched URLs.
  */
-declare type StructuredContentBehavior = BaseStructuredContentBehavior | BrowserContentBehavior;
+declare type StructuredContentBehavior = {
+    behavior: BaseContentBehavior;
+} | BrowserContentBehavior;
 
 /**
- * Specify rules for specific actions.
+ * Behavior when displaying content from matched URLs. Varies depending on type of navigation.
+ * @interface
  */
 declare type StructuredContentPermissions = {
     /**

package/out/fdc3-api.d.ts

@@ -1859,10 +1859,6 @@ declare type BaseLoadFailedEvent = NamedEvent & {
     isMainFrame: boolean;
 };
 
-declare type BaseStructuredContentBehavior = {
-    behavior: BaseContentBehavior;
-};
-
 declare type BaseUrlEvent = NamedEvent & {
     type: 'url-changed';
     url: string;
@@ -1963,11 +1959,15 @@ declare type BoundsDidChangeEvent = BoundsChangeEvent & {
 
 declare type BoundsEvent = BaseEvent_5 & OpenFin.Bounds;
 
+/**
+ * Opens matched URLs in the browser.
+ *
+ * @interface
+ */
 declare type BrowserContentBehavior = {
     behavior: 'browser';
     /**
-     * Additional property that can be specified when setting the behavior to browser.
-     * When set to true will close the Window or View that tried to navigate or redirect to the blocked URL.
+     * When true, closes the window or view that initiated the navigation.
      */
     closeExisting?: boolean;
 };
@@ -3302,6 +3302,7 @@ declare type ClipboardPasteBlockedEvent = NamedEvent & {
 
 /**
  * Clipboard Permissions
+ * @interface
  */
 declare type ClipboardPermissions = {
     copy?: CopyPermissions;
@@ -3864,7 +3865,7 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
 };
 
 /**
- * Sets the behavior for when a Window or View navigates or redirects to a matching URL
+ * Behavior when displaying content from matched URLs.
  *
  * 'allow': The content url is allowed.
  * 'block': The content url is blocked.
@@ -4101,6 +4102,7 @@ declare type CopyBlockedEventReason = 'disabled';
 
 /**
  * Control copy operations for a matched URL.
+ * @interface
  */
 declare type CopyPermissions = {
     /**
@@ -4353,6 +4355,7 @@ declare type DefaultDomainSettings = DomainSettings;
 
 /**
  * @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
+ * @interface
  */
 declare type DefaultDomainSettingsRule = DomainSettingsRule;
 
@@ -4556,9 +4559,8 @@ declare type DomainSettings = {
 };
 
 /**
- * @interface
- *
  * Defines domain-conditional settings for an OpenFin application.
+ * @interface
  */
 declare type DomainSettingsRule = {
     /**
@@ -4695,12 +4697,6 @@ declare type Dpi = {
     vertical?: number;
 };
 
-/**
- * @interface
- * Controls whether HTML5 dragging for this content is allowed or blocked.
- */
-declare type DragBehavior = 'allow' | 'block';
-
 /**
  * Generated when a window has been embedded.
  * @interface
@@ -5895,6 +5891,7 @@ declare type FileDownloadProgressEvent = FileDownloadEvent & {
  * Domain-conditional rules for file downloads.
  *
  * @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
+ * @interface
  */
 declare type FileDownloadSettings = {
     /**
@@ -10335,13 +10332,11 @@ declare namespace OpenFin {
         DomainApiSettings,
         BaseContentBehavior,
         ContentBehavior,
-        BaseStructuredContentBehavior,
         BrowserContentBehavior,
         StructuredContentBehavior,
         StructuredContentPermissions,
         ContentPermission,
         ScreenCaptureBehavior,
-        DragBehavior,
         PerDomainSettings,
         CopyPermissions,
         PastePermissions,
@@ -10534,6 +10529,7 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
 
 /**
  * Control copy operations for a matched URL.
+ * @interface
  */
 declare type PastePermissions = {
     /**
@@ -10699,11 +10695,17 @@ declare type PerDomainSettings = {
          * {@inheritdoc ClipboardPermissions}
          */
         clipboard?: ClipboardPermissions;
+        /**
+         * Whether the content can be printed.
+         * Defaults to 'allow'.
+         * Disables the `print` option in the context menu, and prevents printing via both OpenFin and browser APIs.
+         */
+        print?: 'allow' | 'block';
+        /**
+         * * Controls whether HTML5 dragging for this content is allowed or blocked.
+         */
+        drag?: 'allow' | 'block';
     };
-    /**
-     * * Controls whether HTML5 dragging for this content is allowed or blocked.
-     */
-    drag?: DragBehavior;
 };
 
 /**
@@ -12181,6 +12183,14 @@ declare interface PlatformProvider {
      * ```
      */
     handleFailedViewCreation(viewIdentity: OpenFin.Identity, error: Error): Promise<OpenFin.ViewCreationSuccess | void>;
+    /**
+     * Determines whether a given window should prevent the application from quitting when it is closed.
+     * This method is called when checking if closing a window should trigger application termination.
+     *
+     * @param windowIdentity - The identity of the window being checked.
+     * @returns A promise resolving to `true` if the window should prevent the app from quitting, otherwise `false`.
+     */
+    shouldWindowPreventQuit(windowIdentity: OpenFin.Identity): Promise<boolean>;
 }
 
 /**
@@ -13971,7 +13981,6 @@ declare type RvmLaunchOptions = {
 };
 
 /**
- * @interface
  * Controls whether this content should be allowed or blocked when capturing the screen.
  */
 declare type ScreenCaptureBehavior = 'allow' | 'block';
@@ -14466,12 +14475,15 @@ declare type StartedEvent = BaseEvents.IdentityEvent & {
 };
 
 /**
- * Allows more control over content behaviors
+ * Behavior when displaying content from matched URLs.
  */
-declare type StructuredContentBehavior = BaseStructuredContentBehavior | BrowserContentBehavior;
+declare type StructuredContentBehavior = {
+    behavior: BaseContentBehavior;
+} | BrowserContentBehavior;
 
 /**
- * Specify rules for specific actions.
+ * Behavior when displaying content from matched URLs. Varies depending on type of navigation.
+ * @interface
  */
 declare type StructuredContentPermissions = {
     /**

package/package.json

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