@openfin/fdc3-api 41.100.28 → 41.100.30

package/out/fdc3-api.d.ts

@@ -5335,6 +5335,10 @@ declare namespace FDC3 {
     }
 }
 
+declare type FDC3Factory = typeof fdc3Factory;
+
+declare const fdc3Factory: (version: '1.2' | '2.0', interopClient: OpenFin.InteropClient, wire: Transport<'unknown'>) => OpenFin.FDC3.v2_0.DesktopAgent | OpenFin.FDC3.v1_2.DesktopAgent;
+
 export declare function fdc3FromFin(fin: OpenFin.Fin<OpenFin.EntityType>, { fdc3Version }?: {
     fdc3Version?: Fdc3Version;
 }): Promise<Fdc3Module | Fdc3Module2>;
@@ -6020,11 +6024,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;
 };
 
@@ -7334,7 +7335,7 @@ declare class InteropBroker extends Base {
     };
     private getClientState;
     private static toObject;
-    static checkContextIntegrity(context: OpenFin.Context): {
+    static checkContextIntegrity: (context: OpenFin.Context) => {
         isValid: true;
     } | {
         isValid: false;
@@ -7433,7 +7434,7 @@ declare class InteropClient extends Base {
     /**
      * @internal
      */
-    constructor(wire: Transport, clientPromise: Promise<OpenFin.ChannelClient>);
+    constructor(wire: Transport, clientPromise: Promise<OpenFin.ChannelClient>, fdc3Factory: FDC3Factory);
     /**
      * Sets a context for the context group of the current entity.
      *
@@ -8374,6 +8375,24 @@ declare type LayoutComponent = Omit<LayoutItemConfig, 'content' | 'type'> & {
 
 declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent>;
 
+/**
+ * Generated after a layout is created.
+ * @interface
+ */
+declare type LayoutCreatedEvent = BaseEvent_5 & {
+    type: 'layout-created';
+    layoutIdentity: OpenFin.LayoutIdentity;
+};
+
+/**
+ * Generated after a layout is destroyed.
+ * @interface
+ */
+declare type LayoutDestroyedEvent = BaseEvent_5 & {
+    type: 'layout-destroyed';
+    layoutIdentity: OpenFin.LayoutIdentity;
+};
+
 /**
  * The base payload for the CustomEvent.detail property for Layout events emitted on the layout container element.
  */
@@ -9029,6 +9048,15 @@ declare type LayoutSnapshot = {
     layouts: Record<string, LayoutOptions>;
 };
 
+/**
+ * Generated after a snapshot is applied.
+ * @interface
+ */
+declare type LayoutSnapshotAppliedEvent = BaseEvent_5 & {
+    type: 'layout-snapshot-applied';
+    layoutIdentity: OpenFin.LayoutIdentity;
+};
+
 /**
  * Generated when the Layout experiences a state change, for example tabs added/removed.
  * @interface
@@ -9950,6 +9978,8 @@ declare namespace OpenFin {
         ClientConnectionPayload,
         EntityInfo,
         EntityType_4 as EntityType,
+        ScreenCaptureState,
+        ScreenCapturePermission,
         Bounds,
         WindowBounds,
         Rectangle,
@@ -10169,6 +10199,7 @@ declare namespace OpenFin {
         StructuredContentBehavior,
         StructuredContentPermissions,
         ContentPermission,
+        ScreenCaptureBehavior,
         PerDomainSettings,
         DomainSettingsRule,
         FileDownloadBehavior,
@@ -10482,6 +10513,12 @@ declare type PerDomainSettings = {
      * {@inheritdoc ChromiumPolicies}
      */
     chromiumPolicies?: ChromiumPolicies;
+    contentProtection?: {
+        /**
+         * {@inheritdoc ScreenCaptureBehavior}
+         */
+        screenCapture: ScreenCaptureBehavior;
+    };
 };
 
 /**
@@ -13210,6 +13247,10 @@ declare interface ProtocolMap extends ProtocolMapBase {
         };
         response: OpenFin.PopupResult;
     };
+    'get-screen-capture-permissions': {
+        request: OpenFin.Identity;
+        response: OpenFin.ScreenCapturePermission;
+    };
     'render-overlay': {
         request: {
             bounds: OpenFin.Bounds;
@@ -13739,6 +13780,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
  */
@@ -18124,6 +18190,19 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
      * {@link OpenFin.WebContentsEvents event namespace}.
      */
     showPopupWindow(options: OpenFin.PopupOptions): Promise<OpenFin.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.ScreenCapturePermission>;
 }
 
 /**
@@ -19440,6 +19519,9 @@ declare namespace WindowEvents {
         PerformanceReportEvent,
         InputEvent_2 as InputEvent,
         LayoutInitializedEvent,
+        LayoutCreatedEvent,
+        LayoutDestroyedEvent,
+        LayoutSnapshotAppliedEvent,
         LayoutReadyEvent,
         CloseRequestedEvent,
         WindowCloseRequestedEvent,
@@ -19673,7 +19755,7 @@ declare type WindowShowRequestedEvent = ShowRequestedEvent;
  * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
  * from {@link OpenFin.ViewEvents}.
  */
-declare type WindowSourcedEvent = WebContentsEvents.Event<'window'> | WindowViewEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | ContextChangedEvent | CloseRequestedEvent | ClosedEvent_2 | ClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | HiddenEvent_2 | HotkeyEvent_2 | InitializedEvent_2 | LayoutInitializedEvent | LayoutReadyEvent | MaximizedEvent | MinimizedEvent | OptionsChangedEvent | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | RestoredEvent | ShowRequestedEvent | ShownEvent_2 | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent;
+declare type WindowSourcedEvent = WebContentsEvents.Event<'window'> | WindowViewEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | ContextChangedEvent | CloseRequestedEvent | ClosedEvent_2 | ClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | HiddenEvent_2 | HotkeyEvent_2 | InitializedEvent_2 | LayoutInitializedEvent | LayoutReadyEvent | LayoutCreatedEvent | LayoutDestroyedEvent | LayoutSnapshotAppliedEvent | MaximizedEvent | MinimizedEvent | OptionsChangedEvent | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | RestoredEvent | ShowRequestedEvent | ShownEvent_2 | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent;
 
 /**
  * Generated when a child window starts loading.