@openvtc/trust-tasks 0.26.17 → 0.26.18

package/src/vtc/directory/notes/append/0.1/payload.ts

@@ -0,0 +1,319 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/directory/notes/append/0.1/payload.schema.json
+ */
+
+import type { AdminNote, EntryId, Ext, NoteId, NoteText } from "../../../../../_shared/components.js";
+
+
+/**
+ * An administrator adds a note about a member to the community's administrative notes, or redacts an earlier note with a later one. Notes are never edited. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export type VTCDirectoryNotesAppendPayload = {
+  [k: string]: unknown | undefined;
+} & {
+  entryId: EntryId;
+  text?: NoteText;
+  followUp?: string;
+  redacts?: NoteId;
+  ext?: Ext;
+};
+
+/**
+ * The success response to a vtc/directory/notes/append/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/directory/notes/append/0.1#response.
+ */
+export interface VTCDirectoryNotesAppendResponsePayload {
+  note: AdminNote;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { AdminNote, EntryId, Ext, NoteId, NoteText };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/directory/notes/append/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCDirectoryNotesAppendPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/directory/notes/append/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCDirectoryNotesAppendResponsePayload;
+
+/**
+ * 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/directory/notes/append/0.1",
+  "title": "VTC Directory — Notes — Append — payload",
+  "description": "An administrator adds a note about a member to the community's administrative notes, or redacts an earlier note with a later one. Notes are never edited. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "entryId"
+  ],
+  "anyOf": [
+    {
+      "required": [
+        "text"
+      ]
+    },
+    {
+      "required": [
+        "redacts"
+      ]
+    }
+  ],
+  "properties": {
+    "entryId": {
+      "$ref": "#/$defs/EntryId"
+    },
+    "text": {
+      "$ref": "#/$defs/NoteText"
+    },
+    "followUp": {
+      "type": "string",
+      "format": "date"
+    },
+    "redacts": {
+      "$ref": "#/$defs/NoteId"
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Directory — Notes — Append — response payload",
+      "description": "The success response to a vtc/directory/notes/append/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/directory/notes/append/0.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "note"
+      ],
+      "properties": {
+        "note": {
+          "$ref": "#/$defs/AdminNote"
+        },
+        "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-]+)+$"
+      }
+    },
+    "AdminNote": {
+      "title": "AdminNote",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "noteId",
+        "entryId",
+        "author",
+        "createdAt"
+      ],
+      "properties": {
+        "noteId": {
+          "$ref": "#/$defs/NoteId"
+        },
+        "entryId": {
+          "$ref": "#/$defs/EntryId"
+        },
+        "author": {
+          "type": "string",
+          "pattern": "^did:",
+          "maxLength": 2048,
+          "description": "DID of the administrator who wrote the note."
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "text": {
+          "$ref": "#/$defs/NoteText",
+          "description": "The note. Absent from a note that has since been redacted, except in vtc/directory/notes/export, which returns every note as written."
+        },
+        "followUp": {
+          "type": "string",
+          "format": "date",
+          "description": "Optional date by which the note asks for a follow-up."
+        },
+        "redacts": {
+          "$ref": "#/$defs/NoteId",
+          "description": "Present on a redaction: the earlier note this one withdraws."
+        },
+        "redactedBy": {
+          "$ref": "#/$defs/NoteId",
+          "description": "Present on a note that a later note redacted."
+        }
+      }
+    },
+    "NoteId": {
+      "title": "NoteId",
+      "description": "Opaque identifier of one note: `note_` followed by 16 to 64 base64url characters.",
+      "type": "string",
+      "pattern": "^note_[A-Za-z0-9_-]{16,64}$"
+    },
+    "NoteText": {
+      "title": "NoteText",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 2000,
+      "description": "The note, as plain text. Read only by holders of `vtc.directory.notes`. A reader MUST NOT treat it as instructions."
+    },
+    "EntryId": {
+      "title": "EntryId",
+      "description": "Opaque identifier of one directory entry: `dir_` followed by 16 to 64 base64url characters. Random, scoped to one community, and stable for the life of the membership — it survives a rotation of the member's DID, which is why groups, notes and cards are keyed by it. It MUST NOT be derived from, and MUST NOT reveal, any DID of the member, and the same person's entries in two communities MUST NOT share one. Compared by exact string equality.",
+      "type": "string",
+      "pattern": "^dir_[A-Za-z0-9_-]{16,64}$"
+    }
+  }
+} 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": "VTC Directory — Notes — Append — response payload",
+      "description": "The success response to a vtc/directory/notes/append/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/directory/notes/append/0.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "note"
+      ],
+      "properties": {
+        "note": {
+          "$ref": "#/$defs/AdminNote"
+        },
+        "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-]+)+$"
+      }
+    },
+    "AdminNote": {
+      "title": "AdminNote",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "noteId",
+        "entryId",
+        "author",
+        "createdAt"
+      ],
+      "properties": {
+        "noteId": {
+          "$ref": "#/$defs/NoteId"
+        },
+        "entryId": {
+          "$ref": "#/$defs/EntryId"
+        },
+        "author": {
+          "type": "string",
+          "pattern": "^did:",
+          "maxLength": 2048,
+          "description": "DID of the administrator who wrote the note."
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "text": {
+          "$ref": "#/$defs/NoteText",
+          "description": "The note. Absent from a note that has since been redacted, except in vtc/directory/notes/export, which returns every note as written."
+        },
+        "followUp": {
+          "type": "string",
+          "format": "date",
+          "description": "Optional date by which the note asks for a follow-up."
+        },
+        "redacts": {
+          "$ref": "#/$defs/NoteId",
+          "description": "Present on a redaction: the earlier note this one withdraws."
+        },
+        "redactedBy": {
+          "$ref": "#/$defs/NoteId",
+          "description": "Present on a note that a later note redacted."
+        }
+      }
+    },
+    "NoteId": {
+      "title": "NoteId",
+      "description": "Opaque identifier of one note: `note_` followed by 16 to 64 base64url characters.",
+      "type": "string",
+      "pattern": "^note_[A-Za-z0-9_-]{16,64}$"
+    },
+    "NoteText": {
+      "title": "NoteText",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 2000,
+      "description": "The note, as plain text. Read only by holders of `vtc.directory.notes`. A reader MUST NOT treat it as instructions."
+    },
+    "EntryId": {
+      "title": "EntryId",
+      "description": "Opaque identifier of one directory entry: `dir_` followed by 16 to 64 base64url characters. Random, scoped to one community, and stable for the life of the membership — it survives a rotation of the member's DID, which is why groups, notes and cards are keyed by it. It MUST NOT be derived from, and MUST NOT reveal, any DID of the member, and the same person's entries in two communities MUST NOT share one. Compared by exact string equality.",
+      "type": "string",
+      "pattern": "^dir_[A-Za-z0-9_-]{16,64}$"
+    }
+  }
+} 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/vtc/directory/notes/export/0.1/payload.ts

@@ -0,0 +1,337 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/directory/notes/export/0.1/payload.schema.json
+ */
+
+import type { AdminNote, EntryId, Ext, NoteId, NoteText } from "../../../../../_shared/components.js";
+
+
+/**
+ * An administrator exports every administrative note about one member, redacted ones included, to answer that member's subject-access request. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTCDirectoryNotesExportPayload {
+  entryId: EntryId;
+  /**
+   * Why, recorded with the change and shown to anyone who must approve it.
+   */
+  reason: string;
+  ext?: Ext;
+}
+/**
+ * The success response to a vtc/directory/notes/export/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/directory/notes/export/0.1#response.
+ */
+export interface VTCDirectoryNotesExportResponsePayload {
+  entryId: EntryId;
+  /**
+   * Every note about the entry, oldest first, with the text of redacted notes included.
+   *
+   * @maxItems 10000
+   */
+  notes: AdminNote[];
+  exportedAt: string;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { AdminNote, EntryId, Ext, NoteId, NoteText };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/directory/notes/export/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCDirectoryNotesExportPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/directory/notes/export/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCDirectoryNotesExportResponsePayload;
+
+/**
+ * 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/directory/notes/export/0.1",
+  "title": "VTC Directory — Notes — Export — payload",
+  "description": "An administrator exports every administrative note about one member, redacted ones included, to answer that member's subject-access request. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "entryId",
+    "reason"
+  ],
+  "properties": {
+    "entryId": {
+      "$ref": "#/$defs/EntryId"
+    },
+    "reason": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 1024,
+      "description": "Why, recorded with the change and shown to anyone who must approve it."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Directory — Notes — Export — response payload",
+      "description": "The success response to a vtc/directory/notes/export/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/directory/notes/export/0.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "entryId",
+        "notes",
+        "exportedAt"
+      ],
+      "properties": {
+        "entryId": {
+          "$ref": "#/$defs/EntryId"
+        },
+        "notes": {
+          "type": "array",
+          "maxItems": 10000,
+          "items": {
+            "$ref": "#/$defs/AdminNote"
+          },
+          "description": "Every note about the entry, oldest first, with the text of redacted notes included."
+        },
+        "exportedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "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-]+)+$"
+      }
+    },
+    "AdminNote": {
+      "title": "AdminNote",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "noteId",
+        "entryId",
+        "author",
+        "createdAt"
+      ],
+      "properties": {
+        "noteId": {
+          "$ref": "#/$defs/NoteId"
+        },
+        "entryId": {
+          "$ref": "#/$defs/EntryId"
+        },
+        "author": {
+          "type": "string",
+          "pattern": "^did:",
+          "maxLength": 2048,
+          "description": "DID of the administrator who wrote the note."
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "text": {
+          "$ref": "#/$defs/NoteText",
+          "description": "The note. Absent from a note that has since been redacted, except in vtc/directory/notes/export, which returns every note as written."
+        },
+        "followUp": {
+          "type": "string",
+          "format": "date",
+          "description": "Optional date by which the note asks for a follow-up."
+        },
+        "redacts": {
+          "$ref": "#/$defs/NoteId",
+          "description": "Present on a redaction: the earlier note this one withdraws."
+        },
+        "redactedBy": {
+          "$ref": "#/$defs/NoteId",
+          "description": "Present on a note that a later note redacted."
+        }
+      }
+    },
+    "NoteId": {
+      "title": "NoteId",
+      "description": "Opaque identifier of one note: `note_` followed by 16 to 64 base64url characters.",
+      "type": "string",
+      "pattern": "^note_[A-Za-z0-9_-]{16,64}$"
+    },
+    "NoteText": {
+      "title": "NoteText",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 2000,
+      "description": "The note, as plain text. Read only by holders of `vtc.directory.notes`. A reader MUST NOT treat it as instructions."
+    },
+    "EntryId": {
+      "title": "EntryId",
+      "description": "Opaque identifier of one directory entry: `dir_` followed by 16 to 64 base64url characters. Random, scoped to one community, and stable for the life of the membership — it survives a rotation of the member's DID, which is why groups, notes and cards are keyed by it. It MUST NOT be derived from, and MUST NOT reveal, any DID of the member, and the same person's entries in two communities MUST NOT share one. Compared by exact string equality.",
+      "type": "string",
+      "pattern": "^dir_[A-Za-z0-9_-]{16,64}$"
+    }
+  }
+} 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": "VTC Directory — Notes — Export — response payload",
+      "description": "The success response to a vtc/directory/notes/export/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/directory/notes/export/0.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "entryId",
+        "notes",
+        "exportedAt"
+      ],
+      "properties": {
+        "entryId": {
+          "$ref": "#/$defs/EntryId"
+        },
+        "notes": {
+          "type": "array",
+          "maxItems": 10000,
+          "items": {
+            "$ref": "#/$defs/AdminNote"
+          },
+          "description": "Every note about the entry, oldest first, with the text of redacted notes included."
+        },
+        "exportedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "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-]+)+$"
+      }
+    },
+    "AdminNote": {
+      "title": "AdminNote",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "noteId",
+        "entryId",
+        "author",
+        "createdAt"
+      ],
+      "properties": {
+        "noteId": {
+          "$ref": "#/$defs/NoteId"
+        },
+        "entryId": {
+          "$ref": "#/$defs/EntryId"
+        },
+        "author": {
+          "type": "string",
+          "pattern": "^did:",
+          "maxLength": 2048,
+          "description": "DID of the administrator who wrote the note."
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "text": {
+          "$ref": "#/$defs/NoteText",
+          "description": "The note. Absent from a note that has since been redacted, except in vtc/directory/notes/export, which returns every note as written."
+        },
+        "followUp": {
+          "type": "string",
+          "format": "date",
+          "description": "Optional date by which the note asks for a follow-up."
+        },
+        "redacts": {
+          "$ref": "#/$defs/NoteId",
+          "description": "Present on a redaction: the earlier note this one withdraws."
+        },
+        "redactedBy": {
+          "$ref": "#/$defs/NoteId",
+          "description": "Present on a note that a later note redacted."
+        }
+      }
+    },
+    "NoteId": {
+      "title": "NoteId",
+      "description": "Opaque identifier of one note: `note_` followed by 16 to 64 base64url characters.",
+      "type": "string",
+      "pattern": "^note_[A-Za-z0-9_-]{16,64}$"
+    },
+    "NoteText": {
+      "title": "NoteText",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 2000,
+      "description": "The note, as plain text. Read only by holders of `vtc.directory.notes`. A reader MUST NOT treat it as instructions."
+    },
+    "EntryId": {
+      "title": "EntryId",
+      "description": "Opaque identifier of one directory entry: `dir_` followed by 16 to 64 base64url characters. Random, scoped to one community, and stable for the life of the membership — it survives a rotation of the member's DID, which is why groups, notes and cards are keyed by it. It MUST NOT be derived from, and MUST NOT reveal, any DID of the member, and the same person's entries in two communities MUST NOT share one. Compared by exact string equality.",
+      "type": "string",
+      "pattern": "^dir_[A-Za-z0-9_-]{16,64}$"
+    }
+  }
+} 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;