@rushstack/rush-sdk 5.162.0 → 5.164.0

package/dist/rush-lib.d.ts

@@ -12,7 +12,10 @@ import { AsyncSeriesWaterfallHook } from 'tapable';
 import type { CollatedWriter } from '@rushstack/stream-collator';
 import type { CommandLineParameter } from '@rushstack/ts-command-line';
 import { CommandLineParameterKind } from '@rushstack/ts-command-line';
+import { CredentialCache } from '@rushstack/credential-cache';
 import { HookMap } from 'tapable';
+import { ICredentialCacheEntry } from '@rushstack/credential-cache';
+import { ICredentialCacheOptions } from '@rushstack/credential-cache';
 import { IFileDiffStatus } from '@rushstack/package-deps-hash';
 import { IPackageJson } from '@rushstack/node-core-library';
 import { IPrefixMatch } from '@rushstack/lookup-by-path';
@@ -373,27 +376,7 @@ export declare class CommonVersionsConfiguration {
     private _serialize;
 }
 
-/**
- * @beta
- */
-export declare class CredentialCache {
-    private readonly _cacheFilePath;
-    private readonly _cacheEntries;
-    private _modified;
-    private _disposed;
-    private _supportsEditing;
-    private readonly _lockfile;
-    private constructor();
-    static initializeAsync(options: ICredentialCacheOptions): Promise<CredentialCache>;
-    static usingAsync(options: ICredentialCacheOptions, doActionAsync: (credentialCache: CredentialCache) => Promise<void> | void): Promise<void>;
-    setCacheEntry(cacheId: string, entry: ICredentialCacheEntry): void;
-    tryGetCacheEntry(cacheId: string): ICredentialCacheEntry | undefined;
-    deleteCacheEntry(cacheId: string): void;
-    trimExpiredEntries(): void;
-    saveIfModifiedAsync(): Promise<void>;
-    dispose(): void;
-    private _validate;
-}
+export { CredentialCache }
 
 /**
  * An identifier representing a Rush message that can be customized by
@@ -1309,25 +1292,9 @@ export declare interface ICreateOperationsContext {
     readonly invalidateOperation?: ((operation: Operation, reason: string) => void) | undefined;
 }
 
-/**
- * @beta
- */
-export declare interface ICredentialCacheEntry {
-    expires?: Date;
-    credential: string;
-    credentialMetadata?: object;
-}
+export { ICredentialCacheEntry }
 
-/**
- * @beta
- */
-export declare interface ICredentialCacheOptions {
-    supportEditing: boolean;
-    /**
-     * If specified, use the specified path instead of the default path of `~/.rush-user/credentials.json`
-     */
-    cacheFilePath?: string;
-}
+export { ICredentialCacheOptions }
 
 /**
  * This represents the JSON data structure for the "current-variant.json" data file.
@@ -2102,6 +2069,13 @@ export declare interface IOperationSettings {
      * If true, this operation will never be skipped by the `--changed-projects-only` flag.
      */
     ignoreChangedProjectsOnlyFlag?: boolean;
+    /**
+     * An optional list of custom command-line parameter names (their `parameterLongName` values from
+     * command-line.json) that should be ignored when invoking the command for this operation.
+     * This allows a project to opt out of parameters that don't affect its operation, preventing
+     * unnecessary cache invalidation for this operation and its consumers.
+     */
+    parameterNamesToIgnore?: string[];
 }
 
 /**
@@ -2303,6 +2277,10 @@ export declare interface _IPnpmOptionsJson extends IPackageManagerOptionsJsonBas
      * {@inheritDoc PnpmOptionsConfiguration.pnpmLockfilePolicies}
      */
     pnpmLockfilePolicies?: IPnpmLockfilePolicies;
+    /**
+     * {@inheritDoc PnpmOptionsConfiguration.globalCatalogs}
+     */
+    globalCatalogs?: Record<string, Record<string, string>>;
 }
 
 /**
@@ -3569,6 +3547,15 @@ export declare class PnpmOptionsConfiguration extends PackageManagerOptionsConfi
      * The default value is false.
      */
     readonly alwaysFullInstall: boolean | undefined;
