@openvtc/trust-tasks 0.26.13 → 0.26.14

package/src/vtc/registry/sync-jobs/retry/0.2/payload.ts

@@ -0,0 +1,401 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/registry/sync-jobs/retry/0.2/payload.schema.json
+ */
+
+import type { Ext } from "../../../../../_shared/components.js";
+
+
+/**
+ * Requeue a trust-registry reconciliation job — one the community's reconciler has abandoned, or one waiting out a retry backoff — so it is dispatched on the reconciler's next pass.
+ */
+export type VTCRegistrySyncJobsRetryPayload = {
+  /**
+   * The single job to requeue, from `vtc/registry/sync-jobs/list`. It may be `failed`, or `pending` and waiting out a retry backoff.
+   */
+  jobId?: string;
+  /**
+   * Requeue every job in the terminal `failed` state. Spelled as its own member rather than an absent `jobId` so that a client bug which drops the identifier cannot silently become a bulk operation.
+   */
+  allFailed?: true;
+  /**
+   * Bring forward every `pending` job that is waiting out a retry backoff. Never a held job. Its own member for the same reason as `allFailed`, and distinct from it so that repairing a shared cause and hurrying a slow backoff stay two decisions.
+   */
+  allWaiting?: true;
+  ext?: Ext;
+} & {
+  [k: string]: unknown | undefined;
+};
+
+export interface VTCRegistrySyncJobsRetryResponsePayload {
+  /**
+   * Jobs now scheduled for dispatch on the reconciler's next pass. Empty is a valid answer and is not an error.
+   */
+  requeued: Requeued[];
+  /**
+   * Jobs the maintainer declined to requeue, each with why. Reported rather than failing the task, so a bulk retry is not defeated by one ineligible row.
+   */
+  skipped: Skipped[];
+  ext?: Ext;
+}
+export interface Requeued {
+  jobId: string;
+  /**
+   * The member whose record the requeued job carries.
+   */
+  memberDid?: string;
+  /**
+   * The state the job was in. `failed` — the reconciler had abandoned it. `pending` — it was waiting out a retry backoff and has been brought forward.
+   */
+  from: "failed" | "pending";
+  ext?: Ext;
+}
+export interface Skipped {
+  jobId: string;
+  /**
+   * `inFlight` — the reconciler is dispatching the job now, so requeueing it would dispatch the same mutation twice. `held` — the job is deliberately delayed, and the delay is the point; it is never brought forward. `notFound` — no such job; it may already have been dispatched, retried, discarded, or swept.
+   */
+  reason: "inFlight" | "held" | "notFound";
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/registry/sync-jobs/retry/0.2" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCRegistrySyncJobsRetryPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/registry/sync-jobs/retry/0.2#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCRegistrySyncJobsRetryResponsePayload;
+
+/**
+ * This specification's payload schema, as a value.
+ *
+ * SPEC.md §7.2 item 2 is performed against this. It is shipped as data
+ * rather than only as a `.json` file because TypeScript types are erased
+ * at runtime: without a schema a consumer has nothing to validate, and
+ * every REQUIRED payload member is optional in practice. Cross-file
+ * `$ref`s are already inlined, so it needs no resolver.
+ */
+export const PAYLOAD_SCHEMA = {
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://trusttasks.org/spec/vtc/registry/sync-jobs/retry/0.2",
+  "title": "VTC Registry Sync Jobs Retry — payload",
+  "description": "Requeue a trust-registry reconciliation job — one the community's reconciler has abandoned, or one waiting out a retry backoff — so it is dispatched on the reconciler's next pass.",
+  "type": "object",
+  "additionalProperties": false,
+  "oneOf": [
+    {
+      "required": [
+        "jobId"
+      ],
+      "not": {
+        "anyOf": [
+          {
+            "required": [
+              "allFailed"
+            ]
+          },
+          {
+            "required": [
+              "allWaiting"
+            ]
+          }
+        ]
+      }
+    },
+    {
+      "required": [
+        "allFailed"
+      ],
+      "not": {
+        "anyOf": [
+          {
+            "required": [
+              "jobId"
+            ]
+          },
+          {
+            "required": [
+              "allWaiting"
+            ]
+          }
+        ]
+      }
+    },
+    {
+      "required": [
+        "allWaiting"
+      ],
+      "not": {
+        "anyOf": [
+          {
+            "required": [
+              "jobId"
+            ]
+          },
+          {
+            "required": [
+              "allFailed"
+            ]
+          }
+        ]
+      }
+    }
+  ],
+  "properties": {
+    "jobId": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The single job to requeue, from `vtc/registry/sync-jobs/list`. It may be `failed`, or `pending` and waiting out a retry backoff."
+    },
+    "allFailed": {
+      "type": "boolean",
+      "const": true,
+      "description": "Requeue every job in the terminal `failed` state. Spelled as its own member rather than an absent `jobId` so that a client bug which drops the identifier cannot silently become a bulk operation."
+    },
+    "allWaiting": {
+      "type": "boolean",
+      "const": true,
+      "description": "Bring forward every `pending` job that is waiting out a retry backoff. Never a held job. Its own member for the same reason as `allFailed`, and distinct from it so that repairing a shared cause and hurrying a slow backoff stay two decisions."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Requeued": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "jobId",
+        "from"
+      ],
+      "properties": {
+        "jobId": {
+          "type": "string",
+          "minLength": 1
+        },
+        "memberDid": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The member whose record the requeued job carries."
+        },
+        "from": {
+          "type": "string",
+          "enum": [
+            "failed",
+            "pending"
+          ],
+          "description": "The state the job was in. `failed` — the reconciler had abandoned it. `pending` — it was waiting out a retry backoff and has been brought forward."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Skipped": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "jobId",
+        "reason"
+      ],
+      "properties": {
+        "jobId": {
+          "type": "string",
+          "minLength": 1
+        },
+        "reason": {
+          "type": "string",
+          "enum": [
+            "inFlight",
+            "held",
+            "notFound"
+          ],
+          "description": "`inFlight` — the reconciler is dispatching the job now, so requeueing it would dispatch the same mutation twice. `held` — the job is deliberately delayed, and the delay is the point; it is never brought forward. `notFound` — no such job; it may already have been dispatched, retried, discarded, or swept."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Registry Sync Jobs Retry — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "requeued",
+        "skipped"
+      ],
+      "properties": {
+        "requeued": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Requeued"
+          },
+          "description": "Jobs now scheduled for dispatch on the reconciler's next pass. Empty is a valid answer and is not an error."
+        },
+        "skipped": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Skipped"
+          },
+          "description": "Jobs the maintainer declined to requeue, each with why. Reported rather than failing the task, so a bulk retry is not defeated by one ineligible row."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Ext": {
+      "title": "Ext",
+      "description": "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.",
+      "type": "object",
+      "minProperties": 1,
+      "additionalProperties": true,
+      "propertyNames": {
+        "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
+      }
+    }
+  }
+} as const;
+
+/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
+export const RESPONSE_PAYLOAD_SCHEMA = {
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$ref": "#/$defs/Response",
+  "$defs": {
+    "Requeued": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "jobId",
+        "from"
+      ],
+      "properties": {
+        "jobId": {
+          "type": "string",
+          "minLength": 1
+        },
+        "memberDid": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The member whose record the requeued job carries."
+        },
+        "from": {
+          "type": "string",
+          "enum": [
+            "failed",
+            "pending"
+          ],
+          "description": "The state the job was in. `failed` — the reconciler had abandoned it. `pending` — it was waiting out a retry backoff and has been brought forward."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Skipped": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "jobId",
+        "reason"
+      ],
+      "properties": {
+        "jobId": {
+          "type": "string",
+          "minLength": 1
+        },
+        "reason": {
+          "type": "string",
+          "enum": [
+            "inFlight",
+            "held",
+            "notFound"
+          ],
+          "description": "`inFlight` — the reconciler is dispatching the job now, so requeueing it would dispatch the same mutation twice. `held` — the job is deliberately delayed, and the delay is the point; it is never brought forward. `notFound` — no such job; it may already have been dispatched, retried, discarded, or swept."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Registry Sync Jobs Retry — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "requeued",
+        "skipped"
+      ],
+      "properties": {
+        "requeued": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Requeued"
+          },
+          "description": "Jobs now scheduled for dispatch on the reconciler's next pass. Empty is a valid answer and is not an error."
+        },
+        "skipped": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Skipped"
+          },
+          "description": "Jobs the maintainer declined to requeue, each with why. Reported rather than failing the task, so a bulk retry is not defeated by one ineligible row."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Ext": {
+      "title": "Ext",
+      "description": "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.",
+      "type": "object",
+      "minProperties": 1,
+      "additionalProperties": true,
+      "propertyNames": {
+        "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
+      }
+    }
+  }
+} as const;
+
+/**
+ * SPEC.md §7.2 policy for the request variant, from this specification's
+ * front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
+ * per-specification and cannot be derived from the document alone, and
+ * item 2 needs the schema this carries.
+ */
+export const SPEC = {
+  typeUri: TYPE_URI,
+  isBearer: false,
+  isProofRequired: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: PAYLOAD_SCHEMA,
+} as const;
+
+/**
+ * SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
+ * tracks the *issuer* party's requirement because a response swaps the
+ * parties (§7.3 item 5).
+ */
+export const RESPONSE_SPEC = {
+  typeUri: RESPONSE_TYPE_URI,
+  isBearer: false,
+  isProofRequired: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;