@openfin/fdc3-api 38.81.30 → 38.81.31

package/out/fdc3-api-alpha.d.ts

@@ -3432,6 +3432,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.
@@ -3632,6 +3639,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.
@@ -4712,6 +4726,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;
 };
@@ -10552,7 +10570,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/fdc3-api-beta.d.ts

@@ -3432,6 +3432,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.
@@ -3632,6 +3639,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.
@@ -4712,6 +4726,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;
 };
@@ -10552,7 +10570,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/fdc3-api-public.d.ts

@@ -3432,6 +3432,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.
@@ -3632,6 +3639,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.
@@ -4712,6 +4726,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;
 };
@@ -10552,7 +10570,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/fdc3-api.d.ts

@@ -3491,6 +3491,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.
@@ -3691,6 +3698,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.
@@ -4771,6 +4785,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;
 };
@@ -10867,7 +10885,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/fdc3-api",
-    "version": "38.81.30",
+    "version": "38.81.31",
     "description": "OpenFin fdc3 module utilities and types.",
     "license": "SEE LICENSE IN LICENSE.MD",
     "private": false,