@carrot-foundation/schemas 0.1.47 → 0.1.48

package/dist/index.cjs

@@ -66,7 +66,7 @@ var CreditAmountSchema = NonNegativeFloatSchema.meta({
   title: "Credit Amount",
   description: "Amount of credits issued"
 });
-var IsoTimestampSchema = zod.z.string().datetime({
+var IsoDateTimeSchema = zod.z.iso.datetime({
   message: "Must be a valid ISO 8601 timestamp with timezone information",
   offset: true
 }).meta({
@@ -28325,7 +28325,7 @@ var MethodologyNameSchema = zod.z.enum([
   "AMS-III.F. | BOLD Recycling Credit"
 ]).meta({
   title: "Methodology Name",
-  description: "Name of the methodology used for certification",
+  description: "Full official name of the methodology",
   examples: [
     "AMS-III.F. | BOLD Carbon (CH\u2084) - SSC",
     "AMS-III.F. | BOLD Recycling Credit"
@@ -28333,7 +28333,7 @@ var MethodologyNameSchema = zod.z.enum([
 });
 var MethodologyShortNameSchema = zod.z.enum(["BOLD Carbon (CH\u2084)", "BOLD Recycling"]).meta({
   title: "Methodology Short Name",
-  description: "Abbreviated name for UI display and references",
+  description: "Abbreviated/short name of the methodology used for UI display and references",
   examples: ["BOLD Carbon (CH\u2084)", "BOLD Recycling"]
 });
 var MethodologySlugSchema = zod.z.enum(["bold-recycling", "bold-carbon-ch4"]).meta({
@@ -28398,7 +28398,7 @@ var BaseIpfsSchema = zod.z.strictObject({
     example: "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/heads/main/schemas/ipfs/shared/base/base.schema.json"
   }),
   schema: SchemaInfoSchema,
-  created_at: IsoTimestampSchema.meta({
+  created_at: IsoDateTimeSchema.meta({
     title: "Created At",
     description: "ISO 8601 creation timestamp for this record"
   }),
@@ -28682,15 +28682,15 @@ var MassIDRecyclingDateAttributeSchema = NftAttributeSchema.omit({
   title: "MassID Recycling Date Attribute",
   description: "MassID recycling date attribute using Unix timestamp in milliseconds"
 });
-var MethodologyComplianceSchema = zod.z.enum(["PASSED", "FAILED"]).meta({
-  title: "Methodology Compliance",
-  description: "Result of methodology compliance check",
+var AuditResultSchema = zod.z.enum(["PASSED", "FAILED"]).meta({
+  title: "Audit Result",
+  description: "Result of audit execution",
   examples: ["PASSED", "FAILED"]
 });
 var AuditReferenceSchema = zod.z.strictObject({
-  date: IsoDateSchema.meta({
-    title: "Audit Date",
-    description: "Date when the audit was completed"
+  completed_at: IsoDateTimeSchema.meta({
+    title: "Audit Completion Timestamp",
+    description: "ISO 8601 timestamp when the audit was completed"
   }),
   external_id: ExternalIdSchema.meta({
     title: "Audit External ID",
@@ -28700,15 +28700,15 @@ var AuditReferenceSchema = zod.z.strictObject({
     title: "Audit External URL",
     description: "URL to view the audit on Carrot Explorer"
   }),
-  methodology_compliance: MethodologyComplianceSchema.meta({
-    title: "Methodology Compliance",
-    description: "Result of methodology compliance check"
+  result: AuditResultSchema.meta({
+    title: "Audit Result",
+    description: "Result of audit execution"
   }),
   rules_executed: NonNegativeIntegerSchema.meta({
     title: "Rules Executed",
     description: "Number of rules executed during the audit"
   }),
-  report: IpfsUriSchema.meta({
+  report_uri: IpfsUriSchema.meta({
     title: "Audit Report",
     description: "IPFS URI of the audit report"
   })
@@ -28716,18 +28716,82 @@ var AuditReferenceSchema = zod.z.strictObject({
   title: "Audit Reference",
   description: "Reference to an audit record"
 });
+var GasIDReferenceSchema = zod.z.strictObject({
+  external_id: ExternalIdSchema.meta({
+    title: "GasID External ID",
+    description: "Unique identifier for the GasID"
+  }),
+  token_id: TokenIdSchema.meta({
+    title: "GasID Token ID",
+    description: "NFT token ID of the GasID"
+  }),
+  external_url: ExternalUrlSchema.meta({
+    title: "GasID External URL",
+    description: "URL to view the GasID on Carrot Explorer"
+  }),
+  ipfs_uri: IpfsUriSchema.meta({
+    title: "GasID IPFS URI",
+    description: "IPFS URI of the GasID record"
+  })
+}).meta({
+  title: "GasID Reference",
+  description: "Reference to a GasID record"
+});
+var MassIDReferenceSchema = zod.z.strictObject({
+  external_id: ExternalIdSchema.meta({
+    title: "MassID External ID",
+    description: "Unique identifier for the MassID"
+  }),
+  token_id: TokenIdSchema.meta({
+    title: "MassID Token ID",
+    description: "NFT token ID of the MassID"
+  }),
+  external_url: ExternalUrlSchema.meta({
+    title: "MassID External URL",
+    description: "URL to view the MassID on Carrot Explorer"
+  }),
+  ipfs_uri: IpfsUriSchema.meta({
+    title: "MassID IPFS URI",
+    description: "IPFS URI of the MassID record"
+  })
+}).meta({
+  title: "MassID Reference",
+  description: "Reference to a MassID record"
+});
+var MethodologyReferenceSchema = zod.z.strictObject({
+  external_id: ExternalIdSchema.meta({
+    title: "Methodology External ID",
+    description: "Unique identifier for the methodology"
+  }),
+  name: MethodologyNameSchema,
+  version: SemanticVersionSchema.meta({
+    title: "Methodology Version",
+    description: "Version of the methodology"
+  }),
+  external_url: ExternalUrlSchema.meta({
+    title: "Methodology External URL",
+    description: "URL to view the methodology on Carrot Explorer"
+  }),
+  ipfs_uri: IpfsUriSchema.meta({
+    title: "Methodology IPFS URI",
+    description: "IPFS URI to the methodology record"
+  })
+}).meta({
+  title: "Methodology Reference",
+  description: "Reference to a methodology record"
+});
 
 // src/shared/schemas/audit.schema.ts
 var AuditRuleDefinitionSchema = zod.z.strictObject({
-  rule_id: UuidSchema.meta({
+  id: UuidSchema.meta({
     title: "Rule ID",
     description: "Unique identifier for the audit rule"
   }),
-  rule_slug: SlugSchema.meta({
+  slug: SlugSchema.meta({
     title: "Rule Slug",
     description: "URL-friendly identifier for the rule"
   }),
-  rule_name: NonEmptyStringSchema.max(100).meta({
+  name: NonEmptyStringSchema.max(100).meta({
     title: "Rule Name",
     description: "Human-readable name of the rule",
     examples: ["Waste Mass is Unique", "No Conflicting GasID or Credit"]
@@ -28754,35 +28818,103 @@ var AuditRuleDefinitionSchema = zod.z.strictObject({
   title: "Audit Rule Definition",
   description: "Definition of an audit rule that must be executed for methodology compliance"
 });
-var AuditRuleDefinitionsSchema = zod.z.array(AuditRuleDefinitionSchema).min(1).meta({
+var AuditRuleDefinitionsSchema = zod.z.array(AuditRuleDefinitionSchema).min(1).superRefine((rules, ctx) => {
+  const ruleIds = /* @__PURE__ */ new Set();
+  const ruleSlugs = /* @__PURE__ */ new Set();
+  const executionOrders = /* @__PURE__ */ new Set();
+  for (let i = 0; i < rules.length; i++) {
+    const rule = rules[i];
+    if (ruleIds.has(rule.id)) {
+      ctx.addIssue({
+        code: "custom",
+        message: `Duplicate id found: ${rule.id}`,
+        path: [i, "id"]
+      });
+    } else {
+      ruleIds.add(rule.id);
+    }
+    if (ruleSlugs.has(rule.slug)) {
+      ctx.addIssue({
+        code: "custom",
+        message: `Duplicate slug found: ${rule.slug}`,
+        path: [i, "slug"]
+      });
+    } else {
+      ruleSlugs.add(rule.slug);
+    }
+    if (executionOrders.has(rule.execution_order)) {
+      ctx.addIssue({
+        code: "custom",
+        message: `Duplicate execution_order found: ${rule.execution_order}`,
+        path: [i, "execution_order"]
+      });
+    } else {
+      executionOrders.add(rule.execution_order);
+    }
+  }
+  for (let i = 1; i < rules.length; i++) {
+    const previousOrder = rules[i - 1].execution_order;
+    const currentOrder = rules[i].execution_order;
+    if (currentOrder < previousOrder) {
+      ctx.addIssue({
+        code: "custom",
+        message: `Rules must be sorted by execution_order. Found order ${currentOrder} after ${previousOrder}`,
+        path: [i, "execution_order"]
+      });
+    }
+  }
+}).meta({
   title: "Audit Rule Definitions",
-  description: "List of audit rules that must be executed to check methodology compliance"
+  description: "List of audit rules that must be executed to check methodology compliance, sorted by execution order"
 });
 var AuditRuleExecutionResultSchema = zod.z.strictObject({
-  rule_name: NonEmptyStringSchema.meta({
-    title: "Rule Name",
-    description: "Human-readable name of the audit rule"
-  }),
   rule_id: UuidSchema.meta({
     title: "Rule ID",
-    description: "Unique identifier for the rule"
+    description: "Unique identifier for the audit rule"
   }),
   rule_slug: SlugSchema.meta({
     title: "Rule Slug",
     description: "URL-friendly identifier for the rule"
   }),
-  execution_order: PositiveIntegerSchema.meta({
+  rule_name: NonEmptyStringSchema.max(100).meta({
+    title: "Rule Name",
+    description: "Human-readable name of the rule",
+    examples: ["Waste Mass is Unique", "No Conflicting GasID or Credit"]
+  }),
+  rule_description: zod.z.string().min(10).max(500).meta({
+    title: "Rule Description",
+    description: "Detailed description of what the rule validates and why it is necessary",
+    examples: [
+      "Validates that each MassID is unique within the system to prevent duplicate entries"
+    ]
+  }),
+  rule_source_code_url: zod.z.url().regex(/^https:\/\/github\.com\/.*$/, "Must be a GitHub URL").meta({
+    title: "Rule Source Code URL",
+    description: "GitHub URL pointing to the implementation source code for this rule",
+    examples: [
+      "https://github.com/carrot-foundation/methodologies/blob/main/bold-carbon/rules/waste-mass-unique.js"
+    ]
+  }),
+  rule_execution_order: PositiveIntegerSchema.meta({
     title: "Rule Execution Order",
-    description: "Sequential order in which this rule was executed"
+    description: "Sequential order in which this rule must be executed"
+  }),
+  execution_id: UuidSchema.meta({
+    title: "Execution ID",
+    description: "Unique identifier for this specific rule execution"
   }),
-  result: MethodologyComplianceSchema.meta({
+  execution_started_at: IsoDateTimeSchema.meta({
+    title: "Execution Started At",
+    description: "ISO 8601 timestamp when the rule execution started"
+  }),
+  execution_completed_at: IsoDateTimeSchema.meta({
+    title: "Execution Completed At",
+    description: "ISO 8601 timestamp when the rule execution completed"
+  }),
+  result: AuditResultSchema.meta({
     title: "Rule Execution Result",
     description: "Result of the rule execution"
   }),
-  description: zod.z.string().min(1).max(2e3).meta({
-    title: "Rule Description",
-    description: "Detailed description of what this rule validates"
-  }),
   rule_processor_checksum: NonEmptyStringSchema.max(200).meta({
     title: "Rule Processor Checksum",
     description: "Checksum for rule processor integrity verification"
@@ -28795,9 +28927,38 @@ var AuditRuleExecutionResultSchema = zod.z.strictObject({
   title: "Audit Rule Execution Result",
   description: "Detailed result of an audit rule execution"
 });
-var AuditRuleExecutionResultsSchema = zod.z.array(AuditRuleExecutionResultSchema).meta({
+var AuditRuleExecutionResultsSchema = zod.z.array(AuditRuleExecutionResultSchema).min(1).superRefine((results, ctx) => {
+  const executionIds = /* @__PURE__ */ new Set();
+  for (let i = 0; i < results.length; i++) {
+    const result = results[i];
+    if (executionIds.has(result.execution_id)) {
+      ctx.addIssue({
+        code: "custom",
+        message: `Duplicate execution_id found: ${result.execution_id}`,
+        path: [i, "execution_id"]
+      });
+    } else {
+      executionIds.add(result.execution_id);
+    }
+  }
+  for (let i = 1; i < results.length; i++) {
+    const previousStartedAt = new Date(
+      results[i - 1].execution_started_at
+    ).getTime();
+    const currentStartedAt = new Date(
+      results[i].execution_started_at
+    ).getTime();
+    if (currentStartedAt < previousStartedAt) {
+      ctx.addIssue({
+        code: "custom",
+        message: `Results must be sorted by execution_started_at. Found timestamp ${results[i].execution_started_at} before ${results[i - 1].execution_started_at}`,
+        path: [i, "execution_started_at"]
+      });
+    }
+  }
+}).meta({
   title: "Audit Rule Execution Results",
-  description: "Detailed results of each audit rule execution"
+  description: "Detailed results of each audit rule execution, sorted by execution_started_at"
 });
 var ParticipantSchema = zod.z.strictObject({
   id_hash: Sha256HashSchema.meta({
@@ -28841,74 +29002,6 @@ var LocationSchema = zod.z.strictObject({
   title: "Location",
   description: "Geographic location with address and coordinate information"
 });
-var GasIDReferenceSchema = zod.z.strictObject({
-  external_id: ExternalIdSchema.meta({
-    title: "GasID External ID",
-    description: "Unique identifier for the GasID"
-  }),
-  token_id: TokenIdSchema.meta({
-    title: "GasID Token ID",
-    description: "NFT token ID of the GasID"
-  }),
-  external_url: ExternalUrlSchema.meta({
-    title: "GasID External URL",
-    description: "URL to view the GasID on Carrot Explorer"
-  }),
-  uri: IpfsUriSchema.meta({
-    title: "GasID IPFS URI",
-    description: "IPFS URI of the GasID record"
-  })
-}).meta({
-  title: "GasID Reference",
-  description: "Reference to a GasID record"
-});
-var MassIDReferenceSchema = zod.z.strictObject({
-  external_id: ExternalIdSchema.meta({
-    title: "MassID External ID",
-    description: "Unique identifier for the MassID"
-  }),
-  token_id: TokenIdSchema.meta({
-    title: "MassID Token ID",
-    description: "NFT token ID of the MassID"
-  }),
-  external_url: ExternalUrlSchema.meta({
-    title: "MassID External URL",
-    description: "URL to view the MassID on Carrot Explorer"
-  }),
-  uri: IpfsUriSchema.meta({
-    title: "MassID IPFS URI",
-    description: "IPFS URI of the MassID record"
-  })
-}).meta({
-  title: "MassID Reference",
-  description: "Reference to a MassID record"
-});
-var MethodologyReferenceSchema = zod.z.strictObject({
-  external_id: ExternalIdSchema.meta({
-    title: "Methodology External ID",
-    description: "Unique identifier for the methodology"
-  }),
-  name: NonEmptyStringSchema.min(5).max(150).meta({
-    title: "Methodology Name",
-    description: "Human-readable name of the methodology",
-    examples: ["BOLD Carbon (CH\u2084)", "BOLD Recycling"]
-  }),
-  version: SemanticVersionSchema.meta({
-    title: "Methodology Version",
-    description: "Version of the methodology"
-  }),
-  external_url: ExternalUrlSchema.meta({
-    title: "Methodology External URL",
-    description: "URL to view the methodology on Carrot Explorer"
-  }),
-  uri: IpfsUriSchema.optional().meta({
-    title: "Methodology IPFS URI",
-    description: "IPFS URI to the methodology record"
-  })
-}).meta({
-  title: "Methodology Reference",
-  description: "Reference to a methodology record"
-});
 var WasteClassificationSchema = zod.z.strictObject({
   primary_type: WasteTypeSchema.meta({
     title: "Source Waste Primary Type",
@@ -29200,7 +29293,7 @@ function buildSchemaUrl(schemaPath) {
   return `${getSchemaBaseUrl()}/${cleanPath}`;
 }
 function getSchemaVersionOrDefault() {
-  return "0.1.47";
+  return "0.1.48";
 }
 
 // src/shared/schema-validation.ts
@@ -29514,7 +29607,7 @@ var MassIDAttributesSchema = uniqueBy(
   (attr) => attr.trait_type
 ).min(9).max(14).meta({
   title: "MassID Attributes",
-  description: "MassID NFT attributes array. Provide the canonical set covering waste (type, subtype, net weight), origin (municipality), logistics (vehicle, manifests, weighing method/scale), and lifecycle timestamps (pick-up, drop-off, recycling). Length is validated; specific composition is producer-controlled."
+  description: "Array of NFT attributes describing waste characteristics, origin, logistics, and lifecycle events."
 });
 var MassIDLocalClassificationSchema = zod.z.strictObject({
   code: IbamaWasteClassificationSchema,
@@ -29558,7 +29651,7 @@ var MassIDAttachmentSchema = zod.z.strictObject({
     description: "Official document number if applicable",
     examples: ["2353", "12345"]
   }),
-  issued_at: IsoTimestampSchema.optional().meta({
+  issued_at: IsoDateTimeSchema.optional().meta({
     title: "Issued At",
     description: "ISO 8601 timestamp when the attachment was issued"
   }),
@@ -29575,7 +29668,7 @@ var MassIDBaseEventSchema = zod.z.strictObject({
     title: "Event ID",
     description: "Unique event identifier"
   }),
-  timestamp: IsoTimestampSchema.meta({
+  timestamp: IsoDateTimeSchema.meta({
     title: "Event Timestamp",
     description: "ISO 8601 timestamp when the event occurred"
   }),
@@ -31285,15 +31378,8 @@ var CreditSchema = BaseIpfsSchema.safeExtend({
   })
 }).meta(CreditSchemaMeta);
 var MethodologyDataSchema = zod.z.strictObject({
-  name: MethodologyNameSchema.meta({
-    title: "Methodology Name",
-    description: "Full official name of the methodology"
-  }),
-  short_name: NonEmptyStringSchema.max(50).meta({
-    title: "Methodology Short Name",
-    description: "Abbreviated name for UI display and references",
-    examples: ["BOLD Carbon", "BOLD Recycling"]
-  }),
+  name: MethodologyNameSchema,
+  short_name: MethodologyShortNameSchema,
   slug: MethodologySlugSchema,
   version: SemanticVersionSchema.meta({
     title: "Methodology Version",
@@ -31341,26 +31427,28 @@ var MethodologySchema = BaseIpfsSchema.safeExtend({
   data: MethodologyDataSchema
 }).meta(MethodologySchemaMeta);
 var MassIDAuditSummarySchema = zod.z.strictObject({
-  audit_date: IsoDateSchema.meta({
-    title: "Audit Date",
-    description: "Date when the audit was completed"
-  }),
-  methodology_compliance: MethodologyComplianceSchema.meta({
-    title: "Methodology Compliance",
-    description: "Overall outcome of the audit process"
-  }),
-  total_rules_executed: NonNegativeIntegerSchema.meta({
-    title: "Total Rules Executed",
-    description: "Total number of audit rules executed"
+  started_at: IsoDateTimeSchema.meta({
+    title: "Audit Start Timestamp",
+    description: "ISO 8601 timestamp when the audit was started"
   }),
-  passed_rules: NonNegativeIntegerSchema.meta({
-    title: "Passed Rules Count",
-    description: "Number of rules that passed verification"
+  completed_at: IsoDateTimeSchema.meta({
+    title: "Audit Completion Timestamp",
+    description: "ISO 8601 timestamp when the audit was completed"
   }),
-  failed_rules: NonNegativeIntegerSchema.meta({
-    title: "Failed Rules Count",
-    description: "Number of rules that failed verification"
+  result: AuditResultSchema.meta({
+    title: "Audit Result",
+    description: "Overall outcome of the audit process"
   })
+}).superRefine((data, ctx) => {
+  const startedAt = new Date(data.started_at).getTime();
+  const completedAt = new Date(data.completed_at).getTime();
+  if (completedAt < startedAt) {
+    ctx.addIssue({
+      code: "custom",
+      path: ["completed_at"],
+      message: "completed_at must be greater than or equal to started_at"
+    });
+  }
 }).meta({
   title: "Audit Summary",
   description: "Summary of audit execution results"
@@ -31370,7 +31458,7 @@ var MassIDAuditDataSchema = zod.z.strictObject({
   mass_id: MassIDReferenceSchema,
   gas_id: GasIDReferenceSchema,
   audit_summary: MassIDAuditSummarySchema,
-  rules_execution_results: AuditRuleExecutionResultsSchema
+  rule_execution_results: AuditRuleExecutionResultsSchema
 }).meta({
   title: "MassID Audit Data",
   description: "Complete data structure for MassID Audit records"
@@ -31397,6 +31485,7 @@ exports.ALLOWED_BLOCKCHAIN_NETWORKS = ALLOWED_BLOCKCHAIN_NETWORKS;
 exports.AccreditedParticipantSchema = AccreditedParticipantSchema;
 exports.AccreditedParticipantsSchema = AccreditedParticipantsSchema;
 exports.AuditReferenceSchema = AuditReferenceSchema;
+exports.AuditResultSchema = AuditResultSchema;
 exports.AuditRuleDefinitionSchema = AuditRuleDefinitionSchema;
 exports.AuditRuleDefinitionsSchema = AuditRuleDefinitionsSchema;
 exports.AuditRuleExecutionResultSchema = AuditRuleExecutionResultSchema;
@@ -31454,7 +31543,7 @@ exports.IpnsSchema = IpnsSchema;
 exports.IsoCountryCodeSchema = IsoCountryCodeSchema;
 exports.IsoCountrySubdivisionCodeSchema = IsoCountrySubdivisionCodeSchema;
 exports.IsoDateSchema = IsoDateSchema;
-exports.IsoTimestampSchema = IsoTimestampSchema;
+exports.IsoDateTimeSchema = IsoDateTimeSchema;
 exports.LatitudeSchema = LatitudeSchema;
 exports.LocationSchema = LocationSchema;
 exports.LongitudeSchema = LongitudeSchema;
@@ -31462,6 +31551,7 @@ exports.MassIDAttributesSchema = MassIDAttributesSchema;
 exports.MassIDAuditDataSchema = MassIDAuditDataSchema;
 exports.MassIDAuditSchema = MassIDAuditSchema;
 exports.MassIDAuditSchemaMeta = MassIDAuditSchemaMeta;
+exports.MassIDAuditSummarySchema = MassIDAuditSummarySchema;
 exports.MassIDDataSchema = MassIDDataSchema;
 exports.MassIDIpfsSchema = MassIDIpfsSchema;
 exports.MassIDIpfsSchemaMeta = MassIDIpfsSchemaMeta;
@@ -31470,7 +31560,6 @@ exports.MassIDReferenceSchema = MassIDReferenceSchema;
 exports.MassIDTokenIdAttributeSchema = MassIDTokenIdAttributeSchema;
 exports.MassIdReferenceWithContractSchema = MassIdReferenceWithContractSchema;
 exports.MethodologyAttributeSchema = MethodologyAttributeSchema;
-exports.MethodologyComplianceSchema = MethodologyComplianceSchema;
 exports.MethodologyDataSchema = MethodologyDataSchema;
 exports.MethodologyNameSchema = MethodologyNameSchema;
 exports.MethodologyReferenceSchema = MethodologyReferenceSchema;