@rushstack/rush-sdk 5.112.2-pr4485.2 → 5.113.0

package/lib/api/RushConfiguration.d.ts

@@ -3,10 +3,10 @@ import { RushConfigurationProject, type IRushConfigurationProjectJson } from './
 import { ApprovedPackagesPolicy } from './ApprovedPackagesPolicy';
 import { EventHooks } from './EventHooks';
 import { VersionPolicyConfiguration } from './VersionPolicyConfiguration';
-import { CommonVersionsConfiguration } from './CommonVersionsConfiguration';
+import type { CommonVersionsConfiguration } from './CommonVersionsConfiguration';
 import type { PackageManagerName, PackageManager } from './packageManager/PackageManager';
 import { ExperimentsConfiguration } from './ExperimentsConfiguration';
-import { RepoStateFile } from '../logic/RepoStateFile';
+import type { RepoStateFile } from '../logic/RepoStateFile';
 import { LookupByPath } from '../logic/LookupByPath';
 import { RushPluginsConfiguration } from './RushPluginsConfiguration';
 import { type IPnpmOptionsJson, PnpmOptionsConfiguration } from '../logic/pnpm/PnpmOptionsConfiguration';
@@ -14,7 +14,8 @@ import { type INpmOptionsJson, NpmOptionsConfiguration } from '../logic/npm/NpmO
 import { type IYarnOptionsJson, YarnOptionsConfiguration } from '../logic/yarn/YarnOptionsConfiguration';
 import type { PackageManagerOptionsConfigurationBase } from '../logic/base/BasePackageManagerOptionsConfiguration';
 import { CustomTipsConfiguration } from './CustomTipsConfiguration';
-import { SubspaceConfiguration } from './SubspaceConfiguration';
+import { SubspacesConfiguration } from './SubspacesConfiguration';
+import { Subspace } from './Subspace';
 /**
  * Part of IRushConfigurationJson.
  */
