@openfin/core 39.82.12 → 40.82.1

package/out/mock-public.d.ts

@@ -102,7 +102,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';
 };
@@ -914,7 +914,7 @@ declare namespace ApplicationEvents {
         PropagatedApplicationEvent,
         PropagatedEventType_3 as PropagatedEventType,
         PropagatedApplicationEventType,
-        Payload_4 as Payload,
+        Payload_5 as Payload,
         ByType_3 as ByType
     }
 }
@@ -1707,7 +1707,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;
 };
@@ -1777,6 +1777,7 @@ declare namespace BaseEvents {
         NotCloseRequested,
         PropagatedEventType,
         PropagatedEvent,
+        Payload_2 as Payload,
         EventHandler,
         BaseEvent,
         IdentityEvent,
@@ -1917,7 +1918,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.
@@ -1926,7 +1927,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.
@@ -1935,7 +1936,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.
@@ -1944,7 +1945,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.
@@ -1953,7 +1954,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.
@@ -1962,7 +1963,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.
@@ -1971,7 +1972,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.
@@ -1980,7 +1981,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>;
 
 /**
  * Extracts a single event type matching the given key from the Layout DOM {@link Event} union.
@@ -1989,7 +1990,7 @@ declare type ByType_8<Type extends EventType_8> = Payload_9<Type>;
  *
  * @typeParam Type String key specifying the event to extract
  */
-declare type ByType_9<Type extends EventType_9> = Payload_10<Type>;
+declare type ByType_9<Type extends EventType_9> = Payload_11<Type>;
 
 /**
  * Configuration for page capture.
@@ -4357,6 +4358,10 @@ declare type DomainSettingsRule = {
      * Settings applied when a webcontents has been navigated to a matched domain.
      */
     options: PerDomainSettings;
+    /**
+     * Options to use when comparing URIs to the `match` patterns.
+     */
+    matchOptions?: RuleMatchOptions;
 };
 
 /**
@@ -4801,9 +4806,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 {
@@ -4939,7 +4942,7 @@ declare namespace ExternalApplicationEvents {
         ExternalApplicationEvent,
         EventType_4 as EventType,
         ExternalApplicationEventType,
-        Payload_5 as Payload,
+        Payload_6 as Payload,
         ByType_4 as ByType
     }
 }
@@ -5391,7 +5394,7 @@ declare namespace FrameEvents {
         FrameEvent,
         EventType_5 as EventType,
         FrameEventType,
-        Payload_6 as Payload,
+        Payload_7 as Payload,
         ByType_5 as ByType
     }
 }
@@ -5631,7 +5634,7 @@ declare namespace GlobalHotkeyEvents {
         GlobalHotkeyEvent,
         EventType_6 as EventType,
         GlobalHotkeyEventType,
-        Payload_7 as Payload,
+        Payload_8 as Payload,
         ByType_6 as ByType
     }
 }
@@ -7711,7 +7714,7 @@ declare namespace LayoutDOMEvents {
         LayoutStateChangedEvent,
         Event_12 as Event,
         EventType_9 as EventType,
-        Payload_10 as Payload,
+        Payload_11 as Payload,
         ByType_9 as ByType
     }
 }
@@ -8898,6 +8901,10 @@ declare type NavigationRules = {
     allowlist?: string[];
     /** Forbidden URLs for navigation. */
     denylist?: string[];
+    /**
+     * Options to use when comparing URIs to the `allowlist` and `denylist` patterns.
+     */
+    matchOptions?: RuleMatchOptions;
 };
 
 declare type NewConnectConfig = ConfigWithUuid & ConfigWithRuntime;
@@ -9047,6 +9054,7 @@ declare namespace OpenFin_2 {
         Api,
         ApiSettings,
         InjectionType,
+        RuleMatchOptions,
         NavigationRules,
         ContentNavigation,
         ContentRedirect,
@@ -9367,86 +9375,110 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
     error?: Success extends false ? ErrorPlainObject | undefined : never;
 };
 
+/**
+ * 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_10<Type extends EventType_8> = BaseEvents.Payload<Event_11, Type>;
+
 /**
  * Extracts a single event type matching the given key from the Layout DOM {@link Event} union.
  *
  * @typeParam Type String key specifying the event to extract
  */
-declare type Payload_10<Type extends EventType_9> = Extract<Event_12, {
+declare type Payload_11<Type extends EventType_9> = Extract<Event_12, {
     type: 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_2<Type extends EventType> = Extract<Event_4, {
-    type: Type;
-}>;
+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>;
 
 /**
  * @interface
@@ -10141,7 +10173,7 @@ declare namespace PlatformEvents {
         PlatformEvent,
         EventType_7 as EventType,
         PlatformEventType,
-        Payload_8 as Payload,
+        Payload_9 as Payload,
         ByType_7 as ByType
     }
 }
@@ -11969,6 +12001,17 @@ declare interface RTCProtocolOffer extends ProtocolPacketBase {
     };
 }
 
+/**
+ * Controls the behavior of the navigation URI pattern matching algorithm.
+ */
+declare type RuleMatchOptions = {
+    /**
+     * Matches all schemes rather than just http and https when a wild card is specified. For example, `'*://*.site.com'` will
+     * only match urls which begin with `'http:'` or `'https:'` unless this setting is `true`.
+     */
+    matchAllSchemes?: boolean;
+};
+
 declare type RunRequestedEvent = OpenFin_2.ApplicationEvents.RunRequestedEvent;
 
 /**
@@ -12421,7 +12464,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';
 };
@@ -14026,7 +14069,7 @@ declare namespace SystemEvents {
         SystemEvent,
         EventType_8 as EventType,
         SystemEventType,
-        Payload_9 as Payload,
+        Payload_10 as Payload,
         ByType_8 as ByType
     }
 }
@@ -15047,7 +15090,7 @@ declare namespace ViewEvents {
         PropagatedViewEvent,
         PropagatedEventType_2 as PropagatedEventType,
         PropagatedViewEventType,
-        Payload_2 as Payload,
+        Payload_3 as Payload,
         ByType
     }
 }
@@ -17568,7 +17611,7 @@ declare namespace WindowEvents {
         PropagatedEvent_3 as PropagatedEvent,
         PropagatedWindowEvent,
         PropagatedWindowEventType,
-        Payload_3 as Payload,
+        Payload_4 as Payload,
         ByType_2 as ByType
     }
 }