@rushstack/rush-sdk 5.122.0 → 5.123.0

package/dist/rush-lib.d.ts

@@ -907,6 +907,39 @@ export declare class FileSystemBuildCacheProvider {
     trySetCacheEntryBufferAsync(terminal: ITerminal, cacheId: string, entryBuffer: Buffer): Promise<string>;
 }
 
+/**
+ * A base class for flag file.
+ * @internal
+ */
+export declare class _FlagFile<T extends object = JsonObject> {
+    /**
+     * Flag file path
+     */
+    readonly path: string;
+    /**
+     * Content of the flag
+     */
+    protected _state: T | {};
+    /**
+     * 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?: T);
+    /**
+     * Returns true if the file exists and the contents match the current state.
+     */
+    isValidAsync(): Promise<boolean>;
+    /**
+     * Writes the flag file to disk with the current state
+     */
+    createAsync(): Promise<void>;
+    /**
+     * Removes the flag file
+     */
+    clearAsync(): Promise<void>;
+}
+
 /**
  * Calculates the cache entry id string for an operation.
  * @beta
@@ -1497,14 +1530,6 @@ declare interface ILocalBuildCacheJson extends IBaseBuildCacheJson {
     readonly cacheProvider: 'local-only';
 }
 
-/**
- * @internal
- */
-export declare interface _ILockfileValidityCheckOptions {
-    statePropertiesToIgnore?: string[];
-    rushVerb?: string;
-}
-
 declare interface ILockStepVersionJson extends IVersionPolicyJson {
     version: string;
     nextBump?: string;
@@ -1795,6 +1820,11 @@ export declare interface IOperationSettings {
      * calculating final hash value when reading and writing the build cache
      */
     dependsOnAdditionalFiles?: string[];
+    /**
+     * How many concurrency units this operation should take up during execution. The maximum concurrent units is
+     *  determined by the -p flag.
+     */
+    weight?: number;
 }
 
 /**
@@ -2442,53 +2472,6 @@ export declare interface _IYarnOptionsJson extends IPackageManagerOptionsJsonBas
     ignoreEngines?: boolean;
 }
 
-/**
- * A helper class for managing last-install flags, which are persistent and
- * indicate that something installed in the folder was successfully completed.
- * It also compares state, so that if something like the Node.js version has changed,
- * it can invalidate the last install.
- * @internal
- */
-export declare class _LastInstallFlag {
-    private _state;
-    /**
-     * Returns the full path to the flag file
-     */
-    readonly path: string;
-    /**
-     * Creates a new LastInstall flag
-     * @param folderPath - the folder that this flag is managing
-     * @param state - optional, the state that should be managed or compared
-     */
-    constructor(folderPath: string, state?: JsonObject);
-    /**
-     * Returns true if the file exists and the contents match the current state.
-     */
-    isValid(options?: _ILockfileValidityCheckOptions): 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.
-     *
-     * @internal
-     */
-    checkValidAndReportStoreIssues(options: _ILockfileValidityCheckOptions & {
-        rushVerb: string;
-    }): boolean;
-    private _isValid;
-    /**
-     * Writes the flag file to disk with the current state
-     */
-    create(): void;
-    /**
-     * Removes the flag file
-     */
-    clear(): void;
-    /**
-     * Returns the name of the flag file
-     */
-    protected get flagName(): string;
-}
-
 /**
  * This policy indicates all related projects should use the same version.
  * @public
@@ -4369,6 +4352,10 @@ export declare class RushConstants {
      * The filename ("project-impact-graph.yaml") for the project impact graph file.
      */
     static readonly projectImpactGraphFilename: 'project-impact-graph.yaml';
+    /**
+     * The filename for the last link flag
+     */
+    static readonly lastLinkFlagFilename: 'last-link';
 }
 
 /**
@@ -4619,6 +4606,13 @@ export declare class Subspace {
      * @beta
      */
     getCommonVersionsFilePath(): string;
