@openfin/core 33.76.36 → 33.77.1

package/src/api/clipboard/index.js

@@ -1,200 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const base_1 = require("../base");
-/**
- * @PORTED
- * WriteRequestType interface
- * @typedef { object } WriteRequestType
- * @property { string } data Data to be written
- * @property { string } [type] Clipboard Type
- */
-/**
- * @PORTED
- * OpenFin.WriteAnyClipboardRequest interface
- * @typedef { object } OpenFin.WriteAnyClipboardRequest
- * @property { string } data Data to be written
- * @property { OpenFin.ClipboardSelectionType } [type] Clipboard Type defaults to 'clipboard', use 'selection' for linux
- */
-/**
- * The Clipboard API allows reading and writing to the clipboard in multiple formats.
- *
- */
-class Clipboard extends base_1.Base {
-    /**
-     * Writes data into the clipboard as plain text
-     * @param writeObj The object for writing data into the clipboard
-     *
-     * @example
-     * ```js
-     * fin.Clipboard.writeText({
-     *     data: 'hello, world'
-     * }).then(() => console.log('Text On clipboard')).catch(err => console.log(err));
-     * ```
-     */
-    async writeText(writeObj) {
-        await this.wire.sendAction('clipboard-write-text', writeObj);
-    }
-    /**
-     * Read the content of the clipboard as plain text
-     * @param type Clipboard Type defaults to 'clipboard', use 'selection' for linux
-     *
-     * @example
-     * ```js
-     * fin.Clipboard.readText().then(text => console.log(text)).catch(err => console.log(err));
-     * ```
-     */
-    async readText(type) {
-        // NOTE: When we start supporting linux, we could detect the OS and choose 'selection' automatically for the user
-        const { payload } = await this.wire.sendAction('clipboard-read-text', { type });
-        return payload.data;
-    }
-    /**
-     * Writes data into the clipboard as an Image
-     * @param writeRequest The object to write an image to the clipboard
-     *
-     * @example
-     * ```js
-     * fin.Clipboard.writeImage({
-     *   // raw base64 string, or dataURL of either data:image/png or data:image/jpeg type
-     *   image: '...'
-     * }).then(() => console.log('Image written to clipboard')).catch(err => console.log(err));
-     * ```
-     */
-    async writeImage(writeRequest) {
-        await this.wire.sendAction('clipboard-write-image', writeRequest);
-    }
-    /**
-     * Read the content of the clipboard as a base64 string or a dataURL based on the input parameter 'format', defaults to 'dataURL'
-     * @param readRequest Clipboard Read Image request with formatting options
-     *
-     * @example
-     * ```js
-     * // see TS type: OpenFin.ImageFormatOptions
-     *
-     * const pngOrDataURLOrBmpOptions = {
-     *     format: 'png', // can be: 'png' | 'dataURL' | 'bmp'
-     * };
-     *
-     * const jpgOptions = {
-     *     format: 'jpg',
-     *     quality: 80 // optional, if omitted defaults to 100
-     * };
-     *
-     * fin.Clipboard.readImage(pngOrDataURLOrBmpOptions)
-     *     .then(image => console.log('Image read from clipboard as PNG, DataURL or BMP', image))
-     *     .catch(err => console.log(err));
-     *
-     * fin.Clipboard.readImage(jpgOptions)
-     *     .then(image => console.log('Image read from clipboard as JPG', image))
-     *     .catch(err => console.log(err));
-     *
-     * // defaults to {format: 'dataURL'}
-     * fin.Clipboard.readImage()
-     *     .then(image => console.log('Image read from clipboard as DataURL', image))
-     *     .catch(err => console.log(err));
-     *
-     * ```
-     */
-    async readImage(readRequest = { format: 'dataURL' }) {
-        const { payload } = await this.wire.sendAction('clipboard-read-image', readRequest);
-        return payload.data;
-    }
-    /**
-     * Writes data into the clipboard as Html
-     * @param writeObj The object for writing data into the clipboard
-     *
-     * @example
-     * ```js
-     * fin.Clipboard.writeHtml({
-     *         data: '<h1>Hello, World!</h1>'
-     * }).then(() => console.log('HTML On clipboard')).catch(err => console.log(err));
-     * ```
-     */
-    async writeHtml(writeObj) {
-        await this.wire.sendAction('clipboard-write-html', writeObj);
-    }
-    /**
-     * Read the content of the clipboard as Html
-     * @param type Clipboard Type defaults to 'clipboard', use 'selection' for linux
-     *
-     * @example
-     * ```js
-     * fin.Clipboard.readHtml().then(html => console.log(html)).catch(err => console.log(err));
-     * ```
-     */
-    async readHtml(type) {
-        const { payload } = await this.wire.sendAction('clipboard-read-html', { type });
-        return payload.data;
-    }
-    /**
-     * Writes data into the clipboard as Rtf
-     * @param writeObj The object for writing data into the clipboard
-     *
-     * @example
-     * ```js
-     * fin.Clipboard.writeRtf({
-     *         data: 'some text goes here'
-     * }).then(() => console.log('RTF On clipboard')).catch(err => console.log(err));
-     * ```
-     */
-    async writeRtf(writeObj) {
-        await this.wire.sendAction('clipboard-write-rtf', writeObj);
-    }
-    /**
-     * Read the content of the clipboard as Rtf
-     * @param type Clipboard Type defaults to 'clipboard', use 'selection' for linux
-     *
-     * @example
-     *
-     * ```js
-     * const writeObj = {
-     *     data: 'some text goes here'
-     * };
-     * async function readRtf() {
-     *     await fin.Clipboard.writeRtf(writeObj);
-     *     return await fin.Clipboard.readRtf();
-     * }
-     * readRtf().then(rtf => console.log(rtf)).catch(err => console.log(err));
-     * ```
-     */
-    async readRtf(type) {
-        const { payload } = await this.wire.sendAction('clipboard-read-rtf', { type });
-        return payload.data;
-    }
-    /**
-     * Writes data into the clipboard
-     * @param writeObj The object for writing data into the clipboard
-     *
-     * @example
-     * ```js
-     * fin.Clipboard.write({
-     *   data: {
-     *     text: 'a',
-     *     html: 'b',
-     *     rtf: 'c',
-     *     // Can be either a base64 string, or a DataURL string. If using DataURL, the
-     *     // supported formats are `data:image/png[;base64],` and `data:image/jpeg[;base64],`.
-     *     // Using other image/<format> DataURLs will throw an Error.
-     *     image: '...'
-     *   }
-     * }).then(() => console.log('write data into clipboard')).catch(err => console.log(err));
-     * ```
-     */
-    async write(writeObj) {
-        await this.wire.sendAction('clipboard-write', writeObj);
-    }
-    /**
-     * Reads available formats for the clipboard type
-     * @param type Clipboard Type defaults to 'clipboard', use 'selection' for linux
-     *
-     * @example
-     * ```js
-     * fin.Clipboard.getAvailableFormats().then(formats => console.log(formats)).catch(err => console.log(err));
-     * ```
-     */
-    async getAvailableFormats(type) {
-        const { payload } = await this.wire.sendAction('clipboard-read-formats', { type });
-        return payload.data;
-    }
-}
-exports.default = Clipboard;

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

