@salesforce/core 8.0.5 → 8.1.1

package/lib/lifecycleEvents.d.ts

@@ -94,5 +94,5 @@ export declare class Lifecycle {
      */
     emit<T = AnyJson>(eventName: string, data: T): Promise<void>;
 }
-export declare const cloneUniqueListeners: (uniqueListeners: UniqueListenerMap) => UniqueListenerMap;
+export declare const cloneUniqueListeners: (uniqueListeners: UniqueListenerMap | undefined) => UniqueListenerMap;
 export {};

package/lib/lifecycleEvents.js

@@ -233,6 +233,8 @@ class Lifecycle {
 }
 exports.Lifecycle = Lifecycle;
 const cloneListeners = (listeners) => new Map(Array.from(listeners.entries()));
-const cloneUniqueListeners = (uniqueListeners) => new Map(Array.from(uniqueListeners.entries()).map(([key, value]) => [key, cloneListeners(value)]));
+const cloneUniqueListeners = (uniqueListeners) => 
+// in case we're crossing major sfdx-core versions where uniqueListeners might be undefined
+new Map(Array.from(uniqueListeners?.entries() ?? []).map(([key, value]) => [key, cloneListeners(value)]));
 exports.cloneUniqueListeners = cloneUniqueListeners;
 //# sourceMappingURL=lifecycleEvents.js.map

package/lib/sfProject.d.ts

@@ -19,14 +19,21 @@ export type ProjectJson = ConfigContents & ProjectJsonSchema;
  * The sfdx-project.json config object. This file determines if a folder is a valid sfdx project.
  *
  * *Note:* Any non-standard (not owned by Salesforce) properties stored in sfdx-project.json should
- * be in a top level property that represents your project or plugin.
+ * be in a top level property that represents your project.
+ * Plugins should store their configuration @see SfProject.getPluginConfiguration and @see SfProject.setPluginConfiguration
  *
+ * @example reading a standard property
  * ```
  * const project = await SfProject.resolve();
  * const projectJson = await project.resolveProjectConfig();
- * const myPluginProperties = projectJson.get('myplugin') || {};
- * myPluginProperties.myprop = 'someValue';
- * projectJson.set('myplugin', myPluginProperties);
+ * const namespace = projectJson.get('namespace');
+ * ```
+ *
+ * ```
+ * @example writing
+ * const project = await SfProject.resolve();
+ * const projectJson = await project.resolveProjectConfig();
+ * projectJson.set('namespace', 'new');
  * await projectJson.write();
  * ```
  *
@@ -315,6 +322,30 @@ export declare class SfProject {
     getPackageAliases(): Nullable<Dictionary<string>>;
     getPackageIdFromAlias(alias: string): Optional<string>;
     getAliasesFromPackageId(id: string): string[];
+    /**
+     * retrieve the configuration for a named plugin from sfdx-project.json.plugins.pluginName
+     *
+     * @example
+     * ```
+     * const project = await SfProject.resolve();
+     * const pluginConfig = await project.getPluginConfiguration('myPlugin');
+     * ```
+     *
+     * optionally pass a type parameter for your plugin configuration's schema
+     * */
+    getPluginConfiguration<T extends Record<string, unknown>>(pluginName: string): Promise<Readonly<T>>;
+    /**
+     * set the configuration for a named plugin from sfdx-project.json.plugins.pluginName, overwriting existing configuration
+     *
+     * @example
+     * ```
+     * const project = await SfProject.resolve();
+     * const pluginConfig = await project.setPluginConfiguration('myPlugin', {foo: 'bar', myLimit: 25});
+     * ```
+     *
+     * optionally pass a type parameter for your plugin configuration's schema
+     * */
+    setPluginConfiguration<T extends Record<string, unknown>>(pluginName: string, config: T): Promise<void>;
 }
 /** differentiate between the Base PackageDir (path, maybe default) and the Packaging version (package and maybe a LOT of other fields) by whether is has the `package` property */
 export declare const isPackagingDirectory: (packageDir: PackageDir) => packageDir is PackagePackageDir;

package/lib/sfProject.js

@@ -48,14 +48,21 @@ const messages = new messages_1.Messages('@salesforce/core', 'config', new Map([
  * The sfdx-project.json config object. This file determines if a folder is a valid sfdx project.
  *
  * *Note:* Any non-standard (not owned by Salesforce) properties stored in sfdx-project.json should
- * be in a top level property that represents your project or plugin.
+ * be in a top level property that represents your project.
+ * Plugins should store their configuration @see SfProject.getPluginConfiguration and @see SfProject.setPluginConfiguration
  *
+ * @example reading a standard property
  * ```
  * const project = await SfProject.resolve();
  * const projectJson = await project.resolveProjectConfig();
- * const myPluginProperties = projectJson.get('myplugin') || {};
- * myPluginProperties.myprop = 'someValue';
- * projectJson.set('myplugin', myPluginProperties);
+ * const namespace = projectJson.get('namespace');
+ * ```
+ *
+ * ```
+ * @example writing
+ * const project = await SfProject.resolve();
+ * const projectJson = await project.resolveProjectConfig();
+ * projectJson.set('namespace', 'new');
  * await projectJson.write();
  * ```
  *
@@ -654,6 +661,46 @@ class SfProject {
             .filter(([, value]) => value?.startsWith(id))
             .map(([key]) => key);
     }
+    /**
+     * retrieve the configuration for a named plugin from sfdx-project.json.plugins.pluginName
+     *
+     * @example
+     * ```
+     * const project = await SfProject.resolve();
+     * const pluginConfig = await project.getPluginConfiguration('myPlugin');
+     * ```
+     *
+     * optionally pass a type parameter for your plugin configuration's schema
+     * */
+    async getPluginConfiguration(pluginName) {
+        await this.retrieveSfProjectJson();
+        const plugins = this.sfProjectJson.get('plugins');
+        if (!plugins) {
+            throw new sfError_1.SfError('No plugins defined in sfdx-project.json', 'NoPluginsDefined');
+        }
+        if (!plugins[pluginName]) {
+            throw new sfError_1.SfError(`No configuration defined in sfdx-project.json for plugin ${pluginName}`, 'PluginNotFound');
+        }
+        return plugins[pluginName];
+    }
+    /**
+     * set the configuration for a named plugin from sfdx-project.json.plugins.pluginName, overwriting existing configuration
+     *
+     * @example
+     * ```
+     * const project = await SfProject.resolve();
+     * const pluginConfig = await project.setPluginConfiguration('myPlugin', {foo: 'bar', myLimit: 25});
+     * ```
+     *
+     * optionally pass a type parameter for your plugin configuration's schema
+     * */
+    async setPluginConfiguration(pluginName, config) {
+        await this.retrieveSfProjectJson();
+        const plugins = this.getSfProjectJson().get('plugins') ?? {};
+        const modified = { ...plugins, [pluginName]: config };
+        this.sfProjectJson.set('plugins', modified);
+        this.sfProjectJson.writeSync();
+    }
 }
 exports.SfProject = SfProject;
 /** differentiate between the Base PackageDir (path, maybe default) and the Packaging version (package and maybe a LOT of other fields) by whether is has the `package` property */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/core",
-  "version": "8.0.5",
+  "version": "8.1.1",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/index",
   "types": "lib/index.d.ts",