@openvtc/trust-tasks 0.21.13 → 0.21.14

package/src/git-ns/account/list/0.1/payload.ts

@@ -0,0 +1,392 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/git-ns/account/list/0.1/payload.schema.json
+ */
+
+import type { Did_GitNsV0_3 as Did, Ext, ForgeAccount, ForgeHost, ForgeId } from "../../../../_shared/components.js";
+
+
+/**
+ * A community administrator lists every member's linked forge accounts, community-wide. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
+ */
+export interface GitNamespacesListLinkedForgeAccountsPayload {
+  /**
+   * Only this member's linked accounts. Absent: every member.
+   */
+  member?: Did;
+  /**
+   * Only accounts linked on this forge. Absent: every forge.
+   */
+  forge?: ForgeHost;
+  /**
+   * Opaque continuation token from a previous response's `nextCursor`. A consumer supplying a `cursor` MUST NOT also change `member` or `forge` from the request that produced it — start a fresh query instead.
+   */
+  cursor?: string;
+  /**
+   * Maximum accounts to return in this page. A VTC clamps to 1..=500 (default 100).
+   */
+  limit?: number;
+  ext?: Ext;
+}
+/**
+ * The matching links, ordered by member then forge.
+ */
+export interface GitNamespacesListLinkedForgeAccountsResponsePayload {
+  /**
+   * Links matching `member` and `forge`, ordered by `member` then `account.forge`. At most one per member per forge.
+   */
+  accounts: AccountRow[];
+  /**
+   * Continuation token for the next page, or `null` when this is the last.
+   */
+  nextCursor?: string | null;
+  ext?: Ext;
+}
+/**
+ * One member's account on one forge, as linked through git-ns/account/link.
+ */
+export interface AccountRow {
+  /**
+   * The member the account is linked to.
+   */
+  member: Did;
+  /**
+   * The linked account. `id` is authoritative; `login` is as the forge last reported it — display only.
+   */
+  account: ForgeAccount;
+  /**
+   * When the VTC recorded the link. Absent for a link recorded before this member was tracked.
+   */
+  linkedAt?: string;
+  /**
+   * Whether `member` is still a current member. One whose access lapsed keeps the link — nobody else may link the account — but it projects no forge role, and a forge role it holds cannot be adopted as a right.
+   */
+  memberCurrent: boolean;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Did, Ext, ForgeAccount, ForgeHost, ForgeId };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/git-ns/account/list/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = GitNamespacesListLinkedForgeAccountsPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/git-ns/account/list/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = GitNamespacesListLinkedForgeAccountsResponsePayload;
+
+/**
+ * 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/account/list/0.1",
+  "title": "Git Namespaces — List Linked Forge Accounts — payload",
+  "description": "A community administrator lists every member's linked forge accounts, community-wide. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "member": {
+      "$ref": "#/$defs/Did",
+      "description": "Only this member's linked accounts. Absent: every member."
+    },
+    "forge": {
+      "$ref": "#/$defs/ForgeHost",
+      "description": "Only accounts linked on this forge. Absent: every forge."
+    },
+    "cursor": {
+      "type": "string",
+      "description": "Opaque continuation token from a previous response's `nextCursor`. A consumer supplying a `cursor` MUST NOT also change `member` or `forge` from the request that produced it — start a fresh query instead."
+    },
+    "limit": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 500,
+      "description": "Maximum accounts to return in this page. A VTC clamps to 1..=500 (default 100)."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "AccountRow": {
+      "title": "AccountRow",
+      "description": "One member's account on one forge, as linked through git-ns/account/link.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "member",
+        "account",
+        "memberCurrent"
+      ],
+      "properties": {
+        "member": {
+          "$ref": "#/$defs/Did",
+          "description": "The member the account is linked to."
+        },
+        "account": {
+          "$ref": "#/$defs/ForgeAccount",
+          "description": "The linked account. `id` is authoritative; `login` is as the forge last reported it — display only."
+        },
+        "linkedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the VTC recorded the link. Absent for a link recorded before this member was tracked."
+        },
+        "memberCurrent": {
+          "type": "boolean",
+          "description": "Whether `member` is still a current member. One whose access lapsed keeps the link — nobody else may link the account — but it projects no forge role, and a forge role it holds cannot be adopted as a right."
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "Git Namespaces — List Linked Forge Accounts — response payload",
+      "description": "The matching links, ordered by member then forge.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "accounts"
+      ],
+      "properties": {
+        "accounts": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/AccountRow"
+          },
+          "description": "Links matching `member` and `forge`, ordered by `member` then `account.forge`. At most one per member per forge."
+        },
+        "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-]+)+$"
+      }
+    },
+    "ForgeAccount": {
+      "title": "ForgeAccount",
+      "description": "A person's account on one forge. `id` is authoritative; `login` is for display only, because logins can be renamed and re-registered.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "forge",
+        "id",
+        "login"
+      ],
+      "properties": {
+        "forge": {
+          "$ref": "#/$defs/ForgeHost"
+        },
+        "id": {
+          "$ref": "#/$defs/ForgeId"
+        },
+        "login": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 100,
+          "description": "The account's current login, as the forge reported it when last seen. Display only."
+        }
+      }
+    },
+    "ForgeId": {
+      "title": "ForgeId",
+      "description": "An identifier the forge itself assigns — a repository id, a user or organisation id — carried as a string so a forge whose ids are not numbers needs no new version. GitHub and Forgejo ids are decimal integers written as strings (`\"812736451\"`). Unlike a name, it survives renames and transfers, which is why rights and bindings are keyed by it.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 64
+    },
+    "ForgeHost": {
+      "title": "ForgeHost",
+      "description": "The lowercased DNS host of a forge: `github.com`, a GitHub Enterprise Server host, `codeberg.org`, or a self-hosted Forgejo instance such as `git.example.org`. No scheme, no port, no path. The host is a segment of every resource, so a right never crosses forges.",
+      "type": "string",
+      "minLength": 3,
+      "maxLength": 253,
+      "pattern": "^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?(?:\\.[a-z0-9](?:[a-z0-9-]*[a-z0-9])?)+$"
+    },
+    "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})+$"
+    }
+  }
+} 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": {
+    "AccountRow": {
+      "title": "AccountRow",
+      "description": "One member's account on one forge, as linked through git-ns/account/link.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "member",
+        "account",
+        "memberCurrent"
+      ],
+      "properties": {
+        "member": {
+          "$ref": "#/$defs/Did",
+          "description": "The member the account is linked to."
+        },
+        "account": {
+          "$ref": "#/$defs/ForgeAccount",
+          "description": "The linked account. `id` is authoritative; `login` is as the forge last reported it — display only."
+        },
+        "linkedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the VTC recorded the link. Absent for a link recorded before this member was tracked."
+        },
+        "memberCurrent": {
+          "type": "boolean",
+          "description": "Whether `member` is still a current member. One whose access lapsed keeps the link — nobody else may link the account — but it projects no forge role, and a forge role it holds cannot be adopted as a right."
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "Git Namespaces — List Linked Forge Accounts — response payload",
+      "description": "The matching links, ordered by member then forge.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "accounts"
+      ],
+      "properties": {
+        "accounts": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/AccountRow"
+          },
+          "description": "Links matching `member` and `forge`, ordered by `member` then `account.forge`. At most one per member per forge."
+        },
+        "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-]+)+$"
+      }
+    },
+    "ForgeAccount": {
+      "title": "ForgeAccount",
+      "description": "A person's account on one forge. `id` is authoritative; `login` is for display only, because logins can be renamed and re-registered.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "forge",
+        "id",
+        "login"
+      ],
+      "properties": {
+        "forge": {
+          "$ref": "#/$defs/ForgeHost"
+        },
+        "id": {
+          "$ref": "#/$defs/ForgeId"
+        },
+        "login": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 100,
+          "description": "The account's current login, as the forge reported it when last seen. Display only."
+        }
+      }
+    },
+    "ForgeId": {
+      "title": "ForgeId",
+      "description": "An identifier the forge itself assigns — a repository id, a user or organisation id — carried as a string so a forge whose ids are not numbers needs no new version. GitHub and Forgejo ids are decimal integers written as strings (`\"812736451\"`). Unlike a name, it survives renames and transfers, which is why rights and bindings are keyed by it.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 64
+    },
+    "ForgeHost": {
+      "title": "ForgeHost",
+      "description": "The lowercased DNS host of a forge: `github.com`, a GitHub Enterprise Server host, `codeberg.org`, or a self-hosted Forgejo instance such as `git.example.org`. No scheme, no port, no path. The host is a segment of every resource, so a right never crosses forges.",
+      "type": "string",
+      "minLength": 3,
+      "maxLength": 253,
+      "pattern": "^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?(?:\\.[a-z0-9](?:[a-z0-9-]*[a-z0-9])?)+$"
+    },
+    "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})+$"
+    }
+  }
+} 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;