@openfin/core 40.100.2 → 40.100.5

package/README.md

@@ -1,52 +1,54 @@
-ℹ️ *Note: `@openfin/core` is changing the structure of its output. See [v33 Bundling Changes](#v33-bundling-changes)*
----
+## ℹ️ _Note: `@openfin/core` is changing the structure of its output. See [v33 Bundling Changes](#v33-bundling-changes)_
 
 # OpenFin Core
 
-This package contains the type definitions and API entry points for the OpenFin Core API.  Start here to develop OpenFin applications in TypeScript.
+This package contains the type definitions and API entry points for the OpenFin Core API. Start here to develop OpenFin applications in TypeScript.
 
 Libraries are also available for the following frameworks:
 
-* [Node.js](https://www.npmjs.com/package/openfin-adapter)
-* [.Net](https://developers.openfin.co/of-docs/docs/net-api)
-* [Java](https://developers.openfin.co/of-docs/docs/java-api)
+-   [Node.js](https://www.npmjs.com/package/openfin-adapter)
+-   [.Net](https://developers.openfin.co/of-docs/docs/net-api)
+-   [Java](https://developers.openfin.co/of-docs/docs/java-api)
 
 ## Installation
 
 This package cannot be installed as a dev dependency because it is not types-only.
 
 With npm:
+
 ```bash
 $ npm i -S @openfin/core
 ```
 
 With yarn:
+
 ```bash
 $ yarn add @openfin/core
 ```
 
 ## Usage
 
-The `fin` export is the primary API entry point.  Type definitions are defined in the package's default export.
+The `fin` export is the primary API entry point. Type definitions are defined in the package's default export.
 
-The static `fin.me` object contains some information about the current runtime environment even if imported outside of an OpenFin setting.  In this case, the `isOpenFin` property of `fin.me` will be `false`.  Outside of OpenFin environments, OpenFin API calls will nullop and throw an error.
+The static `fin.me` object contains some information about the current runtime environment even if imported outside of an OpenFin setting. In this case, the `isOpenFin` property of `fin.me` will be `false`. Outside of OpenFin environments, OpenFin API calls will nullop and throw an error.
 
 ```typescript
-import OpenFin, { fin } from "@openfin/core"; 
+import OpenFin, { fin } from '@openfin/core';
 
 const showWindow = async (identity: OpenFin.Identity) => {
-   const win = await fin.Window.wrap(identity);
-   await win.show();
+    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
+};
 ```
 
 ### Importing the type
 
 To import the `OpenFin` namespace:
+
 ```typescript
-import OpenFin from "@openfin/core"; 
+import OpenFin from '@openfin/core';
 
 type OFWindow = OpenFin.Window;
 ```
@@ -54,6 +56,7 @@ type OFWindow = OpenFin.Window;
 ### TSConfig types array
 
 To have the `OpenFin` available in your code automatically, just update your tsconfig `types` key:
+
 ```json
 {
   "compilerOptions": {
@@ -68,8 +71,8 @@ To have the `OpenFin` available in your code automatically, just update your tsc
 
 ## For more information
 
-- [Developer guide](https://developers.openfin.co/of-docs/docs/container-overview)
-- [API reference](https://developer.openfin.co/docs/javascript/stable/Platform.html)
+-   [Developer guide](https://developers.openfin.co/of-docs/docs/container-overview)
+-   [API reference](https://developer.openfin.co/docs/javascript/stable/Platform.html)
 
 ## Migrations
 
@@ -79,7 +82,7 @@ To have the `OpenFin` available in your code automatically, just update your tsc
 
 These changes will allow for improved API and type discoverability via code suggestion and type inspection, and create a clearer, more dependable usage contract for consumers of the package.
 
-Explicit imports from arbitrary files within the module directory (e.g. "@openfin/core/*") will no longer be supported in new versions of @openfin/core , for example:
+Explicit imports from arbitrary files within the module directory (e.g. "@openfin/core/\*") will no longer be supported in new versions of @openfin/core , for example:
 
 ```js
 import { fin } from '@openfin/core/src/mock';
@@ -96,13 +99,3 @@ Until further notice, older versions of the `@openfin/core` package will be comp
 ## v30 Ambient type changes
 
 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.
-
-## License
-
-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.
-
-- [Developer agreement](https://openfin.co/developer-agreement/)

package/out/mock-alpha.d.ts

@@ -593,6 +593,23 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
      * ```
      */
     setTrayIcon(icon: string): Promise<void>;
+    /**
+     * Set hover text for this application's system tray icon.
+     * Note: Application must first set a tray icon with {@link Application.setTrayIcon}.
+     * @param toolTip
+     *
+     * @example
+     *
+     * ```js
+     * const app = fin.Application.getCurrentSync();
+     * const iconUrl = "http://cdn.openfin.co/assets/testing/icons/circled-digit-one.png";
+     *
+     * await app.setTrayIcon(iconUrl);
+     *
+     * await app.setTrayIconToolTip('My Application');
+     * ```
+     */
+    setTrayIconToolTip(toolTip: string): Promise<void>;
     /**
      * Sets new application's shortcut configuration. Windows only.
      * @param config New application's shortcut configuration.
@@ -11800,6 +11817,9 @@ declare interface ProtocolMap extends ProtocolMapBase {
     'set-tray-icon': ApplicationIdentityCall<{
         enabledIcon: string;
     }, void>;
+    'set-tray-icon-tooltip': ApplicationIdentityCall<{
+        toolTip: string;
+    }>;
     'set-shortcuts': ApplicationIdentityCall<{
         data: OpenFin_2.ShortCutConfig;
     }, void>;

package/out/mock-beta.d.ts

@@ -593,6 +593,23 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
      * ```
      */
     setTrayIcon(icon: string): Promise<void>;
+    /**
+     * Set hover text for this application's system tray icon.
+     * Note: Application must first set a tray icon with {@link Application.setTrayIcon}.
+     * @param toolTip
+     *
+     * @example
+     *
+     * ```js
+     * const app = fin.Application.getCurrentSync();
+     * const iconUrl = "http://cdn.openfin.co/assets/testing/icons/circled-digit-one.png";
+     *
+     * await app.setTrayIcon(iconUrl);
+     *
+     * await app.setTrayIconToolTip('My Application');
+     * ```
+     */
+    setTrayIconToolTip(toolTip: string): Promise<void>;
     /**
      * Sets new application's shortcut configuration. Windows only.
      * @param config New application's shortcut configuration.
@@ -11800,6 +11817,9 @@ declare interface ProtocolMap extends ProtocolMapBase {
     'set-tray-icon': ApplicationIdentityCall<{
         enabledIcon: string;
     }, void>;
+    'set-tray-icon-tooltip': ApplicationIdentityCall<{
+        toolTip: string;
+    }>;
     'set-shortcuts': ApplicationIdentityCall<{
         data: OpenFin_2.ShortCutConfig;
     }, void>;

package/out/mock-public.d.ts

@@ -593,6 +593,23 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
      * ```
      */
     setTrayIcon(icon: string): Promise<void>;
+    /**
+     * Set hover text for this application's system tray icon.
+     * Note: Application must first set a tray icon with {@link Application.setTrayIcon}.
+     * @param toolTip
+     *
+     * @example
+     *
+     * ```js
+     * const app = fin.Application.getCurrentSync();
+     * const iconUrl = "http://cdn.openfin.co/assets/testing/icons/circled-digit-one.png";
+     *
+     * await app.setTrayIcon(iconUrl);
+     *
+     * await app.setTrayIconToolTip('My Application');
+     * ```
+     */
+    setTrayIconToolTip(toolTip: string): Promise<void>;
     /**
      * Sets new application's shortcut configuration. Windows only.
      * @param config New application's shortcut configuration.
@@ -11800,6 +11817,9 @@ declare interface ProtocolMap extends ProtocolMapBase {
     'set-tray-icon': ApplicationIdentityCall<{
         enabledIcon: string;
     }, void>;
+    'set-tray-icon-tooltip': ApplicationIdentityCall<{
+        toolTip: string;
+    }>;
     'set-shortcuts': ApplicationIdentityCall<{
         data: OpenFin_2.ShortCutConfig;
     }, void>;

package/out/mock.d.ts

@@ -599,6 +599,23 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
      * ```
      */
     setTrayIcon(icon: string): Promise<void>;
+    /**
+     * Set hover text for this application's system tray icon.
+     * Note: Application must first set a tray icon with {@link Application.setTrayIcon}.
+     * @param toolTip
+     *
+     * @example
+     *
+     * ```js
+     * const app = fin.Application.getCurrentSync();
+     * const iconUrl = "http://cdn.openfin.co/assets/testing/icons/circled-digit-one.png";
+     *
+     * await app.setTrayIcon(iconUrl);
+     *
+     * await app.setTrayIconToolTip('My Application');
+     * ```
+     */
+    setTrayIconToolTip(toolTip: string): Promise<void>;
     /**
      * Sets new application's shortcut configuration. Windows only.
      * @param config New application's shortcut configuration.
@@ -12201,6 +12218,9 @@ declare interface ProtocolMap extends ProtocolMapBase {
     'set-tray-icon': ApplicationIdentityCall<{
         enabledIcon: string;
     }, void>;
+    'set-tray-icon-tooltip': ApplicationIdentityCall<{
+        toolTip: string;
+    }>;
     'set-shortcuts': ApplicationIdentityCall<{
         data: OpenFin_2.ShortCutConfig;
     }, void>;

package/out/mock.js

@@ -3230,6 +3230,25 @@ function requireInstance$1 () {
 	        })
 	            .then(() => undefined);
 	    }
+	    /**
+	     * Set hover text for this application's system tray icon.
+	     * Note: Application must first set a tray icon with {@link Application.setTrayIcon}.
+	     * @param toolTip
+	     *
+	     * @example
+	     *
+	     * ```js
+	     * const app = fin.Application.getCurrentSync();
+	     * const iconUrl = "http://cdn.openfin.co/assets/testing/icons/circled-digit-one.png";
+	     *
+	     * await app.setTrayIcon(iconUrl);
+	     *
+	     * await app.setTrayIconToolTip('My Application');
+	     * ```
+	     */
+	    async setTrayIconToolTip(toolTip) {
+	        await this.wire.sendAction('set-tray-icon-tooltip', { ...this.identity, toolTip });
+	    }
 	    /**
 	     * Sets new application's shortcut configuration. Windows only.
 	     * @param config New application's shortcut configuration.
@@ -8438,11 +8457,12 @@ class ChannelProvider extends channel_1.ChannelBase {
         return [...__classPrivateFieldGet$9(this, _ChannelProvider_connections, "f")];
     }
     static handleClientDisconnection(channel, payload) {
-        const removeById = channel.connections.find((identity) => identity.endpointId === payload.endpointId);
-        if (removeById) {
-            __classPrivateFieldGet$9(channel, _ChannelProvider_removeEndpoint, "f").call(channel, removeById);
+        if (payload?.endpointId) {
+            const { uuid, name, endpointId, isLocalEndpointId } = payload;
+            __classPrivateFieldGet$9(channel, _ChannelProvider_removeEndpoint, "f").call(channel, { uuid, name, endpointId, isLocalEndpointId });
         }
         else {
+            // this is here to support older runtimes that did not have endpointId
             const multipleRemoves = channel.connections.filter((identity) => {
                 return identity.uuid === payload.uuid && identity.name === payload.name;
             });

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/core",
-    "version": "40.100.2",
+    "version": "40.100.5",
     "description": "The core renderer entry point of OpenFin",
     "license": "SEE LICENSE IN LICENSE.md",
     "main": "out/mock.js",
@@ -24,7 +24,8 @@
         "test": "run-p test:*",
         "test:sample": "tsc -p test/tsconfig.json",
         "test:imports": "ts-node scripts/verify-imports",
-        "test:mocha": "ts-mocha -R dot --exit \"./src/**/__tests__/**.test.ts\""
+        "test:mocha": "ts-mocha -R dot --exit \"./src/**/__tests__/**.test.ts\"",
+        "version:update": "of-npm version --allow-same-version '$RMAJOR.$RMINOR.$RPATCH'"
     },
     "files": [
         "out/*",