@@ -154,8 +155,9 @@ export declare class RushConfiguration {
     private _projects;
     private _projectsByName;
     private _projectsByTag;
-    private _rushProjectsBySubspaceName;
     private _commonVersionsConfigurationsByVariant;
+    private readonly _subspacesByName;
+    private readonly _subspaces;
     /**
      * The name of the package manager being used to install dependencies
      */
@@ -245,29 +247,15 @@ export declare class RushConfiguration {
      * Example: `npm-shrinkwrap.json` or `pnpm-lock.yaml`
      */
     readonly shrinkwrapFilename: string;
-    /**
-     * The full path of the temporary shrinkwrap file that is used during "rush install".
-     * This file may get rewritten by the package manager during installation.
-     * @remarks
-     * This property merely reports the filename; the file itself may not actually exist.
-     * Example: `C:\MyRepo\common\temp\npm-shrinkwrap.json` or `C:\MyRepo\common\temp\pnpm-lock.yaml`
-     */
-    readonly tempShrinkwrapFilename: string;
-    /**
-     * The full path of a backup copy of tempShrinkwrapFilename. This backup copy is made
-     * before installation begins, and can be compared to determine how the package manager
-     * modified tempShrinkwrapFilename.
-     * @remarks
-     * This property merely reports the filename; the file itself may not actually exist.
-     * Example: `C:\MyRepo\common\temp\npm-shrinkwrap-preinstall.json`
-     * or `C:\MyRepo\common\temp\pnpm-lock-preinstall.yaml`
-     */
-    readonly tempShrinkwrapPreinstallFilename: string;
     /**
      * The object that specifies subspace configurations if they are provided in the rush workspace.
      * @beta
      */
-    readonly subspaceConfiguration?: SubspaceConfiguration;
+    readonly subspacesConfiguration: SubspacesConfiguration | undefined;
+    /**
+     * Returns true if subspaces.json is present with "enabled=true".
+     */
+    readonly subspacesFeatureEnabled: boolean;
     /**
      * The filename of the variant dependency data file.  By default this is
      * called 'current-variant.json' resides in the Rush common folder.
@@ -496,35 +484,27 @@ export declare class RushConfiguration {
      */
     get rushPluginOptionsFolder(): string;
     /**
-     * The full path of the shrinkwrap file that is tracked by Git.  (The "rush install"
-     * command uses a temporary copy, whose path is tempShrinkwrapFilename.)
+     * The full path of the temporary shrinkwrap file that is used during "rush install".
+     * This file may get rewritten by the package manager during installation.
      * @remarks
      * This property merely reports the filename; the file itself may not actually exist.
-     * Example: `C:\MyRepo\common\npm-shrinkwrap.json` or `C:\MyRepo\common\pnpm-lock.yaml`
+     * Example: `C:\MyRepo\common\temp\npm-shrinkwrap.json` or `C:\MyRepo\common\temp\pnpm-lock.yaml`
      *
-     * @deprecated Use `getCommittedShrinkwrapFilename` instead, which gets the correct common
-     * shrinkwrap file name for a given active variant.
+     * @deprecated Introduced with subspaces is subspace specific tempShrinkwrapFilename accessible from the Subspace class.
      */
-    get committedShrinkwrapFilename(): string;
+    get tempShrinkwrapFilename(): string;
     /**
-     * Returns full path of the temporary shrinkwrap file for a specific subspace.
-     * @remarks
-     * This function takes the subspace name, and returns the full path for the subspace's shrinkwrap file.
-     * This function also consults the deprecated option to allow for shrinkwraps to be stored under a package folder.
-     * This shrinkwrap file is used during "rush install", and may be rewritten by the package manager during installation
-     * This property merely reports the filename, the file itself may not actually exist.
-     * example: `C:\MyRepo\common\<subspace_name>\pnpm-lock.yaml`
-     * @beta
-     */
-    getTempSubspaceShrinkwrapFileName(subspaceName: string): string;
-    /**
-     * The filename (without any path) of the shrinkwrap file used for individual subspaces, used by the package manager.
+     * The full path of a backup copy of tempShrinkwrapFilename. This backup copy is made
+     * before installation begins, and can be compared to determine how the package manager
+     * modified tempShrinkwrapFilename.
      * @remarks
-     * This property merely reports the filename; The file itself may not actually exist.
-     * Example: From "pnpm-lock.yaml" to "subspace-pnpm-lock.yaml"
-     * @beta
+     * This property merely reports the filename; the file itself may not actually exist.
+     * Example: `C:\MyRepo\common\temp\npm-shrinkwrap-preinstall.json`
+     * or `C:\MyRepo\common\temp\pnpm-lock-preinstall.yaml`
+     *
+     * @deprecated Introduced with subspaces is subspace specific tempShrinkwrapPreinstallFilename accessible from the Subspace class.
      */
-    subspaceShrinkwrapFilenames(subspaceName: string): string;
+    get tempShrinkwrapPreinstallFilename(): string;
     /**
      * Returns an English phrase such as "shrinkwrap file" that can be used in logging messages
      * to refer to the shrinkwrap file using appropriate terminology for the currently selected
@@ -547,15 +527,32 @@ export declare class RushConfiguration {
      */
     get repositoryDefaultFullyQualifiedRemoteBranch(): string;
     get projects(): RushConfigurationProject[];
+    /**
+     * @beta
+     */
+    get defaultSubspace(): Subspace;
     /**
      * A list of all the available subspaces in this workspace.
      * @beta
      */
-    get subspaceNames(): Iterable<string>;
+    get subspaces(): readonly Subspace[];
+    /**
+     * @beta
+     */
+    tryGetSubspace(subspaceName: string): Subspace | undefined;
+    /**
+     * @beta
+     */
+    getSubspace(subspaceName: string): Subspace;
     /**
+     * Returns the set of subspaces that the given projects belong to
      * @beta
      */
-    get projectsByName(): Map<string, RushConfigurationProject>;
+    getSubspacesForProjects(projects: ReadonlySet<RushConfigurationProject>): ReadonlySet<Subspace>;
+    /**
+     * @beta
+     */
+    get projectsByName(): ReadonlyMap<string, RushConfigurationProject>;
     /**
      * Obtains the mapping from custom tags to projects.
      * @beta
@@ -580,21 +577,13 @@ export declare class RushConfiguration {
      */
     get currentInstalledVariant(): string | undefined;
     /**
-     * Gets the path to the common-versions.json config file for a specific variant.
-     * @param variant - The name of the current variant in use by the active command.
+     * @deprecated Use {@link Subspace.getCommonVersionsFilePath} instead
      */
-    getCommonVersionsFilePath(variant?: string | undefined): string;
+    getCommonVersionsFilePath(subspace?: Subspace): string;
     /**
-     * Returns `true` if the subspaces feature is enabled and at least one subspaces is defined
-     * in the `subspaces.json` config file.
-     * @beta
+     * @deprecated Use {@link Subspace.getCommonVersions} instead
      */
-    get hasSubspaces(): boolean;
-    /**
-     * Gets the settings from the common-versions.json config file for a specific variant.
-     * @param variant - The name of the current variant in use by the active command.
-     */
-    getCommonVersions(variant?: string | undefined): CommonVersionsConfiguration;
+    getCommonVersions(subspace?: Subspace): CommonVersionsConfiguration;
     /**
      * Returns a map of all direct dependencies that only have a single semantic version specifier.
      * @param variant - The name of the current variant in use by the active command.
@@ -603,27 +592,21 @@ export declare class RushConfiguration {
      */
     getImplicitlyPreferredVersions(variant?: string | undefined): Map<string, string>;
     /**
-     * Gets the path to the repo-state.json file for a specific variant.
-     * @param variant - The name of the current variant in use by the active command.
+     * @deprecated Use {@link Subspace.getRepoStateFilePath} instead
      */
-    getRepoStateFilePath(variant?: string | undefined): string;
+    getRepoStateFilePath(subspace?: Subspace): string;
     /**
-     * Gets the contents from the repo-state.json file for a specific variant.
-     * @param variant - The name of the current variant in use by the active command.
+     * @deprecated Use {@link Subspace.getRepoState} instead
      */
-    getRepoState(variant?: string | undefined): RepoStateFile;
+    getRepoState(subspace?: Subspace): RepoStateFile;
     /**
-     * Gets the committed shrinkwrap file name for a specific variant.
-     * @param variant - The name of the current variant in use by the active command.
+     * @deprecated Use {@link Subspace.getCommittedShrinkwrapFilename} instead
      */
-    getCommittedShrinkwrapFilename(variant?: string | undefined): string;
+    getCommittedShrinkwrapFilename(subspace?: Subspace): string;
     /**
-     * Gets the absolute path for "pnpmfile.js" for a specific variant.
-     * @param variant - The name of the current variant in use by the active command.
-     * @remarks
-     * The file path is returned even if PNPM is not configured as the package manager.
+     * @deprecated Use {@link Subspace.getRepoStateFilePath} instead
      */
-    getPnpmfilePath(variant?: string | undefined): string;
+    getPnpmfilePath(subspace?: Subspace): string;
     /**
      * Looks up a project in the projectsByName map.  If the project is not found,
      * then undefined is returned.
@@ -651,6 +634,5 @@ export declare class RushConfiguration {
      * If the path is not under any project's folder, returns undefined.
      */
     tryGetProjectForPath(currentFolderPath: string): RushConfigurationProject | undefined;
-    private _getVariantConfigFolderPath;
 }
 //# sourceMappingURL=RushConfiguration.d.ts.map

package/lib/api/RushConfigurationProject.d.ts

@@ -2,6 +2,7 @@ import { type IPackageJson } from '@rushstack/node-core-library';
 import type { RushConfiguration } from '../api/RushConfiguration';
 import type { VersionPolicy } from './VersionPolicy';
 import type { PackageJsonEditor } from './PackageJsonEditor';
+import type { Subspace } from './Subspace';
 /**
  * This represents the JSON data object for a project entry in the rush.json configuration file.
  */
@@ -38,6 +39,10 @@ export interface IRushConfigurationProjectOptions {
      * If specified, validate project tags against this list.
      */
     allowedProjectTags: Set<string> | undefined;
+    /**
+     * The containing subspace.
+     */
+    subspace: Subspace;
 }
 /**
  * This represents the configuration of a project that is built by Rush, based on
@@ -85,6 +90,11 @@ export declare class RushConfigurationProject {
      * The Rush configuration for the monorepo that the project belongs to.
      */
     readonly rushConfiguration: RushConfiguration;
+    /**
+     * Returns the subspace name that a project belongs to.
+     * If subspaces is not enabled, returns the default subspace.
+     */
+    readonly subspace: Subspace;
     /**
      * The review category name, or undefined if no category was assigned.
      * This name must be one of the valid choices listed in RushConfiguration.reviewCategories.
@@ -153,17 +163,13 @@ export declare class RushConfigurationProject {
      */
     readonly tags: ReadonlySet<string>;
     /**
-     * Returns the name of the subspace that this project belongs to, as assigned by the `"subspaceName"`
-     * property in `rush.json`.
-     *
-     * @remarks
-     * If the Rush subspaces feature is disabled, the value is still return.
-     * When the Rush subspaces feature is enabled, an undefined `subspaceName` specifies that
-     * the project belongs to the default subspace (whose name is `"default"`).
+     * Returns the subspace name specified in the `"subspaceName"` field in `rush.json`.
+     * Note that this field may be undefined, if the `default` subspace is being used,
+     * and this field may be ignored if the subspaces feature is disabled.
      *
      * @beta
      */
-    readonly subspaceName: string | undefined;
+    readonly configuredSubspaceName: string | undefined;
     /** @internal */
     constructor(options: IRushConfigurationProjectOptions);
     /**

package/lib/api/RushProjectConfiguration.d.ts

@@ -73,13 +73,6 @@ export interface IOperationSettings {
      * calculating final hash value when reading and writing the build cache
      */
     dependsOnAdditionalFiles?: string[];
-    /**
-     * When running this operation in watch mode, enable IPC functionality. This allows reusing a long-lived child
-     * process instead of spawning a new child process for each incremental build.
-     *
-     * Implicitly disables the build cache for this operation.
-     */
-    useIPCInWatchMode?: boolean;
 }
 /**
  * Use this class to load the "config/rush-project.json" config file.

package/lib/api/Subspace.d.ts

@@ -0,0 +1,117 @@
+import type { RushConfiguration } from './RushConfiguration';
+import type { RushConfigurationProject } from './RushConfigurationProject';
+import { CommonVersionsConfiguration } from './CommonVersionsConfiguration';
+import { RepoStateFile } from '../logic/RepoStateFile';
+/**
+ * @internal
+ */
+export interface ISubspaceOptions {
+    subspaceName: string;
+    rushConfiguration: RushConfiguration;
+    splitWorkspaceCompatibility: boolean;
+}
+/**
+ * This represents the subspace configurations for a repository, based on the "subspaces.json"
+ * configuration file.
+ * @public
+ */
+export declare class Subspace {
+    readonly subspaceName: string;
+    private readonly _rushConfiguration;
+    private readonly _projects;
+    private readonly _splitWorkspaceCompatibility;
+    private _commonVersionsConfiguration;
+    private _detail;
+    constructor(options: ISubspaceOptions);
+    /**
+     * Returns the list of projects belonging to this subspace.
+     * @beta
+     */
+    getProjects(): RushConfigurationProject[];
+    private _ensureDetail;
+    /**
+     * Returns the full path of the folder containing this subspace's configuration files such as `pnpm-lock.yaml`.
+     *
+     * Example: `common/config/subspaces/my-subspace`
+     * @beta
+     */
+    getSubspaceConfigFolder(): string;
+    /**
+     * The folder where the subspace's node_modules and other temporary files will be stored.
+     *
+     * Example: `common/temp/subspaces/my-subspace`
+     * @beta
+     */
+    getSubspaceTempFolder(): string;
+    /**
+     * Returns full path of the temporary shrinkwrap file for a specific subspace and returns the common workspace
+     * shrinkwrap if no subspaceName is provided.
+     * @remarks
+     * This function takes the subspace name, and returns the full path for the subspace's shrinkwrap file.
+     * This function also consults the deprecated option to allow for shrinkwraps to be stored under a package folder.
+     * This shrinkwrap file is used during "rush install", and may be rewritten by the package manager during installation
+     * This property merely reports the filename, the file itself may not actually exist.
+     * example: `C:\MyRepo\common\<subspace_name>\pnpm-lock.yaml`
+     * @beta
+     */
+    getTempShrinkwrapFilename(): string;
+    /**
+     * The full path of a backup copy of tempShrinkwrapFilename. This backup copy is made
+     * before installation begins, and can be compared to determine how the package manager
+     * modified tempShrinkwrapFilename.
+     * @remarks
+     * This property merely reports the filename; the file itself may not actually exist.
+     * Example: `C:\MyRepo\common\temp\npm-shrinkwrap-preinstall.json`
+     * or `C:\MyRepo\common\temp\pnpm-lock-preinstall.yaml`
+     * @beta
+     */
+    getTempShrinkwrapPreinstallFilename(subspaceName?: string | undefined): string;
+    /**
+     * Gets the path to the common-versions.json config file for this subspace.
+     *
+     * Example: `C:\MyRepo\common\subspaces\my-subspace\common-versions.json`
+     * @beta
+     */
+    getCommonVersionsFilePath(): string;
+    /**
+     * Gets the settings from the common-versions.json config file for a specific variant.
+     * @param variant - The name of the current variant in use by the active command.
+     * @beta
+     */
+    getCommonVersions(): CommonVersionsConfiguration;
+    /**
+     * Gets the path to the repo-state.json file for a specific variant.
+     * @param variant - The name of the current variant in use by the active command.
+     * @beta
+     */
+    getRepoStateFilePath(): string;
+    /**
+     * Gets the contents from the repo-state.json file for a specific variant.
+     * @param subspaceName - The name of the subspace in use by the active command.
+     * @param variant - The name of the current variant in use by the active command.
+     * @beta
+     */
+    getRepoState(): RepoStateFile;
+    /**
+     * Gets the committed shrinkwrap file name for a specific variant.
+     * @param variant - The name of the current variant in use by the active command.
+     * @beta
+     */
+    getCommittedShrinkwrapFilename(): string;
+    /**
+     * Gets the absolute path for "pnpmfile.js" for a specific subspace.
+     * @param subspace - The name of the current subspace in use by the active command.
+     * @remarks
+     * The file path is returned even if PNPM is not configured as the package manager.
+     * @beta
+     */
+    getPnpmfilePath(): string;
+    /**
+     * Returns true if the specified project belongs to this subspace.
+     * @beta
+     */
+    contains(project: RushConfigurationProject): boolean;
+    /** @internal */
+    _addProject(project: RushConfigurationProject): void;
+}
+//# sourceMappingURL=Subspace.d.ts.map