@@ -1,158 +0,0 @@
-/**
- * Namespace for events that can be transmitted on an OpenFin Application's EventEmitter.  Includes events
- * re-propagate from the `Window` (and, transitively, `View`) level, prefixed with `window-` (and also, if applicable, `view-`).
- * For example, a view's "shown" event will fire as 'window-view-shown' at the application level.
- *
- * Application events re-propagate to the system level, prefixed with `application-`.  For example,
- * the `closed` event will fire as `application-closed` at the system level.  Propagated events from
- * WebContents within an application will *not* transitively re-propagate to the system level, because they are already
- * visible at the system level and contain the identity of the application.
- *
- * @packageDocumentation
- */
-import type * as OpenFin from '../../OpenFin';
-import { IdentityEvent, NamedEvent, PropagatedEvent } from './base';
-import { PropagatedWindowEvent } from './window';
-import { PropagatedViewEvent } from './view';
-/**
- * Generated when an application has crashed.
- */
-export type CrashedEvent = NamedEvent & {
-    type: 'crashed';
-    reason: 'normal-termination' | 'abnormal-termination' | 'killed' | 'crashed' | 'still-running' | 'launch-failed' | 'out-of-memory' | 'integrity-failure';
-    exitCode: number;
-    details: {
-        reason: string;
-        exitCode: number;
-    };
-};
-/**
- * Generated when setFileDownloadLocation api is called.
- * @remarks This event will not include the file download location itself. In order to get the new file download location, the user will have to access the secured query API 'getFileDownloadLocation'.
- */
-export type FileDownloadLocationChangedEvent = NamedEvent & {
-    type: 'file-download-location-changed';
-};
-/**
- * Generated when Application.run() is called for an already running application.
- */
-export type RunRequestedEvent = IdentityEvent & {
-    type: 'run-requested';
-    userAppConfigArgs: Record<string, any>;
-    manifest: OpenFin.ManifestInfo;
-};
-/**
- * Generated when the tray icon is clicked.
- */
-export type TrayIconClickedEvent = IdentityEvent & {
-    type: 'tray-icon-clicked';
-    button: 0 | 1 | 2;
-    bounds: OpenFin.Rectangle;
-    x: number;
-    y: number;
-    monitorInfo: any;
-};
-/**
- * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
- */
-export type WindowAlertRequestedEvent = NamedEvent & {
-    type: 'window-alert-requested';
-};
-/**
- * Generated when a child window is created.
- */
-export type WindowCreatedEvent = NamedEvent & {
-    type: 'window-created';
-};
-/**
- * Generated when a child window ends loading.
- */
-export type WindowEndLoadEvent = NamedEvent & {
-    type: 'window-end-load';
-};
-/**
- * Generated when a child window is not responding.
- */
-export type WindowNotRespondingEvent = NamedEvent & {
-    type: 'window-not-responding';
-};
-/**
- * Generated when a child window is responding.
- */
-export type WindowRespondingEvent = NamedEvent & {
-    type: 'window-responding';
-};
-/**
- * Generated when a child window starts loading.
- */
-export type WindowStartLoadEvent = NamedEvent & {
-    type: 'window-start-load';
-};
-/**
- * A Window event that is natively published at the Application level (not Window).
- */
-export type ApplicationWindowEvent = WindowAlertRequestedEvent | WindowCreatedEvent | WindowEndLoadEvent | WindowNotRespondingEvent | WindowRespondingEvent | WindowStartLoadEvent;
-/**
- * Generated when an application is closed.
- */
-export type ClosedEvent = IdentityEvent & {
-    type: 'closed';
-};
-/**
- * Generated when an application has authenticated and is connected.
- */
-export type ApplicationConnectedEvent = IdentityEvent & {
-    type: 'connected';
-};
-/**
- * Generated when an application has initialized.
- */
-export type InitializedEvent = IdentityEvent & {
-    type: 'initialized';
-};
-/**
- * Generated when the RVM notifies an application that the manifest has changed.
- */
-export type ManifestChangedEvent = IdentityEvent & {
-    type: 'manifest-changed';
-};
-/**
- * Generated when an application is not responding.
- */
-export type NotRespondingEvent = IdentityEvent & {
-    type: 'not-responding';
-};
-/**
- * Generated when an application is responding.
- */
-export type RespondingEvent = IdentityEvent & {
-    type: 'responding';
-};
-/**
- * Generated when an application has started.
- */
-export type StartedEvent = IdentityEvent & {
-    type: 'started';
-};
-/**
- * An Application event that does propagate to (republish on) parent topics.
- */
-export type WillPropagateApplicationEvent = ClosedEvent | ApplicationConnectedEvent | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
-/**
- *  An Application event.
- */
-export type ApplicationEvent = {
-    topic: 'application';
-} & (PropagatedViewEvent | PropagatedWindowEvent | ApplicationWindowEvent | WillPropagateApplicationEvent);
-/**
- * An Application event type.
- */
-export type ApplicationEventType = ApplicationEvent['type'];
-/**
- * A propagated Application event.
- */
-export type PropagatedApplicationEvent = PropagatedEvent<'application', WillPropagateApplicationEvent> | ApplicationWindowEvent;
-/**
- * A propagated Application event type.
- */
-export type PropagatedApplicationEventType = PropagatedApplicationEvent['type'];

