@veruna/api-contracts 20.0.0 → 20.2.0

package/build/v1/message/schemas/step-card.enums.js

@@ -1,13 +1,44 @@
 "use strict";
+/**
+ * Pieces shared by every server-emitted card that hangs under an answer.
+ *
+ * They live apart from any one card because all three step types use them —
+ * BUDGET_PROMO, CAPABILITY_LOCKED and FILE_TRUNCATED. Naming them after one of
+ * those (as `BudgetPromoCta` did) is the same lie the split exists to remove:
+ * a card about a locked tool has nothing to do with a budget.
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CardMessageKey = exports.CardCta = void 0;
+/** The single action the card offers. Absent on purely informational cards. */
 var CardCta;
 (function (CardCta) {
+    /** Unregistered users — promote a free signup with starter tokens. */
     CardCta["REGISTER"] = "REGISTER";
+    /** Registered users — promote a balance top-up. */
     CardCta["TOPUP"] = "TOPUP";
+    /**
+     * Registered users whose PLAN lacks the tool. Money is not the blocker, so
+     * a topup button would take them to a screen that cannot unlock anything.
+     */
     CardCta["UPGRADE"] = "UPGRADE";
+    /**
+     * The tool is already theirs and simply switched off. Neither money nor a
+     * plan stands in the way, so the button opens the tool picker — sending
+     * this person to a paywall would be asking them to buy what they own.
+     */
     CardCta["ENABLE"] = "ENABLE";
 })(CardCta || (exports.CardCta = CardCta = {}));
+/**
+ * Stable identifier the server stamps on a card so the frontend (or i18n layer)
+ * can pick localized copy without re-deriving it from the structural fields.
+ *
+ * The prefix is the STEP TYPE the key belongs to, so a key names its own card
+ * without anyone having to look up which union it came from.
+ *
+ * Frontend treats unknown values as "fall back to the default copy derived from
+ * the structural fields" so a future server adding a key doesn't crash old
+ * clients.
+ */
 var CardMessageKey;
 (function (CardMessageKey) {
     CardMessageKey["DISCOUNT_APPLIED_REGISTER"] = "BUDGET_PROMO.DISCOUNT_APPLIED.REGISTER";
@@ -18,7 +49,15 @@ var CardMessageKey;
     CardMessageKey["CAPABILITY_LOCKED_UPGRADE"] = "CAPABILITY_LOCKED.UPGRADE";
     CardMessageKey["CAPABILITY_LOCKED_ENABLE"] = "CAPABILITY_LOCKED.ENABLE";
     CardMessageKey["FILE_TRUNCATED"] = "FILE_TRUNCATED";
+    /** Guest CTA: «Продолжить разбор», without promising a complete read. */
     CardMessageKey["FILE_TRUNCATED_REGISTER"] = "FILE_TRUNCATED.REGISTER";
+    /**
+     * Nothing at all reached the model — the document failed to convert.
+     *
+     * Its own key, and never a CTA: an account does not repair a broken
+     * conversion, so offering one here sells a fix that does not exist. The
+     * honest ask is to try the file again.
+     */
     CardMessageKey["FILE_TRUNCATED_UNREADABLE"] = "FILE_TRUNCATED.UNREADABLE";
 })(CardMessageKey || (exports.CardMessageKey = CardMessageKey = {}));
 //# sourceMappingURL=step-card.enums.js.map

package/build/v1/message/schemas/step-card.enums.js.map

