@openvtc/trust-tasks 0.12.3 → 0.12.5

package/src/vtc/community/profile/update/0.1/payload.ts

@@ -10,6 +10,10 @@ export interface VTCCommunityProfileUpdatePayload {
   publicUrl?: string | null;
   contactEmail?: string | null;
   language?: string;
+  /**
+   * Set the community's declared relationship-identifier default. See `CommunityProfile.relationshipIdentifierDefault` in the `vtc/_shared/0.1/community` schema. Omit to leave it unchanged.
+   */
+  relationshipIdentifierDefault?: "attributed" | "pairwise";
   /**
    * Opaque community-defined extension bag (maintainer-capped).
    */
@@ -24,6 +28,10 @@ export interface Ext {
 }
 export interface VTCCommunityProfileUpdateResponsePayload {
   profile: CommunityProfile;
+  /**
+   * Names of the profile members this update actually changed, in the wire spelling. Empty when the submitted values all matched what was already stored. Lets a caller distinguish a no-op from an applied change without diffing the returned profile against the one it sent.
+   */
+  fieldsChanged?: string[];
   ext?: Ext;
 }
 export interface CommunityProfile {
@@ -33,6 +41,10 @@ export interface CommunityProfile {
   publicUrl?: string | null;
   contactEmail?: string | null;
   language: string;
+  /**
+   * Which identifier form the community expects members to issue relationship credentials under. `attributed` means the member's membership DID, so an edge names them; `pairwise` means a relationship DID unique to each counterparty. A declaration, not an enforcement: the member still chooses per relationship, and a community that wants to require one form does so in its own policy. Absent means the community has not declared one; implementations default to `pairwise`, matching the DTG Credentials recommendation.
+   */
+  relationshipIdentifierDefault?: "attributed" | "pairwise";
   /**
    * Opaque community-defined extension bag.
    */
@@ -100,6 +112,14 @@ export const PAYLOAD_SCHEMA = {
       "type": "string",
       "minLength": 1
     },
+    "relationshipIdentifierDefault": {
+      "type": "string",
+      "enum": [
+        "attributed",
+        "pairwise"
+      ],
+      "description": "Set the community's declared relationship-identifier default. See `CommunityProfile.relationshipIdentifierDefault` in the `vtc/_shared/0.1/community` schema. Omit to leave it unchanged."
+    },
     "extensions": {
       "type": "object",
       "description": "Opaque community-defined extension bag (maintainer-capped)."
@@ -121,6 +141,13 @@ export const PAYLOAD_SCHEMA = {
         "profile": {
           "$ref": "#/$defs/CommunityProfile"
         },
+        "fieldsChanged": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Names of the profile members this update actually changed, in the wire spelling. Empty when the submitted values all matched what was already stored. Lets a caller distinguish a no-op from an applied change without diffing the returned profile against the one it sent."
+        },
         "ext": {
           "$ref": "#/$defs/Ext"
         }
@@ -175,6 +202,14 @@ export const PAYLOAD_SCHEMA = {
           "type": "string",
           "minLength": 1
         },
+        "relationshipIdentifierDefault": {
+          "type": "string",
+          "enum": [
+            "attributed",
+            "pairwise"
+          ],
+          "description": "Which identifier form the community expects members to issue relationship credentials under. `attributed` means the member's membership DID, so an edge names them; `pairwise` means a relationship DID unique to each counterparty. A declaration, not an enforcement: the member still chooses per relationship, and a community that wants to require one form does so in its own policy. Absent means the community has not declared one; implementations default to `pairwise`, matching the DTG Credentials recommendation."
+        },
         "extensions": {
           "type": "object",
           "description": "Opaque community-defined extension bag."
@@ -209,6 +244,13 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
         "profile": {
           "$ref": "#/$defs/CommunityProfile"
         },
+        "fieldsChanged": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Names of the profile members this update actually changed, in the wire spelling. Empty when the submitted values all matched what was already stored. Lets a caller distinguish a no-op from an applied change without diffing the returned profile against the one it sent."
+        },
         "ext": {
           "$ref": "#/$defs/Ext"
         }
@@ -263,6 +305,14 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
           "type": "string",
           "minLength": 1
         },
+        "relationshipIdentifierDefault": {
+          "type": "string",
+          "enum": [
+            "attributed",
+            "pairwise"
+          ],
+          "description": "Which identifier form the community expects members to issue relationship credentials under. `attributed` means the member's membership DID, so an edge names them; `pairwise` means a relationship DID unique to each counterparty. A declaration, not an enforcement: the member still chooses per relationship, and a community that wants to require one form does so in its own policy. Absent means the community has not declared one; implementations default to `pairwise`, matching the DTG Credentials recommendation."
+        },
         "extensions": {
           "type": "object",
           "description": "Opaque community-defined extension bag."

package/src/vtc/config/export/0.1/payload.ts

@@ -57,6 +57,10 @@ export interface CommunityProfileSnapshot {
    * BCP 47 language tag.
    */
   language: string;
+  /**
+   * The community's declared relationship-identifier default, as defined on `CommunityProfile` in the `vtc/_shared/0.1/community` schema. Carried in a config export so a restore reproduces the declaration rather than silently reverting it to the implementation default.
+   */
+  relationshipIdentifierDefault?: "attributed" | "pairwise";
   /**
    * Opaque community-defined extension bag.
    */
@@ -212,6 +216,14 @@ export const PAYLOAD_SCHEMA = {
           "minLength": 1,
           "description": "BCP 47 language tag."
         },
+        "relationshipIdentifierDefault": {
+          "type": "string",
+          "enum": [
+            "attributed",
+            "pairwise"
+          ],
+          "description": "The community's declared relationship-identifier default, as defined on `CommunityProfile` in the `vtc/_shared/0.1/community` schema. Carried in a config export so a restore reproduces the declaration rather than silently reverting it to the implementation default."
+        },
         "extensions": {
           "type": "object",
           "description": "Opaque community-defined extension bag."
@@ -342,6 +354,14 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
           "minLength": 1,
           "description": "BCP 47 language tag."
         },
+        "relationshipIdentifierDefault": {
+          "type": "string",
+          "enum": [
+            "attributed",
+            "pairwise"
+          ],
+          "description": "The community's declared relationship-identifier default, as defined on `CommunityProfile` in the `vtc/_shared/0.1/community` schema. Carried in a config export so a restore reproduces the declaration rather than silently reverting it to the implementation default."
+        },
         "extensions": {
           "type": "object",
           "description": "Opaque community-defined extension bag."

package/src/vtc/config/import/0.1/payload.ts

@@ -52,6 +52,10 @@ export interface CommunityProfileSnapshot {
    * BCP 47 language tag.
    */
   language: string;
+  /**
+   * The community's declared relationship-identifier default, as defined on `CommunityProfile` in the `vtc/_shared/0.1/community` schema. Carried in a config export so a restore reproduces the declaration rather than silently reverting it to the implementation default.
+   */
+  relationshipIdentifierDefault?: "attributed" | "pairwise";
   /**
    * Opaque community-defined extension bag.
    */
@@ -363,6 +367,14 @@ export const PAYLOAD_SCHEMA = {
           "minLength": 1,
           "description": "BCP 47 language tag."
         },
+        "relationshipIdentifierDefault": {
+          "type": "string",
+          "enum": [
+            "attributed",
+            "pairwise"
+          ],
+          "description": "The community's declared relationship-identifier default, as defined on `CommunityProfile` in the `vtc/_shared/0.1/community` schema. Carried in a config export so a restore reproduces the declaration rather than silently reverting it to the implementation default."
+        },
         "extensions": {
           "type": "object",
           "description": "Opaque community-defined extension bag."
@@ -575,6 +587,14 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
           "minLength": 1,
           "description": "BCP 47 language tag."
         },
+        "relationshipIdentifierDefault": {
+          "type": "string",
+          "enum": [
+            "attributed",
+            "pairwise"
+          ],
+          "description": "The community's declared relationship-identifier default, as defined on `CommunityProfile` in the `vtc/_shared/0.1/community` schema. Carried in a config export so a restore reproduces the declaration rather than silently reverting it to the implementation default."
+        },
         "extensions": {
           "type": "object",
           "description": "Opaque community-defined extension bag."

package/src/vtc/members/removal-notice/0.1/payload.ts

@@ -0,0 +1,140 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/members/removal-notice/0.1/payload.schema.json
+ */
+
+/**
+ * A community tells a member it removed them, on whose authority, when, and why. Unsolicited: unlike vtc/members/self-remove-receipt this answers no request from the member, because the member did not ask.
+ */
+export interface VTCMembersRemovalNoticePayload {
+  /**
+   * The removed member's DID — the notice's recipient. Carried in the payload as well as the envelope so that a forwarded notice, detached from its transport, still names its subject.
+   */
+  did: string;
+  /**
+   * Which removal happened. `adminRemoved` is a policy-governed removal by an administrator; `purged` is a forceful super-administrator deletion that skips the removal policy. The two differ in what recourse a member has, which is why they are distinguishable rather than a single `removed`.
+   */
+  code: "adminRemoved" | "purged";
+  /**
+   * How the member's published record was handled. Always concrete — a community resolves any `policydefault` preference before sending, since a notice naming an unresolved default tells the member nothing about their own record.
+   */
+  disposition: "purge" | "tombstone" | "historical";
+  /**
+   * The operator's stated reason, verbatim. OPTIONAL because a community may remove without giving one — but omitting it and sending an empty string are different claims, and a community that has a reason SHOULD send it. This is the member's only account of why.
+   */
+  reason?: string;
+  /**
+   * When the removal took effect. Distinct from the notice's own `issuedAt`, which may be much later if the member was offline — and it is the decision, not the delivery, that a member or a third party needs to place in time.
+   */
+  decidedAt: string;
+  /**
+   * DID of the administrator who decided. Names the deciding authority rather than the community, because 'the community removed me' is not answerable and 'this administrator removed me' is. The community itself is the document's `issuer`.
+   */
+  decidedBy: string;
+  ext?: Ext;
+}
+/**
+ * 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.
+ */
+export interface Ext {
+  [k: string]: unknown | undefined;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/members/removal-notice/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCMembersRemovalNoticePayload;
+
+/**
+ * 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/members/removal-notice/0.1",
+  "title": "VTC Members Removal Notice — payload",
+  "description": "A community tells a member it removed them, on whose authority, when, and why. Unsolicited: unlike vtc/members/self-remove-receipt this answers no request from the member, because the member did not ask.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "did",
+    "code",
+    "disposition",
+    "decidedAt",
+    "decidedBy"
+  ],
+  "properties": {
+    "did": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The removed member's DID — the notice's recipient. Carried in the payload as well as the envelope so that a forwarded notice, detached from its transport, still names its subject."
+    },
+    "code": {
+      "type": "string",
+      "enum": [
+        "adminRemoved",
+        "purged"
+      ],
+      "description": "Which removal happened. `adminRemoved` is a policy-governed removal by an administrator; `purged` is a forceful super-administrator deletion that skips the removal policy. The two differ in what recourse a member has, which is why they are distinguishable rather than a single `removed`."
+    },
+    "disposition": {
+      "type": "string",
+      "enum": [
+        "purge",
+        "tombstone",
+        "historical"
+      ],
+      "description": "How the member's published record was handled. Always concrete — a community resolves any `policydefault` preference before sending, since a notice naming an unresolved default tells the member nothing about their own record."
+    },
+    "reason": {
+      "type": "string",
+      "maxLength": 1024,
+      "description": "The operator's stated reason, verbatim. OPTIONAL because a community may remove without giving one — but omitting it and sending an empty string are different claims, and a community that has a reason SHOULD send it. This is the member's only account of why."
+    },
+    "decidedAt": {
+      "type": "string",
+      "format": "date-time",
+      "description": "When the removal took effect. Distinct from the notice's own `issuedAt`, which may be much later if the member was offline — and it is the decision, not the delivery, that a member or a third party needs to place in time."
+    },
+    "decidedBy": {
+      "type": "string",
+      "minLength": 1,
+      "description": "DID of the administrator who decided. Names the deciding authority rather than the community, because 'the community removed me' is not answerable and 'this administrator removed me' is. The community itself is the document's `issuer`."
+    },
+    "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-]+)+$"
+      }
+    }
+  }
+} 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,
+  payloadSchema: PAYLOAD_SCHEMA,
+} as const;