@carrot-foundation/schemas 0.1.21 → 0.1.22

package/dist/index.d.ts

@@ -3,7 +3,9 @@ import { z } from 'zod';
 declare const MassIDLocalClassificationSchema: z.ZodObject<{
     code: z.ZodString;
     description: z.ZodString;
-    system: z.ZodString;
+    system: z.ZodEnum<{
+        IBAMA: "IBAMA";
+    }>;
 }, z.core.$strict>;
 type MassIDLocalClassification = z.infer<typeof MassIDLocalClassificationSchema>;
 declare const MassIDMeasurementUnitSchema: z.ZodEnum<{
@@ -18,13 +20,15 @@ declare const ContaminationLevelSchema: z.ZodEnum<{
     High: "High";
 }>;
 type ContaminationLevel = z.infer<typeof ContaminationLevelSchema>;
-declare const MassIDWasteClassificationSchema: z.ZodObject<{
-    primary_type: z.ZodString;
+declare const MassIDWastePropertiesSchema: z.ZodObject<{
+    type: z.ZodString;
     subtype: z.ZodString;
     local_classification: z.ZodOptional<z.ZodObject<{
         code: z.ZodString;
         description: z.ZodString;
-        system: z.ZodString;
+        system: z.ZodEnum<{
+            IBAMA: "IBAMA";
+        }>;
     }, z.core.$strict>>;
     measurement_unit: z.ZodEnum<{
         kg: "kg";
@@ -38,7 +42,7 @@ declare const MassIDWasteClassificationSchema: z.ZodObject<{
         High: "High";
     }>>;
 }, z.core.$strict>;
-type MassIDWasteClassification = z.infer<typeof MassIDWasteClassificationSchema>;
+type MassIDWasteProperties = z.infer<typeof MassIDWastePropertiesSchema>;
 declare const EventAttributeFormatSchema: z.ZodEnum<{
     KILOGRAM: "KILOGRAM";
     DATE: "DATE";
@@ -49,7 +53,8 @@ declare const EventAttributeFormatSchema: z.ZodEnum<{
 type EventAttributeFormat = z.infer<typeof EventAttributeFormatSchema>;
 declare const EventAttributeSchema: z.ZodObject<{
     name: z.ZodString;
-    value: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>;
+    value: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
+    preserved_sensitivity: z.ZodOptional<z.ZodBoolean>;
     format: z.ZodOptional<z.ZodEnum<{
         KILOGRAM: "KILOGRAM";
         DATE: "DATE";
@@ -77,7 +82,8 @@ declare const MassIDChainOfCustodyEventSchema: z.ZodObject<{
     weight: z.ZodOptional<z.ZodNumber>;
     attributes: z.ZodOptional<z.ZodArray<z.ZodObject<{
         name: z.ZodString;
-        value: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>;
+        value: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
+        preserved_sensitivity: z.ZodOptional<z.ZodBoolean>;
         format: z.ZodOptional<z.ZodEnum<{
             KILOGRAM: "KILOGRAM";
             DATE: "DATE";
@@ -107,7 +113,8 @@ declare const MassIDChainOfCustodySchema: z.ZodObject<{
         weight: z.ZodOptional<z.ZodNumber>;
         attributes: z.ZodOptional<z.ZodArray<z.ZodObject<{
             name: z.ZodString;
-            value: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>;
+            value: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
+            preserved_sensitivity: z.ZodOptional<z.ZodBoolean>;
             format: z.ZodOptional<z.ZodEnum<{
                 KILOGRAM: "KILOGRAM";
                 DATE: "DATE";
@@ -151,13 +158,15 @@ declare const MassIDGeographicDataSchema: z.ZodObject<{
 }, z.core.$strict>;
 type MassIDGeographicData = z.infer<typeof MassIDGeographicDataSchema>;
 declare const MassIDDataSchema: z.ZodObject<{
-    waste_classification: z.ZodObject<{
-        primary_type: z.ZodString;
+    waste_properties: z.ZodObject<{
+        type: z.ZodString;
         subtype: z.ZodString;
         local_classification: z.ZodOptional<z.ZodObject<{
             code: z.ZodString;
             description: z.ZodString;
-            system: z.ZodString;
+            system: z.ZodEnum<{
+                IBAMA: "IBAMA";
+            }>;
         }, z.core.$strict>>;
         measurement_unit: z.ZodEnum<{
             kg: "kg";
@@ -191,15 +200,10 @@ declare const MassIDDataSchema: z.ZodObject<{
             }>;
         }, z.core.$strict>;
         facility_type: z.ZodOptional<z.ZodEnum<{
-            "Waste Generation": "Waste Generation";
             "Collection Point": "Collection Point";
-            "Transfer Station": "Transfer Station";
-            "Sorting Facility": "Sorting Facility";
-            "Composting Facility": "Composting Facility";
             "Recycling Facility": "Recycling Facility";
-            "Processing Facility": "Processing Facility";
-            "Disposal Facility": "Disposal Facility";
             "Administrative Office": "Administrative Office";
+            Other: "Other";
         }>>;
     }, z.core.$strict>>;
     participants: z.ZodArray<z.ZodObject<{
@@ -218,7 +222,8 @@ declare const MassIDDataSchema: z.ZodObject<{
             weight: z.ZodOptional<z.ZodNumber>;
             attributes: z.ZodOptional<z.ZodArray<z.ZodObject<{
                 name: z.ZodString;
-                value: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>;
+                value: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
+                preserved_sensitivity: z.ZodOptional<z.ZodBoolean>;
                 format: z.ZodOptional<z.ZodEnum<{
                     KILOGRAM: "KILOGRAM";
                     DATE: "DATE";
@@ -297,7 +302,7 @@ declare const AttributeIntegratorSchema: z.ZodObject<{
 type AttributeIntegrator = z.infer<typeof AttributeIntegratorSchema>;
 declare const AttributePickUpDateSchema: z.ZodObject<{
     trait_type: z.ZodLiteral<"Pick-up Date">;
-    value: z.ZodString;
+    value: z.ZodNumber;
     display_type: z.ZodLiteral<"date">;
 }, z.core.$strict>;
 type AttributePickUpDate = z.infer<typeof AttributePickUpDateSchema>;
@@ -334,7 +339,7 @@ declare const MassIDAttributesSchema: z.ZodTuple<[z.ZodObject<{
     value: z.ZodString;
 }, z.core.$strict>, z.ZodObject<{
     trait_type: z.ZodLiteral<"Pick-up Date">;
-    value: z.ZodString;
+    value: z.ZodNumber;
     display_type: z.ZodLiteral<"date">;
 }, z.core.$strict>, z.ZodObject<{
     trait_type: z.ZodLiteral<"Recycling Date">;
@@ -345,8 +350,8 @@ type MassIDAttributes = z.infer<typeof MassIDAttributesSchema>;
 declare const MassIDIpfsSchemaMeta: {
     readonly title: "MassID NFT IPFS Record";
     readonly description: "Complete MassID NFT IPFS record including fixed attributes and detailed waste tracking data";
-    readonly $id: "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/heads/main/schemas/ipfs/mass-id/mass-id.schema.json";
-    readonly version: "1.0.1";
+    readonly $id: string;
+    readonly version: string;
 };
 declare const MassIDIpfsSchema: z.ZodObject<{
     $schema: z.ZodURL;
@@ -437,7 +442,7 @@ declare const MassIDIpfsSchema: z.ZodObject<{
         value: z.ZodString;
     }, z.core.$strict>, z.ZodObject<{
         trait_type: z.ZodLiteral<"Pick-up Date">;
-        value: z.ZodString;
+        value: z.ZodNumber;
         display_type: z.ZodLiteral<"date">;
     }, z.core.$strict>, z.ZodObject<{
         trait_type: z.ZodLiteral<"Recycling Date">;
@@ -445,13 +450,15 @@ declare const MassIDIpfsSchema: z.ZodObject<{
         display_type: z.ZodLiteral<"date">;
     }, z.core.$strict>], null>;
     data: z.ZodObject<{
-        waste_classification: z.ZodObject<{
-            primary_type: z.ZodString;
+        waste_properties: z.ZodObject<{
+            type: z.ZodString;
             subtype: z.ZodString;
             local_classification: z.ZodOptional<z.ZodObject<{
                 code: z.ZodString;
                 description: z.ZodString;
-                system: z.ZodString;
+                system: z.ZodEnum<{
+                    IBAMA: "IBAMA";
+                }>;
             }, z.core.$strict>>;
             measurement_unit: z.ZodEnum<{
                 kg: "kg";
@@ -485,15 +492,10 @@ declare const MassIDIpfsSchema: z.ZodObject<{
                 }>;
             }, z.core.$strict>;
             facility_type: z.ZodOptional<z.ZodEnum<{
-                "Waste Generation": "Waste Generation";
                 "Collection Point": "Collection Point";
-                "Transfer Station": "Transfer Station";
-                "Sorting Facility": "Sorting Facility";
-                "Composting Facility": "Composting Facility";
                 "Recycling Facility": "Recycling Facility";
-                "Processing Facility": "Processing Facility";
-                "Disposal Facility": "Disposal Facility";
                 "Administrative Office": "Administrative Office";
+                Other: "Other";
             }>>;
         }, z.core.$strict>>;
         participants: z.ZodArray<z.ZodObject<{
@@ -512,7 +514,8 @@ declare const MassIDIpfsSchema: z.ZodObject<{
                 weight: z.ZodOptional<z.ZodNumber>;
                 attributes: z.ZodOptional<z.ZodArray<z.ZodObject<{
                     name: z.ZodString;
-                    value: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>;
+                    value: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
+                    preserved_sensitivity: z.ZodOptional<z.ZodBoolean>;
                     format: z.ZodOptional<z.ZodEnum<{
                         KILOGRAM: "KILOGRAM";
                         DATE: "DATE";
@@ -549,4 +552,4 @@ declare const MassIDIpfsSchema: z.ZodObject<{
 }, z.core.$strict>;
 type MassIDIpfs = z.infer<typeof MassIDIpfsSchema>;
 
-export { type AttributeIntegrator, type AttributeOriginCountry, type AttributeOriginDivision, type AttributeOriginMunicipality, type AttributePickUpDate, type AttributeRecycler, type AttributeRecyclingDate, type AttributeWasteSubtype, type AttributeWasteType, type AttributeWeight, type ContaminationLevel, type EventAttribute, type EventAttributeFormat, type EventDocumentation, type MassIDAttributes, type MassIDChainOfCustody, type MassIDChainOfCustodyEvent, type MassIDData, MassIDDataSchema, type MassIDGeographicData, type MassIDIpfs, MassIDIpfsSchema, MassIDIpfsSchemaMeta, type MassIDLocalClassification, type MassIDMeasurementUnit, type MassIDTransportRoute, type MassIDWasteClassification };
+export { type AttributeIntegrator, type AttributeOriginCountry, type AttributeOriginDivision, type AttributeOriginMunicipality, type AttributePickUpDate, type AttributeRecycler, type AttributeRecyclingDate, type AttributeWasteSubtype, type AttributeWasteType, type AttributeWeight, type ContaminationLevel, type EventAttribute, type EventAttributeFormat, type EventDocumentation, type MassIDAttributes, type MassIDChainOfCustody, type MassIDChainOfCustodyEvent, type MassIDData, MassIDDataSchema, type MassIDGeographicData, type MassIDIpfs, MassIDIpfsSchema, MassIDIpfsSchemaMeta, type MassIDLocalClassification, type MassIDMeasurementUnit, type MassIDTransportRoute, type MassIDWasteProperties };

package/dist/index.js

@@ -33,6 +33,11 @@ var IsoDateSchema = z.iso.date("Must be a valid ISO 8601 date (YYYY-MM-DD)").met
   description: "ISO 8601 formatted date in YYYY-MM-DD format",
   examples: ["2024-12-05", "2025-02-22", "2024-02-10"]
 });
+var UnixTimestampSchema = 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]
+});
 var IsoCountryCodeSchema = z.string().regex(/^[A-Z]{2}$/, "Must be a valid ISO 3166-1 alpha-2 country code").meta({
   title: "ISO Country Code",
   description: "Two-letter country code following ISO 3166-1 alpha-2 standard",
@@ -46,14 +51,14 @@ var IsoAdministrativeDivisionCodeSchema = z.string().regex(
   description: "Administrative division code following ISO 3166-2 standard",
   examples: ["BR-AP", "BR-ES", "US-CA"]
 });
-var LatitudeSchema = z.number().min(-90).max(90).meta({
+var LatitudeSchema = z.number().min(-90).max(90).multipleOf(1e-3).meta({
   title: "Latitude",
-  description: "Geographic latitude coordinate in decimal degrees",
-  examples: [-0.02, -20.38, 40.7128]
+  description: "Geographic latitude coordinate in decimal degrees with maximum 3 decimal places precision (~100m-1km accuracy for city-level, non-PII compliance)",
+  examples: [-0.02, -20.38, 40.713]
 });
-var LongitudeSchema = z.number().min(-180).max(180).meta({
+var LongitudeSchema = z.number().min(-180).max(180).multipleOf(1e-3).meta({
   title: "Longitude",
-  description: "Geographic longitude coordinate in decimal degrees",
+  description: "Geographic longitude coordinate in decimal degrees with maximum 3 decimal places precision (~100m-1km accuracy for city-level, non-PII compliance)",
   examples: [-51.06, -40.34, -74.006]
 });
 var WeightKgSchema = z.number().min(0).meta({
@@ -95,19 +100,18 @@ var ParticipantNameSchema = NonEmptyStringSchema.max(100).meta({
   examples: ["Enlatados Produ\xE7\xE3o", "Eco Reciclagem", "Green Tech Corp"]
 });
 var FacilityTypeSchema = z.enum([
-  "Waste Generation",
   "Collection Point",
-  "Transfer Station",
-  "Sorting Facility",
-  "Composting Facility",
   "Recycling Facility",
-  "Processing Facility",
-  "Disposal Facility",
-  "Administrative Office"
+  "Administrative Office",
+  "Other"
 ]).meta({
   title: "Facility Type",
-  description: "Type of facility in the waste management infrastructure",
-  examples: ["Waste Generation", "Recycling Facility", "Collection Point"]
+  description: "Type of facility in the waste management chain",
+  examples: [
+    "Collection Point",
+    "Recycling Facility",
+    "Administrative Office"
+  ]
 });
 var BlockchainChainIdSchema = z.number().int().min(1).meta({
   title: "Chain ID",
@@ -361,15 +365,10 @@ var MassIDLocalClassificationSchema = z.strictObject({
       "Municipal solid waste - organic fraction"
     ]
   }),
-  system: NonEmptyStringSchema.max(50).meta({
+  system: z.enum(["IBAMA"]).meta({
     title: "Classification System",
-    description: 'Classification system name (e.g., "Ibama Waste Code", "European Waste Catalogue", "US EPA Codes")',
-    examples: [
-      "European Waste Catalogue",
-      "US EPA Codes",
-      "Ibama Waste Code",
-      "Brazilian ABNT Classification"
-    ]
+    description: "Classification system name - currently supports IBAMA (Instituto Brasileiro do Meio Ambiente e dos Recursos Naturais Renov\xE1veis)",
+    examples: ["IBAMA"]
   })
 }).meta({
   title: "Local Classification",
@@ -385,10 +384,10 @@ var ContaminationLevelSchema = z.enum(["None", "Low", "Medium", "High"]).meta({
   description: "Level of contamination in the waste batch",
   examples: ["Low", "Medium", "None"]
 });
-var MassIDWasteClassificationSchema = z.strictObject({
-  primary_type: WasteTypeSchema.meta({
-    title: "Primary Waste Type",
-    description: "Primary waste material category"
+var MassIDWastePropertiesSchema = z.strictObject({
+  type: WasteTypeSchema.meta({
+    title: "Waste Type",
+    description: "Waste material category"
   }),
   subtype: WasteSubtypeSchema.meta({
     title: "Waste Subtype",
@@ -402,8 +401,8 @@ var MassIDWasteClassificationSchema = z.strictObject({
   }),
   contamination_level: ContaminationLevelSchema.optional()
 }).meta({
-  title: "Waste Classification",
-  description: "Standardized waste material classification and regulatory information"
+  title: "Waste Properties",
+  description: "Standardized waste material properties and regulatory information"
 });
 var EventAttributeFormatSchema = z.enum(["KILOGRAM", "DATE", "CURRENCY", "PERCENTAGE", "COORDINATE"]).meta({
   title: "Event Attribute Format",
@@ -425,7 +424,7 @@ var EventAttributeSchema = z.strictObject({
       "processing_cost"
     ]
   }),
-  value: z.union([z.string(), z.number(), z.boolean()]).meta({
+  value: z.union([z.string(), z.number(), z.boolean()]).optional().meta({
     title: "Attribute Value",
     description: "Event attribute value",
     examples: [
@@ -439,6 +438,10 @@ var EventAttributeSchema = z.strictObject({
       "OP-456"
     ]
   }),
+  preserved_sensitivity: z.boolean().optional().meta({
+    title: "Preserved Sensitivity",
+    description: "Indicates if the attribute contains sensitive information that was preserved"
+  }),
   format: EventAttributeFormatSchema.optional()
 }).meta({
   title: "Event Attribute",
@@ -629,7 +632,7 @@ var MassIDGeographicDataSchema = z.strictObject({
   description: "Geographic information about waste origin and processing locations"
 });
 var MassIDDataSchema = z.strictObject({
-  waste_classification: MassIDWasteClassificationSchema,
+  waste_properties: MassIDWastePropertiesSchema,
   locations: uniqueBy(
     LocationSchema,
     (loc) => loc.id,
@@ -962,6 +965,18 @@ var NftIpfsSchema = BaseIpfsSchema.safeExtend({
   description: "NFT-specific fields for Carrot IPFS records"
 });
 
+// src/shared/schema-version.ts
+function getSchemaBaseUrl() {
+  return `https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/${getSchemaVersionOrDefault()}/schemas/ipfs`;
+}
+function buildSchemaUrl(schemaPath) {
+  const cleanPath = schemaPath.startsWith("/") ? schemaPath.slice(1) : schemaPath;
+  return `${getSchemaBaseUrl()}/${cleanPath}`;
+}
+function getSchemaVersionOrDefault() {
+  return "0.0.0-dev";
+}
+
 // src/mass-id/mass-id.schema.ts
 var AttributeWasteTypeSchema = z.strictObject({
   trait_type: z.literal("Waste Type"),
@@ -1037,14 +1052,14 @@ var AttributeIntegratorSchema = z.strictObject({
 });
 var AttributePickUpDateSchema = z.strictObject({
   trait_type: z.literal("Pick-up Date"),
-  value: z.string().regex(/^\d{4}-\d{2}-\d{2}$/, "Must be a valid date in YYYY-MM-DD format").meta({
+  value: UnixTimestampSchema.meta({
     title: "Pick-up Date Value",
-    description: "Date when the waste was picked up from the source"
+    description: "Unix timestamp in milliseconds when the waste was picked up from the source"
   }),
   display_type: z.literal("date")
 }).meta({
   title: "Pick-up Date Attribute",
-  description: "Pick-up date attribute"
+  description: "Pick-up date attribute with Unix timestamp"
 });
 var AttributeRecyclingDateSchema = z.strictObject({
   trait_type: z.literal("Recycling Date"),
@@ -1075,8 +1090,8 @@ var MassIDAttributesSchema = z.tuple([
 var MassIDIpfsSchemaMeta = {
   title: "MassID NFT IPFS Record",
   description: "Complete MassID NFT IPFS record including fixed attributes and detailed waste tracking data",
-  $id: "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/heads/main/schemas/ipfs/mass-id/mass-id.schema.json",
-  version: "1.0.1"
+  $id: buildSchemaUrl("mass-id/mass-id.schema.json"),
+  version: getSchemaVersionOrDefault()
 };
 var MassIDIpfsSchema = NftIpfsSchema.safeExtend({
   schema: NftIpfsSchema.shape.schema.safeExtend({