@openfin/core 32.75.3 → 32.75.5

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/core",
-    "version": "32.75.3",
+    "version": "32.75.5",
     "license": "SEE LICENSE IN LICENSE.MD",
     "main": "./src/mock.js",
     "types": "./src/mock.d.ts",

package/src/OpenFin.d.ts

@@ -435,6 +435,11 @@ export type ViewVisibilityOptions = {
  * Visibility state of a window.
  */
 export type WindowState = 'maximized' | 'minimized' | 'normal';
+/**
+ * Autoplay policy to apply to content in the window, can be
+ * `no-user-gesture-required`, `user-gesture-required`,
+ * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
+ */
 export type AutoplayPolicyOptions = 'no-user-gesture-required' | 'user-gesture-required' | 'document-user-activation-required';
 /**
  * Window options that cannot be changed after creation.
@@ -452,6 +457,11 @@ export type ConstWindowOptions = {
      * @deprecated use `icon` instead.
      */
     applicationIcon: string;
+    /**
+     * Autoplay policy to apply to content in the window, can be
+     * `no-user-gesture-required`, `user-gesture-required`,
+     * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
+     */
     autoplayPolicy: AutoplayPolicyOptions;
     /**
      * Automatically show the window when it is created.
@@ -1268,6 +1278,11 @@ export type ConstViewOptions = {
      * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
      */
     accelerator?: Partial<Accelerator>;
+    /**
+     * Autoplay policy to apply to content in the window, can be
+     * `no-user-gesture-required`, `user-gesture-required`,
+     * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
+     */
     autoplayPolicy: AutoplayPolicyOptions;
 };
 export type ViewState = ViewCreationOptions & {

package/src/api/view/Instance.d.ts

@@ -55,6 +55,11 @@ type ViewEvent = OpenFin.ViewEvent;
  * @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
  * @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
  *
+ * @property {string} [autoplayPolicy="no-user-gesture-required"]
+ * Autoplay policy to apply to content in the window, can be
+ * `no-user-gesture-required`, `user-gesture-required`,
+ * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
+ *
  * @property {object} [autoResize] AutoResize options
  *
  * @property {object} [bounds] initial bounds given relative to the window.

package/src/api/view/Instance.js

@@ -65,6 +65,11 @@ const window_1 = require("../window");
  * @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
  * @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
  *
+ * @property {string} [autoplayPolicy="no-user-gesture-required"]
+ * Autoplay policy to apply to content in the window, can be
+ * `no-user-gesture-required`, `user-gesture-required`,
+ * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
+ *
  * @property {object} [autoResize] AutoResize options
  *
  * @property {object} [bounds] initial bounds given relative to the window.

package/src/api/window/Instance.d.ts

@@ -134,6 +134,11 @@ import { WebContents } from '../webcontents/main';
  * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
  * an aspect ratio will not be enforced.
  *
+ * @property {string} [autoplayPolicy="no-user-gesture-required"]
+ * Autoplay policy to apply to content in the window, can be
+ * `no-user-gesture-required`, `user-gesture-required`,
+ * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
+ *
  * @property {boolean} [autoShow=true]
  * A flag to automatically show the window when it is created.
  *

package/src/api/window/Instance.js

@@ -141,6 +141,11 @@ const view_1 = require("../view");
  * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
  * an aspect ratio will not be enforced.
  *
+ * @property {string} [autoplayPolicy="no-user-gesture-required"]
+ * Autoplay policy to apply to content in the window, can be
+ * `no-user-gesture-required`, `user-gesture-required`,
+ * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
+ *
  * @property {boolean} [autoShow=true]
  * A flag to automatically show the window when it is created.
  *

package/src/environment/openfin-env.d.ts

@@ -1,31 +0,0 @@
-import type * as OpenFin from '../OpenFin';
-import { Transport } from '../transport/transport';
-import { NewConnectConfig } from '../transport/wire';
-import { BrowserEnvironment } from './browser';
-import { ChildContentOptions, Environment } from './environment';
-type EntityType = OpenFin.EntityType;
-export default class OpenFinEnvironment extends BrowserEnvironment implements Environment {
-    #private;
-    private raiseEventAsync;
-    childViews: boolean;
-    constructor();
-    getDefaultChannelOptions(): {
-        create: OpenFin.ChannelCreateOptions;
-        connect: OpenFin.ChannelConnectOptions;
-    };
-    initLayout(_fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, options: OpenFin.InitLayoutOptions): Promise<OpenFin.Layout>;
-    initPlatform(_fin: OpenFin.Fin<OpenFin.EntityType>, options?: OpenFin.InitPlatformOptions): ReturnType<OpenFin.Fin['Platform']['init']>;
-    observeBounds(element: Element, onChange: (bounds: DOMRect) => void | Promise<void>): () => void;
-    writeToken: (path: string, token: string) => Promise<string>;
-    retrievePort: (config: NewConnectConfig) => Promise<number>;
-    getNextMessageId: () => any;
-    createChildContent: ({ options, entityType }: ChildContentOptions) => Promise<unknown>;
-    private normalizeOptions;
-    private resolveUrl;
-    getWebWindow: (identity: OpenFin.Identity) => globalThis.Window;
-    getCurrentEntityIdentity: () => OpenFin.EntityInfo;
-    getCurrentEntityType: () => EntityType;
-    raiseEvent: (eventName: string, eventArgs: any) => void;
-    whenReady(): Promise<void>;
-}
-export {};

package/src/environment/openfin-env.js

@@ -1,100 +0,0 @@
-"use strict";
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _OpenFinEnvironment_ready;
-Object.defineProperty(exports, "__esModule", { value: true });
-const transport_errors_1 = require("../transport/transport-errors");
-const browser_1 = require("./browser");
-const bounds_observer_1 = require("../api/platform/renderer/utils/bounds-observer");
-// Inherits the following BrowserEnvironment methods: getRtcPeer, getRandomId, getUrl, getWsConstructor.
-class OpenFinEnvironment extends browser_1.BrowserEnvironment {
-    constructor() {
-        super();
-        _OpenFinEnvironment_ready.set(this, void 0);
-        this.writeToken = (path, token) => {
-            throw new transport_errors_1.NotImplementedError('Not Implemented');
-        };
-        this.retrievePort = (config) => {
-            throw new transport_errors_1.NotImplementedError('Not Implemented');
-        };
-        this.getNextMessageId = () => {
-            return fin.desktop.getUuid();
-        };
-        // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
-        this.createChildContent = async ({ options, entityType }) => {
-            const opts = this.normalizeOptions(options);
-            return new Promise((y, n) => fin.__internal_.createChildContent({ entityType, options: opts }, y, n));
-        };
-        this.normalizeOptions = (options) => {
-            const { uuid: parentUuid } = fin.__internal_.initialOptions;
-            const opts = JSON.parse(JSON.stringify(options));
-            const ABOUT_BLANK = 'about:blank';
-            opts.uuid = opts.uuid || parentUuid;
-            opts.url = opts.url || ABOUT_BLANK;
-            if (opts.url !== ABOUT_BLANK) {
-                opts.url = this.resolveUrl(opts.url);
-            }
-            return opts;
-        };
-        this.getWebWindow = (identity) => {
-            return fin.__internal_.getWebWindow(identity.name);
-        };
-        this.getCurrentEntityIdentity = () => {
-            return fin.__internal_.entityInfo;
-        };
-        this.getCurrentEntityType = () => {
-            return this.getCurrentEntityIdentity().entityType || 'unknown';
-        };
-        this.raiseEvent = (eventName, eventArgs) => {
-            this.raiseEventAsync(eventName, eventArgs);
-        };
-        this.raiseEventAsync = fin.__internal_.raiseEventAsync;
-        delete fin.__internal_.raiseEventAsync;
-        this.childViews = fin.__internal_.childViews;
-        __classPrivateFieldSet(this, _OpenFinEnvironment_ready, new Promise((resolve) => {
-            fin.desktop.main(resolve);
-        }), "f");
-    }
-    getDefaultChannelOptions() {
-        var _a, _b;
-        return {
-            create: {},
-            connect: {},
-            ...((_b = (_a = fin.__internal_.initialOptions.experimental) === null || _a === void 0 ? void 0 : _a.defaultChannelOptions) !== null && _b !== void 0 ? _b : {})
-        };
-    }
-    async initLayout(_fin, wire, options) {
-        const { initLayout } = await Promise.resolve().then(() => require(
-        /* webpackChunkName: 'layout' */
-        '../api/platform/renderer/init-layout'));
-        return initLayout(_fin, wire, options);
-    }
-    async initPlatform(_fin, options) {
-        const { initPlatformProvider } = await Promise.resolve().then(() => require(
-        /* webpackChunkName: 'provider' */
-        '../api/platform/renderer/init-platform-provider'));
-        return initPlatformProvider(this, _fin, options);
-    }
-    observeBounds(element, onChange) {
-        return (0, bounds_observer_1.observeBounds)(element, onChange);
-    }
-    // eslint-disable-next-line class-methods-use-this
-    resolveUrl(url) {
-        const newUrl = new URL(url, location.href);
-        return newUrl.href;
-    }
-    whenReady() {
-        return __classPrivateFieldGet(this, _OpenFinEnvironment_ready, "f");
-    }
-}
-exports.default = OpenFinEnvironment;
-_OpenFinEnvironment_ready = new WeakMap();