@openfin/core 34.78.6 → 34.78.8

package/out/mock-alpha.d.ts

@@ -2971,7 +2971,7 @@ declare class ClassicStrategy implements ChannelStrategy<EndpointPayload> {
     private messageReceiver;
     private endpointId;
     private providerIdentity;
-    constructor(wire: Transport, messageReceiver: MessageReceiver, endpointId: string, // Provider endpointId is channelId
+    constructor(wire: Transport, messageReceiver: MessageReceiver_2, endpointId: string, // Provider endpointId is channelId
     providerIdentity: ProviderIdentity_4);
     onEndpointDisconnect(endpointId: string, listener: () => void): void;
     receive(listener: (action: string, payload: any, identity: OpenFin_2.ClientIdentity | OpenFin_2.ClientIdentityMultiRuntime | ProviderIdentity_4) => Promise<any>): void;
@@ -3450,7 +3450,7 @@ declare type ConstViewOptions = {
     /**
      * Controls interaction of the view with its parent window's download shelf.
      */
-    downloadShelf: {
+    downloadShelf?: {
         /**
          * Whether downloads in this view trigger opening the download shelf on its parent BrowserWindow
          */
@@ -4355,6 +4355,14 @@ declare type CreateViewTarget = LayoutIdentity & {
     };
 };
 
+/**
+ * Define possible options for Custom protocol.
+ * @interface
+ */
+declare type CustomProtocolOptions = {
+    protocolName: string;
+};
+
 /**
  * Custom headers for requests sent by the window.
  *
@@ -4372,6 +4380,8 @@ declare type CustomRequestHeaders = {
     headers: WebRequestHeader[];
 };
 
+declare type DataChannelReadyState = RTCDataChannel['readyState'];
+
 /**
  * @interface
  */
@@ -4653,7 +4663,7 @@ declare type DownloadShelfOptions = {
     /**
      * Styling options for the download shelf border.
      */
-    border: {
+    border?: {
         /**
          * Thickness of the border in pixels.  Default 1 pixel.  Used only for frameless windows.
          *
@@ -5129,7 +5139,7 @@ declare namespace ExternalApplicationEvents {
 }
 
 /**
- * Union of possible `type` values for a {@link OpenFin.ApplicationEvents.ApplicationEvent}.
+ * Union of possible `type` values for a {@link ApplicationEvent}.
  */
 declare type ExternalApplicationEventType = ExternalApplicationEvent['type'];
 
@@ -5455,6 +5465,8 @@ declare type FindIntentsByContextOptions<MetadataType = IntentMetadata_3> = {
     metadata?: MetadataType;
 };
 
+declare type FlexReadyState = WebSocketReadyState | DataChannelReadyState;
+
 /**
  * Generated when a WebContents gains focus.
  * @interface
@@ -9095,7 +9107,17 @@ declare interface Message<T> {
 
 declare type MessageHandler = (data: any) => boolean;
 
-declare class MessageReceiver extends Base {
+declare interface MessageReceiver {
+    addEventListener(e: 'open', listener: (ev: Event) => void): void;
+    addEventListener(e: 'error', listener: (ev: Event) => void): void;
+    addEventListener(e: 'message', listener: (ev: MessageEvent) => void): void;
+    addEventListener(e: 'close', listener: (ev: Event) => void): void;
+    send(data: unknown): void;
+    close(): void;
+    readyState: FlexReadyState;
+}
+
+declare class MessageReceiver_2 extends Base {
     private endpointMap;
     private latestEndpointIdByChannelId;
     constructor(wire: Transport);
@@ -9661,6 +9683,7 @@ declare namespace OpenFin_2 {
         Rectangle,
         ApplicationCreationOptions,
         ApplicationOptions,
+        CustomProtocolOptions,
         InteropBrokerOptions,
         ContextGroupInfo,
         DisplayMetadata_3 as DisplayMetadata,
@@ -11900,7 +11923,7 @@ declare type PropagatedEventType<Topic extends string, Type extends string> = `$
 
 /**
  * A view event that has propagated to a parent {@link OpenFin.WindowEvents Window}, {@link OpenFin.ApplicationEvents Application},
- * or {@link Openfin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
+ * or {@link OpenFin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
  * event type key with `'view-'`.
  */
 declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent<'view', TargetTopic, ViewEvent> & {
@@ -11914,7 +11937,7 @@ declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
 
 /**
  * A Window event that has propagated to the parent {@link OpenFin.ApplicationEvents Application} and {@link OpenFin.SystemEvents System},
- * prefixing the type string with `'window-'`.  Only {@link NativeWindowEvent native window events} will propagate
+ * prefixing the type string with `'window-'`.  Only {@link WindowSourcedEvent window-sourced events} will propagate
  * this way; those that have {@link OpenFin.ViewEvents.PropagatedViewEvent propagated} from {@link OpenFin.ViewEvents}
  * will *not* re-propagate.
  *
@@ -12132,6 +12155,10 @@ declare interface ProtocolMap extends ProtocolMapBase {
         anchor: OpenFin_2.AnchorType;
     }>>;
     'set-window-bounds': IdentityCall<WithPositioningOptions<Partial<OpenFin_2.Bounds>>>;
+    'register-custom-protocol': ApiCall<OpenFin_2.CustomProtocolOptions, void>;
+    'unregister-custom-protocol': ApiCall<{
+        protocolName: string;
+    }, void>;
 }
 
 declare interface ProtocolMapBase {
@@ -12263,6 +12290,10 @@ declare interface ReactComponentConfig extends ItemConfig {
  */
 declare type ReadImageClipboardRequest = BaseClipboardRequest & ImageFormatOptions;
 
+declare interface ReceiverConfig extends Omit<RemoteConfig, 'address'> {
+    receiver: MessageReceiver;
+}
+
 /**
  * A rectangular area on the screen.
  *
@@ -12902,6 +12933,41 @@ declare type ShortcutOverride = Hotkey & {
 
 /**
  * Generated when the Download Shelf 'Show All' button is clicked.
+ *
+ * @remarks By default, OpenFin does not handle the clicking of the `Show All` button on the download
+ * shelf.  Instead, it fires this event, which leaves rendering a download manager to the user.  For a simple
+ * implementation, the `chrome://downloads` page can be used (see the example below):
+ *
+ * @example
+ *
+ * ```typescript
+ * const platform = await fin.Platform.getCurrentSync();
+ * // Listen to the propagated event at the Platform level, so that we only need one listener for a click from any window
+ * platform.on('window-show-all-downloads', () => {
+ *   // Render the `chrome://downloads` window when a user clicks on the download shelf `Show All` button
+ *   platform.createWindow({
+ *         name: 'show-download-window',
+ *         layout: {
+ *             content: [
+ *                 {
+ *                     type: 'stack',
+ *                     content: [
+ *                         {
+ *                             type: 'component',
+ *                             componentName: 'view',
+ *                             componentState: {
+ *                                 name: 'show-download-view',
+ *                                 url: 'chrome://downloads'
+ *                             }
+ *                         }
+ *                     ]
+ *                 }
+ *             ]
+ *         }
+ *     });
+ * })
+ * ```
+ *
  * @interface
  */
 declare type ShowAllDownloadsEvent = BaseWindowEvent & {
@@ -13942,6 +14008,52 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
      * ```
      */
     openUrlWithBrowser(url: string): Promise<void>;
+    /**
+     * Creates a new registry entry under the HKCU root Windows registry key if the given custom protocol name doesn't exist or
+     * overwrites the existing registry entry if the given custom protocol name already exists.
+     *
+     * Note: This method is restricted by default and must be enabled via
+     * {@link https://developers.openfin.co/docs/api-security API security settings}. It requires RVM 12 or higher version.
+     *
+     *
+     * @remarks These protocols are reserved and cannot be registered:
+     * - fin
+     * - fins
+     * - openfin
+     * - URI Schemes registered with {@link https://en.wikipedia.org/wiki/List_of_URI_schemes#Official_IANA-registered_schemes IANA}
+     *
+     * @throws if a given custom protocol failed to be registered.
+     * @throws if a manifest URL contains the '%1' string.
+     * @throws if a manifest URL contains a query string parameter which name equals to the Protocol Launch Request Parameter Name.
+     * @throws if the full length of the command string that is to be written to the registry exceeds 2048 bytes.
+     *
+     * @example
+     * ```js
+     * fin.System.registerCustomProtocol({protocolName:'protocol1'}).then(console.log).catch(console.error);
+     * ```
+     */
+    registerCustomProtocol(options: OpenFin_2.CustomProtocolOptions): Promise<void>;
+    /**
+     * Removes the registry entry for a given custom protocol.
+     *
+     * Note: This method is restricted by default and must be enabled via
+     * {@link https://developers.openfin.co/docs/api-security API security settings}. It requires RVM 12 or higher version.
+     *
+     *
+     * @remarks These protocols are reserved and cannot be unregistered:
+     * - fin
+     * - fins
+     * - openfin
+     * - URI Schemes registered with {@link https://en.wikipedia.org/wiki/List_of_URI_schemes#Official_IANA-registered_schemes IANA}
+     *
+     * @throws if a protocol entry failed to be removed in registry.
+     *
+     * @example
+     * ```js
+     * await fin.System.unregisterCustomProtocol('protocol1');
+     * ```
+     */
+    unregisterCustomProtocol(protocolName: string): Promise<void>;
     /**
      * Removes the process entry for the passed UUID obtained from a prior call
      * of fin.System.launchExternalProcess().
@@ -14638,6 +14750,14 @@ declare type SystemPermissions = {
         enabled: boolean;
         protocols: string[];
     };
+    registerCustomProtocol: boolean | {
+        enabled: boolean;
+        protocols: string[];
+    };
+    unregisterCustomProtocol: boolean | {
+        enabled: boolean;
+        protocols: string[];
+    };
 };
 
 /**
@@ -14986,7 +15106,7 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
     connectSync: () => void;
     getPort: () => string;
     shutdown(): Promise<void>;
-    connect(config: InternalConnectConfig | RemoteConfig): Promise<string | void>;
+    connect(config: InternalConnectConfig | RemoteConfig | ReceiverConfig): Promise<string | void>;
     private connectRemote;
     connectByPort(config: ExistingConnectConfig): Promise<void>;
     private authorize;
@@ -17037,6 +17157,8 @@ declare type WebRequestHeader = {
     [key: string]: string;
 };
 
+declare type WebSocketReadyState = WebSocket['readyState'];
+
 /**
  * Generated when a window is being moved by the user.
  * @remarks For use with monitor scaling that is not 100%. Bounds are given in DIP (adjusted for monitor scale factor).
@@ -19041,7 +19163,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
      };
 
      declare type Wire = EventEmitter & {
-         connect(address: string, WsConstructor: typeof WebSocket): Promise<any>;
+         connect(messageReciever: MessageReceiver): Promise<any>;
          connectSync(): any;
          send(data: any): Promise<any>;
          shutdown(): Promise<void>;

package/out/mock-beta.d.ts

@@ -2971,7 +2971,7 @@ declare class ClassicStrategy implements ChannelStrategy<EndpointPayload> {
     private messageReceiver;
     private endpointId;
     private providerIdentity;
-    constructor(wire: Transport, messageReceiver: MessageReceiver, endpointId: string, // Provider endpointId is channelId
+    constructor(wire: Transport, messageReceiver: MessageReceiver_2, endpointId: string, // Provider endpointId is channelId
     providerIdentity: ProviderIdentity_4);
     onEndpointDisconnect(endpointId: string, listener: () => void): void;
     receive(listener: (action: string, payload: any, identity: OpenFin_2.ClientIdentity | OpenFin_2.ClientIdentityMultiRuntime | ProviderIdentity_4) => Promise<any>): void;
@@ -3450,7 +3450,7 @@ declare type ConstViewOptions = {
     /**
      * Controls interaction of the view with its parent window's download shelf.
      */
-    downloadShelf: {
+    downloadShelf?: {
         /**
          * Whether downloads in this view trigger opening the download shelf on its parent BrowserWindow
          */
@@ -4355,6 +4355,14 @@ declare type CreateViewTarget = LayoutIdentity & {
     };
 };
 
+/**
+ * Define possible options for Custom protocol.
+ * @interface
+ */
+declare type CustomProtocolOptions = {
+    protocolName: string;
+};
+
 /**
  * Custom headers for requests sent by the window.
  *
@@ -4372,6 +4380,8 @@ declare type CustomRequestHeaders = {
     headers: WebRequestHeader[];
 };
 
+declare type DataChannelReadyState = RTCDataChannel['readyState'];
+
 /**
  * @interface
  */
@@ -4653,7 +4663,7 @@ declare type DownloadShelfOptions = {
     /**
      * Styling options for the download shelf border.
      */
-    border: {
+    border?: {
         /**
          * Thickness of the border in pixels.  Default 1 pixel.  Used only for frameless windows.
          *
@@ -5129,7 +5139,7 @@ declare namespace ExternalApplicationEvents {
 }
 
 /**
- * Union of possible `type` values for a {@link OpenFin.ApplicationEvents.ApplicationEvent}.
+ * Union of possible `type` values for a {@link ApplicationEvent}.
  */
 declare type ExternalApplicationEventType = ExternalApplicationEvent['type'];
 
@@ -5455,6 +5465,8 @@ declare type FindIntentsByContextOptions<MetadataType = IntentMetadata_3> = {
     metadata?: MetadataType;
 };
 
+declare type FlexReadyState = WebSocketReadyState | DataChannelReadyState;
+
 /**
  * Generated when a WebContents gains focus.
  * @interface
@@ -9095,7 +9107,17 @@ declare interface Message<T> {
 
 declare type MessageHandler = (data: any) => boolean;
 
-declare class MessageReceiver extends Base {
+declare interface MessageReceiver {
+    addEventListener(e: 'open', listener: (ev: Event) => void): void;
+    addEventListener(e: 'error', listener: (ev: Event) => void): void;
+    addEventListener(e: 'message', listener: (ev: MessageEvent) => void): void;
+    addEventListener(e: 'close', listener: (ev: Event) => void): void;
+    send(data: unknown): void;
+    close(): void;
+    readyState: FlexReadyState;
+}
+
+declare class MessageReceiver_2 extends Base {
     private endpointMap;
     private latestEndpointIdByChannelId;
     constructor(wire: Transport);
@@ -9661,6 +9683,7 @@ declare namespace OpenFin_2 {
         Rectangle,
         ApplicationCreationOptions,
         ApplicationOptions,
+        CustomProtocolOptions,
         InteropBrokerOptions,
         ContextGroupInfo,
         DisplayMetadata_3 as DisplayMetadata,
@@ -11900,7 +11923,7 @@ declare type PropagatedEventType<Topic extends string, Type extends string> = `$
 
 /**
  * A view event that has propagated to a parent {@link OpenFin.WindowEvents Window}, {@link OpenFin.ApplicationEvents Application},
- * or {@link Openfin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
+ * or {@link OpenFin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
  * event type key with `'view-'`.
  */
 declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent<'view', TargetTopic, ViewEvent> & {
@@ -11914,7 +11937,7 @@ declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
 
 /**
  * A Window event that has propagated to the parent {@link OpenFin.ApplicationEvents Application} and {@link OpenFin.SystemEvents System},
- * prefixing the type string with `'window-'`.  Only {@link NativeWindowEvent native window events} will propagate
+ * prefixing the type string with `'window-'`.  Only {@link WindowSourcedEvent window-sourced events} will propagate
  * this way; those that have {@link OpenFin.ViewEvents.PropagatedViewEvent propagated} from {@link OpenFin.ViewEvents}
  * will *not* re-propagate.
  *
@@ -12132,6 +12155,10 @@ declare interface ProtocolMap extends ProtocolMapBase {
         anchor: OpenFin_2.AnchorType;
     }>>;
     'set-window-bounds': IdentityCall<WithPositioningOptions<Partial<OpenFin_2.Bounds>>>;
+    'register-custom-protocol': ApiCall<OpenFin_2.CustomProtocolOptions, void>;
+    'unregister-custom-protocol': ApiCall<{
+        protocolName: string;
+    }, void>;
 }
 
 declare interface ProtocolMapBase {
@@ -12263,6 +12290,10 @@ declare interface ReactComponentConfig extends ItemConfig {
  */
 declare type ReadImageClipboardRequest = BaseClipboardRequest & ImageFormatOptions;
 
+declare interface ReceiverConfig extends Omit<RemoteConfig, 'address'> {
+    receiver: MessageReceiver;
+}
+
 /**
  * A rectangular area on the screen.
  *
@@ -12902,6 +12933,41 @@ declare type ShortcutOverride = Hotkey & {
 
 /**
  * Generated when the Download Shelf 'Show All' button is clicked.
+ *
+ * @remarks By default, OpenFin does not handle the clicking of the `Show All` button on the download
+ * shelf.  Instead, it fires this event, which leaves rendering a download manager to the user.  For a simple
+ * implementation, the `chrome://downloads` page can be used (see the example below):
+ *
+ * @example
+ *
+ * ```typescript
+ * const platform = await fin.Platform.getCurrentSync();
+ * // Listen to the propagated event at the Platform level, so that we only need one listener for a click from any window
+ * platform.on('window-show-all-downloads', () => {
+ *   // Render the `chrome://downloads` window when a user clicks on the download shelf `Show All` button
+ *   platform.createWindow({
+ *         name: 'show-download-window',
+ *         layout: {
+ *             content: [
+ *                 {
+ *                     type: 'stack',
+ *                     content: [
+ *                         {
+ *                             type: 'component',
+ *                             componentName: 'view',
+ *                             componentState: {
+ *                                 name: 'show-download-view',
+ *                                 url: 'chrome://downloads'
+ *                             }
+ *                         }
+ *                     ]
+ *                 }
+ *             ]
+ *         }
+ *     });
+ * })
+ * ```
+ *
  * @interface
  */
 declare type ShowAllDownloadsEvent = BaseWindowEvent & {
@@ -13942,6 +14008,52 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
      * ```
      */
     openUrlWithBrowser(url: string): Promise<void>;
+    /**
+     * Creates a new registry entry under the HKCU root Windows registry key if the given custom protocol name doesn't exist or
+     * overwrites the existing registry entry if the given custom protocol name already exists.
+     *
+     * Note: This method is restricted by default and must be enabled via
+     * {@link https://developers.openfin.co/docs/api-security API security settings}. It requires RVM 12 or higher version.
+     *
+     *
+     * @remarks These protocols are reserved and cannot be registered:
+     * - fin
+     * - fins
+     * - openfin
+     * - URI Schemes registered with {@link https://en.wikipedia.org/wiki/List_of_URI_schemes#Official_IANA-registered_schemes IANA}
+     *
+     * @throws if a given custom protocol failed to be registered.
+     * @throws if a manifest URL contains the '%1' string.
+     * @throws if a manifest URL contains a query string parameter which name equals to the Protocol Launch Request Parameter Name.
+     * @throws if the full length of the command string that is to be written to the registry exceeds 2048 bytes.
+     *
+     * @example
+     * ```js
+     * fin.System.registerCustomProtocol({protocolName:'protocol1'}).then(console.log).catch(console.error);
+     * ```
+     */
+    registerCustomProtocol(options: OpenFin_2.CustomProtocolOptions): Promise<void>;
+    /**
+     * Removes the registry entry for a given custom protocol.
+     *
+     * Note: This method is restricted by default and must be enabled via
+     * {@link https://developers.openfin.co/docs/api-security API security settings}. It requires RVM 12 or higher version.
+     *
+     *
+     * @remarks These protocols are reserved and cannot be unregistered:
+     * - fin
+     * - fins
+     * - openfin
+     * - URI Schemes registered with {@link https://en.wikipedia.org/wiki/List_of_URI_schemes#Official_IANA-registered_schemes IANA}
+     *
+     * @throws if a protocol entry failed to be removed in registry.
+     *
+     * @example
+     * ```js
+     * await fin.System.unregisterCustomProtocol('protocol1');
+     * ```
+     */
+    unregisterCustomProtocol(protocolName: string): Promise<void>;
     /**
      * Removes the process entry for the passed UUID obtained from a prior call
      * of fin.System.launchExternalProcess().
@@ -14638,6 +14750,14 @@ declare type SystemPermissions = {
         enabled: boolean;
         protocols: string[];
     };
+    registerCustomProtocol: boolean | {
+        enabled: boolean;
+        protocols: string[];
+    };
+    unregisterCustomProtocol: boolean | {
+        enabled: boolean;
+        protocols: string[];
+    };
 };
 
 /**
@@ -14986,7 +15106,7 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
     connectSync: () => void;
     getPort: () => string;
     shutdown(): Promise<void>;
-    connect(config: InternalConnectConfig | RemoteConfig): Promise<string | void>;
+    connect(config: InternalConnectConfig | RemoteConfig | ReceiverConfig): Promise<string | void>;
     private connectRemote;
     connectByPort(config: ExistingConnectConfig): Promise<void>;
     private authorize;
@@ -17037,6 +17157,8 @@ declare type WebRequestHeader = {
     [key: string]: string;
 };
 
+declare type WebSocketReadyState = WebSocket['readyState'];
+
 /**
  * Generated when a window is being moved by the user.
  * @remarks For use with monitor scaling that is not 100%. Bounds are given in DIP (adjusted for monitor scale factor).
@@ -19041,7 +19163,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
      };
 
      declare type Wire = EventEmitter & {
-         connect(address: string, WsConstructor: typeof WebSocket): Promise<any>;
+         connect(messageReciever: MessageReceiver): Promise<any>;
          connectSync(): any;
          send(data: any): Promise<any>;
          shutdown(): Promise<void>;

package/out/mock-public.d.ts

@@ -2971,7 +2971,7 @@ declare class ClassicStrategy implements ChannelStrategy<EndpointPayload> {
     private messageReceiver;
     private endpointId;
     private providerIdentity;
-    constructor(wire: Transport, messageReceiver: MessageReceiver, endpointId: string, // Provider endpointId is channelId
+    constructor(wire: Transport, messageReceiver: MessageReceiver_2, endpointId: string, // Provider endpointId is channelId
     providerIdentity: ProviderIdentity_4);
     onEndpointDisconnect(endpointId: string, listener: () => void): void;
     receive(listener: (action: string, payload: any, identity: OpenFin_2.ClientIdentity | OpenFin_2.ClientIdentityMultiRuntime | ProviderIdentity_4) => Promise<any>): void;
@@ -3450,7 +3450,7 @@ declare type ConstViewOptions = {
     /**
      * Controls interaction of the view with its parent window's download shelf.
      */
-    downloadShelf: {
+    downloadShelf?: {
         /**
          * Whether downloads in this view trigger opening the download shelf on its parent BrowserWindow
          */
@@ -4355,6 +4355,14 @@ declare type CreateViewTarget = LayoutIdentity & {
     };
 };
 
+/**
+ * Define possible options for Custom protocol.
+ * @interface
+ */
+declare type CustomProtocolOptions = {
+    protocolName: string;
+};
+
 /**
  * Custom headers for requests sent by the window.
  *
@@ -4372,6 +4380,8 @@ declare type CustomRequestHeaders = {
     headers: WebRequestHeader[];
 };
 
+declare type DataChannelReadyState = RTCDataChannel['readyState'];
+
 /**
  * @interface
  */
@@ -4653,7 +4663,7 @@ declare type DownloadShelfOptions = {
     /**
      * Styling options for the download shelf border.
      */
-    border: {
+    border?: {
         /**
          * Thickness of the border in pixels.  Default 1 pixel.  Used only for frameless windows.
          *
@@ -5129,7 +5139,7 @@ declare namespace ExternalApplicationEvents {
 }
 
 /**
- * Union of possible `type` values for a {@link OpenFin.ApplicationEvents.ApplicationEvent}.
+ * Union of possible `type` values for a {@link ApplicationEvent}.
  */
 declare type ExternalApplicationEventType = ExternalApplicationEvent['type'];
 
@@ -5455,6 +5465,8 @@ declare type FindIntentsByContextOptions<MetadataType = IntentMetadata_3> = {
     metadata?: MetadataType;
 };
 
+declare type FlexReadyState = WebSocketReadyState | DataChannelReadyState;
+
 /**
  * Generated when a WebContents gains focus.
  * @interface
@@ -9095,7 +9107,17 @@ declare interface Message<T> {
 
 declare type MessageHandler = (data: any) => boolean;
 
-declare class MessageReceiver extends Base {
+declare interface MessageReceiver {
+    addEventListener(e: 'open', listener: (ev: Event) => void): void;
+    addEventListener(e: 'error', listener: (ev: Event) => void): void;
+    addEventListener(e: 'message', listener: (ev: MessageEvent) => void): void;
+    addEventListener(e: 'close', listener: (ev: Event) => void): void;
+    send(data: unknown): void;
+    close(): void;
+    readyState: FlexReadyState;
+}
+
+declare class MessageReceiver_2 extends Base {
     private endpointMap;
     private latestEndpointIdByChannelId;
     constructor(wire: Transport);
@@ -9661,6 +9683,7 @@ declare namespace OpenFin_2 {
         Rectangle,
         ApplicationCreationOptions,
         ApplicationOptions,
+        CustomProtocolOptions,
         InteropBrokerOptions,
         ContextGroupInfo,
         DisplayMetadata_3 as DisplayMetadata,
@@ -11900,7 +11923,7 @@ declare type PropagatedEventType<Topic extends string, Type extends string> = `$
 
 /**
  * A view event that has propagated to a parent {@link OpenFin.WindowEvents Window}, {@link OpenFin.ApplicationEvents Application},
- * or {@link Openfin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
+ * or {@link OpenFin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
  * event type key with `'view-'`.
  */
 declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent<'view', TargetTopic, ViewEvent> & {
@@ -11914,7 +11937,7 @@ declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
 
 /**
  * A Window event that has propagated to the parent {@link OpenFin.ApplicationEvents Application} and {@link OpenFin.SystemEvents System},
- * prefixing the type string with `'window-'`.  Only {@link NativeWindowEvent native window events} will propagate
+ * prefixing the type string with `'window-'`.  Only {@link WindowSourcedEvent window-sourced events} will propagate
  * this way; those that have {@link OpenFin.ViewEvents.PropagatedViewEvent propagated} from {@link OpenFin.ViewEvents}
  * will *not* re-propagate.
  *
@@ -12132,6 +12155,10 @@ declare interface ProtocolMap extends ProtocolMapBase {
         anchor: OpenFin_2.AnchorType;
     }>>;
     'set-window-bounds': IdentityCall<WithPositioningOptions<Partial<OpenFin_2.Bounds>>>;
+    'register-custom-protocol': ApiCall<OpenFin_2.CustomProtocolOptions, void>;
+    'unregister-custom-protocol': ApiCall<{
+        protocolName: string;
+    }, void>;
 }
 
 declare interface ProtocolMapBase {
@@ -12263,6 +12290,10 @@ declare interface ReactComponentConfig extends ItemConfig {
  */
 declare type ReadImageClipboardRequest = BaseClipboardRequest & ImageFormatOptions;
 
+declare interface ReceiverConfig extends Omit<RemoteConfig, 'address'> {
+    receiver: MessageReceiver;
+}
+
 /**
  * A rectangular area on the screen.
  *
@@ -12902,6 +12933,41 @@ declare type ShortcutOverride = Hotkey & {
 
 /**
  * Generated when the Download Shelf 'Show All' button is clicked.
+ *
+ * @remarks By default, OpenFin does not handle the clicking of the `Show All` button on the download
+ * shelf.  Instead, it fires this event, which leaves rendering a download manager to the user.  For a simple
+ * implementation, the `chrome://downloads` page can be used (see the example below):
+ *
+ * @example
+ *
+ * ```typescript
+ * const platform = await fin.Platform.getCurrentSync();
+ * // Listen to the propagated event at the Platform level, so that we only need one listener for a click from any window
+ * platform.on('window-show-all-downloads', () => {
+ *   // Render the `chrome://downloads` window when a user clicks on the download shelf `Show All` button
+ *   platform.createWindow({
+ *         name: 'show-download-window',
+ *         layout: {
+ *             content: [
+ *                 {
+ *                     type: 'stack',
+ *                     content: [
+ *                         {
+ *                             type: 'component',
+ *                             componentName: 'view',
+ *                             componentState: {
+ *                                 name: 'show-download-view',
+ *                                 url: 'chrome://downloads'
+ *                             }
+ *                         }
+ *                     ]
+ *                 }
+ *             ]
+ *         }
+ *     });
+ * })
+ * ```
+ *
  * @interface
  */
 declare type ShowAllDownloadsEvent = BaseWindowEvent & {
@@ -13942,6 +14008,52 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
      * ```
      */
     openUrlWithBrowser(url: string): Promise<void>;
+    /**
+     * Creates a new registry entry under the HKCU root Windows registry key if the given custom protocol name doesn't exist or
+     * overwrites the existing registry entry if the given custom protocol name already exists.
+     *
+     * Note: This method is restricted by default and must be enabled via
+     * {@link https://developers.openfin.co/docs/api-security API security settings}. It requires RVM 12 or higher version.
+     *
+     *
+     * @remarks These protocols are reserved and cannot be registered:
+     * - fin
+     * - fins
+     * - openfin
+     * - URI Schemes registered with {@link https://en.wikipedia.org/wiki/List_of_URI_schemes#Official_IANA-registered_schemes IANA}
+     *
+     * @throws if a given custom protocol failed to be registered.
+     * @throws if a manifest URL contains the '%1' string.
+     * @throws if a manifest URL contains a query string parameter which name equals to the Protocol Launch Request Parameter Name.
+     * @throws if the full length of the command string that is to be written to the registry exceeds 2048 bytes.
+     *
+     * @example
+     * ```js
+     * fin.System.registerCustomProtocol({protocolName:'protocol1'}).then(console.log).catch(console.error);
+     * ```
+     */
+    registerCustomProtocol(options: OpenFin_2.CustomProtocolOptions): Promise<void>;
+    /**
+     * Removes the registry entry for a given custom protocol.
+     *
+     * Note: This method is restricted by default and must be enabled via
+     * {@link https://developers.openfin.co/docs/api-security API security settings}. It requires RVM 12 or higher version.
+     *
+     *
+     * @remarks These protocols are reserved and cannot be unregistered:
+     * - fin
+     * - fins
+     * - openfin
+     * - URI Schemes registered with {@link https://en.wikipedia.org/wiki/List_of_URI_schemes#Official_IANA-registered_schemes IANA}
+     *
+     * @throws if a protocol entry failed to be removed in registry.
+     *
+     * @example
+     * ```js
+     * await fin.System.unregisterCustomProtocol('protocol1');
+     * ```
+     */
+    unregisterCustomProtocol(protocolName: string): Promise<void>;
     /**
      * Removes the process entry for the passed UUID obtained from a prior call
      * of fin.System.launchExternalProcess().
@@ -14638,6 +14750,14 @@ declare type SystemPermissions = {
         enabled: boolean;
         protocols: string[];
     };
+    registerCustomProtocol: boolean | {
+        enabled: boolean;
+        protocols: string[];
+    };
+    unregisterCustomProtocol: boolean | {
+        enabled: boolean;
+        protocols: string[];
+    };
 };
 
 /**
@@ -14986,7 +15106,7 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
     connectSync: () => void;
     getPort: () => string;
     shutdown(): Promise<void>;
-    connect(config: InternalConnectConfig | RemoteConfig): Promise<string | void>;
+    connect(config: InternalConnectConfig | RemoteConfig | ReceiverConfig): Promise<string | void>;
     private connectRemote;
     connectByPort(config: ExistingConnectConfig): Promise<void>;
     private authorize;
@@ -17037,6 +17157,8 @@ declare type WebRequestHeader = {
     [key: string]: string;
 };
 
+declare type WebSocketReadyState = WebSocket['readyState'];
+
 /**
  * Generated when a window is being moved by the user.
  * @remarks For use with monitor scaling that is not 100%. Bounds are given in DIP (adjusted for monitor scale factor).
@@ -19041,7 +19163,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
      };
 
      declare type Wire = EventEmitter & {
-         connect(address: string, WsConstructor: typeof WebSocket): Promise<any>;
+         connect(messageReciever: MessageReceiver): Promise<any>;
          connectSync(): any;
          send(data: any): Promise<any>;
          shutdown(): Promise<void>;

package/out/mock.d.ts

@@ -3011,7 +3011,7 @@ declare class ClassicStrategy implements ChannelStrategy<EndpointPayload> {
     private messageReceiver;
     private endpointId;
     private providerIdentity;
-    constructor(wire: Transport, messageReceiver: MessageReceiver, endpointId: string, // Provider endpointId is channelId
+    constructor(wire: Transport, messageReceiver: MessageReceiver_2, endpointId: string, // Provider endpointId is channelId
     providerIdentity: ProviderIdentity_4);
     onEndpointDisconnect(endpointId: string, listener: () => void): void;
     receive(listener: (action: string, payload: any, identity: OpenFin_2.ClientIdentity | OpenFin_2.ClientIdentityMultiRuntime | ProviderIdentity_4) => Promise<any>): void;
@@ -3544,7 +3544,7 @@ declare type ConstViewOptions = {
     /**
      * Controls interaction of the view with its parent window's download shelf.
      */
-    downloadShelf: {
+    downloadShelf?: {
         /**
          * Whether downloads in this view trigger opening the download shelf on its parent BrowserWindow
          */
@@ -4449,6 +4449,14 @@ declare type CreateViewTarget = LayoutIdentity & {
     };
 };
 
+/**
+ * Define possible options for Custom protocol.
+ * @interface
+ */
+declare type CustomProtocolOptions = {
+    protocolName: string;
+};
+
 /**
  * Custom headers for requests sent by the window.
  *
@@ -4466,6 +4474,8 @@ declare type CustomRequestHeaders = {
     headers: WebRequestHeader[];
 };
 
+declare type DataChannelReadyState = RTCDataChannel['readyState'];
+
 /**
  * @interface
  */
@@ -4747,7 +4757,7 @@ declare type DownloadShelfOptions = {
     /**
      * Styling options for the download shelf border.
      */
-    border: {
+    border?: {
         /**
          * Thickness of the border in pixels.  Default 1 pixel.  Used only for frameless windows.
          *
@@ -5247,7 +5257,7 @@ declare namespace ExternalApplicationEvents {
 }
 
 /**
- * Union of possible `type` values for a {@link OpenFin.ApplicationEvents.ApplicationEvent}.
+ * Union of possible `type` values for a {@link ApplicationEvent}.
  */
 declare type ExternalApplicationEventType = ExternalApplicationEvent['type'];
 
@@ -5573,6 +5583,8 @@ declare type FindIntentsByContextOptions<MetadataType = IntentMetadata_3> = {
     metadata?: MetadataType;
 };
 
+declare type FlexReadyState = WebSocketReadyState | DataChannelReadyState;
+
 /**
  * Generated when a WebContents gains focus.
  * @interface
@@ -9423,7 +9435,17 @@ declare interface Message<T> {
 
 declare type MessageHandler = (data: any) => boolean;
 
-declare class MessageReceiver extends Base {
+declare interface MessageReceiver {
+    addEventListener(e: 'open', listener: (ev: Event) => void): void;
+    addEventListener(e: 'error', listener: (ev: Event) => void): void;
+    addEventListener(e: 'message', listener: (ev: MessageEvent) => void): void;
+    addEventListener(e: 'close', listener: (ev: Event) => void): void;
+    send(data: unknown): void;
+    close(): void;
+    readyState: FlexReadyState;
+}
+
+declare class MessageReceiver_2 extends Base {
     private endpointMap;
     private latestEndpointIdByChannelId;
     constructor(wire: Transport);
@@ -10000,6 +10022,7 @@ declare namespace OpenFin_2 {
         Rectangle,
         ApplicationCreationOptions,
         ApplicationOptions,
+        CustomProtocolOptions,
         InteropBrokerOptions,
         ContextGroupInfo,
         DisplayMetadata_3 as DisplayMetadata,
@@ -12320,7 +12343,7 @@ declare type PropagatedEventType<Topic extends string, Type extends string> = `$
 
 /**
  * A view event that has propagated to a parent {@link OpenFin.WindowEvents Window}, {@link OpenFin.ApplicationEvents Application},
- * or {@link Openfin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
+ * or {@link OpenFin.SystemEvents System}), adding a `viewIdentity` property (since the `Identity` property of the propagated event refers to the `Window`) and prefixing the
  * event type key with `'view-'`.
  */
 declare type PropagatedViewEvent<TargetTopic extends string> = PropagatedEvent<'view', TargetTopic, ViewEvent> & {
@@ -12334,7 +12357,7 @@ declare type PropagatedViewEventType = PropagatedViewEvent<string>['type'];
 
 /**
  * A Window event that has propagated to the parent {@link OpenFin.ApplicationEvents Application} and {@link OpenFin.SystemEvents System},
- * prefixing the type string with `'window-'`.  Only {@link NativeWindowEvent native window events} will propagate
+ * prefixing the type string with `'window-'`.  Only {@link WindowSourcedEvent window-sourced events} will propagate
  * this way; those that have {@link OpenFin.ViewEvents.PropagatedViewEvent propagated} from {@link OpenFin.ViewEvents}
  * will *not* re-propagate.
  *
@@ -12552,6 +12575,10 @@ declare interface ProtocolMap extends ProtocolMapBase {
         anchor: OpenFin_2.AnchorType;
     }>>;
     'set-window-bounds': IdentityCall<WithPositioningOptions<Partial<OpenFin_2.Bounds>>>;
+    'register-custom-protocol': ApiCall<OpenFin_2.CustomProtocolOptions, void>;
+    'unregister-custom-protocol': ApiCall<{
+        protocolName: string;
+    }, void>;
 }
 
 declare interface ProtocolMapBase {
@@ -12683,6 +12710,10 @@ declare interface ReactComponentConfig extends ItemConfig {
  */
 declare type ReadImageClipboardRequest = BaseClipboardRequest & ImageFormatOptions;
 
+declare interface ReceiverConfig extends Omit<RemoteConfig, 'address'> {
+    receiver: MessageReceiver;
+}
+
 /**
  * A rectangular area on the screen.
  *
@@ -13322,6 +13353,41 @@ declare type ShortcutOverride = Hotkey & {
 
 /**
  * Generated when the Download Shelf 'Show All' button is clicked.
+ *
+ * @remarks By default, OpenFin does not handle the clicking of the `Show All` button on the download
+ * shelf.  Instead, it fires this event, which leaves rendering a download manager to the user.  For a simple
+ * implementation, the `chrome://downloads` page can be used (see the example below):
+ *
+ * @example
+ *
+ * ```typescript
+ * const platform = await fin.Platform.getCurrentSync();
+ * // Listen to the propagated event at the Platform level, so that we only need one listener for a click from any window
+ * platform.on('window-show-all-downloads', () => {
+ *   // Render the `chrome://downloads` window when a user clicks on the download shelf `Show All` button
+ *   platform.createWindow({
+ *         name: 'show-download-window',
+ *         layout: {
+ *             content: [
+ *                 {
+ *                     type: 'stack',
+ *                     content: [
+ *                         {
+ *                             type: 'component',
+ *                             componentName: 'view',
+ *                             componentState: {
+ *                                 name: 'show-download-view',
+ *                                 url: 'chrome://downloads'
+ *                             }
+ *                         }
+ *                     ]
+ *                 }
+ *             ]
+ *         }
+ *     });
+ * })
+ * ```
+ *
  * @interface
  */
 declare type ShowAllDownloadsEvent = BaseWindowEvent & {
@@ -14368,6 +14434,52 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
      * ```
      */
     openUrlWithBrowser(url: string): Promise<void>;
+    /**
+     * Creates a new registry entry under the HKCU root Windows registry key if the given custom protocol name doesn't exist or
+     * overwrites the existing registry entry if the given custom protocol name already exists.
+     *
+     * Note: This method is restricted by default and must be enabled via
+     * {@link https://developers.openfin.co/docs/api-security API security settings}. It requires RVM 12 or higher version.
+     *
+     *
+     * @remarks These protocols are reserved and cannot be registered:
+     * - fin
+     * - fins
+     * - openfin
+     * - URI Schemes registered with {@link https://en.wikipedia.org/wiki/List_of_URI_schemes#Official_IANA-registered_schemes IANA}
+     *
+     * @throws if a given custom protocol failed to be registered.
+     * @throws if a manifest URL contains the '%1' string.
+     * @throws if a manifest URL contains a query string parameter which name equals to the Protocol Launch Request Parameter Name.
+     * @throws if the full length of the command string that is to be written to the registry exceeds 2048 bytes.
+     *
+     * @example
+     * ```js
+     * fin.System.registerCustomProtocol({protocolName:'protocol1'}).then(console.log).catch(console.error);
+     * ```
+     */
+    registerCustomProtocol(options: OpenFin_2.CustomProtocolOptions): Promise<void>;
+    /**
+     * Removes the registry entry for a given custom protocol.
+     *
+     * Note: This method is restricted by default and must be enabled via
+     * {@link https://developers.openfin.co/docs/api-security API security settings}. It requires RVM 12 or higher version.
+     *
+     *
+     * @remarks These protocols are reserved and cannot be unregistered:
+     * - fin
+     * - fins
+     * - openfin
+     * - URI Schemes registered with {@link https://en.wikipedia.org/wiki/List_of_URI_schemes#Official_IANA-registered_schemes IANA}
+     *
+     * @throws if a protocol entry failed to be removed in registry.
+     *
+     * @example
+     * ```js
+     * await fin.System.unregisterCustomProtocol('protocol1');
+     * ```
+     */
+    unregisterCustomProtocol(protocolName: string): Promise<void>;
     /**
      * Removes the process entry for the passed UUID obtained from a prior call
      * of fin.System.launchExternalProcess().
@@ -15064,6 +15176,14 @@ declare type SystemPermissions = {
         enabled: boolean;
         protocols: string[];
     };
+    registerCustomProtocol: boolean | {
+        enabled: boolean;
+        protocols: string[];
+    };
+    unregisterCustomProtocol: boolean | {
+        enabled: boolean;
+        protocols: string[];
+    };
 };
 
 /**
@@ -15469,7 +15589,7 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
     connectSync: () => void;
     getPort: () => string;
     shutdown(): Promise<void>;
-    connect(config: InternalConnectConfig | RemoteConfig): Promise<string | void>;
+    connect(config: InternalConnectConfig | RemoteConfig | ReceiverConfig): Promise<string | void>;
     private connectRemote;
     connectByPort(config: ExistingConnectConfig): Promise<void>;
     private authorize;
@@ -17557,6 +17677,8 @@ declare type WebRequestHeader = {
     [key: string]: string;
 };
 
+declare type WebSocketReadyState = WebSocket['readyState'];
+
 /**
  * Generated when a window is being moved by the user.
  * @remarks For use with monitor scaling that is not 100%. Bounds are given in DIP (adjusted for monitor scale factor).
@@ -19645,7 +19767,7 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
      };
 
      declare type Wire = EventEmitter & {
-         connect(address: string, WsConstructor: typeof WebSocket): Promise<any>;
+         connect(messageReciever: MessageReceiver): Promise<any>;
          connectSync(): any;
          send(data: any): Promise<any>;
          shutdown(): Promise<void>;

package/out/mock.js

@@ -26,9 +26,9 @@ var application$1 = {};
  * child {@link OpenFin.Window windows} and {@link OpenFin.View views} are defined in the {@link OpenFin.WindowEvents} and
  * {@link OpenFin.ViewEvents} namespaces.  For a list of valid string keys for *all* application events, see {@link Application.on Application.on}.
  *
- * {@link NativeApplicationEvent Native application events} (i.e. those that have not propagated from {@link OpenFin.ViewEvents Views}
+ * {@link ApplicationSourcedEvent Application-sourced events} (i.e. those that have not propagated from {@link OpenFin.ViewEvents Views}
  * or {@link OpenFin.WindowEvents Windows} re-propagate to {@link OpenFin.SystemEvents System} with their type string prefixed with `application-`.
- * {@link OpenFin.ApplicationEvents.ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
+ * {@link ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
  * are propagated to `System` without any type string prefixing.
  *
  * "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
@@ -151,7 +151,7 @@ var window$2 = {};
  * propagate from `View` are defined in {@link OpenFin.ViewEvents}. For a list of valid string keys for *all* Window events, see
  * {@link Window.on Window.on}
  *
- * {@link OpenFin.WindowEvents.NativeWindowEvent Native window events} (i.e. those that are not propagated from a
+ * {@link OpenFin.WindowEvents.WindowSourcedEvent Window-sourced events} (i.e. those that are not propagated from a
  * {@link OpenFin.ViewEvents View}) propagate to their parent {@link OpenFin.ApplicationEvents Application} and
  * {@link OpenFin.SystemEvents System} with their event types prefixed with `'window-'`).
  *
@@ -196,10 +196,10 @@ Object.defineProperty(window$2, "__esModule", { value: true });
  * finally to the OpenFin runtime itself at the "system" level.  For details on propagation semantics, see the namespace for
  * the propagating (or propagated-to) entity.
  *
- * If you need the payload type for a specific type of event (especially propagated events), use the emitting topic's `EventPayload`
- * (e.g. {@link WindowEvents.WindowEventPayload}) generic with the event's `type` string.  For example, the payload of
+ * If you need the payload type for a specific type of event (especially propagated events), use the emitting topic's `Payload` generic
+ * (e.g. {@link WindowEvents.Payload}) with the event's `type` string.  For example, the payload of
  * a {@link ViewEvents.CreatedEvent} after it has propagated to its parent {@link WindowEvents Window} can be found with
- * `WindowEventPayload<'view-created'>`.
+ * `WindowEvents.Payload<'view-created'>`.
  *
  * @packageDocumentation
  */
@@ -7656,6 +7656,59 @@ class System extends base_1$j.EmitterBase {
     openUrlWithBrowser(url) {
         return this.wire.sendAction('open-url-with-browser', { url }).then(() => undefined);
     }
+    /**
+     * Creates a new registry entry under the HKCU root Windows registry key if the given custom protocol name doesn't exist or
+     * overwrites the existing registry entry if the given custom protocol name already exists.
+     *
+     * Note: This method is restricted by default and must be enabled via
+     * {@link https://developers.openfin.co/docs/api-security API security settings}. It requires RVM 12 or higher version.
+     *
+     *
+     * @remarks These protocols are reserved and cannot be registered:
+     * - fin
+     * - fins
+     * - openfin
+     * - URI Schemes registered with {@link https://en.wikipedia.org/wiki/List_of_URI_schemes#Official_IANA-registered_schemes IANA}
+     *
+     * @throws if a given custom protocol failed to be registered.
+     * @throws if a manifest URL contains the '%1' string.
+     * @throws if a manifest URL contains a query string parameter which name equals to the Protocol Launch Request Parameter Name.
+     * @throws if the full length of the command string that is to be written to the registry exceeds 2048 bytes.
+     *
+     * @example
+     * ```js
+     * fin.System.registerCustomProtocol({protocolName:'protocol1'}).then(console.log).catch(console.error);
+     * ```
+     */
+    async registerCustomProtocol(options) {
+        if (typeof options !== 'object') {
+            throw new Error('Must provide an object with a `protocolName` property having a string value.');
+        }
+        await this.wire.sendAction('register-custom-protocol', options);
+    }
+    /**
+     * Removes the registry entry for a given custom protocol.
+     *
+     * Note: This method is restricted by default and must be enabled via
+     * {@link https://developers.openfin.co/docs/api-security API security settings}. It requires RVM 12 or higher version.
+     *
+     *
+     * @remarks These protocols are reserved and cannot be unregistered:
+     * - fin
+     * - fins
+     * - openfin
+     * - URI Schemes registered with {@link https://en.wikipedia.org/wiki/List_of_URI_schemes#Official_IANA-registered_schemes IANA}
+     *
+     * @throws if a protocol entry failed to be removed in registry.
+     *
+     * @example
+     * ```js
+     * await fin.System.unregisterCustomProtocol('protocol1');
+     * ```
+     */
+    async unregisterCustomProtocol(protocolName) {
+        await this.wire.sendAction('unregister-custom-protocol', { protocolName });
+    }
     /**
      * Removes the process entry for the passed UUID obtained from a prior call
      * of fin.System.launchExternalProcess().
@@ -16756,7 +16809,7 @@ var transport = {};
 var wire = {};
 
 Object.defineProperty(wire, "__esModule", { value: true });
-wire.isInternalConnectConfig = wire.isPortDiscoveryConfig = wire.isNewConnectConfig = wire.isRemoteConfig = wire.isExistingConnectConfig = wire.isExternalConfig = void 0;
+wire.isInternalConnectConfig = wire.isPortDiscoveryConfig = wire.isNewConnectConfig = wire.isConfigWithReceiver = wire.isRemoteConfig = wire.isExistingConnectConfig = wire.isExternalConfig = void 0;
 function isExternalConfig(config) {
     if (typeof config.manifestUrl === 'string') {
         return true;
@@ -16772,6 +16825,10 @@ function isRemoteConfig(config) {
     return isExistingConnectConfig(config) && typeof config.token === 'string';
 }
 wire.isRemoteConfig = isRemoteConfig;
+function isConfigWithReceiver(config) {
+    return typeof config.receiver === 'object' && isRemoteConfig({ ...config, address: '' });
+}
+wire.isConfigWithReceiver = isConfigWithReceiver;
 function hasUuid(config) {
     return typeof config.uuid === 'string';
 }
@@ -16921,13 +16978,13 @@ class Transport extends events_1$1.EventEmitter {
     }
     getFin() {
         if (!__classPrivateFieldGet(this, _Transport_fin, "f")) {
-            throw new Error("No Fin object registered for this transport");
+            throw new Error('No Fin object registered for this transport');
         }
         return __classPrivateFieldGet(this, _Transport_fin, "f");
     }
     registerFin(_fin) {
         if (__classPrivateFieldGet(this, _Transport_fin, "f")) {
-            throw new Error("Fin object has already been registered for this transport");
+            throw new Error('Fin object has already been registered for this transport');
         }
         __classPrivateFieldSet(this, _Transport_fin, _fin, "f");
     }
@@ -16936,6 +16993,10 @@ class Transport extends events_1$1.EventEmitter {
         return wire.shutdown();
     }
     async connect(config) {
+        if ((0, wire_1.isConfigWithReceiver)(config)) {
+            await __classPrivateFieldGet(this, _Transport_wire, "f").connect(config.receiver);
+            return this.authorize(config);
+        }
         if ((0, wire_1.isRemoteConfig)(config)) {
             return this.connectRemote(config);
         }
@@ -16949,14 +17010,14 @@ class Transport extends events_1$1.EventEmitter {
         return undefined;
     }
     async connectRemote(config) {
-        await __classPrivateFieldGet(this, _Transport_wire, "f").connect(config.address, this.environment.getWsConstructor());
+        await __classPrivateFieldGet(this, _Transport_wire, "f").connect(new (this.environment.getWsConstructor())(config.address));
         return this.authorize(config);
     }
     async connectByPort(config) {
         const { address, uuid } = config;
         const reqAuthPayload = { ...config, type: 'file-token' };
         const wire = __classPrivateFieldGet(this, _Transport_wire, "f");
-        await wire.connect(address, this.environment.getWsConstructor());
+        await wire.connect(new (this.environment.getWsConstructor())(config.address));
         const requestExtAuthRet = await this.sendAction('request-external-authorization', {
             uuid,
             type: 'file-token'
@@ -16976,7 +17037,9 @@ class Transport extends events_1$1.EventEmitter {
             throw new transport_errors_1.RuntimeError(requestAuthRet.payload);
         }
     }
-    sendAction(action, payload = {}, uncorrelated = false) {
+    sendAction(action, payload = {}, uncorrelated = false
+    // specialResponse type is only used for 'requestAuthorization'
+    ) {
         // eslint-disable-next-line @typescript-eslint/no-empty-function
         let cancel = () => { };
         // We want the callsite from the caller of this function, not from here.
@@ -17026,7 +17089,10 @@ class Transport extends events_1$1.EventEmitter {
             this.uncorrelatedListener = resolve;
         }
         else if (this.wireListeners.has(id)) {
-            handleNack({ reason: 'Duplicate handler id', error: (0, errors_1.errorToPOJO)(new transport_errors_1.DuplicateCorrelationError(String(id))) });
+            handleNack({
+                reason: 'Duplicate handler id',
+                error: (0, errors_1.errorToPOJO)(new transport_errors_1.DuplicateCorrelationError(String(id)))
+            });
         }
         else {
             this.wireListeners.set(id, { resolve, handleNack });
@@ -17153,7 +17219,7 @@ Object.defineProperty(mockWire, "__esModule", { value: true });
 mockWire.MockWire = void 0;
 const events_1 = require$$0;
 class MockWire extends events_1.EventEmitter {
-    connect(address) {
+    connect() {
         throw new Error('You are not running in OpenFin.');
     }
     connectSync() {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/core",
-    "version": "34.78.6",
+    "version": "34.78.8",
     "description": "The core renderer entry point of OpenFin",
     "license": "SEE LICENSE IN LICENSE.MD",
     "main": "out/mock.js",