@openfin/core 30.74.13 → 30.74.15

package/README.md

@@ -8,19 +8,19 @@ Libraries are also available for the following frameworks:
 * [.Net](https://developers.openfin.co/of-docs/docs/net-api)
 * [Java](https://developers.openfin.co/of-docs/docs/java-api)
 
-## Prerequsites
-
-None.
-
 ## Installation
 
 This package cannot be installed as a dev dependency because it is not types-only.
 
 With npm:
->npm i -S @openfin/core
+```bash
+$ npm i -S @openfin/core
+```
 
 With yarn:
->yarn add @openfin/core
+```bash
+$ yarn add @openfin/core
+```
 
 ## Usage
 
@@ -35,9 +35,38 @@ const showWindow = async (identity: OpenFin.Identity) => {
    const win = await fin.Window.wrap(identity);
    await win.show();
 
-const isOpenFin = fin.me.isOpenFin; // false if not in OpenFin
+   const isOpenFin = fin.me.isOpenFin; // false if not in OpenFin
+}
+```
+
+## Migrating to v30+
+
+Prior to v30, the `OpenFin` namespace was ambiently declared and always available. Starting with v30, you must import it directly or specify it in the tsconfig.
+
+### Importing the type
+
+To import the `OpenFin` namespace:
+```typescript
+import OpenFin from "@openfin/core"; 
+
+type OFWindow = OpenFin.Window;
+```
+
+### TSConfig types array
+
+To have the `OpenFin` available in your code automatically, just update your tsconfig `types` key:
+```json
+{
+  "compilerOptions": {
+    "target": ...,
+    "module": ...,
+    ...,
+    "types": ["@openfin/core/OpenFin"]
+  }
 }
+
 ```
+
 ## For more information
 
 - [Developer guide](https://developers.openfin.co/of-docs/docs/container-overview)
@@ -45,11 +74,10 @@ const isOpenFin = fin.me.isOpenFin; // false if not in OpenFin
 
 ## License
 
-Copyright 2020-2022 OpenFin
+Copyright 2020-2023 OpenFin
 
 The code in this package is distributed under the Apache License, Version 2.0.
 
 However, if you run this code, it may call on the OpenFin RVM or OpenFin Runtime, which are covered by OpenFin's Developer, Community, and Enterprise licenses. You can learn more about OpenFin licensing at the links listed below or email us at support@openfin.co with questions.
 
-- [Licensing](https://www.openfin.co/licensing/)
 - [Developer agreement](https://openfin.co/developer-agreement/)

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/core",
-    "version": "30.74.13",
+    "version": "30.74.15",
     "license": "SEE LICENSE IN LICENSE.MD",
     "main": "./src/mock.js",
     "types": "./src/mock.d.ts",

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

@@ -67,10 +67,6 @@ export declare type FoundInPageEvent = NamedEvent & {
 } & {
     result: OpenFin.FindInPageResult;
 };
-/**
- * A WebContents event that does not propagate to (republish on) parent topics.
- */
-export declare type NonPropagatedWebContentsEvent = FoundInPageEvent | CertificateErrorEvent;
 export declare type BlurredEvent = NamedEvent & {
     type: 'blurred';
 };
@@ -89,9 +85,62 @@ export declare type ChildContentOpenedInBrowserEvent = NamedEvent & {
 export declare type ChildViewCreatedEvent = NamedEvent & {
     type: 'child-view-created';
 };
+export declare type FileDownloadEvent = NamedEvent & {
+    state: 'started' | 'progressing' | 'cancelled' | 'interrupted' | 'completed';
+    /**
+     * The url from which the file is being downloaded.
+     */
+    url: string;
+    mimeType: string;
+    /**
+     * Name used to save the file locally.
+     */
+    fileName: string;
+    /**
+     * Original name of the file.
+     */
+    originalFileName: string;
+    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;
+};
+export declare type FileDownloadStartedEvent = FileDownloadEvent & {
+    type: 'file-download-started';
+    state: 'started';
+};
+export declare type FileDownloadProgressEvent = FileDownloadEvent & {
+    type: 'file-download-progress';
+    state: 'progressing' | 'interrupted';
+};
+export declare type FileDownloadCompletedEvent = FileDownloadEvent & {
+    type: 'file-download-completed';
+    state: 'completed' | 'interrupted' | 'cancelled';
+};
 /**
  * A WebContents event that does propagate to (republish on) parent topics.
  */
-export declare type WillPropagateWebContentsEvent = BlurredEvent | CertificateSelectionShownEvent | CrashedEvent | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | FaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent;
+export declare type WillPropagateWebContentsEvent = BlurredEvent | CertificateSelectionShownEvent | CrashedEvent | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | FaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent;
+/**
+ * A WebContents event that does not propagate to (republish on) parent topics.
+ */
+export declare type NonPropagatedWebContentsEvent = FoundInPageEvent | CertificateErrorEvent;
 export declare type WebContentsEvent = NonPropagatedWebContentsEvent | WillPropagateWebContentsEvent;
 export {};

package/src/mock.d.ts

@@ -1,3 +1,3 @@
-import type * as OpenFin from './OpenFin';
+import * as OpenFin from './OpenFin';
 export declare const fin: OpenFin.Fin<"window" | "view">;
 export default OpenFin;

package/src/mock.js

@@ -1,12 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.fin = void 0;
-/* eslint-disable import/prefer-default-export */
-/* eslint-disable spaced-comment */
-/* eslint-disable @typescript-eslint/triple-slash-reference */
-/* eslint-disable @typescript-eslint/explicit-function-return-type */
-/* eslint-disable class-methods-use-this */
-/// <reference path="../OpenFin.d.ts"/>
+const OpenFin = require("./OpenFin");
 const fin_1 = require("./api/fin");
 const transport_1 = require("./transport/transport");
 const mockEnvironment_1 = require("./environment/mockEnvironment");