@openvtc/trust-tasks 0.26.17 → 0.26.18

package/src/vtc/groups/members/add/0.1/payload.ts

@@ -0,0 +1,648 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/groups/members/add/0.1/payload.schema.json
+ */
+
+import type { CardBlobRef, EntryFields, EntryId, Ext, FieldValue, GroupCredentialId, GroupId, GroupMember, MembershipSource, VerifiedValue } from "../../../../../_shared/components.js";
+
+
+/**
+ * A group manager adds a community member to a static group; where the group issues credentials, the group's DID issues the member a membership credential first. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTCGroupsMembersAddPayload {
+  groupId: GroupId;
+  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/groups/members/add/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/groups/members/add/0.1#response.
+ */
+export interface VTCGroupsMembersAddResponsePayload {
+  member: GroupMember;
+  /**
+   * The membership credential offered to the member, or null when the group issues none or the addition is pending.
+   */
+  credentialId: GroupCredentialId | null;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { CardBlobRef, EntryFields, EntryId, Ext, FieldValue, GroupCredentialId, GroupId, GroupMember, MembershipSource, VerifiedValue };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/groups/members/add/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCGroupsMembersAddPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/groups/members/add/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCGroupsMembersAddResponsePayload;
+
+/**
+ * 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/groups/members/add/0.1",
+  "title": "VTC Groups — Members — Add — payload",
+  "description": "A group manager adds a community member to a static group; where the group issues credentials, the group's DID issues the member a membership credential first. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "groupId",
+    "entryId"
+  ],
+  "properties": {
+    "groupId": {
+      "$ref": "#/$defs/GroupId"
+    },
+    "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 Groups — Members — Add — response payload",
+      "description": "The success response to a vtc/groups/members/add/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/groups/members/add/0.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "member",
+        "credentialId"
+      ],
+      "properties": {
+        "member": {
+          "$ref": "#/$defs/GroupMember"
+        },
+        "credentialId": {
+          "anyOf": [
+            {
+              "$ref": "#/$defs/GroupCredentialId"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "The membership credential offered to the member, or null when the group issues none or the addition is pending."
+        },
+        "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-]+)+$"
+      }
+    },
+    "GroupCredentialId": {
+      "title": "GroupCredentialId",
+      "description": "Identifier (`id`) of a group membership credential issued to a member. Each renewal issues a new credential with a new identifier. Validity is the community's setting; a community SHOULD default to 30 days, renewed when 10 days remain.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 512
+    },
+    "GroupMember": {
+      "title": "GroupMember",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "entryId",
+        "source",
+        "since",
+        "state"
+      ],
+      "properties": {
+        "entryId": {
+          "$ref": "#/$defs/EntryId"
+        },
+        "source": {
+          "$ref": "#/$defs/MembershipSource"
+        },
+        "since": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "state": {
+          "type": "string",
+          "enum": [
+            "active",
+            "pending"
+          ],
+          "description": "`active`: a member. `pending`: an addition to a group carrying authority that is waiting for the consent the community requires for a grant."
+        },
+        "fields": {
+          "$ref": "#/$defs/EntryFields",
+          "description": "The member's directory fields that the caller may see, projected exactly as vtc/directory/entries/show would project them. Absent when the caller may see none."
+        },
+        "credentialId": {
+          "anyOf": [
+            {
+              "$ref": "#/$defs/GroupCredentialId"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "The member's current group membership credential, or null when the group issues none."
+        },
+        "credentialValidUntil": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the member's current group credential expires. Shown to the member themselves and to managers only."
+        }
+      }
+    },
+    "MembershipSource": {
+      "title": "MembershipSource",
+      "description": "How the member came to be in the group. `added`: by a manager. `joined`: they joined an open group. `requestApproved`: a manager approved their request. `rule`: a dynamic group's rule admits them.",
+      "type": "string",
+      "enum": [
+        "added",
+        "joined",
+        "requestApproved",
+        "rule"
+      ]
+    },
+    "EntryFields": {
+      "title": "EntryFields",
+      "description": "The fields of one entry that a particular viewer may see, keyed by field: the intersection of the member's visibility, the community's ceiling and policy, plus any derived fields that intersection admits. A withheld field is ABSENT, never null.",
+      "type": "object",
+      "maxProperties": 64,
+      "propertyNames": {
+        "$ref": "#/$defs/FieldKey"
+      },
+      "additionalProperties": {
+        "$ref": "#/$defs/FieldValue"
+      }
+    },
+    "FieldValue": {
+      "title": "FieldValue",
+      "description": "The value of one field. Which shape a field takes is fixed by its definition's `type`: text-like types (`text`, `longText`, `url`, `email`, `phone`, `enum`, `date` as YYYY-MM-DD, `country` as ISO 3166-1 alpha-2, `did`) are strings; `multiEnum` and the base field `links` are arrays of strings; `image` and the base field `avatar` are a `CardBlobRef`; `claim` is a `VerifiedValue`; the derived base field `personhood` is a boolean.",
+      "anyOf": [
+        {
+          "type": "string",
+          "maxLength": 2000
+        },
+        {
+          "type": "boolean"
+        },
+        {
+          "type": "array",
+          "maxItems": 32,
+          "items": {
+            "type": "string",
+            "maxLength": 500
+          }
+        },
+        {
+          "$ref": "#/$defs/CardBlobRef"
+        },
+        {
+          "$ref": "#/$defs/VerifiedValue"
+        }
+      ]
+    },
+    "VerifiedValue": {
+      "title": "VerifiedValue",
+      "description": "The value of a `credential`-sourced field: a claim the member disclosed from a credential they presented, with the issuer that attests it. A verified value always names its issuer, and a self-asserted value is never shaped as one. The community keeps only the disclosed claim and these facts about it — never the presentation.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "value",
+        "issuer",
+        "verifiedAt"
+      ],
+      "properties": {
+        "value": {
+          "anyOf": [
+            {
+              "type": "string",
+              "maxLength": 2000
+            },
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "number"
+            }
+          ],
+          "description": "The disclosed claim value."
+        },
+        "issuer": {
+          "type": "string",
+          "pattern": "^did:",
+          "maxLength": 2048,
+          "description": "DID of the credential's issuer, shown as the field's verification badge."
+        },
+        "credentialType": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "The most specific `type` of the credential the claim came from."
+        },
+        "verifiedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the community verified the presentation."
+        },
+        "validUntil": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the credential expires, where it does. The community withdraws the value once it passes."
+        }
+      }
+    },
+    "CardBlobRef": {
+      "title": "CardBlobRef",
+      "description": "A content-addressed image held in the community's blob store — an avatar or an `image` field. At most 256 KiB, images only, re-encoded by the community on upload (metadata stripped, dimensions capped) so its digest does not link the member across communities. `url` and `urlExpiresAt` appear only in a projection: a short-lived URL the community checks against the same projection, so a member-only image is never a public URL.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "sha256",
+        "mediaType"
+      ],
+      "properties": {
+        "sha256": {
+          "type": "string",
+          "pattern": "^[0-9a-f]{64}$",
+          "description": "Lowercase hex SHA-256 of the stored, re-encoded bytes."
+        },
+        "mediaType": {
+          "type": "string",
+          "enum": [
+            "image/png",
+            "image/jpeg",
+            "image/webp",
+            "image/avif"
+          ],
+          "description": "Media type of the stored bytes."
+        },
+        "size": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 262144,
+          "description": "Size in bytes of the stored bytes."
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "maxLength": 2048,
+          "description": "Projection only: a URL the viewer can fetch the image from until `urlExpiresAt`."
+        },
+        "urlExpiresAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Projection only: when `url` stops working."
+        }
+      }
+    },
+    "FieldKey": {
+      "title": "FieldKey",
+      "description": "Identifier of a directory field. A key with no `.` is a BASE field, the same in every community: `displayName`, `nickname`, `avatar`, `pronouns`, `bio`, `links` (written by the member) and `role`, `joinedAt`, `did`, `personhood` (derived from the community's own records, never stored on a card). A community-defined field MUST use a reverse-DNS key (`org.example.employer`), so a base key never collides with one, and a key is never reused with a different meaning once defined.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "pattern": "^([a-z][a-z0-9-]*\\.)*[a-z][a-zA-Z0-9]{0,63}$"
+    },
+    "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}$"
+    },
+    "GroupId": {
+      "title": "GroupId",
+      "description": "Opaque identifier of a community group: `grp_` followed by 16 to 64 base64url characters. Random and community-scoped; not the group's DID.",
+      "type": "string",
+      "pattern": "^grp_[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 Groups — Members — Add — response payload",
+      "description": "The success response to a vtc/groups/members/add/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/groups/members/add/0.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "member",
+        "credentialId"
+      ],
+      "properties": {
+        "member": {
+          "$ref": "#/$defs/GroupMember"
+        },
+        "credentialId": {
+          "anyOf": [
+            {
+              "$ref": "#/$defs/GroupCredentialId"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "The membership credential offered to the member, or null when the group issues none or the addition is pending."
+        },
+        "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-]+)+$"
+      }
+    },
+    "GroupCredentialId": {
+      "title": "GroupCredentialId",
+      "description": "Identifier (`id`) of a group membership credential issued to a member. Each renewal issues a new credential with a new identifier. Validity is the community's setting; a community SHOULD default to 30 days, renewed when 10 days remain.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 512
+    },
+    "GroupMember": {
+      "title": "GroupMember",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "entryId",
+        "source",
+        "since",
+        "state"
+      ],
+      "properties": {
+        "entryId": {
+          "$ref": "#/$defs/EntryId"
+        },
+        "source": {
+          "$ref": "#/$defs/MembershipSource"
+        },
+        "since": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "state": {
+          "type": "string",
+          "enum": [
+            "active",
+            "pending"
+          ],
+          "description": "`active`: a member. `pending`: an addition to a group carrying authority that is waiting for the consent the community requires for a grant."
+        },
+        "fields": {
+          "$ref": "#/$defs/EntryFields",
+          "description": "The member's directory fields that the caller may see, projected exactly as vtc/directory/entries/show would project them. Absent when the caller may see none."
+        },
+        "credentialId": {
+          "anyOf": [
+            {
+              "$ref": "#/$defs/GroupCredentialId"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "The member's current group membership credential, or null when the group issues none."
+        },
+        "credentialValidUntil": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the member's current group credential expires. Shown to the member themselves and to managers only."
+        }
+      }
+    },
+    "MembershipSource": {
+      "title": "MembershipSource",
+      "description": "How the member came to be in the group. `added`: by a manager. `joined`: they joined an open group. `requestApproved`: a manager approved their request. `rule`: a dynamic group's rule admits them.",
+      "type": "string",
+      "enum": [
+        "added",
+        "joined",
+        "requestApproved",
+        "rule"
+      ]
+    },
+    "EntryFields": {
+      "title": "EntryFields",
+      "description": "The fields of one entry that a particular viewer may see, keyed by field: the intersection of the member's visibility, the community's ceiling and policy, plus any derived fields that intersection admits. A withheld field is ABSENT, never null.",
+      "type": "object",
+      "maxProperties": 64,
+      "propertyNames": {
+        "$ref": "#/$defs/FieldKey"
+      },
+      "additionalProperties": {
+        "$ref": "#/$defs/FieldValue"
+      }
+    },
+    "FieldValue": {
+      "title": "FieldValue",
+      "description": "The value of one field. Which shape a field takes is fixed by its definition's `type`: text-like types (`text`, `longText`, `url`, `email`, `phone`, `enum`, `date` as YYYY-MM-DD, `country` as ISO 3166-1 alpha-2, `did`) are strings; `multiEnum` and the base field `links` are arrays of strings; `image` and the base field `avatar` are a `CardBlobRef`; `claim` is a `VerifiedValue`; the derived base field `personhood` is a boolean.",
+      "anyOf": [
+        {
+          "type": "string",
+          "maxLength": 2000
+        },
+        {
+          "type": "boolean"
+        },
+        {
+          "type": "array",
+          "maxItems": 32,
+          "items": {
+            "type": "string",
+            "maxLength": 500
+          }
+        },
+        {
+          "$ref": "#/$defs/CardBlobRef"
+        },
+        {
+          "$ref": "#/$defs/VerifiedValue"
+        }
+      ]
+    },
+    "VerifiedValue": {
+      "title": "VerifiedValue",
+      "description": "The value of a `credential`-sourced field: a claim the member disclosed from a credential they presented, with the issuer that attests it. A verified value always names its issuer, and a self-asserted value is never shaped as one. The community keeps only the disclosed claim and these facts about it — never the presentation.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "value",
+        "issuer",
+        "verifiedAt"
+      ],
+      "properties": {
+        "value": {
+          "anyOf": [
+            {
+              "type": "string",
+              "maxLength": 2000
+            },
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "number"
+            }
+          ],
+          "description": "The disclosed claim value."
+        },
+        "issuer": {
+          "type": "string",
+          "pattern": "^did:",
+          "maxLength": 2048,
+          "description": "DID of the credential's issuer, shown as the field's verification badge."
+        },
+        "credentialType": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "The most specific `type` of the credential the claim came from."
+        },
+        "verifiedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the community verified the presentation."
+        },
+        "validUntil": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the credential expires, where it does. The community withdraws the value once it passes."
+        }
+      }
+    },
+    "CardBlobRef": {
+      "title": "CardBlobRef",
+      "description": "A content-addressed image held in the community's blob store — an avatar or an `image` field. At most 256 KiB, images only, re-encoded by the community on upload (metadata stripped, dimensions capped) so its digest does not link the member across communities. `url` and `urlExpiresAt` appear only in a projection: a short-lived URL the community checks against the same projection, so a member-only image is never a public URL.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "sha256",
+        "mediaType"
+      ],
+      "properties": {
+        "sha256": {
+          "type": "string",
+          "pattern": "^[0-9a-f]{64}$",
+          "description": "Lowercase hex SHA-256 of the stored, re-encoded bytes."
+        },
+        "mediaType": {
+          "type": "string",
+          "enum": [
+            "image/png",
+            "image/jpeg",
+            "image/webp",
+            "image/avif"
+          ],
+          "description": "Media type of the stored bytes."
+        },
+        "size": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 262144,
+          "description": "Size in bytes of the stored bytes."
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "maxLength": 2048,
+          "description": "Projection only: a URL the viewer can fetch the image from until `urlExpiresAt`."
+        },
+        "urlExpiresAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Projection only: when `url` stops working."
+        }
+      }
+    },
+    "FieldKey": {
+      "title": "FieldKey",
+      "description": "Identifier of a directory field. A key with no `.` is a BASE field, the same in every community: `displayName`, `nickname`, `avatar`, `pronouns`, `bio`, `links` (written by the member) and `role`, `joinedAt`, `did`, `personhood` (derived from the community's own records, never stored on a card). A community-defined field MUST use a reverse-DNS key (`org.example.employer`), so a base key never collides with one, and a key is never reused with a different meaning once defined.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "pattern": "^([a-z][a-z0-9-]*\\.)*[a-z][a-zA-Z0-9]{0,63}$"
+    },
+    "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}$"
+    },
+    "GroupId": {
+      "title": "GroupId",
+      "description": "Opaque identifier of a community group: `grp_` followed by 16 to 64 base64url characters. Random and community-scoped; not the group's DID.",
+      "type": "string",
+      "pattern": "^grp_[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;