@carrot-foundation/schemas 0.2.4 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (27) hide show
  1. package/README.md +144 -116
  2. package/dist/index.cjs +115 -113
  3. package/dist/index.cjs.map +1 -1
  4. package/dist/index.d.cts +7 -7
  5. package/dist/index.d.ts +7 -7
  6. package/dist/index.js +115 -113
  7. package/dist/index.js.map +1 -1
  8. package/package.json +12 -12
  9. package/schemas/ipfs/collection/collection.example.json +3 -3
  10. package/schemas/ipfs/collection/collection.schema.json +7 -7
  11. package/schemas/ipfs/credit/credit.example.json +4 -4
  12. package/schemas/ipfs/credit/credit.schema.json +6 -6
  13. package/schemas/ipfs/credit-purchase-receipt/credit-purchase-receipt.example.json +15 -15
  14. package/schemas/ipfs/credit-purchase-receipt/credit-purchase-receipt.schema.json +56 -56
  15. package/schemas/ipfs/credit-retirement-receipt/credit-retirement-receipt.example.json +15 -15
  16. package/schemas/ipfs/credit-retirement-receipt/credit-retirement-receipt.schema.json +54 -54
  17. package/schemas/ipfs/gas-id/gas-id.example.json +9 -9
  18. package/schemas/ipfs/gas-id/gas-id.schema.json +49 -41
  19. package/schemas/ipfs/mass-id/mass-id.example.json +7 -7
  20. package/schemas/ipfs/mass-id/mass-id.schema.json +60 -43
  21. package/schemas/ipfs/mass-id-audit/mass-id-audit.example.json +57 -57
  22. package/schemas/ipfs/mass-id-audit/mass-id-audit.schema.json +14 -14
  23. package/schemas/ipfs/methodology/methodology.example.json +5 -5
  24. package/schemas/ipfs/methodology/methodology.schema.json +7 -7
  25. package/schemas/ipfs/recycled-id/recycled-id.example.json +9 -9
  26. package/schemas/ipfs/recycled-id/recycled-id.schema.json +43 -35
  27. package/schemas/schema-hashes.json +10 -10
package/dist/index.d.cts CHANGED
@@ -591,7 +591,7 @@ type MassIDData = z.infer<typeof MassIDDataSchema>;
591
591
 
592
592
  declare const MassIDIpfsSchemaMeta: {
593
593
  readonly title: "MassID NFT IPFS Record";
594
- readonly description: "Complete MassID NFT IPFS record schema defining waste tracking metadata, chain of custody events, and NFT display attributes";
594
+ readonly description: "Complete MassID NFT IPFS record including waste classification, chain-of-custody lifecycle events, geographic locations, supply-chain participants, and NFT display attributes";
595
595
  readonly $id: string;
596
596
  readonly version: string;
597
597
  };
@@ -1166,7 +1166,7 @@ type GasIDData = z.infer<typeof GasIDDataSchema>;
1166
1166
 
1167
1167
  declare const GasIDIpfsSchemaMeta: {
1168
1168
  readonly title: "GasID NFT IPFS Record";
1169
- readonly description: "Complete GasID NFT IPFS record including fixed attributes and detailed carbon emissions prevention data";
1169
+ readonly description: "Complete GasID NFT IPFS record including prevented emissions calculation, source waste provenance, methodology reference, and NFT display attributes";
1170
1170
  readonly $id: string;
1171
1171
  readonly version: string;
1172
1172
  };
@@ -1709,7 +1709,7 @@ type RecycledIDData = z.infer<typeof RecycledIDDataSchema>;
1709
1709
 
1710
1710
  declare const RecycledIDIpfsSchemaMeta: {
1711
1711
  readonly title: "RecycledID NFT IPFS Record";
1712
- readonly description: "Complete RecycledID NFT IPFS record including fixed attributes and recycling outcome data";
1712
+ readonly description: "Complete RecycledID NFT IPFS record including recycling outcome metrics, source waste provenance, methodology reference, and NFT display attributes";
1713
1713
  readonly $id: string;
1714
1714
  readonly version: string;
1715
1715
  };
@@ -2125,7 +2125,7 @@ type CreditPurchaseReceiptData = z.infer<typeof CreditPurchaseReceiptDataSchema>
2125
2125
 
2126
2126
  declare const CreditPurchaseReceiptIpfsSchemaMeta: {
2127
2127
  readonly title: "CreditPurchaseReceipt NFT IPFS Record";
2128
- readonly description: "Complete CreditPurchaseReceipt NFT IPFS record including attributes and credit purchase data";
2128
+ readonly description: "Complete CreditPurchaseReceipt NFT IPFS record including purchase summary, buyer details, credit breakdowns, certificate allocations, and NFT display attributes";
2129
2129
  readonly $id: string;
2130
2130
  readonly version: string;
2131
2131
  };
@@ -2514,7 +2514,7 @@ type CreditRetirementReceiptData = z.infer<typeof CreditRetirementReceiptDataSch
2514
2514
 
2515
2515
  declare const CreditRetirementReceiptIpfsSchemaMeta: {
2516
2516
  readonly title: "CreditRetirementReceipt NFT IPFS Record";
2517
- readonly description: "Complete CreditRetirementReceipt NFT IPFS record including attributes and credit retirement data";
2517
+ readonly description: "Complete CreditRetirementReceipt NFT IPFS record including retirement summary, beneficiary and credit holder details, credit breakdowns, certificate allocations, and NFT display attributes";
2518
2518
  readonly $id: string;
2519
2519
  readonly version: string;
2520
2520
  };
@@ -2796,7 +2796,7 @@ type Credit = z.infer<typeof CreditSchema>;
2796
2796
 