package/src/api/events/application.js

@@ -1,14 +0,0 @@
-"use strict";
-/**
- * Namespace for events that can be transmitted on an OpenFin Application's EventEmitter.  Includes events
- * re-propagate from the `Window` (and, transitively, `View`) level, prefixed with `window-` (and also, if applicable, `view-`).
- * For example, a view's "shown" event will fire as 'window-view-shown' at the application level.
- *
- * Application events re-propagate to the system level, prefixed with `application-`.  For example,
- * the `closed` event will fire as `application-closed` at the system level.  Propagated events from
- * WebContents within an application will *not* transitively re-propagate to the system level, because they are already
- * visible at the system level and contain the identity of the application.
- *
- * @packageDocumentation
- */
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,42 +0,0 @@
-/**
- * Modifies an event key to reflect propagation by prefixing with the topic.
- */
-export type PropagatedEventType<Topic extends string, Type extends string> = `${Topic}-${Type}`;
-/**
- * Modifies an event shape to reflect propagation to a parent topic.
- * @remarks The 'type' field is prefixed with the original topic, and a new property is added with the original topic's identity.
- */
-export type PropagatedEvent<Topic extends string, Event extends {
-    type: string;
-}> = Event extends infer E extends {
-    type: string;
-} ? Omit<E, 'type'> & {
-    type: PropagatedEventType<Topic, E['type']>;
-} : never;
-/**
- * Handler for an event on an EventEmitter.
- * @remarks Selects the correct type for the event
- * payload from the provided union based on the provided string literal type.
- */
-export type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload: Extract<EmitterEvent, {
-    type: EventType;
-}>, ...args: any[]) => void;
-/**
- * A base event.
- */
-export type BaseEvent = {
-    topic: string;
-    type: string;
-};
-/**
- * An Identity event.
- */
-export type IdentityEvent = BaseEvent & {
-    uuid: string;
-};
-/**
- * A Name event.
- */
-export type NamedEvent = IdentityEvent & {
-    name: string;
-};