@@ -1 +1 @@
-{"version":3,"file":"step-card.enums.js","sourceRoot":"","sources":["../../../../v1/message/schemas/step-card.enums.ts"],"names":[],"mappings":";;;AAUA,IAAY,OAgBX;AAhBD,WAAY,OAAO;IAEf,gCAAqB,CAAA;IAErB,0BAAe,CAAA;IAKf,8BAAmB,CAAA;IAMnB,4BAAiB,CAAA;AACrB,CAAC,EAhBW,OAAO,uBAAP,OAAO,QAgBlB;AAaD,IAAY,cAmBX;AAnBD,WAAY,cAAc;IACtB,sFAAoE,CAAA;IACpE,gFAA8D,CAAA;IAC9D,gFAA8D,CAAA;IAC9D,0EAAwD,CAAA;IACxD,2EAAyD,CAAA;IACzD,yEAAuD,CAAA;IACvD,uEAAqD,CAAA;IACrD,mDAAiC,CAAA;IAEjC,qEAAmD,CAAA;IAQnD,yEAAuD,CAAA;AAC3D,CAAC,EAnBW,cAAc,8BAAd,cAAc,QAmBzB"}
+{"version":3,"file":"step-card.enums.js","sourceRoot":"","sources":["../../../../v1/message/schemas/step-card.enums.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;;AAEH,+EAA+E;AAC/E,IAAY,OAgBX;AAhBD,WAAY,OAAO;IACf,sEAAsE;IACtE,gCAAqB,CAAA;IACrB,mDAAmD;IACnD,0BAAe,CAAA;IACf;;;OAGG;IACH,8BAAmB,CAAA;IACnB;;;;OAIG;IACH,4BAAiB,CAAA;AACrB,CAAC,EAhBW,OAAO,uBAAP,OAAO,QAgBlB;AAED;;;;;;;;;;GAUG;AACH,IAAY,cAmBX;AAnBD,WAAY,cAAc;IACtB,sFAAoE,CAAA;IACpE,gFAA8D,CAAA;IAC9D,gFAA8D,CAAA;IAC9D,0EAAwD,CAAA;IACxD,2EAAyD,CAAA;IACzD,yEAAuD,CAAA;IACvD,uEAAqD,CAAA;IACrD,mDAAiC,CAAA;IACjC,yEAAyE;IACzE,qEAAmD,CAAA;IACnD;;;;;;OAMG;IACH,yEAAuD,CAAA;AAC3D,CAAC,EAnBW,cAAc,8BAAd,cAAc,QAmBzB"}

package/build/v1/message/schemas/step-chunk-kind.enum.d.ts

@@ -1,3 +1,15 @@
+/**
+ * Discriminator for STEP_CHUNK metadata shapes.
+ *
+ * - `ARGS` — emitted WHILE the LLM is still streaming tool-call JSON
+ *   arguments. The intent's `chunk` field carries the streamed text; the
+ *   primitive widget on the UI accumulates it live.
+ * - `DESCRIBE` — emitted ONCE by the step-lifecycle middleware when no
+ *   pre-assigned stepId exists (cold-start path). Carries the finalized
+ *   "describe-code" summary text on `chunk`.
+ * - The rest are emitted by specific sandbox primitives with rich payloads
+ *   for GitHub-style UX.
+ */
 export declare enum StepChunkKind {
     ARGS = "ARGS",
     DESCRIBE = "DESCRIBE",

package/build/v1/message/schemas/step-chunk-kind.enum.js

@@ -1,6 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StepChunkKind = void 0;
+/**
+ * Discriminator for STEP_CHUNK metadata shapes.
+ *
+ * - `ARGS` — emitted WHILE the LLM is still streaming tool-call JSON
+ *   arguments. The intent's `chunk` field carries the streamed text; the
+ *   primitive widget on the UI accumulates it live.
+ * - `DESCRIBE` — emitted ONCE by the step-lifecycle middleware when no
+ *   pre-assigned stepId exists (cold-start path). Carries the finalized
+ *   "describe-code" summary text on `chunk`.
+ * - The rest are emitted by specific sandbox primitives with rich payloads
+ *   for GitHub-style UX.
+ */
 var StepChunkKind;
 (function (StepChunkKind) {
     StepChunkKind["ARGS"] = "ARGS";

package/build/v1/message/schemas/step-chunk-kind.enum.js.map

@@ -1 +1 @@
-{"version":3,"file":"step-chunk-kind.enum.js","sourceRoot":"","sources":["../../../../v1/message/schemas/step-chunk-kind.enum.ts"],"names":[],"mappings":";;;AAYA,IAAY,aAOX;AAPD,WAAY,aAAa;IACrB,8BAAa,CAAA;IACb,sCAAqB,CAAA;IACrB,8BAAa,CAAA;IACb,4CAA2B,CAAA;IAC3B,4CAA2B,CAAA;IAC3B,8BAAa,CAAA;AACjB,CAAC,EAPW,aAAa,6BAAb,aAAa,QAOxB"}
+{"version":3,"file":"step-chunk-kind.enum.js","sourceRoot":"","sources":["../../../../v1/message/schemas/step-chunk-kind.enum.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;GAWG;AACH,IAAY,aAOX;AAPD,WAAY,aAAa;IACrB,8BAAa,CAAA;IACb,sCAAqB,CAAA;IACrB,8BAAa,CAAA;IACb,4CAA2B,CAAA;IAC3B,4CAA2B,CAAA;IAC3B,8BAAa,CAAA;AACjB,CAAC,EAPW,aAAa,6BAAb,aAAa,QAOxB"}

package/build/v1/message/schemas/step-chunk-metadata.schema.d.ts

@@ -2,20 +2,63 @@ import { z } from 'zod';
 import { SandboxPrimitiveType } from '../../tool/sandbox/sandbox-primitive-type.enum';
 import { StepChunkKind } from './step-chunk-kind.enum';
 import { BashChunkStream } from './bash-chunk-stream.enum';
+/**
+ * Per-line wire cap. Re-exported from the sandbox layer so existing call
+ * sites keep their symbol; single source of truth lives in
+ * `primitive-completion.schema.ts`.
+ */
 export declare const STEP_CHUNK_LINE_MAX_LENGTH = 4096;
+/**
+ * Absolute line-array cap on the wire. Same source of truth.
+ */
 export declare const STEP_CHUNK_LINES_MAX_ITEMS = 1024;
+/**
+ * ARGS chunk — live tool-call argument streaming.
+ *
+ * The primitive is not yet running. The chunk text on the enclosing intent
+ * is a partial / streaming slice of the argument field being assembled (the
+ * LLM is still typing). The UI attributes each delta to the right primitive
+ * widget via `primitiveType`.
+ *
+ * The argument text is carried on the intent's `chunk` field, NOT here.
+ */
 export declare const ArgsChunkMetadataSchema: z.ZodObject<{
     kind: z.ZodLiteral<StepChunkKind.ARGS>;
     primitiveType: z.ZodEnum<typeof SandboxPrimitiveType>;
 }, z.core.$strip>;
+/**
+ * DESCRIBE chunk — finalized describe-code summary.
+ *
+ * Emitted exactly once per step, at step open, by the pipeline middleware
+ * for primitives that did NOT get a pre-assigned stepId (i.e. the LLM did
+ * not stream arguments live — the tool call arrived in one shot). The chunk
+ * text on the enclosing intent is the already-finalized one-line code
+ * summary (e.g. `bash ls -la`, `create_file /home/user/app.py`).
+ *
+ * Mutually exclusive with ARGS on the same stepId.
+ */
 export declare const DescribeChunkMetadataSchema: z.ZodObject<{
     kind: z.ZodLiteral<StepChunkKind.DESCRIBE>;
     primitiveType: z.ZodEnum<typeof SandboxPrimitiveType>;
 }, z.core.$strip>;
+/**
+ * BASH chunk — one line of sandbox bash output. Emitted many times per
+ * step while the command runs, plus a final chunk if the buffer overflowed
+ * or output was truncated.
+ *
+ * The line text is on the intent's `chunk` field.
+ */
 export declare const BashChunkMetadataSchema: z.ZodObject<{
     kind: z.ZodLiteral<StepChunkKind.BASH>;
     stream: z.ZodEnum<typeof BashChunkStream>;
 }, z.core.$strip>;
+/**
+ * CREATE_FILE chunk — emitted once after a successful write. Carries the
+ * information the UI needs to render a GitHub-style "files added" card.
+ * Inner payload (path/preview/…) is shared with the persisted
+ * `CreateFileCompletion` on the step content, so live card and history
+ * card render from the same shape.
+ */
 export declare const CreateFileChunkMetadataSchema: z.ZodObject<{
     kind: z.ZodLiteral<StepChunkKind.CREATE_FILE>;
     path: z.ZodString;
@@ -27,6 +70,10 @@ export declare const CreateFileChunkMetadataSchema: z.ZodObject<{
         truncated: z.ZodBoolean;
     }, z.core.$strip>;
 }, z.core.$strip>;
+/**
+ * STR_REPLACE chunk — emitted once after a successful single-occurrence
+ * replace. Same shape as the persisted `StrReplaceCompletion`.
+ */
 export declare const StrReplaceChunkMetadataSchema: z.ZodObject<{
     kind: z.ZodLiteral<StepChunkKind.STR_REPLACE>;
     path: z.ZodString;
@@ -43,6 +90,14 @@ export declare const StrReplaceChunkMetadataSchema: z.ZodObject<{
         truncated: z.ZodBoolean;
     }, z.core.$strip>;
 }, z.core.$strip>;
+/**
+ * VIEW chunk — emitted once per successful view operation. The `view`
+ * payload is the same shape persisted on `ViewCompletion`.
+ *
+ * Actual content (directory entries, file text slice, image URL) lands on
+ * the STEP_DONE `content` payload or separate ATTACHMENT_READY intents —
+ * this chunk only carries header/metadata for the live card.
+ */
 export declare const ViewChunkMetadataSchema: z.ZodObject<{
     kind: z.ZodLiteral<StepChunkKind.VIEW>;
     path: z.ZodString;
@@ -62,6 +117,10 @@ export declare const ViewChunkMetadataSchema: z.ZodObject<{
         pagesShown: z.ZodNumber;
     }, z.core.$strip>], "type">;
 }, z.core.$strip>;
+/**
+ * Discriminated union of every possible STEP_CHUNK metadata shape. The
+ * frontend narrows on `metadata.kind` and renders accordingly.
+ */
 export declare const StepChunkMetadataSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
     kind: z.ZodLiteral<StepChunkKind.ARGS>;
     primitiveType: z.ZodEnum<typeof SandboxPrimitiveType>;

package/build/v1/message/schemas/step-chunk-metadata.schema.js

@@ -6,20 +6,63 @@ const primitive_completion_schema_1 = require("../../tool/sandbox/primitive-comp
 const sandbox_primitive_type_enum_1 = require("../../tool/sandbox/sandbox-primitive-type.enum");
 const step_chunk_kind_enum_1 = require("./step-chunk-kind.enum");
 const bash_chunk_stream_enum_1 = require("./bash-chunk-stream.enum");
+/**
+ * Per-line wire cap. Re-exported from the sandbox layer so existing call
+ * sites keep their symbol; single source of truth lives in
+ * `primitive-completion.schema.ts`.
+ */
 exports.STEP_CHUNK_LINE_MAX_LENGTH = primitive_completion_schema_1.SANDBOX_CHUNK_LINE_MAX_LENGTH;
+/**
+ * Absolute line-array cap on the wire. Same source of truth.
+ */
 exports.STEP_CHUNK_LINES_MAX_ITEMS = primitive_completion_schema_1.SANDBOX_CHUNK_LINES_MAX_ITEMS;
+/**
+ * ARGS chunk — live tool-call argument streaming.
+ *
+ * The primitive is not yet running. The chunk text on the enclosing intent
+ * is a partial / streaming slice of the argument field being assembled (the
+ * LLM is still typing). The UI attributes each delta to the right primitive
+ * widget via `primitiveType`.
+ *
+ * The argument text is carried on the intent's `chunk` field, NOT here.
+ */
 exports.ArgsChunkMetadataSchema = zod_1.z.object({
     kind: zod_1.z.literal(step_chunk_kind_enum_1.StepChunkKind.ARGS),
     primitiveType: zod_1.z.enum(sandbox_primitive_type_enum_1.SandboxPrimitiveType),
 });
+/**
+ * DESCRIBE chunk — finalized describe-code summary.
+ *
+ * Emitted exactly once per step, at step open, by the pipeline middleware
+ * for primitives that did NOT get a pre-assigned stepId (i.e. the LLM did
+ * not stream arguments live — the tool call arrived in one shot). The chunk
+ * text on the enclosing intent is the already-finalized one-line code
+ * summary (e.g. `bash ls -la`, `create_file /home/user/app.py`).
+ *
+ * Mutually exclusive with ARGS on the same stepId.
+ */
 exports.DescribeChunkMetadataSchema = zod_1.z.object({
     kind: zod_1.z.literal(step_chunk_kind_enum_1.StepChunkKind.DESCRIBE),
     primitiveType: zod_1.z.enum(sandbox_primitive_type_enum_1.SandboxPrimitiveType),
 });
+/**
+ * BASH chunk — one line of sandbox bash output. Emitted many times per
+ * step while the command runs, plus a final chunk if the buffer overflowed
+ * or output was truncated.
+ *
+ * The line text is on the intent's `chunk` field.
+ */
 exports.BashChunkMetadataSchema = zod_1.z.object({
     kind: zod_1.z.literal(step_chunk_kind_enum_1.StepChunkKind.BASH),
     stream: zod_1.z.enum(bash_chunk_stream_enum_1.BashChunkStream),
 });
+/**
+ * CREATE_FILE chunk — emitted once after a successful write. Carries the
+ * information the UI needs to render a GitHub-style "files added" card.
+ * Inner payload (path/preview/…) is shared with the persisted
+ * `CreateFileCompletion` on the step content, so live card and history
+ * card render from the same shape.
+ */
 exports.CreateFileChunkMetadataSchema = zod_1.z.object({
     kind: zod_1.z.literal(step_chunk_kind_enum_1.StepChunkKind.CREATE_FILE),
     path: zod_1.z.string().min(1).max(4096),
@@ -28,6 +71,10 @@ exports.CreateFileChunkMetadataSchema = zod_1.z.object({
     overwrite: zod_1.z.boolean(),
     preview: primitive_completion_schema_1.FilePreviewSchema,
 });
+/**
+ * STR_REPLACE chunk — emitted once after a successful single-occurrence
+ * replace. Same shape as the persisted `StrReplaceCompletion`.
+ */
 exports.StrReplaceChunkMetadataSchema = zod_1.z.object({
     kind: zod_1.z.literal(step_chunk_kind_enum_1.StepChunkKind.STR_REPLACE),
     path: zod_1.z.string().min(1).max(4096),
@@ -37,11 +84,23 @@ exports.StrReplaceChunkMetadataSchema = zod_1.z.object({
     linesAfter: zod_1.z.number().int().nonnegative(),
     hunk: primitive_completion_schema_1.StrReplaceHunkSchema,
 });
+/**
+ * VIEW chunk — emitted once per successful view operation. The `view`
+ * payload is the same shape persisted on `ViewCompletion`.
+ *
+ * Actual content (directory entries, file text slice, image URL) lands on
+ * the STEP_DONE `content` payload or separate ATTACHMENT_READY intents —
+ * this chunk only carries header/metadata for the live card.
+ */
 exports.ViewChunkMetadataSchema = zod_1.z.object({
     kind: zod_1.z.literal(step_chunk_kind_enum_1.StepChunkKind.VIEW),
     path: zod_1.z.string().min(1).max(4096),
     view: primitive_completion_schema_1.SandboxViewDataSchema,
 });
+/**
+ * Discriminated union of every possible STEP_CHUNK metadata shape. The
+ * frontend narrows on `metadata.kind` and renders accordingly.
+ */
 exports.StepChunkMetadataSchema = zod_1.z.discriminatedUnion('kind', [
     exports.ArgsChunkMetadataSchema,
     exports.DescribeChunkMetadataSchema,

package/build/v1/message/schemas/step-chunk-metadata.schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"step-chunk-metadata.schema.js","sourceRoot":"","sources":["../../../../v1/message/schemas/step-chunk-metadata.schema.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,gGAMwD;AACxD,gGAAsF;AACtF,iEAAuD;AACvD,qEAA2D;AAO9C,QAAA,0BAA0B,GAAG,2DAA6B,CAAC;AAK3D,QAAA,0BAA0B,GAAG,2DAA6B,CAAC;AAY3D,QAAA,uBAAuB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC5C,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,oCAAa,CAAC,IAAI,CAAC;IACnC,aAAa,EAAE,OAAC,CAAC,IAAI,CAAC,kDAAoB,CAAC;CAC9C,CAAC,CAAC;AAaU,QAAA,2BAA2B,GAAG,OAAC,CAAC,MAAM,CAAC;IAChD,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,oCAAa,CAAC,QAAQ,CAAC;IACvC,aAAa,EAAE,OAAC,CAAC,IAAI,CAAC,kDAAoB,CAAC;CAC9C,CAAC,CAAC;AASU,QAAA,uBAAuB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC5C,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,oCAAa,CAAC,IAAI,CAAC;IACnC,MAAM,EAAE,OAAC,CAAC,IAAI,CAAC,wCAAe,CAAC;CAClC,CAAC,CAAC;AASU,QAAA,6BAA6B,GAAG,OAAC,CAAC,MAAM,CAAC;IAClD,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,oCAAa,CAAC,WAAW,CAAC;IAC1C,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC;IACjC,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;IAC1C,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;IAC5C,SAAS,EAAE,OAAC,CAAC,OAAO,EAAE;IACtB,OAAO,EAAE,+CAAiB;CAC7B,CAAC,CAAC;AAMU,QAAA,6BAA6B,GAAG,OAAC,CAAC,MAAM,CAAC;IAClD,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,oCAAa,CAAC,WAAW,CAAC;IAC1C,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC;IACjC,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;IAC1C,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;IAC5C,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;IAC3C,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;IAC1C,IAAI,EAAE,kDAAoB;CAC7B,CAAC,CAAC;AAUU,QAAA,uBAAuB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC5C,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,oCAAa,CAAC,IAAI,CAAC;IACnC,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC;IACjC,IAAI,EAAE,mDAAqB;CAC9B,CAAC,CAAC;AAMU,QAAA,uBAAuB,GAAG,OAAC,CAAC,kBAAkB,CAAC,MAAM,EAAE;IAChE,+BAAuB;IACvB,mCAA2B;IAC3B,+BAAuB;IACvB,qCAA6B;IAC7B,qCAA6B;IAC7B,+BAAuB;CAC1B,CAAC,CAAC"}
+{"version":3,"file":"step-chunk-metadata.schema.js","sourceRoot":"","sources":["../../../../v1/message/schemas/step-chunk-metadata.schema.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,gGAMwD;AACxD,gGAAsF;AACtF,iEAAuD;AACvD,qEAA2D;AAE3D;;;;GAIG;AACU,QAAA,0BAA0B,GAAG,2DAA6B,CAAC;AAExE;;GAEG;AACU,QAAA,0BAA0B,GAAG,2DAA6B,CAAC;AAExE;;;;;;;;;GASG;AACU,QAAA,uBAAuB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC5C,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,oCAAa,CAAC,IAAI,CAAC;IACnC,aAAa,EAAE,OAAC,CAAC,IAAI,CAAC,kDAAoB,CAAC;CAC9C,CAAC,CAAC;AAEH;;;;;;;;;;GAUG;AACU,QAAA,2BAA2B,GAAG,OAAC,CAAC,MAAM,CAAC;IAChD,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,oCAAa,CAAC,QAAQ,CAAC;IACvC,aAAa,EAAE,OAAC,CAAC,IAAI,CAAC,kDAAoB,CAAC;CAC9C,CAAC,CAAC;AAEH;;;;;;GAMG;AACU,QAAA,uBAAuB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC5C,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,oCAAa,CAAC,IAAI,CAAC;IACnC,MAAM,EAAE,OAAC,CAAC,IAAI,CAAC,wCAAe,CAAC;CAClC,CAAC,CAAC;AAEH;;;;;;GAMG;AACU,QAAA,6BAA6B,GAAG,OAAC,CAAC,MAAM,CAAC;IAClD,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,oCAAa,CAAC,WAAW,CAAC;IAC1C,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC;IACjC,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;IAC1C,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;IAC5C,SAAS,EAAE,OAAC,CAAC,OAAO,EAAE;IACtB,OAAO,EAAE,+CAAiB;CAC7B,CAAC,CAAC;AAEH;;;GAGG;AACU,QAAA,6BAA6B,GAAG,OAAC,CAAC,MAAM,CAAC;IAClD,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,oCAAa,CAAC,WAAW,CAAC;IAC1C,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC;IACjC,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;IAC1C,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;IAC5C,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;IAC3C,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;IAC1C,IAAI,EAAE,kDAAoB;CAC7B,CAAC,CAAC;AAEH;;;;;;;GAOG;AACU,QAAA,uBAAuB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC5C,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,oCAAa,CAAC,IAAI,CAAC;IACnC,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC;IACjC,IAAI,EAAE,mDAAqB;CAC9B,CAAC,CAAC;AAEH;;;GAGG;AACU,QAAA,uBAAuB,GAAG,OAAC,CAAC,kBAAkB,CAAC,MAAM,EAAE;IAChE,+BAAuB;IACvB,mCAA2B;IAC3B,+BAAuB;IACvB,qCAA6B;IAC7B,qCAA6B;IAC7B,+BAAuB;CAC1B,CAAC,CAAC"}

package/build/v1/message/schemas/step-metadata.schema.d.ts

@@ -1,29 +1,71 @@
 import { z } from 'zod';
 import { SandboxPrimitiveType } from '../../tool/sandbox/sandbox-primitive-type.enum';
 import { GenerationStepType } from './generation-step-type.enum';
+/**
+ * WEB_SEARCH step-start metadata: the queries being searched.
+ */
 export declare const WebSearchStepStartMetadataSchema: z.ZodObject<{
     queries: z.ZodArray<z.ZodString>;
 }, z.core.$strip>;
+/**
+ * CONVERSATION_SEARCH step-start metadata: the query being searched across the
+ * user's past chats. Emitted at step start so the UI can show "searching for X"
+ * live, before results land (mirrors WEB_SEARCH).
+ */
 export declare const ConversationSearchStepStartMetadataSchema: z.ZodObject<{
     query: z.ZodString;
 }, z.core.$strip>;
+/**
+ * IMAGE_EDIT step-start metadata: source image info.
+ */
 export declare const ImageEditStepStartMetadataSchema: z.ZodObject<{
     sourceResolution: z.ZodString;
     sourceImageCount: z.ZodNumber;
 }, z.core.$strip>;
+/**
+ * VIDEO_ANALYSIS step-start metadata: the video being analysed.
+ */
 export declare const VideoAnalysisStepStartMetadataSchema: z.ZodObject<{
     videoUrl: z.ZodString;
 }, z.core.$strip>;
+/**
+ * CODE_EXECUTION step-start metadata: sandbox primitive discriminator.
+ *
+ * Emitted BEFORE the tool runs, while the LLM is still streaming tool_call
+ * arguments. `primitiveType` tells the UI which sandbox primitive to render
+ * (bash | create_file | str_replace | view). The UI correlates chunks and
+ * final content with this step via `stepId` on the stream event itself.
+ */
 export declare const CodeExecutionStepStartMetadataSchema: z.ZodObject<{
     primitiveType: z.ZodEnum<typeof SandboxPrimitiveType>;
 }, z.core.$strip>;
+/**
+ * CONNECTOR_TOOL step-start metadata: which connector tool is being invoked.
+ * Emitted at step start so the UI can render a live "calling <tool>" card
+ * before the upstream MCP call returns.
+ *
+ * `toolName` is the provider-local tool name (e.g. `ydisk_list`), NOT the
+ * `mcp_<slug>__<name>` wire function name. `connectionUuid` lets the FE resolve
+ * the owning connection (title/icon) by id. `providerKey` is the first-party
+ * provider key, or null for a custom MCP connection. The unique `toolName` +
+ * `connectionUuid` pair keeps this arm unambiguous within the plain union.
+ */
 export declare const ConnectorToolStepStartMetadataSchema: z.ZodObject<{
     toolName: z.ZodString;
     connectionUuid: z.ZodString;
     providerKey: z.ZodNullable<z.ZodString>;
     argsPreview: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
+/**
+ * Registry of step-start metadata schemas by step type. Only specific step
+ * types carry metadata; others have `undefined`. Used by stream validators
+ * to pick the right schema given a step type at runtime.
+ */
 export declare const StepStartMetadataByType: Partial<Record<GenerationStepType, z.ZodTypeAny>>;
+/**
+ * Union schema for all possible step-start metadata shapes. Used in
+ * stream-events schema for the metadata field.
+ */
 export declare const StepStartMetadataSchema: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
     queries: z.ZodArray<z.ZodString>;
 }, z.core.$strip>, z.ZodObject<{
@@ -41,12 +83,22 @@ export declare const StepStartMetadataSchema: z.ZodOptional<z.ZodUnion<readonly
     providerKey: z.ZodNullable<z.ZodString>;
     argsPreview: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>]>>;
+/**
+ * UPLOAD step-done metadata: URLs of uploaded images.
+ */
 export declare const UploadStepDoneMetadataSchema: z.ZodUnion<readonly [z.ZodObject<{
     imageUrl: z.ZodString;
 }, z.core.$strip>, z.ZodObject<{
     imageUrls: z.ZodArray<z.ZodString>;
 }, z.core.$strip>, z.ZodObject<{}, z.core.$strip>]>;
+/**
+ * Registry of step-done metadata schemas by step type. Currently only
+ * UPLOAD carries metadata; others have `undefined`.
+ */
 export declare const StepDoneMetadataByType: Partial<Record<GenerationStepType, z.ZodTypeAny>>;
+/**
+ * Union schema for all possible step-done metadata shapes.
+ */
 export declare const StepDoneMetadataSchema: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
     imageUrl: z.ZodString;
 }, z.core.$strip>, z.ZodObject<{
@@ -59,5 +111,17 @@ export type VideoAnalysisStepStartMetadata = z.infer<typeof VideoAnalysisStepSta
 export type CodeExecutionStepStartMetadata = z.infer<typeof CodeExecutionStepStartMetadataSchema>;
 export type ConnectorToolStepStartMetadata = z.infer<typeof ConnectorToolStepStartMetadataSchema>;
 export type UploadStepDoneMetadata = z.infer<typeof UploadStepDoneMetadataSchema>;
+/**
+ * Union of all possible STEP_START metadata shapes. Derived from the Zod
+ * union (stripping the outer `.optional()`) so the TS type and the runtime
+ * schema can never drift. Consumers use `StreamStepStartEvent.metadata`
+ * when they already have the narrowed event; this alias exists for code
+ * that needs the bare metadata shape without the enclosing event.
+ */
 export type StepStartMetadata = NonNullable<z.infer<typeof StepStartMetadataSchema>>;
+/**
+ * Union of all possible STEP_DONE metadata shapes. Currently only UPLOAD
+ * steps carry metadata. Derived via z.infer so adding a new variant to
+ * `StepDoneMetadataSchema` automatically propagates here.
+ */
 export type StepDoneMetadata = NonNullable<z.infer<typeof StepDoneMetadataSchema>>;

package/build/v1/message/schemas/step-metadata.schema.js

@@ -4,28 +4,69 @@ exports.StepDoneMetadataSchema = exports.StepDoneMetadataByType = exports.Upload
 const zod_1 = require("zod");
 const sandbox_primitive_type_enum_1 = require("../../tool/sandbox/sandbox-primitive-type.enum");
 const generation_step_type_enum_1 = require("./generation-step-type.enum");
+// ============================================================================
+// Step-Start metadata — typed per step type
+// ============================================================================
+/**
+ * WEB_SEARCH step-start metadata: the queries being searched.
+ */
 exports.WebSearchStepStartMetadataSchema = zod_1.z.object({
     queries: zod_1.z.array(zod_1.z.string()),
 });
+/**
+ * CONVERSATION_SEARCH step-start metadata: the query being searched across the
+ * user's past chats. Emitted at step start so the UI can show "searching for X"
+ * live, before results land (mirrors WEB_SEARCH).
+ */
 exports.ConversationSearchStepStartMetadataSchema = zod_1.z.object({
     query: zod_1.z.string(),
 });
+/**
+ * IMAGE_EDIT step-start metadata: source image info.
+ */
 exports.ImageEditStepStartMetadataSchema = zod_1.z.object({
     sourceResolution: zod_1.z.string(),
     sourceImageCount: zod_1.z.number().int().nonnegative(),
 });
+/**
+ * VIDEO_ANALYSIS step-start metadata: the video being analysed.
+ */
 exports.VideoAnalysisStepStartMetadataSchema = zod_1.z.object({
     videoUrl: zod_1.z.string().url(),
 });
+/**
+ * CODE_EXECUTION step-start metadata: sandbox primitive discriminator.
+ *
+ * Emitted BEFORE the tool runs, while the LLM is still streaming tool_call
+ * arguments. `primitiveType` tells the UI which sandbox primitive to render
+ * (bash | create_file | str_replace | view). The UI correlates chunks and
+ * final content with this step via `stepId` on the stream event itself.
+ */
 exports.CodeExecutionStepStartMetadataSchema = zod_1.z.object({
     primitiveType: zod_1.z.enum(sandbox_primitive_type_enum_1.SandboxPrimitiveType),
 });
+/**
+ * CONNECTOR_TOOL step-start metadata: which connector tool is being invoked.
+ * Emitted at step start so the UI can render a live "calling <tool>" card
+ * before the upstream MCP call returns.
+ *
+ * `toolName` is the provider-local tool name (e.g. `ydisk_list`), NOT the
+ * `mcp_<slug>__<name>` wire function name. `connectionUuid` lets the FE resolve
+ * the owning connection (title/icon) by id. `providerKey` is the first-party
+ * provider key, or null for a custom MCP connection. The unique `toolName` +
+ * `connectionUuid` pair keeps this arm unambiguous within the plain union.
+ */
 exports.ConnectorToolStepStartMetadataSchema = zod_1.z.object({
     toolName: zod_1.z.string(),
     connectionUuid: zod_1.z.string(),
     providerKey: zod_1.z.string().nullable(),
     argsPreview: zod_1.z.string().optional(),
 });
+/**
+ * Registry of step-start metadata schemas by step type. Only specific step
+ * types carry metadata; others have `undefined`. Used by stream validators
+ * to pick the right schema given a step type at runtime.
+ */
 exports.StepStartMetadataByType = {
     [generation_step_type_enum_1.GenerationStepType.WEB_SEARCH]: exports.WebSearchStepStartMetadataSchema,
     [generation_step_type_enum_1.GenerationStepType.CONVERSATION_SEARCH]: exports.ConversationSearchStepStartMetadataSchema,
@@ -34,6 +75,10 @@ exports.StepStartMetadataByType = {
     [generation_step_type_enum_1.GenerationStepType.CODE_EXECUTION]: exports.CodeExecutionStepStartMetadataSchema,
     [generation_step_type_enum_1.GenerationStepType.CONNECTOR_TOOL]: exports.ConnectorToolStepStartMetadataSchema,
 };
+/**
+ * Union schema for all possible step-start metadata shapes. Used in
+ * stream-events schema for the metadata field.
+ */
 exports.StepStartMetadataSchema = zod_1.z
     .union([
     exports.WebSearchStepStartMetadataSchema,
@@ -44,13 +89,26 @@ exports.StepStartMetadataSchema = zod_1.z
     exports.ConnectorToolStepStartMetadataSchema,
 ])
     .optional();
+// ============================================================================
+// Step-Done metadata — typed per step type
+// ============================================================================
+/**
+ * UPLOAD step-done metadata: URLs of uploaded images.
+ */
 exports.UploadStepDoneMetadataSchema = zod_1.z.union([
     zod_1.z.object({ imageUrl: zod_1.z.string().url() }),
     zod_1.z.object({ imageUrls: zod_1.z.array(zod_1.z.string().url()) }),
     zod_1.z.object({}),
 ]);
+/**
+ * Registry of step-done metadata schemas by step type. Currently only
+ * UPLOAD carries metadata; others have `undefined`.
+ */
 exports.StepDoneMetadataByType = {
     [generation_step_type_enum_1.GenerationStepType.UPLOAD]: exports.UploadStepDoneMetadataSchema,
 };
+/**
+ * Union schema for all possible step-done metadata shapes.
+ */
 exports.StepDoneMetadataSchema = exports.UploadStepDoneMetadataSchema.optional();
 //# sourceMappingURL=step-metadata.schema.js.map

package/build/v1/message/schemas/step-metadata.schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"step-metadata.schema.js","sourceRoot":"","sources":["../../../../v1/message/schemas/step-metadata.schema.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,gGAAsF;AACtF,2EAAiE;AASpD,QAAA,gCAAgC,GAAG,OAAC,CAAC,MAAM,CAAC;IACrD,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC;CAC/B,CAAC,CAAC;AAOU,QAAA,yCAAyC,GAAG,OAAC,CAAC,MAAM,CAAC;IAC9D,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;CACpB,CAAC,CAAC;AAKU,QAAA,gCAAgC,GAAG,OAAC,CAAC,MAAM,CAAC;IACrD,gBAAgB,EAAE,OAAC,CAAC,MAAM,EAAE;IAC5B,gBAAgB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;CACnD,CAAC,CAAC;AAKU,QAAA,oCAAoC,GAAG,OAAC,CAAC,MAAM,CAAC;IACzD,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;CAC7B,CAAC,CAAC;AAUU,QAAA,oCAAoC,GAAG,OAAC,CAAC,MAAM,CAAC;IACzD,aAAa,EAAE,OAAC,CAAC,IAAI,CAAC,kDAAoB,CAAC;CAC9C,CAAC,CAAC;AAaU,QAAA,oCAAoC,GAAG,OAAC,CAAC,MAAM,CAAC;IACzD,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE;IACpB,cAAc,EAAE,OAAC,CAAC,MAAM,EAAE;IAC1B,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACrC,CAAC,CAAC;AAOU,QAAA,uBAAuB,GAEhC;IACA,CAAC,8CAAkB,CAAC,UAAU,CAAC,EAAE,wCAAgC;IACjE,CAAC,8CAAkB,CAAC,mBAAmB,CAAC,EAAE,iDAAyC;IACnF,CAAC,8CAAkB,CAAC,UAAU,CAAC,EAAE,wCAAgC;IACjE,CAAC,8CAAkB,CAAC,cAAc,CAAC,EAAE,4CAAoC;IACzE,CAAC,8CAAkB,CAAC,cAAc,CAAC,EAAE,4CAAoC;IACzE,CAAC,8CAAkB,CAAC,cAAc,CAAC,EAAE,4CAAoC;CAC5E,CAAC;AAMW,QAAA,uBAAuB,GAAG,OAAC;KACnC,KAAK,CAAC;IACH,wCAAgC;IAChC,iDAAyC;IACzC,wCAAgC;IAChC,4CAAoC;IACpC,4CAAoC;IACpC,4CAAoC;CACvC,CAAC;KACD,QAAQ,EAAE,CAAC;AASH,QAAA,4BAA4B,GAAG,OAAC,CAAC,KAAK,CAAC;IAChD,OAAC,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC;IACxC,OAAC,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC;IAClD,OAAC,CAAC,MAAM,CAAC,EAAE,CAAC;CACf,CAAC,CAAC;AAMU,QAAA,sBAAsB,GAE/B;IACA,CAAC,8CAAkB,CAAC,MAAM,CAAC,EAAE,oCAA4B;CAC5D,CAAC;AAKW,QAAA,sBAAsB,GAAG,oCAA4B,CAAC,QAAQ,EAAE,CAAC"}
+{"version":3,"file":"step-metadata.schema.js","sourceRoot":"","sources":["../../../../v1/message/schemas/step-metadata.schema.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,gGAAsF;AACtF,2EAAiE;AAEjE,+EAA+E;AAC/E,4CAA4C;AAC5C,+EAA+E;AAE/E;;GAEG;AACU,QAAA,gCAAgC,GAAG,OAAC,CAAC,MAAM,CAAC;IACrD,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC;CAC/B,CAAC,CAAC;AAEH;;;;GAIG;AACU,QAAA,yCAAyC,GAAG,OAAC,CAAC,MAAM,CAAC;IAC9D,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;CACpB,CAAC,CAAC;AAEH;;GAEG;AACU,QAAA,gCAAgC,GAAG,OAAC,CAAC,MAAM,CAAC;IACrD,gBAAgB,EAAE,OAAC,CAAC,MAAM,EAAE;IAC5B,gBAAgB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;CACnD,CAAC,CAAC;AAEH;;GAEG;AACU,QAAA,oCAAoC,GAAG,OAAC,CAAC,MAAM,CAAC;IACzD,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;CAC7B,CAAC,CAAC;AAEH;;;;;;;GAOG;AACU,QAAA,oCAAoC,GAAG,OAAC,CAAC,MAAM,CAAC;IACzD,aAAa,EAAE,OAAC,CAAC,IAAI,CAAC,kDAAoB,CAAC;CAC9C,CAAC,CAAC;AAEH;;;;;;;;;;GAUG;AACU,QAAA,oCAAoC,GAAG,OAAC,CAAC,MAAM,CAAC;IACzD,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE;IACpB,cAAc,EAAE,OAAC,CAAC,MAAM,EAAE;IAC1B,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACrC,CAAC,CAAC;AAEH;;;;GAIG;AACU,QAAA,uBAAuB,GAEhC;IACA,CAAC,8CAAkB,CAAC,UAAU,CAAC,EAAE,wCAAgC;IACjE,CAAC,8CAAkB,CAAC,mBAAmB,CAAC,EAAE,iDAAyC;IACnF,CAAC,8CAAkB,CAAC,UAAU,CAAC,EAAE,wCAAgC;IACjE,CAAC,8CAAkB,CAAC,cAAc,CAAC,EAAE,4CAAoC;IACzE,CAAC,8CAAkB,CAAC,cAAc,CAAC,EAAE,4CAAoC;IACzE,CAAC,8CAAkB,CAAC,cAAc,CAAC,EAAE,4CAAoC;CAC5E,CAAC;AAEF;;;GAGG;AACU,QAAA,uBAAuB,GAAG,OAAC;KACnC,KAAK,CAAC;IACH,wCAAgC;IAChC,iDAAyC;IACzC,wCAAgC;IAChC,4CAAoC;IACpC,4CAAoC;IACpC,4CAAoC;CACvC,CAAC;KACD,QAAQ,EAAE,CAAC;AAEhB,+EAA+E;AAC/E,2CAA2C;AAC3C,+EAA+E;AAE/E;;GAEG;AACU,QAAA,4BAA4B,GAAG,OAAC,CAAC,KAAK,CAAC;IAChD,OAAC,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC;IACxC,OAAC,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC;IAClD,OAAC,CAAC,MAAM,CAAC,EAAE,CAAC;CACf,CAAC,CAAC;AAEH;;;GAGG;AACU,QAAA,sBAAsB,GAE/B;IACA,CAAC,8CAAkB,CAAC,MAAM,CAAC,EAAE,oCAA4B;CAC5D,CAAC;AAEF;;GAEG;AACU,QAAA,sBAAsB,GAAG,oCAA4B,CAAC,QAAQ,EAAE,CAAC"}

package/build/v1/message/schemas/stream-event-type.enum.d.ts

@@ -1,15 +1,44 @@
+/**
+ * Stream Event Types for message streaming (NDJSON format)
+ */
 export declare enum StreamEventType {
+    /** Transient routing status before visible model output. */
+    GENERATION_STATUS = "GENERATION_STATUS",
+    /** Generation step started */
     STEP_START = "STEP_START",
+    /** Chunk from any step (text, reasoning, prompt generation) */
     STEP_CHUNK = "STEP_CHUNK",
+    /** Generation step failed (terminal error for the step) */
     STEP_ERROR = "STEP_ERROR",
+    /** Generation step completed (NOT the whole stream) */
     STEP_DONE = "STEP_DONE",
+    /** Image generated by AI */
     IMAGE = "IMAGE",
+    /** Image generation failed (content filter, etc.) */
     IMAGE_GENERATION_ERROR = "IMAGE_GENERATION_ERROR",
+    /** Web search citations/sources */
     CITATIONS = "CITATIONS",
+    /** Keep-alive heartbeat (sent every 15 seconds) */
     HEARTBEAT = "HEARTBEAT",
+    /**
+     * Initial billing hold opened (BEFORE the stream's first token).
+     * Carries the hold id and estimated lock amount so the frontend can
+     * show "X tokens locked" immediately. Reflects the lower-bound
+     * estimate (model.price + Σ explicit option deltas); runtime tools
+     * top up the hold mid-stream and surface via STEP_BILLED.
+     */
     BILLING_ESTIMATE = "BILLING_ESTIMATE",
+    /**
+     * Per-step billing settled. Emitted after each billable step's
+     * settleStep call, carrying the step's individual cost and the
+     * cumulative held amount (initial estimate + Σ top-ups). Lets the
+     * UI show real-time spend climbing during the stream.
+     */
     STEP_BILLED = "STEP_BILLED",
+    /** Stream completed successfully */
     DONE = "DONE",
+    /** Stream cancelled by user */
     CANCELLED = "CANCELLED",
+    /** Error occurred during streaming */
     ERROR = "ERROR"
 }

package/build/v1/message/schemas/stream-event-type.enum.js

@@ -1,20 +1,49 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StreamEventType = void 0;
+/**
+ * Stream Event Types for message streaming (NDJSON format)
+ */
 var StreamEventType;
 (function (StreamEventType) {
+    /** Transient routing status before visible model output. */
+    StreamEventType["GENERATION_STATUS"] = "GENERATION_STATUS";
+    /** Generation step started */
     StreamEventType["STEP_START"] = "STEP_START";
+    /** Chunk from any step (text, reasoning, prompt generation) */
     StreamEventType["STEP_CHUNK"] = "STEP_CHUNK";
+    /** Generation step failed (terminal error for the step) */
     StreamEventType["STEP_ERROR"] = "STEP_ERROR";
+    /** Generation step completed (NOT the whole stream) */
     StreamEventType["STEP_DONE"] = "STEP_DONE";
+    /** Image generated by AI */
     StreamEventType["IMAGE"] = "IMAGE";
+    /** Image generation failed (content filter, etc.) */
     StreamEventType["IMAGE_GENERATION_ERROR"] = "IMAGE_GENERATION_ERROR";
+    /** Web search citations/sources */
     StreamEventType["CITATIONS"] = "CITATIONS";
+    /** Keep-alive heartbeat (sent every 15 seconds) */
     StreamEventType["HEARTBEAT"] = "HEARTBEAT";
+    /**
+     * Initial billing hold opened (BEFORE the stream's first token).
+     * Carries the hold id and estimated lock amount so the frontend can
+     * show "X tokens locked" immediately. Reflects the lower-bound
+     * estimate (model.price + Σ explicit option deltas); runtime tools
+     * top up the hold mid-stream and surface via STEP_BILLED.
+     */
     StreamEventType["BILLING_ESTIMATE"] = "BILLING_ESTIMATE";
+    /**
+     * Per-step billing settled. Emitted after each billable step's
+     * settleStep call, carrying the step's individual cost and the
+     * cumulative held amount (initial estimate + Σ top-ups). Lets the
+     * UI show real-time spend climbing during the stream.
+     */
     StreamEventType["STEP_BILLED"] = "STEP_BILLED";
+    /** Stream completed successfully */
     StreamEventType["DONE"] = "DONE";
+    /** Stream cancelled by user */
     StreamEventType["CANCELLED"] = "CANCELLED";
+    /** Error occurred during streaming */
     StreamEventType["ERROR"] = "ERROR";
 })(StreamEventType || (exports.StreamEventType = StreamEventType = {}));
 //# sourceMappingURL=stream-event-type.enum.js.map

package/build/v1/message/schemas/stream-event-type.enum.js.map

@@ -1 +1 @@
-{"version":3,"file":"stream-event-type.enum.js","sourceRoot":"","sources":["../../../../v1/message/schemas/stream-event-type.enum.ts"],"names":[],"mappings":";;;AAGA,IAAY,eAsCX;AAtCD,WAAY,eAAe;IAEvB,4CAAyB,CAAA;IAEzB,4CAAyB,CAAA;IAEzB,4CAAyB,CAAA;IAEzB,0CAAuB,CAAA;IAEvB,kCAAe,CAAA;IAEf,oEAAiD,CAAA;IAEjD,0CAAuB,CAAA;IAEvB,0CAAuB,CAAA;IAQvB,wDAAqC,CAAA;IAOrC,8CAA2B,CAAA;IAE3B,gCAAa,CAAA;IAEb,0CAAuB,CAAA;IAEvB,kCAAe,CAAA;AACnB,CAAC,EAtCW,eAAe,+BAAf,eAAe,QAsC1B"}
+{"version":3,"file":"stream-event-type.enum.js","sourceRoot":"","sources":["../../../../v1/message/schemas/stream-event-type.enum.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,IAAY,eAwCX;AAxCD,WAAY,eAAe;IACvB,4DAA4D;IAC5D,0DAAuC,CAAA;IACvC,8BAA8B;IAC9B,4CAAyB,CAAA;IACzB,+DAA+D;IAC/D,4CAAyB,CAAA;IACzB,2DAA2D;IAC3D,4CAAyB,CAAA;IACzB,uDAAuD;IACvD,0CAAuB,CAAA;IACvB,4BAA4B;IAC5B,kCAAe,CAAA;IACf,qDAAqD;IACrD,oEAAiD,CAAA;IACjD,mCAAmC;IACnC,0CAAuB,CAAA;IACvB,mDAAmD;IACnD,0CAAuB,CAAA;IACvB;;;;;;OAMG;IACH,wDAAqC,CAAA;IACrC;;;;;OAKG;IACH,8CAA2B,CAAA;IAC3B,oCAAoC;IACpC,gCAAa,CAAA;IACb,+BAA+B;IAC/B,0CAAuB,CAAA;IACvB,sCAAsC;IACtC,kCAAe,CAAA;AACnB,CAAC,EAxCW,eAAe,+BAAf,eAAe,QAwC1B"}