@openfin/core 33.76.6 → 33.76.8

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": "33.76.6",
+    "version": "33.76.8",
     "license": "SEE LICENSE IN LICENSE.MD",
     "main": "./src/mock.js",
     "types": "./src/mock.d.ts",

package/src/OpenFin.d.ts

@@ -3032,4 +3032,3 @@ export interface CapturePageOptions {
      */
     quality?: number;
 }
-export declare const Version: any;

package/src/OpenFin.js

@@ -1,5 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Version = void 0;
-// eslint-disable-next-line global-require, @typescript-eslint/no-var-requires
-exports.Version = require('../package.json').version.split('.')[0];