package/src/api/events/base.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,35 +0,0 @@
-/**
- * Namespace for events that can be transmitted on an OpenFin Channel's EventEmitter.
- *
- * @packageDocumentation
- */
-import { NamedEvent } from './base';
-/**
- * A base Channel event.
- */
-export type BaseChannelEvent = NamedEvent & {
-    channelName: string;
-    channelId: string;
-};
-/**
- * Generated when a Channel client is connected.
- */
-export type ChannelConnectedEvent = BaseChannelEvent & {
-    type: 'connected';
-};
-/**
- * Generated when a Channel client has disconnected.
- */
-export type ChannelDisconnectedEvent = BaseChannelEvent & {
-    type: 'disconnected';
-};
-/**
- * A Channel event.
- */
-export type ChannelEvent = {
-    topic: 'channel';
-} & (ChannelConnectedEvent | ChannelDisconnectedEvent);
-/**
- * A Channel event type.
- */
-export type ChannelEventType = ChannelEvent['type'];

package/src/api/events/channel.js

@@ -1,7 +0,0 @@
-"use strict";
-/**
- * Namespace for events that can be transmitted on an OpenFin Channel's EventEmitter.
- *
- * @packageDocumentation
- */
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,11 +0,0 @@
-/// <reference types="node" />
-import { EventEmitter } from 'events';
-export declare class EmitterMap {
-    private storage;
-    constructor();
-    private hashKeys;
-    getOrCreate(keys: EmitterAccessor): EventEmitter;
-    has(keys: EmitterAccessor): boolean;
-    delete(keys: EmitterAccessor): boolean;
-}
-export type EmitterAccessor = string[];

package/src/api/events/emitterMap.js

@@ -1,35 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EmitterMap = void 0;
-const events_1 = require("events");
-class EmitterMap {
-    constructor() {
-        this.storage = new Map();
-    }
-    // eslint-disable-next-line class-methods-use-this
-    hashKeys(keys) {
-        const hashed = keys.map(normalizeString);
-        return hashed.join('/');
-    }
-    getOrCreate(keys) {
-        const hash = this.hashKeys(keys);
-        if (!this.storage.has(hash)) {
-            this.storage.set(hash, new events_1.EventEmitter());
-        }
-        // We set it above
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        return this.storage.get(hash);
-    }
-    has(keys) {
-        return this.storage.has(this.hashKeys(keys));
-    }
-    delete(keys) {
-        const hash = this.hashKeys(keys);
-        return this.storage.delete(hash);
-    }
-}
-exports.EmitterMap = EmitterMap;
-function normalizeString(s) {
-    const b = Buffer.from(s);
-    return b.toString('base64');
-}

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

