@salesforce/core-bundle 8.0.5 → 8.1.0

package/lib/index.d.ts

@@ -4539,14 +4539,21 @@ declare module '@salesforce/core-bundle/sfProject' {
    * 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();
    * ```
    *
@@ -4835,6 +4842,30 @@ declare module '@salesforce/core-bundle/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 const isPackagingDirectory: (packageDir: PackageDir) => packageDir is PackagePackageDir;

package/lib/index.js

@@ -12088,7 +12088,7 @@ var require_package2 = __commonJS({
   "package.json"(exports2, module2) {
     module2.exports = {
       name: "@salesforce/core-bundle",
-      version: "8.0.5",
+      version: "8.1.0",
       description: "Core libraries to interact with SFDX projects, orgs, and APIs.",
       main: "lib/index",
       types: "lib/index.d.ts",
@@ -94197,6 +94197,46 @@ var require_sfProject = __commonJS({
         }
         return Object.entries(this.getPackageAliases() ?? {}).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_12.SfError("No plugins defined in sfdx-project.json", "NoPluginsDefined");
+        }
+        if (!plugins[pluginName]) {
+          throw new sfError_12.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();
+      }
     };
     exports2.SfProject = SfProject;
     var isPackagingDirectory = (packageDir) => isPackagingDir(packageDir);

package/package.json

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