@vxil/sdk 0.14.0 → 0.14.1

package/dist/index.d.ts

@@ -392,6 +392,33 @@ export interface JobRun {
      *  `processing` ping on its signed callback (plain run) or its provider's
      *  webhook (generation run). null until one arrives. */
     progress?: JobRunProgress | null;
+    /** the single-run read, generation runs only: the LAST `status_mirror`
+     *  write the target refused, or null. A full write refused as a body
+     *  problem (400 / 413 / 422 — e.g. a callback key the collection does not
+     *  declare) is retried with only the status column (a progress update tries
+     *  the declared `progress_fields` first), so an undeclared key no longer
+     *  strands the row; this says what was dropped. Never flips the run; not cleared by a later
+     *  successful mirror (compare `generation_status` / `at`). */
+    mirror_error?: JobRunMirrorError | null;
+}
+/** A refused status-mirror write (`JobRun.mirror_error`). */
+export interface JobRunMirrorError {
+    /** the status word the refused write carried */
+    generation_status: 'pending' | 'processing' | 'completed' | 'failed';
+    /** the target's HTTP status on the full write; 0 = no answer (network / timeout) */
+    status: number;
+    /** the target's error code (e.g. `validation_failed`), `network_error` / `timeout`, or null */
+    code: string | null;
+    /** the target's message (≤ 200 chars), e.g. "unknown field 'video_url'" */
+    message: string | null;
+    /** when it was refused (ISO) */
+    at: string;
+    /** present when a narrower retry LANDED: the keys that were not written */
+    fields_dropped?: string[];
+    /** present when every narrower retry was refused too (the last one's HTTP
+     *  status, 0 = no answer): the status word itself was refused and the
+     *  record still holds the previous status */
+    retry_status?: number;
 }
 /** A run's latest progress report (`JobRun.progress`): only these keys pass. */
 export interface JobRunProgress {
@@ -2987,7 +3014,12 @@ export declare class Vxil<S extends VxilSchemaShape = VxilSchemaShape> {
          * sends `provider.body` exactly; `completion.status_map` maps up to 8
          * provider words to completed | failed | processing (`{ OK: 'completed',
          * ERROR: 'failed' }`); `completion.result_path` names the value the run
-         * settles with — the status mirror receives it as `result`. */
+         * settles with — the status mirror receives it as `result`.
+         *
+         * A mirror write the record refuses never fails the run: a body refusal
+         * (e.g. a callback key the collection does not declare) is retried with
+         * only the status column, so the row still reaches `completed`; the run then reports `mirror_error`
+         * (`JobRun.mirror_error` on `vx.jobs.run(run_id)`). */
         generation: (input: {
             job_name: string;
             provider: {

package/dist/index.js

@@ -718,7 +718,12 @@ export class Vxil {
          * sends `provider.body` exactly; `completion.status_map` maps up to 8
          * provider words to completed | failed | processing (`{ OK: 'completed',
          * ERROR: 'failed' }`); `completion.result_path` names the value the run
-         * settles with — the status mirror receives it as `result`. */
+         * settles with — the status mirror receives it as `result`.
+         *
+         * A mirror write the record refuses never fails the run: a body refusal
+         * (e.g. a callback key the collection does not declare) is retried with
+         * only the status column, so the row still reaches `completed`; the run then reports `mirror_error`
+         * (`JobRun.mirror_error` on `vx.jobs.run(run_id)`). */
         generation: async (input) => (await this.call('POST', '/v1/jobs/generation', input)).data,
         runs: async (q) => {
             const s = qs({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vxil/sdk",
-  "version": "0.14.0",
+  "version": "0.14.1",
   "private": false,
   "type": "module",
   "description": "Typed client for the Vxil REST API (notifications, auth, jobs, files, cms, comments, webhooks, realtime, orgs, rate-limits).",