@openfin/remote-adapter 36.79.13 → 36.79.17

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

@@ -88,12 +88,21 @@ declare type Api = {
     iframe?: {
         /**
          * Inject OpenFin API into cross-origin iframes
+         *
+         * @defaultValue false
          */
         crossOriginInjection?: boolean;
         /**
          * Inject OpenFin API into same-origin iframes
+         *
+         * @defaultValue true
          */
         sameOriginInjection?: boolean;
+        /**
+         * @deprecated Shared names should not be used; support is provided purely for back-compat reasons.
+         *
+         * When `true`, iframes will have the same name as their parent WebContents.
+         */
         enableDeprecatedSharedName?: boolean;
     };
     /**
@@ -1668,9 +1677,9 @@ declare class Base {
      * on the context in which the devtools panel was opened.
      */
     get me(): Identity;
-    protected isNodeEnvironment: () => boolean;
-    protected isOpenFinEnvironment: () => boolean;
-    protected isBrowserEnvironment: () => boolean;
+    /* Excluded from this release type: isNodeEnvironment */
+    /* Excluded from this release type: isOpenFinEnvironment */
+    /* Excluded from this release type: isBrowserEnvironment */
 }
 
 /**
@@ -4490,6 +4499,32 @@ declare type CreateLayoutOptions = {
     container: HTMLElement;
     layoutName: string;
     layout: LayoutOptions;
+    /**
+     * @defaultValue 'default'
+     *
+     * Controls the View behavior for the given `layout` property. Note
+     * that the selected behavior only applies to unnamed Views or
+     * Views with the prefix `internal-generated-`. In all cases, if any
+     * View in the `layout` does not already exist, it will be created
+     * with a name that starts with `internal-generated-`.
+     *
+     * When set to `reparent`, Views prefixed with `internal-generated-` will
+     * be reparented to the current Window and added to this new Layout.
+     * Use this option when you need to transfer an existing Layout between Windows.
+     *
+     * When set to 'duplicate', Views prefixed with `internal-generated-` will
+     * be duplicated with new generated names. Use this option when you need
+     * to clone a Layout to any Window.
+     *
+     * When set to `default` or omitted, the Layout will attempt to re-use
+     * existing Views only if they are attached to the current Window or
+     * the Provider Window. Set to `default` or omit this option when creating
+     * Layouts as part of implementing the LayoutManager::applyLayoutSnapshot
+     * override. Note that during applyLayoutSnapshot, Views are created and
+     * attached to the Provider while the Window is being created, so it's
+     * important to not 'duplicate' Views in this workflow.
+     */
+    multiInstanceViewBehavior?: MultiInstanceViewBehavior;
 };
 
 /**
@@ -5200,8 +5235,14 @@ declare interface Environment {
     getRtcPeer(): RTCPeerConnection;
     getWsConstructor(): typeof WebSocket;
     whenReady(): Promise<void>;
+    getInteropInfo(fin: OpenFin.Fin<OpenFin.EntityType>): Promise<InternalInteropBrokerOptions & {
+        fdc3Version?: Fdc3Version;
+    }>;
+    readonly type: EnvironmentType;
 }
 
+declare type EnvironmentType = 'node' | 'openfin' | 'other';
+
 declare type ErrorMiddleware = OpenFin.ErrorMiddleware;
 
 declare type ErrorMiddleware_2 = (topic: string, error: Error, id: ProviderIdentity_7 | ClientIdentity) => unknown;
@@ -5605,6 +5646,8 @@ declare namespace FDC3 {
     }
 }
 
+declare type Fdc3Version = '1.2' | '2.0';
+
 /**
  * @interface
  */