package/lib/api/{SubspaceConfiguration.js → Subspace.js}

@@ -1 +1 @@
-module.exports = require("../../lib-shim/index")._rushSdk_loadInternalModule("api/SubspaceConfiguration");
+module.exports = require("../../lib-shim/index")._rushSdk_loadInternalModule("api/Subspace");

package/lib/api/SubspacesConfiguration.d.ts

@@ -0,0 +1,58 @@
+import type { RushConfiguration } from './RushConfiguration';
+/**
+ * The allowed naming convention for subspace names.
+ * Allows for names to be formed of identifiers separated by hyphens (-)
+ *
+ * Example: "my-subspace"
+ */
+export declare const SUBSPACE_NAME_REGEXP: RegExp;
+export declare const SPLIT_WORKSPACE_SUBSPACE_NAME_REGEXP: RegExp;
+/**
+ * This represents the subspace configurations for a repository, based on the "subspaces.json"
+ * configuration file.
+ * @beta
+ */
+export declare class SubspacesConfiguration {
+    private static _jsonSchema;
+    /**
+     * The absolute path to the "subspaces.json" configuration file that was loaded to construct this object.
+     */
+    readonly subspaceJsonFilePath: string;
+    /**
+     * Determines if the subspace feature is enabled
+     */
+    readonly enabled: boolean;
+    /**
+     * This determines if the subspaces feature supports adding configuration files under the project folder itself
+     */
+    readonly splitWorkspaceCompatibility: boolean;
+    /**
+     * A set of the available subspaces
+     */
+    readonly subspaceNames: ReadonlySet<string>;
+    private constructor();
+    /**
+     * Checks whether the provided string could be used as a subspace name.
+     * Returns `undefined` if the name is valid; otherwise returns an error message.
+     * @remarks
+     * This is a syntax check only; it does not test whether the subspace is actually defined in the Rush configuration.
+     */
+    static explainIfInvalidSubspaceName(subspaceName: string, splitWorkspaceCompatibility?: boolean): string | undefined;
+    /**
+     * Checks whether the provided string could be used as a subspace name.
+     * If not, an exception is thrown.
+     * @remarks
+     * This is a syntax check only; it does not test whether the subspace is actually defined in the Rush configuration.
+     */
+    static requireValidSubspaceName(subspaceName: string, splitWorkspaceCompatibility?: boolean): void;
+    static tryLoadFromConfigurationFile(subspaceJsonFilePath: string): SubspacesConfiguration | undefined;
+    static tryLoadFromDefaultLocation(rushConfiguration: RushConfiguration): SubspacesConfiguration | undefined;
+    /**
+     * Returns a name of the form `_RUSH_SUBSPACE_XYZ_TEMP_FOLDER` where `XYZ` is
+     * derived from the subspace name.
+     *
+     * @internal
+     */
+    static _convertNameToEnvironmentVariable(subspaceName: string, splitWorkspaceCompatibility: boolean): string;
+}
+//# sourceMappingURL=SubspacesConfiguration.d.ts.map

package/lib/api/SubspacesConfiguration.js

@@ -0,0 +1 @@
+module.exports = require("../../lib-shim/index")._rushSdk_loadInternalModule("api/SubspacesConfiguration");

package/lib/api/VersionPolicyConfiguration.d.ts

@@ -47,7 +47,7 @@ export declare class VersionPolicyConfiguration {
     /**
      * Validate the version policy configuration against the rush config
      */
-    validate(projectsByName: Map<string, RushConfigurationProject>): void;
+    validate(projectsByName: ReadonlyMap<string, RushConfigurationProject>): void;
     /**
      * Gets the version policy by its name.
      * Throws error if the version policy is not found.

package/lib/api/packageManager/PnpmPackageManager.d.ts

@@ -11,6 +11,13 @@ export declare class PnpmPackageManager extends PackageManager {
      * Example: `pnpmfile.js` or `.pnpmfile.cjs`
      */
     readonly pnpmfileFilename: string;
+    /**
+     * The filename of the shrinkwrap file of a subspace that is used by the package manager.
+     *
+     * @remarks
+     * Example: `.pnpmfile-subspace.cjs`
+     */
+    subspacePnpmfileFilename: string;
     /** @internal */
     constructor(version: string);
 }

package/lib/cli/actions/BaseInstallAction.d.ts

