@salesforce/core 4.0.0 → 4.0.1

package/lib/{sfdxProject.d.ts → sfProject.d.ts}

@@ -1,12 +1,12 @@
-import { JsonMap, Nullable, Optional } from '@salesforce/ts-types';
+import { Dictionary, JsonMap, Nullable, Optional } from '@salesforce/ts-types';
 import { ConfigFile } from './config/configFile';
 import { ConfigContents } from './config/configStore';
-export declare type PackageDirDependency = {
+export type PackageDirDependency = {
     [k: string]: unknown;
     package: string;
     versionNumber?: string;
 };
-export declare type PackageDir = {
+export type PackageDir = {
     ancestorId?: string;
     ancestorVersion?: string;
     default?: boolean;
@@ -23,7 +23,7 @@ export declare type PackageDir = {
     versionName?: string;
     versionNumber?: string;
 };
-export declare type NamedPackageDir = PackageDir & {
+export type NamedPackageDir = PackageDir & {
     /**
      * The [normalized](https://nodejs.org/api/path.html#path_path_normalize_path) path used as the package name.
      */
@@ -33,7 +33,7 @@ export declare type NamedPackageDir = PackageDir & {
      */
     fullPath: string;
 };
-export declare type ProjectJson = ConfigContents & {
+export type ProjectJson = ConfigContents & {
     packageDirectories: PackageDir[];
     namespace?: string;
     sourceApiVersion?: string;
@@ -54,7 +54,7 @@ export declare type ProjectJson = ConfigContents & {
  * be in a top level property that represents your project or plugin.
  *
  * ```
- * const project = await SfdxProject.resolve();
+ * const project = await SfProject.resolve();
  * const projectJson = await project.resolveProjectConfig();
  * const myPluginProperties = projectJson.get('myplugin') || {};
  * myPluginProperties.myprop = 'someValue';
@@ -64,7 +64,7 @@ export declare type ProjectJson = ConfigContents & {
  *
  * **See** [force:project:create](https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_ws_create_new.htm)
  */
-export declare class SfdxProjectJson extends ConfigFile {
+export declare class SfProjectJson extends ConfigFile {
     static BLOCKLIST: string[];
     static getFileName(): string;
     static getDefaultOptions(isGlobal?: boolean): ConfigFile.Options;
@@ -80,7 +80,7 @@ export declare class SfdxProjectJson extends ConfigFile {
      * Set the `SFDX_PROJECT_JSON_VALIDATION` environment variable to `true` to throw an error when schema validation fails.
      * A warning is logged by default when the file is invalid.
      *
-     * ***See*** [sfdx-project.schema.json] (https://raw.githubusercontent.com/forcedotcom/schemas/master/schemas/sfdx-project.schema.json)
+     * ***See*** [sfdx-project.schema.json] ((https://github.com/forcedotcom/schemas/blob/main/sfdx-project.schema.json)
      */
     schemaValidate(): Promise<void>;
     /**
@@ -94,7 +94,7 @@ export declare class SfdxProjectJson extends ConfigFile {
      * Set the `SFDX_PROJECT_JSON_VALIDATION` environment variable to `true` to throw an error when schema validation fails.
      * A warning is logged by default when the file is invalid.
      *
-     * ***See*** [sfdx-project.schema.json] (https://raw.githubusercontent.com/forcedotcom/schemas/master/schemas/sfdx-project.schema.json)
+     * ***See*** [sfdx-project.schema.json] ((https://github.com/forcedotcom/schemas/blob/main/sfdx-project.schema.json)
      */
     schemaValidateSync(): void;
     /**
@@ -115,7 +115,7 @@ export declare class SfdxProjectJson extends ConfigFile {
      */
     getUniquePackageDirectories(): NamedPackageDir[];
     /**
-     * Get a list of the unique package names from within sfdx-project.json. Use {@link SfdxProject.getUniquePackageDirectories}
+     * Get a list of the unique package names from within sfdx-project.json. Use {@link SfProject.getUniquePackageDirectories}
      * for data other than the names.
      */
     getUniquePackageNames(): string[];
@@ -127,55 +127,80 @@ export declare class SfdxProjectJson extends ConfigFile {
      * Has multiple package directories (MPD) defined in the project.
      */
     hasMultiplePackages(): boolean;
+    /**
+     * Has at least one package alias defined in the project.
+     */
+    hasPackageAliases(): Promise<boolean>;
+    /**
+     * Get package aliases defined in the project.
+     */
+    getPackageAliases(): Nullable<Dictionary<string>>;
+    /**
+     * Add a package alias to the project.
+     * If the alias already exists, it will be overwritten.
+     *
+     * @param alias
+     * @param id
+     */
+    addPackageAlias(alias: string, id: string): void;
+    /**
+     * Add a package directory to the project.
+     * If the package directory already exists, the new directory
+     * properties will be merged with the existing properties.
+     *
+     * @param packageDir
+     */
+    addPackageDirectory(packageDir: NamedPackageDir): void;
     private doesPackageExist;
     private validateKeys;
 }
 /**
- * Represents an SFDX project directory. This directory contains a {@link SfdxProjectJson} config file as well as
+ * Represents an SFDX project directory. This directory contains a {@link SfProjectJson} config file as well as
  * a hidden .sfdx folder that contains all the other local project config files.
  *
  * ```
- * const project = await SfdxProject.resolve();
+ * const project = await SfProject.resolve();
  * const projectJson = await project.resolveProjectConfig();
  * console.log(projectJson.sfdcLoginUrl);
  * ```
  */
-export declare class SfdxProject {
+export declare class SfProject {
     private path;
     private static instances;
     private projectConfig;
-    private sfdxProjectJson;
-    private sfdxProjectJsonGlobal;
+    private sfProjectJson;
+    private sfProjectJsonGlobal;
     private packageDirectories?;
     private activePackage;
+    private packageAliases;
     /**
-     * Do not directly construct instances of this class -- use {@link SfdxProject.resolve} instead.
+     * Do not directly construct instances of this class -- use {@link SfProject.resolve} instead.
      *
      * @ignore
      */
-    private constructor();
+    protected constructor(path: string);
     /**
      * Get a Project from a given path or from the working directory.
      *
      * @param path The path of the project.
      *
-     * **Throws** *{@link SfdxError}{ name: 'InvalidProjectWorkspaceError' }* If the current folder is not located in a workspace.
+     * **Throws** *{@link SfError}{ name: 'InvalidProjectWorkspaceError' }* If the current folder is not located in a workspace.
      */
-    static resolve(path?: string): Promise<SfdxProject>;
+    static resolve(path?: string): Promise<SfProject>;
     /**
      * Get a Project from a given path or from the working directory.
      *
      * @param path The path of the project.
      *
-     * **Throws** *{@link SfdxError}{ name: 'InvalidProjectWorkspaceError' }* If the current folder is not located in a workspace.
+     * **Throws** *{@link SfError}{ name: 'InvalidProjectWorkspaceError' }* If the current folder is not located in a workspace.
      */
-    static getInstance(path?: string): SfdxProject;
+    static getInstance(path?: string): SfProject;
     /**
      * Performs an upward directory search for an sfdx project file. Returns the absolute path to the project.
      *
      * @param dir The directory path to start traversing from.
      *
-     * **Throws** *{@link SfdxError}{ name: 'InvalidProjectWorkspaceError' }* If the current folder is not located in a workspace.
+     * **Throws** *{@link SfError}{ name: 'InvalidProjectWorkspaceError' }* If the current folder is not located in a workspace.
      *
      * **See** {@link traverseForFile}
      *
@@ -187,7 +212,7 @@ export declare class SfdxProject {
      *
      * @param dir The directory path to start traversing from.
      *
-     * **Throws** *{@link SfdxError}{ name: 'InvalidProjectWorkspaceError' }* If the current folder is not located in a workspace.
+     * **Throws** *{@link SfError}{ name: 'InvalidProjectWorkspaceError' }* If the current folder is not located in a workspace.
      *
      * **See** {@link traverseForFileSync}
      *
@@ -202,24 +227,24 @@ export declare class SfdxProject {
      * Get the sfdx-project.json config. The global sfdx-project.json is used for user defaults
      * that are not checked in to the project specific file.
      *
-     * *Note:* When reading values from {@link SfdxProjectJson}, it is recommended to use
-     * {@link SfdxProject.resolveProjectConfig} instead.
+     * *Note:* When reading values from {@link SfProjectJson}, it is recommended to use
+     * {@link SfProject.resolveProjectConfig} instead.
      *
      * @param isGlobal True to get the global project file, otherwise the local project config.
      */
-    retrieveSfdxProjectJson(isGlobal?: boolean): Promise<SfdxProjectJson>;
+    retrieveSfProjectJson(isGlobal?: boolean): Promise<SfProjectJson>;
     /**
      * Get the sfdx-project.json config. The global sfdx-project.json is used for user defaults
      * that are not checked in to the project specific file.
      *
-     * *Note:* When reading values from {@link SfdxProjectJson}, it is recommended to use
-     * {@link SfdxProject.resolveProjectConfig} instead.
+     * *Note:* When reading values from {@link SfProjectJson}, it is recommended to use
+     * {@link SfProject.resolveProjectConfig} instead.
      *
-     * This is the sync method of {@link SfdxProject.resolveSfdxProjectJson}
+     * This is the sync method of {@link SfProject.resolveSfProjectJson}
      *
      * @param isGlobal True to get the global project file, otherwise the local project config.
      */
-    getSfdxProjectJson(isGlobal?: boolean): SfdxProjectJson;
+    getSfProjectJson(isGlobal?: boolean): SfProjectJson;
     /**
      * Returns a read-only list of `packageDirectories` within sfdx-project.json, first reading
      * and validating the file if necessary. i.e. modifying this array will not affect the
@@ -238,7 +263,7 @@ export declare class SfdxProject {
      */
     getUniquePackageDirectories(): NamedPackageDir[];
     /**
-     * Get a list of the unique package names from within sfdx-project.json. Use {@link SfdxProject.getUniquePackageDirectories}
+     * Get a list of the unique package names from within sfdx-project.json. Use {@link SfProject.getUniquePackageDirectories}
      * for data other than the names.
      */
     getUniquePackageNames(): string[];
@@ -260,6 +285,12 @@ export declare class SfdxProject {
      * @param packageName Name of the package directory.  E.g., 'force-app'
      */
     getPackage(packageName: string): Optional<NamedPackageDir>;
+    /**
+     * Returns the package directory.
+     *
+     * @param packageName Name of the package directory.  E.g., 'force-app'
+     */
+    findPackage(predicate: (packageDir: NamedPackageDir) => boolean): Optional<NamedPackageDir>;
     /**
      * Returns the absolute path of the package directory ending with the path separator.
      * E.g., /Users/jsmith/projects/ebikes-lwc/force-app/
@@ -284,7 +315,7 @@ export declare class SfdxProject {
      * Set the currently activated package on the project. This has no implication on sfdx-project.json
      * but is useful for keeping track of package and source specific options in a process.
      *
-     * @param pkgName The package name to activate. E.g. 'force-app'
+     * @param packageName The package name to activate. E.g. 'force-app'
      */
     setActivePackage(packageName: Nullable<string>): void;
     /**
@@ -293,15 +324,24 @@ export declare class SfdxProject {
      */
     getDefaultPackage(): NamedPackageDir;
     /**
-     * The project config is resolved from local and global {@link SfdxProjectJson},
+     * The project config is resolved from local and global {@link SfProjectJson},
      * {@link ConfigAggregator}, and a set of defaults. It is recommended to use
-     * this when reading values from SfdxProjectJson.
+     * this when reading values from SfProjectJson.
      *
-     * The global {@link SfdxProjectJson} is used to allow the user to provide default values they
+     * The global {@link SfProjectJson} is used to allow the user to provide default values they
      * may not want checked into their project's source.
      *
      * @returns A resolved config object that contains a bunch of different
      * properties, including some 3rd party custom properties.
      */
     resolveProjectConfig(): Promise<JsonMap>;
+    hasPackageAliases(): Promise<boolean>;
+    /**
+     * Returns a read-only list of `packageDirectories` within sfdx-project.json, first reading
+     * and validating the file if necessary. i.e. modifying this array will not affect the
+     * sfdx-project.json file.
+     */
+    getPackageAliases(): Nullable<Dictionary<string>>;
+    getPackageIdFromAlias(alias: string): Optional<string>;
+    getAliasesFromPackageId(id: string): string[];
 }