@openfin/remote-adapter 38.81.30 → 38.81.32

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

@@ -1161,9 +1161,14 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
      */
     mainWindowOptions: WindowCreationOptions;
     /**
-     * The name of the application (and the application's main window).
+     * The name of the application.
      *
-     * If provided, _must_ match `uuid`.
+     * @remarks
+     * This property is only used for naming the application logging folder, which will be sanitized to remove
+     * any special characters, spaces or international characters. Otherwise it's not used and it will be overwritten
+     * during startup with the UUID of the application.
+     *
+     * This property will be deprecated in the future.
      */
     name: string;
     /**
@@ -1193,9 +1198,7 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
     url: string;
     /**
      * The _Unique Universal Identifier_ (UUID) of the application, unique within the set of all other applications
-     *  running in the OpenFin Runtime.
-     *
-     * Note that `name` and `uuid` must match.
+     * running in the OpenFin Runtime.
      */
     uuid: string;
     /**
@@ -3456,6 +3459,13 @@ declare type ConstViewOptions = {
      * Initial bounds given relative to the window.
      */
     bounds: Bounds;
+    /**
+     * API permissions for code running in the view.
+     *
+     * @remarks Superseded by {@link DomainSettings.default.api.permissions} - if present, this setting will be **ignored**.
+     * It is recommended for users to migrate to a domain-based security model, since it is more natural to assign trust
+     * to the source of the page content than to the context rendering it.
+     */
     permissions: Partial<Permissions_2>;
     /**
      * String tag that attempts to group like-tagged renderers together. Will only be used if pages are on the same origin.
@@ -3656,6 +3666,13 @@ declare type ConstWindowOptions = {
      * The name of the window.
      */
     name: string;
+    /**
+     * API permissions for code running in the window.
+     *
+     * @remarks Superseded by {@link DomainSettings.default.api.permissions} - if present, this setting will be **ignored**.
+     * It is recommended for users to migrate to a domain-based security model, since it is more natural to assign trust
+     * to the source of the page content than to the context rendering it.
+     */
     permissions: Partial<Permissions_2>;
     /**
      * Scripts that run before page load.  When omitted, inherits from the parent application.
@@ -4736,6 +4753,10 @@ declare type DomainSettings = {
     rules: DomainSettingsRule[];
     /**
      * Default values for settings in {@link DomainSettingsRule}.
+     *
+     * @remarks If {@link PerDomainSettings.content} or {@link PerDomainSettings.api.fin} are given a default value
+     * here, they will supersede any equivalent functionality in {@link WindowOptions} or {@link ViewOptions}.  For
+     * more information, see the documentation for the individual properties.
      */
     default?: PerDomainSettings;
 };
@@ -10251,7 +10272,7 @@ declare type PerDomainSettings = {
      * Whether DOM content can be loaded (by navigation or redirect).
      *
      * @remarks If this is included in {@link DomainSettings.default}, then {@link ContentNavigation} and
-     * {@link ContentRedirect} will be **ignored**.
+     * {@link ContentRedirect} in {@link WindowOptions} and {@link ViewOptions} will be **ignored**.
      */
     content?: ContentPermission;
 };

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

@@ -1161,9 +1161,14 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
      */
     mainWindowOptions: WindowCreationOptions;
     /**
-     * The name of the application (and the application's main window).
+     * The name of the application.
      *
-     * If provided, _must_ match `uuid`.
+     * @remarks
+     * This property is only used for naming the application logging folder, which will be sanitized to remove
+     * any special characters, spaces or international characters. Otherwise it's not used and it will be overwritten
+     * during startup with the UUID of the application.
+     *
+     * This property will be deprecated in the future.
      */
     name: string;
     /**
@@ -1193,9 +1198,7 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
     url: string;
     /**
      * The _Unique Universal Identifier_ (UUID) of the application, unique within the set of all other applications
-     *  running in the OpenFin Runtime.
-     *
-     * Note that `name` and `uuid` must match.
+     * running in the OpenFin Runtime.
      */
     uuid: string;
     /**
@@ -3456,6 +3459,13 @@ declare type ConstViewOptions = {
      * Initial bounds given relative to the window.
      */
     bounds: Bounds;
