@carrot-foundation/schemas 0.1.6

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,45 @@
+# 🥕 Carrot IPFS Schemas
+
+This repository contains all JSON Schemas used across the Carrot ecosystem.
+
+These schemas define the structure of IPFS metadata for tokenized assets.
+They are versioned, publicly referenceable, and used for validation, traceability, and frontend/backend integration.
+
+## 📦 Structure
+
+- Schemas are organized by type (e.g., `mass-id`, `gas-id`, `shared`) and follow [Semantic Versioning](https://semver.org/), but folder names are not versioned.
+- Each schema lives in its own folder and includes an `example.json` for testing and documentation.
+- Shared components like `signature`, `attribute`, and the `root` schema are located in `schemas/ipfs/shared`.
+
+## 🔖 Versioning
+
+- Schemas are versioned using Git tags (`vX.Y.Z`); directory names are not versioned.
+- For released versions, each schema’s `$id` must point to the tagged raw URL to remain immutable.
+- During development on `main`, `$id` may reference `refs/heads/main`, but consumers should pin to tags in production.
+- Keep `$ref` paths relative; they resolve against the `$id` base (the tag) at validation time.
+
+Example `$id` pinned to a tag:
+
+```json
+"$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/v0.1.0/schemas/ipfs/collection/collection.schema.json"
+```
+
+## ✅ Usage
+
+You may:
+
+- Reference any schema via its `$id` (e.g. in IPFS metadata)
+- Validate metadata files using these schemas
+- Link to them from applications, dashboards, or traceability tools
+
+You may not:
+
+- Redistribute, rebrand, or fork these schemas for other ecosystems
+- Create derivative schemas that use Carrot's identity
+
+See [NOTICE](./NOTICE) for full usage guidance.
+
+## 🔐 License
+
+Licensed under the [Apache License 2.0](./LICENSE).
+See [NOTICE](./NOTICE) for additional terms and usage intentions.

package/dist/index.js

@@ -0,0 +1 @@
+export * from './mass-id';

package/dist/mass-id/index.js

@@ -0,0 +1,2 @@
+export * from './mass-id.data.schema.js';
+export * from './mass-id.schema.js';

package/dist/mass-id/mass-id.data.schema.js

@@ -0,0 +1,346 @@
+import { z } from 'zod';
+import { UuidSchema, WasteTypeSchema, WasteSubtypeSchema, NonEmptyStringSchema, NonNegativeFloatSchema, IsoTimestampSchema, IsoDateSchema, HoursSchema, } from '../shared/definitions.schema.js';
+import { LocationSchema } from '../shared/entities/location.schema.js';
+import { ParticipantSchema } from '../shared/entities/participant.schema.js';
+import { uniqueBy } from '../shared/helpers.schema.js';
+const LocalClassificationSchema = z
+    .strictObject({
+    code: NonEmptyStringSchema.max(20).meta({
+        title: 'Classification Code',
+        description: 'Local waste classification code',
+        examples: ['20 01 01', 'D001', 'EWC-150101', 'IBAMA-A001'],
+    }),
+    description: NonEmptyStringSchema.max(200).meta({
+        title: 'Classification Description',
+        description: 'Local waste classification description',
+        examples: [
+            'Paper and cardboard packaging',
+            'Ignitable waste',
+            'Paper and cardboard packaging waste',
+            'Municipal solid waste - organic fraction',
+        ],
+    }),
+    system: NonEmptyStringSchema.max(50).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',
+        ],
+    }),
+})
+    .meta({
+    title: 'Local Classification',
+    description: 'Local or regional waste classification codes and descriptions',
+});
+const MeasurementUnitSchema = z.enum(['kg', 'ton']).meta({
+    title: 'Measurement Unit',
+    description: 'Unit of measurement for the waste quantity',
+    examples: ['kg', 'ton'],
+});
+const ContaminationLevelSchema = z
+    .enum(['None', 'Low', 'Medium', 'High'])
+    .meta({
+    title: 'Contamination Level',
+    description: 'Level of contamination in the waste batch',
+    examples: ['Low', 'Medium', 'None'],
+});
+const WasteClassificationSchema = z
+    .strictObject({
+    primary_type: WasteTypeSchema.meta({
+        title: 'Primary Waste Type',
+        description: 'Primary waste material category',
+    }),
+    subtype: WasteSubtypeSchema.meta({
+        title: 'Waste Subtype',
+        description: 'Specific subcategory of waste material',
+    }),
+    local_classification: LocalClassificationSchema.optional(),
+    measurement_unit: MeasurementUnitSchema,
+    net_weight: NonNegativeFloatSchema.meta({
+        title: 'Net Weight',
+        description: 'Net weight of the waste batch in the specified measurement unit',
+    }),
+    contamination_level: ContaminationLevelSchema.optional(),
+})
+    .meta({
+    title: 'Waste Classification',
+    description: 'Standardized waste material classification and regulatory information',
+});
+const EventAttributeFormatSchema = z
+    .enum(['KILOGRAM', 'DATE', 'CURRENCY', 'PERCENTAGE', 'COORDINATE'])
+    .meta({
+    title: 'Event Attribute Format',
+    description: 'Data format hint for proper display',
+    examples: ['KILOGRAM', 'DATE', 'PERCENTAGE'],
+});
+const EventAttributeSchema = z
+    .strictObject({
+    name: NonEmptyStringSchema.max(100).meta({
+        title: 'Attribute Name',
+        description: 'Event attribute name',
+        examples: [
+            'temperature',
+            'humidity',
+            'contamination_percentage',
+            'quality_grade',
+            'batch_number',
+            'operator_id',
+            'equipment_used',
+            'processing_cost',
+        ],
+    }),
+    value: z.union([z.string(), z.number(), z.boolean()]).meta({
+        title: 'Attribute Value',
+        description: 'Event attribute value',
+        examples: [
+            25.5,
+            'Grade A',
+            true,
+            'BATCH-2024-001',
+            12.75,
+            'Shredder-X200',
+            false,
+            'OP-456',
+        ],
+    }),
+    format: EventAttributeFormatSchema.optional(),
+})
+    .meta({
+    title: 'Event Attribute',
+    description: 'Additional attribute specific to an event',
+});
+const EventDocumentSchema = z
+    .strictObject({
+    type: NonEmptyStringSchema.max(50).meta({
+        title: 'Document Type',
+        description: 'Type of supporting documentation',
+        examples: [
+            'Waste Transfer Note',
+            'Certificate of Disposal',
+            'Certificate of Final Destination',
+            'Quality Assessment Report',
+            'Transport Manifest',
+            'Processing Receipt',
+            'Environmental Permit',
+            'Invoice',
+        ],
+    }),
+    document_number: NonEmptyStringSchema.max(50)
+        .optional()
+        .meta({
+        title: 'Document Number',
+        description: 'Official document number if applicable',
+        examples: [
+            'WTN-2024-001234',
+            'CD-ENV-456789',
+            'INV-2024-QTR1-789',
+            'PERMIT-EPA-2024-001',
+            'MANIFEST-DOT-567890',
+        ],
+    }),
+    reference: NonEmptyStringSchema.meta({
+        title: 'Document Reference',
+        description: 'Reference to document (IPFS hash, file name, or external URL)',
+        examples: [
+            'QmYjtig7VJQ6XsnUjqqJvj7QaMcCAwtrgNdahSiFofrE7o',
+            'waste_transfer_note_2024_001.pdf',
+            'https://docs.example.com/certificates/disposal_cert_456.pdf',
+            'bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi',
+            'processing_receipt_20240315.jpg',
+        ],
+    }),
+    issue_date: IsoDateSchema.optional().meta({
+        title: 'Issue Date',
+        description: 'Date the document was issued',
+    }),
+    issuer: NonEmptyStringSchema.max(100)
+        .optional()
+        .meta({
+        title: 'Document Issuer',
+        description: 'Entity that issued the document',
+        examples: [
+            'Environmental Protection Agency',
+            'Waste Management Solutions Ltd',
+            'Green Recycling Corp',
+            'City Waste Authority',
+            'EcoProcess Industries',
+            'Regional Environmental Office',
+        ],
+    }),
+})
+    .meta({
+    title: 'Event Document',
+    description: 'Supporting event document',
+});
+const ChainOfCustodyEventSchema = z
+    .strictObject({
+    event_id: UuidSchema.meta({
+        title: 'Event ID',
+        description: 'Unique event identifier',
+    }),
+    event_name: NonEmptyStringSchema.max(50).meta({
+        title: 'Event Name',
+        description: 'Name of custody or processing event',
+        examples: ['Sorting', 'Processing', 'Recycling', 'Weighing'],
+    }),
+    description: NonEmptyStringSchema.max(200).meta({
+        title: 'Event Description',
+        description: 'Detailed description of what happened during this event',
+        examples: [
+            'Waste collected from residential area using collection truck',
+            'Material sorted into recyclable and non-recyclable fractions',
+            'Plastic waste processed through shredding and washing',
+            'Waste transferred to authorized recycling facility',
+            'Final disposal at licensed landfill site',
+            'Quality inspection and contamination assessment completed',
+        ],
+    }),
+    timestamp: IsoTimestampSchema.meta({
+        title: 'Event Timestamp',
+        description: 'ISO 8601 timestamp when the event occurred',
+    }),
+    participant_id: UuidSchema.meta({
+        title: 'Participant ID',
+        description: 'Reference to participant in the participants array',
+    }),
+    location_id: UuidSchema.meta({
+        title: 'Location ID',
+        description: 'Reference to location in the locations array',
+    }),
+    weight: NonNegativeFloatSchema.optional().meta({
+        title: 'Event Weight',
+        description: 'Mass weight after this event',
+    }),
+    attributes: z.array(EventAttributeSchema).optional().meta({
+        title: 'Event Attributes',
+        description: 'Additional attributes specific to this event',
+    }),
+    documentation: z.array(EventDocumentSchema).optional().meta({
+        title: 'Event Documentation',
+        description: 'Associated documentation for this event',
+    }),
+    notes: NonEmptyStringSchema.max(500).optional().meta({
+        title: 'Event Notes',
+        description: 'Additional notes or comments about this event',
+    }),
+})
+    .meta({
+    title: 'Chain of Custody Event',
+    description: 'Chain of custody event',
+});
+const ChainOfCustodySchema = z
+    .strictObject({
+    events: z.array(ChainOfCustodyEventSchema).min(1).meta({
+        title: 'Custody Events',
+        description: 'Chronological sequence of custody transfer and processing events',
+    }),
+    total_distance_km: NonNegativeFloatSchema.meta({
+        title: 'Total Distance (km)',
+        description: 'Total distance traveled across all transport events',
+    }),
+    total_duration_hours: HoursSchema.meta({
+        title: 'Total Duration (hours)',
+        description: 'Total time from first to last event in hours',
+    }),
+})
+    .meta({
+    title: 'Chain of Custody',
+    description: 'Complete chain of custody tracking from waste generation to final processing',
+});
+const TransportRouteSchema = z
+    .strictObject({
+    from_location_id: UuidSchema.meta({
+        title: 'From Location ID',
+        description: 'Reference to the origin location in the locations array',
+    }),
+    to_location_id: UuidSchema.meta({
+        title: 'To Location ID',
+        description: 'Reference to the destination location in the locations array',
+    }),
+    distance_km: NonNegativeFloatSchema.meta({
+        title: 'Distance (km)',
+        description: 'Distance for this route segment in kilometers',
+    }),
+    transport_method: NonEmptyStringSchema.max(50).meta({
+        title: 'Transport Method',
+        description: 'Method of transportation for this segment',
+        examples: [
+            'Truck',
+            'Rail',
+            'Barge',
+            'Container Ship',
+            'Conveyor Belt',
+            'Pipeline',
+            'Walking',
+            'Forklift',
+        ],
+    }),
+    duration_hours: HoursSchema.meta({
+        title: 'Duration (hours)',
+        description: 'Time taken for this route segment in hours',
+    }),
+})
+    .meta({
+    title: 'Transport Route',
+    description: 'Transport route segment information',
+});
+const GeographicDataSchema = z
+    .strictObject({
+    origin_location_id: UuidSchema.meta({
+        title: 'Origin Location ID',
+        description: 'Reference to origin location in the locations array',
+    }),
+    processing_location_ids: z.array(UuidSchema).optional().meta({
+        title: 'Processing Location IDs',
+        description: 'Locations where the waste was processed or handled',
+    }),
+    final_destination_id: UuidSchema.meta({
+        title: 'Final Destination ID',
+        description: 'Reference to final destination in the locations array',
+    }),
+    transport_routes: z.array(TransportRouteSchema).meta({
+        title: 'Transport Routes',
+        description: 'Detailed transport route information',
+    }),
+})
+    .meta({
+    title: 'Geographic Data',
+    description: 'Geographic information about waste origin and processing locations',
+});
+export const MassIDDataSchema = z
+    .strictObject({
+    waste_classification: WasteClassificationSchema,
+    locations: uniqueBy(LocationSchema, (loc) => loc.id, 'Location IDs must be unique')
+        .min(1)
+        .meta({
+        title: 'Locations',
+        description: 'All locations referenced in this MassID, indexed by ID',
+    }),
+    participants: uniqueBy(ParticipantSchema, (p) => p.id, 'Participant IDs must be unique')
+        .min(1)
+        .meta({
+        title: 'Participants',
+        description: 'All participants referenced in this MassID, indexed by ID',
+    }),
+    chain_of_custody: ChainOfCustodySchema,
+    geographic_data: GeographicDataSchema,
+})
+    .refine((data) => {
+    const participantIdSet = new Set(data.participants.map((participant) => participant.id));
+    const eventParticipantIds = data.chain_of_custody.events.map((event) => event.participant_id);
+    const allEventParticipantsExist = eventParticipantIds.every((participantId) => participantIdSet.has(participantId));
+    return allEventParticipantsExist;
+}, 'All participant IDs in chain of custody events must exist in participants array')
+    .refine((data) => {
+    const locationIdSet = new Set(data.locations.map((location) => location.id));
+    const eventLocationIds = data.chain_of_custody.events.map((event) => event.location_id);
+    const allEventLocationsExist = eventLocationIds.every((locationId) => locationIdSet.has(locationId));
+    return allEventLocationsExist;
+}, 'All location IDs in chain of custody events must exist in locations array')
+    .meta({
+    title: 'MassID Data',
+    description: 'MassID data containing waste tracking and chain of custody information',
+});