+    /**
+     * Gets the path to the pnpm-config.json config file for this subspace.
+     *
+     * Example: `C:\MyRepo\common\subspaces\my-subspace\pnpm-config.json`
+     * @beta
+     */
+    getPnpmConfigFilePath(): string;
     /**
      * Gets the settings from the common-versions.json config file.
      * @beta

package/dist/tsdoc-metadata.json

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

package/lib/api/FlagFile.d.ts

@@ -0,0 +1,34 @@
+import { type JsonObject } from '@rushstack/node-core-library';
+/**
+ * A base class for flag file.
+ * @internal
+ */
+export declare class FlagFile<T extends object = JsonObject> {
+    /**
+     * Flag file path
+     */
+    readonly path: string;
+    /**
+     * Content of the flag
+     */
+    protected _state: T | {};
+    /**
+     * 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?: T);
+    /**
+     * Returns true if the file exists and the contents match the current state.
+     */
+    isValidAsync(): Promise<boolean>;
+    /**
+     * Writes the flag file to disk with the current state
+     */
+    createAsync(): Promise<void>;
+    /**
+     * Removes the flag file
+     */
+    clearAsync(): Promise<void>;
+}
+//# sourceMappingURL=FlagFile.d.ts.map

package/lib/api/{LastLinkFlag.js → FlagFile.js}

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

package/lib/api/LastInstallFlag.d.ts

@@ -1,12 +1,56 @@
-import { type JsonObject } from '@rushstack/node-core-library';
+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;
 /**
- * @internal
+ * This represents the JSON data structure for the "last-install.flag" file.
  */