+    /**
+     * API permissions for code running in the view.
+     *
+     * @remarks Superseded by {@link DomainSettings.default.api.permissions} - if present, this setting will be **ignored**.
+     * It is recommended for users to migrate to a domain-based security model, since it is more natural to assign trust
+     * to the source of the page content than to the context rendering it.
+     */
     permissions: Partial<Permissions_2>;
     /**
      * String tag that attempts to group like-tagged renderers together. Will only be used if pages are on the same origin.
@@ -3656,6 +3666,13 @@ declare type ConstWindowOptions = {
      * The name of the window.
      */
     name: string;
+    /**
+     * API permissions for code running in the window.
+     *
+     * @remarks Superseded by {@link DomainSettings.default.api.permissions} - if present, this setting will be **ignored**.
+     * It is recommended for users to migrate to a domain-based security model, since it is more natural to assign trust
+     * to the source of the page content than to the context rendering it.
+     */
     permissions: Partial<Permissions_2>;
     /**
      * Scripts that run before page load.  When omitted, inherits from the parent application.
@@ -4736,6 +4753,10 @@ declare type DomainSettings = {
     rules: DomainSettingsRule[];
     /**
      * Default values for settings in {@link DomainSettingsRule}.
+     *
+     * @remarks If {@link PerDomainSettings.content} or {@link PerDomainSettings.api.fin} are given a default value
+     * here, they will supersede any equivalent functionality in {@link WindowOptions} or {@link ViewOptions}.  For
+     * more information, see the documentation for the individual properties.
      */
     default?: PerDomainSettings;
 };
@@ -10251,7 +10272,7 @@ declare type PerDomainSettings = {
      * Whether DOM content can be loaded (by navigation or redirect).
      *
      * @remarks If this is included in {@link DomainSettings.default}, then {@link ContentNavigation} and
-     * {@link ContentRedirect} will be **ignored**.
+     * {@link ContentRedirect} in {@link WindowOptions} and {@link ViewOptions} will be **ignored**.
      */
     content?: ContentPermission;
 };

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

@@ -1161,9 +1161,14 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
      */
     mainWindowOptions: WindowCreationOptions;
     /**
-     * The name of the application (and the application's main window).
+     * The name of the application.
      *
-     * If provided, _must_ match `uuid`.
+     * @remarks
+     * This property is only used for naming the application logging folder, which will be sanitized to remove
+     * any special characters, spaces or international characters. Otherwise it's not used and it will be overwritten
+     * during startup with the UUID of the application.
+     *
+     * This property will be deprecated in the future.
      */
     name: string;
     /**
@@ -1193,9 +1198,7 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
     url: string;
     /**
      * The _Unique Universal Identifier_ (UUID) of the application, unique within the set of all other applications
-     *  running in the OpenFin Runtime.
-     *
-     * Note that `name` and `uuid` must match.
+     * running in the OpenFin Runtime.
      */
     uuid: string;
     /**
@@ -3456,6 +3459,13 @@ declare type ConstViewOptions = {
      * Initial bounds given relative to the window.
      */
     bounds: Bounds;
+    /**
+     * API permissions for code running in the view.
+     *
+     * @remarks Superseded by {@link DomainSettings.default.api.permissions} - if present, this setting will be **ignored**.
+     * It is recommended for users to migrate to a domain-based security model, since it is more natural to assign trust
+     * to the source of the page content than to the context rendering it.
+     */
     permissions: Partial<Permissions_2>;
     /**
      * String tag that attempts to group like-tagged renderers together. Will only be used if pages are on the same origin.
@@ -3656,6 +3666,13 @@ declare type ConstWindowOptions = {
      * The name of the window.
      */
     name: string;
+    /**
+     * API permissions for code running in the window.
+     *
+     * @remarks Superseded by {@link DomainSettings.default.api.permissions} - if present, this setting will be **ignored**.
+     * It is recommended for users to migrate to a domain-based security model, since it is more natural to assign trust
+     * to the source of the page content than to the context rendering it.
+     */
     permissions: Partial<Permissions_2>;
     /**
      * Scripts that run before page load.  When omitted, inherits from the parent application.
@@ -4736,6 +4753,10 @@ declare type DomainSettings = {
     rules: DomainSettingsRule[];
     /**
      * Default values for settings in {@link DomainSettingsRule}.
+     *
+     * @remarks If {@link PerDomainSettings.content} or {@link PerDomainSettings.api.fin} are given a default value
+     * here, they will supersede any equivalent functionality in {@link WindowOptions} or {@link ViewOptions}.  For
+     * more information, see the documentation for the individual properties.
      */
     default?: PerDomainSettings;
 };
