build-raptor-api 0.114.0 → 0.115.0

package/dist/src/build-raptor-api.d.ts

@@ -1,4 +1,8 @@
 import { z } from 'zod';
+/**
+ * Represents a union of possible build step types, discriminated by the 'step' field.
+ * Each step type contains specific information about different phases of the build process.
+ */
 export declare const Step: z.ZodDiscriminatedUnion<"step", [z.ZodObject<{
     step: z.ZodLiteral<"BUILD_RUN_STARTED">;
     buildRunId: z.ZodString;
@@ -86,6 +90,24 @@ export declare const Step: z.ZodDiscriminatedUnion<"step", [z.ZodObject<{
     testPath: string[];
     verdict: "TEST_PASSED" | "TEST_FAILED" | "TEST_CRASHED" | "TEST_TIMEDOUT";
     durationMillis?: number | undefined;
+}>, z.ZodObject<{
+    step: z.ZodLiteral<"TASK_ENDED">;
+    /** The fully qualified name of the task (e.g., 'my-module:build') */
+    taskName: z.ZodString;
+    /** The final verdict that represents whether the task succeeded or failed */
+    verdict: z.ZodUnion<[z.ZodLiteral<"OK">, z.ZodLiteral<"FAIL">, z.ZodLiteral<"CRASH">, z.ZodLiteral<"UNKNOWN">]>;
+    /** Indicates how the task was processed during the build run */
+    executionType: z.ZodUnion<[z.ZodLiteral<"EXECUTED">, z.ZodLiteral<"CACHED">, z.ZodLiteral<"CANNOT_START">, z.ZodLiteral<"UNKNOWN">]>;
+}, "strip", z.ZodTypeAny, {
+    step: "TASK_ENDED";
+    taskName: string;
+    verdict: "OK" | "FAIL" | "CRASH" | "UNKNOWN";
+    executionType: "UNKNOWN" | "EXECUTED" | "CACHED" | "CANNOT_START";
+}, {
+    step: "TASK_ENDED";
+    taskName: string;
+    verdict: "OK" | "FAIL" | "CRASH" | "UNKNOWN";
+    executionType: "UNKNOWN" | "EXECUTED" | "CACHED" | "CANNOT_START";
 }>, z.ZodObject<{
     step: z.ZodLiteral<"ASSET_PUBLISHED">;
     labels: z.ZodArray<z.ZodString, "many">;
@@ -135,7 +157,7 @@ export declare const Step: z.ZodDiscriminatedUnion<"step", [z.ZodObject<{
     step: z.ZodLiteral<"PUBLIC_FILES">;
     taskName: z.ZodString;
     /**
-     * Maps path-in-repo (of "public output" files) to the hash of the contnet of the file.
+     * Maps path-in-repo (of "public output" files) to the hash of the content of the file.
      */
     publicFiles: z.ZodRecord<z.ZodString, z.ZodString>;
 }, "strip", z.ZodTypeAny, {
@@ -239,6 +261,24 @@ export declare const StepByStep: z.ZodArray<z.ZodDiscriminatedUnion<"step", [z.Z
     testPath: string[];
     verdict: "TEST_PASSED" | "TEST_FAILED" | "TEST_CRASHED" | "TEST_TIMEDOUT";
     durationMillis?: number | undefined;
+}>, z.ZodObject<{
+    step: z.ZodLiteral<"TASK_ENDED">;
+    /** The fully qualified name of the task (e.g., 'my-module:build') */
+    taskName: z.ZodString;
+    /** The final verdict that represents whether the task succeeded or failed */
+    verdict: z.ZodUnion<[z.ZodLiteral<"OK">, z.ZodLiteral<"FAIL">, z.ZodLiteral<"CRASH">, z.ZodLiteral<"UNKNOWN">]>;
+    /** Indicates how the task was processed during the build run */
+    executionType: z.ZodUnion<[z.ZodLiteral<"EXECUTED">, z.ZodLiteral<"CACHED">, z.ZodLiteral<"CANNOT_START">, z.ZodLiteral<"UNKNOWN">]>;
+}, "strip", z.ZodTypeAny, {
+    step: "TASK_ENDED";
+    taskName: string;
+    verdict: "OK" | "FAIL" | "CRASH" | "UNKNOWN";
+    executionType: "UNKNOWN" | "EXECUTED" | "CACHED" | "CANNOT_START";
+}, {
+    step: "TASK_ENDED";
+    taskName: string;
+    verdict: "OK" | "FAIL" | "CRASH" | "UNKNOWN";
+    executionType: "UNKNOWN" | "EXECUTED" | "CACHED" | "CANNOT_START";
 }>, z.ZodObject<{
     step: z.ZodLiteral<"ASSET_PUBLISHED">;
     labels: z.ZodArray<z.ZodString, "many">;
@@ -288,7 +328,7 @@ export declare const StepByStep: z.ZodArray<z.ZodDiscriminatedUnion<"step", [z.Z
     step: z.ZodLiteral<"PUBLIC_FILES">;
     taskName: z.ZodString;
     /**
-     * Maps path-in-repo (of "public output" files) to the hash of the contnet of the file.
+     * Maps path-in-repo (of "public output" files) to the hash of the content of the file.
      */
     publicFiles: z.ZodRecord<z.ZodString, z.ZodString>;
 }, "strip", z.ZodTypeAny, {

package/dist/src/build-raptor-api.js

@@ -2,6 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StepByStep = exports.Step = void 0;
 const zod_1 = require("zod");
+/**
+ * Represents a union of possible build step types, discriminated by the 'step' field.
+ * Each step type contains specific information about different phases of the build process.
+ */
 exports.Step = zod_1.z.discriminatedUnion('step', [
     zod_1.z.object({
         step: zod_1.z.literal('BUILD_RUN_STARTED'),
@@ -42,6 +46,54 @@ exports.Step = zod_1.z.discriminatedUnion('step', [
             zod_1.z.literal('TEST_TIMEDOUT'),
         ]),
     }),
+    /**
+     * Indicates the completion of a build task. This step is emitted when a task either completes execution or is
+     * determined to be skippable due to caching.
+     *
+     * @example
+     * // Example of a successfully executed task
+     * {
+     *   step: 'TASK_ENDED',
+     *   taskName: 'webapp:build',
+     *   verdict: 'OK',
+     *   executionType: 'EXECUTED'
+     * }
+     *
+     * // Example of a skipped task due to cache hit
+     * {
+     *   step: 'TASK_ENDED',
+     *   taskName: 'webapp:test',
+     *   verdict: 'OK',
+     *   executionType: 'CACHED'
+     * }
+     */
+    zod_1.z.object({
+        step: zod_1.z.literal('TASK_ENDED'),
+        /** The fully qualified name of the task (e.g., 'my-module:build') */
+        taskName: zod_1.z.string(),
+        /** The final verdict that represents whether the task succeeded or failed */
+        verdict: zod_1.z.union([
+            /** Task executed and completed successfully */
+            zod_1.z.literal('OK'),
+            /** Task executed but failed with an error code */
+            zod_1.z.literal('FAIL'),
+            /** Task execution terminated unexpectedly (e.g., ran out of memory) */
+            zod_1.z.literal('CRASH'),
+            /** Task verdict is indeterminate due to an unexpected failure of the build system */
+            zod_1.z.literal('UNKNOWN'),
+        ]),
+        /** Indicates how the task was processed during the build run */
+        executionType: zod_1.z.union([
+            /** Task was executed in this build run */
+            zod_1.z.literal('EXECUTED'),
+            /** Task outputs were retrieved from cache without execution */
+            zod_1.z.literal('CACHED'),
+            /** Task could not be started (typically due to a 'FAIL' verdict in a dependency task) */
+            zod_1.z.literal('CANNOT_START'),
+            /** Execution type is indeterminate due to an unexpected failure of the build system */
+            zod_1.z.literal('UNKNOWN'),
+        ]),
+    }),
     zod_1.z.object({
         step: zod_1.z.literal('ASSET_PUBLISHED'),
         labels: zod_1.z.string().array(),
@@ -69,10 +121,10 @@ exports.Step = zod_1.z.discriminatedUnion('step', [
         step: zod_1.z.literal('PUBLIC_FILES'),
         taskName: zod_1.z.string(),
         /**
-         * Maps path-in-repo (of "public output" files) to the hash of the contnet of the file.
+         * Maps path-in-repo (of "public output" files) to the hash of the content of the file.
          */
         publicFiles: zod_1.z.record(zod_1.z.string(), zod_1.z.string()),
     }),
 ]);
 exports.StepByStep = exports.Step.array();
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYnVpbGQtcmFwdG9yLWFwaS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9idWlsZC1yYXB0b3ItYXBpLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBLDZCQUF1QjtBQUVWLFFBQUEsSUFBSSxHQUFHLE9BQUMsQ0FBQyxrQkFBa0IsQ0FBQyxNQUFNLEVBQUU7SUFDL0MsT0FBQyxDQUFDLE1BQU0sQ0FBQztRQUNQLElBQUksRUFBRSxPQUFDLENBQUMsT0FBTyxDQUFDLG1CQUFtQixDQUFDO1FBQ3BDLFVBQVUsRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFO1FBQ3RCLFVBQVUsRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFLENBQUMsUUFBUSxFQUFFO0tBQ2xDLENBQUM7SUFDRixPQUFDLENBQUMsTUFBTSxDQUFDO1FBQ1AsSUFBSSxFQUFFLE9BQUMsQ0FBQyxPQUFPLENBQUMsaUJBQWlCLENBQUM7S0FDbkMsQ0FBQztJQUNGLE9BQUMsQ0FBQyxNQUFNLENBQUM7UUFDUCxJQUFJLEVBQUUsT0FBQyxDQUFDLE9BQU8sQ0FBQyxnQkFBZ0IsQ0FBQztRQUNqQyxXQUFXLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRSxDQUFDLFFBQVEsRUFBRTtRQUNsQyxRQUFRLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRTtRQUNwQixNQUFNLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRTtRQUNsQixRQUFRLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRTtRQUNwQixNQUFNLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRTtRQUNsQixLQUFLLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRSxDQUFDLEtBQUssRUFBRTtLQUMxQixDQUFDO0lBQ0YsT0FBQyxDQUFDLE1BQU0sQ0FBQztRQUNQLElBQUksRUFBRSxPQUFDLENBQUMsT0FBTyxDQUFDLGdCQUFnQixDQUFDO1FBQ2pDLFdBQVcsRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFLENBQUMsUUFBUSxFQUFFO1FBQ2xDLFFBQVEsRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFO1FBQ3BCLE1BQU0sRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFO1FBQ2xCLFFBQVEsRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFO1FBQ3BCLE1BQU0sRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFO1FBQ2xCLEtBQUssRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFLENBQUMsS0FBSyxFQUFFO0tBQzFCLENBQUM7SUFDRixPQUFDLENBQUMsTUFBTSxDQUFDO1FBQ1AsSUFBSSxFQUFFLE9BQUMsQ0FBQyxPQUFPLENBQUMsWUFBWSxDQUFDO1FBQzdCLFFBQVEsRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFO1FBQ3BCLFFBQVEsRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFO1FBQ3BCLFFBQVEsRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFLENBQUMsS0FBSyxFQUFFO1FBQzVCLGNBQWMsRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFLENBQUMsRUFBRSxDQUFDLE9BQUMsQ0FBQyxTQUFTLEVBQUUsQ0FBQztRQUM1QyxPQUFPLEVBQUUsT0FBQyxDQUFDLEtBQUssQ0FBQztZQUNmLE9BQUMsQ0FBQyxPQUFPLENBQUMsYUFBYSxDQUFDO1lBQ3hCLE9BQUMsQ0FBQyxPQUFPLENBQUMsYUFBYSxDQUFDO1lBQ3hCLE9BQUMsQ0FBQyxPQUFPLENBQUMsY0FBYyxDQUFDO1lBQ3pCLE9BQUMsQ0FBQyxPQUFPLENBQUMsZUFBZSxDQUFDO1NBQzNCLENBQUM7S0FDSCxDQUFDO0lBQ0YsT0FBQyxDQUFDLE1BQU0sQ0FBQztRQUNQLElBQUksRUFBRSxPQUFDLENBQUMsT0FBTyxDQUFDLGlCQUFpQixDQUFDO1FBQ2xDLE1BQU0sRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFLENBQUMsS0FBSyxFQUFFO1FBQzFCLFFBQVEsRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFO1FBQ3BCLE1BQU0sRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFO1FBQ2xCLFFBQVEsRUFBRSxPQUFDLENBQUMsT0FBTyxFQUFFO1FBQ3JCLFdBQVcsRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFO1FBQ3ZCLFVBQVUsRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFO1FBQ3RCLElBQUksRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFO0tBQ2pCLENBQUM7SUFDRixPQUFDLENBQUMsTUFBTSxDQUFDO1FBQ1A7O1dBRUc7UUFDSCxJQUFJLEVBQUUsT0FBQyxDQUFDLE9BQU8sQ0FBQyxlQUFlLENBQUM7UUFDaEM7Ozs7O1dBS0c7UUFDSCxTQUFTLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRSxDQUFDLEtBQUssRUFBRTtLQUM5QixDQUFDO0lBQ0YsT0FBQyxDQUFDLE1BQU0sQ0FBQztRQUNQLElBQUksRUFBRSxPQUFDLENBQUMsT0FBTyxDQUFDLGNBQWMsQ0FBQztRQUMvQixRQUFRLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRTtRQUNwQjs7V0FFRztRQUNILFdBQVcsRUFBRSxPQUFDLENBQUMsTUFBTSxDQUFDLE9BQUMsQ0FBQyxNQUFNLEVBQUUsRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFLENBQUM7S0FDOUMsQ0FBQztDQUNILENBQUMsQ0FBQTtBQU9XLFFBQUEsVUFBVSxHQUFHLFlBQUksQ0FBQyxLQUFLLEVBQUUsQ0FBQSJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYnVpbGQtcmFwdG9yLWFwaS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9idWlsZC1yYXB0b3ItYXBpLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBLDZCQUF1QjtBQUV2Qjs7O0dBR0c7QUFDVSxRQUFBLElBQUksR0FBRyxPQUFDLENBQUMsa0JBQWtCLENBQUMsTUFBTSxFQUFFO0lBQy9DLE9BQUMsQ0FBQyxNQUFNLENBQUM7UUFDUCxJQUFJLEVBQUUsT0FBQyxDQUFDLE9BQU8sQ0FBQyxtQkFBbUIsQ0FBQztRQUNwQyxVQUFVLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRTtRQUN0QixVQUFVLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRSxDQUFDLFFBQVEsRUFBRTtLQUNsQyxDQUFDO0lBQ0YsT0FBQyxDQUFDLE1BQU0sQ0FBQztRQUNQLElBQUksRUFBRSxPQUFDLENBQUMsT0FBTyxDQUFDLGlCQUFpQixDQUFDO0tBQ25DLENBQUM7SUFDRixPQUFDLENBQUMsTUFBTSxDQUFDO1FBQ1AsSUFBSSxFQUFFLE9BQUMsQ0FBQyxPQUFPLENBQUMsZ0JBQWdCLENBQUM7UUFDakMsV0FBVyxFQUFFLE9BQUMsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxRQUFRLEVBQUU7UUFDbEMsUUFBUSxFQUFFLE9BQUMsQ0FBQyxNQUFNLEVBQUU7UUFDcEIsTUFBTSxFQUFFLE9BQUMsQ0FBQyxNQUFNLEVBQUU7UUFDbEIsUUFBUSxFQUFFLE9BQUMsQ0FBQyxNQUFNLEVBQUU7UUFDcEIsTUFBTSxFQUFFLE9BQUMsQ0FBQyxNQUFNLEVBQUU7UUFDbEIsS0FBSyxFQUFFLE9BQUMsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxLQUFLLEVBQUU7S0FDMUIsQ0FBQztJQUNGLE9BQUMsQ0FBQyxNQUFNLENBQUM7UUFDUCxJQUFJLEVBQUUsT0FBQyxDQUFDLE9BQU8sQ0FBQyxnQkFBZ0IsQ0FBQztRQUNqQyxXQUFXLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRSxDQUFDLFFBQVEsRUFBRTtRQUNsQyxRQUFRLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRTtRQUNwQixNQUFNLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRTtRQUNsQixRQUFRLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRTtRQUNwQixNQUFNLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRTtRQUNsQixLQUFLLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRSxDQUFDLEtBQUssRUFBRTtLQUMxQixDQUFDO0lBQ0YsT0FBQyxDQUFDLE1BQU0sQ0FBQztRQUNQLElBQUksRUFBRSxPQUFDLENBQUMsT0FBTyxDQUFDLFlBQVksQ0FBQztRQUM3QixRQUFRLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRTtRQUNwQixRQUFRLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRTtRQUNwQixRQUFRLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRSxDQUFDLEtBQUssRUFBRTtRQUM1QixjQUFjLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRSxDQUFDLEVBQUUsQ0FBQyxPQUFDLENBQUMsU0FBUyxFQUFFLENBQUM7UUFDNUMsT0FBTyxFQUFFLE9BQUMsQ0FBQyxLQUFLLENBQUM7WUFDZixPQUFDLENBQUMsT0FBTyxDQUFDLGFBQWEsQ0FBQztZQUN4QixPQUFDLENBQUMsT0FBTyxDQUFDLGFBQWEsQ0FBQztZQUN4QixPQUFDLENBQUMsT0FBTyxDQUFDLGNBQWMsQ0FBQztZQUN6QixPQUFDLENBQUMsT0FBTyxDQUFDLGVBQWUsQ0FBQztTQUMzQixDQUFDO0tBQ0gsQ0FBQztJQUNGOzs7Ozs7Ozs7Ozs7Ozs7Ozs7OztPQW9CRztJQUNILE9BQUMsQ0FBQyxNQUFNLENBQUM7UUFDUCxJQUFJLEVBQUUsT0FBQyxDQUFDLE9BQU8sQ0FBQyxZQUFZLENBQUM7UUFDN0IscUVBQXFFO1FBQ3JFLFFBQVEsRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFO1FBQ3BCLDZFQUE2RTtRQUM3RSxPQUFPLEVBQUUsT0FBQyxDQUFDLEtBQUssQ0FBQztZQUNmLCtDQUErQztZQUMvQyxPQUFDLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQztZQUNmLGtEQUFrRDtZQUNsRCxPQUFDLENBQUMsT0FBTyxDQUFDLE1BQU0sQ0FBQztZQUNqQix1RUFBdUU7WUFDdkUsT0FBQyxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUM7WUFDbEIscUZBQXFGO1lBQ3JGLE9BQUMsQ0FBQyxPQUFPLENBQUMsU0FBUyxDQUFDO1NBQ3JCLENBQUM7UUFDRixnRUFBZ0U7UUFDaEUsYUFBYSxFQUFFLE9BQUMsQ0FBQyxLQUFLLENBQUM7WUFDckIsMENBQTBDO1lBQzFDLE9BQUMsQ0FBQyxPQUFPLENBQUMsVUFBVSxDQUFDO1lBQ3JCLCtEQUErRDtZQUMvRCxPQUFDLENBQUMsT0FBTyxDQUFDLFFBQVEsQ0FBQztZQUNuQix5RkFBeUY7WUFDekYsT0FBQyxDQUFDLE9BQU8sQ0FBQyxjQUFjLENBQUM7WUFDekIsdUZBQXVGO1lBQ3ZGLE9BQUMsQ0FBQyxPQUFPLENBQUMsU0FBUyxDQUFDO1NBQ3JCLENBQUM7S0FDSCxDQUFDO0lBQ0YsT0FBQyxDQUFDLE1BQU0sQ0FBQztRQUNQLElBQUksRUFBRSxPQUFDLENBQUMsT0FBTyxDQUFDLGlCQUFpQixDQUFDO1FBQ2xDLE1BQU0sRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFLENBQUMsS0FBSyxFQUFFO1FBQzFCLFFBQVEsRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFO1FBQ3BCLE1BQU0sRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFO1FBQ2xCLFFBQVEsRUFBRSxPQUFDLENBQUMsT0FBTyxFQUFFO1FBQ3JCLFdBQVcsRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFO1FBQ3ZCLFVBQVUsRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFO1FBQ3RCLElBQUksRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFO0tBQ2pCLENBQUM7SUFDRixPQUFDLENBQUMsTUFBTSxDQUFDO1FBQ1A7O1dBRUc7UUFDSCxJQUFJLEVBQUUsT0FBQyxDQUFDLE9BQU8sQ0FBQyxlQUFlLENBQUM7UUFDaEM7Ozs7O1dBS0c7UUFDSCxTQUFTLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRSxDQUFDLEtBQUssRUFBRTtLQUM5QixDQUFDO0lBQ0YsT0FBQyxDQUFDLE1BQU0sQ0FBQztRQUNQLElBQUksRUFBRSxPQUFDLENBQUMsT0FBTyxDQUFDLGNBQWMsQ0FBQztRQUMvQixRQUFRLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRTtRQUNwQjs7V0FFRztRQUNILFdBQVcsRUFBRSxPQUFDLENBQUMsTUFBTSxDQUFDLE9BQUMsQ0FBQyxNQUFNLEVBQUUsRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFLENBQUM7S0FDOUMsQ0FBQztDQUNILENBQUMsQ0FBQTtBQU9XLFFBQUEsVUFBVSxHQUFHLFlBQUksQ0FBQyxLQUFLLEVBQUUsQ0FBQSJ9

package/dist/src/step-by-step-processor.d.ts

@@ -1,22 +1,35 @@
 import { Step } from './build-raptor-api';
 /**
  * StepByStepProcessor is a function type for processing build steps in real-time.
+ * Each step's details are passed to your processor as it occurs during the build.
  *
  * To use with build-raptor:
- * 1. Create a Node.js module that exports a function of this type.
- * 2. Import the necessary types from 'build-raptor-api'.
- * 3. Implement the processing logic.
- * 4. Export the function as 'processor'.
+ * 1. Create a file that imports the necessary types from 'build-raptor-api'
+ * 2. Implement and export a function called `processor` matching the `StepByStepProcessor` type
+ * 3. The function can be async or sync and should handle the `Step` object according to your needs
  *
- * Example implementation:
+ * ## Example Implementation (my-step-processor.ts)
  * ```typescript
  * import { Step, StepByStepProcessor } from 'build-raptor-api'
- * export const processor: StepByStepProcessor = (step: Step) => {
- *   console.log(`Processing step: ${JSON.stringify(step)}`)
+ *
+ * export const processor: StepByStepProcessor = async (step: Step) => {
+ *   // Log step details
+ *   console.log(`Step "${step.name}" status: ${step.status}`)
+ *
+ *   // Send metrics to monitoring system
+ *   await sendMetrics({
+ *     stepName: step.name,
+ *     duration: step.duration,
+ *     status: step.status
+ *   })
  * }
  * ```
  *
- * Usage: Provide the path to your module as an argument to build-raptor's
- * --step-by-step-processor command-line option.
+ * ## Usage
+ * To make build-raptor use your own processor:
+ *
+ * ```bash
+ * build-raptor --step-by-step-processor ./path/to/my-step-processor.js
+ * ```
  */
 export declare type StepByStepProcessor = (step: Step) => void | Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "build-raptor-api",
-  "version": "0.114.0",
+  "version": "0.115.0",
   "description": "",
   "keywords": [],
   "author": "",