@openfin/core 33.76.36 → 33.77.1

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

@@ -1,421 +0,0 @@
-/**
- * Namespace for events that can be transmitted on an OpenFin Window's EventEmitter.
- *
- * Window events fall into two categories: propagated and non-propagated.  Propagated events will
- * be re-emitted on the parent application of the target window, prefixed with "window-".  For example,
- * a window's "reloaded" event will be re-emitted on the parent application as "window-reloaded".  Non-propagated
- * events will not be re-emitted on the parent application.
- *
- * @packageDocumentation
- */
-import type * as OpenFin from '../../OpenFin';
-import { NamedEvent, PropagatedEvent } from './base';
-import { BaseViewEvent, PropagatedViewEvent, AttachedEvent as ViewAttachedEvent } from './view';
-import { NonPropagatedWebContentsEvent, WillPropagateWebContentsEvent } from './webcontents';
-/**
- * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
- */
-export type AlertRequestedEvent = NamedEvent & {
-    type: 'alert-requested';
-    message: string;
-    url: string;
-};
-/**
- * Generated when a window within this application requires credentials from the user.
- * @remarks When a proxy exists, our default behavior shows an auth dialog, and asks users to enter their username and password.
- * If you would like to change the default behavior, you can use the 'window-auth-requested' event to override it.
- *
- * Show customized auth dialog instead of default auth dialog:
- * ```js
- *
- * // Sample code to create a login window. Users can create their own login pages
- * async function createAuthUI(identity, loginPageUrl, authInfo) {
- *     const winName = 'my-auth-win-' + Date.now();
- *     const uriUuid = encodeURIComponent(identity.uuid);
- *     const uriName = encodeURIComponent(identity.name);
- *
- *     const url = `http://${authInfo.host}:${authInfo.port}`;
- *     // login page should handle these query params
- * 	loginPageUrl = `${loginPageUrl}?uuid=${uriUuid}&name=${uriName}&url=${url}`;
- * 	await fin.Window.create({
- *         url: loginPageUrl,
- *         uuid: identity.uuid,
- *         name: winName,
- *         alwaysOnTop: true,
- *         autoShow: true,
- *         defaultCentered: true,
- *         defaultHeight: 271,
- *         defaultTop: true,
- *         defaultWidth: 362,
- *         frame: false,
- *         resizable: false
- * 	});
- * }
- *
- * const app = fin.Application.getCurrentSync();
- * app.on('window-auth-requested', (event) => {
- *     if (event.authInfo.isProxy) {
- *         const identity = { uuid: event.uuid, name: event.name};
- *         createAuthUI(identity, 'userLoginPageUrl', event.authInfo);
- *     }
- *
- * });
- * ```
- *
- * Don't show any auth dialog:
- * ```js
- * const app = fin.Application.getCurrentSync();
- * app.on('window-auth-requested', event => {
- *     if (event.authInfo.isProxy) {
- *         console.log('no auth dialog');
- *     }
- * });
- * ```
- *
- * User defined function. For example, showing a single dialog, alerting a support team and so on:
- * ```js
- * const app = fin.Application.getCurrentSync();
- * app.on('window-auth-requested', event => {
- *     if (event.authInfo.isProxy) {
- *         // user defined function
- *         alert('Do whatever you like');
- *     }
- * });
- * ```
- */
-export type AuthRequestedEvent = NamedEvent & {
-    type: 'auth-requested';
-    authInfo: {
-        host: string;
-        isProxy: boolean;
-        port: number;
-        realm: string;
-        scheme: string;
-    };
-};
-/**
- * Generated when a window ends loading.
- */
-export type EndLoadEvent = NamedEvent & {
-    type: 'end-load';
-    documentName: string;
-    isMain: boolean;
-};
-/**
- * Generated when window is being redirected as per contentRedirect allowlist/denylist rules.
- */
-export type WillRedirectEvent = NamedEvent & {
-    type: 'will-redirect';
-    blocked: boolean;
-    isInPlace: boolean;
-    url: string;
-};
-/**
- * Generated when a window has been reloaded.
- */
-export type ReloadedEvent = NamedEvent & {
-    type: 'reloaded';
-    url: string;
-};
-/**
- * Generated after window options are changed using the window.updateOptions method.
- * @remarks Will not fire if the diff object is empty.
- */
-export type WindowOptionsChangedEvent = NamedEvent & {
-    type: 'options-changed';
-    options: OpenFin.WindowOptions;
-    diff: OpenFin.WindowOptionDiff;
-};
-/**
- * Generated when an external process has exited.
- */
-export type ExternalProcessExitedEvent = NamedEvent & {
-    type: 'external-process-exited';
-    processUuid: string;
-    exitCode: number;
-};
-/**
- * Generated when an external process has started.
- */
-export type ExternalProcessStartedEvent = NamedEvent & {
-    type: 'external-process-started';
-    processUuid: string;
-};
-/**
- * Generated when a window has been hidden.
- */
-export type HiddenEvent = NamedEvent & {
-    type: 'hidden';
-    reason: 'closing' | 'hide' | 'hide-on-close';
-};
-/**
- * Preload script running state info during the execution of a window's preload script.
- */
-export type PreloadScriptInfoRunning = {
-    state: 'load-started' | 'load-failed' | 'load-succeeded' | 'failed' | 'succeeded';
-};
-/**
- * Preload script final state info after the execution of all of a window's preload scripts.
- */
-export type PreloadScriptInfo = {
-    state: 'load-failed' | 'failed' | 'succeeded';
-};
-/**
- * A general preload scripts state change event without event type.
- */
-export type PreloadScriptsStateChangeEvent = NamedEvent & {
-    preloadScripts: (PreloadScriptInfoRunning & any)[];
-};
-/**
- * A general user bounds change event without event type.
- */
-export type UserBoundsChangeEvent = NamedEvent & {
-    height: number;
-    left: number;
-    top: number;
-    width: number;
-    windowState: 'minimized' | 'normal' | 'maximized';
-};
-/**
- * A general bounds change event without event type.
- */
-export type BoundsChangeEvent = NamedEvent & {
-    changeType: 0 | 1 | 2;
-    deferred: boolean;
-    height: number;
-    left: number;
-    top: number;
-    width: number;
-};
-/**
- * A general will-move or will-resize event without event type.
- */
-export type WillMoveOrResizeEvent = NamedEvent & {
-    height: number;
-    left: number;
-    top: number;
-    width: number;
-    monitorScaleFactor: number;
-};
-/**
- * Generated when window finishes loading. Provides performance and navigation data.
- */
-export type PerformanceReportEvent = Performance & NamedEvent & {
-    type: 'performance-report';
-};
-/**
- * Generated when a window has a view detached from it.
- * @remarks Will fire when a view is destroyed in which case `target` will be null.
- */
-export type ViewDetachedEvent = NamedEvent & BaseViewEvent & {
-    type: 'view-detached';
-    previousTarget: OpenFin.Identity;
-};
-/**
- * Generated when the value of the element changes.
- */
-export type InputEvent = {
-    inputType: 'keyUp' | 'keyDown';
-    ctrlKey: boolean;
-    shiftKey: boolean;
-    altKey: boolean;
-    metaKey: boolean;
-    key: string;
-    code: string;
-    repeat: boolean;
-    command?: string;
-};
-/**
- * Generated when a window and all of its layout's views have either finished or failed navigation.
- */
-export type LayoutInitializedEvent = NamedEvent & {
-    type: 'layout-initialized';
-    ofViews: (OpenFin.Identity & {
-        entityType: 'view';
-    })[];
-};
-/**
- * Generated when a window and all of its layout's views have been created and can receive API calls.
- */
-export type LayoutReadyEvent = NamedEvent & {
-    type: 'layout-ready';
-    views: (OpenFin.Identity & {
-        success: boolean;
-    })[];
-};
-/**
- * A Window event that does not propagate to (republish on) parent topics.
- */
-export type NonPropagatedWindowEvent = NonPropagatedWebContentsEvent;
-/**
- * Generated at the beginning of a user-driven change to a window's size or position.
- */
-export type BeginUserBoundsChangingEvent = UserBoundsChangeEvent & {
-    type: 'begin-user-bounds-changing';
-};
-/**
- * Generated after changes in a window's size and/or position.
- */
-export type BoundsChangedEvent = BoundsChangeEvent & {
-    type: 'bounds-changed';
-};
-/**
- * Generated during changes to a window's size and/or position.
- */
-export type BoundsChangingEvent = BoundsChangeEvent & {
-    type: 'bounds-changing';
-};
-/**
- * Generated when a window has been prevented from closing.
- * @remarks A window will be prevented from closing by default, either through the API or by a user when ‘close-requested’ has been subscribed to and the Window.close(force) flag is false.
- */
-export type WindowCloseRequestedEvent = NamedEvent & {
-    type: 'close-requested';
-};
-/**
- * Generated when a window has closed.
- */
-export type WindowClosedEvent = NamedEvent & {
-    type: 'closed';
-};
-/**
- * Generated when a window has initiated the closing routine.
- */
-export type WindowClosingEvent = NamedEvent & {
-    type: 'closing';
-};
-/**
- * Generated after a change to a window's size and/or position is attempted while window movement is disabled.
- */
-export type DisabledMovementBoundsChangedEvent = BoundsChangeEvent & {
-    type: 'disabled-movement-bounds-changed';
-};
-/**
- * Generated while a change to a window's size and/or position is attempted while window movement is disabled.
- */
-export type DisabledMovementBoundsChangingEvent = BoundsChangeEvent & {
-    type: 'disabled-movement-bounds-changing';
-};
-/**
- * Generated when a window has been embedded.
- */
-export type EmbeddedEvent = NamedEvent & {
-    type: 'embedded';
-};
-/**
- * Generated at the end of a user-driven change to a window's size or position.
- */
-export type EndUserBoundsChangingEvent = UserBoundsChangeEvent & {
-    type: 'end-user-bounds-changing';
-};
-/**
- * Generated when a keyboard shortcut defined in the `hotkeys` array in [Window options](OpenFin.WindowOptions.html) is pressed inside the window.
- * @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
- */
-export type WindowHotkeyEvent = InputEvent & NamedEvent & {
-    type: 'hotkey';
-};
-/**
- * Generated when a window is initialized.
- */
-export type WindowInitializedEvent = NamedEvent & {
-    type: 'initialized';
-};
-/**
- * Generated when a window is maximized.
- */
-export type MaximizedEvent = NamedEvent & {
-    type: 'maximized';
-};
-/**
- * Generated when a window is minimized.
- */
-export type MinimizedEvent = NamedEvent & {
-    type: 'minimized';
-};
-/**
- * Generated after the execution of all of a window's preload scripts.
- * @remarks Contains information about all window's preload scripts' final states.
- */
-export type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
-    type: 'preload-script-state-changed';
-};
-/**
- * Generated during the execution of a window's preload script.
- * @remarks Contains information about a single window's preload script's state, for which the event has been raised.
- */
-export type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
-    type: 'preload-script-state-changing';
-};
-/**
- * Generated when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
- */
-export type WindowRestoredEvent = NamedEvent & {
-    type: 'restored';
-};
-/**
- * Generated when a window has been prevented from showing.
- * @remarks A window will be prevented from showing by default, either through the API or by a user when ‘show-requested’ has been subscribed to on the window or 'window-show-requested' on the parent application and the Window.show(force) flag is false.
- */
-export type WindowShowRequestedEvent = NamedEvent & {
-    type: 'show-requested';
-};
-/**
- * Generated when a hidden window has been shown.
- */
-export type WindowShownEvent = NamedEvent & {
-    type: 'shown';
-};
-/**
- * Generated when a window's user movement becomes enabled.
- */
-export type UserMovementEnabledEvent = NamedEvent & {
-    type: 'user-movement-enabled';
-};
-/**
- * Generated when a window's user movement becomes disabled.
- */
-export type UserMovementDisabledEvent = NamedEvent & {
-    type: 'user-movement-disabled';
-};
-/**
- * Generated when a window is being moved by the user.
- * @remarks For use with monitor scaling that is not 100%. Bounds are given in DIP (adjusted for monitor scale factor).
- */
-export type WillMoveEvent = WillMoveOrResizeEvent & {
-    type: 'will-move';
-};
-/**
- * Generated when a window is being resized by the user.
- * @remarks For use with monitor scaling that is not 100%. Bounds are given in DIP (adjusted for monitor scale factor).
- * The event will fire when a user resize is blocked by window options such as maxWidth or minHeight but not if the window is not resizable.
- */
-export type WillResizeEvent = WillMoveOrResizeEvent & {
-    type: 'will-resize';
-};
-/**
- * A propagated View event that is re-propagated from window.
- */
-export type PropagatedViewAttachedEvent = PropagatedEvent<'view', ViewAttachedEvent>;
-/**
- * A Window event that does propagate to (republish on) parent topics.
- */
-export type WillPropagateWindowEvent = WillPropagateWebContentsEvent | PropagatedViewAttachedEvent | ViewDetachedEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | WindowCloseRequestedEvent | WindowClosedEvent | WindowClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | HiddenEvent | WindowHotkeyEvent | WindowInitializedEvent | LayoutInitializedEvent | LayoutReadyEvent | MaximizedEvent | MinimizedEvent | WindowOptionsChangedEvent | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | WindowRestoredEvent | WindowShowRequestedEvent | WindowShownEvent | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillRedirectEvent | WillResizeEvent;
-/**
- * A Window event.
- */
-export type WindowEvent = {
-    topic: 'window';
-} & (WillPropagateWindowEvent | NonPropagatedWindowEvent | PropagatedViewEvent);
-/**
- * A Window event type.
- */
-export type WindowEventType = WindowEvent['type'];
-/**
- * A propagated Window event.
- */
-export type PropagatedWindowEvent = PropagatedEvent<'window', Exclude<WillPropagateWindowEvent, WindowCloseRequestedEvent>>;
-/**
- * A propagated Window event type.
- */
-export type PropagatedWindowEventType = PropagatedWindowEvent['type'];

