@rushstack/rush-sdk 5.68.2 → 5.71.0

package/dist/rush-lib.d.ts

@@ -225,7 +225,6 @@ export declare class CommonVersionsConfiguration {
     private _filePath;
     private _preferredVersions;
     private _implicitlyPreferredVersions;
-    private _xstitchPreferredVersions;
     private _allowedAlternativeVersions;
     private _modified;
     private constructor();
@@ -272,15 +271,6 @@ export declare class CommonVersionsConfiguration {
      * If the value is `undefined`, then the default value is `true`.
      */
     get implicitlyPreferredVersions(): boolean | undefined;
-    /**
-     * A table of specifies preferred versions maintained by the XStitch tool.
-     *
-     * @remarks
-     * This property has the same behavior as the "preferredVersions" property, except these entries
-     * are automatically managed by the XStitch tool.  It is an error for the same dependency name
-     * to appear in both tables.
-     */
-    get xstitchPreferredVersions(): Map<string, string>;
     /**
      * A table that stores, for a given dependency, a list of SemVer ranges that will be accepted
      * by "rush check" in addition to the normal version range.
@@ -295,7 +285,7 @@ export declare class CommonVersionsConfiguration {
      */
     get allowedAlternativeVersions(): Map<string, ReadonlyArray<string>>;
     /**
-     * Returns the union of preferredVersions and xstitchPreferredVersions.
+     * Returns preferredVersions.
      */
     getAllPreferredVersions(): Map<string, string>;
     private _onSetPreferredVersions;
@@ -779,6 +769,11 @@ export declare interface ICreateOperationsContext {
      * The set of Rush projects selected for the current command execution.
      */
     readonly projectSelection: ReadonlySet<RushConfigurationProject>;
+    /**
+     * The set of Rush projects that have not been built in the current process since they were last modified.
+     * When `isInitial` is true, this will be an exact match of `projectSelection`.
+     */
+    readonly projectsInUnknownState: ReadonlySet<RushConfigurationProject>;
     /**
      * The Rush configuration
      */
@@ -822,6 +817,21 @@ declare interface IEventHooksJson {
     postRushBuild?: string[];
 }
 
+/**
+ * The `IExecutionResult` interface represents the results of executing a set of {@link Operation}s.
+ * @alpha
+ */
+export declare interface IExecutionResult {
+    /**
+     * The results for each scheduled operation.
+     */
+    readonly operationResults: ReadonlyMap<Operation, IOperationExecutionResult>;
+    /**
+     * The overall result.
+     */
+    readonly status: OperationStatus;
+}
+
 /**
  * This interface represents the raw experiments.json file which allows repo
  * maintainers to enable and disable experimental Rush features.
@@ -1029,6 +1039,33 @@ export declare class IndividualVersionPolicy extends VersionPolicy {
 export declare interface _INpmOptionsJson extends IPackageManagerOptionsJsonBase {
 }
 
+/**
+ * The `IOperationExecutionResult` interface represents the results of executing an {@link Operation}.
+ * @alpha
+ */
+export declare interface IOperationExecutionResult {
+    /**
+     * The current execution status of an operation. Operations start in the 'ready' state,
+     * but can be 'blocked' if an upstream operation failed. It is 'executing' when
+     * the operation is executing. Once execution is complete, it is either 'success' or
+     * 'failure'.
+     */
+    readonly status: OperationStatus;
+    /**
+     * The error which occurred while executing this operation, this is stored in case we need
+     * it later (for example to re-print errors at end of execution).
+     */
+    readonly error: Error | undefined;
+    /**
+     * Object tracking execution timing.
+     */
+    readonly stopwatch: IStopwatchResult;
+    /**
+     * Object used to report a summary at the end of the Rush invocation.
+     */
+    readonly stdioSummarizer: StdioSummarizer;
+}
+
 /**
  * Options for constructing a new Operation.
  * @alpha
@@ -1364,6 +1401,29 @@ declare interface IRushVariantOptionsJson {
     description: string;
 }
 
+/**
+ * Represents a readonly view of a `Stopwatch`.
+ * @alpha
+ */
+export declare interface IStopwatchResult {
+    /**
+     * Displays how long the stopwatch has been executing in a human readable format.
+     */
+    toString(): string;
+    /**
+     * Get the duration in seconds.
+     */
+    get duration(): number;
+    /**
+     * Return the start time of the most recent stopwatch run.
+     */
+    get startTime(): number | undefined;
+    /**
+     * Return the end time of the most recent stopwatch run.
+     */
+    get endTime(): number | undefined;
+}
+
 /**
  * @beta
  */
@@ -1397,7 +1457,7 @@ export declare interface ITelemetryData {
      */
     readonly rushVersion?: string;
     readonly extraData?: {
-        [key: string]: string;
+        [key: string]: string | number | boolean;
     };
 }
 
@@ -1671,10 +1731,14 @@ export declare class Operation {
      * The Rush project associated with this Operation, if any
      */
     readonly associatedProject: RushConfigurationProject | undefined;
+    /**
+     * A set of all operations which depend on this operation.
+     */
+    readonly consumers: ReadonlySet<Operation>;
     /**
      * A set of all dependencies which must be executed before this operation is complete.
      */
-    readonly dependencies: Set<Operation>;
+    readonly dependencies: ReadonlySet<Operation>;
     /**
      * When the scheduler is ready to process this `Operation`, the `runner` implements the actual work of
      * running the operation.
@@ -1697,6 +1761,14 @@ export declare class Operation {
      * The name of this operation, for logging.
      */
     get name(): string | undefined;
+    /**
+     * Adds the specified operation as a dependency and updates the consumer list.
+     */
+    addDependency(dependency: Operation): void;
+    /**
+     * Deletes the specified operation as a dependency and updates the consumer list.
+     */
+    deleteDependency(dependency: Operation): void;
 }
 
 /**
@@ -1865,6 +1937,12 @@ export declare class PhasedCommandHooks {
      * Use the context to distinguish between the initial run and phased runs.
      */
     readonly createOperations: AsyncSeriesWaterfallHook<[Set<Operation>, ICreateOperationsContext]>;
+    /**
+     * Hook invoked after executing a set of operations.
+     * Use the context to distinguish between the initial run and phased runs.
+     * Hook is series for stable output.
+     */
+    readonly afterExecuteOperations: AsyncSeriesHook<[IExecutionResult, ICreateOperationsContext]>;
     /**
      * Hook invoked after a run has finished and the command is watching for changes.
      * May be used to display additional relevant data to the user.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/rush-sdk",
-  "version": "5.68.2",
+  "version": "5.71.0",
   "description": "An API for interacting with the Rush engine",
   "repository": {
     "type": "git",
@@ -12,18 +12,18 @@
   "typings": "dist/rush-lib.d.ts",
   "license": "MIT",
   "dependencies": {
-    "@rushstack/node-core-library": "3.45.4",
+    "@rushstack/node-core-library": "3.45.5",
     "@types/node-fetch": "1.6.9",
     "tapable": "2.2.1"
   },
   "devDependencies": {
-    "@microsoft/rush-lib": "5.68.2",
+    "@microsoft/rush-lib": "5.71.0",
     "@rushstack/eslint-config": "2.6.0",
-    "@rushstack/heft": "0.45.1",
-    "@rushstack/heft-node-rig": "1.9.2",
-    "@rushstack/stream-collator": "4.0.171",
-    "@rushstack/ts-command-line": "4.10.10",
-    "@rushstack/terminal": "0.3.40",
+    "@rushstack/heft": "0.45.5",
+    "@rushstack/heft-node-rig": "1.9.6",
+    "@rushstack/stream-collator": "4.0.175",
+    "@rushstack/ts-command-line": "4.11.0",
+    "@rushstack/terminal": "0.3.44",
     "@types/heft-jest": "1.0.1",
     "@types/semver": "7.3.5",
     "@types/webpack-env": "1.13.0"