@openfin/core 33.76.36 → 33.77.1

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

@@ -1,34 +0,0 @@
-/**
- * Namespace for events that can be transmitted on an OpenFin Platform's EventEmitter.
- *
- * The Platform `EventEmitter` is a superset of the Application's `EventEmitter`,
- * meaning it can listen to all Application events, along with some Platform-specific events.
- *
- * @packageDocumentation
- */
-import { ApplicationEvent } from './application';
-import { BaseEvent } from './base';
-/**
- * Generated when a new Platform's API becomes responsive.
- */
-export type PlatformApiReadyEvent = BaseEvent & {
-    topic: 'application';
-    type: 'platform-api-ready';
-};
-/**
- * Generated when a platform.ApplySnapshot call is resolved.
- * @remarks The call is resolved when the following conditions are met for all windows in the snapshot:
- * 1. The window has been created
- * 2. The window has a responsive API
- * 3. If a window has a layout property, the 'layout-ready' event has fired
- *
- * _Note_ - In the case of using a custom provider, if a window has a layout property but does not call _Layout.init_ this event may not fire.
- */
-export type PlatformSnapshotAppliedEvent = BaseEvent & {
-    topic: 'application';
-    type: 'platform-snapshot-applied';
-};
-/**
- * A Platform event.
- */
-export type PlatformEvent = ApplicationEvent | PlatformApiReadyEvent | PlatformSnapshotAppliedEvent;

package/src/api/events/platform.js

@@ -1,10 +0,0 @@
-"use strict";
-/**
- * Namespace for events that can be transmitted on an OpenFin Platform's EventEmitter.
- *
- * The Platform `EventEmitter` is a superset of the Application's `EventEmitter`,
- * meaning it can listen to all Application events, along with some Platform-specific events.
- *
- * @packageDocumentation
- */
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,126 +0,0 @@
-/**
- * Namespace for runtime-wide OpenFin events that transmit on the OpenFin System event emitter.  Includes events
- * re-propagated from individual applications, windows, and views (prefixed with `application-`, `window-`, and `view-`).  All
- * event propagations are visible at the System level, regardless of source, so transitive re-propagations (e.g. from view to window)
- * are visible in their entirety.  Propagated events from WebContents (windows, views, frames) to the Application level 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.
- *
- * For example, an application's "closed" event will fire as 'application-closed' at the system level.  A view's 'shown' event
- * will be visible as both 'view-shown' and 'window-view-shown' at the system level, but *not* as `application-window-view-shown`.
- *
- * @packageDocumentation
- */
-import type * as OpenFin from '../../OpenFin';
-import { PropagatedApplicationEvent } from './application';
-import { BaseEvent, IdentityEvent } from './base';
-import { PropagatedViewEvent } from './view';
-import { PropagatedWindowEvent } from './window';
-import { AppVersionCompleteEvent, AppVersionErrorEvent, AppVersionProgressEvent, AppVersionRuntimeStatusEvent } from '../../OpenFin';
-/**
- * @internal
- */
-export type NotRequested<EventType> = EventType extends `${infer U}-requested` ? never : EventType;
-/**
- * @internal
- */
-export type ExcludeRequested<Event extends {
-    type: string;
-}> = Extract<Event, {
-    type: NotRequested<Event['type']>;
-}>;
-/**
- * Generated when a user enters or returns from idle state.
- * @remarks This method is continuously generated every minute while the user is in idle.
- * A user enters idle state when the computer is locked or when there has been no keyboard/mouse activity for 1 minute.
- * A user returns from idle state when the computer is unlocked or keyboard/mouse activity has resumed.
- */
-export type IdleEvent = {
-    type: 'idle-state-changed';
-    elapsedTime: number;
-    isIdle: boolean;
-};
-/**
- * Generated on changes of a monitor's size/location.
- * @remarks A monitor's size changes when the taskbar is resized or relocated.
- * The available space of a monitor defines a rectangle that is not occupied by the taskbar
- */
-export type MonitorEvent = OpenFin.MonitorInfo & {
-    type: 'monitor-info-changed';
-};
-/**
- * Generated on changes to a user’s local computer session.
- */
-export type SessionChangedEvent = {
-    type: 'session-changed';
-    reason: 'lock' | 'unlock' | 'remote-connect' | 'remote-disconnect' | 'unknown';
-};
-/**
- * An app versioning event.
- */
-export type AppVersionEvent = AppVersionProgressEvent | AppVersionRuntimeStatusEvent | AppVersionCompleteEvent | AppVersionErrorEvent;
-/**
- * An app versioning event type.
- */
-export type AppVersionEventType = AppVersionEvent['type'];
-/**
- * @internal
- */
-export type IdEventType = WithId<AppVersionEventType>;
-/**
- * @internal
- */
-export type WithId<T extends AppVersionEventType> = `${T}.${string}`;
-/**
- * @internal
- */
-export type WithoutId<T extends string> = T extends WithId<infer U> ? U : never;
-/**
- * @internal
- */
-export type AppVersionTypeFromIdEvent<T extends IdEventType> = Extract<AppVersionEvent, {
-    type: WithoutId<T>;
-}>;
-/**
- * @internal
- */
-export type EventWithId<Event extends AppVersionEvent> = Event extends infer E extends {
-    type: AppVersionEventType;
-} ? Omit<E, 'type'> & {
-    type: WithId<E['type']>;
-    topic: 'system';
-    appVersionId: string;
-} : never;
-/**
- * @internal
- */
-export type AppVersionEventWithId = EventWithId<AppVersionEvent>;
-/**
- * Generated when an application is created.
- */
-export type ApplicationCreatedEvent = IdentityEvent & {
-    type: 'application-created';
-};
-/**
- * Generated when the desktop icon is clicked while it's already running.
- */
-export type DesktopIconClickedEvent = BaseEvent & {
-    type: 'desktop-icon-clicked';
-};
-/**
- * Generated when system shutdown or log off.
- * @internal
- */
-export type SystemShutdownEvent = BaseEvent & {
-    type: 'system-shutdown';
-};
-/**
- * A system event.
- */
-export type SystemEvent = {
-    topic: 'system';
-} & (ExcludeRequested<PropagatedWindowEvent> | PropagatedViewEvent | PropagatedApplicationEvent | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent);
-/**
- * A system event type.
- */
-export type SystemEventType = SystemEvent['type'];