package/src/api/events/window.js

@@ -1,12 +0,0 @@
-"use strict";
-/**
- * Namespace for events that can be transmitted on an OpenFin Window's EventEmitter.
- *
- * Window events fall into two categories: propagated and non-propagated.  Propagated events will
- * be re-emitted on the parent application of the target window, prefixed with "window-".  For example,
- * a window's "reloaded" event will be re-emitted on the parent application as "window-reloaded".  Non-propagated
- * events will not be re-emitted on the parent application.
- *
- * @packageDocumentation
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/src/api/external-application/Factory.d.ts

@@ -1,34 +0,0 @@
-import type * as OpenFin from '../../OpenFin';
-import { Base } from '../base';
-export default class ExternalApplicationModule extends Base {
-    /**
-     * Asynchronously returns an External Application object that represents an external application.
-     * <br>It is possible to wrap a process that does not yet exist, (for example, to listen for startup-related events)
-     * provided its uuid is already known.
-     * @param uuid The UUID of the external application to be wrapped
-     *
-     * @example
-     * ```js
-     * fin.ExternalApplication.wrap('javaApp-uuid');
-     * .then(extApp => console.log('wrapped external application'))
-     * .catch(err => console.log(err));
-     * ```
-     * @static
-     */
-    wrap(uuid: string): Promise<OpenFin.ExternalApplication>;
-    /**
-     * Synchronously returns an External Application object that represents an external application.
-     * <br>It is possible to wrap a process that does not yet exist, (for example, to listen for startup-related events)
-     * provided its uuid is already known.
-     * @param uuid The UUID of the external application to be wrapped
-     *
-     * @example
-     * ```js
-     * const extApp = fin.ExternalApplication.wrapSync('javaApp-uuid');
-     * const info = await extApp.getInfo();
-     * console.log(info);
-     * ```
-     * @static
-     */
-    wrapSync(uuid: string): OpenFin.ExternalApplication;
-}

