@openfin/core 40.102.2 → 40.103.4

package/out/mock-public.d.ts

@@ -3221,6 +3221,40 @@ declare class Clipboard_2 extends Base {
     getAvailableFormats(type?: OpenFin_2.ClipboardSelectionType): Promise<Array<string>>;
 }
 
+/**
+ * Generated when a copy operation is blocked through {@link OpenFin.DomainSettings}.
+ * @interface
+ */
+declare type ClipboardCopyBlockedEvent = NamedEvent & {
+    type: 'clipboard-copy-blocked';
+    /**
+     * URL of the Window or View that generated the event.
+     */
+    url: string;
+    reason: CopyBlockedEventReason;
+};
+
+/**
+ * Generated when a paste operation is blocked through {@link OpenFin.DomainSettings}.
+ * @interface
+ */
+declare type ClipboardPasteBlockedEvent = NamedEvent & {
+    type: 'clipboard-paste-blocked';
+    /**
+     * URL of the Window or View that generated the event.
+     */
+    url: string;
+    reason: PasteBlockedEventReason;
+};
+
+/**
+ * Clipboard Permissions
+ */
+declare type ClipboardPermissions = {
+    copy?: CopyPermissions;
+    paste?: PastePermissions;
+};
+
 /**
  * The type of clipboard to write to, can be 'clipboard' or 'selection'.
  * Defaults to 'clipboard'. Use 'selection' for linux only.
@@ -3995,6 +4029,40 @@ declare type CookieOption = {
     name: string;
 };
 
+/**
+ * Reasons for a copy operation being blocked
+ *
+ * 'disabled': Copy operation is disabled through domain-based permissions.
+ */
+declare type CopyBlockedEventReason = 'disabled';
+
+/**
+ * Control copy operations for a matched URL.
+ */
+declare type CopyPermissions = {
+    /**
+     * @defaultValue 'allowed'
+     *
+     * Controls the behavior for copy operations for a matched URL.
+     *
+     * allow: Enables all copy operations.
+     * block: Disables all copy operations.
+     * protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
+     */
+    behavior: 'allow' | 'block' | 'protect';
+    /**
+     * Additional copy operation options
+     */
+    options?: {
+        /**
+         * @defaultValue ''
+         *
+         * When setting behavior = 'protected' , this string will be pasted to other applications that do not have a matching URL instead of the original content.
+         */
+        replacementText: string;
+    };
+};
+
 /**
  * Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
  *  average of _height_ and _width_.
@@ -4850,7 +4918,7 @@ declare type Event_4 = (WebContentsEvents.Event<'view'> & {
  */
 declare type Event_5<Topic extends string> = {
     topic: Topic;
-} & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | DidStartLoadingEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent | ContentBlockedEvent | WillRedirectEvent);
+} & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | DidStartLoadingEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent | ContentBlockedEvent | WillRedirectEvent | ClipboardCopyBlockedEvent | ClipboardPasteBlockedEvent);
 
 /**
  *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Window}.  Events are
@@ -5607,11 +5675,8 @@ declare type FrameEventType = EventType_5;
 /**
  * @interface
  */