package/src/api/events/system.js

@@ -1,15 +0,0 @@
-"use strict";
-/**
- * Namespace for runtime-wide OpenFin events that transmit on the OpenFin System event emitter.  Includes events
- * re-propagated from individual applications, windows, and views (prefixed with `application-`, `window-`, and `view-`).  All
- * event propagations are visible at the System level, regardless of source, so transitive re-propagations (e.g. from view to window)
- * are visible in their entirety.  Propagated events from WebContents (windows, views, frames) to the Application level 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.
- *
- * For example, an application's "closed" event will fire as 'application-closed' at the system level.  A view's 'shown' event
- * will be visible as both 'view-shown' and 'window-view-shown' at the system level, but *not* as `application-window-view-shown`.
- *
- * @packageDocumentation
- */
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,20 +0,0 @@
-export type Listener<T extends {
-    type: string;
-}> = (payload: T) => void;
-export interface TypedEventEmitter<Event extends {
-    type: string;
-}, EmitterEventType = Event['type']> {
-    on<EventType extends EmitterEventType>(event: EventType, listener: Listener<Extract<Event, {
-        type: EventType;
-    }>>): this;
-    addListener<EventType extends EmitterEventType>(event: EventType, listener: Listener<Extract<Event, {
-        type: EventType;
-    }>>): this;
-    removeListener<EventType extends EmitterEventType>(event: EventType, listener: Listener<Extract<Event, {
-        type: EventType;
-    }>>): this;
-    removeAllListeners<EventType extends EmitterEventType>(event?: EmitterEventType): this;
-    emit<EventType extends EmitterEventType>(event: EventType, payload: Extract<Event, {
-        type: EventType;
-    }>): boolean;
-}

package/src/api/events/typedEventEmitter.js

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

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