@@ -3,6 +3,7 @@ import { type ITerminal } from '@rushstack/node-core-library';
 import { BaseRushAction, type IBaseRushActionOptions } from './BaseRushAction';
 import type { IInstallManagerOptions } from '../../logic/base/BaseInstallManagerTypes';
 import type { SelectionParameterSet } from '../parsing/SelectionParameterSet';
+import type { Subspace } from '../../api/Subspace';
 /**
  * This is the common base class for InstallAction and UpdateAction.
  */
@@ -17,10 +18,13 @@ export declare abstract class BaseInstallAction extends BaseRushAction {
     protected readonly _maxInstallAttempts: CommandLineIntegerParameter;
     protected readonly _ignoreHooksParameter: CommandLineFlagParameter;
     protected readonly _offlineParameter: CommandLineFlagParameter;
+    protected readonly _subspaceParameter: CommandLineStringParameter;
     protected _selectionParameters?: SelectionParameterSet;
     constructor(options: IBaseRushActionOptions);
     protected abstract buildInstallOptionsAsync(): Promise<IInstallManagerOptions>;
+    protected getTargetSubspace(): Subspace;
     protected runAsync(): Promise<void>;
+    private _doInstall;
     private _collectTelemetry;
 }
 //# sourceMappingURL=BaseInstallAction.d.ts.map

