@openfin/core 33.76.36 → 33.77.1

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

@@ -1,88 +0,0 @@
-import type * as OpenFin from '../../OpenFin';
-import { Base } from '../base';
-export default class ViewModule extends Base {
-    /**
-     * Creates a new View.
-     * @param options - View creation options
-     *
-     * @example
-     * ```js
-     * let view;
-     * async function createView() {
-     *     const me = await fin.Window.getCurrent();
-     *     return fin.View.create({
-     *         name: 'viewNameCreate',
-     *         target: me.identity,
-     *         bounds: {top: 10, left: 10, width: 200, height: 200}
-     *     });
-     * }
-     *
-     * createView()
-     *     .then((createdView) => {
-     *         view = createdView;
-     *         console.log('View created.', view);
-     *         view.navigate('https://google.com');
-     *         console.log('View navigated to given url.');
-     *     })
-     *     .catch(err => console.log(err));
-     * ```
-     * Note that created views needs to navigate somewhere for them to actually render a website.
-     * @experimental
-     * @static
-     */
-    create(options: OpenFin.ViewCreationOptions): Promise<OpenFin.View>;
-    /**
-     * Asynchronously returns a View object that represents an existing view.
-     * @param identity
-     *
-     * @example
-     * ```js
-     * fin.View.wrap({ uuid: 'testViewUuid', name: 'testViewName' }))
-     *     .then(view => console.log('wrapped view', view))
-     *     .catch(err => console.log(err));
-     * ```
-     * @experimental
-     * @static
-     */
-    wrap(identity: OpenFin.Identity): Promise<OpenFin.View>;
-    /**
-     * Synchronously returns a View object that represents an existing view.
-     * @param identity
-     *
-     * @example
-     * ```js
-     * const view = fin.View.wrapSync({ uuid: 'testView', name: 'testViewName' });
-     * await view.hide();
-     * ```
-     * @experimental
-     * @static
-     */
-    wrapSync(identity: OpenFin.Identity): OpenFin.View;
-    /**
-     * Asynchronously returns a View object that represents the current view
-     *
-     * @example
-     * ```js
-     * fin.View.getCurrent()
-     *     .then(view => console.log('current view', view))
-     *     .catch(err => console.log(err));
-     *
-     * ```
-     * @experimental
-     * @static
-     */
-    getCurrent(): Promise<OpenFin.View>;
-    /**
-     * Synchronously returns a View object that represents the current view
-     *
-     * @example
-     * ```js
-     * const view = fin.View.getCurrentSync();
-     * console.log(view);
-     *
-     * ```
-     * @experimental
-     * @static
-     */
-    getCurrentSync(): OpenFin.View;
-}

package/src/api/view/Factory.js

@@ -1,141 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const base_1 = require("../base");
-const validate_1 = require("../../util/validate");
-const index_1 = require("./index");
-class ViewModule extends base_1.Base {
-    /**
-     * Creates a new View.
-     * @param options - View creation options
-     *
-     * @example
-     * ```js
-     * let view;
-     * async function createView() {
-     *     const me = await fin.Window.getCurrent();
-     *     return fin.View.create({
-     *         name: 'viewNameCreate',
-     *         target: me.identity,
-     *         bounds: {top: 10, left: 10, width: 200, height: 200}
-     *     });
-     * }
-     *
-     * createView()
-     *     .then((createdView) => {
-     *         view = createdView;
-     *         console.log('View created.', view);
-     *         view.navigate('https://google.com');
-     *         console.log('View navigated to given url.');
-     *     })
-     *     .catch(err => console.log(err));
-     * ```
-     * Note that created views needs to navigate somewhere for them to actually render a website.
-     * @experimental
-     * @static
-     */
-    async create(options) {
-        const { uuid } = this.wire.me;
-        if (!options.name || typeof options.name !== 'string') {
-            throw new Error('Please provide a name property as a string in order to create a View.');
-        }
-        if (this.wire.environment.childViews) {
-            await this.wire.environment.createChildContent({
-                entityType: 'view',
-                options: { ...options, uuid }
-            });
-        }
-        else {
-            await this.wire.sendAction('create-view', { ...options, uuid });
-        }
-        return this.wrapSync({ uuid, name: options.name });
-    }
-    /**
-     * Asynchronously returns a View object that represents an existing view.
-     * @param identity
-     *
-     * @example
-     * ```js
-     * fin.View.wrap({ uuid: 'testViewUuid', name: 'testViewName' }))
-     *     .then(view => console.log('wrapped view', view))
-     *     .catch(err => console.log(err));
-     * ```
-     * @experimental
-     * @static
-     */
-    async wrap(identity) {
-        this.wire.sendAction('view-wrap');
-        const errorMsg = (0, validate_1.validateIdentity)(identity);
-        if (errorMsg) {
-            throw new Error(errorMsg);
-        }
-        return new index_1.View(this.wire, identity);
-    }
-    /**
-     * Synchronously returns a View object that represents an existing view.
-     * @param identity
-     *
-     * @example
-     * ```js
-     * const view = fin.View.wrapSync({ uuid: 'testView', name: 'testViewName' });
-     * await view.hide();
-     * ```
-     * @experimental
-     * @static
-     */
-    wrapSync(identity) {
-        this.wire.sendAction('view-wrap-sync').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        const errorMsg = (0, validate_1.validateIdentity)(identity);
-        if (errorMsg) {
-            throw new Error(errorMsg);
-        }
-        return new index_1.View(this.wire, identity);
-    }
-    /**
-     * Asynchronously returns a View object that represents the current view
-     *
-     * @example
-     * ```js
-     * fin.View.getCurrent()
-     *     .then(view => console.log('current view', view))
-     *     .catch(err => console.log(err));
-     *
-     * ```
-     * @experimental
-     * @static
-     */
-    getCurrent() {
-        this.wire.sendAction('view-get-current').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        if (!this.wire.me.isView) {
-            throw new Error('You are not in a View context');
-        }
-        const { uuid, name } = this.wire.me;
-        return this.wrap({ uuid, name });
-    }
-    /**
-     * Synchronously returns a View object that represents the current view
-     *
-     * @example
-     * ```js
-     * const view = fin.View.getCurrentSync();
-     * console.log(view);
-     *
-     * ```
-     * @experimental
-     * @static
-     */
-    getCurrentSync() {
-        this.wire.sendAction('view-get-current-sync').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        if (!this.wire.me.isView) {
-            throw new Error('You are not in a View context');
-        }
-        const { uuid, name } = this.wire.me;
-        return this.wrapSync({ uuid, name });
-    }
-}
-exports.default = ViewModule;