+    /**
+     * The `globalCatalogs` setting provides named catalogs for organizing dependency versions.
+     * Each catalog can be referenced using the `catalog:catalogName` protocol in package.json files
+     * (e.g., `catalog:react18`). The settings are written to the `catalogs` field of the
+     * `pnpm-workspace.yaml` file that is generated by Rush during installation.
+     *
+     * PNPM documentation: https://pnpm.io/catalogs
+     */
+    readonly globalCatalogs: Record<string, Record<string, string>> | undefined;
     /**
      * (GENERATED BY RUSH-PNPM PATCH-COMMIT) When modifying this property, make sure you know what you are doing.
      *
@@ -3650,6 +3637,7 @@ export declare class RepoStateFile {
     private _pnpmShrinkwrapHash;
     private _preferredVersionsHash;
     private _packageJsonInjectedDependenciesHash;
+    private _pnpmCatalogsHash;
     private _isValid;
     private _modified;
     /**
@@ -3669,6 +3657,10 @@ export declare class RepoStateFile {
      * The hash of all preferred versions at the end of the last update.
      */
     get packageJsonInjectedDependenciesHash(): string | undefined;
+    /**
+     * The hash of the PNPM catalog definitions at the end of the last update.
+     */
+    get pnpmCatalogsHash(): string | undefined;
     /**
      * If false, the repo-state.json file is not valid and its values cannot be relied upon
      */
@@ -5125,6 +5117,11 @@ export declare class Subspace {
     contains(project: RushConfigurationProject): boolean;
     /** @internal */
     _addProject(project: RushConfigurationProject): void;
+    /**
+     * Computes a hash of the PNPM catalog definitions for this subspace.
+     * Returns undefined if no catalogs are defined.
+     */
+    getPnpmCatalogsHash(): string | undefined;
     /**
      * Returns hash value of injected dependencies in related package.json.
      * @beta

package/dist/tsdoc-metadata.json

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

package/lib/api/RushProjectConfiguration.d.ts

@@ -117,6 +117,13 @@ export interface IOperationSettings {
      * If true, this operation will never be skipped by the `--changed-projects-only` flag.
      */
     ignoreChangedProjectsOnlyFlag?: boolean;
+    /**
+     * An optional list of custom command-line parameter names (their `parameterLongName` values from
+     * command-line.json) that should be ignored when invoking the command for this operation.
+     * This allows a project to opt out of parameters that don't affect its operation, preventing
+     * unnecessary cache invalidation for this operation and its consumers.
+     */
+    parameterNamesToIgnore?: string[];
 }
 /**
  * Use this class to load the "config/rush-project.json" config file.

package/lib/api/Subspace.d.ts

@@ -168,6 +168,11 @@ export declare class Subspace {
     contains(project: RushConfigurationProject): boolean;
     /** @internal */
     _addProject(project: RushConfigurationProject): void;
+    /**
+     * Computes a hash of the PNPM catalog definitions for this subspace.
+     * Returns undefined if no catalogs are defined.
+     */
+    getPnpmCatalogsHash(): string | undefined;
     /**
      * Returns hash value of injected dependencies in related package.json.
      * @beta

package/lib/cli/RushCommandLineParser.d.ts

@@ -27,6 +27,10 @@ export declare class RushCommandLineParser extends CommandLineParser {
     private readonly _terminalProvider;
     private readonly _terminal;
     private readonly _autocreateBuildCommand;
+    /**
+     * The current working directory that was used to find the Rush configuration.
+     */
+    get cwd(): string;
     constructor(options?: Partial<IRushCommandLineParserOptions>);
     get isDebug(): boolean;
     get isQuiet(): boolean;

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