-export interface ILockfileValidityCheckOptions {
-    statePropertiesToIgnore?: string[];
+export interface ILastInstallFlagJson {
+    /**
+     * Current node version
+     */
+    node?: string;
+    /**
+     * Current package manager name
+     */
+    packageManager?: PackageManagerName;
+    /**
+     * Current package manager version
+     */
+    packageManagerVersion: string;
+    /**
+     * Current rush json folder
+     */
+    rushJsonFolder: string;
+    /**
+     * The content of package.json, used in the flag file of autoinstaller
+     */
+    packageJson?: IPackageJson;
+    /**
+     * Same with pnpmOptions.pnpmStorePath in rush.json
+     */
+    storePath?: string;
+    /**
+     * An experimental flag used by cleanInstallAfterNpmrcChanges
+     */
+    npmrcHash?: string;
+    /**
+     * True when "useWorkspaces" is true in rush.json
+     */
+    workspaces?: boolean;
+    /**
+     * True when user explicitly specify "--ignore-scripts" CLI parameter or deferredInstallationScripts
+     */
+    ignoreScripts?: boolean;
+    /**
+     * When specified, it is a list of selected projects during partial install
+     * It is undefined when full install
+     */
+    selectedProjectNames?: string[];
+}
+interface ILockfileValidityCheckOptions {
+    statePropertiesToIgnore?: (keyof ILastInstallFlagJson)[];
     rushVerb?: string;
 }
 /**
@@ -14,7 +58,6 @@ export interface ILockfileValidityCheckOptions {
  * indicate that something installed in the folder was successfully completed.
  * It also compares state, so that if something like the Node.js version has changed,
  * it can invalidate the last install.
- * @internal
  */
 export declare class LastInstallFlag {
     private _state;
@@ -27,29 +70,33 @@ export declare class LastInstallFlag {
      * @param folderPath - the folder that this flag is managing
      * @param state - optional, the state that should be managed or compared
      */
-    constructor(folderPath: string, state?: JsonObject);
+    constructor(folderPath: string, state?: Partial<ILastInstallFlagJson>);
     /**
      * Returns true if the file exists and the contents match the current state.
      */
-    isValid(options?: ILockfileValidityCheckOptions): boolean;
+    isValidAsync(options?: ILockfileValidityCheckOptions): 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.
      *
      * @internal
      */
-    checkValidAndReportStoreIssues(options: ILockfileValidityCheckOptions & {
+    checkValidAndReportStoreIssuesAsync(options: ILockfileValidityCheckOptions & {
         rushVerb: string;
-    }): boolean;
-    private _isValid;
+    }): Promise<boolean>;
+    private _isValidAsync;
     /**
      * Writes the flag file to disk with the current state
      */
-    create(): void;
+    createAsync(): Promise<void>;
+    /**
+     * Merge new data into current state by "merge"
+     */
+    mergeFromObject(data: JsonObject): void;
     /**
      * Removes the flag file
      */
-    clear(): void;
+    clearAsync(): Promise<void>;
     /**
      * Returns the name of the flag file
      */
@@ -71,4 +118,5 @@ export declare class LastInstallFlagFactory {
      */
     static getCommonTempFlag(rushConfiguration: RushConfiguration, subspace: Subspace, extraState?: Record<string, string>): LastInstallFlag;
 }
+export {};
 //# sourceMappingURL=LastInstallFlag.d.ts.map

package/lib/api/RushProjectConfiguration.d.ts

@@ -73,6 +73,11 @@ export interface IOperationSettings {
      * calculating final hash value when reading and writing the build cache
      */
     dependsOnAdditionalFiles?: string[];
+    /**
+     * How many concurrency units this operation should take up during execution. The maximum concurrent units is
+     *  determined by the -p flag.
+     */
+    weight?: number;
 }
 /**
  * Use this class to load the "config/rush-project.json" config file.

package/lib/api/Subspace.d.ts

@@ -81,6 +81,13 @@ export declare class Subspace {
      * @beta
      */
     getCommonVersionsFilePath(): string;
+    /**
+     * Gets the path to the pnpm-config.json config file for this subspace.
+     *
+     * Example: `C:\MyRepo\common\subspaces\my-subspace\pnpm-config.json`
+     * @beta
+     */
+    getPnpmConfigFilePath(): string;
     /**
      * Gets the settings from the common-versions.json config file.
      * @beta

package/lib/index.d.ts

@@ -29,7 +29,7 @@ export { RepoStateFile } from './logic/RepoStateFile';
 export { LookupByPath, IPrefixMatch } from './logic/LookupByPath';
 export { EventHooks, Event } from './api/EventHooks';
 export { ChangeManager } from './api/ChangeManager';
-export { LastInstallFlag as _LastInstallFlag, ILockfileValidityCheckOptions as _ILockfileValidityCheckOptions } from './api/LastInstallFlag';
+export { FlagFile as _FlagFile } from './api/FlagFile';
 export { VersionPolicyDefinitionName, BumpType, LockStepVersionPolicy, IndividualVersionPolicy, VersionPolicy } from './api/VersionPolicy';
 export { VersionPolicyConfiguration } from './api/VersionPolicyConfiguration';
 export { ILaunchOptions, Rush } from './api/Rush';

package/lib/logic/RushConstants.d.ts

@@ -256,5 +256,9 @@ export declare class RushConstants {
      * The filename ("project-impact-graph.yaml") for the project impact graph file.
      */
     static readonly projectImpactGraphFilename: 'project-impact-graph.yaml';
+    /**
+     * The filename for the last link flag
+     */
+    static readonly lastLinkFlagFilename: 'last-link';
 }
 //# sourceMappingURL=RushConstants.d.ts.map

package/lib/logic/UnlinkManager.d.ts

@@ -11,7 +11,7 @@ export declare class UnlinkManager {
      *
      * Returns true if anything was deleted.
      */
-    unlink(force?: boolean): boolean;
+    unlinkAsync(force?: boolean): Promise<boolean>;
     /**
      * Delete:
      *  - all the node_modules symlinks of configured Rush projects

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

@@ -1,5 +1,6 @@
 import type { ITerminal } from '@rushstack/terminal';
 import type { Subspace } from '../../api/Subspace';
+import type { RushConfigurationProject } from '../../api/RushConfigurationProject';
 export interface IInstallManagerOptions {
     /**
      * Whether the global "--debug" flag was specified.
@@ -67,7 +68,7 @@ export interface IInstallManagerOptions {
      * Filters to be passed to PNPM during installation, if applicable.
      * These restrict the scope of a workspace installation.
      */
-    pnpmFilterArguments: string[];
+    filteredProjects: RushConfigurationProject[];
     /**
      * Callback to invoke between preparing the common/temp folder and running installation.
      */

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

@@ -21,7 +21,7 @@ export declare abstract class BaseShrinkwrapFile {
      *
      * @virtual
      */
-    validateShrinkwrapAfterUpdate(rushConfiguration: RushConfiguration, terminal: ITerminal): void;
+    validateShrinkwrapAfterUpdate(rushConfiguration: RushConfiguration, subspace: Subspace, terminal: ITerminal): void;
     /**
      * Validate the shrinkwrap using the provided policy options.
      *

package/lib/logic/operations/AsyncOperationQueue.d.ts

@@ -8,7 +8,10 @@ import type { OperationExecutionRecord } from './OperationExecutionRecord';
  * NOTE: the caller must wait for some time to avoid busy loop and burn CPU cycles.
  */
 export declare const UNASSIGNED_OPERATION: 'UNASSIGNED_OPERATION';
-export type IOperationIteratorResult = OperationExecutionRecord | typeof UNASSIGNED_OPERATION;
+export type IOperationIteratorResult = OperationExecutionRecord | {
+    weight: 0;
+    status: typeof UNASSIGNED_OPERATION;
+};
 /**
  * Implementation of the async iteration protocol for a collection of IOperation objects.
  * The async iterator will wait for an operation to be ready for execution, or terminate if there are no more operations.

package/lib/logic/operations/WeightedOperationPlugin.d.ts

@@ -0,0 +1,10 @@
+import type { IPhasedCommandPlugin, PhasedCommandHooks } from '../../pluginFramework/PhasedCommandHooks';
+/**
+ * Add weights to operations based on the operation settings in rush-project.json.
+ *
+ * This also sets the weight of no-op operations to 0.
+ */
+export declare class WeightedOperationPlugin implements IPhasedCommandPlugin {
+    apply(hooks: PhasedCommandHooks): void;
+}
+//# sourceMappingURL=WeightedOperationPlugin.d.ts.map

package/lib/logic/operations/WeightedOperationPlugin.js

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

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

@@ -140,7 +140,7 @@ export declare class PnpmShrinkwrapFile extends BaseShrinkwrapFile {
      */
     private _disallowInsecureSha1;
     /** @override */
-    validateShrinkwrapAfterUpdate(rushConfiguration: RushConfiguration, terminal: ITerminal): void;
+    validateShrinkwrapAfterUpdate(rushConfiguration: RushConfiguration, subspace: Subspace, terminal: ITerminal): void;
     /** @override */
     validate(packageManagerOptionsConfig: PackageManagerOptionsConfigurationBase, policyOptions: IShrinkwrapFilePolicyValidatorOptions, experimentsConfig?: IExperimentsJson): void;
     /**

package/lib/utilities/objectUtilities.d.ts

@@ -4,4 +4,9 @@
 export declare function objectsAreDeepEqual<TObject>(a: TObject, b: TObject): boolean;
 export declare function cloneDeep<TObject>(obj: TObject): TObject;
 export declare function merge<TBase extends object, TOther>(base: TBase, other: TOther): (TBase & TOther) | TOther;
+/**
+ * Performs a partial deep comparison between `obj` and `source` to
+ * determine if `obj` contains equivalent property values.
+ */
+export declare function isMatch<TObject>(obj: TObject, source: TObject): boolean;
 //# sourceMappingURL=objectUtilities.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/rush-sdk",
-  "version": "5.122.0",
+  "version": "5.123.0",
   "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/terminal": "0.10.1",
-    "@rushstack/node-core-library": "4.1.0"
+    "@rushstack/node-core-library": "4.2.0",
+    "@rushstack/terminal": "0.10.2"
   },
   "devDependencies": {
     "@types/semver": "7.5.0",
     "@types/webpack-env": "1.18.0",
-    "@rushstack/heft": "0.66.3",
-    "@microsoft/rush-lib": "5.122.0",
+    "@microsoft/rush-lib": "5.123.0",
+    "@rushstack/stream-collator": "4.1.42",
+    "@rushstack/heft": "0.66.4",
     "local-node-rig": "1.0.0",
-    "@rushstack/stream-collator": "4.1.41",
-    "@rushstack/ts-command-line": "4.19.2"
+    "@rushstack/ts-command-line": "4.19.3"
   },
   "scripts": {
     "build": "heft build --clean",

package/lib/api/LastLinkFlag.d.ts

@@ -1,41 +0,0 @@
-import { LastInstallFlag } from './LastInstallFlag';
-import type { Subspace } from './Subspace';
-export declare const LAST_LINK_FLAG_FILE_NAME: string;
-/**
- * A helper class for managing the last-link flag, which is persistent and
- * indicates that linking was completed successfully.
- * @internal
- */
-export declare class LastLinkFlag extends LastInstallFlag {
-    /**
-     * @override
-     */
-    isValid(): boolean;
-    /**
-     * @override
-     */
-    checkValidAndReportStoreIssues(): boolean;
-    /**
-     * Returns the name of the flag file
-     *
-     * @override
-     */
-    protected get flagName(): string;
-}
-/**
- * A helper class for LastLinkFlag
- *
- * @internal
- */
-export declare class LastLinkFlagFactory {
-    /**
-     * Gets the LastLink flag and sets the current state. This state is used to compare
-     * against the last-known-good state tracked by the LastLink flag.
-     * @param rushConfiguration - the configuration of the Rush repo to get the install
-     * state from
-     *
-     * @internal
-     */
-    static getCommonTempFlag(subspace: Subspace): LastLinkFlag;
-}
-//# sourceMappingURL=LastLinkFlag.d.ts.map