-declare type FrameInfo = {
-    name: string;
-    uuid: string;
+declare type FrameInfo = EntityInfo & {
     url: string;
-    entityType: EntityType_4;
     parent: Identity_4;
 };
 
@@ -9327,6 +9392,8 @@ declare namespace OpenFin_2 {
         ClientConnectionPayload,
         EntityInfo,
         EntityType_4 as EntityType,
+        ScreenCaptureState,
+        ScreenCapturePermission,
         Bounds,
         WindowBounds,
         GetBoundsOptions,
@@ -9547,7 +9614,11 @@ declare namespace OpenFin_2 {
         StructuredContentBehavior,
         StructuredContentPermissions,
         ContentPermission,
+        ScreenCaptureBehavior,
         PerDomainSettings,
+        CopyPermissions,
+        PastePermissions,
+        ClipboardPermissions,
         DomainSettingsRule,
         FileDownloadBehavior,
         FileDownloadBehaviorNames,
@@ -9728,6 +9799,29 @@ declare type PageTitleUpdatedEvent = NamedEvent & {
     title: string;
 };
 
+/**
+ * Reasons for a paste operation being blocked
+ *
+ * 'invalid-data': Copy protection is enabled and the pasted data is invalid.
+ * 'disabled': Copy protection is turned on and the current URL for this WebContent has been disabled through domain-based settings from accessing the copied data.
+ */
+declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
+
+/**
+ * Control copy operations for a matched URL.
+ */
+declare type PastePermissions = {
+    /**
+     * @defaultValue 'non-protected-content'
+     *
+     * Controls the behavior for paste operations for a matched URL.
+     *
+     * non-protected-content: All matching URLs will be able to paste content copied from non-protected URLs.
+     * all-content: All matching URLs will be able to paste content copied from both protected (copy.behavior = 'protect') and on-protected (copy.behavior = 'allow') URLs.
+     */
+    behavior: 'non-protected-content' | 'all-content';
+};
+
 declare type PathServeRequest = ServeRequest & {
     path: string;
 };
@@ -9871,6 +9965,16 @@ declare type PerDomainSettings = {
      * {@inheritdoc ChromiumPolicies}
      */
     chromiumPolicies?: ChromiumPolicies;
+    contentProtection?: {
+        /**
+         * {@inheritdoc ScreenCaptureBehavior}
+         */
+        screenCapture: ScreenCaptureBehavior;
+        /**
+         * {@inheritdoc ClipboardPermissions}
+         */
+        clipboard?: ClipboardPermissions;
+    };
 };
 
 /**
@@ -12521,6 +12625,10 @@ declare interface ProtocolMap extends ProtocolMapBase {
         };
         response: OpenFin_2.PopupResult;
     };
+    'get-screen-capture-permissions': {
+        request: OpenFin_2.Identity;
+        response: OpenFin_2.ScreenCapturePermission;
+    };
     'render-overlay': {
         request: {
             bounds: OpenFin_2.Bounds;
@@ -13050,6 +13158,31 @@ declare type RvmLaunchOptions = {
     subscribe?: (launch: LaunchEmitter) => void;
 };
 
+/**
+ * @interface
+ * Controls whether this content should be allowed or blocked when capturing the screen.
+ */
+declare type ScreenCaptureBehavior = 'allow' | 'block';
+
+/**
+ * Returned by getScreenCapturePermission. Includes sub-entity permission states and the resulting permission.
+ * @interface
+ */
+declare type ScreenCapturePermission = {
+    permission: ScreenCaptureBehavior;
+    permissions: ScreenCaptureState[];
+};
+
+/**
+ * screenCapture state for a given entity as defined in domain settings.
+ * @interface
+ */
+declare type ScreenCaptureState = {
+    info: EntityInfo;
+    behavior: ScreenCaptureBehavior;
+    url: string;
+};
+
 /**
  * @interface
  */
@@ -17295,6 +17428,19 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
      * {@link OpenFin.WebContentsEvents event namespace}.
      */
     showPopupWindow(options: OpenFin_2.PopupOptions): Promise<OpenFin_2.PopupResult>;
+    /**
+     *
+     * Get the screen capture permission for this content.
+     *
+     * @example
+     * ```js
+     * const { permission } = await fin.me.getScreenCapturePermission();
+     *
+     * console.log(`This content is currently ${permission}ed in screen captures.`);
+     *
+     * ```
+     */
+    getScreenCapturePermission(): Promise<OpenFin_2.ScreenCapturePermission>;
 }
 
 /**
@@ -17333,6 +17479,8 @@ declare namespace WebContentsEvents {
         FileDownloadProgressEvent,
         FileDownloadCompletedEvent,
         ContentBlockedEvent,
+        ClipboardCopyBlockedEvent,
+        ClipboardPasteBlockedEvent,
         Event_5 as Event,
         WebContentsEvent,
         WillPropagateWebContentsEvent,

package/out/stub.d.ts

@@ -3277,6 +3277,40 @@ declare class Clipboard_2 extends Base {
     getAvailableFormats(type?: OpenFin_2.ClipboardSelectionType): Promise<Array<string>>;
 }
 
+/**
+ * Generated when a copy operation is blocked through {@link OpenFin.DomainSettings}.
+ * @interface
+ */
+declare type ClipboardCopyBlockedEvent = NamedEvent & {
+    type: 'clipboard-copy-blocked';
+    /**
+     * URL of the Window or View that generated the event.
+     */
+    url: string;
+    reason: CopyBlockedEventReason;
+};
+
+/**
+ * Generated when a paste operation is blocked through {@link OpenFin.DomainSettings}.
+ * @interface
+ */
+declare type ClipboardPasteBlockedEvent = NamedEvent & {
+    type: 'clipboard-paste-blocked';
+    /**
+     * URL of the Window or View that generated the event.
+     */
+    url: string;
+    reason: PasteBlockedEventReason;
+};
+
+/**
+ * Clipboard Permissions
+ */
+declare type ClipboardPermissions = {
+    copy?: CopyPermissions;
+    paste?: PastePermissions;
+};
+
 /**
  * The type of clipboard to write to, can be 'clipboard' or 'selection'.
  * Defaults to 'clipboard'. Use 'selection' for linux only.
@@ -4054,6 +4088,40 @@ declare type CookieOption = {
     name: string;
 };
 
+/**
+ * Reasons for a copy operation being blocked
+ *
+ * 'disabled': Copy operation is disabled through domain-based permissions.
+ */
+declare type CopyBlockedEventReason = 'disabled';
+
+/**
+ * Control copy operations for a matched URL.
+ */
+declare type CopyPermissions = {
+    /**
+     * @defaultValue 'allowed'
+     *
+     * Controls the behavior for copy operations for a matched URL.
+     *
+     * allow: Enables all copy operations.
+     * block: Disables all copy operations.
+     * protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
+     */
+    behavior: 'allow' | 'block' | 'protect';
+    /**
+     * Additional copy operation options
+     */
+    options?: {
+        /**
+         * @defaultValue ''
+         *
+         * When setting behavior = 'protected' , this string will be pasted to other applications that do not have a matching URL instead of the original content.
+         */
+        replacementText: string;
+    };
+};
+
 /**
  * Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
  *  average of _height_ and _width_.
@@ -4914,7 +4982,7 @@ declare type Event_4 = (WebContentsEvents.Event<'view'> & {
  */
 declare type Event_5<Topic extends string> = {
     topic: Topic;
-} & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | DidStartLoadingEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent | ContentBlockedEvent | WillRedirectEvent);
+} & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | DidStartLoadingEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent | ContentBlockedEvent | WillRedirectEvent | ClipboardCopyBlockedEvent | ClipboardPasteBlockedEvent);
 
 /**
  *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Window}.  Events are
@@ -5695,11 +5763,8 @@ declare type FrameEventType = EventType_5;
 /**
  * @interface
  */
