@openvtc/trust-tasks 0.20.7 → 0.21.0

package/src/git-ns/right/break-glass-notice/0.1/payload.ts

@@ -0,0 +1,258 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/git-ns/right/break-glass-notice/0.1/payload.schema.json
+ */
+
+import type { BreakGlass, Did_GitNsV0_3 as Did, Ext, NamespaceId, Resource, Right, RightRecord_GitNsV0_4 as RightRecord } from "../../../../_shared/components.js";
+
+
+/**
+ * The VTC tells an administrator that a member broke the glass on an elevated git right, or that a break-glass record was ratified or revoked. Unsolicited: it answers no request from the recipient.
+ */
+export interface GitNamespacesBreakGlassNoticePayload {
+  /**
+   * `breakGlass` — `record.subject` recorded the right for themselves with git-ns/right/break-glass. `ratified` — another administrator ratified it with git-ns/right/ratify. `revoked` — it was revoked with git-ns/right/revoke, before or after ratification.
+   */
+  event: "breakGlass" | "ratified" | "revoked";
+  /**
+   * The namespace the record's resource lies in.
+   */
+  namespace: NamespaceId;
+  /**
+   * The record as it stands after the event — for `revoked`, as it stood when it was revoked. Always carries `breakGlass`, justification included.
+   */
+  record: RightRecord;
+  /**
+   * Who acted: the subject for `breakGlass`, the ratifier for `ratified`, the revoker for `revoked`.
+   */
+  by: Did;
+  /**
+   * When the event took effect at the VTC — not when the notice was sent, which differs whenever the recipient was offline.
+   */
+  at: string;
+  /**
+   * For `ratified`, the ratifier's statement; for `revoked`, the revoker's reason. Absent when none was given, and always for `breakGlass`, whose justification is in `record.breakGlass`.
+   */
+  statement?: string;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { BreakGlass, Did, Ext, NamespaceId, Resource, Right, RightRecord };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/git-ns/right/break-glass-notice/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = GitNamespacesBreakGlassNoticePayload;
+
+/**
+ * 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/right/break-glass-notice/0.1",
+  "title": "Git Namespaces — Break-Glass Notice — payload",
+  "description": "The VTC tells an administrator that a member broke the glass on an elevated git right, or that a break-glass record was ratified or revoked. Unsolicited: it answers no request from the recipient.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "event",
+    "namespace",
+    "record",
+    "by",
+    "at"
+  ],
+  "properties": {
+    "event": {
+      "type": "string",
+      "enum": [
+        "breakGlass",
+        "ratified",
+        "revoked"
+      ],
+      "description": "`breakGlass` — `record.subject` recorded the right for themselves with git-ns/right/break-glass. `ratified` — another administrator ratified it with git-ns/right/ratify. `revoked` — it was revoked with git-ns/right/revoke, before or after ratification."
+    },
+    "namespace": {
+      "$ref": "#/$defs/NamespaceId",
+      "description": "The namespace the record's resource lies in."
+    },
+    "record": {
+      "$ref": "#/$defs/RightRecord",
+      "description": "The record as it stands after the event — for `revoked`, as it stood when it was revoked. Always carries `breakGlass`, justification included."
+    },
+    "by": {
+      "$ref": "#/$defs/Did",
+      "description": "Who acted: the subject for `breakGlass`, the ratifier for `ratified`, the revoker for `revoked`."
+    },
+    "at": {
+      "type": "string",
+      "format": "date-time",
+      "description": "When the event took effect at the VTC — not when the notice was sent, which differs whenever the recipient was offline."
+    },
+    "statement": {
+      "type": "string",
+      "maxLength": 1024,
+      "description": "For `ratified`, the ratifier's statement; for `revoked`, the revoker's reason. Absent when none was given, and always for `breakGlass`, whose justification is in `record.breakGlass`."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "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-]+)+$"
+      }
+    },
+    "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})+$"
+    },
+    "RightRecord": {
+      "title": "RightRecord",
+      "description": "One recorded right. Implied rights (§4.2 of the rights model: `own` implies `maintain` implies `commit.sign` on the same resource; `ns.admin` implies `repo.create` and `own` across its namespace) are not records and never appear as RightRecords. A record carrying `breakGlass` was given by its subject to themselves through git-ns/right/break-glass; it is a real right, published like any other, and is shown with that flag on every surface that shows the record.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "subject",
+        "right",
+        "resource",
+        "grantedBy",
+        "grantedAt"
+      ],
+      "properties": {
+        "subject": {
+          "$ref": "#/$defs/Did",
+          "description": "Who holds the right. For `git.commit.sign` this is the DID whose commit signatures the CI check accepts."
+        },
+        "right": {
+          "$ref": "#/$defs/Right"
+        },
+        "resource": {
+          "$ref": "#/$defs/Resource"
+        },
+        "grantedBy": {
+          "$ref": "#/$defs/Did",
+          "description": "The actor whose task caused the right: the granter, the creator of a repository (for its first `own`), the adopting admin, the transferring owner, or the binding admin (for the first `git.ns.admin`). The VTC's own DID for a right it derives from its configuration."
+        },
+        "grantedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the right lapses. Absent: no expiry."
+        },
+        "reason": {
+          "type": "string",
+          "maxLength": 1024,
+          "description": "The granter's free-text reason. Disclosed only to holders of `git.repo.own` on the resource and of `git.ns.admin` over it."
+        },
+        "breakGlass": {
+          "$ref": "#/$defs/BreakGlass",
+          "description": "Present exactly when the subject gave themselves this right through git-ns/right/break-glass. Absent for every other record."
+        }
+      }
+    },
+    "BreakGlass": {
+      "title": "BreakGlass",
+      "description": "How a self-granted right came to be, and whether another administrator has since ratified it. A record whose `breakGlass` has no `ratifiedBy` is **unratified**: it is live and published like any other right, it does not count toward the last-owner or last-admin invariants, and any community administrator or namespace admin of its namespace may revoke it. Ratification (git-ns/right/ratify) sets `ratifiedBy` and `ratifiedAt`; from then on the record is an ordinary grant, and `breakGlass` stays as its history. Never published to the Trust Registry.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "by",
+        "at",
+        "justification"
+      ],
+      "properties": {
+        "by": {
+          "$ref": "#/$defs/Did",
+          "description": "Who broke the glass: always the record's `subject`, restated so the flag reads on its own."
+        },
+        "at": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the VTC recorded the break-glass."
+        },
+        "justification": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 2048,
+          "pattern": "\\S",
+          "description": "The actor's statement of why nobody else could grant this right. Shown to every community administrator, every namespace admin of the namespace and every owner of the resource; kept in the audit record; never published."
+        },
+        "effectiveAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the right takes effect, where the community's policy imposed a delay. Absent: it took effect at `at`. Until this instant the record confers nothing and is not published, and any administrator who may revoke it may do so."
+        },
+        "ratifiedBy": {
+          "$ref": "#/$defs/Did",
+          "description": "The administrator who ratified the record — never its subject. Absent while unratified."
+        },
+        "ratifiedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When it was ratified. Present exactly when `ratifiedBy` is."
+        }
+      }
+    },
+    "Resource": {
+      "title": "Resource",
+      "description": "A forge-qualified resource: `<forge-host>/<owner>` for a namespace, or `<forge-host>/<owner>/<repo>` for one repository, all lowercase — `github.com/acme`, `github.com/acme/widgets`, `codeberg.org/acme`. The forge is never implied: `acme/widgets` alone is not a resource. Containment is by whole segment: `github.com/acme` contains `github.com/acme/widgets` and does not contain `github.com/acme-labs/x` or `codeberg.org/acme/widgets`.",
+      "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}){1,2}$"
+    },
+    "Right": {
+      "title": "Right",
+      "description": "One of the five git rights. Each string is also the TRQP `action` the VTC publishes the right under in its Trust Registry, so it is carried verbatim. `git.ns.admin` and `git.repo.create` apply to a namespace resource; `git.repo.own` and `git.repo.maintain` to a repository resource; `git.commit.sign` to either.",
+      "type": "string",
+      "enum": [
+        "git.ns.admin",
+        "git.repo.create",
+        "git.repo.own",
+        "git.repo.maintain",
+        "git.commit.sign"
+      ]
+    },
+    "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: true,
+  payloadSchema: PAYLOAD_SCHEMA,
+} as const;