@carrot-foundation/schemas 0.1.40 → 0.1.41

package/dist/index.cjs

@@ -5,14 +5,12 @@ require('fs');
 require('path');
 
 // src/mass-id/mass-id.attributes.ts
-var UuidSchema = zod.z.uuidv4("Must be a valid UUID v4 string").meta({
-  title: "UUID",
+var nativeDateParse = Date.parse.bind(Date);
+var ISO_TIMESTAMP_REGEX = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d{1,3})?(?:Z|[+-]\d{2}:\d{2})$/;
+var UuidSchema = zod.z.uuidv4().meta({
+  title: "UUID V4",
   description: "A universally unique identifier version 4",
-  examples: [
-    "ad44dd3f-f176-4b98-bf78-5ee6e77d0530",
-    "6f520d88-864d-432d-bf9f-5c3166c4818f",
-    "f77afa89-1c58-40fd-9bf5-8a86703a8af4"
-  ]
+  examples: ["ad44dd3f-f176-4b98-bf78-5ee6e77d0530"]
 });
 var EthereumAddressSchema = zod.z.string().regex(
   /^0x[a-f0-9]{40}$/,
@@ -20,25 +18,33 @@ var EthereumAddressSchema = zod.z.string().regex(
 ).meta({
   title: "Ethereum Address",
   description: "A valid Ethereum address in hexadecimal format",
-  examples: [
-    "0x1234567890abcdef1234567890abcdef12345678",
-    "0xabcdef1234567890abcdef1234567890abcdef12"
-  ]
-});
-var IsoTimestampSchema = zod.z.iso.datetime().meta({
+  examples: ["0x1234567890abcdef1234567890abcdef12345678"]
+});
+var IsoTimestampSchema = zod.z.string().regex(
+  ISO_TIMESTAMP_REGEX,
+  "Must be a valid ISO 8601 timestamp with timezone information"
+).superRefine((value, ctx) => {
+  const parsed = nativeDateParse(value);
+  if (Number.isNaN(parsed)) {
+    ctx.addIssue({
+      code: "custom",
+      message: "Must be a valid ISO 8601 timestamp with timezone information"
+    });
+  }
+}).meta({
   title: "ISO Timestamp",
   description: "ISO 8601 formatted timestamp with timezone information",
-  examples: ["2024-12-05T11:02:47.000Z", "2025-02-22T10:35:12.000Z"]
+  examples: ["2024-12-05T11:02:47.000Z"]
 });
 var IsoDateSchema = zod.z.iso.date("Must be a valid ISO 8601 date (YYYY-MM-DD)").meta({
   title: "ISO Date",
   description: "ISO 8601 formatted date in YYYY-MM-DD format",
-  examples: ["2024-12-05", "2025-02-22", "2024-02-10"]
+  examples: ["2024-12-05"]
 });
 var UnixTimestampSchema = zod.z.number().int().positive().meta({
   title: "Unix Timestamp",
   description: "Unix timestamp in milliseconds since epoch (January 1, 1970 00:00:00 UTC)",
-  examples: [17040672e5, 17356896e5, 1762371245149]
+  examples: [17040672e5]
 });
 var IsoCountryCodeSchema = zod.z.string().regex(/^[A-Z]{2}$/, "Must be a valid ISO 3166-1 alpha-2 country code").meta({
   title: "ISO Country Code",
@@ -55,15 +61,20 @@ var IsoAdministrativeDivisionCodeSchema = zod.z.string().regex(
 });
 var LatitudeSchema = zod.z.number().min(-90).max(90).multipleOf(1e-3).meta({
   title: "Latitude",
-  description: "Geographic latitude coordinate in decimal degrees with maximum 3 decimal places precision (~100m-1km accuracy for city-level, non-PII compliance)",
+  description: "Geographic latitude coordinate in decimal degrees with maximum 3 decimal places precision (~100m-1km accuracy for city-level)",
   examples: [-0.02, -20.38, 40.713]
 });
 var LongitudeSchema = zod.z.number().min(-180).max(180).multipleOf(1e-3).meta({
   title: "Longitude",
-  description: "Geographic longitude coordinate in decimal degrees with maximum 3 decimal places precision (~100m-1km accuracy for city-level, non-PII compliance)",
+  description: "Geographic longitude coordinate in decimal degrees with maximum 3 decimal places precision (~100m-1km accuracy for city-level)",
   examples: [-51.06, -40.34, -74.006]
 });
-var WeightKgSchema = zod.z.number().min(0).meta({
+var NonNegativeFloatSchema = zod.z.number().min(0).meta({
+  title: "Non-Negative Float",
+  description: "Floating-point number that is zero or positive",
+  examples: [0, 45.2, 72.5]
+});
+var WeightKgSchema = NonNegativeFloatSchema.meta({
   title: "Weight (kg)",
   description: "Weight measurement in kilograms",
   examples: [3e3, 1500, 500]
@@ -127,7 +138,7 @@ var WasteTypeSchema = NonEmptyStringSchema.max(100).meta({
 var WasteSubtypeSchema = NonEmptyStringSchema.max(100).meta({
   title: "Waste Subtype",
   description: "Specific subcategory of waste within a waste type",
-  examples: ["Food, Food Waste and Beverages", "PET Bottles", "Aluminum Cans"]
+  examples: ["Food, Food Waste and Beverages", "Domestic Sludge"]
 });
 var ParticipantRoleSchema = NonEmptyStringSchema.max(100).meta({
   title: "Participant Role",
@@ -139,14 +150,14 @@ var ParticipantNameSchema = NonEmptyStringSchema.max(100).meta({
   description: "Name of a participant in the waste management system",
   examples: ["Enlatados Produ\xE7\xE3o", "Eco Reciclagem", "Green Tech Corp"]
 });
-var BlockchainChainIdSchema = zod.z.number().int().min(1).meta({
+var BlockchainChainIdSchema = zod.z.union([zod.z.literal(137), zod.z.literal(80002)]).meta({
   title: "Chain ID",
-  description: "Blockchain network identifier",
+  description: "Supported Polygon chain identifiers",
   examples: [137, 80002]
 });
-var BlockchainNetworkNameSchema = NonEmptyStringSchema.max(100).meta({
+var BlockchainNetworkNameSchema = zod.z.enum(["Polygon", "Amoy"]).meta({
   title: "Blockchain Network Name",
-  description: "Name of the blockchain network",
+  description: "Supported Polygon network names",
   examples: ["Polygon", "Amoy"]
 });
 var SmartContractAddressSchema = EthereumAddressSchema.meta({
@@ -161,7 +172,7 @@ var SmartContractSchema = zod.z.strictObject({
   title: "Smart Contract",
   description: "Smart contract details for on-chain references"
 });
-var PercentageSchema = zod.z.number().min(0).max(100).meta({
+var PercentageSchema = NonNegativeFloatSchema.max(100).meta({
   title: "Percentage",
   description: "Percentage value between 0 and 100",
   examples: [50, 75.5, 100]
@@ -176,11 +187,6 @@ var PositiveIntegerSchema = zod.z.number().int().min(1).meta({
   description: "Integer value that is greater than zero",
   examples: [1, 123, 456]
 });
-var NonNegativeFloatSchema = zod.z.number().min(0).meta({
-  title: "Non-Negative Float",
-  description: "Floating-point number that is zero or positive",
-  examples: [0, 45.2, 72.5]
-});
 var CreditTypeSchema = NonEmptyStringSchema.max(100).meta({
   title: "Credit Type",
   description: "Type of credit issued",
@@ -195,7 +201,7 @@ var HoursSchema = zod.z.number().min(0).multipleOf(0.1).meta({
   description: "Time duration in hours with 0.1 hour precision",
   examples: [72.5, 24, 168.5]
 });
-var MinutesSchema = zod.z.number().int().min(0).meta({
+var MinutesSchema = NonNegativeIntegerSchema.meta({
   title: "Minutes",
   description: "Time duration in minutes",
   examples: [4350, 1440, 10110]
@@ -225,7 +231,7 @@ var TokenIdSchema = NonEmptyStringSchema.regex(
 ).meta({
   title: "Token ID",
   description: "Numeric identifier for blockchain tokens as string",
-  examples: ["123", "456789", "1000000"]
+  examples: ["456789", "1000000"]
 });
 var HexColorSchema = NonEmptyStringSchema.regex(
   /^#[0-9A-F]{6}$/,
@@ -233,41 +239,28 @@ var HexColorSchema = NonEmptyStringSchema.regex(
 ).meta({
   title: "Hex Color",
   description: "Hexadecimal color code with hash prefix",
-  examples: ["#2D5A27", "#FF5733", "#1E90FF"]
+  examples: ["#2D5A27", "#FF5733"]
 });
 var Sha256HashSchema = zod.z.hash("sha256", {
-  error: "Must be a SHA256 hash as 32-byte hex string"
+  error: "Must be a SHA-256 hash as 32-byte hex string"
 }).meta({
   format: void 0,
-  title: "SHA256 Hash",
+  title: "SHA-256 Hash",
   description: "SHA-256 cryptographic hash as hexadecimal string",
   examples: [
-    "87f633634cc4b02f628685651f0a29b7bfa22a0bd841f725c6772dd00a58d489",
-    "6e83b8e6373847bbdc056549bedda38dc88854ce41ba4fca11e0fc6ce3e07ef6"
-  ]
-});
-var Keccak256HashSchema = Sha256HashSchema.meta({
-  title: "Keccak256 Hash",
-  description: "Keccak256 cryptographic hash as hexadecimal string",
-  examples: [
-    "ac08c3cf2e175e55961d6affdb38bc24591b84ceef7f3707c69ae3d52c148b2f",
-    "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2"
+    "87f633634cc4b02f628685651f0a29b7bfa22a0bd841f725c6772dd00a58d489"
   ]
 });
 var ExternalIdSchema = UuidSchema.meta({
   title: "External ID",
-  description: "UUID identifier for external system references",
-  examples: [
-    "ad44dd3f-f176-4b98-bf78-5ee6e77d0530",
-    "b2c4e6f8-a1b3-4c5d-9e8f-123456789abc"
-  ]
+  description: "UUID identifier for external system references"
 });
-var ExternalUrlSchema = zod.z.url("Must be a valid URL").meta({
+var ExternalUrlSchema = zod.z.url().meta({
   title: "External URL",
-  description: "Valid URL pointing to external resources",
+  description: "URL pointing to external resources",
   examples: [
-    "https://explore.carrot.eco/document/ad44dd3f-f176-4b98-bf78-5ee6e77d0530",
-    "https://carrot.eco/whitepaper.pdf"
+    "https://explore.carrot.eco/",
+    "https://https://whitepaper.carrot.eco/"
   ]
 });
 var RecordSchemaTypeSchema = zod.z.enum([
@@ -298,21 +291,6 @@ var CreditTokenSymbolSchema = TokenSymbolSchema.meta({
   description: "Symbol of the credit token (e.g., C-CARB, C-BIOW)",
   examples: ["C-CARB", "C-BIOW"]
 });
-var RecordRelationshipTypeSchema = zod.z.enum([
-  "collection",
-  "credit",
-  "gas-id",
-  "mass-id",
-  "mass-id-audit",
-  "methodology",
-  "credit-purchase-receipt",
-  "credit-retirement-receipt",
-  "recycled-id"
-]).meta({
-  title: "Relationship Type",
-  description: "Type of relationship between different entities in the system",
-  examples: ["mass-id", "collection", "credit-purchase-receipt"]
-});
 function uniqueArrayItems(schema, errorMessage = "Array items must be unique") {
   return zod.z.array(schema).refine((items) => new Set(items).size === items.length, {
     message: errorMessage
@@ -351,10 +329,10 @@ var ParticipantSchema = zod.z.strictObject({
   title: "Participant",
   description: "A participant in the waste management supply chain"
 });
-var PrecisionLevelSchema = zod.z.enum(["exact", "neighborhood", "city", "region", "country"]).meta({
+var PrecisionLevelSchema = zod.z.enum(["city", "region", "country"]).meta({
   title: "Coordinate Precision Level",
   description: "Level of coordinate precision",
-  examples: ["city", "exact", "neighborhood"]
+  examples: ["city"]
 });
 var CoordinatesSchema = zod.z.strictObject({
   latitude: LatitudeSchema,
@@ -596,70 +574,20 @@ var ParticipantRewardsSchema = zod.z.strictObject({
   title: "Participant Rewards",
   description: "Rewards distribution to participants"
 });
-var SchemaHashSchema = zod.z.union([
-  Keccak256HashSchema,
-  zod.z.string().regex(
-    /^0x[a-fA-F0-9]{64}$/,
-    "Must be a Keccak256 hash as 0x-prefixed hex string"
-  )
-]).meta({
+var SchemaHashSchema = Sha256HashSchema.meta({
   title: "Schema Hash",
-  description: "Keccak256 hash of the JSON Schema this record was validated against",
-  examples: [
-    "ac08c3cf2e175e55961d6affdb38bc24591b84ceef7f3707c69ae3d52c148b2f",
-    "0xac08c3cf2e175e55961d6affdb38bc24591b84ceef7f3707c69ae3d52c148b2f"
-  ]
+  description: "SHA-256 hash of the JSON Schema this record was validated against"
 });
 var SchemaInfoSchema = zod.z.strictObject({
   hash: SchemaHashSchema,
-  type: RecordSchemaTypeSchema.meta({
-    title: "Schema Type",
-    description: "Type/category of this schema"
-  }),
+  type: RecordSchemaTypeSchema,
   version: SemanticVersionSchema.meta({
     title: "Schema Version",
     description: "Version of the schema, using semantic versioning"
   })
 }).meta({
-  title: "Schema Information"
-});
-var RecordCreatorSchema = zod.z.strictObject({
-  name: zod.z.string().meta({
-    title: "Creator Name",
-    description: "Company or individual name that created this record",
-    examples: ["Carrot Foundation"]
-  }),
-  id: UuidSchema.meta({
-    title: "Creator ID",
-    description: "Unique identifier for the creator"
-  })
-}).meta({
-  title: "Creator",
-  description: "Entity that created this record"
-});
-var RecordRelationshipSchema = zod.z.strictObject({
-  target_uri: IpfsUriSchema.meta({
-    title: "Target IPFS URI",
-    description: "Target IPFS URI of the referenced record"
-  }),
-  type: RecordRelationshipTypeSchema.meta({
-    title: "Relationship Type",
-    description: "Type of relationship to the referenced record"
-  }),
-  description: zod.z.string().optional().meta({
-    title: "Relationship Description",
-    description: "Human-readable description of the relationship",
-    examples: [
-      "This record supersedes the previous version",
-      "Related carbon credit batch",
-      "Source document for this verification",
-      "Child record derived from this parent",
-      "Updated version of original record"
-    ]
-  })
-}).meta({
-  title: "Relationship",
-  description: "Relationship to another IPFS record"
+  title: "Schema Information",
+  description: "Information about the schema used to validate this record"
 });
 var RecordEnvironmentSchema = zod.z.strictObject({
   blockchain_network: zod.z.enum(["mainnet", "testnet"]).meta({
@@ -675,8 +603,8 @@ var RecordEnvironmentSchema = zod.z.strictObject({
     description: "Name of the data set for this record"
   })
 }).meta({
-  title: "Environment",
-  description: "Environment information"
+  title: "Record Environment",
+  description: "Environment information for the record"
 });
 var BaseIpfsSchema = zod.z.strictObject({
   $schema: zod.z.url("Must be a valid URI").meta({
@@ -689,14 +617,8 @@ var BaseIpfsSchema = zod.z.strictObject({
     title: "Created At",
     description: "ISO 8601 creation timestamp for this record"
   }),
-  external_id: ExternalIdSchema.meta({
-    title: "External ID",
-    description: "Off-chain reference ID (UUID from Carrot backend)"
-  }),
-  external_url: ExternalUrlSchema.meta({
-    title: "External URL",
-    description: "External URL of the content"
-  }),
+  external_id: ExternalIdSchema,
+  external_url: ExternalUrlSchema,
   original_content_hash: Sha256HashSchema.meta({
     title: "Original Content Hash",
     description: "SHA-256 hash of the original JSON content including private data before schema validation"
@@ -705,11 +627,6 @@ var BaseIpfsSchema = zod.z.strictObject({
     title: "Content Hash",
     description: "SHA-256 hash of RFC 8785 canonicalized JSON after schema validation"
   }),
-  creator: RecordCreatorSchema.optional(),
-  relationships: zod.z.array(RecordRelationshipSchema).optional().meta({
-    title: "Relationships",
-    description: "References to other IPFS records this record relates to"
-  }),
   environment: RecordEnvironmentSchema.optional(),
   data: zod.z.record(zod.z.string(), zod.z.unknown()).optional().meta({
     title: "Custom Data",
@@ -719,6 +636,11 @@ var BaseIpfsSchema = zod.z.strictObject({
   title: "Base IPFS Record",
   description: "Base fields for all Carrot IPFS records, providing common structure for any JSON content stored in IPFS"
 });
+var BLOCKCHAIN_NETWORK_CONFIG = {
+  mainnet: { chain_id: 137, network_name: "Polygon" },
+  testnet: { chain_id: 80002, network_name: "Amoy" }
+};
+var ALLOWED_BLOCKCHAIN_NETWORKS = Object.values(BLOCKCHAIN_NETWORK_CONFIG);
 var NftSchemaTypeSchema = RecordSchemaTypeSchema.extract([
   "MassID",
   "RecycledID",
@@ -737,14 +659,27 @@ var BlockchainReferenceSchema = zod.z.strictObject({
     title: "Chain ID",
     description: "Blockchain chain ID"
   }),
-  network_name: zod.z.string().min(5).max(100).meta({
-    title: "Network Name",
-    description: "Name of the blockchain network"
-  }),
+  network_name: BlockchainNetworkNameSchema,
   token_id: TokenIdSchema.meta({
     title: "Token ID",
     description: "NFT token ID"
   })
+}).superRefine((value, ctx) => {
+  const matchedNetwork = ALLOWED_BLOCKCHAIN_NETWORKS.find(
+    (network) => network.chain_id === value.chain_id && network.network_name === value.network_name
+  );
+  if (!matchedNetwork) {
+    ctx.addIssue({
+      code: "custom",
+      message: "chain_id and network_name must match a supported network: 137/Polygon (mainnet) or 80002/Amoy (testnet)",
+      path: ["chain_id"]
+    });
+    ctx.addIssue({
+      code: "custom",
+      message: "chain_id and network_name must match a supported network: 137/Polygon (mainnet) or 80002/Amoy (testnet)",
+      path: ["network_name"]
+    });
+  }
 }).meta({
   title: "Blockchain Information",
   description: "Blockchain-specific information for the NFT"
@@ -889,6 +824,26 @@ var NftIpfsSchema = BaseIpfsSchema.safeExtend({
       ]
     ]
   })
+}).superRefine((value, ctx) => {
+  const environmentNetwork = value.environment?.blockchain_network;
+  if (!environmentNetwork) {
+    return;
+  }
+  const config = BLOCKCHAIN_NETWORK_CONFIG[environmentNetwork];
+  if (value.blockchain.chain_id !== config.chain_id) {
+    ctx.addIssue({
+      code: "custom",
+      message: `blockchain.chain_id must be ${config.chain_id} when environment.blockchain_network is ${environmentNetwork}`,
+      path: ["blockchain", "chain_id"]
+    });
+  }
+  if (value.blockchain.network_name !== config.network_name) {
+    ctx.addIssue({
+      code: "custom",
+      message: `blockchain.network_name must be ${config.network_name} when environment.blockchain_network is ${environmentNetwork}`,
+      path: ["blockchain", "network_name"]
+    });
+  }
 }).meta({
   title: "NFT IPFS Record",
   description: "NFT-specific fields for Carrot IPFS records"
@@ -901,7 +856,7 @@ function buildSchemaUrl(schemaPath) {
   return `${getSchemaBaseUrl()}/${cleanPath}`;
 }
 function getSchemaVersionOrDefault() {
-  return "0.1.40";
+  return "0.1.41";
 }
 var MethodologyAttributeSchema = NftAttributeSchema.safeExtend({
   trait_type: zod.z.literal("Methodology"),
@@ -1019,10 +974,6 @@ var AuditRuleDefinitionSchema = zod.z.strictObject({
       "https://github.com/carrot-foundation/methodologies/blob/main/bold-carbon/rules/waste-mass-unique.js"
     ]
   }),
-  mandatory: zod.z.boolean().meta({
-    title: "Mandatory",
-    description: "Whether this rule is mandatory for methodology compliance"
-  }),
   execution_order: PositiveIntegerSchema.meta({
     title: "Rule Execution Order",
     description: "Sequential order in which this rule must be executed"
@@ -3560,7 +3511,6 @@ exports.IsoAdministrativeDivisionCodeSchema = IsoAdministrativeDivisionCodeSchem
 exports.IsoCountryCodeSchema = IsoCountryCodeSchema;
 exports.IsoDateSchema = IsoDateSchema;
 exports.IsoTimestampSchema = IsoTimestampSchema;
-exports.Keccak256HashSchema = Keccak256HashSchema;
 exports.LatitudeSchema = LatitudeSchema;
 exports.LocationSchema = LocationSchema;
 exports.LongitudeSchema = LongitudeSchema;
@@ -3599,7 +3549,6 @@ exports.PercentageSchema = PercentageSchema;
 exports.PositiveIntegerSchema = PositiveIntegerSchema;
 exports.ReceiptIdentitySchema = ReceiptIdentitySchema;
 exports.RecordEnvironmentSchema = RecordEnvironmentSchema;
-exports.RecordRelationshipTypeSchema = RecordRelationshipTypeSchema;
 exports.RecordSchemaTypeSchema = RecordSchemaTypeSchema;
 exports.RecycledIDAttributesSchema = RecycledIDAttributesSchema;
 exports.RecycledIDDataSchema = RecycledIDDataSchema;