@@ -1,5 +0,0 @@
-import { Message } from '../../transport/transport';
-import { EmitterMap } from './emitterMap';
-export default class EventAggregator extends EmitterMap {
-    dispatchEvent: (message: Message<any>) => boolean;
-}

package/src/api/events/eventAggregator.js

@@ -1,35 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const emitterMap_1 = require("./emitterMap");
-function isEventMessage(message) {
-    return message.action === 'process-desktop-event';
-}
-function mapKeyFromEvent(event) {
-    const { topic } = event;
-    if (topic === 'frame' || topic === 'window' || topic === 'view') {
-        const { uuid, name } = event;
-        return [topic, uuid, name];
-    }
-    if (topic === 'application') {
-        const { uuid } = event;
-        return [topic, uuid];
-    }
-    return [topic];
-}
-class EventAggregator extends emitterMap_1.EmitterMap {
-    constructor() {
-        super(...arguments);
-        this.dispatchEvent = (message) => {
-            if (isEventMessage(message)) {
-                const { payload } = message;
-                const accessor = mapKeyFromEvent(payload);
-                if (this.has(accessor)) {
-                    this.getOrCreate(accessor).emit(payload.type, payload);
-                    return true;
-                }
-            }
-            return false;
-        };
-    }
-}
-exports.default = EventAggregator;

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

@@ -1,24 +0,0 @@
-/**
- * Namespace for events that can be transmitted on an OpenFin ExternalApplication's EventEmitter.
- *
- * @packageDocumentation
- */
-import { BaseEvent } from './base';
-/**
- * Generated when an external application has authenticated and is connected.
- */
-export type ExternalApplicationConnectedEvent = BaseEvent & {
-    type: 'connected';
-};
-/**
- * Generated when an external application has disconnected.
- */
-export type ExternalApplicationDisconnectedEvent = BaseEvent & {
-    type: 'disconnected';
-};
-/**
- * An external application event.
- */
-export type ExternalApplicationEvent = {
-    topic: 'externalapplication';
-} & (ExternalApplicationConnectedEvent | ExternalApplicationDisconnectedEvent);

package/src/api/events/externalApplication.js

@@ -1,7 +0,0 @@
-"use strict";
-/**
- * Namespace for events that can be transmitted on an OpenFin ExternalApplication's EventEmitter.
- *
- * @packageDocumentation
- */
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,35 +0,0 @@
-/**
- * Namespace for events that can be transmitted on an OpenFin Frame's EventEmitter.
- *
- * @packageDocumentation
- */
-import { NamedEvent } from './base';
-/**
- * The base frame event.
- */
-export type BaseFrameEvent = NamedEvent & {
-    entityType: 'iframe';
-    frameName: string;
-};
-/**
- * Generated when a frame is connected.
- */
-export type FrameConnectedEvent = BaseFrameEvent & {
-    type: 'connected';
-};
-/**
- * Generated when a frame has disconnected.
- */
-export type FrameDisconnectedEvent = BaseFrameEvent & {
-    type: 'disconnected';
-};
-/**
- * A Frame event.
- */
-export type FrameEvent = {
-    topic: 'frame';
-} & (FrameConnectedEvent | FrameDisconnectedEvent);
-/**
- * A Frame event type.
- */
-export type FrameEventType = FrameEvent['type'];

package/src/api/events/frame.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,25 +0,0 @@
-/**
- * Namespace for events that can be transmitted on an OpenFin GlobalHotkey's EventEmitter.
- *
- * @packageDocumentation
- */
-import { BaseEvent } from './base';
-/**
- * Generated when a hotkey has been registered with the operating system.
- */
-export type RegisteredEvent = BaseEvent & {
-    type: 'registered';
-};
-/**
- * Generated when a hotkey has been unregistered with the operating system.
- */
-export type UnregisteredEvent = BaseEvent & {
-    type: 'unregistered';
-};
-/**
- * A global hotkey event.
- */
-export type GlobalHotkeyEvent = {
-    topic: 'global-hotkey';
-    hotkey: 'string';
-} & (RegisteredEvent | UnregisteredEvent);

package/src/api/events/globalHotkey.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });