@openvtc/trust-tasks 0.28.19 → 0.28.20

package/src/index.ts

@@ -3216,6 +3216,12 @@ export import VtcBadgesAwardsOffer_v0_1 = _VtcBadgesAwardsOffer_v0_1;
 import * as _VtcBadgesAwardsRevoke_v0_1 from "./vtc/badges/awards/revoke/0.1/payload.js";
 /** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
 export import VtcBadgesAwardsRevoke_v0_1 = _VtcBadgesAwardsRevoke_v0_1;
+import * as _VtcBadgesAwardsShare_v0_1 from "./vtc/badges/awards/share/0.1/payload.js";
+/** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
+export import VtcBadgesAwardsShare_v0_1 = _VtcBadgesAwardsShare_v0_1;
+import * as _VtcBadgesAwardsUnshare_v0_1 from "./vtc/badges/awards/unshare/0.1/payload.js";
+/** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
+export import VtcBadgesAwardsUnshare_v0_1 = _VtcBadgesAwardsUnshare_v0_1;
 import * as _VtcBadgesAwardsWithdraw_v0_1 from "./vtc/badges/awards/withdraw/0.1/payload.js";
 /** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
 export import VtcBadgesAwardsWithdraw_v0_1 = _VtcBadgesAwardsWithdraw_v0_1;

package/src/vtc/badges/_shared/0.1/badge.ts

@@ -20,4 +20,4 @@ export interface BadgeSharedDefinitionsForTheVtcBadgesSpecFamily {
  * The definitions this shared schema publishes, hoisted to one declaration each.
  * See "../../../../_shared/components.js".
  */
-export type { Award, AwardId, AwardNote, AwardState, Badge, BadgeCriteria, BadgeDescription, BadgeId, BadgeKind, BadgeLimits, BadgeName, BadgeSettings, BadgeState, KudosMakers, MyBadge, WallEntry, WallVisibility } from "../../../../_shared/components.js";
+export type { Award, AwardId, AwardNote, AwardShare, AwardState, Badge, BadgeCriteria, BadgeDescription, BadgeId, BadgeKind, BadgeLimits, BadgeName, BadgeSettings, BadgeState, KudosMakers, MyBadge, WallEntry, WallVisibility } from "../../../../_shared/components.js";

package/src/vtc/badges/awards/list/0.1/payload.ts

@@ -3,7 +3,7 @@
  * Source: specs/vtc/badges/awards/list/0.1/payload.schema.json
  */
 
-import type { Award, AwardId, AwardNote, AwardState, BadgeId, CardBlobRef, EntryFields, EntryId, Ext, FieldValue, GroupCredentialId, VerifiedValue } from "../../../../../_shared/components.js";
+import type { Award, AwardId, AwardNote, AwardShare, AwardState, BadgeId, CardBlobRef, EntryFields, EntryId, Ext, FieldValue, GroupCredentialId, VerifiedValue } from "../../../../../_shared/components.js";
 
 
 /**
@@ -57,7 +57,7 @@ export interface VTCBadgesAwardsListResponsePayload {
 }
 
 /** Shared definitions this specification references, re-exported under the names it used to declare them with. */