package/lib/index.d.ts

@@ -4,7 +4,8 @@
  */
 export { ApprovedPackagesPolicy } from './api/ApprovedPackagesPolicy';
 export { RushConfiguration, ITryFindRushJsonLocationOptions } from './api/RushConfiguration';
-export { SubspaceConfiguration } from './api/SubspaceConfiguration';
+export { Subspace } from './api/Subspace';
+export { SubspacesConfiguration } from './api/SubspacesConfiguration';
 export { IPackageManagerOptionsJsonBase, IConfigurationEnvironment, IConfigurationEnvironmentVariable, PackageManagerOptionsConfigurationBase } from './logic/base/BasePackageManagerOptionsConfiguration';
 export { INpmOptionsJson as _INpmOptionsJson, NpmOptionsConfiguration } from './logic/npm/NpmOptionsConfiguration';
 export { IYarnOptionsJson as _IYarnOptionsJson, YarnOptionsConfiguration } from './logic/yarn/YarnOptionsConfiguration';
@@ -23,7 +24,7 @@ export { RushUserConfiguration } from './api/RushUserConfiguration';
 export { RushGlobalFolder as _RushGlobalFolder } from './api/RushGlobalFolder';
 export { ApprovedPackagesItem, ApprovedPackagesConfiguration } from './api/ApprovedPackagesConfiguration';
 export { CommonVersionsConfiguration } from './api/CommonVersionsConfiguration';