@@ -34,6 +34,10 @@ export interface IJsonEntry {
      * @see {@link ../../api/RushConfigurationProject#RushConfigurationProject.tags | RushConfigurationProject.tags}
      */
     tags: string[];
+    /**
+     * @see {@link ../../api/Subspace#Subspace.subspaceName | Subspace.subspaceName}
+     */
+    subspaceName: string | undefined;
 }
 export interface IJsonOutput {
     projects: IJsonEntry[];

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

@@ -7,6 +7,11 @@ export declare const SUBSPACE_LONG_ARG_NAME: '--subspace';
 interface ISelectionParameterSetOptions {
     gitOptions: IGitSelectorParserOptions;
     includeSubspaceSelector: boolean;
+    /**
+     * The working directory used to resolve relative paths.
+     * This should be the same directory that was used to find the Rush configuration.
+     */
+    cwd: string;
 }
 /**
  * This class is provides the set of command line parameters used to select projects

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

@@ -0,0 +1,12 @@
+import type { CommandLineParameter } from '@rushstack/ts-command-line';
+import type { IParameterJson, IPhase } from '../../api/CommandLineConfiguration';
+/**
+ * Associates command line parameters with their associated phases.
+ * This helper is used to populate the `associatedParameters` set on each phase
+ * based on the `associatedPhases` property of each parameter.
+ *
+ * @param customParameters - Map of parameter definitions to their CommandLineParameter instances
+ * @param knownPhases - Map of phase names to IPhase objects
+ */
+export declare function associateParametersByPhase(customParameters: ReadonlyMap<IParameterJson, CommandLineParameter>, knownPhases: ReadonlyMap<string, IPhase>): void;
+//# sourceMappingURL=associateParametersByPhase.d.ts.map

package/lib/cli/parsing/associateParametersByPhase.js

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

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

@@ -0,0 +1,12 @@
+import type { CommandLineAction, CommandLineParameter } from '@rushstack/ts-command-line';
+import type { IParameterJson } from '../../api/CommandLineConfiguration';
+/**
+ * Helper function to create CommandLineParameter instances from parameter definitions.
+ * This centralizes the logic for defining parameters based on their kind.
+ *
+ * @param action - The CommandLineAction to define the parameters on
+ * @param associatedParameters - The set of parameter definitions
+ * @param targetMap - The map to populate with parameter definitions to CommandLineParameter instances
+ */
+export declare function defineCustomParameters(action: CommandLineAction, associatedParameters: Iterable<IParameterJson>, targetMap: Map<IParameterJson, CommandLineParameter>): void;
+//# sourceMappingURL=defineCustomParameters.d.ts.map

package/lib/cli/parsing/defineCustomParameters.js

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

package/lib/index.d.ts

@@ -4,6 +4,7 @@
  * @packageDocumentation
  */
 export { LookupByPath as LookupByPath, type IPrefixMatch } from '@rushstack/lookup-by-path';
+export { type ICredentialCacheOptions, type ICredentialCacheEntry, CredentialCache } from '@rushstack/credential-cache';
 export { ApprovedPackagesPolicy } from './api/ApprovedPackagesPolicy';
 export { RushConfiguration, type ITryFindRushJsonLocationOptions } from './api/RushConfiguration';
 export { Subspace } from './api/Subspace';
@@ -53,7 +54,6 @@ export type { IRushPluginConfigurationBase as _IRushPluginConfigurationBase } fr
 export type { ILogger } from './pluginFramework/logging/Logger';
 export type { ICloudBuildCacheProvider } from './logic/buildCache/ICloudBuildCacheProvider';
 export type { ICobuildLockProvider, ICobuildContext, ICobuildCompletedState } from './logic/cobuild/ICobuildLockProvider';
-export { type ICredentialCacheOptions, type ICredentialCacheEntry, CredentialCache } from './logic/CredentialCache';
 export type { ITelemetryData, ITelemetryMachineInfo, ITelemetryOperationResult } from './logic/Telemetry';
 export type { IStopwatchResult } from './utilities/Stopwatch';
 export { OperationStateFile as _OperationStateFile, type IOperationStateFileOptions as _IOperationStateFileOptions, type IOperationStateJson as _IOperationStateJson } from './logic/operations/OperationStateFile';

package/lib/logic/DependencySpecifier.d.ts

@@ -37,7 +37,11 @@ export declare enum DependencySpecifierType {
     /**
      * A package specified using workspace protocol, e.g. "workspace:^1.2.3"
      */
-    Workspace = "Workspace"
+    Workspace = "Workspace",
+    /**
+     * A package specified using catalog protocol, e.g. "catalog:" or "catalog:react18"
+     */
+    Catalog = "Catalog"
 }
 /**
  * An NPM "version specifier" is a string that can appear as a package.json "dependencies" value.

package/lib/logic/RepoStateFile.d.ts

@@ -11,6 +11,7 @@ export declare class RepoStateFile {
     private _pnpmShrinkwrapHash;
     private _preferredVersionsHash;
     private _packageJsonInjectedDependenciesHash;
+    private _pnpmCatalogsHash;
     private _isValid;
     private _modified;
     /**
@@ -30,6 +31,10 @@ export declare class RepoStateFile {
      * The hash of all preferred versions at the end of the last update.
      */
     get packageJsonInjectedDependenciesHash(): string | undefined;
+    /**
+     * The hash of the PNPM catalog definitions at the end of the last update.
+     */
+    get pnpmCatalogsHash(): string | undefined;
     /**
      * If false, the repo-state.json file is not valid and its values cannot be relied upon
      */

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

@@ -11,6 +11,7 @@ export interface IIPCOperationRunnerOptions {
     commandForHash: string;
     persist: boolean;
     requestRun: OperationRequestRunCallback;
+    ignoredParameterValues: ReadonlyArray<string>;
 }
 /**
  * Runner that hosts a long-lived process to which it communicates via IPC.
@@ -26,6 +27,7 @@ export declare class IPCOperationRunner implements IOperationRunner {
     private readonly _commandForHash;
     private readonly _persist;
     private readonly _requestRun;
+    private readonly _ignoredParameterValues;
     private _ipcProcess;
     private _processReadyPromise;
     constructor(options: IIPCOperationRunnerOptions);

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

@@ -8,6 +8,7 @@ export interface IShellOperationRunnerOptions {
     displayName: string;
     commandToRun: string;
     commandForHash: string;
+    ignoredParameterValues: ReadonlyArray<string>;
 }
 /**
  * An `IOperationRunner` implementation that performs an operation via a shell command.
@@ -27,6 +28,7 @@ export declare class ShellOperationRunner implements IOperationRunner {
     readonly isNoOp: boolean;
     private readonly _commandForHash;
     private readonly _rushProject;
+    private readonly _ignoredParameterValues;
     constructor(options: IShellOperationRunnerOptions);
     executeAsync(context: IOperationRunnerContext): Promise<OperationStatus>;
     getConfigHash(): string;

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

@@ -1,6 +1,7 @@
 import type { IPhase } from '../../api/CommandLineConfiguration';
 import type { RushConfigurationProject } from '../../api/RushConfigurationProject';
 import type { IPhasedCommandPlugin, PhasedCommandHooks } from '../../pluginFramework/PhasedCommandHooks';
+import type { Operation } from './Operation';
 import type { RushConfiguration } from '../../api/RushConfiguration';
 import type { IOperationRunner } from './IOperationRunner';
 export declare const PLUGIN_NAME: 'ShellOperationRunnerPlugin';
@@ -18,12 +19,32 @@ export declare function initializeShellOperationRunner(options: {
     commandToRun: string | undefined;
     commandForHash?: string;
     customParameterValues: ReadonlyArray<string>;
+    ignoredParameterValues: ReadonlyArray<string>;
 }): IOperationRunner;
+/**
+ * Result of filtering custom parameters for an operation
+ */
+export interface ICustomParameterValuesForOperation {
+    /**
+     * The serialized custom parameter values that should be included in the command
+     */
+    parameterValues: ReadonlyArray<string>;
+    /**
+     * The serialized custom parameter values that were ignored for this operation
+     */
+    ignoredParameterValues: ReadonlyArray<string>;
+}
 /**
  * Memoizer for custom parameter values by phase
  * @returns A function that returns the custom parameter values for a given phase
  */
 export declare function getCustomParameterValuesByPhase(): (phase: IPhase) => ReadonlyArray<string>;
+/**
+ * Gets custom parameter values for an operation, filtering out any parameters that should be ignored
+ * based on the operation's settings.
+ * @returns A function that returns the filtered custom parameter values and ignored parameter values for a given operation
+ */
+export declare function getCustomParameterValuesByOperation(): (operation: Operation) => ICustomParameterValuesForOperation;
 export declare function formatCommand(rawCommand: string, customParameterValues: ReadonlyArray<string>): string;
 export declare function getDisplayName(phase: IPhase, project: RushConfigurationProject): string;
 //# sourceMappingURL=ShellOperationRunnerPlugin.d.ts.map

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

@@ -138,6 +138,10 @@ export interface IPnpmOptionsJson extends IPackageManagerOptionsJsonBase {
      * {@inheritDoc PnpmOptionsConfiguration.pnpmLockfilePolicies}
      */
     pnpmLockfilePolicies?: IPnpmLockfilePolicies;
+    /**
+     * {@inheritDoc PnpmOptionsConfiguration.globalCatalogs}
+     */
+    globalCatalogs?: Record<string, Record<string, string>>;
 }
 /**
  * Options that are only used when the PNPM package manager is selected.
@@ -378,6 +382,15 @@ export declare class PnpmOptionsConfiguration extends PackageManagerOptionsConfi
      * The default value is false.
      */
     readonly alwaysFullInstall: boolean | undefined;
+    /**
+     * The `globalCatalogs` setting provides named catalogs for organizing dependency versions.
+     * Each catalog can be referenced using the `catalog:catalogName` protocol in package.json files
+     * (e.g., `catalog:react18`). The settings are written to the `catalogs` field of the
+     * `pnpm-workspace.yaml` file that is generated by Rush during installation.
+     *
+     * PNPM documentation: https://pnpm.io/catalogs
+     */
+    readonly globalCatalogs: Record<string, Record<string, string>> | undefined;
     /**
      * (GENERATED BY RUSH-PNPM PATCH-COMMIT) When modifying this property, make sure you know what you are doing.
      *

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

@@ -5,11 +5,17 @@ export declare class PnpmWorkspaceFile extends BaseWorkspaceFile {
      */
     readonly workspaceFilename: string;
     private _workspacePackages;
+    private _catalogs;
     /**
      * The PNPM workspace file is used to specify the location of workspaces relative to the root
      * of your PNPM install.
      */
     constructor(workspaceYamlFilename: string);
+    /**
+     * Sets the catalog definitions for the workspace.
+     * @param catalogs - A map of catalog name to package versions
+     */
+    setCatalogs(catalogs: Record<string, Record<string, string>> | undefined): void;
     /** @override */
     addPackage(packagePath: string): void;
     /** @override */

package/lib/logic/selectors/PathProjectSelectorParser.d.ts

@@ -0,0 +1,11 @@
+import type { RushConfiguration } from '../../api/RushConfiguration';
+import type { RushConfigurationProject } from '../../api/RushConfigurationProject';
+import type { IEvaluateSelectorOptions, ISelectorParser } from './ISelectorParser';
+export declare class PathProjectSelectorParser implements ISelectorParser<RushConfigurationProject> {
+    private readonly _rushConfiguration;
+    private readonly _workingDirectory;
+    constructor(rushConfiguration: RushConfiguration, workingDirectory: string);
+    evaluateSelectorAsync({ unscopedSelector, terminal, parameterName }: IEvaluateSelectorOptions): Promise<Iterable<RushConfigurationProject>>;
+    getCompletions(): Iterable<string>;
+}
+//# sourceMappingURL=PathProjectSelectorParser.d.ts.map

package/lib/logic/selectors/PathProjectSelectorParser.js

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

package/lib/utilities/objectUtilities.d.ts

@@ -1,7 +1,3 @@
-/**
- * Determines if two objects are deeply equal.
- */
-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;
 /**