@openfin/node-adapter 36.80.23 → 36.80.26

package/out/node-adapter.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';
 };
@@ -942,7 +951,7 @@ declare namespace ApplicationEvents {
         PropagatedApplicationEvent,
         PropagatedEventType_3 as PropagatedEventType,
         PropagatedApplicationEventType,
-        Payload_4 as Payload,
+        Payload_5 as Payload,
         ByType_3 as ByType
     }
 }
@@ -1807,7 +1816,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;
 };
@@ -1877,6 +1886,7 @@ declare namespace BaseEvents {
         NotCloseRequested,
         PropagatedEventType,
         PropagatedEvent,
+        Payload_2 as Payload,
         EventHandler,
         BaseEvent,
         IdentityEvent,
@@ -2017,7 +2027,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.
@@ -2026,7 +2036,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.
@@ -2035,7 +2045,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.
@@ -2044,7 +2054,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.
@@ -2053,7 +2063,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.
@@ -2062,7 +2072,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.
@@ -2071,7 +2081,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.
@@ -2080,7 +2090,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.
@@ -3743,7 +3753,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;
     /**
@@ -4947,7 +4959,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
@@ -4996,9 +5008,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 {
@@ -5150,7 +5160,7 @@ declare namespace ExternalApplicationEvents {
         ExternalApplicationEvent,
         EventType_4 as EventType,
         ExternalApplicationEventType,
-        Payload_5 as Payload,
+        Payload_6 as Payload,
         ByType_4 as ByType
     }
 }
@@ -5625,7 +5635,7 @@ declare namespace FrameEvents {
         FrameEvent,
         EventType_5 as EventType,
         FrameEventType,
-        Payload_6 as Payload,
+        Payload_7 as Payload,
         ByType_5 as ByType
     }
 }
@@ -5870,7 +5880,7 @@ declare namespace GlobalHotkeyEvents {
         GlobalHotkeyEvent,
         EventType_6 as EventType,
         GlobalHotkeyEventType,
-        Payload_7 as Payload,
+        Payload_8 as Payload,
         ByType_6 as ByType
     }
 }
@@ -9872,76 +9882,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;
 
@@ -10635,7 +10669,7 @@ declare namespace PlatformEvents {
         PlatformEvent,
         EventType_7 as EventType,
         PlatformEventType,
-        Payload_8 as Payload,
+        Payload_9 as Payload,
         ByType_7 as ByType
     }
 }
@@ -12354,6 +12388,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
  */
@@ -12996,7 +13039,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';
 };
@@ -14608,7 +14651,7 @@ declare namespace SystemEvents {
         SystemEvent,
         EventType_8 as EventType,
         SystemEventType,
-        Payload_9 as Payload,
+        Payload_10 as Payload,
         ByType_8 as ByType
     }
 }
@@ -15658,6 +15701,8 @@ declare namespace ViewEvents {
         BaseEvent_4 as BaseEvent,
         BaseViewEvent,
         TargetChangedEvent,
+        AddedToLayoutEvent,
+        RemovedFromLayoutEvent,
         NonPropagatedViewEvent,
         CreatedEvent,
         DestroyedEvent,
@@ -15674,7 +15719,7 @@ declare namespace ViewEvents {
         PropagatedViewEvent,
         PropagatedEventType_2 as PropagatedEventType,
         PropagatedViewEventType,
-        Payload_2 as Payload,
+        Payload_3 as Payload,
         ByType
     }
 }
@@ -18153,7 +18198,7 @@ declare namespace WindowEvents {
         PropagatedEvent_3 as PropagatedEvent,
         PropagatedWindowEvent,
         PropagatedWindowEventType,
-        Payload_3 as Payload,
+        Payload_4 as Payload,
         ByType_2 as ByType
     }
 }

package/out/node-adapter.js

@@ -2734,9 +2734,14 @@ function requireInstance$2 () {
 	                // don't expose
 	            });
 	            const layoutWindow = await this.getCurrentWindow();
+	            let layoutWindowIdentity = layoutWindow.identity;
+	            // TODO: CORE-1857 - when we tearout active layout or drag a view out of a window, the above identity includes the whole window info.
+	            if (layoutWindowIdentity.identity) {
+	                layoutWindowIdentity = layoutWindowIdentity.identity;
+	            }
 	            try {
 	                const providerChannelClient = await __classPrivateFieldGet(this, _View_providerChannelClient, "f").getValue();
-	                const client = await layout_entities_1.LayoutNode.newLayoutEntitiesClient(providerChannelClient, layout_constants_1.LAYOUT_CONTROLLER_ID, layoutWindow.identity);
+	                const client = await layout_entities_1.LayoutNode.newLayoutEntitiesClient(providerChannelClient, layout_constants_1.LAYOUT_CONTROLLER_ID, layoutWindowIdentity);
 	                const layoutIdentity = await client.getLayoutIdentityForViewOrThrow(this.identity);
 	                return this.fin.Platform.Layout.wrap(layoutIdentity);
 	            }
@@ -2749,7 +2754,7 @@ function requireInstance$2 () {
 	                    throw e;
 	                }
 	                // fallback logic for missing endpoint