@@ -1,92 +0,0 @@
-/**
- * Namespace for events that can be transmitted on an OpenFin View's EventEmitter.
- *
- * View events fall into two categories: propagated and non-propagated.  Propagated events will
- * be re-emitted on the parent window of the target view, prefixed with "view-".  For example,
- * the "shown" event will be re-emitted on the parent window as "view-shown".  Non-propagated events
- * will not be re-emitted on the parent window.
- *
- * @packageDocumentation
- */
-import type * as OpenFin from '../../OpenFin';
-import { NonPropagatedWebContentsEvent, WillPropagateWebContentsEvent } from './webcontents';
-import { NamedEvent, PropagatedEvent } from './base';
-/**
- * A base View event.
- */
-export type BaseViewEvent = NamedEvent & {
-    target: OpenFin.Identity;
-    viewIdentity: OpenFin.Identity;
-};
-/**
- * Generated when a View changes its window target.
- * @remarks This event will fire during creation of a View.
- * In that case, previousTarget identity will be the same as target identity.
- */
-export type TargetChangedEvent = BaseViewEvent & {
-    type: 'target-changed';
-    previousTarget: OpenFin.Identity;
-};
-/**
- * A View event that does not propagate to (republish on) parent topics.
- */
-export type NonPropagatedViewEvent = BaseViewEvent & NonPropagatedWebContentsEvent;
-/**
- * Generated when a View is attached to a window.
- */
-export type AttachedEvent = BaseViewEvent & {
-    type: 'attached';
-};
-/**
- * Generated when a View is created.
- */
-export type CreatedEvent = BaseViewEvent & {
-    type: 'created';
-};
-/**
- * Generated when a View is destroyed.
- */
-export type DestroyedEvent = BaseViewEvent & {
-    type: 'destroyed';
-};
-/**
- * Generated when a View is hidden.
- */
-export type HiddenEvent = BaseViewEvent & {
-    type: 'hidden';
-};
-/**
- * Generated when a keyboard shortcut defined in the `hotkeys` array in [View options](OpenFin.ViewOptions.html) is pressed inside the view.
- * @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
- */
-export type HotkeyEvent = BaseViewEvent & {
-    type: 'hotkey';
-};
-/**
- * Generated when a View is shown. This event will fire during creation of a View.
- */
-export type ShownEvent = BaseViewEvent & {
-    type: 'shown';
-};
-/**
- * A View event that does propagate to (republish on) parent topics.
- */
-export type WillPropagateViewEvent = WillPropagateWebContentsEvent | AttachedEvent | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent;
-/**
- * A View event.
- */
-export type ViewEvent = {
-    topic: 'view';
-} & (NonPropagatedViewEvent | WillPropagateViewEvent);
-/**
- * A View event type.
- */
-export type ViewEventType = ViewEvent['type'];
-/**
- * A propagated View event.
- */
-export type PropagatedViewEvent = PropagatedEvent<'view', WillPropagateViewEvent>;
-/**
- * A propagated View event type.
- */
-export type PropagatedViewEventType = PropagatedViewEvent['type'];

package/src/api/events/view.js

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

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

