@openvtc/trust-tasks 0.28.20 → 0.28.22

package/dist/vtc/badges/show/0.1/payload.d.ts

@@ -2,7 +2,7 @@
  * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
  * Source: specs/vtc/badges/show/0.1/payload.schema.json
  */
-import type { Badge, BadgeCriteria, BadgeDescription, BadgeId, BadgeKind, BadgeName, BadgeState, CardBlobRef, EntryId, Ext, GroupId } from "../../../../_shared/components.js";
+import type { Award, AwardId, AwardNote, AwardShare, AwardState, Badge, BadgeCriteria, BadgeDescription, BadgeId, BadgeKind, BadgeName, BadgeState, CardBlobRef, EntryId, Ext, GroupCredentialId, GroupId } from "../../../../_shared/components.js";
 /**
  * Where the caller stands with the badge, as vtc/badges/list states it. `holder`: at least one accepted award. `offered`: an open offer names them. `requested`: an undecided request to join its badge group. `none`: nothing.
  */
@@ -31,6 +31,12 @@ export interface VTCBadgesShowResponsePayload {
      */
     myCount: number;
     myState: MyState;
+    /**
+     * The caller's own accepted awards of this badge, newest first, each with `shared` where they show it outside the community — what `vtc/badges/awards/share` and `unshare` name. Absent where the caller holds none. Never another member's award.
+     *
+     * @maxItems 1000
+     */
+    myAwards?: Award[];
     /**
      * Community badges only: the badge group's managers, whom a request for the badge goes to. Shown to every caller who may see the badge.
      *
@@ -45,7 +51,7 @@ export interface VTCBadgesShowResponsePayload {
     ext?: Ext;
 }
 /** Shared definitions this specification references, re-exported under the names it used to declare them with. */
-export type { Badge, BadgeCriteria, BadgeDescription, BadgeId, BadgeKind, BadgeName, BadgeState, CardBlobRef, EntryId, Ext, GroupId };
+export type { Award, AwardId, AwardNote, AwardShare, AwardState, Badge, BadgeCriteria, BadgeDescription, BadgeId, BadgeKind, BadgeName, BadgeState, CardBlobRef, EntryId, Ext, GroupCredentialId, GroupId };
 /** Trust Task type URI. */
 export declare const TYPE_URI: "https://trusttasks.org/spec/vtc/badges/show/0.1";
 /**
@@ -126,6 +132,14 @@ export declare const PAYLOAD_SCHEMA: {
                 readonly myState: {
                     readonly $ref: "#/$defs/MyState";
                 };
+                readonly myAwards: {
+                    readonly type: "array";
+                    readonly maxItems: 1000;
+                    readonly items: {
+                        readonly $ref: "#/$defs/Award";
+                    };
+                    readonly description: "The caller's own accepted awards of this badge, newest first, each with `shared` where they show it outside the community — what `vtc/badges/awards/share` and `unshare` name. Absent where the caller holds none. Never another member's award.";
+                };
                 readonly owners: {
                     readonly type: "array";
                     readonly maxItems: 64;
@@ -163,6 +177,114 @@ export declare const PAYLOAD_SCHEMA: {
             readonly type: "string";
             readonly pattern: "^dir_[A-Za-z0-9_-]{16,64}$";
         };
+        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. `shared` is present on an accepted award of a badge its holders may show outside while its holder shares it (vtc/badges/awards/share).";
+            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 shared: {
+                    readonly $ref: "#/$defs/AwardShare";
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        readonly AwardShare: {
+            readonly title: "AwardShare";
+            readonly description: "Where an accepted award is shown outside the community, by its holder's choice (VTI-BDG-070): the public location that answers a verification of exactly what the credential says, the baked image where the community serves one, and since when. Present only while the holder shares the award; absent once they stop, the award is taken back, the badge is retired or the holder departs. The locations are unguessable and name no other holder (VTI-BDG-071).";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["verificationUrl", "since"];
+            readonly properties: {
+                readonly verificationUrl: {
+                    readonly type: "string";
+                    readonly format: "uri";
+                    readonly maxLength: 2048;
+                    readonly description: "The public location that answers the credential and a verification of it.";
+                };
+                readonly bakedImageUrl: {
+                    readonly type: "string";
+                    readonly format: "uri";
+                    readonly maxLength: 2048;
+                    readonly description: "The badge's picture with the credential baked into it, for a website or an email signature. Absent where the community serves no baked image.";
+                };
+                readonly since: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                };
+            };
+        };
+        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 Badge: {
             readonly title: "Badge";
             readonly description: "A badge as a caller who may see it sees it. `groupId` is present exactly when `kind` is `community`. `holderCount` only to callers who may see the badge's holders, counted over holders who have not hidden it (VTI-BDG-030, VTI-BDG-033). `createdBy` is the directory entry of the administrator or member who made it, where they have one.";
@@ -271,12 +393,6 @@ export declare const PAYLOAD_SCHEMA: {
             readonly type: "string";
             readonly enum: readonly ["community", "kudos"];
         };
-        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 GroupId: {
             readonly title: "GroupId";
             readonly description: "Opaque identifier of a community group: `grp_` followed by 16 to 64 base64url characters. Random and community-scoped; not the group's DID.";
@@ -358,6 +474,14 @@ export declare const RESPONSE_PAYLOAD_SCHEMA: {
                 readonly myState: {
                     readonly $ref: "#/$defs/MyState";
                 };
+                readonly myAwards: {
+                    readonly type: "array";
+                    readonly maxItems: 1000;
+                    readonly items: {
+                        readonly $ref: "#/$defs/Award";
+                    };
+                    readonly description: "The caller's own accepted awards of this badge, newest first, each with `shared` where they show it outside the community — what `vtc/badges/awards/share` and `unshare` name. Absent where the caller holds none. Never another member's award.";
+                };
                 readonly owners: {
                     readonly type: "array";
                     readonly maxItems: 64;
@@ -395,6 +519,114 @@ export declare const RESPONSE_PAYLOAD_SCHEMA: {
             readonly type: "string";
             readonly pattern: "^dir_[A-Za-z0-9_-]{16,64}$";
         };
+        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. `shared` is present on an accepted award of a badge its holders may show outside while its holder shares it (vtc/badges/awards/share).";
+            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 shared: {
+                    readonly $ref: "#/$defs/AwardShare";
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        readonly AwardShare: {
+            readonly title: "AwardShare";
+            readonly description: "Where an accepted award is shown outside the community, by its holder's choice (VTI-BDG-070): the public location that answers a verification of exactly what the credential says, the baked image where the community serves one, and since when. Present only while the holder shares the award; absent once they stop, the award is taken back, the badge is retired or the holder departs. The locations are unguessable and name no other holder (VTI-BDG-071).";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["verificationUrl", "since"];
+            readonly properties: {
+                readonly verificationUrl: {
+                    readonly type: "string";
+                    readonly format: "uri";
+                    readonly maxLength: 2048;
+                    readonly description: "The public location that answers the credential and a verification of it.";
+                };
+                readonly bakedImageUrl: {
+                    readonly type: "string";
+                    readonly format: "uri";
+                    readonly maxLength: 2048;
+                    readonly description: "The badge's picture with the credential baked into it, for a website or an email signature. Absent where the community serves no baked image.";
+                };
+                readonly since: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                };
+            };
+        };
+        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 Badge: {
             readonly title: "Badge";
             readonly description: "A badge as a caller who may see it sees it. `groupId` is present exactly when `kind` is `community`. `holderCount` only to callers who may see the badge's holders, counted over holders who have not hidden it (VTI-BDG-030, VTI-BDG-033). `createdBy` is the directory entry of the administrator or member who made it, where they have one.";
@@ -503,12 +735,6 @@ export declare const RESPONSE_PAYLOAD_SCHEMA: {
             readonly type: "string";
             readonly enum: readonly ["community", "kudos"];
         };
-        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 GroupId: {
             readonly title: "GroupId";
             readonly description: "Opaque identifier of a community group: `grp_` followed by 16 to 64 base64url characters. Random and community-scoped; not the group's DID.";
@@ -614,6 +840,14 @@ export declare const SPEC: {
                     readonly myState: {
                         readonly $ref: "#/$defs/MyState";
                     };
+                    readonly myAwards: {
+                        readonly type: "array";
+                        readonly maxItems: 1000;
+                        readonly items: {
+                            readonly $ref: "#/$defs/Award";
+                        };
+                        readonly description: "The caller's own accepted awards of this badge, newest first, each with `shared` where they show it outside the community — what `vtc/badges/awards/share` and `unshare` name. Absent where the caller holds none. Never another member's award.";
+                    };
                     readonly owners: {
                         readonly type: "array";
                         readonly maxItems: 64;
@@ -651,6 +885,114 @@ export declare const SPEC: {
                 readonly type: "string";
                 readonly pattern: "^dir_[A-Za-z0-9_-]{16,64}$";
             };
+            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. `shared` is present on an accepted award of a badge its holders may show outside while its holder shares it (vtc/badges/awards/share).";
+                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 shared: {
+                        readonly $ref: "#/$defs/AwardShare";
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            readonly AwardShare: {
+                readonly title: "AwardShare";
+                readonly description: "Where an accepted award is shown outside the community, by its holder's choice (VTI-BDG-070): the public location that answers a verification of exactly what the credential says, the baked image where the community serves one, and since when. Present only while the holder shares the award; absent once they stop, the award is taken back, the badge is retired or the holder departs. The locations are unguessable and name no other holder (VTI-BDG-071).";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["verificationUrl", "since"];
+                readonly properties: {
+                    readonly verificationUrl: {
+                        readonly type: "string";
+                        readonly format: "uri";
+                        readonly maxLength: 2048;
+                        readonly description: "The public location that answers the credential and a verification of it.";
+                    };
+                    readonly bakedImageUrl: {
+                        readonly type: "string";
+                        readonly format: "uri";
+                        readonly maxLength: 2048;
+                        readonly description: "The badge's picture with the credential baked into it, for a website or an email signature. Absent where the community serves no baked image.";
+                    };
+                    readonly since: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                    };
+                };
+            };
+            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 Badge: {
                 readonly title: "Badge";
                 readonly description: "A badge as a caller who may see it sees it. `groupId` is present exactly when `kind` is `community`. `holderCount` only to callers who may see the badge's holders, counted over holders who have not hidden it (VTI-BDG-030, VTI-BDG-033). `createdBy` is the directory entry of the administrator or member who made it, where they have one.";
@@ -759,12 +1101,6 @@ export declare const SPEC: {
                 readonly type: "string";
                 readonly enum: readonly ["community", "kudos"];
             };
-            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 GroupId: {
                 readonly title: "GroupId";
                 readonly description: "Opaque identifier of a community group: `grp_` followed by 16 to 64 base64url characters. Random and community-scoped; not the group's DID.";
@@ -857,6 +1193,14 @@ export declare const RESPONSE_SPEC: {
                     readonly myState: {
                         readonly $ref: "#/$defs/MyState";
                     };
+                    readonly myAwards: {
+                        readonly type: "array";
+                        readonly maxItems: 1000;
+                        readonly items: {
+                            readonly $ref: "#/$defs/Award";
+                        };
+                        readonly description: "The caller's own accepted awards of this badge, newest first, each with `shared` where they show it outside the community — what `vtc/badges/awards/share` and `unshare` name. Absent where the caller holds none. Never another member's award.";
+                    };
                     readonly owners: {
                         readonly type: "array";
                         readonly maxItems: 64;
@@ -894,6 +1238,114 @@ export declare const RESPONSE_SPEC: {
                 readonly type: "string";
                 readonly pattern: "^dir_[A-Za-z0-9_-]{16,64}$";
             };
+            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. `shared` is present on an accepted award of a badge its holders may show outside while its holder shares it (vtc/badges/awards/share).";
+                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 shared: {
+                        readonly $ref: "#/$defs/AwardShare";
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            readonly AwardShare: {
+                readonly title: "AwardShare";
+                readonly description: "Where an accepted award is shown outside the community, by its holder's choice (VTI-BDG-070): the public location that answers a verification of exactly what the credential says, the baked image where the community serves one, and since when. Present only while the holder shares the award; absent once they stop, the award is taken back, the badge is retired or the holder departs. The locations are unguessable and name no other holder (VTI-BDG-071).";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["verificationUrl", "since"];
+                readonly properties: {
+                    readonly verificationUrl: {
+                        readonly type: "string";
+                        readonly format: "uri";
+                        readonly maxLength: 2048;
+                        readonly description: "The public location that answers the credential and a verification of it.";
+                    };
+                    readonly bakedImageUrl: {
+                        readonly type: "string";
+                        readonly format: "uri";
+                        readonly maxLength: 2048;
+                        readonly description: "The badge's picture with the credential baked into it, for a website or an email signature. Absent where the community serves no baked image.";
+                    };
+                    readonly since: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                    };
+                };
+            };
+            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 Badge: {
                 readonly title: "Badge";
                 readonly description: "A badge as a caller who may see it sees it. `groupId` is present exactly when `kind` is `community`. `holderCount` only to callers who may see the badge's holders, counted over holders who have not hidden it (VTI-BDG-030, VTI-BDG-033). `createdBy` is the directory entry of the administrator or member who made it, where they have one.";
@@ -1002,12 +1454,6 @@ export declare const RESPONSE_SPEC: {
                 readonly type: "string";
                 readonly enum: readonly ["community", "kudos"];
             };
-            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 GroupId: {
                 readonly title: "GroupId";
                 readonly description: "Opaque identifier of a community group: `grp_` followed by 16 to 64 base64url characters. Random and community-scoped; not the group's DID.";

package/dist/vtc/badges/show/0.1/payload.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../src/vtc/badges/show/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,KAAK,EAAE,aAAa,EAAE,gBAAgB,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,mCAAmC,CAAC;AAG/K;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,QAAQ,GAAG,SAAS,GAAG,WAAW,GAAG,MAAM,CAAC;AAClE;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC;AAE7D;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;IACb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,OAAO,CAAC;IACjB;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC;IACnB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AAED,kHAAkH;AAClH,YAAY,EAAE,KAAK,EAAE,aAAa,EAAE,gBAAgB,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC;AAEtI,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,iDAA0D,CAAC;AAEnF;;;;;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,oBAAoB,CAAC;AAE3C,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,0DAAmE,CAAC;AAErG,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,4BAA4B,CAAC;AAEpD;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2RjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4Q1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOhB,CAAC"}
+{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../src/vtc/badges/show/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,KAAK,EAAE,aAAa,EAAE,gBAAgB,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,EAAE,iBAAiB,EAAE,OAAO,EAAE,MAAM,mCAAmC,CAAC;AAGrP;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,QAAQ,GAAG,SAAS,GAAG,WAAW,GAAG,MAAM,CAAC;AAClE;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC;AAE7D;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;IACb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,OAAO,CAAC;IACjB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,KAAK,EAAE,CAAC;IACnB;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC;IACnB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AAED,kHAAkH;AAClH,YAAY,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,KAAK,EAAE,aAAa,EAAE,gBAAgB,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,EAAE,iBAAiB,EAAE,OAAO,EAAE,CAAC;AAE5M,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,iDAA0D,CAAC;AAEnF;;;;;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,oBAAoB,CAAC;AAE3C,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,0DAAmE,CAAC;AAErG,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,4BAA4B,CAAC;AAEpD;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAyZjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA0Y1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOhB,CAAC"}