-declare type FrameInfo = {
-    name: string;
-    uuid: string;
+declare type FrameInfo = EntityInfo & {
     url: string;
-    entityType: EntityType_4;
     parent: Identity_4;
 };
 
@@ -9645,6 +9710,8 @@ declare namespace OpenFin_2 {
         ClientConnectionPayload,
         EntityInfo,
         EntityType_4 as EntityType,
+        ScreenCaptureState,
+        ScreenCapturePermission,
         Bounds,
         WindowBounds,
         GetBoundsOptions,
@@ -9865,7 +9932,11 @@ declare namespace OpenFin_2 {
         StructuredContentBehavior,
         StructuredContentPermissions,
         ContentPermission,
+        ScreenCaptureBehavior,
         PerDomainSettings,
+        CopyPermissions,
+        PastePermissions,
+        ClipboardPermissions,
         DomainSettingsRule,
         FileDownloadBehavior,
         FileDownloadBehaviorNames,
@@ -10046,6 +10117,29 @@ declare type PageTitleUpdatedEvent = NamedEvent & {
     title: string;
 };
 
+/**
+ * Reasons for a paste operation being blocked
+ *
+ * 'invalid-data': Copy protection is enabled and the pasted data is invalid.
+ * 'disabled': Copy protection is turned on and the current URL for this WebContent has been disabled through domain-based settings from accessing the copied data.
+ */
+declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
+
+/**
+ * Control copy operations for a matched URL.
+ */
+declare type PastePermissions = {
+    /**
+     * @defaultValue 'non-protected-content'
+     *
+     * Controls the behavior for paste operations for a matched URL.
+     *
+     * non-protected-content: All matching URLs will be able to paste content copied from non-protected URLs.
+     * all-content: All matching URLs will be able to paste content copied from both protected (copy.behavior = 'protect') and on-protected (copy.behavior = 'allow') URLs.
+     */
+    behavior: 'non-protected-content' | 'all-content';
+};
+
 declare type PathServeRequest = ServeRequest & {
     path: string;
 };
@@ -10189,6 +10283,16 @@ declare type PerDomainSettings = {
      * {@inheritdoc ChromiumPolicies}
      */
     chromiumPolicies?: ChromiumPolicies;
+    contentProtection?: {
+        /**
+         * {@inheritdoc ScreenCaptureBehavior}
+         */
+        screenCapture: ScreenCaptureBehavior;
+        /**
+         * {@inheritdoc ClipboardPermissions}
+         */
+        clipboard?: ClipboardPermissions;
+    };
 };
 
 /**
@@ -12922,6 +13026,10 @@ declare interface ProtocolMap extends ProtocolMapBase {
         };
         response: OpenFin_2.PopupResult;
     };
+    'get-screen-capture-permissions': {
+        request: OpenFin_2.Identity;
+        response: OpenFin_2.ScreenCapturePermission;
+    };
     'render-overlay': {
         request: {
             bounds: OpenFin_2.Bounds;
@@ -13451,6 +13559,31 @@ declare type RvmLaunchOptions = {
     subscribe?: (launch: LaunchEmitter) => void;
 };
 
+/**
+ * @interface
+ * Controls whether this content should be allowed or blocked when capturing the screen.
+ */
+declare type ScreenCaptureBehavior = 'allow' | 'block';
+
+/**
+ * Returned by getScreenCapturePermission. Includes sub-entity permission states and the resulting permission.
+ * @interface
+ */
+declare type ScreenCapturePermission = {
+    permission: ScreenCaptureBehavior;
+    permissions: ScreenCaptureState[];
+};
+
+/**
+ * screenCapture state for a given entity as defined in domain settings.
+ * @interface
+ */
+declare type ScreenCaptureState = {
+    info: EntityInfo;
+    behavior: ScreenCaptureBehavior;
+    url: string;
+};
+
 /**
  * @interface
  */
@@ -17746,6 +17879,19 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
      * {@link OpenFin.WebContentsEvents event namespace}.
      */
     showPopupWindow(options: OpenFin_2.PopupOptions): Promise<OpenFin_2.PopupResult>;
+    /**
+     *
+     * Get the screen capture permission for this content.
+     *
+     * @example
+     * ```js
+     * const { permission } = await fin.me.getScreenCapturePermission();
+     *
+     * console.log(`This content is currently ${permission}ed in screen captures.`);
+     *
+     * ```
+     */
+    getScreenCapturePermission(): Promise<OpenFin_2.ScreenCapturePermission>;
 }
 
 /**
@@ -17784,6 +17930,8 @@ declare namespace WebContentsEvents {
         FileDownloadProgressEvent,
         FileDownloadCompletedEvent,
         ContentBlockedEvent,
+        ClipboardCopyBlockedEvent,
+        ClipboardPasteBlockedEvent,
         Event_5 as Event,
         WebContentsEvent,
         WillPropagateWebContentsEvent,