@salesforce/core 5.2.9 → 5.3.0

package/lib/lifecycleEvents.d.ts

@@ -23,6 +23,7 @@ type callback = (data: any) => Promise<void>;
  */
 export declare class Lifecycle {
     private readonly listeners;
+    private readonly uniqueListeners;
     static readonly telemetryEventName = "telemetry";
     static readonly warningEventName = "warning";
     private logger?;
@@ -68,8 +69,9 @@ export declare class Lifecycle {
      *
      * @param eventName The name of the event that is being listened for
      * @param cb The callback function to run when the event is emitted
+     * @param uniqueListenerIdentifier A unique identifier for the listener. If a listener with the same identifier is already registered, a new one will not be added
      */
-    on<T = AnyJson>(eventName: string, cb: (data: T) => Promise<void>): void;
+    on<T = AnyJson>(eventName: string, cb: (data: T) => Promise<void>, uniqueListenerIdentifier?: string): void;
     /**
      * Emit a `telemetry` event, causing all callback functions to be run in the order they were registered
      *

package/lib/lifecycleEvents.js

@@ -35,8 +35,9 @@ const logger_1 = require("./logger/logger");
  * ```
  */
 class Lifecycle {
-    constructor(listeners = {}) {
+    constructor(listeners = {}, uniqueListeners = new Map()) {
         this.listeners = listeners;
+        this.uniqueListeners = uniqueListeners;
     }
     /**
      * return the package.json version of the sfdx-core library.
@@ -74,7 +75,7 @@ class Lifecycle {
             const oldInstance = global.salesforceCoreLifecycle;
             // use the newer version and transfer any listeners from the old version
             // object spread keeps them from being references
-            global.salesforceCoreLifecycle = new Lifecycle({ ...oldInstance.listeners });
+            global.salesforceCoreLifecycle = new Lifecycle({ ...oldInstance.listeners }, oldInstance.uniqueListeners);
             // clean up any listeners on the old version
             Object.keys(oldInstance.listeners).map((eventName) => {
                 oldInstance.removeAllListeners(eventName);
@@ -96,6 +97,7 @@ class Lifecycle {
      */
     removeAllListeners(eventName) {
         this.listeners[eventName] = [];
+        this.uniqueListeners.delete(eventName);
     }
     /**
      * Get an array of listeners (callback functions) for a given event
@@ -103,7 +105,7 @@ class Lifecycle {
      * @param eventName The name of the event to get listeners of
      */
     getListeners(eventName) {
-        const listeners = this.listeners[eventName];
+        const listeners = this.listeners[eventName]?.concat(Array.from((this.uniqueListeners.get(eventName) ?? []).values()) ?? []);
         if (listeners) {
             return listeners;
         }
@@ -133,8 +135,9 @@ class Lifecycle {
      *
      * @param eventName The name of the event that is being listened for
      * @param cb The callback function to run when the event is emitted
+     * @param uniqueListenerIdentifier A unique identifier for the listener. If a listener with the same identifier is already registered, a new one will not be added
      */
-    on(eventName, cb) {
+    on(eventName, cb, uniqueListenerIdentifier) {
         const listeners = this.getListeners(eventName);
         if (listeners.length !== 0) {
             if (!this.logger) {
@@ -142,8 +145,20 @@ class Lifecycle {
             }
             this.logger.debug(`${listeners.length + 1} lifecycle events with the name ${eventName} have now been registered. When this event is emitted all ${listeners.length + 1} listeners will fire.`);
         }
-        listeners.push(cb);
-        this.listeners[eventName] = listeners;
+        if (uniqueListenerIdentifier) {
+            if (!this.uniqueListeners.has(eventName)) {
+                // nobody is listening to the event yet
+                this.uniqueListeners.set(eventName, new Map([[uniqueListenerIdentifier, cb]]));
+            }
+            else if (!this.uniqueListeners.get(eventName)?.has(uniqueListenerIdentifier)) {
+                // the unique listener identifier is not already registered
+                this.uniqueListeners.get(eventName)?.set(uniqueListenerIdentifier, cb);
+            }
+        }
+        else {
+            listeners.push(cb);
+            this.listeners[eventName] = listeners;
+        }
     }
     /**
      * Emit a `telemetry` event, causing all callback functions to be run in the order they were registered

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/core",
-  "version": "5.2.9",
+  "version": "5.3.0",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -42,7 +42,7 @@
     "@salesforce/kit": "^3.0.11",
     "@salesforce/schemas": "^1.6.0",
     "@salesforce/ts-types": "^2.0.7",
-    "@types/semver": "^7.5.1",
+    "@types/semver": "^7.5.2",
     "ajv": "^8.12.0",
     "change-case": "^4.1.2",
     "faye": "^1.4.0",
@@ -63,10 +63,10 @@
     "@salesforce/dev-scripts": "^5.4.2",
     "@salesforce/prettier-config": "^0.0.3",
     "@salesforce/ts-sinon": "^1.4.15",
-    "@types/benchmark": "^2.1.2",
-    "@types/chai-string": "^1.4.2",
-    "@types/jsonwebtoken": "9.0.2",
-    "@types/lodash": "^4.14.197",
+    "@types/benchmark": "^2.1.3",
+    "@types/chai-string": "^1.4.3",
+    "@types/jsonwebtoken": "9.0.3",
+    "@types/lodash": "^4.14.199",
     "@types/proper-lockfile": "^4.1.2",
     "@types/shelljs": "0.8.12",
     "@typescript-eslint/eslint-plugin": "^5.62.0",
@@ -74,7 +74,7 @@
     "benchmark": "^2.1.4",
     "chai": "^4.3.8",
     "chai-string": "^1.5.0",
-    "eslint": "^8.49.0",
+    "eslint": "^8.50.0",
     "eslint-config-prettier": "^8.10.0",
     "eslint-config-salesforce": "^2.0.2",
     "eslint-config-salesforce-license": "^0.2.0",
@@ -93,7 +93,7 @@
     "ts-node": "^10.4.0",
     "ttypescript": "^1.5.15",
     "typescript": "^4.9.5",
-    "wireit": "^0.13.0"
+    "wireit": "^0.14.0"
   },
   "repository": {
     "type": "git",