@openvtc/trust-tasks 0.28.17 → 0.28.19

package/dist/vtc/badges/awards/revoke/0.1/payload.d.ts

@@ -0,0 +1,605 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/badges/awards/revoke/0.1/payload.schema.json
+ */
+import type { Award, AwardId, AwardNote, AwardState, BadgeId, EntryId, Ext, GroupCredentialId } from "../../../../../_shared/components.js";
+/**
+ * Take an accepted award back: revoke or stop renewing the credential that evidences it, remove the holder from the badge group where it was their last award, and tell them. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTCBadgesAwardsRevokePayload {
+    /**
+     * The award to take back. It must be `accepted`.
+     */
+    awardId: AwardId;
+    /**
+     * Why, kept with the audit of the change for the badge's owners and administrators. The holder is told the award was taken back, never the reason.
+     */
+    reason: string;
+    ext?: Ext;
+}
+/**
+ * The success response to a vtc/badges/awards/revoke/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/badges/awards/revoke/0.1#response.
+ */
+export interface VTCBadgesAwardsRevokeResponsePayload {
+    /**
+     * The award as it now stands: `state` `revoked`, `decidedAt` set. `credentialId` names the credential that evidenced it, now revoked or no longer renewed.
+     */
+    award: Award;
+    ext?: Ext;
+}
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Award, AwardId, AwardNote, AwardState, BadgeId, EntryId, Ext, GroupCredentialId };
+/** Trust Task type URI. */
+export declare const TYPE_URI: "https://trusttasks.org/spec/vtc/badges/awards/revoke/0.1";
+/**
+ * The earlier version of this specification that this one declares it
+ * extends (front matter `extends`, SPEC §5.2 "Declared extension"), or
+ * `null`. Only the direct declaration — follow the chain with
+ * `extendsChain` / `readForSpec`.
+ */
+export declare const EXTENDS: string | null;
+/**
+ * Why this version is deprecated, or `null` while it is current. A
+ * superseded or retired version is still supported, and is withdrawn from
+ * this package in a later scheduled batch (SPEC "Superseded and Withdrawn
+ * Versions").
+ */
+export declare const DEPRECATION: string | null;
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCBadgesAwardsRevokePayload;
+/** Trust Task response type URI (request type URI + "#response"). */
+export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/vtc/badges/awards/revoke/0.1#response";
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCBadgesAwardsRevokeResponsePayload;
+/**
+ * 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 declare const PAYLOAD_SCHEMA: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $id: "https://trusttasks.org/spec/vtc/badges/awards/revoke/0.1";
+    readonly title: "VTC Badges — Awards — Revoke — payload";
+    readonly description: "Take an accepted award back: revoke or stop renewing the credential that evidences it, remove the holder from the badge group where it was their last award, and tell them. The outer document members are owned by the framework — SPEC §6.3.";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly ["awardId", "reason"];
+    readonly properties: {
+        readonly awardId: {
+            readonly $ref: "#/$defs/AwardId";
+            readonly description: "The award to take back. It must be `accepted`.";
+        };
+        readonly reason: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 1024;
+            readonly description: "Why, kept with the audit of the change for the badge's owners and administrators. The holder is told the award was taken back, never the reason.";
+        };
+        readonly ext: {
+            readonly $ref: "#/$defs/Ext";
+        };
+    };
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "VTC Badges — Awards — Revoke — response payload";
+            readonly description: "The success response to a vtc/badges/awards/revoke/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/badges/awards/revoke/0.1#response.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["award"];
+            readonly properties: {
+                readonly award: {
+                    readonly $ref: "#/$defs/Award";
+                    readonly description: "The award as it now stands: `state` `revoked`, `decidedAt` set. `credentialId` names the credential that evidenced it, now revoked or no longer renewed.";
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        readonly Ext: {
+            readonly title: "Ext";
+            readonly 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.";
+            readonly type: "object";
+            readonly minProperties: 1;
+            readonly additionalProperties: true;
+            readonly propertyNames: {
+                readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+            };
+        };
+        readonly Award: {
+            readonly title: "Award";
+            readonly description: "One giving of a badge to one member. `givenBy` is the giver's directory entry, absent for an award a dynamic badge group's rule made. `note` is shown to the recipient, the giver, the badge's owners and administrators, never to other members. `credentialId` is present on an accepted award of a community badge: the badge credential that evidences it, renewed or re-issued as the badge's regime requires.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["awardId", "badgeId", "entryId", "state", "offeredAt"];
+            readonly properties: {
+                readonly awardId: {
+                    readonly $ref: "#/$defs/AwardId";
+                };
+                readonly badgeId: {
+                    readonly $ref: "#/$defs/BadgeId";
+                };
+                readonly entryId: {
+                    readonly $ref: "#/$defs/EntryId";
+                    readonly description: "The recipient.";
+                };
+                readonly givenBy: {
+                    readonly $ref: "#/$defs/EntryId";
+                };
+                readonly note: {
+                    readonly $ref: "#/$defs/AwardNote";
+                };
+                readonly state: {
+                    readonly $ref: "#/$defs/AwardState";
+                };
+                readonly offeredAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                };
+                readonly decidedAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "When the recipient accepted or declined, the giver withdrew, the offer expired, or the award was revoked.";
+                };
+                readonly expiresAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "When an unanswered offer lapses, where the community expires offers.";
+                };
+                readonly credentialId: {
+                    readonly $ref: "#/$defs/GroupCredentialId";
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        readonly AwardState: {
+            readonly title: "AwardState";
+            readonly description: "`offered`: waiting for the recipient. `accepted`: the recipient took it; for a community badge the credential was issued and the membership recorded. `declined`: the recipient declined; nothing was recorded in the group and nothing issued. `withdrawn`: the giver withdrew the offer before a decision. `expired`: the offer lapsed unanswered. `revoked`: taken back after acceptance (VTI-BDG-023).";
+            readonly type: "string";
+            readonly enum: readonly ["offered", "accepted", "declined", "withdrawn", "expired", "revoked"];
+        };
+        readonly AwardNote: {
+            readonly title: "AwardNote";
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 500;
+            readonly description: "What the award is for, from the giver, shown to the recipient and written as the award's evidence narrative where the badge carries a credential. Plain text; erased with its author (VTI-BDG-090).";
+        };
+        readonly BadgeId: {
+            readonly title: "BadgeId";
+            readonly description: "Opaque identifier of a badge: `bdg_` followed by 16 to 64 base64url characters. Random, community-scoped, never reused (VTI-BDG-001).";
+            readonly type: "string";
+            readonly pattern: "^bdg_[A-Za-z0-9_-]{16,64}$";
+        };
+        readonly AwardId: {
+            readonly title: "AwardId";
+            readonly description: "Opaque identifier of one giving of a badge to one member: `awd_` followed by 16 to 64 base64url characters. Random and unique within the community.";
+            readonly type: "string";
+            readonly pattern: "^awd_[A-Za-z0-9_-]{16,64}$";
+        };
+        readonly GroupCredentialId: {
+            readonly title: "GroupCredentialId";
+            readonly 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.";
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 512;
+        };
+        readonly EntryId: {
+            readonly title: "EntryId";
+            readonly 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.";
+            readonly type: "string";
+            readonly pattern: "^dir_[A-Za-z0-9_-]{16,64}$";
+        };
+    };
+};
+/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
+export declare const RESPONSE_PAYLOAD_SCHEMA: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $ref: "#/$defs/Response";
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "VTC Badges — Awards — Revoke — response payload";
+            readonly description: "The success response to a vtc/badges/awards/revoke/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/badges/awards/revoke/0.1#response.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["award"];
+            readonly properties: {
+                readonly award: {
+                    readonly $ref: "#/$defs/Award";
+                    readonly description: "The award as it now stands: `state` `revoked`, `decidedAt` set. `credentialId` names the credential that evidenced it, now revoked or no longer renewed.";
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        readonly Ext: {
+            readonly title: "Ext";
+            readonly 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.";
+            readonly type: "object";
+            readonly minProperties: 1;
+            readonly additionalProperties: true;
+            readonly propertyNames: {
+                readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+            };
+        };
+        readonly Award: {
+            readonly title: "Award";
+            readonly description: "One giving of a badge to one member. `givenBy` is the giver's directory entry, absent for an award a dynamic badge group's rule made. `note` is shown to the recipient, the giver, the badge's owners and administrators, never to other members. `credentialId` is present on an accepted award of a community badge: the badge credential that evidences it, renewed or re-issued as the badge's regime requires.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["awardId", "badgeId", "entryId", "state", "offeredAt"];
+            readonly properties: {
+                readonly awardId: {
+                    readonly $ref: "#/$defs/AwardId";
+                };
+                readonly badgeId: {
+                    readonly $ref: "#/$defs/BadgeId";
+                };
+                readonly entryId: {
+                    readonly $ref: "#/$defs/EntryId";
+                    readonly description: "The recipient.";
+                };
+                readonly givenBy: {
+                    readonly $ref: "#/$defs/EntryId";
+                };
+                readonly note: {
+                    readonly $ref: "#/$defs/AwardNote";
+                };
+                readonly state: {
+                    readonly $ref: "#/$defs/AwardState";
+                };
+                readonly offeredAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                };
+                readonly decidedAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "When the recipient accepted or declined, the giver withdrew, the offer expired, or the award was revoked.";
+                };
+                readonly expiresAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "When an unanswered offer lapses, where the community expires offers.";
+                };
+                readonly credentialId: {
+                    readonly $ref: "#/$defs/GroupCredentialId";
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        readonly AwardState: {
+            readonly title: "AwardState";
+            readonly description: "`offered`: waiting for the recipient. `accepted`: the recipient took it; for a community badge the credential was issued and the membership recorded. `declined`: the recipient declined; nothing was recorded in the group and nothing issued. `withdrawn`: the giver withdrew the offer before a decision. `expired`: the offer lapsed unanswered. `revoked`: taken back after acceptance (VTI-BDG-023).";
+            readonly type: "string";
+            readonly enum: readonly ["offered", "accepted", "declined", "withdrawn", "expired", "revoked"];
+        };
+        readonly AwardNote: {
+            readonly title: "AwardNote";
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 500;
+            readonly description: "What the award is for, from the giver, shown to the recipient and written as the award's evidence narrative where the badge carries a credential. Plain text; erased with its author (VTI-BDG-090).";
+        };
+        readonly BadgeId: {
+            readonly title: "BadgeId";
+            readonly description: "Opaque identifier of a badge: `bdg_` followed by 16 to 64 base64url characters. Random, community-scoped, never reused (VTI-BDG-001).";
+            readonly type: "string";
+            readonly pattern: "^bdg_[A-Za-z0-9_-]{16,64}$";
+        };
+        readonly AwardId: {
+            readonly title: "AwardId";
+            readonly description: "Opaque identifier of one giving of a badge to one member: `awd_` followed by 16 to 64 base64url characters. Random and unique within the community.";
+            readonly type: "string";
+            readonly pattern: "^awd_[A-Za-z0-9_-]{16,64}$";
+        };
+        readonly GroupCredentialId: {
+            readonly title: "GroupCredentialId";
+            readonly 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.";
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 512;
+        };
+        readonly EntryId: {
+            readonly title: "EntryId";
+            readonly 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.";
+            readonly type: "string";
+            readonly pattern: "^dir_[A-Za-z0-9_-]{16,64}$";
+        };
+    };
+};
+/**
+ * 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 declare const SPEC: {
+    readonly typeUri: "https://trusttasks.org/spec/vtc/badges/awards/revoke/0.1";
+    readonly isBearer: false;
+    readonly isProofRequired: true;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: true;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $id: "https://trusttasks.org/spec/vtc/badges/awards/revoke/0.1";
+        readonly title: "VTC Badges — Awards — Revoke — payload";
+        readonly description: "Take an accepted award back: revoke or stop renewing the credential that evidences it, remove the holder from the badge group where it was their last award, and tell them. The outer document members are owned by the framework — SPEC §6.3.";
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["awardId", "reason"];
+        readonly properties: {
+            readonly awardId: {
+                readonly $ref: "#/$defs/AwardId";
+                readonly description: "The award to take back. It must be `accepted`.";
+            };
+            readonly reason: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 1024;
+                readonly description: "Why, kept with the audit of the change for the badge's owners and administrators. The holder is told the award was taken back, never the reason.";
+            };
+            readonly ext: {
+                readonly $ref: "#/$defs/Ext";
+            };
+        };
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "VTC Badges — Awards — Revoke — response payload";
+                readonly description: "The success response to a vtc/badges/awards/revoke/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/badges/awards/revoke/0.1#response.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["award"];
+                readonly properties: {
+                    readonly award: {
+                        readonly $ref: "#/$defs/Award";
+                        readonly description: "The award as it now stands: `state` `revoked`, `decidedAt` set. `credentialId` names the credential that evidenced it, now revoked or no longer renewed.";
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            readonly Ext: {
+                readonly title: "Ext";
+                readonly 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.";
+                readonly type: "object";
+                readonly minProperties: 1;
+                readonly additionalProperties: true;
+                readonly propertyNames: {
+                    readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+                };
+            };
+            readonly Award: {
+                readonly title: "Award";
+                readonly description: "One giving of a badge to one member. `givenBy` is the giver's directory entry, absent for an award a dynamic badge group's rule made. `note` is shown to the recipient, the giver, the badge's owners and administrators, never to other members. `credentialId` is present on an accepted award of a community badge: the badge credential that evidences it, renewed or re-issued as the badge's regime requires.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["awardId", "badgeId", "entryId", "state", "offeredAt"];
+                readonly properties: {
+                    readonly awardId: {
+                        readonly $ref: "#/$defs/AwardId";
+                    };
+                    readonly badgeId: {
+                        readonly $ref: "#/$defs/BadgeId";
+                    };
+                    readonly entryId: {
+                        readonly $ref: "#/$defs/EntryId";
+                        readonly description: "The recipient.";
+                    };
+                    readonly givenBy: {
+                        readonly $ref: "#/$defs/EntryId";
+                    };
+                    readonly note: {
+                        readonly $ref: "#/$defs/AwardNote";
+                    };
+                    readonly state: {
+                        readonly $ref: "#/$defs/AwardState";
+                    };
+                    readonly offeredAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                    };
+                    readonly decidedAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "When the recipient accepted or declined, the giver withdrew, the offer expired, or the award was revoked.";
+                    };
+                    readonly expiresAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "When an unanswered offer lapses, where the community expires offers.";
+                    };
+                    readonly credentialId: {
+                        readonly $ref: "#/$defs/GroupCredentialId";
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            readonly AwardState: {
+                readonly title: "AwardState";
+                readonly description: "`offered`: waiting for the recipient. `accepted`: the recipient took it; for a community badge the credential was issued and the membership recorded. `declined`: the recipient declined; nothing was recorded in the group and nothing issued. `withdrawn`: the giver withdrew the offer before a decision. `expired`: the offer lapsed unanswered. `revoked`: taken back after acceptance (VTI-BDG-023).";
+                readonly type: "string";
+                readonly enum: readonly ["offered", "accepted", "declined", "withdrawn", "expired", "revoked"];
+            };
+            readonly AwardNote: {
+                readonly title: "AwardNote";
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 500;
+                readonly description: "What the award is for, from the giver, shown to the recipient and written as the award's evidence narrative where the badge carries a credential. Plain text; erased with its author (VTI-BDG-090).";
+            };
+            readonly BadgeId: {
+                readonly title: "BadgeId";
+                readonly description: "Opaque identifier of a badge: `bdg_` followed by 16 to 64 base64url characters. Random, community-scoped, never reused (VTI-BDG-001).";
+                readonly type: "string";
+                readonly pattern: "^bdg_[A-Za-z0-9_-]{16,64}$";
+            };
+            readonly AwardId: {
+                readonly title: "AwardId";
+                readonly description: "Opaque identifier of one giving of a badge to one member: `awd_` followed by 16 to 64 base64url characters. Random and unique within the community.";
+                readonly type: "string";
+                readonly pattern: "^awd_[A-Za-z0-9_-]{16,64}$";
+            };
+            readonly GroupCredentialId: {
+                readonly title: "GroupCredentialId";
+                readonly 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.";
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 512;
+            };
+            readonly EntryId: {
+                readonly title: "EntryId";
+                readonly 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.";
+                readonly type: "string";
+                readonly pattern: "^dir_[A-Za-z0-9_-]{16,64}$";
+            };
+        };
+    };
+};
+/**
+ * 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 declare const RESPONSE_SPEC: {
+    readonly typeUri: "https://trusttasks.org/spec/vtc/badges/awards/revoke/0.1#response";
+    readonly isBearer: false;
+    readonly isProofRequired: true;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: true;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $ref: "#/$defs/Response";
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "VTC Badges — Awards — Revoke — response payload";
+                readonly description: "The success response to a vtc/badges/awards/revoke/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/badges/awards/revoke/0.1#response.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["award"];
+                readonly properties: {
+                    readonly award: {
+                        readonly $ref: "#/$defs/Award";
+                        readonly description: "The award as it now stands: `state` `revoked`, `decidedAt` set. `credentialId` names the credential that evidenced it, now revoked or no longer renewed.";
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            readonly Ext: {
+                readonly title: "Ext";
+                readonly 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.";
+                readonly type: "object";
+                readonly minProperties: 1;
+                readonly additionalProperties: true;
+                readonly propertyNames: {
+                    readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+                };
+            };
+            readonly Award: {
+                readonly title: "Award";
+                readonly description: "One giving of a badge to one member. `givenBy` is the giver's directory entry, absent for an award a dynamic badge group's rule made. `note` is shown to the recipient, the giver, the badge's owners and administrators, never to other members. `credentialId` is present on an accepted award of a community badge: the badge credential that evidences it, renewed or re-issued as the badge's regime requires.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["awardId", "badgeId", "entryId", "state", "offeredAt"];
+                readonly properties: {
+                    readonly awardId: {
+                        readonly $ref: "#/$defs/AwardId";
+                    };
+                    readonly badgeId: {
+                        readonly $ref: "#/$defs/BadgeId";
+                    };
+                    readonly entryId: {
+                        readonly $ref: "#/$defs/EntryId";
+                        readonly description: "The recipient.";
+                    };
+                    readonly givenBy: {
+                        readonly $ref: "#/$defs/EntryId";
+                    };
+                    readonly note: {
+                        readonly $ref: "#/$defs/AwardNote";
+                    };
+                    readonly state: {
+                        readonly $ref: "#/$defs/AwardState";
+                    };
+                    readonly offeredAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                    };
+                    readonly decidedAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "When the recipient accepted or declined, the giver withdrew, the offer expired, or the award was revoked.";
+                    };
+                    readonly expiresAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "When an unanswered offer lapses, where the community expires offers.";
+                    };
+                    readonly credentialId: {
+                        readonly $ref: "#/$defs/GroupCredentialId";
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            readonly AwardState: {
+                readonly title: "AwardState";
+                readonly description: "`offered`: waiting for the recipient. `accepted`: the recipient took it; for a community badge the credential was issued and the membership recorded. `declined`: the recipient declined; nothing was recorded in the group and nothing issued. `withdrawn`: the giver withdrew the offer before a decision. `expired`: the offer lapsed unanswered. `revoked`: taken back after acceptance (VTI-BDG-023).";
+                readonly type: "string";
+                readonly enum: readonly ["offered", "accepted", "declined", "withdrawn", "expired", "revoked"];
+            };
+            readonly AwardNote: {
+                readonly title: "AwardNote";
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 500;
+                readonly description: "What the award is for, from the giver, shown to the recipient and written as the award's evidence narrative where the badge carries a credential. Plain text; erased with its author (VTI-BDG-090).";
+            };
+            readonly BadgeId: {
+                readonly title: "BadgeId";
+                readonly description: "Opaque identifier of a badge: `bdg_` followed by 16 to 64 base64url characters. Random, community-scoped, never reused (VTI-BDG-001).";
+                readonly type: "string";
+                readonly pattern: "^bdg_[A-Za-z0-9_-]{16,64}$";
+            };
+            readonly AwardId: {
+                readonly title: "AwardId";
+                readonly description: "Opaque identifier of one giving of a badge to one member: `awd_` followed by 16 to 64 base64url characters. Random and unique within the community.";
+                readonly type: "string";
+                readonly pattern: "^awd_[A-Za-z0-9_-]{16,64}$";
+            };
+            readonly GroupCredentialId: {
+                readonly title: "GroupCredentialId";
+                readonly 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.";
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 512;
+            };
+            readonly EntryId: {
+                readonly title: "EntryId";
+                readonly 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.";
+                readonly type: "string";
+                readonly pattern: "^dir_[A-Za-z0-9_-]{16,64}$";
+            };
+        };
+    };
+};
+//# sourceMappingURL=payload.d.ts.map

package/dist/vtc/badges/awards/revoke/0.1/payload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../../src/vtc/badges/awards/revoke/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,iBAAiB,EAAE,MAAM,sCAAsC,CAAC;AAG5I;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;IACb,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AAED,kHAAkH;AAClH,YAAY,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,iBAAiB,EAAE,CAAC;AAEhG,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,0DAAmE,CAAC;AAE5F;;;;;GAKG;AACH,eAAO,MAAM,OAAO,EAAE,MAAM,GAAG,IAAW,CAAC;AAE3C;;;;;GAKG;AACH,eAAO,MAAM,WAAW,EAAE,MAAM,GAAG,IAAW,CAAC;AAE/C,mEAAmE;AACnE,MAAM,MAAM,OAAO,GAAG,4BAA4B,CAAC;AAEnD,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,mEAA4E,CAAC;AAE9G,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,oCAAoC,CAAC;AAE5D;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4JjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqI1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOhB,CAAC"}