@carrot-foundation/schemas 0.4.2 → 0.5.1

package/dist/index.cjs

@@ -28610,7 +28610,7 @@ var NftIpfsSchema = BaseIpfsSchema.safeExtend({
     "External link URLs must be unique"
   ).optional().meta({
     title: "External Links",
-    description: "Optional list of public resource links with labels"
+    description: "Supplementary reference links (label, URL, optional description) displayed on the NFT page"
   }),
   attributes: uniqueBy(
     NftAttributeSchema,
@@ -29415,22 +29415,27 @@ var CreditRetirementReceiptSummarySchema = SummaryBaseSchema.safeExtend({
   description: "Summary totals for the credit retirement including credit quantity, certificate count, and timestamp"
 });
 var ReceiptIdentitySchema = zod.z.strictObject({
-  name: NonEmptyStringSchema.max(100).meta({
+  name: NonEmptyStringSchema.max(100).optional().meta({
     title: "Identity Name",
     description: "Display name of the buyer or beneficiary on the receipt",
     examples: ["EcoTech Solutions Inc.", "Climate Action Corp"]
   }),
-  external_id: ExternalIdSchema.meta({
+  external_id: ExternalIdSchema.optional().meta({
     title: "Identity External ID",
-    description: "Unique identifier for the buyer or beneficiary in the Carrot platform"
+    description: "Unique identifier of the associated entity in the Carrot platform"
   }),
-  external_url: ExternalUrlSchema.meta({
+  external_url: ExternalUrlSchema.optional().meta({
     title: "Identity External URL",
     description: "Link to the buyer or beneficiary profile page on the Carrot platform"
   })
-}).meta({
+}).refine(
+  (value) => value.name !== void 0 || value.external_id !== void 0 || value.external_url !== void 0,
+  {
+    message: "identity must include at least one of: name, external_id, external_url"
+  }
+).meta({
   title: "Identity",
-  description: "Identity information for the buyer or beneficiary associated with this receipt"
+  description: "Identity information for the buyer or beneficiary associated with this receipt. All fields are optional, but at least one must be provided when the identity block is present."
 });
 function createReceiptCollectionSchema(params) {
   const { meta } = params;
@@ -29486,7 +29491,7 @@ function buildSchemaUrl(schemaPath) {
   return `${getSchemaBaseUrl()}/${cleanPath}`;
 }
 function getSchemaVersionOrDefault() {
-  return "0.4.2";
+  return "0.5.1";
 }
 
 // src/shared/schema-validation.ts
@@ -30060,7 +30065,7 @@ var MassIDWastePropertiesSchema = zod.z.strictObject({
   local_classification: MassIDLocalClassificationSchema.optional(),
   weight_kg: WeightKgSchema.meta({
     title: "Net Weight",
-    description: "Net weight of the waste batch in kilograms (kg)",
+    description: "Weight in kilograms of the entire waste batch tracked through the chain of custody",
     examples: [3e3]
   })
 }).meta({
@@ -30103,7 +30108,7 @@ var MassIDBaseEventSchema = zod.z.strictObject({
   participant_id_hash: ParticipantIdHashSchema,
   location_id_hash: Sha256HashSchema.meta({
     title: "Location ID Hash",
-    description: "Reference to location in the locations array"
+    description: "Hash reference to the geographic location where this event occurred; matches an entry in `data.locations`"
   })
 }).meta({
   title: "MassID Base Event",
@@ -31037,7 +31042,7 @@ var CreditPurchaseReceiptBuyerAttributeSchema = NftAttributeSchema.omit({
 var CreditPurchaseReceiptRetirementDateAttributeSchema = createDateAttributeSchema({
   traitType: "Retirement Date",
   title: "Retirement Date",
-  description: "Unix timestamp in milliseconds when credits were retired (if retirement occurred)"
+  description: "Unix timestamp in milliseconds when credits were retired; present in the attributes array only when the purchase has been retired (data.retirement_receipt is set)"
 });
 var CreditPurchaseReceiptRetirementReceiptAttributeSchema = NftAttributeSchema.safeExtend({
   trait_type: zod.z.literal("Retirement Receipt"),
@@ -31479,11 +31484,11 @@ var CreditRetirementReceiptPurchaseReceiptAttributeSchema = NftAttributeSchema.s
 });
 var REQUIRED_CREDIT_RETIREMENT_RECEIPT_ATTRIBUTES = [
   CreditRetirementReceiptTotalCreditsAttributeSchema,
-  CreditRetirementReceiptBeneficiaryAttributeSchema,
   CreditRetirementReceiptRetirementDateAttributeSchema,
   CreditRetirementReceiptCertificatesAttributeSchema
 ];
 var CONDITIONAL_CREDIT_RETIREMENT_RECEIPT_ATTRIBUTES = [
+  CreditRetirementReceiptBeneficiaryAttributeSchema,
   CreditRetirementReceiptCreditHolderAttributeSchema,
   CreditRetirementReceiptPurchaseDateAttributeSchema,
   CreditRetirementReceiptPurchaseReceiptAttributeSchema
@@ -31498,11 +31503,10 @@ var CreditRetirementReceiptAttributesSchema = createOrderedAttributesSchema({
     ...DYNAMIC_CREDIT_RETIREMENT_RECEIPT_ATTRIBUTES
   ],
   title: "Credit Retirement Receipt NFT Attribute Array",
-  description: "Attributes for credit retirement receipts including per-credit breakdowns, totals, beneficiary, credit holder, retirement date, certificate count, and optional purchase info. Fixed required attributes: Total Credits Retired, Beneficiary, Retirement Date, Certificates Retired. Conditional attributes: Credit Holder (required when credit_holder.identity.name is provided), Purchase Date (optional, when purchase_receipt is present), Purchase Receipt (optional, when purchase_receipt is present). Dynamic attributes: Credit attributes (one per credit symbol in data.credits).",
+  description: "Attributes for credit retirement receipts including per-credit breakdowns, totals, beneficiary, credit holder, retirement date, certificate count, and optional purchase info. Fixed required attributes: Total Credits Retired, Retirement Date, Certificates Retired. Conditional attributes: Beneficiary (required when beneficiary.identity.name is provided), Credit Holder (required when credit_holder.identity.name is provided), Purchase Date (optional, when purchase_receipt is present), Purchase Receipt (optional, when purchase_receipt is present). Dynamic attributes: Credit attributes (one per credit symbol in data.credits).",
   uniqueBySelector: (attribute) => attribute.trait_type,
   requiredTraitTypes: [
     "Total Credits Retired",
-    "Beneficiary",
     "Retirement Date",
     "Certificates Retired"
   ]
@@ -31511,9 +31515,9 @@ var CreditRetirementReceiptIdentitySchema = ReceiptIdentitySchema;
 var CreditRetirementReceiptBeneficiarySchema = zod.z.strictObject({
   beneficiary_id: ExternalIdSchema.meta({
     title: "Retirement Beneficiary ID",
-    description: "UUID identifying the beneficiary of the retirement (bytes16 normalized to UUID)"
+    description: "UUID identifying the beneficiary of the retirement within the Carrot platform"
   }),
-  identity: CreditRetirementReceiptIdentitySchema
+  identity: CreditRetirementReceiptIdentitySchema.optional()
 }).meta({
   title: "Beneficiary",
   description: "Beneficiary receiving the retirement benefit"
@@ -31521,7 +31525,7 @@ var CreditRetirementReceiptBeneficiarySchema = zod.z.strictObject({
 var CreditRetirementReceiptCreditHolderSchema = zod.z.strictObject({
   wallet_address: EthereumAddressSchema.meta({
     title: "Credit Holder Wallet Address",
-    description: "Ethereum address of the credit holder surrendering credits"
+    description: "Ethereum address of the wallet that held and surrendered the credits"
   }),
   identity: CreditRetirementReceiptIdentitySchema.optional()
 }).meta({
@@ -31733,7 +31737,7 @@ var CreditRetirementReceiptDataSchema = zod.z.strictObject({
 });
 var CreditRetirementReceiptIpfsSchemaMeta = {
   title: "CreditRetirementReceipt NFT IPFS Record",
-  description: "Complete CreditRetirementReceipt NFT IPFS record including retirement summary, beneficiary and credit holder details, credit breakdowns, certificate allocations, and NFT display attributes",
+  description: "Complete CreditRetirementReceipt NFT IPFS record including retirement summary, beneficiary and credit holder details (identity optional), credit breakdowns, certificate allocations, and NFT display attributes",
   $id: buildSchemaUrl(
     "credit-retirement-receipt/credit-retirement-receipt.schema.json"
   ),
@@ -31803,14 +31807,17 @@ var CreditRetirementReceiptIpfsSchema = NftIpfsSchema.safeExtend({
     missingMessage: 'Attribute "Certificates Retired" is required',
     mismatchMessage: 'Attribute "Certificates Retired" must match data.summary.total_certificates'
   });
-  validateAttributeValue({
-    ctx,
-    attributeByTraitType,
-    traitType: "Beneficiary",
-    expectedValue: String(data.beneficiary.identity.name),
-    missingMessage: 'Attribute "Beneficiary" is required',
-    mismatchMessage: 'Attribute "Beneficiary" must match beneficiary.identity.name'
-  });
+  const beneficiaryName = data.beneficiary.identity?.name;
+  if (beneficiaryName) {
+    validateAttributeValue({
+      ctx,
+      attributeByTraitType,
+      traitType: "Beneficiary",
+      expectedValue: String(beneficiaryName),
+      missingMessage: 'Attribute "Beneficiary" is required when beneficiary.identity.name is provided',
+      mismatchMessage: 'Attribute "Beneficiary" must match beneficiary.identity.name'
+    });
+  }
   const creditHolderName = data.credit_holder.identity?.name;
   if (creditHolderName) {
     validateAttributeValue({