@carrot-foundation/schemas 0.1.53 → 0.1.55

package/dist/index.cjs

@@ -28632,6 +28632,29 @@ function mergeSchemaMeta(schema, newMeta) {
   }
   return merged;
 }
+function extractTraitType(schema) {
+  try {
+    if (typeof schema === "object" && schema !== null && "shape" in schema && typeof schema.shape === "object" && schema.shape !== null && "trait_type" in schema.shape) {
+      const traitTypeSchema = schema.shape.trait_type;
+      const literalSchema = traitTypeSchema;
+      if (literalSchema.value !== void 0 && typeof literalSchema.value === "string") {
+        return literalSchema.value;
+      }
+    }
+    const meta = getSchemaMetadata(schema);
+    if (meta?.title) {
+      const title = meta.title;
+      if (title.endsWith(" Attribute")) {
+        const inferred = title.slice(0, -11);
+        if (inferred.length > 3) {
+          return inferred;
+        }
+      }
+    }
+  } catch {
+  }
+  return "";
+}
 function createDateAttributeSchema(params) {
   const { omitMaxValue = true } = params;
   const base = omitMaxValue ? NftAttributeSchema.omit({ max_value: true }) : NftAttributeSchema;
@@ -28682,6 +28705,71 @@ function createNumericAttributeSchema(params) {
     description: `${params.description} attribute with numeric display`
   });
 }
