@rushstack/rush-sdk 5.118.7 → 5.119.0

package/dist/rush-lib.d.ts

@@ -387,6 +387,7 @@ export declare class CredentialCache {
  */
 export declare enum CustomTipId {
     TIP_RUSH_INCONSISTENT_VERSIONS = "TIP_RUSH_INCONSISTENT_VERSIONS",
+    TIP_RUSH_DISALLOW_INSECURE_SHA1 = "TIP_RUSH_DISALLOW_INSECURE_SHA1",
     TIP_PNPM_UNEXPECTED_STORE = "TIP_PNPM_UNEXPECTED_STORE",
     TIP_PNPM_NO_MATCHING_VERSION = "TIP_PNPM_NO_MATCHING_VERSION",
     TIP_PNPM_NO_MATCHING_VERSION_INSIDE_WORKSPACE = "TIP_PNPM_NO_MATCHING_VERSION_INSIDE_WORKSPACE",
@@ -428,31 +429,40 @@ export declare class CustomTipsConfiguration {
     static customTipRegistry: Readonly<Record<CustomTipId, ICustomTipInfo>>;
     constructor(configFilePath: string);
     /**
-     * If custom-tips.json defines a tip for the specified tipId,
-     * display the tip on the terminal.
+     * If custom-tips.json defines a tip for the specified tipId,  display the tip on the terminal.
      *
      * @remarks
      * The severity of the tip is defined in ${@link CustomTipsConfiguration.customTipRegistry}.
-     * If you want to change the severity specifically for this call, use other API like {@link CustomTipsConfiguration._showErrorTip}.
+     * If you want to change the severity specifically for this call,
+     * use other APIs such as {@link CustomTipsConfiguration._showErrorTip}.
+     *
+     * Custom tips by design do not replace Rush's standard messaging; instead, they annotate Rush's
+     * output with additional team-specific advice.
      *
      * @internal
      */
     _showTip(terminal: ITerminal, tipId: CustomTipId): void;
     /**
-     * If custom-tips.json defines a tip for the specified tipId,
-     * display the tip on the terminal.
+     * If custom-tips.json defines a tip for the specified tipId, display the tip on the terminal.
+     * @remarks
+     * Custom tips by design do not replace Rush's standard messaging; instead, they annotate Rush's
+     * output with additional team-specific advice.
      * @internal
      */
     _showInfoTip(terminal: ITerminal, tipId: CustomTipId): void;
     /**
-     * If custom-tips.json defines a tip for the specified tipId,
-     * display the tip on the terminal.
+     * If custom-tips.json defines a tip for the specified tipId, display the tip on the terminal.
+     * @remarks
+     * Custom tips by design do not replace Rush's standard messaging; instead, they annotate Rush's
+     * output with additional team-specific advice.
      * @internal
      */
     _showWarningTip(terminal: ITerminal, tipId: CustomTipId): void;
     /**
-     * If custom-tips.json defines a tip for the specified tipId,
-     * display the tip on the terminal.
+     * If custom-tips.json defines a tip for the specified tipId, display the tip on the terminal.
+     * @remarks
+     * Custom tips by design do not replace Rush's standard messaging; instead, they annotate Rush's
+     * output with additional team-specific advice.
      * @internal
      */
     _showErrorTip(terminal: ITerminal, tipId: CustomTipId): void;
@@ -1142,10 +1152,6 @@ export declare interface ICreateOperationsContext {
      * The set of phases selected for the current command execution.
      */
     readonly phaseSelection: ReadonlySet<IPhase>;
-    /**
-     * The current state of the repository
-     */
-    readonly projectChangeAnalyzer: ProjectChangeAnalyzer;
     /**
      * The set of Rush projects selected for the current command execution.
      */
@@ -1271,6 +1277,19 @@ declare interface IEventHooksJson {
     postRushBuild?: string[];
 }
 
+/**
+ * Context used for executing operations.
+ * @alpha
+ */
+export declare interface IExecuteOperationsContext extends ICreateOperationsContext {
+    /**
+     * The current state of the repository.
+     *
+     * Note that this is not defined during the initial operation creation.
+     */
+    readonly projectChangeAnalyzer: ProjectChangeAnalyzer;
+}
+
 /**
  * The `IExecutionResult` interface represents the results of executing a set of {@link Operation}s.
  * @alpha
@@ -1875,6 +1894,17 @@ export declare interface IPhasedCommand extends IRushCommand {
     readonly hooks: PhasedCommandHooks;
 }
 
+/**
+ * Possible values for the `pnpmLockfilePolicies` setting in Rush's pnpm-config.json file.
+ * @public
+ */
+export declare interface IPnpmLockfilePolicies {
+    /**
+     * Forbid sha1 hashes in `pnpm-lock.yaml`
+     */
+    disallowInsecureSha1?: boolean;
+}
+
 /**
  * Part of IRushConfigurationJson.
  * @internal
@@ -1936,25 +1966,35 @@ export declare interface _IPnpmOptionsJson extends IPackageManagerOptionsJsonBas
      * {@inheritDoc PnpmOptionsConfiguration.alwaysFullInstall}
      */
     alwaysFullInstall?: boolean;
+    /**
+     * {@inheritDoc PnpmOptionsConfiguration.pnpmLockfilePolicies}
+     */
+    pnpmLockfilePolicies?: IPnpmLockfilePolicies;
 }
 
-declare interface IPnpmPackageExtension {
+/**
+ * @public
+ */
+export declare interface IPnpmPackageExtension {
     dependencies?: Record<string, string>;
     optionalDependencies?: Record<string, string>;
     peerDependencies?: Record<string, string>;
     peerDependenciesMeta?: IPnpmPeerDependenciesMeta;
 }
 
-declare interface IPnpmPeerDependenciesMeta {
+/**
+ * @public
+ */
+export declare interface IPnpmPeerDependenciesMeta {
     [packageName: string]: {
         optional?: boolean;
     };
 }
 
 /**
- * @beta
+ * @public
  */
-declare interface IPnpmPeerDependencyRules {
+export declare interface IPnpmPeerDependencyRules {
     ignoreMissing?: string[];
     allowAny?: string[];
     allowedVersions?: Record<string, string>;
@@ -2945,7 +2985,7 @@ export declare class PhasedCommandHooks {
      */
     readonly beforeExecuteOperations: AsyncSeriesHook<[
     Map<Operation, IOperationExecutionResult>,
-    ICreateOperationsContext
+    IExecuteOperationsContext
     ]>;
     /**
      * Hook invoked when operation status changed
@@ -2957,7 +2997,7 @@ export declare class PhasedCommandHooks {
      * Use the context to distinguish between the initial run and phased runs.
      * Hook is series for stable output.
      */
-    readonly afterExecuteOperations: AsyncSeriesHook<[IExecutionResult, ICreateOperationsContext]>;
+    readonly afterExecuteOperations: AsyncSeriesHook<[IExecutionResult, IExecuteOperationsContext]>;
     /**
      * Hook invoked before executing a operation.
      */
@@ -3165,6 +3205,10 @@ export declare class PnpmOptionsConfiguration extends PackageManagerOptionsConfi
      */
     readonly unsupportedPackageJsonSettings: unknown | undefined;
     readonly jsonFilename: string | undefined;
+    /**
+     * The `pnpmLockfilePolicies` setting defines the policies that govern the `pnpm-lock.yaml` file.
+     */
+    readonly pnpmLockfilePolicies: IPnpmLockfilePolicies | undefined;
     /**
      * (EXPERIMENTAL) If "true", then filtered installs ("rush install --to my-project")
      * will be disregarded, instead always performing a full installation of the lockfile.
@@ -4380,31 +4424,31 @@ export declare class RushLifecycleHooks {
     /**
      * The hook to run before executing any Rush CLI Command.
      */
-    initialize: AsyncSeriesHook<IRushCommand>;
+    readonly initialize: AsyncSeriesHook<IRushCommand>;
     /**
      * The hook to run before executing any global Rush CLI Command (defined in command-line.json).
      */
-    runAnyGlobalCustomCommand: AsyncSeriesHook<IGlobalCommand>;
+    readonly runAnyGlobalCustomCommand: AsyncSeriesHook<IGlobalCommand>;
     /**
      * A hook map to allow plugins to hook specific named global commands (defined in command-line.json) before execution.
      */
-    runGlobalCustomCommand: HookMap<AsyncSeriesHook<IGlobalCommand>>;
+    readonly runGlobalCustomCommand: HookMap<AsyncSeriesHook<IGlobalCommand>>;
     /**
      * The hook to run before executing any phased Rush CLI Command (defined in command-line.json, or the default "build" or "rebuild").
      */
-    runAnyPhasedCommand: AsyncSeriesHook<IPhasedCommand>;
+    readonly runAnyPhasedCommand: AsyncSeriesHook<IPhasedCommand>;
     /**
      * A hook map to allow plugins to hook specific named phased commands (defined in command-line.json) before execution.
      */
-    runPhasedCommand: HookMap<AsyncSeriesHook<IPhasedCommand>>;
+    readonly runPhasedCommand: HookMap<AsyncSeriesHook<IPhasedCommand>>;
     /**
      * The hook to run between preparing the common/temp folder and invoking the package manager during "rush install" or "rush update".
      */
-    beforeInstall: AsyncSeriesHook<IGlobalCommand>;
+    readonly beforeInstall: AsyncSeriesHook<IGlobalCommand>;
     /**
      * A hook to allow plugins to hook custom logic to process telemetry data.
      */
-    flushTelemetry: AsyncParallelHook<[ReadonlyArray<ITelemetryData>]>;
+    readonly flushTelemetry: AsyncParallelHook<[ReadonlyArray<ITelemetryData>]>;
 }
 
 declare class RushPluginsConfiguration {

package/lib/api/CustomTipsConfiguration.d.ts

@@ -40,6 +40,7 @@ export interface ICustomTipItemJson {
  */
 export declare enum CustomTipId {
     TIP_RUSH_INCONSISTENT_VERSIONS = "TIP_RUSH_INCONSISTENT_VERSIONS",
+    TIP_RUSH_DISALLOW_INSECURE_SHA1 = "TIP_RUSH_DISALLOW_INSECURE_SHA1",
     TIP_PNPM_UNEXPECTED_STORE = "TIP_PNPM_UNEXPECTED_STORE",
     TIP_PNPM_NO_MATCHING_VERSION = "TIP_PNPM_NO_MATCHING_VERSION",
     TIP_PNPM_NO_MATCHING_VERSION_INSIDE_WORKSPACE = "TIP_PNPM_NO_MATCHING_VERSION_INSIDE_WORKSPACE",
@@ -137,31 +138,40 @@ export declare class CustomTipsConfiguration {
     static customTipRegistry: Readonly<Record<CustomTipId, ICustomTipInfo>>;
     constructor(configFilePath: string);
     /**
-     * If custom-tips.json defines a tip for the specified tipId,
-     * display the tip on the terminal.
+     * If custom-tips.json defines a tip for the specified tipId,  display the tip on the terminal.
      *
      * @remarks
      * The severity of the tip is defined in ${@link CustomTipsConfiguration.customTipRegistry}.
-     * If you want to change the severity specifically for this call, use other API like {@link CustomTipsConfiguration._showErrorTip}.
+     * If you want to change the severity specifically for this call,
+     * use other APIs such as {@link CustomTipsConfiguration._showErrorTip}.
+     *
+     * Custom tips by design do not replace Rush's standard messaging; instead, they annotate Rush's
+     * output with additional team-specific advice.
      *
      * @internal
      */
     _showTip(terminal: ITerminal, tipId: CustomTipId): void;
     /**
-     * If custom-tips.json defines a tip for the specified tipId,
-     * display the tip on the terminal.
+     * If custom-tips.json defines a tip for the specified tipId, display the tip on the terminal.
+     * @remarks
+     * Custom tips by design do not replace Rush's standard messaging; instead, they annotate Rush's
+     * output with additional team-specific advice.
      * @internal
      */
     _showInfoTip(terminal: ITerminal, tipId: CustomTipId): void;
     /**
-     * If custom-tips.json defines a tip for the specified tipId,
-     * display the tip on the terminal.
+     * If custom-tips.json defines a tip for the specified tipId, display the tip on the terminal.
+     * @remarks
+     * Custom tips by design do not replace Rush's standard messaging; instead, they annotate Rush's
+     * output with additional team-specific advice.
      * @internal
      */
     _showWarningTip(terminal: ITerminal, tipId: CustomTipId): void;
     /**
-     * If custom-tips.json defines a tip for the specified tipId,
-     * display the tip on the terminal.
+     * If custom-tips.json defines a tip for the specified tipId, display the tip on the terminal.
+     * @remarks
+     * Custom tips by design do not replace Rush's standard messaging; instead, they annotate Rush's
+     * output with additional team-specific advice.
      * @internal
      */
     _showErrorTip(terminal: ITerminal, tipId: CustomTipId): void;

package/lib/index.d.ts

@@ -9,7 +9,7 @@ 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';
-export { IPnpmOptionsJson as _IPnpmOptionsJson, PnpmStoreLocation, PnpmStoreOptions, PnpmOptionsConfiguration, PnpmResolutionMode } from './logic/pnpm/PnpmOptionsConfiguration';
+export { IPnpmOptionsJson as _IPnpmOptionsJson, PnpmStoreLocation, IPnpmLockfilePolicies, IPnpmPackageExtension, IPnpmPeerDependencyRules, IPnpmPeerDependenciesMeta, PnpmStoreOptions, PnpmOptionsConfiguration, PnpmResolutionMode } from './logic/pnpm/PnpmOptionsConfiguration';
 export { BuildCacheConfiguration } from './api/BuildCacheConfiguration';
 export { CobuildConfiguration, ICobuildJson } from './api/CobuildConfiguration';
 export { GetCacheEntryIdFunction, IGenerateCacheEntryIdOptions } from './logic/buildCache/CacheEntryId';
@@ -43,7 +43,7 @@ export { IOperationOptions, Operation } from './logic/operations/Operation';
 export { OperationStatus } from './logic/operations/OperationStatus';
 export { RushSession, IRushSessionOptions, CloudBuildCacheProviderFactory, CobuildLockProviderFactory } from './pluginFramework/RushSession';
 export { IRushCommand, IGlobalCommand, IPhasedCommand, RushLifecycleHooks } from './pluginFramework/RushLifeCycle';
-export { ICreateOperationsContext, PhasedCommandHooks } from './pluginFramework/PhasedCommandHooks';
+export { ICreateOperationsContext, IExecuteOperationsContext, PhasedCommandHooks } from './pluginFramework/PhasedCommandHooks';
 export { IRushPlugin } from './pluginFramework/IRushPlugin';
 export { IBuiltInPluginConfiguration as _IBuiltInPluginConfiguration } from './pluginFramework/PluginLoader/BuiltInPluginLoader';
 export { IRushPluginConfigurationBase as _IRushPluginConfigurationBase } from './api/RushPluginsConfiguration';

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

@@ -1,3 +1,4 @@
+import { type ITerminal } from '@rushstack/terminal';
 import { type DependencySpecifier } from '../DependencySpecifier';
 import type { IShrinkwrapFilePolicyValidatorOptions } from '../policy/ShrinkwrapFilePolicy';
 import type { RushConfiguration } from '../../api/RushConfiguration';
@@ -15,6 +16,12 @@ export declare abstract class BaseShrinkwrapFile {
     protected static tryGetValue<T>(dictionary: {
         [key2: string]: T;
     }, key: string): T | undefined;
+    /**
+     * Determine whether `pnpm-lock.yaml` complies with the rules specified in `common/config/rush/pnpm-config.schema.json`.
+     *
+     * @virtual
+     */
+    validateShrinkwrapAfterUpdate(rushConfiguration: RushConfiguration, terminal: ITerminal): void;
     /**
      * Validate the shrinkwrap using the provided policy options.
      *

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

@@ -19,18 +19,34 @@ export type PnpmStoreOptions = PnpmStoreLocation;
  */
 export type PnpmResolutionMode = 'highest' | 'time-based' | 'lowest-direct';
 /**
- * @beta
+ * Possible values for the `pnpmLockfilePolicies` setting in Rush's pnpm-config.json file.
+ * @public
+ */
+export interface IPnpmLockfilePolicies {
+    /**
+     * Forbid sha1 hashes in `pnpm-lock.yaml`
+     */
+    disallowInsecureSha1?: boolean;
+}
+/**
+ * @public
  */
 export interface IPnpmPeerDependencyRules {
     ignoreMissing?: string[];
     allowAny?: string[];
     allowedVersions?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface IPnpmPeerDependenciesMeta {
     [packageName: string]: {
         optional?: boolean;
     };
 }
+/**
+ * @public
+ */
 export interface IPnpmPackageExtension {
     dependencies?: Record<string, string>;
     optionalDependencies?: Record<string, string>;
@@ -98,6 +114,10 @@ export interface IPnpmOptionsJson extends IPackageManagerOptionsJsonBase {
      * {@inheritDoc PnpmOptionsConfiguration.alwaysFullInstall}
      */
     alwaysFullInstall?: boolean;
+    /**
+     * {@inheritDoc PnpmOptionsConfiguration.pnpmLockfilePolicies}
+     */
+    pnpmLockfilePolicies?: IPnpmLockfilePolicies;
 }
 /**
  * Options that are only used when the PNPM package manager is selected.
@@ -277,6 +297,10 @@ export declare class PnpmOptionsConfiguration extends PackageManagerOptionsConfi
      */
     readonly unsupportedPackageJsonSettings: unknown | undefined;
     readonly jsonFilename: string | undefined;
+    /**
+     * The `pnpmLockfilePolicies` setting defines the policies that govern the `pnpm-lock.yaml` file.
+     */
+    readonly pnpmLockfilePolicies: IPnpmLockfilePolicies | undefined;
     /**
      * (EXPERIMENTAL) If "true", then filtered installs ("rush install --to my-project")
      * will be disregarded, instead always performing a full installation of the lockfile.

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

@@ -1,3 +1,4 @@
+import { type ITerminal } from '@rushstack/terminal';
 import { BaseShrinkwrapFile } from '../base/BaseShrinkwrapFile';
 import { DependencySpecifier } from '../DependencySpecifier';
 import type { RushConfiguration } from '../../api/RushConfiguration';
@@ -133,6 +134,13 @@ export declare class PnpmShrinkwrapFile extends BaseShrinkwrapFile {
     static loadFromFile(shrinkwrapYamlFilePath: string, { withCaching }?: ILoadFromFileOptions): PnpmShrinkwrapFile | undefined;
     static loadFromString(shrinkwrapContent: string): PnpmShrinkwrapFile;
     getShrinkwrapHash(experimentsConfig?: IExperimentsJson): string;
+    /**
+     * Determine whether `pnpm-lock.yaml` contains insecure sha1 hashes.
+     * @internal
+     */
+    private _disallowInsecureSha1;
+    /** @override */
+    validateShrinkwrapAfterUpdate(rushConfiguration: RushConfiguration, terminal: ITerminal): void;
     /** @override */
     validate(packageManagerOptionsConfig: PackageManagerOptionsConfigurationBase, policyOptions: IShrinkwrapFilePolicyValidatorOptions, experimentsConfig?: IExperimentsJson): void;
     /** @override */

package/lib/pluginFramework/PhasedCommandHooks.d.ts

@@ -62,10 +62,6 @@ export interface ICreateOperationsContext {
      * The set of phases selected for the current command execution.
      */
     readonly phaseSelection: ReadonlySet<IPhase>;
-    /**
-     * The current state of the repository
-     */
-    readonly projectChangeAnalyzer: ProjectChangeAnalyzer;
     /**
      * The set of Rush projects selected for the current command execution.
      */
@@ -90,6 +86,18 @@ export interface ICreateOperationsContext {
      */
     readonly invalidateOperation?: ((operation: Operation, reason: string) => void) | undefined;
 }
+/**
+ * Context used for executing operations.
+ * @alpha
+ */
+export interface IExecuteOperationsContext extends ICreateOperationsContext {
+    /**
+     * The current state of the repository.
+     *
+     * Note that this is not defined during the initial operation creation.
+     */
+    readonly projectChangeAnalyzer: ProjectChangeAnalyzer;
+}
 /**
  * Hooks into the execution process for phased commands
  * @alpha
@@ -106,7 +114,7 @@ export declare class PhasedCommandHooks {
      */
     readonly beforeExecuteOperations: AsyncSeriesHook<[
         Map<Operation, IOperationExecutionResult>,
-        ICreateOperationsContext
+        IExecuteOperationsContext
     ]>;
     /**
      * Hook invoked when operation status changed
@@ -118,7 +126,7 @@ export declare class PhasedCommandHooks {
      * Use the context to distinguish between the initial run and phased runs.
      * Hook is series for stable output.
      */
-    readonly afterExecuteOperations: AsyncSeriesHook<[IExecutionResult, ICreateOperationsContext]>;
+    readonly afterExecuteOperations: AsyncSeriesHook<[IExecutionResult, IExecuteOperationsContext]>;
     /**
      * Hook invoked before executing a operation.
      */

package/lib/pluginFramework/RushLifeCycle.d.ts

@@ -37,30 +37,30 @@ export declare class RushLifecycleHooks {
     /**
      * The hook to run before executing any Rush CLI Command.
      */
-    initialize: AsyncSeriesHook<IRushCommand>;
+    readonly initialize: AsyncSeriesHook<IRushCommand>;
     /**
      * The hook to run before executing any global Rush CLI Command (defined in command-line.json).
      */
-    runAnyGlobalCustomCommand: AsyncSeriesHook<IGlobalCommand>;
+    readonly runAnyGlobalCustomCommand: AsyncSeriesHook<IGlobalCommand>;
     /**
      * A hook map to allow plugins to hook specific named global commands (defined in command-line.json) before execution.
      */
-    runGlobalCustomCommand: HookMap<AsyncSeriesHook<IGlobalCommand>>;
+    readonly runGlobalCustomCommand: HookMap<AsyncSeriesHook<IGlobalCommand>>;
     /**
      * The hook to run before executing any phased Rush CLI Command (defined in command-line.json, or the default "build" or "rebuild").
      */
-    runAnyPhasedCommand: AsyncSeriesHook<IPhasedCommand>;
+    readonly runAnyPhasedCommand: AsyncSeriesHook<IPhasedCommand>;
     /**
      * A hook map to allow plugins to hook specific named phased commands (defined in command-line.json) before execution.
      */
-    runPhasedCommand: HookMap<AsyncSeriesHook<IPhasedCommand>>;
+    readonly runPhasedCommand: HookMap<AsyncSeriesHook<IPhasedCommand>>;
     /**
      * The hook to run between preparing the common/temp folder and invoking the package manager during "rush install" or "rush update".
      */
-    beforeInstall: AsyncSeriesHook<IGlobalCommand>;
+    readonly beforeInstall: AsyncSeriesHook<IGlobalCommand>;
     /**
      * A hook to allow plugins to hook custom logic to process telemetry data.
      */
-    flushTelemetry: AsyncParallelHook<[ReadonlyArray<ITelemetryData>]>;
+    readonly flushTelemetry: AsyncParallelHook<[ReadonlyArray<ITelemetryData>]>;
 }
 //# sourceMappingURL=RushLifeCycle.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/rush-sdk",
-  "version": "5.118.7",
+  "version": "5.119.0",
   "description": "An API for interacting with the Rush engine",
   "repository": {
     "type": "git",
@@ -31,11 +31,11 @@
   "devDependencies": {
     "@types/semver": "7.5.0",
     "@types/webpack-env": "1.18.0",
+    "@microsoft/rush-lib": "5.119.0",
     "@rushstack/heft": "0.66.2",
     "local-node-rig": "1.0.0",
-    "@microsoft/rush-lib": "5.118.7",
-    "@rushstack/stream-collator": "4.1.40",
-    "@rushstack/ts-command-line": "4.19.1"
+    "@rushstack/ts-command-line": "4.19.1",
+    "@rushstack/stream-collator": "4.1.40"
   },
   "scripts": {
     "build": "heft build --clean",