-export type { Award, AwardId, AwardNote, AwardState, BadgeId, CardBlobRef, EntryFields, EntryId, Ext, FieldValue, GroupCredentialId, VerifiedValue };
+export type { Award, AwardId, AwardNote, AwardShare, AwardState, BadgeId, CardBlobRef, EntryFields, EntryId, Ext, FieldValue, GroupCredentialId, VerifiedValue };
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/badges/awards/list/0.1" as const;
@@ -334,7 +334,7 @@ export const PAYLOAD_SCHEMA = {
     },
     "Award": {
       "title": "Award",
-      "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.",
+      "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).",
       "type": "object",
       "additionalProperties": false,
       "required": [
@@ -381,11 +381,42 @@ export const PAYLOAD_SCHEMA = {
         "credentialId": {
           "$ref": "#/$defs/GroupCredentialId"
         },
+        "shared": {
+          "$ref": "#/$defs/AwardShare"
+        },
         "ext": {
           "$ref": "#/$defs/Ext"
         }
       }
     },
+    "AwardShare": {
+      "title": "AwardShare",
+      "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).",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "verificationUrl",
+        "since"
+      ],
+      "properties": {
+        "verificationUrl": {
+          "type": "string",
+          "format": "uri",
+          "maxLength": 2048,
+          "description": "The public location that answers the credential and a verification of it."
+        },
+        "bakedImageUrl": {
+          "type": "string",
+          "format": "uri",
+          "maxLength": 2048,
+          "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."
+        },
+        "since": {
+          "type": "string",
+          "format": "date-time"
+        }
+      }
+    },
     "AwardState": {
       "title": "AwardState",
       "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).",
@@ -638,7 +669,7 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
     },
     "Award": {
       "title": "Award",
-      "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.",
+      "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).",
       "type": "object",
       "additionalProperties": false,
       "required": [
@@ -685,11 +716,42 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
         "credentialId": {
           "$ref": "#/$defs/GroupCredentialId"
         },
+        "shared": {
+          "$ref": "#/$defs/AwardShare"
+        },
         "ext": {
           "$ref": "#/$defs/Ext"
         }
       }
     },