@@ -7003,6 +7046,15 @@ declare class InterApplicationBus extends Base {
 
 declare type InternalConnectConfig = ExistingConnectConfig | NewConnectConfig;
 
+declare type InternalFDC3Info = {
+    providerVersion: string;
+    provider: string;
+};
+
+declare type InternalInteropBrokerOptions = OpenFin.InteropBrokerOptions & {
+    fdc3Info: InternalFDC3Info;
+};
+
 /**
  * Define whether to enable interop action logging.
  *
@@ -7131,6 +7183,7 @@ declare type InteropActionLoggingOption = {
  *
  */
 declare class InteropBroker extends Base {
+    #private;
     private getProvider;
     private interopClients;
     private contextGroupsById;
@@ -9446,6 +9499,13 @@ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin.MonitorInfo & {
     type: 'monitor-info-changed';
 };
 
+/**
+ * @experimental
+ *
+ * Used to control view behavior for Layout.create API
+ */
+declare type MultiInstanceViewBehavior = 'reparent' | 'duplicate' | 'default';
+
 /**
  * @interface
  */
@@ -10166,6 +10226,7 @@ declare namespace OpenFin {
         LayoutManagerOverride,
         LayoutManager,
         CreateLayoutOptions,
+        MultiInstanceViewBehavior,
         PresetLayoutOptions_2 as PresetLayoutOptions,
         ResultBehavior,
         PopupBaseBehavior,

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

@@ -88,12 +88,21 @@ declare type Api = {
     iframe?: {
         /**
          * Inject OpenFin API into cross-origin iframes
+         *
+         * @defaultValue false
          */
         crossOriginInjection?: boolean;
         /**
          * Inject OpenFin API into same-origin iframes
+         *
+         * @defaultValue true
          */
         sameOriginInjection?: boolean;
+        /**
+         * @deprecated Shared names should not be used; support is provided purely for back-compat reasons.
+         *
+         * When `true`, iframes will have the same name as their parent WebContents.
+         */
         enableDeprecatedSharedName?: boolean;
     };
     /**
@@ -1668,9 +1677,9 @@ declare class Base {
      * on the context in which the devtools panel was opened.
      */
     get me(): Identity;
-    protected isNodeEnvironment: () => boolean;
-    protected isOpenFinEnvironment: () => boolean;
-    protected isBrowserEnvironment: () => boolean;
+    /* Excluded from this release type: isNodeEnvironment */
+    /* Excluded from this release type: isOpenFinEnvironment */
+    /* Excluded from this release type: isBrowserEnvironment */
 }
 
 /**
@@ -4490,6 +4499,32 @@ declare type CreateLayoutOptions = {
     container: HTMLElement;
     layoutName: string;
     layout: LayoutOptions;
+    /**
+     * @defaultValue 'default'
+     *
+     * Controls the View behavior for the given `layout` property. Note
+     * that the selected behavior only applies to unnamed Views or
+     * Views with the prefix `internal-generated-`. In all cases, if any
+     * View in the `layout` does not already exist, it will be created
+     * with a name that starts with `internal-generated-`.
+     *
+     * When set to `reparent`, Views prefixed with `internal-generated-` will
+     * be reparented to the current Window and added to this new Layout.
+     * Use this option when you need to transfer an existing Layout between Windows.
+     *
+     * When set to 'duplicate', Views prefixed with `internal-generated-` will
+     * be duplicated with new generated names. Use this option when you need
+     * to clone a Layout to any Window.
+     *
+     * When set to `default` or omitted, the Layout will attempt to re-use
+     * existing Views only if they are attached to the current Window or
+     * the Provider Window. Set to `default` or omit this option when creating
+     * Layouts as part of implementing the LayoutManager::applyLayoutSnapshot
+     * override. Note that during applyLayoutSnapshot, Views are created and
+     * attached to the Provider while the Window is being created, so it's
+     * important to not 'duplicate' Views in this workflow.
+     */
+    multiInstanceViewBehavior?: MultiInstanceViewBehavior;
 };
 
 /**
@@ -5200,8 +5235,14 @@ declare interface Environment {
     getRtcPeer(): RTCPeerConnection;
     getWsConstructor(): typeof WebSocket;
     whenReady(): Promise<void>;
+    getInteropInfo(fin: OpenFin.Fin<OpenFin.EntityType>): Promise<InternalInteropBrokerOptions & {
+        fdc3Version?: Fdc3Version;
+    }>;
+    readonly type: EnvironmentType;
 }
 
+declare type EnvironmentType = 'node' | 'openfin' | 'other';
+
 declare type ErrorMiddleware = OpenFin.ErrorMiddleware;
 
 declare type ErrorMiddleware_2 = (topic: string, error: Error, id: ProviderIdentity_7 | ClientIdentity) => unknown;
@@ -5605,6 +5646,8 @@ declare namespace FDC3 {
     }
 }
 
+declare type Fdc3Version = '1.2' | '2.0';
+
 /**
  * @interface
  */
@@ -7003,6 +7046,15 @@ declare class InterApplicationBus extends Base {
 
 declare type InternalConnectConfig = ExistingConnectConfig | NewConnectConfig;
 
+declare type InternalFDC3Info = {
+    providerVersion: string;
+    provider: string;
+};
+
+declare type InternalInteropBrokerOptions = OpenFin.InteropBrokerOptions & {
+    fdc3Info: InternalFDC3Info;
+};
+
 /**
  * Define whether to enable interop action logging.
  *
@@ -7131,6 +7183,7 @@ declare type InteropActionLoggingOption = {
  *
  */
 declare class InteropBroker extends Base {
+    #private;
     private getProvider;
     private interopClients;
     private contextGroupsById;
@@ -9446,6 +9499,13 @@ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin.MonitorInfo & {
     type: 'monitor-info-changed';
 };
 
+/**
+ * @experimental
+ *
+ * Used to control view behavior for Layout.create API
+ */
+declare type MultiInstanceViewBehavior = 'reparent' | 'duplicate' | 'default';
+
 /**
  * @interface
  */
@@ -10166,6 +10226,7 @@ declare namespace OpenFin {
         LayoutManagerOverride,
         LayoutManager,
         CreateLayoutOptions,
+        MultiInstanceViewBehavior,
         PresetLayoutOptions_2 as PresetLayoutOptions,
         ResultBehavior,
         PopupBaseBehavior,

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

@@ -88,12 +88,21 @@ declare type Api = {
     iframe?: {
         /**
          * Inject OpenFin API into cross-origin iframes
+         *
+         * @defaultValue false
          */
         crossOriginInjection?: boolean;
         /**
          * Inject OpenFin API into same-origin iframes
+         *
+         * @defaultValue true
          */
         sameOriginInjection?: boolean;
+        /**
+         * @deprecated Shared names should not be used; support is provided purely for back-compat reasons.
+         *
+         * When `true`, iframes will have the same name as their parent WebContents.
+         */
         enableDeprecatedSharedName?: boolean;
     };
     /**
@@ -1668,9 +1677,9 @@ declare class Base {
      * on the context in which the devtools panel was opened.
      */
     get me(): Identity;
-    protected isNodeEnvironment: () => boolean;
-    protected isOpenFinEnvironment: () => boolean;
-    protected isBrowserEnvironment: () => boolean;
+    /* Excluded from this release type: isNodeEnvironment */
+    /* Excluded from this release type: isOpenFinEnvironment */
+    /* Excluded from this release type: isBrowserEnvironment */
 }
 
 /**
@@ -4490,6 +4499,32 @@ declare type CreateLayoutOptions = {
     container: HTMLElement;
     layoutName: string;
     layout: LayoutOptions;
+    /**
+     * @defaultValue 'default'
+     *
+     * Controls the View behavior for the given `layout` property. Note
+     * that the selected behavior only applies to unnamed Views or
+     * Views with the prefix `internal-generated-`. In all cases, if any
+     * View in the `layout` does not already exist, it will be created
+     * with a name that starts with `internal-generated-`.
+     *
+     * When set to `reparent`, Views prefixed with `internal-generated-` will
+     * be reparented to the current Window and added to this new Layout.
+     * Use this option when you need to transfer an existing Layout between Windows.
+     *
+     * When set to 'duplicate', Views prefixed with `internal-generated-` will
+     * be duplicated with new generated names. Use this option when you need
+     * to clone a Layout to any Window.
+     *
+     * When set to `default` or omitted, the Layout will attempt to re-use
+     * existing Views only if they are attached to the current Window or
+     * the Provider Window. Set to `default` or omit this option when creating
+     * Layouts as part of implementing the LayoutManager::applyLayoutSnapshot
+     * override. Note that during applyLayoutSnapshot, Views are created and
+     * attached to the Provider while the Window is being created, so it's
+     * important to not 'duplicate' Views in this workflow.
+     */
+    multiInstanceViewBehavior?: MultiInstanceViewBehavior;
 };
 
 /**
@@ -5200,8 +5235,14 @@ declare interface Environment {
     getRtcPeer(): RTCPeerConnection;
     getWsConstructor(): typeof WebSocket;
     whenReady(): Promise<void>;
+    getInteropInfo(fin: OpenFin.Fin<OpenFin.EntityType>): Promise<InternalInteropBrokerOptions & {
+        fdc3Version?: Fdc3Version;
+    }>;
+    readonly type: EnvironmentType;
 }
 
+declare type EnvironmentType = 'node' | 'openfin' | 'other';
+
 declare type ErrorMiddleware = OpenFin.ErrorMiddleware;
 
 declare type ErrorMiddleware_2 = (topic: string, error: Error, id: ProviderIdentity_7 | ClientIdentity) => unknown;
@@ -5605,6 +5646,8 @@ declare namespace FDC3 {
     }
 }
 
+declare type Fdc3Version = '1.2' | '2.0';
+
 /**
  * @interface
  */
@@ -7003,6 +7046,15 @@ declare class InterApplicationBus extends Base {
 
 declare type InternalConnectConfig = ExistingConnectConfig | NewConnectConfig;
 
+declare type InternalFDC3Info = {
+    providerVersion: string;
+    provider: string;
+};
+
+declare type InternalInteropBrokerOptions = OpenFin.InteropBrokerOptions & {
+    fdc3Info: InternalFDC3Info;
+};
+
 /**
  * Define whether to enable interop action logging.
  *
@@ -7131,6 +7183,7 @@ declare type InteropActionLoggingOption = {
  *
  */
 declare class InteropBroker extends Base {
+    #private;
     private getProvider;
     private interopClients;
     private contextGroupsById;
@@ -9446,6 +9499,13 @@ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin.MonitorInfo & {
     type: 'monitor-info-changed';
 };
 
+/**
+ * @experimental
+ *
+ * Used to control view behavior for Layout.create API
+ */
+declare type MultiInstanceViewBehavior = 'reparent' | 'duplicate' | 'default';
+
 /**
  * @interface
  */
@@ -10166,6 +10226,7 @@ declare namespace OpenFin {
         LayoutManagerOverride,
         LayoutManager,
         CreateLayoutOptions,
+        MultiInstanceViewBehavior,
         PresetLayoutOptions_2 as PresetLayoutOptions,
         ResultBehavior,
         PopupBaseBehavior,

package/out/remote-adapter.d.ts

@@ -88,12 +88,21 @@ declare type Api = {
     iframe?: {
         /**
          * Inject OpenFin API into cross-origin iframes
+         *
+         * @defaultValue false
          */
         crossOriginInjection?: boolean;
         /**
          * Inject OpenFin API into same-origin iframes
+         *
+         * @defaultValue true
          */
         sameOriginInjection?: boolean;
+        /**
+         * @deprecated Shared names should not be used; support is provided purely for back-compat reasons.
+         *
+         * When `true`, iframes will have the same name as their parent WebContents.
+         */
         enableDeprecatedSharedName?: boolean;
     };
     /**
@@ -1688,8 +1697,20 @@ declare class Base {
      * on the context in which the devtools panel was opened.
      */
     get me(): Identity;
+    /**
+     * @internal
+     * @deprecated
+     */
     protected isNodeEnvironment: () => boolean;
+    /**
+     * @internal
+     * @deprecated
+     */
     protected isOpenFinEnvironment: () => boolean;
+    /**
+     * @internal
+     * @deprecated
+     */
     protected isBrowserEnvironment: () => boolean;
 }
 
@@ -4533,6 +4554,32 @@ declare type CreateLayoutOptions = {
     container: HTMLElement;
     layoutName: string;
     layout: LayoutOptions;
+    /**
+     * @defaultValue 'default'
+     *
+     * Controls the View behavior for the given `layout` property. Note
+     * that the selected behavior only applies to unnamed Views or
+     * Views with the prefix `internal-generated-`. In all cases, if any
+     * View in the `layout` does not already exist, it will be created
+     * with a name that starts with `internal-generated-`.
+     *
+     * When set to `reparent`, Views prefixed with `internal-generated-` will
+     * be reparented to the current Window and added to this new Layout.
+     * Use this option when you need to transfer an existing Layout between Windows.
+     *
+     * When set to 'duplicate', Views prefixed with `internal-generated-` will
+     * be duplicated with new generated names. Use this option when you need
+     * to clone a Layout to any Window.
+     *
+     * When set to `default` or omitted, the Layout will attempt to re-use
+     * existing Views only if they are attached to the current Window or
+     * the Provider Window. Set to `default` or omit this option when creating
+     * Layouts as part of implementing the LayoutManager::applyLayoutSnapshot
+     * override. Note that during applyLayoutSnapshot, Views are created and
+     * attached to the Provider while the Window is being created, so it's
+     * important to not 'duplicate' Views in this workflow.
+     */
+    multiInstanceViewBehavior?: MultiInstanceViewBehavior;
 };
 
 /**
@@ -5248,8 +5295,14 @@ declare interface Environment {
     getRtcPeer(): RTCPeerConnection;
     getWsConstructor(): typeof WebSocket;
     whenReady(): Promise<void>;
+    getInteropInfo(fin: OpenFin.Fin<OpenFin.EntityType>): Promise<InternalInteropBrokerOptions & {
+        fdc3Version?: Fdc3Version;
+    }>;
+    readonly type: EnvironmentType;
 }
 
+declare type EnvironmentType = 'node' | 'openfin' | 'other';
+
 declare type ErrorMiddleware = OpenFin.ErrorMiddleware;
 
 declare type ErrorMiddleware_2 = (topic: string, error: Error, id: ProviderIdentity_7 | ClientIdentity) => unknown;
@@ -5674,6 +5727,8 @@ declare namespace FDC3 {
     }
 }
 
+declare type Fdc3Version = '1.2' | '2.0';
+
 /**
  * @interface
  */
@@ -7093,6 +7148,15 @@ declare class InterAppPayload {
 
 declare type InternalConnectConfig = ExistingConnectConfig | NewConnectConfig;
 
+declare type InternalFDC3Info = {
+    providerVersion: string;
+    provider: string;
+};
+
+declare type InternalInteropBrokerOptions = OpenFin.InteropBrokerOptions & {
+    fdc3Info: InternalFDC3Info;
+};
+
 /**
  * Define whether to enable interop action logging.
  *
@@ -7221,6 +7285,7 @@ declare type InteropActionLoggingOption = {
  *
  */
 declare class InteropBroker extends Base {
+    #private;
     private getProvider;
     private interopClients;
     private contextGroupsById;
@@ -7232,7 +7297,7 @@ declare class InteropBroker extends Base {
     /**
      * @internal
      */
-    constructor(wire: Transport, getProvider: () => Promise<OpenFin.ChannelProvider>, options?: any);
+    constructor(wire: Transport, getProvider: () => Promise<OpenFin.ChannelProvider>, options: InternalInteropBrokerOptions);
     static createClosedConstructor(...args: ConstructorParameters<typeof InteropBroker>): {
         new (): InteropBroker;
     };
@@ -9723,6 +9788,13 @@ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin.MonitorInfo & {
     type: 'monitor-info-changed';
 };
 
+/**
+ * @experimental
+ *
+ * Used to control view behavior for Layout.create API
+ */
+declare type MultiInstanceViewBehavior = 'reparent' | 'duplicate' | 'default';
+
 /**
  * @interface
  */
@@ -10465,6 +10537,7 @@ declare namespace OpenFin {
         LayoutManagerOverride,
         LayoutManager,
         CreateLayoutOptions,
+        MultiInstanceViewBehavior,
         PresetLayoutOptions_2 as PresetLayoutOptions,
         ResultBehavior,
         PopupBaseBehavior,