@rushstack/rush-sdk 5.112.0 → 5.112.2

package/dist/rush-lib.d.ts

@@ -181,11 +181,19 @@ export declare class BuildCacheConfiguration {
 /**
  * Type of version bumps
  * @public
+ *
+ * @internalRemarks
+ * This is a copy of the semver ReleaseType enum, but with the `none` value added and
+ * the `premajor` and `prepatch` omitted.
+ * See {@link LockStepVersionPolicy._getReleaseType}.
+ *
+ * TODO: Consider supporting `premajor` and `prepatch` in the future.
  */
 export declare enum BumpType {
     'none' = 0,
     'prerelease' = 1,
     'patch' = 2,
+    'preminor' = 3,
     'minor' = 4,
     'major' = 5
 }
@@ -1989,6 +1997,7 @@ declare interface IRushConfigurationProjectJson {
     skipRushCheck?: boolean;
     publishFolder?: string;
     tags?: string[];
+    subspaceName?: string;
 }
 
 /**
@@ -3264,6 +3273,7 @@ export declare class RushConfiguration {
     private _projects;
     private _projectsByName;
     private _projectsByTag;
+    private _rushProjectsBySubspaceName;
     private _commonVersionsConfigurationsByVariant;
     /**
      * The name of the package manager being used to install dependencies
@@ -3372,6 +3382,11 @@ export declare class RushConfiguration {
      * 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;
     /**
      * The filename of the variant dependency data file.  By default this is
      * called 'current-variant.json' resides in the Rush common folder.
@@ -3610,6 +3625,25 @@ export declare class RushConfiguration {
      * shrinkwrap file name for a given active variant.
      */
     get committedShrinkwrapFilename(): 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.
+     * @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
+     */
+    subspaceShrinkwrapFilenames(subspaceName: string): 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
@@ -3632,6 +3666,14 @@ export declare class RushConfiguration {
      */
     get repositoryDefaultFullyQualifiedRemoteBranch(): string;
     get projects(): RushConfigurationProject[];
+    /**
+     * A list of all the available subspaces in this workspace.
+     * @beta
+     */
+    get subspaceNames(): Iterable<string>;
+    /**
+     * @beta
+     */
     get projectsByName(): Map<string, RushConfigurationProject>;
     /**
      * Obtains the mapping from custom tags to projects.
@@ -3661,6 +3703,12 @@ export declare class RushConfiguration {
      * @param variant - The name of the current variant in use by the active command.
      */
     getCommonVersionsFilePath(variant?: string | undefined): string;
+    /**
+     * Returns `true` if the subspaces feature is enabled and at least one subspaces is defined
+     * in the `subspaces.json` config file.
+     * @beta
+     */
+    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.
@@ -3838,6 +3886,18 @@ export declare class RushConfigurationProject {
      * @beta
      */
     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"`).
+     *
+     * @beta
+     */
+    readonly subspaceName: string | undefined;
     /** @internal */
     constructor(options: IRushConfigurationProjectOptions);
     /**
@@ -4049,6 +4109,10 @@ export declare class RushConstants {
      * The artifactory.json configuration file name.
      */
     static readonly artifactoryFilename: string;
+    /**
+     * The subspaces.json configuration file name
+     */
+    static readonly subspacesConfigFilename: string;
     /**
      * Build cache configuration file.
      */
@@ -4313,6 +4377,26 @@ export declare class RushUserConfiguration {
     static getRushUserFolderPath(): string;
 }
 
+/**
+ * This represents the subspace configurations for a repository, based on the "subspaces.json"
+ * configuration file.
+ * @beta
+ */
+export declare class SubspaceConfiguration {
+    private static _jsonSchema;
+    /**
+     * The absolute path to the "subspaces.json" configuration file that was loaded to construct this object.
+     */
+    readonly subspaceJsonFilePath: string;
+    /**
+     * A set of the available subspaces
+     */
+    readonly subspaceNames: Set<string>;
+    private constructor();
+    static tryLoadFromConfigurationFile(subspaceJsonFilePath: string): SubspaceConfiguration | undefined;
+    static tryLoadFromDefaultLocation(rushConfiguration: RushConfiguration): SubspaceConfiguration | undefined;
+}
+
 declare enum VersionFormatForCommit {
     wildcard = "wildcard",
     original = "original"

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.38.3"
+      "packageVersion": "7.38.5"
     }
   ]
 }

package/lib/api/RushConfiguration.d.ts

@@ -14,6 +14,7 @@ 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';
 /**
  * Part of IRushConfigurationJson.
  */
@@ -118,6 +119,15 @@ export interface IRushConfigurationJson {
 export interface ICurrentVariantJson {
     variant: string | JsonNull;
 }
+/**
+ * The filter parameters to search from all projects
+ */
+export interface IRushConfigurationProjectsFilter {
+    /**
+     * A string representation of the subspace to filter for
+     */
+    subspace: string;
+}
 /**
  * Options for `RushConfiguration.tryFindRushJsonLocation`.
  * @public
@@ -144,6 +154,7 @@ export declare class RushConfiguration {
     private _projects;
     private _projectsByName;
     private _projectsByTag;
+    private _rushProjectsBySubspaceName;
     private _commonVersionsConfigurationsByVariant;
     /**
      * The name of the package manager being used to install dependencies
@@ -252,6 +263,11 @@ export declare class RushConfiguration {
      * 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;
     /**
      * The filename of the variant dependency data file.  By default this is
      * called 'current-variant.json' resides in the Rush common folder.
@@ -490,6 +506,25 @@ export declare class RushConfiguration {
      * shrinkwrap file name for a given active variant.
      */
     get committedShrinkwrapFilename(): 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.
+     * @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
+     */
+    subspaceShrinkwrapFilenames(subspaceName: string): 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
@@ -512,6 +547,14 @@ export declare class RushConfiguration {
      */
     get repositoryDefaultFullyQualifiedRemoteBranch(): string;
     get projects(): RushConfigurationProject[];
+    /**
+     * A list of all the available subspaces in this workspace.
+     * @beta
+     */
+    get subspaceNames(): Iterable<string>;
+    /**
+     * @beta
+     */
     get projectsByName(): Map<string, RushConfigurationProject>;
     /**
      * Obtains the mapping from custom tags to projects.
@@ -541,6 +584,12 @@ export declare class RushConfiguration {
      * @param variant - The name of the current variant in use by the active command.
      */
     getCommonVersionsFilePath(variant?: string | undefined): string;
+    /**
+     * Returns `true` if the subspaces feature is enabled and at least one subspaces is defined
+     * in the `subspaces.json` config file.
+     * @beta
+     */
+    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.

package/lib/api/RushConfigurationProject.d.ts

@@ -16,6 +16,7 @@ export interface IRushConfigurationProjectJson {
     skipRushCheck?: boolean;
     publishFolder?: string;
     tags?: string[];
+    subspaceName?: string;
 }
 /**
  * @internal
@@ -151,6 +152,18 @@ export declare class RushConfigurationProject {
      * @beta
      */
     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"`).
+     *
+     * @beta
+     */
+    readonly subspaceName: string | undefined;
     /** @internal */
     constructor(options: IRushConfigurationProjectOptions);
     /**

package/lib/api/SubspaceConfiguration.d.ts

@@ -0,0 +1,26 @@
+import type { RushConfiguration } from './RushConfiguration';
+/**
+ * The allowed naming convention for subspace names.
+ * Allows for names to be formed of letters, numbers, and hyphens (-)
+ */
+export declare const SUBSPACE_NAME_REGEXP: RegExp;
+/**
+ * This represents the subspace configurations for a repository, based on the "subspaces.json"
+ * configuration file.
+ * @beta
+ */
+export declare class SubspaceConfiguration {
+    private static _jsonSchema;
+    /**
+     * The absolute path to the "subspaces.json" configuration file that was loaded to construct this object.
+     */
+    readonly subspaceJsonFilePath: string;
+    /**
+     * A set of the available subspaces
+     */
+    readonly subspaceNames: Set<string>;
+    private constructor();
+    static tryLoadFromConfigurationFile(subspaceJsonFilePath: string): SubspaceConfiguration | undefined;
+    static tryLoadFromDefaultLocation(rushConfiguration: RushConfiguration): SubspaceConfiguration | undefined;
+}
+//# sourceMappingURL=SubspaceConfiguration.d.ts.map

package/lib/api/SubspaceConfiguration.js

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

package/lib/api/VersionPolicy.d.ts

@@ -4,11 +4,19 @@ import type { RushConfiguration } from './RushConfiguration';
 /**
  * Type of version bumps
  * @public
+ *
+ * @internalRemarks
+ * This is a copy of the semver ReleaseType enum, but with the `none` value added and
+ * the `premajor` and `prepatch` omitted.
+ * See {@link LockStepVersionPolicy._getReleaseType}.
+ *
+ * TODO: Consider supporting `premajor` and `prepatch` in the future.
  */
 export declare enum BumpType {
     'none' = 0,
     'prerelease' = 1,
     'patch' = 2,
+    'preminor' = 3,
     'minor' = 4,
     'major' = 5
 }

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

@@ -3,6 +3,7 @@ import { BaseConfiglessRushAction } from './BaseRushAction';
 export declare class InitAction extends BaseConfiglessRushAction {
     private readonly _overwriteParameter;
     private readonly _rushExampleParameter;
+    private readonly _experimentsParameter;
     private _commentedBySectionName;
     constructor(parser: RushCommandLineParser);
     protected runAsync(): Promise<void>;

package/lib/index.d.ts

@@ -4,6 +4,7 @@
  */
 export { ApprovedPackagesPolicy } from './api/ApprovedPackagesPolicy';
 export { RushConfiguration, ITryFindRushJsonLocationOptions } from './api/RushConfiguration';
+export { SubspaceConfiguration } from './api/SubspaceConfiguration';
 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';

package/lib/logic/PublishUtilities.d.ts

@@ -43,7 +43,6 @@ export declare class PublishUtilities {
         [key: string]: string;
     }, dependencyName: string, newProjectVersion: string): string;
     private static _getReleaseType;
-    private static _getChangeTypeForSemverReleaseType;
     private static _getNewRangeDependency;
     private static _shouldSkipVersionBump;
     private static _updateCommitDetails;

package/lib/logic/RushConstants.d.ts

@@ -145,6 +145,10 @@ export declare class RushConstants {
      * The artifactory.json configuration file name.
      */
     static readonly artifactoryFilename: string;
+    /**
+     * The subspaces.json configuration file name
+     */
+    static readonly subspacesConfigFilename: string;
     /**
      * Build cache configuration file.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/rush-sdk",
-  "version": "5.112.0",
+  "version": "5.112.2",
   "description": "An API for interacting with the Rush engine",
   "repository": {
     "type": "git",
@@ -25,17 +25,17 @@
   "dependencies": {
     "@types/node-fetch": "2.6.2",
     "tapable": "2.2.1",
-    "@rushstack/node-core-library": "3.61.0"
+    "@rushstack/node-core-library": "3.62.0"
   },
   "devDependencies": {
     "@types/semver": "7.5.0",
     "@types/webpack-env": "1.18.0",
-    "@microsoft/rush-lib": "5.112.0",
+    "@microsoft/rush-lib": "5.112.2",
+    "@rushstack/heft": "0.63.4",
     "local-node-rig": "1.0.0",
-    "@rushstack/stream-collator": "4.1.13",
-    "@rushstack/heft": "0.63.2",
+    "@rushstack/terminal": "0.7.14",
     "@rushstack/ts-command-line": "4.17.1",
-    "@rushstack/terminal": "0.7.12"
+    "@rushstack/stream-collator": "4.1.15"
   },
   "scripts": {
     "build": "heft build --clean",