+function createOrderedAttributesSchema(params) {
+  const {
+    required,
+    optional = [],
+    title,
+    description,
+    uniqueBySelector,
+    maxItems,
+    requiredTraitTypes,
+    optionalTraitTypes
+  } = params;
+  const allSchemas = [...required, ...optional];
+  let unionSchema;
+  if (allSchemas.length === 0) {
+    unionSchema = zod.z.never();
+  } else if (allSchemas.length === 1) {
+    unionSchema = allSchemas[0];
+  } else {
+    unionSchema = zod.z.union(
+      allSchemas
+    );
+  }
+  const requiredTypes = requiredTraitTypes ?? required.map(extractTraitType).filter(Boolean);
+  const optionalTypes = optionalTraitTypes ?? optional.map(extractTraitType).filter(Boolean);
+  const isDynamic = description.includes("Dynamic attributes");
+  const descriptionParts = [description];
+  if (requiredTypes.length > 0) {
+    descriptionParts.push(
+      `
+
+Required attributes (${required.length}): ${requiredTypes.join(", ")}`
+    );
+  }
+  if (optionalTypes.length > 0 && !isDynamic) {
+    descriptionParts.push(
+      `
+Optional attributes (${optional.length}): ${optionalTypes.join(", ")}`
+    );
+  }
+  let arraySchema = uniqueBy(unionSchema, uniqueBySelector).min(
+    required.length
+  );
+  if (maxItems !== void 0) {
+    arraySchema = arraySchema.max(maxItems);
+  } else if (optional.length > 0 && !isDynamic) {
+    arraySchema = arraySchema.max(required.length + optional.length);
+  }
+  return arraySchema.superRefine((attributes, ctx) => {
+    const traitTypes = new Set(
+      attributes.map(uniqueBySelector)
+    );
+    for (const traitType of requiredTypes) {
+      if (traitType && !traitTypes.has(traitType)) {
+        ctx.addIssue({
+          code: "custom",
+          message: `Required attribute '${traitType}' is missing`,
+          path: []
+        });
+      }
+    }
+  }).meta({
+    title,
+    description: descriptionParts.join("")
+  });
+}
 var MethodologyAttributeSchema = NftAttributeSchema.safeExtend({
   trait_type: zod.z.literal("Methodology"),
   value: MethodologyNameSchema
@@ -29357,7 +29445,7 @@ function buildSchemaUrl(schemaPath) {
   return `${getSchemaBaseUrl()}/${cleanPath}`;
 }
 function getSchemaVersionOrDefault() {
-  return "0.1.53";
+  return "0.1.55";
 }
 
 // src/shared/schema-validation.ts
@@ -29628,27 +29716,48 @@ var MassIDAttributeRecyclingDateSchema = createDateAttributeSchema({
   title: "Recycling Date",
   description: "Unix timestamp in milliseconds when the waste was recycled/processed"
 });
-var MassIDAttributesSchema = uniqueBy(
-  zod.z.union([
-    MassIDAttributeWasteTypeSchema,
-    MassIDAttributeWasteSubtypeSchema,
-    MassIDAttributeWeightSchema,
-    MassIDAttributeOriginCitySchema,
-    MassIDAttributePickUpVehicleTypeSchema,
-    MassIDAttributeRecyclingMethodSchema,
-    MassIDAttributeLocalWasteClassificationIdSchema,
-    MassIDAttributeRecyclingManifestCodeSchema,
-    MassIDAttributeTransportManifestCodeSchema,
-    MassIDAttributeWeighingCaptureMethodSchema,
-    MassIDAttributeScaleTypeSchema,
-    MassIDAttributePickUpDateSchema,
-    MassIDAttributeDropOffDateSchema,
-    MassIDAttributeRecyclingDateSchema
-  ]),
-  (attr) => attr.trait_type
-).min(9).max(14).meta({
+var REQUIRED_MASS_ID_ATTRIBUTES = [
+  MassIDAttributeWasteTypeSchema,
+  MassIDAttributeWasteSubtypeSchema,
+  MassIDAttributeWeightSchema,
+  MassIDAttributeOriginCitySchema,
+  MassIDAttributePickUpVehicleTypeSchema,
+  MassIDAttributeRecyclingMethodSchema,
+  MassIDAttributePickUpDateSchema,
+  MassIDAttributeDropOffDateSchema,
+  MassIDAttributeRecyclingDateSchema
+];
+var OPTIONAL_MASS_ID_ATTRIBUTES = [
+  MassIDAttributeLocalWasteClassificationIdSchema,
+  MassIDAttributeRecyclingManifestCodeSchema,
+  MassIDAttributeTransportManifestCodeSchema,
+  MassIDAttributeWeighingCaptureMethodSchema,
+  MassIDAttributeScaleTypeSchema
+];
+var MassIDAttributesSchema = createOrderedAttributesSchema({
+  required: REQUIRED_MASS_ID_ATTRIBUTES,
+  optional: OPTIONAL_MASS_ID_ATTRIBUTES,
   title: "MassID Attributes",
-  description: "Array of NFT attributes describing waste characteristics, origin, logistics, and lifecycle events."
+  description: "Array of NFT attributes describing waste characteristics, origin, logistics, and lifecycle events.",
+  uniqueBySelector: (attr) => attr.trait_type,
+  requiredTraitTypes: [
+    "Waste Type",
+    "Waste Subtype",
+    "Weight (kg)",
+    "Origin City",
+    "Pick-up Vehicle Type",
+    "Recycling Method",
+    "Pick-up Date",
+    "Drop-off Date",
+    "Recycling Date"
+  ],
+  optionalTraitTypes: [
+    "Local Waste Classification ID",
+    "Recycling Manifest Number",
+    "Transport Manifest Number",
+    "Weighing Capture Method",
+    "Scale Type"
+  ]
 });
 var MassIDLocalClassificationSchema = zod.z.strictObject({
   code: IbamaWasteClassificationSchema,
@@ -30082,7 +30191,7 @@ var GasIDAttributesSchema = zod.z.tuple([
   GasIDAttributeCertificateIssuanceDateSchema
 ]).meta({
   title: "GasID NFT Attribute Array",
-  description: "Schema for the fixed set of GasID NFT attributes, enforcing order and type for each trait"
+  description: "Schema for the fixed set of GasID NFT attributes, enforcing order and type for each trait.\n\nRequired attributes (11, in order): Methodology, Gas Type, CO\u2082e Prevented (kg), Credit Amount, Credit Type, Source Waste Type, Source Weight (kg), Origin City, MassID, MassID Recycling Date, Certificate Issuance Date."
 });
 var GasIDSummarySchema = zod.z.strictObject({
   gas_type: GasTypeSchema,
@@ -30135,9 +30244,9 @@ var PreventedEmissionsCalculationSchema = zod.z.strictObject({
     description: "Method used to calculate the prevented emissions",
     examples: ["UNFCCC AMS-III.F"]
   }),
-  date: IsoDateSchema.meta({
-    title: "Calculation Date",
-    description: "Date when the calculation was performed"
+  calculated_at: IsoDateTimeSchema.meta({
+    title: "Calculated At",
+    description: "ISO 8601 timestamp when the calculation was performed"
   }),
   values: zod.z.array(CalculationValueSchema).min(1).meta({
     title: "Calculation Values",
@@ -30176,17 +30285,8 @@ var GasIDIpfsSchema = NftIpfsSchema.safeExtend({
       description: "GasID NFT schema type"
     })
   }),
+  attributes: GasIDAttributesSchema,
   data: GasIDDataSchema
-}).superRefine((value, ctx) => {
-  const attributesResult = GasIDAttributesSchema.safeParse(value.attributes);
-  if (!attributesResult.success) {
-    attributesResult.error.issues.forEach((issue) => {
-      ctx.addIssue({
-        ...issue,
-        path: ["attributes", ...issue.path]
-      });
-    });
-  }
 }).meta(GasIDIpfsSchemaMeta);
 var RecycledIDAttributeMethodologySchema = MethodologyAttributeSchema;
 var RecycledIDAttributeRecycledMassWeightSchema = createWeightAttributeSchema(
@@ -30217,7 +30317,7 @@ var RecycledIDAttributesSchema = zod.z.tuple([
   RecycledIDAttributeCertificateIssuanceDateSchema
 ]).meta({
   title: "RecycledID NFT Attribute Array",
-  description: "Schema for the fixed set of RecycledID NFT attributes, enforcing order and type for each trait"
+  description: "Schema for the fixed set of RecycledID NFT attributes, enforcing order and type for each trait.\n\nRequired attributes (10, in order): Methodology, Recycled Mass Weight (kg), Credit Amount, Credit Type, Source Waste Type, Source Weight (kg), Origin City, MassID, MassID Recycling Date, Certificate Issuance Date."
 });
 var RecycledIDSummarySchema = zod.z.strictObject({
   recycled_mass_kg: WeightKgSchema.meta({
@@ -30262,19 +30362,8 @@ var RecycledIDIpfsSchema = NftIpfsSchema.safeExtend({
       description: "RecycledID NFT schema type"
     })
   }),
+  attributes: RecycledIDAttributesSchema,
   data: RecycledIDDataSchema
-}).superRefine((value, ctx) => {
-  const attributesResult = RecycledIDAttributesSchema.safeParse(
-    value.attributes
-  );
-  if (!attributesResult.success) {
-    attributesResult.error.issues.forEach((issue) => {
-      ctx.addIssue({
-        ...issue,
-        path: ["attributes", ...issue.path]
-      });
-    });
-  }
 }).meta(RecycledIDIpfsSchemaMeta);
 var CreditPurchaseReceiptCreditAttributeSchema = NftAttributeSchema.safeExtend({
   trait_type: CreditTokenSymbolSchema,
@@ -30335,21 +30424,34 @@ var CreditPurchaseReceiptCollectionAttributeSchema = NftAttributeSchema.safeExte
   title: "Collection Attribute",
   description: "Attribute representing the amount of credits purchased from a collection"
 });
-var CreditPurchaseReceiptAttributesSchema = uniqueBy(
-  zod.z.union([
-    CreditPurchaseReceiptCreditAttributeSchema,
-    CreditPurchaseReceiptTotalCreditsAttributeSchema,
-    CreditPurchaseReceiptTotalUsdcAttributeSchema,
-    CreditPurchaseReceiptPurchaseDateAttributeSchema,
-    CreditPurchaseReceiptCertificatesAttributeSchema,
-    CreditPurchaseReceiptReceiverAttributeSchema,
-    CreditPurchaseReceiptCollectionAttributeSchema
-  ]),
-  (attribute) => attribute.trait_type,
-  "Attribute trait_type values must be unique"
-).min(5).meta({
+var REQUIRED_CREDIT_PURCHASE_RECEIPT_ATTRIBUTES = [
+  CreditPurchaseReceiptTotalCreditsAttributeSchema,
+  CreditPurchaseReceiptTotalUsdcAttributeSchema,
+  CreditPurchaseReceiptPurchaseDateAttributeSchema,
+  CreditPurchaseReceiptCertificatesAttributeSchema
+];
+var CONDITIONAL_CREDIT_PURCHASE_RECEIPT_ATTRIBUTES = [
+  CreditPurchaseReceiptReceiverAttributeSchema
+];
+var DYNAMIC_CREDIT_PURCHASE_RECEIPT_ATTRIBUTES = [
+  CreditPurchaseReceiptCreditAttributeSchema,
+  CreditPurchaseReceiptCollectionAttributeSchema
+];
+var CreditPurchaseReceiptAttributesSchema = createOrderedAttributesSchema({
+  required: REQUIRED_CREDIT_PURCHASE_RECEIPT_ATTRIBUTES,
+  optional: [
+    ...CONDITIONAL_CREDIT_PURCHASE_RECEIPT_ATTRIBUTES,
+    ...DYNAMIC_CREDIT_PURCHASE_RECEIPT_ATTRIBUTES
+  ],
   title: "Credit Purchase Receipt NFT Attribute Array",
-  description: "Attributes for credit purchase receipts including per-credit breakdowns, totals, receiver, purchase date, and per-collection amounts. Attributes must have unique trait types."
+  description: "Attributes for credit purchase receipts including per-credit breakdowns, totals, receiver, purchase date, and per-collection amounts. Fixed required attributes: Total Credits Purchased, Total USDC Amount, Purchase Date, Certificates Purchased. Conditional attributes: Receiver (required when receiver.identity.name is provided). Dynamic attributes: Credit attributes (one per credit symbol in data.credits), Collection attributes (one per collection name in data.collections).",
+  uniqueBySelector: (attribute) => attribute.trait_type,
+  requiredTraitTypes: [
+    "Total Credits Purchased",
+    "Total USDC Amount",
+    "Purchase Date",
+    "Certificates Purchased"
+  ]
 });
 var CreditPurchaseReceiptIdentitySchema = ReceiptIdentitySchema;
 var CreditPurchaseReceiptReceiverSchema = zod.z.strictObject({
@@ -30860,21 +30962,34 @@ var CreditRetirementReceiptCollectionAttributeSchema = NftAttributeSchema.safeEx
   title: "Collection Attribute",
   description: "Attribute representing the amount of credits retired from a collection"
 });
-var CreditRetirementReceiptAttributesSchema = uniqueBy(
-  zod.z.union([
-    CreditRetirementReceiptCreditAttributeSchema,
-    CreditRetirementReceiptTotalCreditsAttributeSchema,
-    CreditRetirementReceiptBeneficiaryAttributeSchema,
-    CreditRetirementReceiptCreditHolderAttributeSchema,
-    CreditRetirementReceiptRetirementDateAttributeSchema,
-    CreditRetirementReceiptCertificatesAttributeSchema,
-    CreditRetirementReceiptCollectionAttributeSchema
-  ]),
-  (attribute) => attribute.trait_type,
-  "Attribute trait_type values must be unique"
-).min(6).meta({
+var REQUIRED_CREDIT_RETIREMENT_RECEIPT_ATTRIBUTES = [
+  CreditRetirementReceiptTotalCreditsAttributeSchema,
+  CreditRetirementReceiptBeneficiaryAttributeSchema,
+  CreditRetirementReceiptRetirementDateAttributeSchema,
+  CreditRetirementReceiptCertificatesAttributeSchema
+];
+var CONDITIONAL_CREDIT_RETIREMENT_RECEIPT_ATTRIBUTES = [
+  CreditRetirementReceiptCreditHolderAttributeSchema
+];
+var DYNAMIC_CREDIT_RETIREMENT_RECEIPT_ATTRIBUTES = [
+  CreditRetirementReceiptCreditAttributeSchema,
+  CreditRetirementReceiptCollectionAttributeSchema
+];
+var CreditRetirementReceiptAttributesSchema = createOrderedAttributesSchema({
+  required: REQUIRED_CREDIT_RETIREMENT_RECEIPT_ATTRIBUTES,
+  optional: [
+    ...CONDITIONAL_CREDIT_RETIREMENT_RECEIPT_ATTRIBUTES,
+    ...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 per-collection amounts. Attributes must have unique trait types."
+  description: "Attributes for credit retirement receipts including per-credit breakdowns, totals, beneficiary, credit holder, retirement date, certificate count, and per-collection amounts. Fixed required attributes: Total Credits Retired, Beneficiary, Retirement Date, Certificates Retired. Conditional attributes: Credit Holder (required when credit_holder.identity.name is provided). Dynamic attributes: Credit attributes (one per credit symbol in data.credits), Collection attributes (one per collection name in data.collections).",
+  uniqueBySelector: (attribute) => attribute.trait_type,
+  requiredTraitTypes: [
+    "Total Credits Retired",
+    "Beneficiary",
+    "Retirement Date",
+    "Certificates Retired"
+  ]
 });
 var CreditRetirementReceiptIdentitySchema = ReceiptIdentitySchema;
 var CreditRetirementReceiptBeneficiarySchema = zod.z.strictObject({
@@ -31473,7 +31588,7 @@ var MassIDAuditSchema = BaseIpfsSchema.safeExtend({
   }),
   data: MassIDAuditDataSchema
 }).meta(MassIDAuditSchemaMeta);
-/* v8 ignore next -- @preserve */
+/* v8 ignore file -- @preserve */
 
 exports.ALLOWED_BLOCKCHAIN_NETWORKS = ALLOWED_BLOCKCHAIN_NETWORKS;
 exports.AuditReferenceSchema = AuditReferenceSchema;
@@ -31607,6 +31722,7 @@ exports.canonicalizeForHash = canonicalizeForHash;
 exports.createAttributeMap = createAttributeMap;
 exports.createDateAttributeSchema = createDateAttributeSchema;
 exports.createNumericAttributeSchema = createNumericAttributeSchema;
+exports.createOrderedAttributesSchema = createOrderedAttributesSchema;
 exports.createReceiptCertificateSchema = createReceiptCertificateSchema;
 exports.createReceiptCollectionSchema = createReceiptCollectionSchema;
 exports.createReceiptCreditSchema = createReceiptCreditSchema;