@@ -10251,7 +10272,7 @@ declare type PerDomainSettings = {
      * Whether DOM content can be loaded (by navigation or redirect).
      *
      * @remarks If this is included in {@link DomainSettings.default}, then {@link ContentNavigation} and
-     * {@link ContentRedirect} will be **ignored**.
+     * {@link ContentRedirect} in {@link WindowOptions} and {@link ViewOptions} will be **ignored**.
      */
     content?: ContentPermission;
 };

package/out/remote-adapter.d.ts

@@ -1167,9 +1167,14 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
      */
     mainWindowOptions: WindowCreationOptions;
     /**
-     * The name of the application (and the application's main window).
+     * The name of the application.
      *
-     * If provided, _must_ match `uuid`.
+     * @remarks
+     * This property is only used for naming the application logging folder, which will be sanitized to remove
+     * any special characters, spaces or international characters. Otherwise it's not used and it will be overwritten
+     * during startup with the UUID of the application.
+     *
+     * This property will be deprecated in the future.
      */
     name: string;
     /**
@@ -1199,9 +1204,7 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
     url: string;
     /**
      * The _Unique Universal Identifier_ (UUID) of the application, unique within the set of all other applications
-     *  running in the OpenFin Runtime.
-     *
-     * Note that `name` and `uuid` must match.
+     * running in the OpenFin Runtime.
      */
     uuid: string;
     /**
@@ -3515,6 +3518,13 @@ declare type ConstViewOptions = {
      * Initial bounds given relative to the window.
      */
     bounds: Bounds;
+    /**
+     * API permissions for code running in the view.
+     *
+     * @remarks Superseded by {@link DomainSettings.default.api.permissions} - if present, this setting will be **ignored**.
+     * It is recommended for users to migrate to a domain-based security model, since it is more natural to assign trust
+     * to the source of the page content than to the context rendering it.
+     */
     permissions: Partial<Permissions_2>;
     /**
      * String tag that attempts to group like-tagged renderers together. Will only be used if pages are on the same origin.
@@ -3715,6 +3725,13 @@ declare type ConstWindowOptions = {
      * The name of the window.
      */
     name: string;
+    /**
+     * API permissions for code running in the window.
+     *
+     * @remarks Superseded by {@link DomainSettings.default.api.permissions} - if present, this setting will be **ignored**.
+     * It is recommended for users to migrate to a domain-based security model, since it is more natural to assign trust
+     * to the source of the page content than to the context rendering it.
+     */
     permissions: Partial<Permissions_2>;
     /**
      * Scripts that run before page load.  When omitted, inherits from the parent application.
@@ -4795,6 +4812,10 @@ declare type DomainSettings = {
     rules: DomainSettingsRule[];
     /**
      * Default values for settings in {@link DomainSettingsRule}.
+     *
+     * @remarks If {@link PerDomainSettings.content} or {@link PerDomainSettings.api.fin} are given a default value
+     * here, they will supersede any equivalent functionality in {@link WindowOptions} or {@link ViewOptions}.  For
+     * more information, see the documentation for the individual properties.
      */
     default?: PerDomainSettings;
 };
@@ -10566,7 +10587,7 @@ declare type PerDomainSettings = {
      * Whether DOM content can be loaded (by navigation or redirect).
      *
      * @remarks If this is included in {@link DomainSettings.default}, then {@link ContentNavigation} and
-     * {@link ContentRedirect} will be **ignored**.
+     * {@link ContentRedirect} in {@link WindowOptions} and {@link ViewOptions} will be **ignored**.
      */
     content?: ContentPermission;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/remote-adapter",
-    "version": "38.81.30",
+    "version": "38.81.32",
     "description": "Establish intermachine runtime connections using webRTC.",
     "license": "SEE LICENSE IN LICENSE.md",
     "private": false,