-	                return this.fin.Platform.Layout.wrap(layoutWindow.identity);
+	                return this.fin.Platform.Layout.wrap(layoutWindowIdentity);
 	            }
 	        };
 	        /**
@@ -4634,7 +4639,7 @@ function requireInstance () {
 	            // don't expose
 	        });
 	        const opts = await this.getOptions();
-	        if (!opts.layout || !opts.layoutSnapshot) {
+	        if (!opts.layout && !opts.layoutSnapshot) {
 	            throw new Error('Window does not have a Layout');
 	        }
 	        return this.fin.Platform.Layout.wrap(layoutIdentity ?? this.identity);
@@ -16872,6 +16877,8 @@ var application = {};
  * For example, a view's "attached" event will fire as 'window-view-attached' at the application level.
  *
  * Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
+ * Events gain metadata as they propagate, which is *not* present on the explicit payload interfaces.  To refer to the full type
+ * of an event as it would be raised on this emitter, use {@link Payload}.
  *
  * This namespace contains only payload shapes for events that are unique to `Application`.  Events that propagate to `Application` from
  * child {@link OpenFin.Window windows} and {@link OpenFin.View views} are defined in the {@link OpenFin.WindowEvents} and
@@ -16903,6 +16910,8 @@ var externalApplication = {};
  * Namespace for events that can be transmitted by an {@link OpenFin.ExternalApplication}.
  *
  * Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
+ * Events gain metadata as they propagate, which is *not* present on the explicit payload interfaces.  To refer to the full type
+ * of an event as it would be raised on this emitter, use {@link Payload}.
  *
  * For a list of valid string keys for external application events, see {@link ExternalApplication.on ExternalApplication.on}.
  *
@@ -16921,6 +16930,8 @@ var globalHotkey = {};
  * Namespace for events that can be transmitted by {@link GlobalHotkey.GlobalHotkey}.
  *
  * Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
+ * Events gain metadata as they propagate, which is *not* present on the explicit payload interfaces.  To refer to the full type
+ * of an event as it would be raised on this emitter, use {@link Payload}.
  *
  * For a list of valid string keys for global hotkey events, see {@link GlobalHotkey.GlobalHotkey.on GlobalHotkey.on}.
  *
@@ -16935,6 +16946,8 @@ var platform = {};
  * Namespace for events that can emitted by a {@link OpenFin.Platform}.
  *
  * Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
+ * Events gain metadata as they propagate, which is *not* present on the explicit payload interfaces.  To refer to the full type
+ * of an event as it would be raised on this emitter, use {@link Payload}.
  *
  * The Platform `EventEmitter` is a superset of the {@link OpenFin.Application} `EventEmitter`,
  * meaning it can listen to all {@link OpenFin.ApplicationEvents Application events} in addition to the
@@ -16956,6 +16969,8 @@ var system = {};
  * will be visible as 'view-shown' at the system level, but *not* as `application-window-view-shown`.
  *
  * Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
+ * Events gain metadata as they propagate, which is *not* present on the explicit payload interfaces.  To refer to the full type
+ * of an event as it would be raised on this emitter, use {@link Payload}.
  *
  * This namespace contains only payload shapes for events that are unique to `System`.  Events that propagate to `System` from
  * child {@link OpenFin.Application applications}, {@link OpenFin.Window windows}, and {@link OpenFin.View views} are defined in the
@@ -16972,6 +16987,8 @@ var view = {};
  * Namespace for events that can be emitted by a {@link OpenFin.View}.
  *
  * Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
+ * Events gain metadata as they propagate, which is *not* present on the explicit payload interfaces.  To refer to the full type
+ * of an event as it would be raised on this emitter, use {@link Payload}.
  *
  * This namespace contains only payload shapes for events that are unique to `View`.  Events that are shared between all `WebContents`
  * (i.e. {@link OpenFin.Window}, {@link OpenFin.View}) are defined in {@link OpenFin.WebContentsEvents}.  For a list
@@ -17003,6 +17020,8 @@ var window$1 = {};
  * Namespace for events that can be emitted by a {@link OpenFin.Window}.
  *
  * Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
+ * Events gain metadata as they propagate, which is *not* present on the explicit payload interfaces.  To refer to the full type
+ * of an event as it would be raised on this emitter, use {@link Payload}.
  *
  * This namespace contains only payload shapes for events that are unique to `Window`.  Events that are shared between all `WebContents`
  * (i.e. {@link OpenFin.Window}, {@link OpenFin.View}) are defined in {@link OpenFin.WebContentsEvents}. Events that

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/node-adapter",
-    "version": "36.80.23",
+    "version": "36.80.26",
     "description": "See README.md",
     "main": "out/node-adapter.js",
     "types": "out/node-adapter.d.ts",
@@ -26,7 +26,7 @@
         "typescript": "4.9.5"
     },
     "dependencies": {
-        "@types/node": "^16.0.0",
+        "@types/node": "^20.14.2",
         "openfin-adapter": "file:../../../js-adapter",
         "lodash": "^4.17.21",
         "ws": "^7.3.0"