@rushstack/rush-sdk 5.69.0 → 5.74.0

package/dist/rush-lib.d.ts

@@ -817,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.
@@ -943,6 +958,10 @@ export declare interface ILaunchOptions {
      * @internal
      */
     builtInPluginConfigurations?: _IBuiltInPluginConfiguration[];
+    /**
+     * Used to specify terminal how to write a message
+     */
+    terminalProvider?: ITerminalProvider;
 }
 
 /**
@@ -1024,6 +1043,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
@@ -1359,6 +1405,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
  */
@@ -1392,7 +1461,7 @@ export declare interface ITelemetryData {
      */
     readonly rushVersion?: string;
     readonly extraData?: {
-        [key: string]: string;
+        [key: string]: string | number | boolean;
     };
 }
 
@@ -1872,6 +1941,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.
@@ -2067,8 +2142,6 @@ export declare class Rush {
      * Third-party tools should not use this API.  Instead, they should execute the "rush" binary
      * and start a new Node.js process.
      *
-     * @param launcherVersion - The version of the `@microsoft/rush` wrapper used to call invoke the CLI.
-     *
      * @remarks
      * Earlier versions of the rush frontend used a different API contract. In the old contract,
      * the second argument was the `isManaged` value of the {@link ILaunchOptions} object.
@@ -2080,10 +2153,14 @@ export declare class Rush {
      * This API is used by the `@microsoft/rush` front end to launch the "rushx" command-line.
      * Third-party tools should not use this API.  Instead, they should execute the "rushx" binary
      * and start a new Node.js process.
-     *
-     * @param launcherVersion - The version of the `@microsoft/rush` wrapper used to call invoke the CLI.
      */
     static launchRushX(launcherVersion: string, options: ILaunchOptions): void;
+    /**
+     * This API is used by the `@microsoft/rush` front end to launch the "rush-pnpm" command-line.
+     * Third-party tools should not use this API.  Instead, they should execute the "rush-pnpm" binary
+     * and start a new Node.js process.
+     */
+    static launchRushPnpm(launcherVersion: string, options: ILaunchOptions): void;
     /**
      * The currently executing version of the "rush-lib" library.
      * This is the same as the Rush tool version for that release.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/rush-sdk",
-  "version": "5.69.0",
+  "version": "5.74.0",
   "description": "An API for interacting with the Rush engine",
   "repository": {
     "type": "git",
@@ -17,13 +17,13 @@
     "tapable": "2.2.1"
   },
   "devDependencies": {
-    "@microsoft/rush-lib": "5.69.0",
+    "@microsoft/rush-lib": "5.74.0",
     "@rushstack/eslint-config": "2.6.0",
-    "@rushstack/heft": "0.45.2",
-    "@rushstack/heft-node-rig": "1.9.3",
-    "@rushstack/stream-collator": "4.0.172",
+    "@rushstack/heft": "0.45.6",
+    "@rushstack/heft-node-rig": "1.9.7",
+    "@rushstack/stream-collator": "4.0.176",
     "@rushstack/ts-command-line": "4.11.0",
-    "@rushstack/terminal": "0.3.41",
+    "@rushstack/terminal": "0.3.45",
     "@types/heft-jest": "1.0.1",
     "@types/semver": "7.3.5",
     "@types/webpack-env": "1.13.0"