package/src/api/external-application/Factory.js

@@ -1,47 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const base_1 = require("../base");
-const Instance_1 = require("./Instance");
-class ExternalApplicationModule extends base_1.Base {
-    /**
-     * Asynchronously returns an External Application object that represents an external application.
-     * <br>It is possible to wrap a process that does not yet exist, (for example, to listen for startup-related events)
-     * provided its uuid is already known.
-     * @param uuid The UUID of the external application to be wrapped
-     *
-     * @example
-     * ```js
-     * fin.ExternalApplication.wrap('javaApp-uuid');
-     * .then(extApp => console.log('wrapped external application'))
-     * .catch(err => console.log(err));
-     * ```
-     * @static
-     */
-    wrap(uuid) {
-        this.wire.sendAction('external-application-wrap').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        return Promise.resolve(new Instance_1.ExternalApplication(this.wire, { uuid }));
-    }
-    /**
-     * Synchronously returns an External Application object that represents an external application.
-     * <br>It is possible to wrap a process that does not yet exist, (for example, to listen for startup-related events)
-     * provided its uuid is already known.
-     * @param uuid The UUID of the external application to be wrapped
-     *
-     * @example
-     * ```js
-     * const extApp = fin.ExternalApplication.wrapSync('javaApp-uuid');
-     * const info = await extApp.getInfo();
-     * console.log(info);
-     * ```
-     * @static
-     */
-    wrapSync(uuid) {
-        this.wire.sendAction('external-application-wrap-sync').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        return new Instance_1.ExternalApplication(this.wire, { uuid });
-    }
-}
-exports.default = ExternalApplicationModule;

