@rushstack/rush-sdk 5.157.0 → 5.158.1

package/dist/rush-lib.d.ts

@@ -1612,7 +1612,12 @@ export declare interface IGetChangedProjectsOptions {
 export declare interface IGlobalCommand extends IRushCommand {
 }
 
-declare interface IIndividualVersionJson extends IVersionPolicyJson {
+/**
+ * This interface represents the raw individual version policy JSON object which extends the base version policy
+ * with additional fields specific to individual versioning.
+ * @public
+ */
+export declare interface IIndividualVersionJson extends IVersionPolicyJson {
     lockedMajor?: number;
 }
 
@@ -1697,7 +1702,12 @@ declare interface ILocalBuildCacheJson extends IBaseBuildCacheJson {
     readonly cacheProvider: 'local-only';
 }
 
-declare interface ILockStepVersionJson extends IVersionPolicyJson {
+/**
+ * This interface represents the raw lock-step version policy JSON object which extends the base version policy
+ * with additional fields specific to lock-step versioning.
+ * @public
+ */
+export declare interface ILockStepVersionJson extends IVersionPolicyJson {
     version: string;
     nextBump?: string;
     mainProject?: string;
@@ -1756,19 +1766,17 @@ export declare interface ILogger {
  */
 export declare class IndividualVersionPolicy extends VersionPolicy {
     /**
-     * The major version that has been locked
+     * @internal
      */
-    readonly lockedMajor: number | undefined;
+    readonly _json: IIndividualVersionJson;
     /**
-     * @internal
+     * The major version that has been locked
      */
-    constructor(versionPolicyJson: IIndividualVersionJson);
+    get lockedMajor(): number | undefined;
     /**
-     * Serialized json for this policy
-     *
      * @internal
      */
-    get _json(): IIndividualVersionJson;
+    constructor(versionPolicyJson: IIndividualVersionJson);
     /**
      * Returns an updated package json that satisfies the version policy.
      *
@@ -2765,12 +2773,24 @@ export declare interface ITryFindRushJsonLocationOptions {
     startingFolder?: string;
 }
 
+/**
+ * This interface represents the `dependencies` field in a version policy JSON object,
+ * allowing repo maintainers to specify how dependencies' versions should be handled
+ * during publishing and committing.
+ * @public
+ */
 declare interface IVersionPolicyDependencyJson {
     versionFormatForPublish?: VersionFormatForPublish;
     versionFormatForCommit?: VersionFormatForCommit;
 }
 
-declare interface IVersionPolicyJson {
+/**
+ * This interface represents the raw version policy JSON object which allows repo
+ * maintainers to define how different groups of projects will be published by Rush,
+ * and how their version numbers will be determined.
+ * @public
+ */
+export declare interface IVersionPolicyJson {
     policyName: string;
     definitionName: string;
     dependencies?: IVersionPolicyDependencyJson;
@@ -2798,18 +2818,22 @@ export declare interface _IYarnOptionsJson extends IPackageManagerOptionsJsonBas
  * @public
  */
 export declare class LockStepVersionPolicy extends VersionPolicy {
+    /**
+     * @internal
+     */
+    readonly _json: ILockStepVersionJson;
     private _version;
     /**
      * The type of bump for next bump.
      */
-    readonly nextBump: BumpType | undefined;
+    get nextBump(): BumpType | undefined;
     /**
      * The main project for the version policy.
      *
      * If the value is provided, change logs will only be generated in that project.
      * If the value is not provided, change logs will be hosted in each project associated with the policy.
      */
-    readonly mainProject: string | undefined;
+    get mainProject(): string | undefined;
     /**
      * @internal
      */
@@ -2818,12 +2842,6 @@ export declare class LockStepVersionPolicy extends VersionPolicy {
      * The value of the lockstep version
      */
     get version(): string;
-    /**
-     * Serialized json for this policy
-     *
-     * @internal
-     */
-    get _json(): ILockStepVersionJson;
     /**
      * Returns an updated package json that satisfies the version policy.
      *
@@ -5096,39 +5114,45 @@ export declare class SubspacesConfiguration {
     static tryLoadFromDefaultLocation(rushConfiguration: RushConfiguration): SubspacesConfiguration | undefined;
 }
 
-declare enum VersionFormatForCommit {
-    wildcard = "wildcard",
-    original = "original"
-}
+/**
+ * @public
+ */
+declare type VersionFormatForCommit = 'wildcard' | 'original';
 
-declare enum VersionFormatForPublish {
-    original = "original",
-    exact = "exact"
-}
+/**
+ * @public
+ */
+declare type VersionFormatForPublish = 'original' | 'exact';
 
 /**
  * This is the base class for version policy which controls how versions get bumped.
  * @public
  */
 export declare abstract class VersionPolicy {
-    private _versionFormatForCommit;
-    private _versionFormatForPublish;
+    /**
+     * Serialized json for the policy
+     *
+     * @internal
+     */
+    readonly _json: IVersionPolicyJson;
+    private get _versionFormatForCommit();
+    private get _versionFormatForPublish();
     /**
      * Version policy name
      */
-    readonly policyName: string;
+    get policyName(): string;
     /**
      * Version policy definition name
      */
-    readonly definitionName: VersionPolicyDefinitionName;
+    get definitionName(): VersionPolicyDefinitionName;
     /**
      * Determines if a version policy wants to opt out of changelog files.
      */
-    readonly exemptFromRushChange: boolean;
+    get exemptFromRushChange(): boolean;
     /**
      * Determines if a version policy wants to opt in to including email.
      */
-    readonly includeEmailInChangeFile: boolean;
+    get includeEmailInChangeFile(): boolean;
     /**
      * @internal
      */
@@ -5159,12 +5183,6 @@ export declare abstract class VersionPolicy {
      * @param identifier - (optional) override prerelease Id
      */
     abstract bump(bumpType?: BumpType, identifier?: string): void;
-    /**
-     * Serialized json for the policy
-     *
-     * @internal
-     */
-    abstract get _json(): IVersionPolicyJson;
     /**
      * Validates the specified version and throws if the version does not satisfy the policy.
      *

package/dist/tsdoc-metadata.json

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

package/lib/api/VersionPolicy.d.ts

@@ -1,5 +1,5 @@
 import { type IPackageJson } from '@rushstack/node-core-library';
-import { type IVersionPolicyJson, type ILockStepVersionJson, type IIndividualVersionJson } from './VersionPolicyConfiguration';
+import type { IVersionPolicyJson, ILockStepVersionJson, IIndividualVersionJson } from './VersionPolicyConfiguration';
 import type { RushConfiguration } from './RushConfiguration';
 /**
  * Type of version bumps
@@ -33,24 +33,30 @@ export declare enum VersionPolicyDefinitionName {
  * @public
  */
 export declare abstract class VersionPolicy {
-    private _versionFormatForCommit;
-    private _versionFormatForPublish;
+    /**
+     * Serialized json for the policy
+     *
+     * @internal
+     */
+    readonly _json: IVersionPolicyJson;
+    private get _versionFormatForCommit();
+    private get _versionFormatForPublish();
     /**
      * Version policy name
      */
-    readonly policyName: string;
+    get policyName(): string;
     /**
      * Version policy definition name
      */
-    readonly definitionName: VersionPolicyDefinitionName;
+    get definitionName(): VersionPolicyDefinitionName;
     /**
      * Determines if a version policy wants to opt out of changelog files.
      */
-    readonly exemptFromRushChange: boolean;
+    get exemptFromRushChange(): boolean;
     /**
      * Determines if a version policy wants to opt in to including email.
      */
-    readonly includeEmailInChangeFile: boolean;
+    get includeEmailInChangeFile(): boolean;
     /**
      * @internal
      */
@@ -81,12 +87,6 @@ export declare abstract class VersionPolicy {
      * @param identifier - (optional) override prerelease Id
      */
     abstract bump(bumpType?: BumpType, identifier?: string): void;
-    /**
-     * Serialized json for the policy
-     *
-     * @internal
-     */
-    abstract get _json(): IVersionPolicyJson;
     /**
      * Validates the specified version and throws if the version does not satisfy the policy.
      *
@@ -110,18 +110,22 @@ export declare abstract class VersionPolicy {
  * @public
  */
 export declare class LockStepVersionPolicy extends VersionPolicy {
+    /**
+     * @internal
+     */
+    readonly _json: ILockStepVersionJson;
     private _version;
     /**
      * The type of bump for next bump.
      */
-    readonly nextBump: BumpType | undefined;
+    get nextBump(): BumpType | undefined;
     /**
      * The main project for the version policy.
      *
      * If the value is provided, change logs will only be generated in that project.
      * If the value is not provided, change logs will be hosted in each project associated with the policy.
      */
-    readonly mainProject: string | undefined;
+    get mainProject(): string | undefined;
     /**
      * @internal
      */
@@ -130,12 +134,6 @@ export declare class LockStepVersionPolicy extends VersionPolicy {
      * The value of the lockstep version
      */
     get version(): string;
-    /**
-     * Serialized json for this policy
-     *
-     * @internal
-     */
-    get _json(): ILockStepVersionJson;
     /**
      * Returns an updated package json that satisfies the version policy.
      *
@@ -171,19 +169,17 @@ export declare class LockStepVersionPolicy extends VersionPolicy {
  */
 export declare class IndividualVersionPolicy extends VersionPolicy {
     /**
-     * The major version that has been locked
+     * @internal
      */
-    readonly lockedMajor: number | undefined;
+    readonly _json: IIndividualVersionJson;
     /**
-     * @internal
+     * The major version that has been locked
      */
-    constructor(versionPolicyJson: IIndividualVersionJson);
+    get lockedMajor(): number | undefined;
     /**
-     * Serialized json for this policy
-     *
      * @internal
      */
-    get _json(): IIndividualVersionJson;
+    constructor(versionPolicyJson: IIndividualVersionJson);
     /**
      * Returns an updated package json that satisfies the version policy.
      *

package/lib/api/VersionPolicyConfiguration.d.ts

@@ -1,5 +1,11 @@
 import { VersionPolicy, type BumpType } from './VersionPolicy';
 import type { RushConfigurationProject } from './RushConfigurationProject';
+/**
+ * This interface represents the raw version policy JSON object which allows repo
+ * maintainers to define how different groups of projects will be published by Rush,
+ * and how their version numbers will be determined.
+ * @public
+ */
 export interface IVersionPolicyJson {
     policyName: string;
     definitionName: string;
@@ -7,22 +13,38 @@ export interface IVersionPolicyJson {
     exemptFromRushChange?: boolean;
     includeEmailInChangeFile?: boolean;
 }
+/**
+ * This interface represents the raw lock-step version policy JSON object which extends the base version policy
+ * with additional fields specific to lock-step versioning.
+ * @public
+ */
 export interface ILockStepVersionJson extends IVersionPolicyJson {
     version: string;
     nextBump?: string;
     mainProject?: string;
 }
+/**
+ * This interface represents the raw individual version policy JSON object which extends the base version policy
+ * with additional fields specific to individual versioning.
+ * @public
+ */
 export interface IIndividualVersionJson extends IVersionPolicyJson {
     lockedMajor?: number;
 }
-export declare enum VersionFormatForPublish {
-    original = "original",
-    exact = "exact"
-}
-export declare enum VersionFormatForCommit {
-    wildcard = "wildcard",
-    original = "original"
-}
+/**
+ * @public
+ */
+export type VersionFormatForPublish = 'original' | 'exact';
+/**
+ * @public
+ */
+export type VersionFormatForCommit = 'wildcard' | 'original';
+/**
+ * This interface represents the `dependencies` field in a version policy JSON object,
+ * allowing repo maintainers to specify how dependencies' versions should be handled
+ * during publishing and committing.
+ * @public
+ */
 export interface IVersionPolicyDependencyJson {
     versionFormatForPublish?: VersionFormatForPublish;
     versionFormatForCommit?: VersionFormatForCommit;

package/lib/index.d.ts

@@ -32,7 +32,7 @@ export { EventHooks, Event } from './api/EventHooks';
 export { ChangeManager } from './api/ChangeManager';
 export { FlagFile as _FlagFile } from './api/FlagFile';
 export { VersionPolicyDefinitionName, BumpType, LockStepVersionPolicy, IndividualVersionPolicy, VersionPolicy } from './api/VersionPolicy';
-export { VersionPolicyConfiguration } from './api/VersionPolicyConfiguration';
+export { VersionPolicyConfiguration, type ILockStepVersionJson, type IIndividualVersionJson, type IVersionPolicyJson } from './api/VersionPolicyConfiguration';
 export { type ILaunchOptions, Rush } from './api/Rush';
 export { RushInternals as _RushInternals } from './api/RushInternals';
 export { ExperimentsConfiguration, type IExperimentsJson } from './api/ExperimentsConfiguration';

package/lib/logic/DependencySpecifier.d.ts

@@ -65,6 +65,17 @@ export declare class DependencySpecifier {
      */
     readonly aliasTarget: DependencySpecifier | undefined;
     constructor(packageName: string, versionSpecifier: string);
+    /**
+     * Clears the dependency specifier parse cache.
+     */
+    static clearCache(): void;
+    /**
+     * Parses a dependency specifier with caching.
+     * @param packageName - The name of the package the version specifier corresponds to
+     * @param versionSpecifier - The version specifier to parse
+     * @returns The parsed dependency specifier
+     */
+    static parseWithCache(packageName: string, versionSpecifier: string): DependencySpecifier;
     static getDependencySpecifierType(specifierType: string): DependencySpecifierType;
 }
 //# sourceMappingURL=DependencySpecifier.d.ts.map

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

@@ -89,7 +89,6 @@ export declare function parsePnpm9DependencyKey(dependencyName: string, versionS
 export declare function parsePnpmDependencyKey(dependencyName: string, versionSpecifier: IPnpmVersionSpecifier): DependencySpecifier | undefined;
 export declare function normalizePnpmVersionSpecifier(versionSpecifier: IPnpmVersionSpecifier): string;
 export declare class PnpmShrinkwrapFile extends BaseShrinkwrapFile {
-    private static _cacheByLockfilePath;
     readonly shrinkwrapFileMajorVersion: number;
     readonly isWorkspaceCompatible: boolean;
     readonly registry: string;
@@ -99,12 +98,17 @@ export declare class PnpmShrinkwrapFile extends BaseShrinkwrapFile {
     readonly packages: ReadonlyMap<string, IPnpmShrinkwrapDependencyYaml>;
     readonly overrides: ReadonlyMap<string, string>;
     readonly packageExtensionsChecksum: undefined | string;
+    readonly hash: string;
     private readonly _shrinkwrapJson;
     private readonly _integrities;
     private _pnpmfileConfiguration;
     private constructor();
     static getLockfileV9PackageId(name: string, version: string): string;
-    static loadFromFile(shrinkwrapYamlFilePath: string, { withCaching }?: ILoadFromFileOptions): PnpmShrinkwrapFile | undefined;
+    /**
+     * Clears the cache of PnpmShrinkwrapFile instances to free up memory.
+     */
+    static clearCache(): void;
+    static loadFromFile(shrinkwrapYamlFilePath: string, options?: ILoadFromFileOptions): PnpmShrinkwrapFile | undefined;
     static loadFromString(shrinkwrapContent: string): PnpmShrinkwrapFile;
     getShrinkwrapHash(experimentsConfig?: IExperimentsJson): string;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/rush-sdk",
-  "version": "5.157.0",
+  "version": "5.158.1",
   "description": "An API for interacting with the Rush engine",
   "repository": {
     "type": "git",
@@ -36,9 +36,9 @@
   "dependencies": {
     "@pnpm/lockfile.types": "~1.0.3",
     "tapable": "2.2.1",
-    "@rushstack/package-deps-hash": "4.4.3",
-    "@rushstack/lookup-by-path": "0.7.2",
     "@rushstack/node-core-library": "5.14.0",
+    "@rushstack/package-deps-hash": "4.4.5",
+    "@rushstack/lookup-by-path": "0.7.4",
     "@rushstack/terminal": "0.15.4"
   },
   "devDependencies": {
@@ -46,12 +46,12 @@
     "@types/webpack-env": "1.18.8",
     "eslint": "~9.25.1",
     "webpack": "~5.98.0",
-    "@microsoft/rush-lib": "5.157.0",
-    "@rushstack/heft-webpack5-plugin": "0.11.35",
-    "@rushstack/heft": "0.74.1",
-    "@rushstack/stream-collator": "4.1.105",
+    "@microsoft/rush-lib": "5.158.1",
+    "@rushstack/heft": "0.74.3",
     "@rushstack/ts-command-line": "5.0.2",
-    "@rushstack/webpack-preserve-dynamic-require-plugin": "0.11.104",
+    "@rushstack/heft-webpack5-plugin": "0.11.40",
+    "@rushstack/stream-collator": "4.1.107",
+    "@rushstack/webpack-preserve-dynamic-require-plugin": "0.11.106",
     "local-node-rig": "1.0.0"
   },
   "scripts": {