-export { PackageJsonEditor, PackageJsonDependency, DependencyType } from './api/PackageJsonEditor';
+export { PackageJsonEditor, PackageJsonDependency, DependencyType, PackageJsonDependencyMeta } from './api/PackageJsonEditor';
 export { RepoStateFile } from './logic/RepoStateFile';
 export { LookupByPath, IPrefixMatch } from './logic/LookupByPath';
 export { EventHooks, Event } from './api/EventHooks';

package/lib/logic/ChangeManager.d.ts

@@ -26,7 +26,7 @@ export declare class ChangeManager {
     loadAsync(changesPath: string, prereleaseToken?: PrereleaseToken, includeCommitDetails?: boolean): Promise<void>;
     hasChanges(): boolean;
     get packageChanges(): IChangeInfo[];
-    get allPackages(): Map<string, RushConfigurationProject>;
+    get allPackages(): ReadonlyMap<string, RushConfigurationProject>;
     validateChanges(versionConfig: VersionPolicyConfiguration): void;
     /**
      * Apply changes to package.json

package/lib/logic/ChangelogGenerator.d.ts

@@ -12,11 +12,11 @@ export declare class ChangelogGenerator {
     /**
      * Updates the appropriate changelogs with the given changes.
      */
-    static updateChangelogs(allChanges: IChangeRequests, allProjects: Map<string, RushConfigurationProject>, rushConfiguration: RushConfiguration, shouldCommit: boolean): IChangelog[];
+    static updateChangelogs(allChanges: IChangeRequests, allProjects: ReadonlyMap<string, RushConfigurationProject>, rushConfiguration: RushConfiguration, shouldCommit: boolean): IChangelog[];
     /**
      * Fully regenerate the markdown files based on the current json files.
      */
-    static regenerateChangelogs(allProjects: Map<string, RushConfigurationProject>, rushConfiguration: RushConfiguration): void;
+    static regenerateChangelogs(allProjects: ReadonlyMap<string, RushConfigurationProject>, rushConfiguration: RushConfiguration): void;
     /**
      * Updates an individual changelog for a single project.
      */

package/lib/logic/PublishUtilities.d.ts

@@ -15,7 +15,7 @@ export declare class PublishUtilities {
      * @param changesPath Path to the changes folder.
      * @returns Dictionary of all change requests, keyed by package name.
      */
-    static findChangeRequestsAsync(allPackages: Map<string, RushConfigurationProject>, rushConfiguration: RushConfiguration, changeFiles: ChangeFiles, includeCommitDetails?: boolean, prereleaseToken?: PrereleaseToken, projectsToExclude?: Set<string>): Promise<IChangeRequests>;
+    static findChangeRequestsAsync(allPackages: ReadonlyMap<string, RushConfigurationProject>, rushConfiguration: RushConfiguration, changeFiles: ChangeFiles, includeCommitDetails?: boolean, prereleaseToken?: PrereleaseToken, projectsToExclude?: Set<string>): Promise<IChangeRequests>;
     /**
      * Given the changes hash, flattens them into a sorted array based on their dependency order.
      * @params packageChanges - hash of change requests.
@@ -25,7 +25,7 @@ export declare class PublishUtilities {
     /**
      * Given a single change request, updates the package json file with updated versions on disk.
      */
-    static updatePackages(allChanges: IChangeRequests, allPackages: Map<string, RushConfigurationProject>, rushConfiguration: RushConfiguration, shouldCommit: boolean, prereleaseToken?: PrereleaseToken, projectsToExclude?: Set<string>): Map<string, IPackageJson>;
+    static updatePackages(allChanges: IChangeRequests, allPackages: ReadonlyMap<string, RushConfigurationProject>, rushConfiguration: RushConfiguration, shouldCommit: boolean, prereleaseToken?: PrereleaseToken, projectsToExclude?: Set<string>): Map<string, IPackageJson>;
     /**
      * Returns the generated tagname to use for a published commit, given package name and version.
      */

package/lib/logic/RepoStateFile.d.ts

@@ -1,4 +1,5 @@
 import type { RushConfiguration } from '../api/RushConfiguration';
+import type { Subspace } from '../api/Subspace';
 /**
  * This file is used to track the state of various Rush-related features. It is generated
  * and updated by Rush.
@@ -7,7 +8,6 @@ import type { RushConfiguration } from '../api/RushConfiguration';
  */
 export declare class RepoStateFile {
     private static _jsonSchema;
-    private _variant;
     private _pnpmShrinkwrapHash;
     private _preferredVersionsHash;
     private _isValid;
@@ -36,16 +36,18 @@ export declare class RepoStateFile {
      * @param jsonFilename - The path to the repo-state.json file.
      * @param variant - The variant currently being used by Rush.
      */
-    static loadFromFile(jsonFilename: string, variant: string | undefined): RepoStateFile;
+    static loadFromFile(jsonFilename: string): RepoStateFile;
     /**
      * Refresh the data contained in repo-state.json using the current state
      * of the Rush repo, and save the file if changes were made.
      *
      * @param rushConfiguration - The Rush configuration for the repo.
+     * @param subspace - The subspace that repo-state.json was loaded from,
+     * or `undefined` for the default subspace.
      *
      * @returns true if the file was modified, otherwise false.
      */
-    refreshState(rushConfiguration: RushConfiguration): boolean;
+    refreshState(rushConfiguration: RushConfiguration, subspace: Subspace | undefined): boolean;
     /**
      * Writes the "repo-state.json" file to disk, using the filename that was passed to loadFromFile().
      */

package/lib/logic/RushConstants.d.ts

@@ -75,6 +75,10 @@ export declare class RushConstants {
      * The filename (".pnpmfile.cjs") used to add custom configuration to PNPM (PNPM version 6.x and later).
      */
     static readonly pnpmfileV6Filename: string;
+    /**
+     * The filename ("global-pnpmfile.cjs") used to add custom configuration to subspaces
+     */
+    static readonly pnpmfileGlobalFilename: string;
     /**
      * The folder name used to store patch files for pnpm
      * Example: `C:\MyRepo\common\config\pnpm-patches`
@@ -149,6 +153,10 @@ export declare class RushConstants {
      * The subspaces.json configuration file name
      */
     static readonly subspacesConfigFilename: string;
+    /**
+     * The name of the default subspace if one isn't specified but subspaces is enabled.
+     */
+    static readonly defaultSubspaceName: string;
     /**
      * Build cache configuration file.
      */