@rushstack/rush-sdk 5.124.1 → 5.124.3

package/dist/rush-lib.d.ts

@@ -911,7 +911,7 @@ export declare class FileSystemBuildCacheProvider {
  * A base class for flag file.
  * @internal
  */
-export declare class _FlagFile {
+export declare class _FlagFile<TState extends JsonObject = JsonObject> {
     /**
      * Flag file path
      */
@@ -919,13 +919,13 @@ export declare class _FlagFile {
     /**
      * Content of the flag
      */
-    private _state;
+    protected _state: TState;
     /**
      * Creates a new flag file
      * @param folderPath - the folder that this flag is managing
      * @param state - optional, the state that should be managed or compared
      */
-    constructor(folderPath: string, flagName: string, initialState?: JsonObject);
+    constructor(folderPath: string, flagName: string, initialState: TState);
     /**
      * Returns true if the file exists and the contents match the current state.
      */
@@ -3840,7 +3840,7 @@ export declare class RushConfiguration {
      * Returns the set of subspaces that the given projects belong to
      * @beta
      */
-    getSubspacesForProjects(projects: ReadonlySet<RushConfigurationProject>): ReadonlySet<Subspace>;
+    getSubspacesForProjects(projects: Iterable<RushConfigurationProject>): ReadonlySet<Subspace>;
     /**
      * @beta
      */

package/dist/tsdoc-metadata.json

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

package/lib/api/FlagFile.d.ts

@@ -3,7 +3,7 @@ import { type JsonObject } from '@rushstack/node-core-library';
  * A base class for flag file.
  * @internal
  */
-export declare class FlagFile {
+export declare class FlagFile<TState extends JsonObject = JsonObject> {
     /**
      * Flag file path
      */
@@ -11,13 +11,13 @@ export declare class FlagFile {
     /**
      * Content of the flag
      */
-    private _state;
+    protected _state: TState;
     /**
      * Creates a new flag file
      * @param folderPath - the folder that this flag is managing
      * @param state - optional, the state that should be managed or compared
      */
-    constructor(folderPath: string, flagName: string, initialState?: JsonObject);
+    constructor(folderPath: string, flagName: string, initialState: TState);
     /**
      * Returns true if the file exists and the contents match the current state.
      */

package/lib/api/LastInstallFlag.d.ts

@@ -2,7 +2,7 @@ import { type JsonObject, type IPackageJson } from '@rushstack/node-core-library
 import type { PackageManagerName } from './packageManager/PackageManager';
 import type { RushConfiguration } from './RushConfiguration';
 import type { Subspace } from './Subspace';
-export declare const LAST_INSTALL_FLAG_FILE_NAME: string;
+import { FlagFile } from './FlagFile';
 /**
  * This represents the JSON data structure for the "last-install.flag" file.
  */
@@ -63,12 +63,7 @@ interface ILockfileValidityCheckOptions {
  * It also compares state, so that if something like the Node.js version has changed,
  * it can invalidate the last install.
  */
-export declare class LastInstallFlag {
-    private _state;
-    /**
-     * Returns the full path to the flag file
-     */
-    readonly path: string;
+export declare class LastInstallFlag extends FlagFile<Partial<ILastInstallFlagJson>> {
     /**
      * Creates a new LastInstall flag
      * @param folderPath - the folder that this flag is managing
@@ -78,7 +73,7 @@ export declare class LastInstallFlag {
     /**
      * Returns true if the file exists and the contents match the current state.
      */
-    isValidAsync(options?: ILockfileValidityCheckOptions): Promise<boolean>;
+    isValidAsync(): Promise<boolean>;
     /**
      * Same as isValid(), but with an additional check:  If the current state is not equal to the previous
      * state, and an the current state causes an error, then throw an exception with a friendly message.
@@ -89,38 +84,19 @@ export declare class LastInstallFlag {
         rushVerb: string;
     }): Promise<boolean>;
     private _isValidAsync;
-    /**
-     * Writes the flag file to disk with the current state
-     */
-    createAsync(): Promise<void>;
     /**
      * Merge new data into current state by "merge"
      */
     mergeFromObject(data: JsonObject): void;
-    /**
-     * Removes the flag file
-     */
-    clearAsync(): Promise<void>;
-    /**
-     * Returns the name of the flag file
-     */
-    protected get flagName(): string;
 }
 /**
- * A helper class for LastInstallFlag
+ * Gets the LastInstall flag and sets the current state. This state is used to compare
+ * against the last-known-good state tracked by the LastInstall flag.
+ * @param rushConfiguration - the configuration of the Rush repo to get the install
+ * state from
  *
  * @internal
  */
-export declare class LastInstallFlagFactory {
-    /**
-     * Gets the LastInstall flag and sets the current state. This state is used to compare
-     * against the last-known-good state tracked by the LastInstall flag.
-     * @param rushConfiguration - the configuration of the Rush repo to get the install
-     * state from
-     *
-     * @internal
-     */
-    static getCommonTempFlag(rushConfiguration: RushConfiguration, subspace: Subspace, extraState?: Record<string, string>): LastInstallFlag;
-}
+export declare function getCommonTempFlag(rushConfiguration: RushConfiguration, subspace: Subspace, extraState?: Record<string, string>): LastInstallFlag;
 export {};
 //# sourceMappingURL=LastInstallFlag.d.ts.map

package/lib/api/RushConfiguration.d.ts

@@ -532,7 +532,7 @@ export declare class RushConfiguration {
      * Returns the set of subspaces that the given projects belong to
      * @beta
      */
-    getSubspacesForProjects(projects: ReadonlySet<RushConfigurationProject>): ReadonlySet<Subspace>;
+    getSubspacesForProjects(projects: Iterable<RushConfigurationProject>): ReadonlySet<Subspace>;
     /**
      * @beta
      */

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

@@ -9,7 +9,6 @@ export declare class DeployAction extends BaseRushAction {
     private readonly _createArchivePath;
     private readonly _createArchiveOnly;
     constructor(parser: RushCommandLineParser);
-    private _getDependencyProjects;
     protected runAsync(): Promise<void>;
 }
 //# sourceMappingURL=DeployAction.d.ts.map

package/lib/cli/parsing/SelectionParameterSet.d.ts

@@ -31,11 +31,16 @@ export declare class SelectionParameterSet {
      * Represents the selection as `--filter` parameters to pnpm.
      *
      * @remarks
-     * This is a separate from the selection to allow the filters to be represented more concisely.
      *
-     * @see https://pnpm.js.org/en/filtering
+     * IMPORTANT: This function produces PNPM CLI operators that select projects from PNPM's temp workspace.
+     * If Rush subspaces are enabled, PNPM cannot see the complete Rush workspace, and therefore these operators
+     * would malfunction. In the current implementation, we calculate them anyway, then `BaseInstallAction.runAsync()`
+     * will overwrite `pnpmFilterArgumentValues` with a flat list of project names.  In the future, these
+     * two code paths will be combined into a single general solution.
+     *
+     * @see https://pnpm.io/filtering
      */
-    getPnpmFilterArgumentsAsync(terminal: ITerminal): Promise<string[]>;
+    getPnpmFilterArgumentValuesAsync(terminal: ITerminal): Promise<string[]>;
     /**
      * Usage telemetry for selection parameters. Only saved locally, and if requested in the config.
      */

package/lib/logic/base/BaseInstallManagerTypes.d.ts

@@ -65,10 +65,21 @@ export interface IInstallManagerOptions {
      */
     maxInstallAttempts: number;
     /**
-     * Filters to be passed to PNPM during installation, if applicable.
-     * These restrict the scope of a workspace installation.
+     * An array of `--filter` argument values. For example, if the array is ["a", "b"] then Rush would invoke
+     * `pnpm install --filter a --filter b` which restricts the install/update to dependencies of
+     * workspace projects "a" and "b". If the array is empty, then an unfiltered install
+     * is performed. Filtered installs have some limitations such as less comprehensive version analysis.
+     *
+     * @remarks
+     * Note that PNPM may arbitrarily ignore `--filter` (producing an unfiltered install) in certain situations,
+     * for example when `config.dedupe-peer-dependents=true` with PNPM 8.  Rush tries to circumvent this, under the
+     * assumption that a user who invokes a filtered install cares more about lockfile stability than duplication.
+     */
+    pnpmFilterArgumentValues: string[];
+    /**
+     * The set of projects for which installation should be performed.
      */
-    filteredProjects: RushConfigurationProject[];
+    selectedProjects: Set<RushConfigurationProject>;
     /**
      * Callback to invoke between preparing the common/temp folder and running installation.
      */

package/lib/logic/pnpm/PnpmfileShim.d.ts

@@ -1,3 +1,4 @@
 import type { IPnpmfileHooks } from './IPnpmfile';
+export declare function reset(): void;
 export declare const hooks: IPnpmfileHooks;
 //# sourceMappingURL=PnpmfileShim.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/rush-sdk",
-  "version": "5.124.1",
+  "version": "5.124.3",
   "description": "An API for interacting with the Rush engine",
   "repository": {
     "type": "git",
@@ -31,8 +31,8 @@
   "devDependencies": {
     "@types/semver": "7.5.0",
     "@types/webpack-env": "1.18.0",
+    "@microsoft/rush-lib": "5.124.3",
     "@rushstack/heft": "0.66.6",
-    "@microsoft/rush-lib": "5.124.1",
     "local-node-rig": "1.0.0",
     "@rushstack/ts-command-line": "4.19.5",
     "@rushstack/stream-collator": "4.1.44"