@openfin/core 33.76.36 → 33.77.1

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

@@ -1,601 +0,0 @@
-import type * as OpenFin from '../../OpenFin';
-import { Transport } from '../../transport/transport';
-import { WebContents } from '../webcontents/main';
-type UpdatableViewOptions = OpenFin.UpdatableViewOptions;
-type ViewEvent = OpenFin.ViewEvent;
-/**
- * @PORTED
- * @typedef {object} View~options
- * @summary View creation options.
- * @desc This is the options object required by {@link View.create View.create}.
- *
- * Note that `name` and `target` are the only required properties — albeit the `url` property is usually provided as well
- * (defaults to `"about:blank"` when omitted).
- *
- * @property {object} [experimental]
- * Configurations for API injection.
- *
- * @property {boolean} [experimental.childWindows] Configure if the runtime should enable child windows for views.
- *
- * @property {object} [accelerator]
- * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
- *
- * @property {boolean} [accelerator.devtools=false]
- * If `true`, enables the devtools keyboard shortcut:<br>
- * `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
- *
- * @property {boolean} [accelerator.reload=false]
- * If `true`, enables the reload keyboard shortcuts:<br>
- * `Ctrl` + `R` _(Windows)_<br>
- * `F5` _(Windows)_<br>
- * `Command` + `R` _(Mac)_
- *
- * @property {boolean} [accelerator.reloadIgnoringCache=false]
- * If `true`, enables the reload-from-source keyboard shortcuts:<br>
- * `Ctrl` + `Shift` + `R` _(Windows)_<br>
- * `Shift` + `F5` _(Windows)_<br>
- * `Command` + `Shift` + `R` _(Mac)_
- *
- * @property {boolean} [accelerator.zoom=false]
- * If `true`, enables the zoom keyboard shortcuts:<br>
- * `Ctrl` + `+` _(Zoom In)_<br>
- * `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
- * `Ctrl` + `NumPad+` _(Zoom In)_<br>
- * `Ctrl` + `-` _(Zoom Out)_<br>
- * `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
- * `Ctrl` + `NumPad-` _(Zoom Out)_<br>
- * `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
- * `Ctrl` + `0` _(Restore to 100%)_
- *
- * @property {object} [api]
- * Configurations for API injection.
- *
- * @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
- *
- * @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.
- *
- * @property {string} [backgroundColor="#FFF"] - _Updatable._
- * The view’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
- * (`document.body.style.backgroundColor`),
- * this color briefly fills a view’s (a) content area before its content is loaded as well as (b) newly exposed
- * areas when growing a window. Setting
- * this value to the anticipated content background color can help improve user experience.
- * Default is white.
- *
- * @property {object} [contentNavigation]
- * Restrict navigation to URLs that match an allowed pattern.
- * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
- * @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
- * @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
- *
- * @property {object} [contentRedirect]
- * Restrict redirects to URLs that match an allowed pattern.
- * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
- * @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
- * @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
- *
- * @property {object} [contextMenuSettings] - _Updatable._
- * Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
- * Configure the context menu when right-clicking on a view.
- * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
- * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
- * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
- *
- * @property {object} [contextMenuOptions] - _Updatable._
- * Configure the context menu when right-clicking on a view. Supported menu items:
- * 'separator'
- * 'cut'
- * 'copy'
- * 'copyImage',
- * 'paste'
- * 'spellCheck'
- * 'inspect'
- * 'reload'
- * 'navigateForward'
- * 'navigateBack'
- * 'print'
- * @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
- * @property {string[]} [contextMenuOptions.template=[]] List of context menu items to display on right-click.
- *
- * @property {any} [customData=""] - _Updatable._
- * A field that the user can attach serializable data to be ferried around with the view options.
- * _When omitted, the default value of this property is the empty string (`""`)._
- *
- * @property {any} [customContext=""] - _Updatable._
- * A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
- * is called.
- * When omitted, the default value of this property is the empty string (`""`).
- * As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
- *
- * @property {object[]} [hotkeys=[]] - _Updatable._
- * Defines the list of hotkeys that will be emitted as a `hotkey` event on the view. For usage example see [example]{@tutorial hotkeys}.
- * Within Platform, OpenFin also implements a set of pre-defined actions called
- * [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
- * that can be assigned to a specific hotkey in the platform manifest.
- * @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
- * @property {boolean} [hotkeys.preventDefault=false] preventDefault will prevent the page keydown/keyup events from being emitted.
- *
- * @property {boolean} [isClosable=true] **Platforms Only.** If false, the view will be persistent and can't be closed through
- * either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
- * if the view isn't part of the new layout when running `Layout.replace`.
- *
- * @property {string} name
- * The name of the view.
- *
- * @property {boolean} [detachOnClose=false] - _Updatable._
- * Platforms Only.  If true, will hide and detach the View from the window for later use instead of closing,
- * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
- *
- * @property {string} [manifestUrl] **Platforms Only.** Url to a manifest that contains View Options. Properties other than manifestUrl can still be used
- * but the properties in the manifest will take precedence if there is any collision.
- *
- * @property {preloadScript[]} [preloadScripts] - _Inheritable_
- * A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
- * from the parent application.
- *
- * @property {boolean} [preventDragOut=false] **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
- *
- * @property {string} [processAffinity=<application uuid>]
- * A string to attempt to group renderers together. Will only be used if pages are on the same origin.
- *
- * @property {boolean} [spellCheck=false]
- * Enable spell check in input text fields for the view.
- *
- * @property {Identity} [target]
- * The identity of the window this view should be attached to.
- *
- * @property {string} [url="about:blank"]
- * The URL of the view.
- *
- * @property {string} [uuid=<application uuid>]
- * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
- * If omitted, defaults to the `uuid` of the application spawning the view.
- * If given, must match the `uuid` of the application spawning the view.
- * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
- * really no need to provide it.
- */
-/**
- * A View can be used to embed additional web content into a Window.
- * It is like a child window, except it is positioned relative to its owning window.
- * It has the ability to listen for {@link OpenFin.ViewEvents View-specific events}.
- *
- * By default, a View will try to share the same renderer process as other Views owned by its parent Application.
- * To change that behavior, see the processAffinity {@link OpenFin.ViewOptions view option}.
- *
- * A View's lifecycle is tied to its owning window and can be re-attached to a different window at any point during its lifecycle.
- */
-export declare class View extends WebContents<ViewEvent> {
-    #private;
-    identity: OpenFin.Identity;
-    /**
-     * @internal
-     */
-    constructor(wire: Transport, identity: OpenFin.Identity);
-    /**
-     * Focuses the view
-     *
-     * @function focus
-     * @memberof View
-     * @emits focused
-     * @instance
-     * @example
-     * ```js
-     * const view = fin.View.wrapSync({ uuid: 'viewUuid', name: 'viewName' });
-     * await view.focus();
-     * // do things with the focused view
-     * ```
-     * @experimental
-     */
-    focus({ emitSynthFocused }?: {
-        emitSynthFocused: boolean;
-    }): Promise<void>;
-    /**
-     * Attaches the current view to the given window identity.
-     * Identity must be the identity of a window in the same application.
-     * This detaches the view from its current window, and sets the view to be destroyed when its new window closes.
-     * @param target {Identity}
-     *
-     * @example
-     * ```js
-     * let view;
-     * async function createView() {
-     *     const me = await fin.Window.getCurrent();
-     *     return fin.View.create({
-     *         name: 'viewNameAttach',
-     *         target: me.identity,
-     *         bounds: {top: 10, left: 10, width: 200, height: 200}
-     *     });
-     * }
-     *
-     * async function attachView() {
-     *     view = await createView();
-     *     console.log('View created.');
-     *
-     *     await view.navigate('https://google.com');
-     *     console.log('View navigated to given url.');
-     *
-     *     const winOption = {
-     *         name:'winOptionName',
-     *         defaultWidth: 300,
-     *         defaultHeight: 300,
-     *         url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.create.html',
-     *         frame: true,
-     *         autoShow: true
-     *     };
-     *     const newWindow = await fin.Window.create(winOption);
-     *     view.attach(newWindow.identity);
-     * }
-     *
-     * attachView()
-     *     .then(() => console.log('View attached to new window.'))
-     *     .catch(err => console.log(err));
-     * ```
-     * @experimental
-     */
-    attach: (target: OpenFin.Identity) => Promise<void>;
-    /**
-     * Destroys the current view
-     *
-     * @example
-     * ```js
-     * const view = fin.View.wrapSync({ uuid: 'viewUuid', name: 'viewName' });
-     * view.destroy();
-     * ```
-     * @experimental
-     */
-    destroy: () => Promise<void>;
-    /**
-     * Shows the current view if it is currently hidden.
-     *
-     * @example
-     * ```js
-     * let view;
-     * async function createView() {
-     *     const me = await fin.Window.getCurrent();
-     *     return fin.View.create({
-     *         name: 'viewNameShow',
-     *         target: me.identity,
-     *         bounds: {top: 10, left: 10, width: 200, height: 200}
-     *     });
-     * }
-     *
-     * async function hideAndShowView() {
-     *     view = await createView();
-     *     console.log('View created.');
-     *
-     *     await view.navigate('https://google.com');
-     *     console.log('View navigated to given url option.');
-     *
-     *     await view.hide();
-     *     console.log("View hidden.");
-     *
-     *     view.show();
-     *     console.log("View shown.");
-     * }
-     *
-     * hideAndShowView()
-     *     .then(() => console.log('View hidden and shown.'))
-     *     .catch(err => console.log(err));
-     * ```
-     * @experimental
-     */
-    show: () => Promise<void>;
-    /**
-     * Hides the current view if it is currently visible.
-     *
-     * @example
-     * ```js
-     * let view;
-     * async function createView() {
-     *     const me = await fin.Window.getCurrent();
-     *     return fin.View.create({
-     *         name: 'viewNameHide',
-     *         target: me.identity,
-     *         bounds: {top: 10, left: 10, width: 200, height: 200}
-     *     });
-     * }
-     *
-     * async function hideView() {
-     *     view = await createView();
-     *     console.log('View created.');
-     *
-     *     await view.navigate('https://google.com');
-     *     console.log('View navigated to given url.');
-     *
-     *     await view.hide();
-     * }
-     *
-     * hideView()
-     *     .then(() => console.log('View hidden.'))
-     *     .catch(err => console.log(err));
-     * ```
-     * @experimental
-     */
-    hide: () => Promise<void>;
-    /**
-     * Sets the bounds (top, left, width, height) of the view relative to its window.
-     * @param bounds {ViewBounds}
-     *
-     * @remarks View position is relative to the bounds of the window.
-     * ({top: 0, left: 0} represents the top left corner of the window)
-     *
-     * @example
-     * ```js
-     * let view;
-     * async function createView() {
-     *     const me = await fin.Window.getCurrent();
-     *     return fin.View.create({
-     *         name: 'viewNameSetBounds',
-     *         target: me.identity,
-     *         bounds: {top: 10, left: 10, width: 200, height: 200}
-     *     });
-     * }
-     *
-     * async function setViewBounds() {
-     *     view = await createView();
-     *     console.log('View created.');
-     *
-     *     await view.navigate('https://google.com');
-     *     console.log('View navigated to given url.');
-     *
-     *     await view.setBounds({
-     *         top: 100,
-     *         left: 100,
-     *         width: 300,
-     *         height: 300
-     *     });
-     * }
-     *
-     * setViewBounds()
-     *     .then(() => console.log('View set to new bounds.'))
-     *     .catch(err => console.log(err));
-     * ```
-     * @experimental
-     */
-    setBounds: (bounds: OpenFin.Bounds) => Promise<void>;
-    /**
-     * Gets the bounds (top, left, width, height) of the view relative to its window.
-     *
-     * @remarks View position is relative to the bounds of the window.
-     * ({top: 0, left: 0} represents the top left corner of the window)
-     *
-     * @example
-     * ```js
-     * const view = await fin.View.create({
-     *     name: 'viewNameSetBounds',
-     *     target: fin.me.identity,
-     *     bounds: {top: 10, left: 10, width: 200, height: 200}
-     * });
-     *
-     * await view.navigate('https://google.com');
-     *
-     * await view.setBounds({
-     *     top: 100,
-     *     left: 100,
-     *     width: 300,
-     *     height: 300
-     * });
-     *
-     * console.log(await view.getBounds());
-     * ```
-     * @experimental
-     */
-    getBounds: () => Promise<OpenFin.Bounds>;
-    /**
-     * Gets the View's info.
-     *
-     * @example
-     * ```js
-     * let view;
-     * async function createView() {
-     *     const me = await fin.Window.getCurrent();
-     *     return fin.View.create({
-     *         name: 'viewNameGetInfo',
-     *         target: me.identity,
-     *         bounds: {top: 10, left: 10, width: 200, height: 200}
-     *     });
-     * }
-     *
-     * async function getViewInfo() {
-     *     view = await createView();
-     *     console.log('View created.');
-     *
-     *     await view.navigate('https://google.com');
-     *     console.log('View navigated to given url.');
-     *
-     *     return view.getInfo();
-     * }
-     *
-     * getViewInfo()
-     *     .then((info) => console.log('View info fetched.', info))
-     *     .catch(err => console.log(err));
-     * ```
-     * @experimental
-     */
-    getInfo: () => Promise<OpenFin.ViewInfo>;
-    /**
-     * Retrieves the layout for the window the view is attached to.
-     *
-     * @example
-     * ```js
-     *     //get the current View
-     *     const view = await fin.View.getCurrent();
-     *
-     *     //get a reference to the Layout for the Window the view is part of
-     *     const layout = await view.getParentLayout();
-     * ```
-     * @experimental
-     */
-    getParentLayout: () => Promise<OpenFin.Layout>;
-    /**
-     * Gets the View's options.
-     *
-     * @example
-     * ```js
-     * let view;
-     * async function createView() {
-     *     const me = await fin.Window.getCurrent();
-     *     return fin.View.create({
-     *         name: 'viewNameGetOptions',
-     *         target: me.identity,
-     *         bounds: {top: 10, left: 10, width: 200, height: 200}
-     *     });
-     * }
-     *
-     * async function getViewOptions() {
-     *     view = await createView();
-     *     console.log('View created.');
-     *
-     *     await view.navigate('https://google.com');
-     *     console.log('View navigated to given url.');
-     *
-     *     const me = await fin.Window.getCurrent();
-     *     view = fin.View.wrapSync({ uuid: me.identity.uuid, name: 'viewNameGetOptions' });
-     *     return view.getOptions();
-     * }
-     *
-     * getViewOptions()
-     *     .then((info) => console.log('View options fetched.', info))
-     *     .catch(err => console.log(err));
-     * ```
-     * @experimental
-     */
-    getOptions: () => Promise<OpenFin.ViewOptions>;
-    /**
-     * Updates the view's options.
-     * @param options
-     *
-     * @example
-     * ```js
-     * let view;
-     * async function createView() {
-     *     const me = await fin.Window.getCurrent();
-     *     return fin.View.create({
-     *         url: 'https://google.com',
-     *         name: 'viewNameUpdateOptions',
-     *         target: me.identity,
-     *         bounds: {top: 10, left: 10, width: 200, height: 200}
-     *     });
-     * }
-     *
-     * async function updateViewOptions() {
-     *     view = await createView();
-     *     console.log('View created.');
-     *
-     *     await view.navigate('https://google.com');
-     *     console.log('View navigated to given url option.');
-     *
-     *     const newOptions = { autoResize: {
-     *         width: true,
-     *         horizontal: true
-     *     }};
-     *     return view.updateOptions(newOptions);
-     * }
-     *
-     * updateViewOptions()
-     *     .then(payload => console.log('View options updated: ', payload))
-     *     .catch(err => console.log(err));
-     * ```
-     * @experimental
-     */
-    updateOptions: (options: UpdatableViewOptions) => Promise<void>;
-    /**
-     * Retrieves the window the view is currently attached to.
-     *
-     * @experimental
-     * @example
-     * ```js
-     * const view = fin.View.wrapSync({ uuid: 'viewUuid', name: 'viewName' });
-     * view.getCurrentWindow()
-     *     .then(win => console.log('current window', win))
-     *     .catch(err => console.log(err));)
-     * ```
-     */
-    getCurrentWindow: () => Promise<OpenFin.Window>;
-    /**
-     * Retrieves the current {@link OpenFin.TabStack} of the view if it belongs to one.
-     * @returns this view belongs to.
-     * @throws if this view does not belong to a TabStack or if the window has been destroyed.
-     * @example
-     * ```js
-     * if (!fin.me.isView) {
-     *     throw new Error('Not running in a platform View.');
-     * }
-     *
-     * const stack = await fin.me.getCurrentStack();
-     * // Alternatively, you can wrap any view and get the stack from there
-     * // const viewFromSomewhere = fin.View.wrapSync(someView.identity);
-     * // const stack = await viewFromSomewhere.getCurrentStack();
-     * const views = await stack.getViews();
-     * console.log(`Stack contains ${views.length} view(s)`);
-     * ```
-     */
-    getCurrentStack: () => Promise<OpenFin.TabStack>;
-    /**
-     * Triggers the before-unload handler for the View, if one is set.
-     *
-     * @remarks Returns `true` if the handler is trying to prevent the View from unloading, and `false` if it isn't.
-     * Only enabled when setting enableBeforeUnload: true in your View options. If this option is not enabled it will
-     * always return false.
-     *
-     * This method is used internally by the Platform Provider to determine the status of each before unload handler in Views when closing the Window.
-     *
-     * @example
-     *
-     * ```js
-     * // from inside a View context
-     * const unloadPrevented = await fin.me.triggerBeforeUnload();
-     * ```
-     *
-     * @experimental
-     */
-    triggerBeforeUnload: () => Promise<boolean>;
-    /**
-     * **NOTE**: Internal use only.
-     * Attaches this view to an HTML element in the current context. The view will resize responsively when the element bounds change.
-     *
-     * **Known issue**: View.bindToElement does not track position changes, if the element has fixed px width and height values it is possible for the view to not update responsively.
-     *
-     * **Known issue**: When View.bindToElement is used on a element that takes up the entire page in a platform window, the bound view will not respond responsively when the window is resized to be smaller.
-     *
-     * @param element - HTML element to attach the view to.
-     * @returns - Cleanup function that will disconnect the element resize observer.
-     * @internal
-     * @experimental
-     * @remarks View will resize accordingly when the element is resized. If the element is repositioned in the DOM the view will not be repositioned, to handle this case call `bindToElement` again once the element changes position.
-     *
-     * @example
-     * ```html
-     * <div id="view-container"></div>
-     * <script>
-     *     async function createAndAttachView() {
-     *         const url = 'https://example.com';
-     *         const elementId = 'view-container';
-     *         const element = document.getElementById(elementId);
-     *         const view = await fin.View.create({
-     *             name: 'my-view',
-     *             url,
-     *             target: fin.me.identity
-     *         });
-     *         await view.navigate(url);
-     *         await view.bindToElement(element);
-     *     }
-     *     createAndAttachView().catch(console.error);
-     * </script>
-     * ```
-     */
-    bindToElement: (element: HTMLElement) => Promise<() => void>;
-}
-export {};