@openvtc/trust-tasks 0.20.1 → 0.20.3

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

@@ -0,0 +1,242 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/git-ns/account/link/0.1/payload.schema.json
+ */
+
+import type { Ext, ForgeHost } from "../../../../_shared/components.js";
+
+
+/**
+ * A member begins linking their account on a forge to their DID. The response carries where the member goes to authorise it; the member then polls git-ns/account/link-status.
+ */
+export interface GitNamespacesLinkForgeAccountPayload {
+  /**
+   * The forge whose account to link.
+   */
+  forge: ForgeHost;
+  ext?: Ext;
+}
+/**
+ * Where to authorise the link.
+ */
+export interface GitNamespacesLinkForgeAccountResponsePayload {
+  /**
+   * Identifies this attempt for git-ns/account/link-status. Opaque; meaningful only to the member who began it.
+   */
+  linkId: string;
+  /**
+   * Where the member authorises the link: the device-code entry page (GitHub), or the forge's authorisation page (Forgejo, authorisation code with PKCE).
+   */
+  url: string;
+  /**
+   * The code the member types at `url`, for a forge that uses a device flow. Absent otherwise.
+   */
+  userCode?: string;
+  /**
+   * When this attempt lapses if not completed.
+   */
+  expiresAt: string;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, ForgeHost };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/git-ns/account/link/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = GitNamespacesLinkForgeAccountPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/git-ns/account/link/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = GitNamespacesLinkForgeAccountResponsePayload;
+
+/**
+ * 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/link/0.1",
+  "title": "Git Namespaces — Link Forge Account — payload",
+  "description": "A member begins linking their account on a forge to their DID. The response carries where the member goes to authorise it; the member then polls git-ns/account/link-status.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "forge"
+  ],
+  "properties": {
+    "forge": {
+      "$ref": "#/$defs/ForgeHost",
+      "description": "The forge whose account to link."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Git Namespaces — Link Forge Account — response payload",
+      "description": "Where to authorise the link.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "linkId",
+        "url",
+        "expiresAt"
+      ],
+      "properties": {
+        "linkId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "Identifies this attempt for git-ns/account/link-status. Opaque; meaningful only to the member who began it."
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "maxLength": 2048,
+          "pattern": "^https://",
+          "description": "Where the member authorises the link: the device-code entry page (GitHub), or the forge's authorisation page (Forgejo, authorisation code with PKCE)."
+        },
+        "userCode": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 64,
+          "description": "The code the member types at `url`, for a forge that uses a device flow. Absent otherwise."
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When this attempt lapses if not completed."
+        },
+        "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-]+)+$"
+      }
+    },
+    "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])?)+$"
+    }
+  }
+} 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": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Git Namespaces — Link Forge Account — response payload",
+      "description": "Where to authorise the link.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "linkId",
+        "url",
+        "expiresAt"
+      ],
+      "properties": {
+        "linkId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "Identifies this attempt for git-ns/account/link-status. Opaque; meaningful only to the member who began it."
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "maxLength": 2048,
+          "pattern": "^https://",
+          "description": "Where the member authorises the link: the device-code entry page (GitHub), or the forge's authorisation page (Forgejo, authorisation code with PKCE)."
+        },
+        "userCode": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 64,
+          "description": "The code the member types at `url`, for a forge that uses a device flow. Absent otherwise."
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When this attempt lapses if not completed."
+        },
+        "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-]+)+$"
+      }
+    },
+    "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])?)+$"
+    }
+  }
+} 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;

package/src/git-ns/account/link-status/0.1/payload.ts

@@ -0,0 +1,276 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/git-ns/account/link-status/0.1/payload.schema.json
+ */
+
+import type { Ext, ForgeAccount, ForgeHost, ForgeId } from "../../../../_shared/components.js";
+
+
+/**
+ * A member asks where a forge account link they began stands.
+ */
+export interface GitNamespacesForgeAccountLinkStatusPayload {
+  /**
+   * From git-ns/account/link.
+   */
+  linkId: string;
+  ext?: Ext;
+}
+/**
+ * Where the link stands.
+ */
+export interface GitNamespacesForgeAccountLinkStatusResponsePayload {
+  /**
+   * `pending` — waiting for the member to authorise. `linked` — the account is bound to the member's DID. `expired` — not authorised in time. `failed` — the forge refused, or the account is already linked to another member.
+   */
+  state: "pending" | "linked" | "expired" | "failed";
+  /**
+   * The linked account. Present only when `state` is `linked`.
+   */
+  account?: ForgeAccount;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, ForgeAccount, ForgeHost, ForgeId };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/git-ns/account/link-status/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = GitNamespacesForgeAccountLinkStatusPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/git-ns/account/link-status/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = GitNamespacesForgeAccountLinkStatusResponsePayload;
+
+/**
+ * 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/link-status/0.1",
+  "title": "Git Namespaces — Forge Account Link Status — payload",
+  "description": "A member asks where a forge account link they began stands.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "linkId"
+  ],
+  "properties": {
+    "linkId": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "description": "From git-ns/account/link."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Git Namespaces — Forge Account Link Status — response payload",
+      "description": "Where the link stands.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "state"
+      ],
+      "properties": {
+        "state": {
+          "type": "string",
+          "enum": [
+            "pending",
+            "linked",
+            "expired",
+            "failed"
+          ],
+          "description": "`pending` — waiting for the member to authorise. `linked` — the account is bound to the member's DID. `expired` — not authorised in time. `failed` — the forge refused, or the account is already linked to another member."
+        },
+        "account": {
+          "$ref": "#/$defs/ForgeAccount",
+          "description": "The linked account. Present only when `state` is `linked`."
+        },
+        "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])?)+$"
+    }
+  }
+} 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": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Git Namespaces — Forge Account Link Status — response payload",
+      "description": "Where the link stands.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "state"
+      ],
+      "properties": {
+        "state": {
+          "type": "string",
+          "enum": [
+            "pending",
+            "linked",
+            "expired",
+            "failed"
+          ],
+          "description": "`pending` — waiting for the member to authorise. `linked` — the account is bound to the member's DID. `expired` — not authorised in time. `failed` — the forge refused, or the account is already linked to another member."
+        },
+        "account": {
+          "$ref": "#/$defs/ForgeAccount",
+          "description": "The linked account. Present only when `state` is `linked`."
+        },
+        "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])?)+$"
+    }
+  }
+} 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: false,
+  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: false,
+  isRecipientRequired: true,
+  isIssuedAtRequired: false,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;