2797
2797
  declare const MethodologySchemaMeta: {
2798
2798
  readonly title: "Methodology IPFS Record";
2799
- readonly description: "Methodology metadata stored in IPFS, extending the base schema with methodology data and audit rules";
2799
+ readonly description: "Methodology metadata stored in IPFS, defining the environmental impact measurement approach including versioning, documentation, and MassID audit rules";
2800
2800
  readonly $id: string;
2801
2801
  readonly version: string;
2802
2802
  };
@@ -2891,7 +2891,7 @@ type MethodologyData = z.infer<typeof MethodologyDataSchema>;
2891
2891
 
2892
2892
  declare const MassIDAuditSchemaMeta: {
2893
2893
  readonly title: "MassID Audit IPFS Record";
2894
- readonly description: "MassID audit metadata stored in IPFS, extending the base schema with audit results and references";
2894
+ readonly description: "MassID audit record stored in IPFS, containing methodology reference, audit summary, rule execution results, and links to the source MassID and resulting GasID or RecycledID";
2895
2895
  readonly $id: string;
2896
2896
  readonly version: string;
2897
2897
  };
package/dist/index.d.ts CHANGED
@@ -591,7 +591,7 @@ type MassIDData = z.infer<typeof MassIDDataSchema>;
591
591
 
592
592
  declare const MassIDIpfsSchemaMeta: {
593
593
  readonly title: "MassID NFT IPFS Record";
594
- readonly description: "Complete MassID NFT IPFS record schema defining waste tracking metadata, chain of custody events, and NFT display attributes";
594
+ readonly description: "Complete MassID NFT IPFS record including waste classification, chain-of-custody lifecycle events, geographic locations, supply-chain participants, and NFT display attributes";
595
595
  readonly $id: string;
596
596
  readonly version: string;
597
597
  };
@@ -1166,7 +1166,7 @@ type GasIDData = z.infer<typeof GasIDDataSchema>;
1166
1166
 
1167
1167
  declare const GasIDIpfsSchemaMeta: {
1168
1168
  readonly title: "GasID NFT IPFS Record";
1169
- readonly description: "Complete GasID NFT IPFS record including fixed attributes and detailed carbon emissions prevention data";
1169
+ readonly description: "Complete GasID NFT IPFS record including prevented emissions calculation, source waste provenance, methodology reference, and NFT display attributes";
1170
1170
  readonly $id: string;
1171
1171
  readonly version: string;
1172
1172
  };
@@ -1709,7 +1709,7 @@ type RecycledIDData = z.infer<typeof RecycledIDDataSchema>;
1709
1709
 
1710
1710
  declare const RecycledIDIpfsSchemaMeta: {
1711
1711
  readonly title: "RecycledID NFT IPFS Record";
1712
- readonly description: "Complete RecycledID NFT IPFS record including fixed attributes and recycling outcome data";
1712
+ readonly description: "Complete RecycledID NFT IPFS record including recycling outcome metrics, source waste provenance, methodology reference, and NFT display attributes";
1713
1713
  readonly $id: string;
1714
1714
  readonly version: string;
1715
1715
  };
@@ -2125,7 +2125,7 @@ type CreditPurchaseReceiptData = z.infer<typeof CreditPurchaseReceiptDataSchema>
2125
2125
 
2126
2126
  declare const CreditPurchaseReceiptIpfsSchemaMeta: {
2127
2127
  readonly title: "CreditPurchaseReceipt NFT IPFS Record";
2128
- readonly description: "Complete CreditPurchaseReceipt NFT IPFS record including attributes and credit purchase data";
2128
+ readonly description: "Complete CreditPurchaseReceipt NFT IPFS record including purchase summary, buyer details, credit breakdowns, certificate allocations, and NFT display attributes";
2129
2129
  readonly $id: string;
2130
2130
  readonly version: string;
2131
2131
  };
@@ -2514,7 +2514,7 @@ type CreditRetirementReceiptData = z.infer<typeof CreditRetirementReceiptDataSch
2514
2514
 
2515
2515
  declare const CreditRetirementReceiptIpfsSchemaMeta: {
2516
2516
  readonly title: "CreditRetirementReceipt NFT IPFS Record";
2517
- readonly description: "Complete CreditRetirementReceipt NFT IPFS record including attributes and credit retirement data";
2517
+ readonly description: "Complete CreditRetirementReceipt NFT IPFS record including retirement summary, beneficiary and credit holder details, credit breakdowns, certificate allocations, and NFT display attributes";
2518
2518
  readonly $id: string;
2519
2519
  readonly version: string;
2520
2520
  };
@@ -2796,7 +2796,7 @@ type Credit = z.infer<typeof CreditSchema>;
2796
2796
 
2797
2797
  declare const MethodologySchemaMeta: {
2798
2798
  readonly title: "Methodology IPFS Record";
2799
- readonly description: "Methodology metadata stored in IPFS, extending the base schema with methodology data and audit rules";
2799
+ readonly description: "Methodology metadata stored in IPFS, defining the environmental impact measurement approach including versioning, documentation, and MassID audit rules";
2800
2800
  readonly $id: string;
2801
2801
  readonly version: string;
2802
2802
  };
@@ -2891,7 +2891,7 @@ type MethodologyData = z.infer<typeof MethodologyDataSchema>;
2891
2891
 
2892
2892
  declare const MassIDAuditSchemaMeta: {
2893
2893
  readonly title: "MassID Audit IPFS Record";
2894
- readonly description: "MassID audit metadata stored in IPFS, extending the base schema with audit results and references";
2894
+ readonly description: "MassID audit record stored in IPFS, containing methodology reference, audit summary, rule execution results, and links to the source MassID and resulting GasID or RecycledID";
2895
2895
  readonly $id: string;
2896
2896
  readonly version: string;
2897
2897
  };