@openvtc/trust-tasks 0.23.4 → 0.23.5

package/src/git-ns/bridge/job/list/0.2/payload.ts

@@ -0,0 +1,517 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/git-ns/bridge/job/list/0.2/payload.schema.json
+ */
+
+import type { Did_GitNsV0_3 as Did, Ext, NamespaceId, RepoResource } from "../../../../../_shared/components.js";
+
+
+/**
+ * The VTC's own queue state for the job, driven by git-ns/bridge/result/0.1 reports. `pending` — queued, not yet accepted. `accepted` — the bridge has taken it and not yet reported an outcome. `succeeded` — every step completed. `partial` — some steps completed and at least one did not. `failed` — no step completed. `cancelled` — withdrawn before the bridge accepted it.
+ */
+export type JobState = "pending" | "accepted" | "succeeded" | "partial" | "failed" | "cancelled";
+/**
+ * The VTC's identifier for the job, unique across the VTC's jobs. The same identifier git-ns/bridge/job (0.4 and 0.5) assigns and git-ns/bridge/result/0.1 reports against.
+ */
+export type JobId = string;
+/**
+ * What the job asks the bridge to do — the same eight kinds git-ns/bridge/job/0.5 defines. Kept as its own enum here, rather than a cross-file $ref, because job/0.5 declares its `kind` inline rather than as a named $def; the two lists change together.
+ */
+export type JobKind =
+  | "projectRoles"
+  | "createRepo"
+  | "bootstrap"
+  | "archive"
+  | "inspect"
+  | "beginBind"
+  | "beginAccountLink"
+  | "closePullRequest";
+
+/**
+ * A namespace's administrators list the bridge jobs queued or run for it — every namespace, for a community administrator — with each job's kind, state and last error. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
+ */
+export interface GitNamespacesListBridgeJobsPayload {
+  /**
+   * Only jobs in this namespace. Absent: every administered namespace.
+   */
+  namespace?: NamespaceId;
+  state?: JobState;
+  /**
+   * Opaque continuation token from a previous response's `nextCursor`. A consumer supplying a `cursor` MUST NOT also change `namespace` or `state` from the request that produced it — start a fresh query instead.
+   */
+  cursor?: string;
+  /**
+   * Maximum jobs to return in this page. A VTC clamps to 1..=500 (default 100).
+   */
+  limit?: number;
+  ext?: Ext;
+}
+/**
+ * The matching jobs, newest first.
+ */
+export interface GitNamespacesListBridgeJobsResponsePayload {
+  /**
+   * Jobs matching `namespace` and `state`, newest (`createdAt`) first.
+   */
+  jobs: JobRow[];
+  /**
+   * Continuation token for the next page, or `null` when this is the last.
+   */
+  nextCursor?: string | null;
+  ext?: Ext;
+}
+/**
+ * One bridge job as the administrator's console shows it.
+ */
+export interface JobRow {
+  jobId: JobId;
+  namespace: NamespaceId;
+  /**
+   * The bridge the job was dispatched to.
+   */
+  bridgeDid: Did;
+  kind: JobKind;
+  state: JobState;
+  /**
+   * The repository the job acts on. Absent for a namespace-wide `inspect` sweep or a job with no repository (`beginBind`, `beginAccountLink`).
+   */
+  repo?: RepoResource;
+  /**
+   * The pull request a `closePullRequest` job closes, in `repo` — the job's own `number`. Present for a `closePullRequest` job and absent for every other kind.
+   */
+  number?: number;
+  /**
+   * How many times the VTC has dispatched this job to a bridge.
+   */
+  attempts: number;
+  /**
+   * When the VTC queued the job.
+   */
+  createdAt: string;
+  /**
+   * When a bridge last accepted it. Absent while `state` is `pending` or `cancelled`.
+   */
+  acceptedAt?: string;
+  /**
+   * The bridge's last reported error, verbatim. Diagnostic prose for an administrator; a consumer MUST NOT parse it. Absent unless `state` is `partial` or `failed`.
+   */
+  lastError?: string;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Did, Ext, NamespaceId, RepoResource };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/git-ns/bridge/job/list/0.2" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = GitNamespacesListBridgeJobsPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/git-ns/bridge/job/list/0.2#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = GitNamespacesListBridgeJobsResponsePayload;
+
+/**
+ * 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/git-ns/bridge/job/list/0.2",
+  "title": "Git Namespaces — List Bridge Jobs — payload",
+  "description": "A namespace's administrators list the bridge jobs queued or run for it — every namespace, for a community administrator — with each job's kind, state and last error. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "namespace": {
+      "$ref": "#/$defs/NamespaceId",
+      "description": "Only jobs in this namespace. Absent: every administered namespace."
+    },
+    "state": {
+      "$ref": "#/$defs/JobState"
+    },
+    "cursor": {
+      "type": "string",
+      "description": "Opaque continuation token from a previous response's `nextCursor`. A consumer supplying a `cursor` MUST NOT also change `namespace` or `state` from the request that produced it — start a fresh query instead."
+    },
+    "limit": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 500,
+      "description": "Maximum jobs to return in this page. A VTC clamps to 1..=500 (default 100)."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "JobId": {
+      "title": "JobId",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "description": "The VTC's identifier for the job, unique across the VTC's jobs. The same identifier git-ns/bridge/job (0.4 and 0.5) assigns and git-ns/bridge/result/0.1 reports against."
+    },
+    "JobKind": {
+      "title": "JobKind",
+      "type": "string",
+      "enum": [
+        "projectRoles",
+        "createRepo",
+        "bootstrap",
+        "archive",
+        "inspect",
+        "beginBind",
+        "beginAccountLink",
+        "closePullRequest"
+      ],
+      "description": "What the job asks the bridge to do — the same eight kinds git-ns/bridge/job/0.5 defines. Kept as its own enum here, rather than a cross-file $ref, because job/0.5 declares its `kind` inline rather than as a named $def; the two lists change together."
+    },
+    "JobState": {
+      "title": "JobState",
+      "type": "string",
+      "enum": [
+        "pending",
+        "accepted",
+        "succeeded",
+        "partial",
+        "failed",
+        "cancelled"
+      ],
+      "description": "The VTC's own queue state for the job, driven by git-ns/bridge/result/0.1 reports. `pending` — queued, not yet accepted. `accepted` — the bridge has taken it and not yet reported an outcome. `succeeded` — every step completed. `partial` — some steps completed and at least one did not. `failed` — no step completed. `cancelled` — withdrawn before the bridge accepted it."
+    },
+    "JobRow": {
+      "title": "JobRow",
+      "description": "One bridge job as the administrator's console shows it.",
+      "type": "object",
+      "additionalProperties": false,
+      "dependentRequired": {
+        "number": [
+          "repo"
+        ]
+      },
+      "required": [
+        "jobId",
+        "namespace",
+        "bridgeDid",
+        "kind",
+        "state",
+        "attempts",
+        "createdAt"
+      ],
+      "properties": {
+        "jobId": {
+          "$ref": "#/$defs/JobId"
+        },
+        "namespace": {
+          "$ref": "#/$defs/NamespaceId"
+        },
+        "bridgeDid": {
+          "$ref": "#/$defs/Did",
+          "description": "The bridge the job was dispatched to."
+        },
+        "kind": {
+          "$ref": "#/$defs/JobKind"
+        },
+        "state": {
+          "$ref": "#/$defs/JobState"
+        },
+        "repo": {
+          "$ref": "#/$defs/RepoResource",
+          "description": "The repository the job acts on. Absent for a namespace-wide `inspect` sweep or a job with no repository (`beginBind`, `beginAccountLink`)."
+        },
+        "number": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "The pull request a `closePullRequest` job closes, in `repo` — the job's own `number`. Present for a `closePullRequest` job and absent for every other kind."
+        },
+        "attempts": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "How many times the VTC has dispatched this job to a bridge."
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the VTC queued the job."
+        },
+        "acceptedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When a bridge last accepted it. Absent while `state` is `pending` or `cancelled`."
+        },
+        "lastError": {
+          "type": "string",
+          "maxLength": 1024,
+          "description": "The bridge's last reported error, verbatim. Diagnostic prose for an administrator; a consumer MUST NOT parse it. Absent unless `state` is `partial` or `failed`."
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "Git Namespaces — List Bridge Jobs — response payload",
+      "description": "The matching jobs, newest first.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "jobs"
+      ],
+      "properties": {
+        "jobs": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/JobRow"
+          },
+          "description": "Jobs matching `namespace` and `state`, newest (`createdAt`) first."
+        },
+        "nextCursor": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "description": "Continuation token for the next page, or `null` when this is the last."
+        },
+        "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-]+)+$"
+      }
+    },
+    "RepoResource": {
+      "title": "RepoResource",
+      "description": "A forge-qualified resource naming exactly one repository: `<forge-host>/<owner>/<repo>`, lowercase.",
+      "type": "string",
+      "maxLength": 455,
+      "pattern": "^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?(?:\\.[a-z0-9](?:[a-z0-9-]*[a-z0-9])?)+/[a-z0-9_-][a-z0-9._-]{0,99}/[a-z0-9_-][a-z0-9._-]{0,99}$"
+    },
+    "Did": {
+      "title": "Did",
+      "description": "A bare DID in the W3C DID Core syntax (§3.1): `did:`, a method name of lowercase letters and digits, `:`, and a method-specific id of colon-separated segments drawn from `A-Z a-z 0-9 . - _` and percent-encoded octets, the last segment non-empty. A DID URL is not a DID: no path, query or fragment (`/`, `?`, `#`), so a verification-method id such as `did:key:z6Mk…#z6Mk…` is refused. Compared by exact string equality — no case folding or percent-decoding. A consumer MUST still treat the value as data: the pattern keeps shell metacharacters, whitespace and quotes out of the wire form, but it does not make a DID safe to splice into a command or markup.",
+      "type": "string",
+      "maxLength": 2048,
+      "pattern": "^did:[a-z0-9]+:(?:(?:[A-Za-z0-9._-]|%[0-9A-Fa-f]{2})*:)*(?:[A-Za-z0-9._-]|%[0-9A-Fa-f]{2})+$"
+    },
+    "NamespaceId": {
+      "title": "NamespaceId",
+      "description": "The VTC's opaque identifier for a namespace, assigned when it is bound. Stable for the life of the binding; never reused for another binding.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128
+    }
+  }
+} 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": {
+    "JobId": {
+      "title": "JobId",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "description": "The VTC's identifier for the job, unique across the VTC's jobs. The same identifier git-ns/bridge/job (0.4 and 0.5) assigns and git-ns/bridge/result/0.1 reports against."
+    },
+    "JobKind": {
+      "title": "JobKind",
+      "type": "string",
+      "enum": [
+        "projectRoles",
+        "createRepo",
+        "bootstrap",
+        "archive",
+        "inspect",
+        "beginBind",
+        "beginAccountLink",
+        "closePullRequest"
+      ],
+      "description": "What the job asks the bridge to do — the same eight kinds git-ns/bridge/job/0.5 defines. Kept as its own enum here, rather than a cross-file $ref, because job/0.5 declares its `kind` inline rather than as a named $def; the two lists change together."
+    },
+    "JobState": {
+      "title": "JobState",
+      "type": "string",
+      "enum": [
+        "pending",
+        "accepted",
+        "succeeded",
+        "partial",
+        "failed",
+        "cancelled"
+      ],
+      "description": "The VTC's own queue state for the job, driven by git-ns/bridge/result/0.1 reports. `pending` — queued, not yet accepted. `accepted` — the bridge has taken it and not yet reported an outcome. `succeeded` — every step completed. `partial` — some steps completed and at least one did not. `failed` — no step completed. `cancelled` — withdrawn before the bridge accepted it."
+    },
+    "JobRow": {
+      "title": "JobRow",
+      "description": "One bridge job as the administrator's console shows it.",
+      "type": "object",
+      "additionalProperties": false,
+      "dependentRequired": {
+        "number": [
+          "repo"
+        ]
+      },
+      "required": [
+        "jobId",
+        "namespace",
+        "bridgeDid",
+        "kind",
+        "state",
+        "attempts",
+        "createdAt"
+      ],
+      "properties": {
+        "jobId": {
+          "$ref": "#/$defs/JobId"
+        },
+        "namespace": {
+          "$ref": "#/$defs/NamespaceId"
+        },
+        "bridgeDid": {
+          "$ref": "#/$defs/Did",
+          "description": "The bridge the job was dispatched to."
+        },
+        "kind": {
+          "$ref": "#/$defs/JobKind"
+        },
+        "state": {
+          "$ref": "#/$defs/JobState"
+        },
+        "repo": {
+          "$ref": "#/$defs/RepoResource",
+          "description": "The repository the job acts on. Absent for a namespace-wide `inspect` sweep or a job with no repository (`beginBind`, `beginAccountLink`)."
+        },
+        "number": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "The pull request a `closePullRequest` job closes, in `repo` — the job's own `number`. Present for a `closePullRequest` job and absent for every other kind."
+        },
+        "attempts": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "How many times the VTC has dispatched this job to a bridge."
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the VTC queued the job."
+        },
+        "acceptedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When a bridge last accepted it. Absent while `state` is `pending` or `cancelled`."
+        },
+        "lastError": {
+          "type": "string",
+          "maxLength": 1024,
+          "description": "The bridge's last reported error, verbatim. Diagnostic prose for an administrator; a consumer MUST NOT parse it. Absent unless `state` is `partial` or `failed`."
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "Git Namespaces — List Bridge Jobs — response payload",
+      "description": "The matching jobs, newest first.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "jobs"
+      ],
+      "properties": {
+        "jobs": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/JobRow"
+          },
+          "description": "Jobs matching `namespace` and `state`, newest (`createdAt`) first."
+        },
+        "nextCursor": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "description": "Continuation token for the next page, or `null` when this is the last."
+        },
+        "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-]+)+$"
+      }
+    },
+    "RepoResource": {
+      "title": "RepoResource",
+      "description": "A forge-qualified resource naming exactly one repository: `<forge-host>/<owner>/<repo>`, lowercase.",
+      "type": "string",
+      "maxLength": 455,
+      "pattern": "^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?(?:\\.[a-z0-9](?:[a-z0-9-]*[a-z0-9])?)+/[a-z0-9_-][a-z0-9._-]{0,99}/[a-z0-9_-][a-z0-9._-]{0,99}$"
+    },
+    "Did": {
+      "title": "Did",
+      "description": "A bare DID in the W3C DID Core syntax (§3.1): `did:`, a method name of lowercase letters and digits, `:`, and a method-specific id of colon-separated segments drawn from `A-Z a-z 0-9 . - _` and percent-encoded octets, the last segment non-empty. A DID URL is not a DID: no path, query or fragment (`/`, `?`, `#`), so a verification-method id such as `did:key:z6Mk…#z6Mk…` is refused. Compared by exact string equality — no case folding or percent-decoding. A consumer MUST still treat the value as data: the pattern keeps shell metacharacters, whitespace and quotes out of the wire form, but it does not make a DID safe to splice into a command or markup.",
+      "type": "string",
+      "maxLength": 2048,
+      "pattern": "^did:[a-z0-9]+:(?:(?:[A-Za-z0-9._-]|%[0-9A-Fa-f]{2})*:)*(?:[A-Za-z0-9._-]|%[0-9A-Fa-f]{2})+$"
+    },
+    "NamespaceId": {
+      "title": "NamespaceId",
+      "description": "The VTC's opaque identifier for a namespace, assigned when it is bound. Stable for the life of the binding; never reused for another binding.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128
+    }
+  }
+} 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: false,
+  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: false,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;

package/src/index.ts

@@ -221,6 +221,7 @@ export * as GitNsBridgeJob_v0_3 from "./git-ns/bridge/job/0.3/payload.js";
 export * as GitNsBridgeJob_v0_4 from "./git-ns/bridge/job/0.4/payload.js";
 export * as GitNsBridgeJob_v0_5 from "./git-ns/bridge/job/0.5/payload.js";
 export * as GitNsBridgeJobList_v0_1 from "./git-ns/bridge/job/list/0.1/payload.js";
+export * as GitNsBridgeJobList_v0_2 from "./git-ns/bridge/job/list/0.2/payload.js";
 export * as GitNsBridgeResult_v0_1 from "./git-ns/bridge/result/0.1/payload.js";
 export * as GitNsDriftResolve_v0_1 from "./git-ns/drift/resolve/0.1/payload.js";
 export * as GitNsDriftResolve_v0_2 from "./git-ns/drift/resolve/0.2/payload.js";