+    "AwardShare": {
+      "title": "AwardShare",
+      "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).",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "verificationUrl",
+        "since"
+      ],
+      "properties": {
+        "verificationUrl": {
+          "type": "string",
+          "format": "uri",
+          "maxLength": 2048,
+          "description": "The public location that answers the credential and a verification of it."
+        },
+        "bakedImageUrl": {
+          "type": "string",
+          "format": "uri",
+          "maxLength": 2048,
+          "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."
+        },
+        "since": {
+          "type": "string",
+          "format": "date-time"
+        }
+      }
+    },
     "AwardState": {
       "title": "AwardState",
       "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).",

package/src/vtc/badges/awards/offer/0.1/payload.ts

@@ -3,7 +3,7 @@
  * Source: specs/vtc/badges/awards/offer/0.1/payload.schema.json
  */
 
-import type { Award, AwardId, AwardNote, AwardState, BadgeId, EntryId, Ext, GroupCredentialId, GroupId } from "../../../../../_shared/components.js";
+import type { Award, AwardId, AwardNote, AwardShare, AwardState, BadgeId, EntryId, Ext, GroupCredentialId, GroupId } from "../../../../../_shared/components.js";
 
 
 /**
@@ -57,7 +57,7 @@ export interface VTCBadgesAwardsOfferResponsePayload {
 }
 
 /** 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, GroupId };
+export type { Award, AwardId, AwardNote, AwardShare, AwardState, BadgeId, EntryId, Ext, GroupCredentialId, GroupId };
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/badges/awards/offer/0.1" as const;
@@ -225,7 +225,7 @@ export const PAYLOAD_SCHEMA = {
     },
     "Award": {
       "title": "Award",
-      "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.",
+      "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).",
       "type": "object",
       "additionalProperties": false,
       "required": [
@@ -272,11 +272,42 @@ export const PAYLOAD_SCHEMA = {
         "credentialId": {
           "$ref": "#/$defs/GroupCredentialId"
         },
+        "shared": {
+          "$ref": "#/$defs/AwardShare"
+        },
         "ext": {
           "$ref": "#/$defs/Ext"
         }
       }
     },
+    "AwardShare": {
+      "title": "AwardShare",
+      "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).",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "verificationUrl",
+        "since"
+      ],
+      "properties": {
+        "verificationUrl": {
+          "type": "string",
+          "format": "uri",
+          "maxLength": 2048,
+          "description": "The public location that answers the credential and a verification of it."
+        },
+        "bakedImageUrl": {
+          "type": "string",
+          "format": "uri",
+          "maxLength": 2048,
+          "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."
+        },
+        "since": {
+          "type": "string",
+          "format": "date-time"
+        }
+      }
+    },
     "AwardState": {
       "title": "AwardState",
       "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).",
@@ -400,7 +431,7 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
     },
     "Award": {
       "title": "Award",
-      "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.",
+      "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).",
       "type": "object",
       "additionalProperties": false,
       "required": [
@@ -447,11 +478,42 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
         "credentialId": {
           "$ref": "#/$defs/GroupCredentialId"
         },
+        "shared": {
+          "$ref": "#/$defs/AwardShare"
+        },
         "ext": {
           "$ref": "#/$defs/Ext"
         }
       }
     },
+    "AwardShare": {
+      "title": "AwardShare",
+      "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).",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "verificationUrl",
+        "since"
+      ],
+      "properties": {
+        "verificationUrl": {
+          "type": "string",
+          "format": "uri",
+          "maxLength": 2048,
+          "description": "The public location that answers the credential and a verification of it."
+        },
+        "bakedImageUrl": {
+          "type": "string",
+          "format": "uri",
+          "maxLength": 2048,
+          "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."
+        },
+        "since": {
+          "type": "string",
+          "format": "date-time"
+        }
+      }
+    },
     "AwardState": {
       "title": "AwardState",
       "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).",

package/src/vtc/badges/awards/revoke/0.1/payload.ts

@@ -3,7 +3,7 @@
  * 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";
+import type { Award, AwardId, AwardNote, AwardShare, AwardState, BadgeId, EntryId, Ext, GroupCredentialId } from "../../../../../_shared/components.js";
 
 
 /**
@@ -32,7 +32,7 @@ export interface VTCBadgesAwardsRevokeResponsePayload {
 }
 
 /** 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 };
+export type { Award, AwardId, AwardNote, AwardShare, AwardState, BadgeId, EntryId, Ext, GroupCredentialId };
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/badges/awards/revoke/0.1" as const;
@@ -129,7 +129,7 @@ export const PAYLOAD_SCHEMA = {
     },
     "Award": {
       "title": "Award",
-      "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.",
+      "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).",
       "type": "object",
       "additionalProperties": false,
       "required": [
@@ -176,11 +176,42 @@ export const PAYLOAD_SCHEMA = {
         "credentialId": {
           "$ref": "#/$defs/GroupCredentialId"
         },
+        "shared": {
+          "$ref": "#/$defs/AwardShare"
+        },
         "ext": {
           "$ref": "#/$defs/Ext"
         }
       }
     },
+    "AwardShare": {
+      "title": "AwardShare",
+      "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).",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "verificationUrl",
+        "since"
+      ],
+      "properties": {
+        "verificationUrl": {
+          "type": "string",
+          "format": "uri",
+          "maxLength": 2048,
+          "description": "The public location that answers the credential and a verification of it."
+        },
+        "bakedImageUrl": {
+          "type": "string",
+          "format": "uri",
+          "maxLength": 2048,
+          "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."
+        },
+        "since": {
+          "type": "string",
+          "format": "date-time"
+        }
+      }
+    },
     "AwardState": {
       "title": "AwardState",
       "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).",
@@ -265,7 +296,7 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
     },
     "Award": {
       "title": "Award",
-      "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.",
+      "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).",
       "type": "object",
       "additionalProperties": false,
       "required": [
@@ -312,11 +343,42 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
         "credentialId": {
           "$ref": "#/$defs/GroupCredentialId"
         },
+        "shared": {
+          "$ref": "#/$defs/AwardShare"
+        },
         "ext": {
           "$ref": "#/$defs/Ext"
         }
       }
     },
+    "AwardShare": {
+      "title": "AwardShare",
+      "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).",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "verificationUrl",
+        "since"
+      ],
+      "properties": {
+        "verificationUrl": {
+          "type": "string",
+          "format": "uri",
+          "maxLength": 2048,
+          "description": "The public location that answers the credential and a verification of it."
+        },
+        "bakedImageUrl": {
+          "type": "string",
+          "format": "uri",
+          "maxLength": 2048,
+          "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."
+        },
+        "since": {
+          "type": "string",
+          "format": "date-time"
+        }
+      }
+    },
     "AwardState": {
       "title": "AwardState",
       "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).",