@rushstack/rush-sdk 5.153.2 → 5.155.0

package/dist/rush-lib.d.ts

@@ -1274,6 +1274,10 @@ export declare interface ICredentialCacheEntry {
  */
 export declare interface ICredentialCacheOptions {
     supportEditing: boolean;
+    /**
+     * If specified, use the specified path instead of the default path of `~/.rush-user/credentials.json`
+     */
+    cacheFilePath?: string;
 }
 
 /**
@@ -1749,6 +1753,20 @@ export declare class IndividualVersionPolicy extends VersionPolicy {
 export declare interface _INpmOptionsJson extends IPackageManagerOptionsJsonBase {
 }
 
+/**
+ * @internal
+ */
+export declare interface _IOperationBuildCacheOptions {
+    /**
+     * The repo-wide configuration for the build cache.
+     */
+    buildCacheConfiguration: BuildCacheConfiguration;
+    /**
+     * The terminal to use for logging.
+     */
+    terminal: ITerminal;
+}
+
 /**
  * The `IOperationExecutionResult` interface represents the results of executing an {@link Operation}.
  * @alpha
@@ -2237,6 +2255,28 @@ export declare interface IPnpmPeerDependencyRules {
 
 export { IPrefixMatch }
 
+/**
+ * @internal
+ */
+export declare type _IProjectBuildCacheOptions = _IOperationBuildCacheOptions & {
+    /**
+     * Value from rush-project.json
+     */
+    projectOutputFolderNames: ReadonlyArray<string>;
+    /**
+     * The project to be cached.
+     */
+    project: RushConfigurationProject;
+    /**
+     * The hash of all relevant inputs and configuration that uniquely identifies this execution.
+     */
+    operationStateHash: string;
+    /**
+     * The name of the phase that is being cached.
+     */
+    phaseName: string;
+};
+
 /**
  * Information about the currently executing command provided to plugins.
  * @beta
@@ -2857,6 +2897,35 @@ export declare class Operation {
     deleteDependency(dependency: Operation): void;
 }
 
+/**
+ * @internal
+ */
+export declare class _OperationBuildCache {
+    private static _tarUtilityPromise;
+    private readonly _project;
+    private readonly _localBuildCacheProvider;
+    private readonly _cloudBuildCacheProvider;
+    private readonly _buildCacheEnabled;
+    private readonly _cacheWriteEnabled;
+    private readonly _projectOutputFolderNames;
+    private readonly _cacheId;
+    private constructor();
+    private static _tryGetTarUtility;
+    get cacheId(): string | undefined;
+    static getOperationBuildCache(options: _IProjectBuildCacheOptions): _OperationBuildCache;
+    static forOperation(executionResult: IOperationExecutionResult, options: _IOperationBuildCacheOptions): _OperationBuildCache;
+    tryRestoreFromCacheAsync(terminal: ITerminal, specifiedCacheId?: string): Promise<boolean>;
+    trySetCacheEntryAsync(terminal: ITerminal, specifiedCacheId?: string): Promise<boolean>;
+    /**
+     * Walks the declared output folders of the project and collects a list of files.
+     * @returns The list of output files as project-relative paths, or `undefined` if a
+     *   symbolic link was encountered.
+     */
+    private _tryCollectPathsToCacheAsync;
+    private _getTarLogFilePath;
+    private static _getCacheId;
+}
+
 /**
  * A helper class for managing the meta files of a operation.
  *

package/lib/index.d.ts

@@ -59,4 +59,6 @@ export type { IStopwatchResult } from './utilities/Stopwatch';
 export { OperationStateFile as _OperationStateFile, type IOperationStateFileOptions as _IOperationStateFileOptions, type IOperationStateJson as _IOperationStateJson } from './logic/operations/OperationStateFile';
 export { OperationMetadataManager as _OperationMetadataManager, type IOperationMetadataManagerOptions as _IOperationMetadataManagerOptions, type IOperationMetaData as _IOperationMetadata } from './logic/operations/OperationMetadataManager';
 export { RushCommandLine, type IRushCommandLineSpec, type IRushCommandLineParameter, type IRushCommandLineAction } from './api/RushCommandLine';
+export { OperationBuildCache as _OperationBuildCache } from './logic/buildCache/OperationBuildCache';
+export type { IOperationBuildCacheOptions as _IOperationBuildCacheOptions, IProjectBuildCacheOptions as _IProjectBuildCacheOptions } from './logic/buildCache/OperationBuildCache';
 //# sourceMappingURL=index.d.ts.map

package/lib/logic/CredentialCache.d.ts

@@ -11,6 +11,10 @@ export interface ICredentialCacheEntry {
  */
 export interface ICredentialCacheOptions {
     supportEditing: boolean;
+    /**
+     * If specified, use the specified path instead of the default path of `~/.rush-user/credentials.json`
+     */
+    cacheFilePath?: string;
 }
 /**
  * @beta

package/lib/logic/buildCache/{ProjectBuildCache.d.ts → OperationBuildCache.d.ts}

@@ -1,7 +1,10 @@
 import type { ITerminal } from '@rushstack/terminal';
 import type { RushConfigurationProject } from '../../api/RushConfigurationProject';
 import type { BuildCacheConfiguration } from '../../api/BuildCacheConfiguration';
-import type { OperationExecutionRecord } from '../operations/OperationExecutionRecord';
+import type { IOperationExecutionResult } from '../operations/IOperationExecutionResult';
+/**
+ * @internal
+ */
 export interface IOperationBuildCacheOptions {
     /**
      * The repo-wide configuration for the build cache.
@@ -12,6 +15,9 @@ export interface IOperationBuildCacheOptions {
      */
     terminal: ITerminal;
 }
+/**
+ * @internal
+ */
 export type IProjectBuildCacheOptions = IOperationBuildCacheOptions & {
     /**
      * Value from rush-project.json
@@ -30,7 +36,10 @@ export type IProjectBuildCacheOptions = IOperationBuildCacheOptions & {
      */
     phaseName: string;
 };
-export declare class ProjectBuildCache {
+/**
+ * @internal
+ */
+export declare class OperationBuildCache {
     private static _tarUtilityPromise;
     private readonly _project;
     private readonly _localBuildCacheProvider;
@@ -42,8 +51,8 @@ export declare class ProjectBuildCache {
     private constructor();
     private static _tryGetTarUtility;
     get cacheId(): string | undefined;
-    static getProjectBuildCache(options: IProjectBuildCacheOptions): ProjectBuildCache;
-    static forOperation(operation: OperationExecutionRecord, options: IOperationBuildCacheOptions): ProjectBuildCache;
+    static getOperationBuildCache(options: IProjectBuildCacheOptions): OperationBuildCache;
+    static forOperation(executionResult: IOperationExecutionResult, options: IOperationBuildCacheOptions): OperationBuildCache;
     tryRestoreFromCacheAsync(terminal: ITerminal, specifiedCacheId?: string): Promise<boolean>;
     trySetCacheEntryAsync(terminal: ITerminal, specifiedCacheId?: string): Promise<boolean>;
     /**
@@ -55,4 +64,4 @@ export declare class ProjectBuildCache {
     private _getTarLogFilePath;
     private static _getCacheId;
 }
-//# sourceMappingURL=ProjectBuildCache.d.ts.map
+//# sourceMappingURL=OperationBuildCache.d.ts.map

package/lib/logic/buildCache/{ProjectBuildCache.js → OperationBuildCache.js}

@@ -1 +1 @@
-module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("logic/buildCache/ProjectBuildCache");
+module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("logic/buildCache/OperationBuildCache");

package/lib/logic/cobuild/CobuildLock.d.ts

@@ -1,7 +1,7 @@
 import type { CobuildConfiguration } from '../../api/CobuildConfiguration';
 import type { OperationStatus } from '../operations/OperationStatus';
 import type { ICobuildContext } from './ICobuildLockProvider';
-import type { ProjectBuildCache } from '../buildCache/ProjectBuildCache';
+import type { OperationBuildCache } from '../buildCache/OperationBuildCache';
 export interface ICobuildLockOptions {
     /**
      * {@inheritdoc CobuildConfiguration}
@@ -19,7 +19,7 @@ export interface ICobuildLockOptions {
      * {@inheritdoc ICobuildContext.phaseName}
      */
     phaseName: string;
-    projectBuildCache: ProjectBuildCache;
+    operationBuildCache: OperationBuildCache;
     /**
      * The expire time of the lock in seconds.
      */
@@ -31,7 +31,7 @@ export interface ICobuildCompletedState {
 }
 export declare class CobuildLock {
     readonly cobuildConfiguration: CobuildConfiguration;
-    readonly projectBuildCache: ProjectBuildCache;
+    readonly operationBuildCache: OperationBuildCache;
     private _cobuildContext;
     constructor(options: ICobuildLockOptions);
     setCompletedStateAsync(state: ICobuildCompletedState): Promise<void>;

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

@@ -1,6 +1,6 @@
 import { type TerminalWritable, type ITerminal } from '@rushstack/terminal';
 import { CobuildLock } from '../cobuild/CobuildLock';
-import { ProjectBuildCache } from '../buildCache/ProjectBuildCache';
+import { OperationBuildCache } from '../buildCache/OperationBuildCache';
 import type { CobuildConfiguration } from '../../api/CobuildConfiguration';
 import { DisjointSet } from '../cobuild/DisjointSet';
 import { PeriodicCallback } from './PeriodicCallback';
@@ -16,7 +16,7 @@ export interface IProjectDeps {
 export interface IOperationBuildCacheContext {
     isCacheWriteAllowed: boolean;
     isCacheReadAllowed: boolean;
-    operationBuildCache: ProjectBuildCache | undefined;
+    operationBuildCache: OperationBuildCache | undefined;
     cacheDisabledReason: string | undefined;
     outputFolderNames: ReadonlyArray<string>;
     cobuildLock: CobuildLock | undefined;
@@ -40,8 +40,8 @@ export declare class CacheableOperationPlugin implements IPhasedCommandPlugin {
     apply(hooks: PhasedCommandHooks): void;
     private _getBuildCacheContextByOperation;
     private _getBuildCacheContextByOperationOrThrow;
-    private _tryGetProjectBuildCache;
-    private _tryGetLogOnlyProjectBuildCacheAsync;
+    private _tryGetOperationBuildCache;
+    private _tryGetLogOnlyOperationBuildCacheAsync;
     private _tryGetCobuildLockAsync;
     private _createBuildCacheTerminalAsync;
     private _tryGetBuildCacheTerminalWritableAsync;

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

@@ -11,6 +11,9 @@ import type { IOperationExecutionResult } from './IOperationExecutionResult';
 import type { IInputsSnapshot } from '../incremental/InputsSnapshot';
 import type { IEnvironment } from '../../utilities/Utilities';
 import { type ILogFilePaths } from './ProjectLogWritable';
+/**
+ * @internal
+ */
 export interface IOperationExecutionRecordContext {
     streamCollator: StreamCollator;
     onOperationStatusChanged?: (record: OperationExecutionRecord) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/rush-sdk",
-  "version": "5.153.2",
+  "version": "5.155.0",
   "description": "An API for interacting with the Rush engine",
   "repository": {
     "type": "git",
@@ -37,21 +37,21 @@
     "@pnpm/lockfile.types": "~1.0.3",
     "tapable": "2.2.1",
     "@rushstack/lookup-by-path": "0.7.0",
+    "@rushstack/package-deps-hash": "4.4.1",
     "@rushstack/node-core-library": "5.13.1",
-    "@rushstack/terminal": "0.15.3",
-    "@rushstack/package-deps-hash": "4.4.1"
+    "@rushstack/terminal": "0.15.3"
   },
   "devDependencies": {
     "@types/semver": "7.5.0",
     "@types/webpack-env": "1.18.8",
     "webpack": "~5.98.0",
-    "@microsoft/rush-lib": "5.153.2",
+    "@microsoft/rush-lib": "5.155.0",
     "@rushstack/heft": "0.73.6",
-    "local-node-rig": "1.0.0",
-    "@rushstack/heft-webpack5-plugin": "0.11.33",
     "@rushstack/stream-collator": "4.1.103",
-    "@rushstack/webpack-preserve-dynamic-require-plugin": "0.11.102",
-    "@rushstack/ts-command-line": "5.0.1"
+    "@rushstack/heft-webpack5-plugin": "0.11.33",
+    "@rushstack/ts-command-line": "5.0.1",
+    "local-node-rig": "1.0.0",
+    "@rushstack/webpack-preserve-dynamic-require-plugin": "0.11.102"
   },
   "scripts": {
     "build": "heft build --clean",