package/src/api/external-application/Instance.d.ts

@@ -1,110 +0,0 @@
-import type * as OpenFin from '../../OpenFin';
-import { EmitterBase } from '../base';
-import { Transport } from '../../transport/transport';
-/**
- * An ExternalApplication object representing native language adapter connections to the runtime. Allows
- * the developer to listen to {@link OpenFin.ExternalApplicationEvents external application events}.
- * Discovery of connections is provided by <a href="tutorial-System.getAllExternalApplications.html">getAllExternalApplications.</a>
- *
- * Processes that can be wrapped as `ExternalApplication`s include the following:
- * - Processes which have connected to an OpenFin runtime via an adapter
- * - Processes started via `System.launchExternalApplication`
- * - Processes monitored via `System.monitorExternalProcess`
- */
-export declare class ExternalApplication extends EmitterBase<OpenFin.ExternalApplicationEvent> {
-    identity: OpenFin.ApplicationIdentity;
-    /**
-     * @internal
-     */
-    constructor(wire: Transport, identity: OpenFin.ApplicationIdentity);
-    /**
-     * Adds a listener to the end of the listeners array for the specified event.
-     * @param eventType  - The type of the event.
-     * @param listener - Called whenever an event of the specified type occurs.
-     * @param options - Option to support event timestamps.
-     *
-     * @function addListener
-     * @memberof ExternalApplication
-     * @instance
-     * @tutorial ExternalApplication.EventEmitter
-     */
-    /**
-     * Adds a listener to the end of the listeners array for the specified event.
-     * @param eventType  - The type of the event.
-     * @param listener - Called whenever an event of the specified type occurs.
-     * @param options - Option to support event timestamps.
-     *
-     * @function on
-     * @memberof ExternalApplication
-     * @instance
-     * @tutorial ExternalApplication.EventEmitter
-     */
-    /**
-     * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
-     * @param eventType  - The type of the event.
-     * @param listener - The callback function.
-     * @param options - Option to support event timestamps.
-     *
-     * @function once
-     * @memberof ExternalApplication
-     * @instance
-     * @tutorial ExternalApplication.EventEmitter
-     */
-    /**
-     * Adds a listener to the beginning of the listeners array for the specified event.
-     * @param eventType  - The type of the event.
-     * @param listener - The callback function.
-     * @param options - Option to support event timestamps.
-     *
-     * @function prependListener
-     * @memberof ExternalApplication
-     * @instance
-     * @tutorial ExternalApplication.EventEmitter
-     */
-    /**
-     * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
-     * The listener is added to the beginning of the listeners array.
-     * @param eventType  - The type of the event.
-     * @param listener - The callback function.
-     * @param options - Option to support event timestamps.
-     *
-     * @function prependOnceListener
-     * @memberof ExternalApplication
-     * @instance
-     * @tutorial ExternalApplication.EventEmitter
-     */
-    /**
-     * Remove a listener from the listener array for the specified event.
-     * Caution: Calling this method changes the array indices in the listener array behind the listener.
-     * @param eventType  - The type of the event.
-     * @param listener - The callback function.
-     * @param options - Option to support event timestamps.
-     *
-     * @function removeListener
-     * @memberof ExternalApplication
-     * @instance
-     * @tutorial ExternalApplication.EventEmitter
-     */
-    /**
-     * Removes all listeners, or those of the specified event.
-     * @param eventType  - The type of the event.
-     *
-     * @function removeAllListeners
-     * @memberof ExternalApplication
-     * @instance
-     * @tutorial ExternalApplication.EventEmitter
-     */
-    /**
-     * Retrieves information about the external application.
-     *
-     * @example
-     * ```js
-     * async function getInfo() {
-     *     const extApp = await fin.ExternalApplication.wrap('javaApp-uuid');
-     *     return await extApp.getInfo();
-     * }
-     * getInfo().then(info => console.log(info)).catch(err => console.log(err));
-     * ```
-     */
-    getInfo(): Promise<OpenFin.ExternalApplicationInfo>;
-}