@openfin/core 41.100.28 → 41.100.30

Sign up to get free protection for your applications and to get access to all the features.
package/out/mock.d.ts CHANGED
@@ -5338,6 +5338,10 @@ declare namespace FDC3 {
5338
5338
  }
5339
5339
  }
5340
5340
 
5341
+ declare type FDC3Factory = typeof fdc3Factory;
5342
+
5343
+ declare const fdc3Factory: (version: '1.2' | '2.0', interopClient: OpenFin_2.InteropClient, wire: Transport<'unknown'>) => OpenFin_2.FDC3.v2_0.DesktopAgent | OpenFin_2.FDC3.v1_2.DesktopAgent;
5344
+
5341
5345
  /**
5342
5346
  * @interface
5343
5347
  */
@@ -5678,11 +5682,8 @@ declare type FrameEventType = EventType_5;
5678
5682
  /**
5679
5683
  * @interface
5680
5684
  */
5681
- declare type FrameInfo = {
5682
- name: string;
5683
- uuid: string;
5685
+ declare type FrameInfo = EntityInfo & {
5684
5686
  url: string;
5685
- entityType: EntityType_4;
5686
5687
  parent: Identity_4;
5687
5688
  };
5688
5689
 
@@ -6992,7 +6993,7 @@ declare class InteropBroker extends Base {
6992
6993
  };
6993
6994
  private getClientState;
6994
6995
  private static toObject;
6995
- static checkContextIntegrity(context: OpenFin_2.Context): {
6996
+ static checkContextIntegrity: (context: OpenFin_2.Context) => {
6996
6997
  isValid: true;
6997
6998
  } | {
6998
6999
  isValid: false;
@@ -7091,7 +7092,7 @@ declare class InteropClient extends Base {
7091
7092
  /**
7092
7093
  * @internal
7093
7094
  */
7094
- constructor(wire: Transport, clientPromise: Promise<OpenFin_2.ChannelClient>);
7095
+ constructor(wire: Transport, clientPromise: Promise<OpenFin_2.ChannelClient>, fdc3Factory: FDC3Factory);
7095
7096
  /**
7096
7097
  * Sets a context for the context group of the current entity.
7097
7098
  *
@@ -8032,6 +8033,24 @@ declare type LayoutComponent = Omit<LayoutItemConfig, 'content' | 'type'> & {
8032
8033
 
8033
8034
  declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent>;
8034
8035
 
8036
+ /**
8037
+ * Generated after a layout is created.
8038
+ * @interface
8039
+ */
8040
+ declare type LayoutCreatedEvent = BaseEvent_5 & {
8041
+ type: 'layout-created';
8042
+ layoutIdentity: OpenFin_2.LayoutIdentity;
8043
+ };
8044
+
8045
+ /**
8046
+ * Generated after a layout is destroyed.
8047
+ * @interface
8048
+ */
8049
+ declare type LayoutDestroyedEvent = BaseEvent_5 & {
8050
+ type: 'layout-destroyed';
8051
+ layoutIdentity: OpenFin_2.LayoutIdentity;
8052
+ };
8053
+
8035
8054
  /**
8036
8055
  * The base payload for the CustomEvent.detail property for Layout events emitted on the layout container element.
8037
8056
  */
@@ -8687,6 +8706,15 @@ declare type LayoutSnapshot = {
8687
8706
  layouts: Record<string, LayoutOptions>;
8688
8707
  };
8689
8708
 
8709
+ /**
8710
+ * Generated after a snapshot is applied.
8711
+ * @interface
8712
+ */
8713
+ declare type LayoutSnapshotAppliedEvent = BaseEvent_5 & {
8714
+ type: 'layout-snapshot-applied';
8715
+ layoutIdentity: OpenFin_2.LayoutIdentity;
8716
+ };
8717
+
8690
8718
  /**
8691
8719
  * Generated when the Layout experiences a state change, for example tabs added/removed.
8692
8720
  * @interface
@@ -9608,6 +9636,8 @@ declare namespace OpenFin_2 {
9608
9636
  ClientConnectionPayload,
9609
9637
  EntityInfo,
9610
9638
  EntityType_4 as EntityType,
9639
+ ScreenCaptureState,
9640
+ ScreenCapturePermission,
9611
9641
  Bounds,
9612
9642
  WindowBounds,
9613
9643
  Rectangle,
@@ -9827,6 +9857,7 @@ declare namespace OpenFin_2 {
9827
9857
  StructuredContentBehavior,
9828
9858
  StructuredContentPermissions,
9829
9859
  ContentPermission,
9860
+ ScreenCaptureBehavior,
9830
9861
  PerDomainSettings,
9831
9862
  DomainSettingsRule,
9832
9863
  FileDownloadBehavior,
@@ -10142,6 +10173,12 @@ declare type PerDomainSettings = {
10142
10173
  * {@inheritdoc ChromiumPolicies}
10143
10174
  */
10144
10175
  chromiumPolicies?: ChromiumPolicies;
10176
+ contentProtection?: {
10177
+ /**
10178
+ * {@inheritdoc ScreenCaptureBehavior}
10179
+ */
10180
+ screenCapture: ScreenCaptureBehavior;
10181
+ };
10145
10182
  };
10146
10183
 
10147
10184
  /**
@@ -12870,6 +12907,10 @@ declare interface ProtocolMap extends ProtocolMapBase {
12870
12907
  };
12871
12908
  response: OpenFin_2.PopupResult;
12872
12909
  };
12910
+ 'get-screen-capture-permissions': {
12911
+ request: OpenFin_2.Identity;
12912
+ response: OpenFin_2.ScreenCapturePermission;
12913
+ };
12873
12914
  'render-overlay': {
12874
12915
  request: {
12875
12916
  bounds: OpenFin_2.Bounds;
@@ -13399,6 +13440,31 @@ declare type RvmLaunchOptions = {
13399
13440
  subscribe?: (launch: LaunchEmitter) => void;
13400
13441
  };
13401
13442
 
13443
+ /**
13444
+ * @interface
13445
+ * Controls whether this content should be allowed or blocked when capturing the screen.
13446
+ */
13447
+ declare type ScreenCaptureBehavior = 'allow' | 'block';
13448
+
13449
+ /**
13450
+ * Returned by getScreenCapturePermission. Includes sub-entity permission states and the resulting permission.
13451
+ * @interface
13452
+ */
13453
+ declare type ScreenCapturePermission = {
13454
+ permission: ScreenCaptureBehavior;
13455
+ permissions: ScreenCaptureState[];
13456
+ };
13457
+
13458
+ /**
13459
+ * screenCapture state for a given entity as defined in domain settings.
13460
+ * @interface
13461
+ */
13462
+ declare type ScreenCaptureState = {
13463
+ info: EntityInfo;
13464
+ behavior: ScreenCaptureBehavior;
13465
+ url: string;
13466
+ };
13467
+
13402
13468
  /**
13403
13469
  * @interface
13404
13470
  */
@@ -17678,6 +17744,19 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
17678
17744
  * {@link OpenFin.WebContentsEvents event namespace}.
17679
17745
  */
17680
17746
  showPopupWindow(options: OpenFin_2.PopupOptions): Promise<OpenFin_2.PopupResult>;
17747
+ /**
17748
+ *
17749
+ * Get the screen capture permission for this content.
17750
+ *
17751
+ * @example
17752
+ * ```js
17753
+ * const { permission } = await fin.me.getScreenCapturePermission();
17754
+ *
17755
+ * console.log(`This content is currently ${permission}ed in screen captures.`);
17756
+ *
17757
+ * ```
17758
+ */
17759
+ getScreenCapturePermission(): Promise<OpenFin_2.ScreenCapturePermission>;
17681
17760
  }
17682
17761
 
17683
17762
  /**
@@ -18994,6 +19073,9 @@ declare namespace WindowEvents {
18994
19073
  PerformanceReportEvent,
18995
19074
  InputEvent_2 as InputEvent,
18996
19075
  LayoutInitializedEvent,
19076
+ LayoutCreatedEvent,
19077
+ LayoutDestroyedEvent,
19078
+ LayoutSnapshotAppliedEvent,
18997
19079
  LayoutReadyEvent,
18998
19080
  CloseRequestedEvent,
18999
19081
  WindowCloseRequestedEvent,
@@ -19227,7 +19309,7 @@ declare type WindowShowRequestedEvent = ShowRequestedEvent;
19227
19309
  * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
19228
19310
  * from {@link OpenFin.ViewEvents}.
19229
19311
  */
19230
- 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;
19312
+ 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;
19231
19313
 
19232
19314
  /**
19233
19315
  * Generated when a child window starts loading.