@@ -1,277 +0,0 @@
-/**
- * Namespace for events shared by all OpenFin WebContents elements (i.e. windows, views, and frames).
- *
- * WebContents events are divided into two groups: propagating and non-propagating.  Propagating events
- * will re-emit on parent entities - e.g., a propagating event in a view will also be emitted on the view's
- * parent window, and propagating events in a window will also be emitted on the window's parent application.
- *
- * Non-propagating events will not re-emit on parent entities.
- *
- * @packageDocumentation
- */
-import type * as OpenFin from '../../OpenFin';
-import { NamedEvent } from './base';
-import { CrashedEvent } from './application';
-type BaseLoadFailedEvent = NamedEvent & {
-    errorCode: number;
-    errorDescription: string;
-    validatedURL: string;
-    isMainFrame: boolean;
-};
-/**
- * Generated when an HTTP load was cancelled or failed.
- */
-export type ResourceLoadFailedEvent = BaseLoadFailedEvent & {
-    type: 'resource-load-failed';
-};
-/**
- * Generated when an HTTP resource request has received response details.
- */
-export type ResourceResponseReceivedEvent = NamedEvent & {
-    type: 'resource-response-received';
-    status: boolean;
-    newUrl: string;
-    originalUrl: string;
-    httpResponseCode: number;
-    requestMethod: string;
-    referrer: string;
-    headers: any;
-    resourceType: 'mainFrame' | 'subFrame' | 'styleSheet' | 'script' | 'image' | 'object' | 'xhr' | 'other';
-};
-/**
- * Generated when page title is set during navigation.
- * @remarks explicitSet is false when title is synthesized from file url.
- */
-export type PageTitleUpdatedEvent = NamedEvent & {
-    type: 'page-title-updated';
-    title: string;
-};
-/**
- * Generated when navigating to a URL that fails certificate validation.
- */
-export type CertificateErrorEvent = NamedEvent & {
-    type: 'certificate-error';
-    error: string;
-    url: string;
-    certificate: OpenFin.Certificate;
-};
-/**
- * Generated when the certificate selection dialog is shown.
- */
-export type CertificateSelectionShownEvent = NamedEvent & {
-    type: 'certificate-selection-shown';
-    url: string;
-    certificates: OpenFin.Certificate[];
-};
-/**
- * Generated when page receives favicon urls.
- */
-export type FaviconUpdatedEvent = NamedEvent & {
-    type: 'page-favicon-updated';
-    favicons: string[];
-};
-/**
- * Generated when view navigation is rejected as per contentNavigation allowlist/denylist rules.
- */
-export type NavigationRejectedEvent = NamedEvent & {
-    type: 'navigation-rejected';
-    sourceName?: string;
-    url: string;
-};
-type BaseUrlEvent = NamedEvent & {
-    type: 'url-changed';
-    url: string;
-};
-/**
- * Generated when navigation or redirect is completed.
- * @remarks Also emitted for in-page navigations, examples of this occurring are when anchor links are clicked or when the DOM hashchange event is triggered, indicated by isInPage=true.
- * Note that navigating to a url with an anchor in it like http://openfin.co/#my-inpage-anchor will fire 2 events indicating the original navigation (isInPage=false) and then the in-page navigation event (isInPage=true).
- */
-export type UrlChangedEvent = BaseUrlEvent & ({
-    isInPage: true;
-} | {
-    isInPage: false;
-    httpResponseCode: number;
-    httpStatusText: string;
-});
-/**
- * Generated when the navigation is done, i.e. the spinner of the tab will stop spinning, and the onload event is dispatched.
- */
-export type DidFinishLoadEvent = NamedEvent & {
-    type: 'did-finish-load';
-};
-/**
- * Generated when load failed.
- */
-export type DidFailLoadEvent = BaseLoadFailedEvent & {
-    type: 'did-fail-load';
-};
-/**
- * Generated when a result is available when calling findInPage.
- */
-export type FoundInPageEvent = NamedEvent & {
-    type: 'found-in-page';
-} & {
-    result: OpenFin.FindInPageResult;
-};
-/**
- * Generated when a WebContents loses focus.
- */
-export type BlurredEvent = NamedEvent & {
-    type: 'blurred';
-};
-/**
- * Generated when a page's theme color changes. This is usually due to encountering a meta tag.
- */
-export type DidChangeThemeColorEvent = NamedEvent & {
-    type: 'did-change-theme-color';
-};
-/**
- * Generated when a WebContents gains focus.
- */
-export type FocusedEvent = NamedEvent & {
-    type: 'focused';
-};
-export type ContentCreationRulesEvent = NamedEvent & {
-    /**
-     * The absolute url which triggered this event.
-     */
-    url: string;
-    /**
-     * The features string passed to `window.open()`
-     */
-    features: string;
-    /**
-     * The frame name passed to `window.open()`
-     */
-    frameName: string;
-    /**
-     * The rule which triggered this event. May be undefined on `child-window-created` where no rule corresponds to the child Window creation
-     */
-    rule: OpenFin.ContentCreationRule;
-    /**
-     * The features string passed to `window.open()` converted to OpenFin window options
-     */
-    parsedFeatures: Partial<OpenFin.WindowOptions>;
-    disposition: string;
-};
-/**
- * Generated when a child content is blocked to load.
- */
-export type ChildContentBlockedEvent = ContentCreationRulesEvent & {
-    type: 'child-content-blocked';
-};
-/**
- * Generated when a child content is loaded into a browser.
- */
-export type ChildContentOpenedInBrowserEvent = ContentCreationRulesEvent & {
-    type: 'child-content-opened-in-browser';
-};
-/**
- * Generated when a child View is created.
- */
-export type ChildViewCreatedEvent = ContentCreationRulesEvent & {
-    type: 'child-view-created';
-    /**
-     * The options the child View was created with.
-     */
-    childOptions: OpenFin.ViewOptions;
-};
-/**
- * Generated when a child Window is created.
- */
-export type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
-    type: 'child-window-created';
-    /**
-     * The options the child Window was created with.
-     */
-    childOptions: OpenFin.WindowOptions;
-    /**
-     * On `child-window-created` rule may be undefined.
-     * It is only defined if the rules engine found a match for a user-supplied rule, not in the case of an api call or the default behavior.
-     */
-    rule?: OpenFin.ContentCreationRule;
-};
-/**
- * A general file download event without event type.
- */
-export type FileDownloadEvent = {
-    /**
-     * The file download state.
-     */
-    state: 'started' | 'progressing' | 'cancelled' | 'interrupted' | 'completed';
-    /**
-     * The url from which the file is being downloaded.
-     */
-    url: string;
-    /**
-     * The file mime type.
-     */
-    mimeType: string;
-    /**
-     * The name used to save the file locally.
-     */
-    fileName: string;
-    /**
-     * The original name of the file.
-     */
-    originalFileName: string;
-    /**
-     * The total size in bytes of the file.
-     */
-    totalBytes: number;
-    /**
-     * The number of seconds since the UNIX epoch when the download was started.
-     */
-    startTime: number;
-    /**
-     * The value of the Content-Disposition field from the response header.
-     */
-    contentDisposition: string;
-    /**
-     * The value of the Last-Modified header.
-     */
-    lastModifiedTime: Date;
-    /**
-     * The value of the ETag header.
-     */
-    eTag: string;
-    /**
-     * The number of bytes of the item that have already been downloaded.
-     */
-    downloadedBytes: number;
-} & NamedEvent;
-/**
- * Generated when a file download has started.
- */
-export type FileDownloadStartedEvent = FileDownloadEvent & {
-    type: 'file-download-started';
-    state: 'started';
-};
-/**
- * Generated during file download progress.
- */
-export type FileDownloadProgressEvent = FileDownloadEvent & {
-    type: 'file-download-progress';
-    state: 'progressing' | 'interrupted';
-};
-/**
- * Generated when a file download has completed.
- */
-export type FileDownloadCompletedEvent = FileDownloadEvent & {
-    type: 'file-download-completed';
-    state: 'completed' | 'interrupted' | 'cancelled';
-};
-/**
- * A WebContents event that does propagate to (republish on) parent topics.
- */
-export type WillPropagateWebContentsEvent = BlurredEvent | CertificateSelectionShownEvent | CrashedEvent | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | FaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent;
-/**
- * A WebContents event that does not propagate to (republish on) parent topics.
- */
-export type NonPropagatedWebContentsEvent = FoundInPageEvent | CertificateErrorEvent;
-/**
- * A WebContents event.
- */
-export type WebContentsEvent = NonPropagatedWebContentsEvent | WillPropagateWebContentsEvent;
-export {};

package/src/api/events/webcontents.js

@@ -1,13 +0,0 @@
-"use strict";
-/**
- * Namespace for events shared by all OpenFin WebContents elements (i.e. windows, views, and frames).
- *
- * WebContents events are divided into two groups: propagating and non-propagating.  Propagating events
- * will re-emit on parent entities - e.g., a propagating event in a view will also be emitted on the view's
- * parent window, and propagating events in a window will also be emitted on the window's parent application.
- *
- * Non-propagating events will not re-emit on parent entities.
- *
- * @packageDocumentation
- */
-Object.defineProperty(exports, "__esModule", { value: true });