@openfin/remote-adapter 36.80.23 → 36.80.26

package/out/remote-adapter-alpha.d.ts

@@ -42,6 +42,15 @@ declare type Accelerator = {
     zoom: boolean;
 };
 
+/**
+ * Generated when a View is added to a layout.
+ * @interface
+ */
+declare type AddedToLayoutEvent = BaseEvent_4 & {
+    type: 'added-to-layout';
+    layoutIdentity: OpenFin.LayoutIdentity;
+};
+
 /**
  * Options to use when adding a view to a {@link TabStack}.
  *
@@ -99,7 +108,7 @@ declare type ApiInjection = DomainApiSettings;
  * Generated when a new Platform's API becomes responsive.
  * @interface
  */
-declare type ApiReadyEvent = BaseEvent & {
+declare type ApiReadyEvent = BaseEvents.BaseEvent & {
     topic: 'application';
     type: 'platform-api-ready';
 };
@@ -936,7 +945,7 @@ declare namespace ApplicationEvents {
         PropagatedApplicationEvent,
         PropagatedEventType_3 as PropagatedEventType,
         PropagatedApplicationEventType,
-        Payload_4 as Payload,
+        Payload_5 as Payload,
         ByType_3 as ByType
     }
 }
@@ -1775,7 +1784,7 @@ declare type BaseEvent_10 = Events.BaseEvents.BaseEvent;
  * A base Channel event.
  * @interface
  */
-declare type BaseEvent_2 = NamedEvent & {
+declare type BaseEvent_2 = BaseEvents.NamedEvent & {
     channelName: string;
     channelId: string;
 };
@@ -1845,6 +1854,7 @@ declare namespace BaseEvents {
         NotCloseRequested,
         PropagatedEventType,
         PropagatedEvent,
+        Payload_2 as Payload,
         EventHandler,
         BaseEvent,
         IdentityEvent,
@@ -1985,7 +1995,7 @@ declare type BrowserContentCreationRule = BaseContentCreationRule & {
  *
  * @typeParam Type String key specifying the event to extract
  */
-declare type ByType<Type extends EventType> = Payload_2<Type>;
+declare type ByType<Type extends EventType> = Payload_3<Type>;
 
 /**
  * Extracts a single event type matching the given key from the Window {@link Event} union.
@@ -1994,7 +2004,7 @@ declare type ByType<Type extends EventType> = Payload_2<Type>;
  *
  * @typeParam Type String key specifying the event to extract
  */
-declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
+declare type ByType_2<Type extends EventType_2> = Payload_4<Type>;
 
 /**
  * Extracts a single event type matching the given key from the Application {@link Event} union.
@@ -2003,7 +2013,7 @@ declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
  *
  * @typeParam Type String key specifying the event to extract
  */
-declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
+declare type ByType_3<Type extends EventType_3> = Payload_5<Type>;
 
 /**
  * Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
@@ -2012,7 +2022,7 @@ declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
  *
  * @typeParam Type String key specifying the event to extract
  */
-declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
+declare type ByType_4<Type extends EventType_4> = Payload_6<Type>;
 
 /**
  * Extracts a single event type matching the given key from the Frame {@link Event} union.
@@ -2021,7 +2031,7 @@ declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
  *
  * @typeParam Type String key specifying the event to extract
  */
-declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
+declare type ByType_5<Type extends EventType_5> = Payload_7<Type>;
 
 /**
  * Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
@@ -2030,7 +2040,7 @@ declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
  *
  * @typeParam Type String key specifying the event to extract
  */
-declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
+declare type ByType_6<Type extends EventType_6> = Payload_8<Type>;
 
 /**
  * Extracts a single event type matching the given key from the Platform {@link Event} union.
@@ -2039,7 +2049,7 @@ declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
  *
  * @typeParam Type String key specifying the event to extract
  */
-declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
+declare type ByType_7<Type extends EventType_7> = Payload_9<Type>;
 
 /**
  * Extracts a single event type matching the given key from the System {@link Event} union.
@@ -2048,7 +2058,7 @@ declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
  *
  * @typeParam Type String key specifying the event to extract
  */
-declare type ByType_8<Type extends EventType_8> = Payload_9<Type>;
+declare type ByType_8<Type extends EventType_8> = Payload_10<Type>;
 
 /**
  * Configuration for page capture.
@@ -3708,7 +3718,9 @@ declare type ConstWindowOptions = {
      */
     preloadScripts: PreloadScript[];
     /**
-     * String tag that attempts to group like-tagged renderers together. Will only be used if pages are on the same origin.
+     * String tag that attempts to group like-tagged renderers together.
+     * However, there is no guarantee that a different affinity value will create a different process, under the hood Chromium can enforce its own process management under certain circumstances.
+     * @remarks Will only be used if pages are on the same origin.
      */
     processAffinity: string;
     /**
@@ -4907,7 +4919,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
  */
 declare type Event_4 = (WebContentsEvents.Event<'view'> & {
     target: OpenFin.Identity;
-}) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
+}) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent | AddedToLayoutEvent | RemovedFromLayoutEvent;
 
 /**
  *  [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
@@ -4956,9 +4968,7 @@ declare class EventAggregator extends EmitterMap {
  * @remarks Selects the correct type for the event
  * payload from the provided union based on the provided string literal type.
  */
-declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload: Extract<EmitterEvent, {
-    type: EventType;
-}>, ...args: any[]) => void;
+declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload: Payload_2<EmitterEvent, EventType>, ...args: any[]) => void;
 
 declare namespace Events {
     export {
@@ -5089,7 +5099,7 @@ declare namespace ExternalApplicationEvents {
         ExternalApplicationEvent,
         EventType_4 as EventType,
         ExternalApplicationEventType,
-        Payload_5 as Payload,
+        Payload_6 as Payload,
         ByType_4 as ByType
     }
 }
@@ -5533,7 +5543,7 @@ declare namespace FrameEvents {
         FrameEvent,
         EventType_5 as EventType,
         FrameEventType,
-        Payload_6 as Payload,
+        Payload_7 as Payload,
         ByType_5 as ByType
     }
 }
@@ -5775,7 +5785,7 @@ declare namespace GlobalHotkeyEvents {
         GlobalHotkeyEvent,
         EventType_6 as EventType,
         GlobalHotkeyEventType,
-        Payload_7 as Payload,
+        Payload_8 as Payload,
         ByType_6 as ByType
     }
 }
@@ -9571,76 +9581,100 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
 };
 
 /**
- * Extracts a single event type matching the given key from the View {@link Event} union.
+ * Extracts a single event type matching the given key from the System {@link Event} union.
+ *
+ * @see {@link ByType}
  *
  * @typeParam Type String key specifying the event to extract
  */
-declare type Payload_2<Type extends EventType> = Extract<Event_4, {
-    type: Type;
+declare type Payload_10<Type extends EventType_8> = BaseEvents.Payload<Event_11, Type>;
+
+/**
+ * Extracts a single event type matching the given type key from the provided EmitterEvent union.
+ *
+ * @remarks Each event emitter namespace defines its own reduction of this type that fixes the Event parameter to
+ * the appropriate payload union for that namespace.
+ *
+ * @typeParam Event Union of payloads for events on the given emitter
+ * @see {@link ByType}
+ *
+ * @typeParam Type String key specifying the event to extract from the union
+ *
+ * @see {@link OpenFin.Events.ApplicationEvents.Payload}
+ * @see {@link OpenFin.Events.ExternalApplicationEvents.Payload}
+ * @see {@link OpenFin.Events.FrameEvents.Payload}
+ * @see {@link OpenFin.Events.GlobalHotkeyEvents.Payload}
+ * @see {@link OpenFin.Events.PlatformEvents.Payload}
+ * @see {@link OpenFin.Events.SystemEvents.Payload}
+ * @see {@link OpenFin.Events.ViewEvents.Payload}
+ * @see {@link OpenFin.Events.WindowEvents.Payload}
+ */
+declare type Payload_2<Event extends BaseEvent, EventType extends string> = Extract<Event, {
+    type: EventType;
 }>;
 
+/**
+ * Extracts a single event type matching the given key from the View {@link Event} union.
+ *
+ * @see {@link ByType}
+ *
+ * @typeParam Type String key specifying the event to extract
+ */
+declare type Payload_3<Type extends EventType> = BaseEvents.Payload<Event_4, Type>;
+
 /**
  * Extracts a single event type matching the given key from the Window {@link Event} union.
  *
+ * @see {@link ByType}
+ *
  * @typeParam Type String key specifying the event to extract
  */
-declare type Payload_3<Type extends EventType_2> = Extract<Event_6, {
-    type: Type;
-}>;
+declare type Payload_4<Type extends EventType_2> = BaseEvents.Payload<Event_6, Type>;
 
 /**
  * Extracts a single event type matching the given key from the Application {@link Event} union.
  *
+ * @see {@link ByType}
+ *
  * @typeParam Type String key specifying the event to extract
  */
-declare type Payload_4<Type extends EventType_3> = Extract<Event_3, {
-    type: Type;
-}>;
+declare type Payload_5<Type extends EventType_3> = BaseEvents.Payload<Event_3, Type>;
 
 /**
  * Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
  *
+ * @see {@link ByType}
+ *
  * @typeParam Type String key specifying the event to extract
  */
-declare type Payload_5<Type extends EventType_4> = Extract<Event_7, {
-    type: Type;
-}>;
+declare type Payload_6<Type extends EventType_4> = BaseEvents.Payload<Event_7, Type>;
 
 /**
  * Extracts a single event type matching the given key from the Frame {@link Event} union.
  *
+ * @see {@link ByType}
+ *
  * @typeParam Type String key specifying the event to extract
  */
-declare type Payload_6<Type extends EventType_5> = Extract<Event_8, {
-    type: Type;
-}>;
+declare type Payload_7<Type extends EventType_5> = BaseEvents.Payload<Event_8, Type>;
 
 /**
  * Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
  *
+ * @see {@link ByType}
+ *
  * @typeParam Type String key specifying the event to extract
  */
-declare type Payload_7<Type extends EventType_6> = Extract<Event_9, {
-    type: Type;
-}>;
+declare type Payload_8<Type extends EventType_6> = BaseEvents.Payload<Event_9, Type>;
 
 /**
  * Extracts a single event type matching the given key from the Platform {@link Event} union.
  *
- * @typeParam Type String key specifying the event to extract
- */
-declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
-    type: Type;
-}>;
-
-/**
- * Extracts a single event type matching the given key from the System {@link Event} union.
+ * @see {@link ByType}
  *
  * @typeParam Type String key specifying the event to extract
  */
-declare type Payload_9<Type extends EventType_8> = Extract<Event_11, {
-    type: Type;
-}>;
+declare type Payload_9<Type extends EventType_7> = BaseEvents.Payload<Event_10, Type>;
 
 declare type PayloadTypeByStrategy<T extends ChannelStrategy<unknown>> = T extends ChannelStrategy<infer U> ? U : never;
 
@@ -10304,7 +10338,7 @@ declare namespace PlatformEvents {
         PlatformEvent,
         EventType_7 as EventType,
         PlatformEventType,
-        Payload_8 as Payload,
+        Payload_9 as Payload,
         ByType_7 as ByType
     }
 }
@@ -11975,6 +12009,15 @@ declare interface RemoteConfig extends ExistingConnectConfig {
     token: string;
 }
 
+/**
+ * Generated when a View is removed from a layout.
+ * @interface
+ */
+declare type RemovedFromLayoutEvent = BaseEvent_4 & {
+    type: 'removed-from-layout';
+    layoutIdentity: OpenFin.LayoutIdentity;
+};
+
 /**
  * @interface
  */
@@ -12617,7 +12660,7 @@ declare type Snapshot = {
  * _Note_ - In the case of using a custom provider, if a window has a layout property but does not call _Layout.init_ this event may not fire.
  * @interface
  */
-declare type SnapshotAppliedEvent = BaseEvent & {
+declare type SnapshotAppliedEvent = BaseEvents.BaseEvent & {
     topic: 'application';
     type: 'platform-snapshot-applied';
 };
@@ -14223,7 +14266,7 @@ declare namespace SystemEvents {
         SystemEvent,
         EventType_8 as EventType,
         SystemEventType,
-        Payload_9 as Payload,
+        Payload_10 as Payload,
         ByType_8 as ByType
     }
 }
@@ -15229,6 +15272,8 @@ declare namespace ViewEvents {
         BaseEvent_4 as BaseEvent,
         BaseViewEvent,
         TargetChangedEvent,
+        AddedToLayoutEvent,
+        RemovedFromLayoutEvent,
         NonPropagatedViewEvent,
         CreatedEvent,
         DestroyedEvent,
@@ -15245,7 +15290,7 @@ declare namespace ViewEvents {
         PropagatedViewEvent,
         PropagatedEventType_2 as PropagatedEventType,
         PropagatedViewEventType,
-        Payload_2 as Payload,
+        Payload_3 as Payload,
         ByType
     }
 }
@@ -17721,7 +17766,7 @@ declare namespace WindowEvents {
         PropagatedEvent_3 as PropagatedEvent,
         PropagatedWindowEvent,
         PropagatedWindowEventType,
-        Payload_3 as Payload,
+        Payload_4 as Payload,
         ByType_2 as ByType
     }
 }