diff --git a/packages/untp-test-suite/credentials-v0.3.10.json b/packages/untp-test-suite/credentials-v0.3.10.json new file mode 100644 index 00000000..2483a091 --- /dev/null +++ b/packages/untp-test-suite/credentials-v0.3.10.json @@ -0,0 +1,34 @@ +{ + "credentials": [ + { + "type": "aggregationEvent", + "version": "v0.0.1", + "dataPath": "" + }, + { + "type": "conformityCredential", + "version": "v0.3.10", + "dataPath": "credentials/DigitalConformityCredential_instance-0.3.10.json" + }, + { + "type": "objectEvent", + "version": "v0.3.10", + "dataPath": "credentials/DigitalTraceabilityEvent_instance-0.3.10.json" + }, + { + "type": "productPassport", + "version": "v0.3.10", + "dataPath": "credentials/DigitalProductPassport_instance-0.3.10.json" + }, + { + "type": "transactionEvent", + "version": "v0.0.1", + "dataPath": "" + }, + { + "type": "transformationEvent", + "version": "v0.0.1", + "dataPath": "" + } + ] +} \ No newline at end of file diff --git a/packages/untp-test-suite/credentials/DigitalConformityCredential_instance-0.3.10.json b/packages/untp-test-suite/credentials/DigitalConformityCredential_instance-0.3.10.json new file mode 100644 index 00000000..3b534389 --- /dev/null +++ b/packages/untp-test-suite/credentials/DigitalConformityCredential_instance-0.3.10.json @@ -0,0 +1,589 @@ +{ + "type": [ + "DigitalConformityCredential", + "VerifiableCredential" + ], + "@context": [ + "https://www.w3.org/ns/credentials/v2", + "https://test.uncefact.org/vocabulary/untp/dcc/0.3.10/", + "https://dev-render-method-context.s3.ap-southeast-1.amazonaws.com/dev-render-method-context.json" + ], + "id": "https://example-company.com/credentials/2a423366-a0d6-4855-ba65-2e0c926d09b0", + "issuer": { + "type": [ + "CredentialIssuer" + ], + "id": "did:web:identifiers.example-company.com:12345", + "name": "Example Company Pty Ltd", + "otherIdentifiers": [ + { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + } + ] + }, + "validFrom": "2024-03-15T12:00:00", + "validUntil": "2034-03-15T12:00:00", + "credentialSubject": { + "type": [ + "ConformityAttestation", + "Attestation" + ], + "id": "https://exampleCAB.com/38f73303-a39e-45a7-b8b7-e73517548f27", + "name": "Carbon Lifecycle assessment 12345567", + "assessorLevel": "3rdParty", + "assessmentLevel": "Accredited", + "attestationType": "certification", + "attestationDescription": "Assessment of battery products against the GHG Protocol.", + "issuedToParty": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "authorisations": [ + { + "type": [ + "Endorsement" + ], + "id": "https://authority.gov/schemeABC/123456789", + "name": "Accreditation of certifiers.com under the Australian National Greenhouse and Energy Reporting scheme (NGER).", + "trustmark": { + "fileName": "GHG protocol trust mark", + "fileType": "image/png", + "file": "iVBORw0KGgoAAAANSUhEUgAAADkAAAA2CAYAAAB9TjFQAAAABGdBTUEAAi/9H3pWy6vI9uFdAAAAAElFTkSuQmCC" + }, + "issuingAuthority": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "accreditationCertificate": { + "linkURL": "https://files.example-certifier.com/1234567.json", + "linkName": "GBA rule book conformity certificate", + "linkType": "https://test.uncefact.org/vocabulary/linkTypes/dcc" + } + }, + { + "type": [ + "Endorsement" + ], + "id": "https://authority.gov/schemeABC/123456789", + "name": "Accreditation of certifiers.com under the Australian National Greenhouse and Energy Reporting scheme (NGER).", + "trustmark": { + "fileName": "GHG protocol trust mark", + "fileType": "image/png", + "file": "iVBORw0KGgoAAAANSUhEUgAAADkAAAA2CAYAAAB9TjFQAAAABGdBTUEAAi/9H3pWy6vI9uFdAAAAAElFTkSuQmCC" + }, + "issuingAuthority": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "accreditationCertificate": { + "linkURL": "https://files.example-certifier.com/1234567.json", + "linkName": "GBA rule book conformity certificate", + "linkType": "https://test.uncefact.org/vocabulary/linkTypes/dcc" + } + } + ], + "conformityCertificate": { + "linkURL": "https://files.example-certifier.com/1234567.json", + "linkName": "GBA rule book conformity certificate", + "linkType": "https://test.uncefact.org/vocabulary/linkTypes/dcc", + "hashDigest": "6239119", + "hashMethod": "SHA-256", + "encryptionMethod": "AES" + }, + "auditableEvidence": { + "linkURL": "https://files.example-certifier.com/1234567.json", + "linkName": "GBA rule book conformity certificate", + "linkType": "https://test.uncefact.org/vocabulary/linkTypes/dcc", + "hashDigest": "6239119", + "hashMethod": "SHA-256", + "encryptionMethod": "AES" + }, + "scope": { + "type": [ + "ConformityAssessmentScheme", + "Standard" + ], + "id": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf", + "name": "GBA Battery Passport Greenhouse Gas Rulebook - V.2.0", + "issuingParty": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "issueDate": "2023-12-05", + "trustmark": { + "fileName": "GHG protocol trust mark", + "fileType": "image/png", + "file": "iVBORw0KGgoAAAANSUhEUgAAADkAAAA2CAYAAAB9TjFQAAAABGdBTUEAAi/9H3pWy6vI9uFdAAAAAElFTkSuQmCC" + } + }, + "assessments": [ + { + "type": [ + "ConformityAssessment", + "Declaration" + ], + "id": "https://exampleCAB.com/38f73303-a39e-45a7-b8b7-e73517548f27/01", + "referenceStandard": { + "type": [ + "Standard" + ], + "id": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf", + "name": "GBA Battery Passport Greenhouse Gas Rulebook - V.2.0", + "issuingParty": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "issueDate": "2023-12-05" + }, + "referenceRegulation": { + "type": [ + "Regulation" + ], + "id": "https://www.legislation.gov.au/F2008L02309/latest/versions", + "name": "NNational Greenhouse and Energy Reporting (Measurement) Determination", + "jurisdictionCountry": "Enumeration Value", + "administeredBy": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "effectiveDate": "2024-03-20" + }, + "assessmentCriteria": [ + { + "type": [ + "Criterion" + ], + "id": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf#BatteryAssembly", + "name": "GBA Battery rule book v2.0 battery assembly guidelines.", + "thresholdValues": [ + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + }, + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + } + ] + }, + { + "type": [ + "Criterion" + ], + "id": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf#BatteryAssembly", + "name": "GBA Battery rule book v2.0 battery assembly guidelines.", + "thresholdValues": [ + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + }, + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + } + ] + } + ], + "declaredValues": [ + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + }, + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + } + ], + "compliance": true, + "conformityTopic": "environment.emissions", + "assessedProducts": [ + { + "type": [ + "Product", + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + }, + "IDverifiedByCAB": true + }, + { + "type": [ + "Product", + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + }, + "IDverifiedByCAB": true + } + ], + "assessedFacilities": [ + { + "type": [ + "Facility", + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + }, + "IDverifiedByCAB": true + }, + { + "type": [ + "Facility", + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + }, + "IDverifiedByCAB": true + } + ] + }, + { + "type": [ + "ConformityAssessment", + "Declaration" + ], + "id": "https://exampleCAB.com/38f73303-a39e-45a7-b8b7-e73517548f27/01", + "referenceStandard": { + "type": [ + "Standard" + ], + "id": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf", + "name": "GBA Battery Passport Greenhouse Gas Rulebook - V.2.0", + "issuingParty": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "issueDate": "2023-12-05" + }, + "referenceRegulation": { + "type": [ + "Regulation" + ], + "id": "https://www.legislation.gov.au/F2008L02309/latest/versions", + "name": "NNational Greenhouse and Energy Reporting (Measurement) Determination", + "jurisdictionCountry": "Enumeration Value", + "administeredBy": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "effectiveDate": "2024-03-20" + }, + "assessmentCriteria": [ + { + "type": [ + "Criterion" + ], + "id": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf#BatteryAssembly", + "name": "GBA Battery rule book v2.0 battery assembly guidelines.", + "thresholdValues": [ + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + }, + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + } + ] + }, + { + "type": [ + "Criterion" + ], + "id": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf#BatteryAssembly", + "name": "GBA Battery rule book v2.0 battery assembly guidelines.", + "thresholdValues": [ + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + }, + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + } + ] + } + ], + "declaredValues": [ + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + }, + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + } + ], + "compliance": true, + "conformityTopic": "environment.emissions", + "assessedProducts": [ + { + "type": [ + "Product", + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + }, + "IDverifiedByCAB": true + }, + { + "type": [ + "Product", + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + }, + "IDverifiedByCAB": true + } + ], + "assessedFacilities": [ + { + "type": [ + "Facility", + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + }, + "IDverifiedByCAB": true + }, + { + "type": [ + "Facility", + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + }, + "IDverifiedByCAB": true + } + ] + } + ] + } +} \ No newline at end of file diff --git a/packages/untp-test-suite/credentials/DigitalConformityCredential_instance-0.3.9.json b/packages/untp-test-suite/credentials/DigitalConformityCredential_instance-0.3.9.json new file mode 100644 index 00000000..5d07aa6f --- /dev/null +++ b/packages/untp-test-suite/credentials/DigitalConformityCredential_instance-0.3.9.json @@ -0,0 +1,588 @@ +{ + "type": [ + "DigitalConformityCredential", + "VerifiableCredential" + ], + "@context": [ + "https://www.w3.org/ns/credentials/v2", + "https://vocabulary.uncefact.org/untp/dcc/0.3.9/" + ], + "id": "https://example-company.com/credentials/2a423366-a0d6-4855-ba65-2e0c926d09b0", + "issuer": { + "type": [ + "CredentialIssuer" + ], + "id": "did:web:identifiers.example-company.com:12345", + "name": "Example Company Pty Ltd", + "otherIdentifiers": [ + { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + } + ] + }, + "validFrom": 2024, + "validUntil": 2034, + "credentialSubject": { + "type": [ + "ConformityAttestation", + "Attestation" + ], + "id": "https://exampleCAB.com/38f73303-a39e-45a7-b8b7-e73517548f27", + "name": "The quick brown fox jumps over the lazy dog.", + "assessorLevel": "Self", + "assessmentLevel": "GovtApproval", + "attestationType": "certification", + "attestationDescription": "The quick brown fox jumps over the lazy dog.", + "issuedToParty": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "authorisations": [ + { + "type": [ + "Endorsement" + ], + "id": "https://authority.gov/schemeABC/123456789", + "name": "Accreditation of certifiers.com under the Australian National Greenhouse and Energy Reporting scheme (NGER).", + "trustmark": { + "fileName": "GHG protocol trust mark", + "fileType": "image/png", + "file": "iVBORw0KGgoAAAANSUhEUgAAADkAAAA2CAYAAAB9TjFQAAAABGdBTUEAAi/9H3pWy6vI9uFdAAAAAElFTkSuQmCC" + }, + "issuingAuthority": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "accreditationCertificate": { + "linkURL": "https://files.example-certifier.com/1234567.json", + "linkName": "GBA rule book conformity certificate", + "linkType": "https://test.uncefact.org/vocabulary/linkTypes/dcc" + } + }, + { + "type": [ + "Endorsement" + ], + "id": "https://authority.gov/schemeABC/123456789", + "name": "Accreditation of certifiers.com under the Australian National Greenhouse and Energy Reporting scheme (NGER).", + "trustmark": { + "fileName": "GHG protocol trust mark", + "fileType": "image/png", + "file": "iVBORw0KGgoAAAANSUhEUgAAADkAAAA2CAYAAAB9TjFQAAAABGdBTUEAAi/9H3pWy6vI9uFdAAAAAElFTkSuQmCC" + }, + "issuingAuthority": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "accreditationCertificate": { + "linkURL": "https://files.example-certifier.com/1234567.json", + "linkName": "GBA rule book conformity certificate", + "linkType": "https://test.uncefact.org/vocabulary/linkTypes/dcc" + } + } + ], + "conformityCertificate": { + "linkURL": "https://files.example-certifier.com/1234567.json", + "linkName": "GBA rule book conformity certificate", + "linkType": "https://test.uncefact.org/vocabulary/linkTypes/dcc", + "hashDigest": "6239119", + "hashMethod": "SHA-256", + "encryptionMethod": "AES" + }, + "auditableEvidence": { + "linkURL": "https://files.example-certifier.com/1234567.json", + "linkName": "GBA rule book conformity certificate", + "linkType": "https://test.uncefact.org/vocabulary/linkTypes/dcc", + "hashDigest": "6239119", + "hashMethod": "SHA-256", + "encryptionMethod": "AES" + }, + "scope": { + "type": [ + "ConformityAssessmentScheme", + "Standard" + ], + "id": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf", + "name": "GBA Battery Passport Greenhouse Gas Rulebook - V.2.0", + "issuingParty": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "issueDate": 2023, + "trustmark": { + "fileName": "GHG protocol trust mark", + "fileType": "image/png", + "file": "iVBORw0KGgoAAAANSUhEUgAAADkAAAA2CAYAAAB9TjFQAAAABGdBTUEAAi/9H3pWy6vI9uFdAAAAAElFTkSuQmCC" + } + }, + "assessments": [ + { + "type": [ + "ConformityAssessment", + "Declaration" + ], + "id": "https://exampleCAB.com/38f73303-a39e-45a7-b8b7-e73517548f27/01", + "referenceStandard": { + "type": [ + "Standard" + ], + "id": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf", + "name": "GBA Battery Passport Greenhouse Gas Rulebook - V.2.0", + "issuingParty": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "issueDate": 2023 + }, + "referenceRegulation": { + "type": [ + "Regulation" + ], + "id": "https://www.legislation.gov.au/F2008L02309/latest/versions", + "name": "NNational Greenhouse and Energy Reporting (Measurement) Determination", + "jurisdictionCountry": "Enumeration Value", + "administeredBy": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "effectiveDate": 2024 + }, + "assessmentCriteria": [ + { + "type": [ + "Criterion" + ], + "id": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf#BatteryAssembly", + "name": "GBA Battery rule book v2.0 battery assembly guidelines.", + "thresholdValues": [ + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + }, + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + } + ] + }, + { + "type": [ + "Criterion" + ], + "id": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf#BatteryAssembly", + "name": "GBA Battery rule book v2.0 battery assembly guidelines.", + "thresholdValues": [ + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + }, + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + } + ] + } + ], + "declaredValues": [ + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + }, + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + } + ], + "compliance": true, + "conformityTopic": "environment.energy", + "assessedProducts": [ + { + "type": [ + "Product", + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + }, + "IDverifiedByCAB": true + }, + { + "type": [ + "Product", + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + }, + "IDverifiedByCAB": true + } + ], + "assessedFacilities": [ + { + "type": [ + "Facility", + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + }, + "IDverifiedByCAB": true + }, + { + "type": [ + "Facility", + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + }, + "IDverifiedByCAB": true + } + ] + }, + { + "type": [ + "ConformityAssessment", + "Declaration" + ], + "id": "https://exampleCAB.com/38f73303-a39e-45a7-b8b7-e73517548f27/01", + "referenceStandard": { + "type": [ + "Standard" + ], + "id": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf", + "name": "GBA Battery Passport Greenhouse Gas Rulebook - V.2.0", + "issuingParty": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "issueDate": 2023 + }, + "referenceRegulation": { + "type": [ + "Regulation" + ], + "id": "https://www.legislation.gov.au/F2008L02309/latest/versions", + "name": "NNational Greenhouse and Energy Reporting (Measurement) Determination", + "jurisdictionCountry": "Enumeration Value", + "administeredBy": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "effectiveDate": 2024 + }, + "assessmentCriteria": [ + { + "type": [ + "Criterion" + ], + "id": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf#BatteryAssembly", + "name": "GBA Battery rule book v2.0 battery assembly guidelines.", + "thresholdValues": [ + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + }, + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + } + ] + }, + { + "type": [ + "Criterion" + ], + "id": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf#BatteryAssembly", + "name": "GBA Battery rule book v2.0 battery assembly guidelines.", + "thresholdValues": [ + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + }, + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + } + ] + } + ], + "declaredValues": [ + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + }, + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + } + ], + "compliance": true, + "conformityTopic": "environment.energy", + "assessedProducts": [ + { + "type": [ + "Product", + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + }, + "IDverifiedByCAB": true + }, + { + "type": [ + "Product", + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + }, + "IDverifiedByCAB": true + } + ], + "assessedFacilities": [ + { + "type": [ + "Facility", + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + }, + "IDverifiedByCAB": true + }, + { + "type": [ + "Facility", + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + }, + "IDverifiedByCAB": true + } + ] + } + ] + } +} \ No newline at end of file diff --git a/packages/untp-test-suite/credentials/DigitalProductPassport_instance-0.3.10.json b/packages/untp-test-suite/credentials/DigitalProductPassport_instance-0.3.10.json new file mode 100644 index 00000000..5dbaf0a4 --- /dev/null +++ b/packages/untp-test-suite/credentials/DigitalProductPassport_instance-0.3.10.json @@ -0,0 +1,542 @@ +{ + "type": [ + "DigitalProductPassport", + "VerifiableCredential" + ], + "@context": [ + "https://www.w3.org/ns/credentials/v2", + "https://test.uncefact.org/vocabulary/untp/dpp/0.3.10/", + "https://dev-render-method-context.s3.ap-southeast-1.amazonaws.com/dev-render-method-context.json" + ], + "id": "https://example-company.com/credentials/2a423366-a0d6-4855-ba65-2e0c926d09b0", + "issuer": { + "type": [ + "CredentialIssuer" + ], + "id": "did:web:identifiers.example-company.com:12345", + "name": "Example Company Pty Ltd", + "otherIdentifiers": [ + { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + } + ] + }, + "validFrom": "2024-03-15T12:00:00", + "validUntil": "2034-03-15T12:00:00", + "credentialSubject": { + "type": [ + "Product", + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + }, + "serialNumber": "12345678", + "batchNumber": "6789", + "productImage": { + "linkURL": "https://files.example-certifier.com/1234567.json", + "linkName": "GBA rule book conformity certificate", + "linkType": "https://test.uncefact.org/vocabulary/linkTypes/dcc" + }, + "description": "400Ah 24v LiFePO4 battery", + "productCategory": [ + { + "type": [ + "Classification" + ], + "id": "https://unstats.un.org/unsd/classifications/Econ/cpc/46410", + "code": "46410", + "name": "Primary cells and primary batteries", + "schemeID": "https://unstats.un.org/unsd/classifications/Econ/cpc/", + "schemeName": "UN Central Product Classification (CPC)" + }, + { + "type": [ + "Classification" + ], + "id": "https://unstats.un.org/unsd/classifications/Econ/cpc/46410", + "code": "46410", + "name": "Primary cells and primary batteries", + "schemeID": "https://unstats.un.org/unsd/classifications/Econ/cpc/", + "schemeName": "UN Central Product Classification (CPC)" + } + ], + "furtherInformation": [ + { + "linkURL": "https://files.example-certifier.com/1234567.json", + "linkName": "GBA rule book conformity certificate", + "linkType": "https://test.uncefact.org/vocabulary/linkTypes/dcc" + }, + { + "linkURL": "https://files.example-certifier.com/1234567.json", + "linkName": "GBA rule book conformity certificate", + "linkType": "https://test.uncefact.org/vocabulary/linkTypes/dcc" + } + ], + "producedByParty": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "producedAtFacility": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "dimensions": { + "weight": { + "value": 10, + "unit": "KGM" + }, + "length": { + "value": 10, + "unit": "KGM" + }, + "width": { + "value": 10, + "unit": "KGM" + }, + "height": { + "value": 10, + "unit": "KGM" + }, + "volume": { + "value": 10, + "unit": "KGM" + } + }, + "productionDate": "2024-04-25", + "countryOfProduction": "AU", + "materialsProvenance": [ + { + "name": "Lithium Spodumene", + "originCountry": "AU", + "materialType": { + "type": [ + "Classification" + ], + "id": "https://unstats.un.org/unsd/classifications/Econ/cpc/46410", + "code": "46410", + "name": "Primary cells and primary batteries", + "schemeID": "https://unstats.un.org/unsd/classifications/Econ/cpc/", + "schemeName": "UN Central Product Classification (CPC)" + }, + "massFraction": 0.2, + "recycledAmount": 0.5, + "hazardous": false, + "materialSafetyInformation": { + "linkURL": "https://files.example-certifier.com/1234567.json", + "linkName": "GBA rule book conformity certificate", + "linkType": "https://test.uncefact.org/vocabulary/linkTypes/dcc" + } + }, + { + "name": "Lithium Spodumene", + "originCountry": "AU", + "materialType": { + "type": [ + "Classification" + ], + "id": "https://unstats.un.org/unsd/classifications/Econ/cpc/46410", + "code": "46410", + "name": "Primary cells and primary batteries", + "schemeID": "https://unstats.un.org/unsd/classifications/Econ/cpc/", + "schemeName": "UN Central Product Classification (CPC)" + }, + "massFraction": 0.2, + "recycledAmount": 0.5, + "hazardous": false, + "materialSafetyInformation": { + "linkURL": "https://files.example-certifier.com/1234567.json", + "linkName": "GBA rule book conformity certificate", + "linkType": "https://test.uncefact.org/vocabulary/linkTypes/dcc" + } + } + ], + "conformityDeclarations": [ + { + "type": [ + "Declaration" + ], + "id": "https://products.example-company.com/09520123456788/declarations/12345", + "referenceStandard": { + "type": [ + "Standard" + ], + "id": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf", + "name": "GBA Battery Passport Greenhouse Gas Rulebook - V.2.0", + "issuingParty": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "issueDate": "2023-12-05" + }, + "referenceRegulation": { + "type": [ + "Regulation" + ], + "id": "https://www.legislation.gov.au/F2008L02309/latest/versions", + "name": "NNational Greenhouse and Energy Reporting (Measurement) Determination", + "jurisdictionCountry": "Enumeration Value", + "administeredBy": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "effectiveDate": "2024-03-20" + }, + "assessmentCriteria": [ + { + "type": [ + "Criterion" + ], + "id": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf#BatteryAssembly", + "name": "GBA Battery rule book v2.0 battery assembly guidelines.", + "thresholdValues": [ + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + }, + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + } + ] + }, + { + "type": [ + "Criterion" + ], + "id": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf#BatteryAssembly", + "name": "GBA Battery rule book v2.0 battery assembly guidelines.", + "thresholdValues": [ + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + }, + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + } + ] + } + ], + "declaredValues": [ + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + }, + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + } + ], + "compliance": true, + "conformityTopic": "environment.emissions", + "conformityEvidence": { + "linkURL": "https://files.example-certifier.com/1234567.json", + "linkName": "GBA rule book conformity certificate", + "linkType": "https://test.uncefact.org/vocabulary/linkTypes/dcc", + "hashDigest": "6239119", + "hashMethod": "SHA-256", + "encryptionMethod": "AES" + } + }, + { + "type": [ + "Declaration" + ], + "id": "https://products.example-company.com/09520123456788/declarations/12345", + "referenceStandard": { + "type": [ + "Standard" + ], + "id": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf", + "name": "GBA Battery Passport Greenhouse Gas Rulebook - V.2.0", + "issuingParty": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "issueDate": "2023-12-05" + }, + "referenceRegulation": { + "type": [ + "Regulation" + ], + "id": "https://www.legislation.gov.au/F2008L02309/latest/versions", + "name": "NNational Greenhouse and Energy Reporting (Measurement) Determination", + "jurisdictionCountry": "Enumeration Value", + "administeredBy": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "effectiveDate": "2024-03-20" + }, + "assessmentCriteria": [ + { + "type": [ + "Criterion" + ], + "id": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf#BatteryAssembly", + "name": "GBA Battery rule book v2.0 battery assembly guidelines.", + "thresholdValues": [ + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + }, + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + } + ] + }, + { + "type": [ + "Criterion" + ], + "id": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf#BatteryAssembly", + "name": "GBA Battery rule book v2.0 battery assembly guidelines.", + "thresholdValues": [ + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + }, + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + } + ] + } + ], + "declaredValues": [ + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + }, + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + } + ], + "compliance": true, + "conformityTopic": "environment.emissions", + "conformityEvidence": { + "linkURL": "https://files.example-certifier.com/1234567.json", + "linkName": "GBA rule book conformity certificate", + "linkType": "https://test.uncefact.org/vocabulary/linkTypes/dcc", + "hashDigest": "6239119", + "hashMethod": "SHA-256", + "encryptionMethod": "AES" + } + } + ], + "circularityScorecard": { + "recyclingInformation": { + "linkURL": "https://files.example-certifier.com/1234567.json", + "linkName": "GBA rule book conformity certificate", + "linkType": "https://test.uncefact.org/vocabulary/linkTypes/dcc" + }, + "repairInformation": { + "linkURL": "https://files.example-certifier.com/1234567.json", + "linkName": "GBA rule book conformity certificate", + "linkType": "https://test.uncefact.org/vocabulary/linkTypes/dcc" + }, + "recyclableContent": 0.5, + "recyecledContent": 0.3, + "utilityFactor": 1.2, + "materialCircularityIndicator": 0.67 + }, + "emissionsScorecard": { + "carbonFootprint": 1.8, + "declaredUnit": "KGM", + "operationalScope": "CradleToGate", + "primarySourcedRatio": 0.3, + "reportingStandard": { + "type": [ + "Standard" + ], + "id": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf", + "name": "GBA Battery Passport Greenhouse Gas Rulebook - V.2.0", + "issuingParty": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "issueDate": "2023-12-05" + } + }, + "traceabilityInformation": [ + { + "linkURL": "https://files.example-certifier.com/1234567.json", + "linkName": "GBA rule book conformity certificate", + "linkType": "https://test.uncefact.org/vocabulary/linkTypes/dcc", + "hashDigest": "6239119", + "hashMethod": "SHA-256", + "encryptionMethod": "AES" + }, + { + "linkURL": "https://files.example-certifier.com/1234567.json", + "linkName": "GBA rule book conformity certificate", + "linkType": "https://test.uncefact.org/vocabulary/linkTypes/dcc", + "hashDigest": "6239119", + "hashMethod": "SHA-256", + "encryptionMethod": "AES" + } + ] + } +} \ No newline at end of file diff --git a/packages/untp-test-suite/credentials/DigitalProductPassport_instance-0.3.9.json b/packages/untp-test-suite/credentials/DigitalProductPassport_instance-0.3.9.json new file mode 100644 index 00000000..bfaaf243 --- /dev/null +++ b/packages/untp-test-suite/credentials/DigitalProductPassport_instance-0.3.9.json @@ -0,0 +1,541 @@ +{ + "type": [ + "DigitalProductPassport", + "VerifiableCredential" + ], + "@context": [ + "https://www.w3.org/ns/credentials/v2", + "https://vocabulary.uncefact.org/untp/dpp/0.3.9/" + ], + "id": "https://example-company.com/credentials/2a423366-a0d6-4855-ba65-2e0c926d09b0", + "issuer": { + "type": [ + "CredentialIssuer" + ], + "id": "did:web:identifiers.example-company.com:12345", + "name": "Example Company Pty Ltd", + "otherIdentifiers": [ + { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + } + ] + }, + "validFrom": 2024, + "validUntil": 2034, + "credentialSubject": { + "type": [ + "Product", + "Entity" + ], + "id": "https://jargon.sh", + "name": "The quick brown fox jumps over the lazy dog.", + "registeredId": "The quick brown fox jumps over the lazy dog.", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + }, + "serialNumber": "The quick brown fox jumps over the lazy dog.", + "batchNumber": "The quick brown fox jumps over the lazy dog.", + "productImage": { + "linkURL": "https://files.example-certifier.com/1234567.json", + "linkName": "GBA rule book conformity certificate", + "linkType": "https://test.uncefact.org/vocabulary/linkTypes/dcc" + }, + "description": "The quick brown fox jumps over the lazy dog.", + "productCategory": [ + { + "type": [ + "Classification" + ], + "id": "https://unstats.un.org/unsd/classifications/Econ/cpc/46410", + "code": "46410", + "name": "Primary cells and primary batteries", + "schemeID": "https://unstats.un.org/unsd/classifications/Econ/cpc/", + "schemeName": "UN Central Product Classification (CPC)" + }, + { + "type": [ + "Classification" + ], + "id": "https://unstats.un.org/unsd/classifications/Econ/cpc/46410", + "code": "46410", + "name": "Primary cells and primary batteries", + "schemeID": "https://unstats.un.org/unsd/classifications/Econ/cpc/", + "schemeName": "UN Central Product Classification (CPC)" + } + ], + "furtherInformation": [ + { + "linkURL": "https://files.example-certifier.com/1234567.json", + "linkName": "GBA rule book conformity certificate", + "linkType": "https://test.uncefact.org/vocabulary/linkTypes/dcc" + }, + { + "linkURL": "https://files.example-certifier.com/1234567.json", + "linkName": "GBA rule book conformity certificate", + "linkType": "https://test.uncefact.org/vocabulary/linkTypes/dcc" + } + ], + "producedByParty": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "producedAtFacility": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "dimensions": { + "weight": { + "value": 10, + "unit": "KGM" + }, + "length": { + "value": 10, + "unit": "KGM" + }, + "width": { + "value": 10, + "unit": "KGM" + }, + "height": { + "value": 10, + "unit": "KGM" + }, + "volume": { + "value": 10, + "unit": "KGM" + } + }, + "productionDate": "1/1/1970", + "countryOfProduction": "Enumeration Value", + "materialsProvenance": [ + { + "name": "Lithium Spodumene", + "originCountry": "AU", + "materialType": { + "type": [ + "Classification" + ], + "id": "https://unstats.un.org/unsd/classifications/Econ/cpc/46410", + "code": "46410", + "name": "Primary cells and primary batteries", + "schemeID": "https://unstats.un.org/unsd/classifications/Econ/cpc/", + "schemeName": "UN Central Product Classification (CPC)" + }, + "massFraction": 0.2, + "recycledAmount": 0.5, + "hazardous": false, + "materialSafetyInformation": { + "linkURL": "https://files.example-certifier.com/1234567.json", + "linkName": "GBA rule book conformity certificate", + "linkType": "https://test.uncefact.org/vocabulary/linkTypes/dcc" + } + }, + { + "name": "Lithium Spodumene", + "originCountry": "AU", + "materialType": { + "type": [ + "Classification" + ], + "id": "https://unstats.un.org/unsd/classifications/Econ/cpc/46410", + "code": "46410", + "name": "Primary cells and primary batteries", + "schemeID": "https://unstats.un.org/unsd/classifications/Econ/cpc/", + "schemeName": "UN Central Product Classification (CPC)" + }, + "massFraction": 0.2, + "recycledAmount": 0.5, + "hazardous": false, + "materialSafetyInformation": { + "linkURL": "https://files.example-certifier.com/1234567.json", + "linkName": "GBA rule book conformity certificate", + "linkType": "https://test.uncefact.org/vocabulary/linkTypes/dcc" + } + } + ], + "conformityDeclarations": [ + { + "type": [ + "Declaration" + ], + "id": "https://jargon.sh", + "referenceStandard": { + "type": [ + "Standard" + ], + "id": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf", + "name": "GBA Battery Passport Greenhouse Gas Rulebook - V.2.0", + "issuingParty": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "issueDate": 2023 + }, + "referenceRegulation": { + "type": [ + "Regulation" + ], + "id": "https://www.legislation.gov.au/F2008L02309/latest/versions", + "name": "NNational Greenhouse and Energy Reporting (Measurement) Determination", + "jurisdictionCountry": "Enumeration Value", + "administeredBy": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "effectiveDate": 2024 + }, + "assessmentCriteria": [ + { + "type": [ + "Criterion" + ], + "id": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf#BatteryAssembly", + "name": "GBA Battery rule book v2.0 battery assembly guidelines.", + "thresholdValues": [ + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + }, + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + } + ] + }, + { + "type": [ + "Criterion" + ], + "id": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf#BatteryAssembly", + "name": "GBA Battery rule book v2.0 battery assembly guidelines.", + "thresholdValues": [ + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + }, + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + } + ] + } + ], + "declaredValues": [ + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + }, + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + } + ], + "compliance": true, + "conformityTopic": "environment.energy", + "conformityEvidence": { + "linkURL": "https://files.example-certifier.com/1234567.json", + "linkName": "GBA rule book conformity certificate", + "linkType": "https://test.uncefact.org/vocabulary/linkTypes/dcc", + "hashDigest": "6239119", + "hashMethod": "SHA-256", + "encryptionMethod": "AES" + } + }, + { + "type": [ + "Declaration" + ], + "id": "https://jargon.sh", + "referenceStandard": { + "type": [ + "Standard" + ], + "id": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf", + "name": "GBA Battery Passport Greenhouse Gas Rulebook - V.2.0", + "issuingParty": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "issueDate": 2023 + }, + "referenceRegulation": { + "type": [ + "Regulation" + ], + "id": "https://www.legislation.gov.au/F2008L02309/latest/versions", + "name": "NNational Greenhouse and Energy Reporting (Measurement) Determination", + "jurisdictionCountry": "Enumeration Value", + "administeredBy": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "effectiveDate": 2024 + }, + "assessmentCriteria": [ + { + "type": [ + "Criterion" + ], + "id": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf#BatteryAssembly", + "name": "GBA Battery rule book v2.0 battery assembly guidelines.", + "thresholdValues": [ + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + }, + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + } + ] + }, + { + "type": [ + "Criterion" + ], + "id": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf#BatteryAssembly", + "name": "GBA Battery rule book v2.0 battery assembly guidelines.", + "thresholdValues": [ + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + }, + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + } + ] + } + ], + "declaredValues": [ + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + }, + { + "metricName": "GHG emissions intensity", + "metricValue": { + "value": 10, + "unit": "KGM" + }, + "accuracy": 0.05 + } + ], + "compliance": true, + "conformityTopic": "environment.energy", + "conformityEvidence": { + "linkURL": "https://files.example-certifier.com/1234567.json", + "linkName": "GBA rule book conformity certificate", + "linkType": "https://test.uncefact.org/vocabulary/linkTypes/dcc", + "hashDigest": "6239119", + "hashMethod": "SHA-256", + "encryptionMethod": "AES" + } + } + ], + "circularityScorecard": { + "recyclingInformation": { + "linkURL": "https://files.example-certifier.com/1234567.json", + "linkName": "GBA rule book conformity certificate", + "linkType": "https://test.uncefact.org/vocabulary/linkTypes/dcc" + }, + "repairInformation": { + "linkURL": "https://files.example-certifier.com/1234567.json", + "linkName": "GBA rule book conformity certificate", + "linkType": "https://test.uncefact.org/vocabulary/linkTypes/dcc" + }, + "recyclableContent": 0.5, + "recyecledContent": 0.3, + "utilityFactor": 1.2, + "materialCircularityIndicator": 0.67 + }, + "emissionsScorecard": { + "carbonFootprint": 1.8, + "declaredUnit": "KGM", + "operationalScope": "Scope123toGate", + "primarySourcedRatio": 0.3, + "reportingStandard": { + "type": [ + "Standard" + ], + "id": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf", + "name": "GBA Battery Passport Greenhouse Gas Rulebook - V.2.0", + "issuingParty": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "issueDate": 2023 + } + }, + "traceabilityInformation": [ + { + "linkURL": "https://files.example-certifier.com/1234567.json", + "linkName": "GBA rule book conformity certificate", + "linkType": "https://test.uncefact.org/vocabulary/linkTypes/dcc", + "hashDigest": "6239119", + "hashMethod": "SHA-256", + "encryptionMethod": "AES" + }, + { + "linkURL": "https://files.example-certifier.com/1234567.json", + "linkName": "GBA rule book conformity certificate", + "linkType": "https://test.uncefact.org/vocabulary/linkTypes/dcc", + "hashDigest": "6239119", + "hashMethod": "SHA-256", + "encryptionMethod": "AES" + } + ] + } +} \ No newline at end of file diff --git a/packages/untp-test-suite/credentials/DigitalTraceabilityEvent_instance-0.3.10.json b/packages/untp-test-suite/credentials/DigitalTraceabilityEvent_instance-0.3.10.json new file mode 100644 index 00000000..d3b87a3d --- /dev/null +++ b/packages/untp-test-suite/credentials/DigitalTraceabilityEvent_instance-0.3.10.json @@ -0,0 +1,449 @@ +{ + "type": [ + "DigitalTraceabilityEvent", + "VerifiableCredential" + ], + "id": "https://example-company.com/credentials/2a423366-a0d6-4855-ba65-2e0c926d09b0", + "@context": [ + "https://www.w3.org/ns/credentials/v2", + "https://test.uncefact.org/vocabulary/untp/dte/0.3.10", + "https://dev-render-method-context.s3.ap-southeast-1.amazonaws.com/dev-render-method-context.json" + ], + "issuer": { + "type": [ + "CredentialIssuer" + ], + "id": "did:web:identifiers.example-company.com:12345", + "name": "Example Company Pty Ltd", + "otherIdentifiers": [ + { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + } + ] + }, + "validFrom": "2024-03-15T12:00:00", + "credentialSubject": [ + { + "type": [ + "TransformationEvent", + "Event" + ], + "id": "https://events.sample.com/b681df10-c682-454a-b11b-d0b9374c01bd", + "eventTime": "2024-09-01T12:00:00", + "action": "add", + "disposition": "https://ref.gs1.org/cbv/Disp-active", + "bizStep": "https://ref.gs1.org/cbv/BizStep-commissioning", + "bizLocation": "https://id.gs1.org/414/9520123456788", + "sensorElementList": [ + { + "sensorMetadata": { + "device": { + "type": [ + "Item", + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "dataProcessingMethod": "https://standards.org/sensorMethod#1234" + }, + "sensorReport": [ + { + "time": "2024-07-24T12:00:00", + "sensorType": "https://samplesensors.com/model1234", + "value": 25, + "uom": "KGM" + }, + { + "time": "2024-07-24T12:00:00", + "sensorType": "https://samplesensors.com/model1234", + "value": 25, + "uom": "KGM" + } + ], + "sensorIntegrityProof": "https://jargon.sh" + }, + { + "sensorMetadata": { + "device": { + "type": [ + "Item", + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "dataProcessingMethod": "https://standards.org/sensorMethod#1234" + }, + "sensorReport": [ + { + "time": "2024-07-24T12:00:00", + "sensorType": "https://samplesensors.com/model1234", + "value": 25, + "uom": "KGM" + }, + { + "time": "2024-07-24T12:00:00", + "sensorType": "https://samplesensors.com/model1234", + "value": 25, + "uom": "KGM" + } + ], + "sensorIntegrityProof": "https://jargon.sh" + } + ], + "outputEPCList": [ + { + "type": [ + "Item", + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + { + "type": [ + "Item", + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + } + ], + "inputEPCList": [ + { + "type": [ + "Item", + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + { + "type": [ + "Item", + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + } + ], + "inputQuantityList": [ + { + "product": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "quantity": 20, + "uom": "KGM" + }, + { + "product": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "quantity": 20, + "uom": "KGM" + } + ], + "outputQuantityList": [ + { + "product": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "quantity": 20, + "uom": "KGM" + }, + { + "product": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "quantity": 20, + "uom": "KGM" + } + ], + "processType": "https://textileIndustry.org/spinning" + }, + { + "type": [ + "ObjectEvent", + "Event" + ], + "id": "https://events.sample.com/b681df10-c682-454a-b11b-d0b9374c01bd", + "eventTime": "2024-09-01T12:00:00", + "action": "add", + "disposition": "https://ref.gs1.org/cbv/Disp-active", + "bizStep": "https://ref.gs1.org/cbv/BizStep-commissioning", + "bizLocation": "https://id.gs1.org/414/9520123456788", + "sensorElementList": [ + { + "sensorMetadata": { + "device": { + "type": [ + "Item", + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "dataProcessingMethod": "https://standards.org/sensorMethod#1234" + }, + "sensorReport": [ + { + "time": "2024-07-24T12:00:00", + "sensorType": "https://samplesensors.com/model1234", + "value": 25, + "uom": "KGM" + }, + { + "time": "2024-07-24T12:00:00", + "sensorType": "https://samplesensors.com/model1234", + "value": 25, + "uom": "KGM" + } + ], + "sensorIntegrityProof": "https://jargon.sh" + }, + { + "sensorMetadata": { + "device": { + "type": [ + "Item", + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "dataProcessingMethod": "https://standards.org/sensorMethod#1234" + }, + "sensorReport": [ + { + "time": "2024-07-24T12:00:00", + "sensorType": "https://samplesensors.com/model1234", + "value": 25, + "uom": "KGM" + }, + { + "time": "2024-07-24T12:00:00", + "sensorType": "https://samplesensors.com/model1234", + "value": 25, + "uom": "KGM" + } + ], + "sensorIntegrityProof": "https://jargon.sh" + } + ], + "epcList": [ + { + "type": [ + "Item", + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + { + "type": [ + "Item", + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + } + ], + "quantityList": [ + { + "product": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "quantity": 20, + "uom": "KGM" + }, + { + "product": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "quantity": 20, + "uom": "KGM" + } + ] + } + ] +} \ No newline at end of file diff --git a/packages/untp-test-suite/credentials/DigitalTraceabilityEvent_instance-0.3.9.json b/packages/untp-test-suite/credentials/DigitalTraceabilityEvent_instance-0.3.9.json new file mode 100644 index 00000000..c44b7310 --- /dev/null +++ b/packages/untp-test-suite/credentials/DigitalTraceabilityEvent_instance-0.3.9.json @@ -0,0 +1,449 @@ +{ + "type": [ + "DigitalTraceabilityEvent", + "VerifiableCredential" + ], + "@context": [ + "https://www.w3.org/ns/credentials/v2", + "https://vocabulary.uncefact.org/untp/dte/0.3.9" + ], + "id": "https://example-company.com/credentials/2a423366-a0d6-4855-ba65-2e0c926d09b0", + "issuer": { + "type": [ + "CredentialIssuer" + ], + "id": "did:web:identifiers.example-company.com:12345", + "name": "Example Company Pty Ltd", + "otherIdentifiers": [ + { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + } + ] + }, + "validFrom": 2024, + "validUntil": 2034, + "credentialSubject": [ + { + "type": [ + "TransformationEvent", + "Event" + ], + "id": "https://jargon.sh", + "eventTime": "1970-01-01T00:00:00Z", + "action": "observe", + "disposition": "Enumeration Value", + "bizStep": "Enumeration Value", + "bizLocation": "https://jargon.sh", + "sensorElementList": [ + { + "sensorMetadata": { + "device": { + "type": [ + "Item", + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "dataProcessingMethod": "https://jargon.sh" + }, + "sensorReport": [ + { + "time": "1970-01-01T00:00:00Z", + "sensorType": "https://jargon.sh", + "value": 12345, + "uom": "Enumeration Value" + }, + { + "time": "1970-01-01T00:00:00Z", + "sensorType": "https://jargon.sh", + "value": 12345, + "uom": "Enumeration Value" + } + ], + "sensorIntegrityProof": "https://jargon.sh" + }, + { + "sensorMetadata": { + "device": { + "type": [ + "Item", + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "dataProcessingMethod": "https://jargon.sh" + }, + "sensorReport": [ + { + "time": "1970-01-01T00:00:00Z", + "sensorType": "https://jargon.sh", + "value": 12345, + "uom": "Enumeration Value" + }, + { + "time": "1970-01-01T00:00:00Z", + "sensorType": "https://jargon.sh", + "value": 12345, + "uom": "Enumeration Value" + } + ], + "sensorIntegrityProof": "https://jargon.sh" + } + ], + "outputEPCList": [ + { + "type": [ + "Item", + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + { + "type": [ + "Item", + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + } + ], + "inputEPCList": [ + { + "type": [ + "Item", + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + { + "type": [ + "Item", + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + } + ], + "inputQuantityList": [ + { + "product": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "quantity": 12345, + "uom": "Enumeration Value" + }, + { + "product": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "quantity": 12345, + "uom": "Enumeration Value" + } + ], + "outputQuantityList": [ + { + "product": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "quantity": 12345, + "uom": "Enumeration Value" + }, + { + "product": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "quantity": 12345, + "uom": "Enumeration Value" + } + ], + "processType": "https://jargon.sh" + }, + { + "type": [ + "ObjectEvent", + "Event" + ], + "id": "https://jargon.sh", + "eventTime": "1970-01-01T00:00:00Z", + "action": "observe", + "disposition": "Enumeration Value", + "bizStep": "Enumeration Value", + "bizLocation": "https://jargon.sh", + "sensorElementList": [ + { + "sensorMetadata": { + "device": { + "type": [ + "Item", + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "dataProcessingMethod": "https://jargon.sh" + }, + "sensorReport": [ + { + "time": "1970-01-01T00:00:00Z", + "sensorType": "https://jargon.sh", + "value": 12345, + "uom": "Enumeration Value" + }, + { + "time": "1970-01-01T00:00:00Z", + "sensorType": "https://jargon.sh", + "value": 12345, + "uom": "Enumeration Value" + } + ], + "sensorIntegrityProof": "https://jargon.sh" + }, + { + "sensorMetadata": { + "device": { + "type": [ + "Item", + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "dataProcessingMethod": "https://jargon.sh" + }, + "sensorReport": [ + { + "time": "1970-01-01T00:00:00Z", + "sensorType": "https://jargon.sh", + "value": 12345, + "uom": "Enumeration Value" + }, + { + "time": "1970-01-01T00:00:00Z", + "sensorType": "https://jargon.sh", + "value": 12345, + "uom": "Enumeration Value" + } + ], + "sensorIntegrityProof": "https://jargon.sh" + } + ], + "epcList": [ + { + "type": [ + "Item", + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + { + "type": [ + "Item", + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + } + ], + "quantityList": [ + { + "product": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "quantity": 12345, + "uom": "Enumeration Value" + }, + { + "product": { + "type": [ + "Entity" + ], + "id": "https://id.gs1.org/01/09520123456788/21/12345", + "name": "EV battery 300Ah.", + "registeredId": "90664869327", + "idScheme": { + "type": [ + "IdentifierScheme" + ], + "id": "https://id.gs1.org/01/", + "name": "Global Trade Identification Number (GTIN)" + } + }, + "quantity": 12345, + "uom": "Enumeration Value" + } + ] + } + ] +} \ No newline at end of file diff --git a/packages/untp-test-suite/src/schemas/aggregationEvent/v0.3.9/schema.json b/packages/untp-test-suite/src/schemas/aggregationEvent/v0.3.9/schema.json new file mode 100644 index 00000000..f24d452c --- /dev/null +++ b/packages/untp-test-suite/src/schemas/aggregationEvent/v0.3.9/schema.json @@ -0,0 +1,817 @@ +{ + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "DigitalTraceabilityEvent", + "VerifiableCredential" + ], + "default": [ + "DigitalTraceabilityEvent", + "VerifiableCredential" + ], + "items": { + "type": "string", + "enum": [ + "DigitalTraceabilityEvent", + "VerifiableCredential" + ] + } + }, + "@context": { + "example": "https://test.uncefact.org/vocabulary/untp/dpp/dpp-context.jsonld", + "type": "array", + "items": { + "type": "string", + "enum": [ + "https://www.w3.org/ns/credentials/v2", + "https://vocabulary.uncefact.org/untp/dte/{{version}}" + ] + }, + "description": "A list of JSON-LD context URIs that define the seamntic meaning of prperties within the credential. ", + "readOnly": true, + "const": [ + "https://www.w3.org/ns/credentials/v2", + "https://vocabulary.uncefact.org/untp/dte/{{version}}" + ], + "default": [ + "https://www.w3.org/ns/credentials/v2", + "https://vocabulary.uncefact.org/untp/dte/{{version}}" + ] + }, + "id": { + "example": "https://example-company.com/credentials/2a423366-a0d6-4855-ba65-2e0c926d09b0", + "type": "string", + "format": "uri", + "description": "A unique identifier (URI) assigned to the product passport. May be a UUID" + }, + "issuer": { + "$ref": "#/$defs/CredentialIssuer", + "description": "The organisation that is the isuer of this VC. Note that the \"id\" property MUST be a W3C DID. Other identifiers such as tax registration numbers can be listed in the \"otherIdentifiers\" property." + }, + "validFrom": { + "example": "2024-03-15", + "type": "string", + "format": "date-time", + "description": "The date and time from which the credential is valid." + }, + "validUntil": { + "example": "2034-03-15", + "type": "string", + "format": "date-time", + "description": "The expiry date (if applicable) of this verifiable credential." + }, + "credentialSubject": { + "type": "array", + "items": { + "$ref": "#/$defs/Event" + }, + "description": "VC subject is the transaction event structure" + } + }, + "description": "Traceability Event as a VC", + "required": [ + "@context", + "id", + "issuer" + ], + "$schema": "https://json-schema.org/draft/2020-12/schema", + "$defs": { + "CredentialIssuer": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "default": "CredentialIssuer", + "enum": [ + "CredentialIssuer" + ] + }, + "id": { + "example": "did:web:identifiers.example-company.com:12345", + "type": "string", + "format": "uri", + "description": "The W3C DID of the issuer - should be a did:web or did:tdw" + }, + "name": { + "example": "Example Company Pty Ltd", + "type": "string", + "description": "The name of the issuer person or organisation" + }, + "otherIdentifiers": { + "type": "array", + "items": { + "$ref": "#/$defs/Entity" + }, + "description": "An optional list of other registered identifiers for this credential issuer " + } + }, + "description": "The issuer party ()person or orgnaition) of a verifiable credential.", + "required": [ + "id", + "name" + ] + }, + "Entity": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "default": "Entity", + "enum": [ + "Entity" + ] + }, + "id": { + "example": "https://id.gs1.org/01/09520123456788/21/12345", + "type": "string", + "format": "uri", + "description": "The globally unique ID of the entity as a resolvable URL according to ISO 18975. ExamplesProduct - id.gs1.org/01/09520123456788/21/12345 Party - abr.business.gov.au/ABN/View?abn=90664869327. Facility - did:web:facilities.example-company.com:123. " + }, + "name": { + "example": "EV battery 300Ah.", + "type": "string", + "description": "The registered name of the entity within the identifier scheme. Examplesproduct - EV battery 300Ahparty - Sample Company Pty Ltd. facility - Greenacres battery factory" + }, + "registeredId": { + "example": "90664869327", + "type": "string", + "description": "The registration number (alphanumeric) of the entity within the register. Unique within the register." + }, + "idScheme": { + "$ref": "#/$defs/IdentifierScheme", + "description": "The identifier scheme. Exampleproduct - id.gs1.org/01. party - business.gov.au/abn facility - did:web:facilities.acme.com. " + } + }, + "description": "The ID and Name of an identified entity such qs a product, facility, party, standard, etc. If the identifier is a W3C DID then the corresponding DID document SHOULD include a serviceEndpoint of type \"IdentityResolver\". If the identifier is not a W3C DID then the id peroperty SHOULD be an identity resolver URL.", + "required": [ + "id", + "name" + ] + }, + "IdentifierScheme": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "default": "IdentifierScheme", + "enum": [ + "IdentifierScheme" + ] + }, + "id": { + "example": "https://id.gs1.org/01/", + "type": "string", + "format": "uri", + "description": "The globally unique identifier of the registration scheme. The scheme should be registered and discoverable from vocabulary.uncefact.org/identifierSchemes" + }, + "name": { + "example": "Global Trade Identification Number (GTIN)", + "type": "string", + "description": "The name of the identifier scheme. " + } + }, + "description": "An identifier registration scheme for products, facilities, or organisations. Typically operated by a state, national or gloabl authority." + }, + "TransformationEvent": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "TransformationEvent", + "Event" + ], + "default": [ + "TransformationEvent", + "Event" + ], + "items": { + "type": "string", + "enum": [ + "TransformationEvent", + "Event" + ] + } + }, + "id": { + "readOnly": true, + "type": "string", + "format": "uri", + "description": "The unique identifier of this event - SHOULD be a UUID" + }, + "eventTime": { + "type": "string", + "format": "date-time", + "description": "The ISO-8601 date time when the event occurred." + }, + "action": { + "type": "string", + "enum": [ + "observe", + "add", + "delete" + ], + "example": "observe", + "description": "Code describing how an event relates to the lifecycle of the entity impacted by the event." + }, + "disposition": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/Disp", + "description": "Disposition code describing the state of the item after the event. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/Disp\n " + }, + "bizStep": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/BizStep", + "description": "A business step code drawn from a controlled vocabulary. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/BizStep\n " + }, + "bizLocation": { + "type": "string", + "format": "uri", + "description": "A Business Location is a uniquely identified and discretely recorded geospatial location that is meant to designate the specific place where an object is assumed to be following an EPCIS event until it is reported to be at a different Business Location by a subsequent EPCIS event. The bizLocation must be a resolvable URI that links to facility information and geolocation data." + }, + "sensorElementList": { + "type": "array", + "items": { + "$ref": "#/$defs/SensorElement" + }, + "description": "An array (one for each sensor) of sensor device data sets associated with the event. " + }, + "outputEPCList": { + "type": "array", + "items": { + "$ref": "#/$defs/Item" + }, + "description": "The list of uniquely identified items that are the output of this transformation event - for example a list of individually identified bolts of cloth that are the output of a weaving process." + }, + "inputEPCList": { + "type": "array", + "items": { + "$ref": "#/$defs/Item" + }, + "description": "The list of uniquely identified items that are the input of this transformation event - for example a list of individually identified bobbins of yarn that are the input of a weaving process." + }, + "inputQuantityList": { + "type": "array", + "items": { + "$ref": "#/$defs/QuantityElement" + }, + "description": "The quantified list of product classes that are the input of this transformation event - used when each item does not have a unique identity. for example the weight of raw cotton that is the input to a ginning process." + }, + "outputQuantityList": { + "type": "array", + "items": { + "$ref": "#/$defs/QuantityElement" + }, + "description": "The quantified list of product classes that are the output of this transformation event - used when each item does not have a unique identity. for example a count of the bales of cleaned cotton that are the output of a ginning process." + }, + "processType": { + "type": "string", + "format": "uri", + "description": "An industry specific process type code. " + } + }, + "description": "Transformation represents an event in which input objects are fully or partially consumed and output objects are produced, such that any of the input objects may have contributed to all of the output objects - for example consuming bales of cotton to produce yarn." + }, + "SensorElement": { + "type": "object", + "additionalProperties": false, + "properties": { + "sensorMetadata": { + "$ref": "#/$defs/Sensor", + "description": "Data that describes the physical sensor that recorded the sensor data set." + }, + "sensorReport": { + "type": "array", + "items": { + "$ref": "#/$defs/SensorData" + }, + "description": "A list of sensor readings from the given sensor relevant to the traceability event context." + }, + "sensorIntegrityProof": { + "type": "string", + "format": "uri", + "description": "An optional reference to a verifiable credential signed by the sensor device or device manufacturer that contains the digitally signed raw data associated with this sensor report." + } + }, + "description": "A SensorElement is used to carry data related to an event that is captured one sensor such as an IoT device. Include one sensor property and an array of sensor data values." + }, + "Sensor": { + "type": "object", + "additionalProperties": false, + "properties": { + "device": { + "$ref": "#/$defs/Item", + "description": "The device Identifier for the sensor as a URI (typically an EPC)" + }, + "dataProcessingMethod": { + "type": "string", + "format": "uri", + "description": "The data processing method used by the sensor - should reference a documented standard criteria as a URI" + } + }, + "description": "A physical sensor that records a sensor data set." + }, + "Item": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "Item", + "Entity" + ], + "default": [ + "Item", + "Entity" + ], + "items": { + "type": "string", + "enum": [ + "Item", + "Entity" + ] + } + }, + "id": { + "example": "https://id.gs1.org/01/09520123456788/21/12345", + "type": "string", + "format": "uri", + "description": "The globally unique ID of the entity as a resolvable URL according to ISO 18975. ExamplesProduct - id.gs1.org/01/09520123456788/21/12345 Party - abr.business.gov.au/ABN/View?abn=90664869327. Facility - did:web:facilities.example-company.com:123. " + }, + "name": { + "example": "EV battery 300Ah.", + "type": "string", + "description": "The registered name of the entity within the identifier scheme. Examplesproduct - EV battery 300Ahparty - Sample Company Pty Ltd. facility - Greenacres battery factory" + }, + "registeredId": { + "example": "90664869327", + "type": "string", + "description": "The registration number (alphanumeric) of the entity within the register. Unique within the register." + }, + "idScheme": { + "$ref": "#/$defs/IdentifierScheme", + "description": "The identifier scheme. Exampleproduct - id.gs1.org/01. party - business.gov.au/abn facility - did:web:facilities.acme.com. " + } + }, + "description": "A specific serilaised trade item which is a type of a more generic product. Typically an SGTIN", + "required": [ + "id", + "name" + ] + }, + "SensorData": { + "type": "object", + "additionalProperties": false, + "properties": { + "time": { + "type": "string", + "format": "date-time", + "description": "the timestamp at which the sensor reading was made." + }, + "sensorType": { + "type": "string", + "format": "uri", + "description": "the measurement type of the sensor reading, as a URI reference to a measurement method specification." + }, + "value": { + "type": "number", + "description": "the sensor reading" + }, + "uom": { + "type": "string", + "x-external-enumeration": "https://vocabulary.uncefact.org/UnitMeasureCode", + "description": "the unit of measure for the sensor reading\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://vocabulary.uncefact.org/UnitMeasureCode\n " + } + }, + "description": "A data point read by a sensor." + }, + "QuantityElement": { + "type": "object", + "additionalProperties": false, + "properties": { + "product": { + "$ref": "#/$defs/Entity", + "description": "THe identifier of a product class (as opposed to a product instance) such as a GTIN code for a manufactured product." + }, + "quantity": { + "type": "number", + "description": "The numeric quantity of the product class (eg 100 kg of cotton)" + }, + "uom": { + "type": "string", + "x-external-enumeration": "https://vocabulary.uncefact.org/UnitMeasureCode", + "description": "The unit of measure for the quantity value (eg Kg or meters etc) using the UNECE Rec 20 unit of measure codelist.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://vocabulary.uncefact.org/UnitMeasureCode\n " + } + }, + "description": "The quantity element is used to define the quantities (eg 100), units of measure (eg Kg) and product class (eg GTIN or other class identifier) of products that are inputs or outputs or the subject of supply chain events. ", + "required": [ + "quantity" + ] + }, + "ObjectEvent": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "ObjectEvent", + "Event" + ], + "default": [ + "ObjectEvent", + "Event" + ], + "items": { + "type": "string", + "enum": [ + "ObjectEvent", + "Event" + ] + } + }, + "id": { + "readOnly": true, + "type": "string", + "format": "uri", + "description": "The unique identifier of this event - SHOULD be a UUID" + }, + "eventTime": { + "type": "string", + "format": "date-time", + "description": "The ISO-8601 date time when the event occurred." + }, + "action": { + "type": "string", + "enum": [ + "observe", + "add", + "delete" + ], + "example": "observe", + "description": "Code describing how an event relates to the lifecycle of the entity impacted by the event." + }, + "disposition": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/Disp", + "description": "Disposition code describing the state of the item after the event. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/Disp\n " + }, + "bizStep": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/BizStep", + "description": "A business step code drawn from a controlled vocabulary. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/BizStep\n " + }, + "bizLocation": { + "type": "string", + "format": "uri", + "description": "A Business Location is a uniquely identified and discretely recorded geospatial location that is meant to designate the specific place where an object is assumed to be following an EPCIS event until it is reported to be at a different Business Location by a subsequent EPCIS event. The bizLocation must be a resolvable URI that links to facility information and geolocation data." + }, + "sensorElementList": { + "type": "array", + "items": { + "$ref": "#/$defs/SensorElement" + }, + "description": "An array (one for each sensor) of sensor device data sets associated with the event. " + }, + "epcList": { + "type": "array", + "items": { + "$ref": "#/$defs/Item" + }, + "description": "A list of uniquely identified items (eg specific items serial numbers or tagged shipments / packages) that are the focus of this object event. " + }, + "quantityList": { + "type": "array", + "items": { + "$ref": "#/$defs/QuantityElement" + }, + "description": "A quantified list of product classes (eg GS1 GTINs) that are the focus of this object event" + } + }, + "description": "Object represents an event that happened to one or more physical or digital objects - such as an inspection or certification of a product or shipment. The physical objects may be identified either as specific items (eg a unique consignment number) or as a quantified amount of a product class (eg 100Kg of cotton yarn)" + }, + "AggregationEvent": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "AggregationEvent", + "Event" + ], + "default": [ + "AggregationEvent", + "Event" + ], + "items": { + "type": "string", + "enum": [ + "AggregationEvent", + "Event" + ] + } + }, + "id": { + "readOnly": true, + "type": "string", + "format": "uri", + "description": "The unique identifier of this event - SHOULD be a UUID" + }, + "eventTime": { + "type": "string", + "format": "date-time", + "description": "The ISO-8601 date time when the event occurred." + }, + "action": { + "type": "string", + "enum": [ + "observe", + "add", + "delete" + ], + "example": "observe", + "description": "Code describing how an event relates to the lifecycle of the entity impacted by the event." + }, + "disposition": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/Disp", + "description": "Disposition code describing the state of the item after the event. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/Disp\n " + }, + "bizStep": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/BizStep", + "description": "A business step code drawn from a controlled vocabulary. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/BizStep\n " + }, + "bizLocation": { + "type": "string", + "format": "uri", + "description": "A Business Location is a uniquely identified and discretely recorded geospatial location that is meant to designate the specific place where an object is assumed to be following an EPCIS event until it is reported to be at a different Business Location by a subsequent EPCIS event. The bizLocation must be a resolvable URI that links to facility information and geolocation data." + }, + "sensorElementList": { + "type": "array", + "items": { + "$ref": "#/$defs/SensorElement" + }, + "description": "An array (one for each sensor) of sensor device data sets associated with the event. " + }, + "parentEPC": { + "$ref": "#/$defs/Item", + "description": "The unique item identifier that is the result of this aggregation. Typically a packaging ID used in shipments that represents a box/ pallet / container of contained items." + }, + "childEPCs": { + "type": "array", + "items": { + "$ref": "#/$defs/Item" + }, + "description": "The list of child items that have been aggregated into the parent (or dis-aggregated from the parent). Maybe a list of package references (eg boxes on a pallet) or may be individual items (eg products in a box)." + }, + "childQuantityList": { + "type": "array", + "items": { + "$ref": "#/$defs/QuantityElement" + }, + "description": "List of quantified product classes that have been aggregated into the parent. Used whwn the child items do not have unique identifiers (eg 100 Kg of cotton bales)" + } + }, + "description": "Aggregation represents an event that happened to one or more objects that are physically aggregated together (physically constrained to be in the same place at the same time, as when cases are aggregated to a pallet). This event is also used to represent de-aggregation (eg unpacking) when businessStepCode is unpacking." + }, + "TransactionEvent": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "TransactionEvent", + "Event" + ], + "default": [ + "TransactionEvent", + "Event" + ], + "items": { + "type": "string", + "enum": [ + "TransactionEvent", + "Event" + ] + } + }, + "id": { + "readOnly": true, + "type": "string", + "format": "uri", + "description": "The unique identifier of this event - SHOULD be a UUID" + }, + "eventTime": { + "type": "string", + "format": "date-time", + "description": "The ISO-8601 date time when the event occurred." + }, + "action": { + "type": "string", + "enum": [ + "observe", + "add", + "delete" + ], + "example": "observe", + "description": "Code describing how an event relates to the lifecycle of the entity impacted by the event." + }, + "disposition": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/Disp", + "description": "Disposition code describing the state of the item after the event. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/Disp\n " + }, + "bizStep": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/BizStep", + "description": "A business step code drawn from a controlled vocabulary. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/BizStep\n " + }, + "bizLocation": { + "type": "string", + "format": "uri", + "description": "A Business Location is a uniquely identified and discretely recorded geospatial location that is meant to designate the specific place where an object is assumed to be following an EPCIS event until it is reported to be at a different Business Location by a subsequent EPCIS event. The bizLocation must be a resolvable URI that links to facility information and geolocation data." + }, + "sensorElementList": { + "type": "array", + "items": { + "$ref": "#/$defs/SensorElement" + }, + "description": "An array (one for each sensor) of sensor device data sets associated with the event. " + }, + "sourceParty": { + "$ref": "#/$defs/Entity", + "description": "The source party for this supply chain transaction - typically the seller party" + }, + "destinationParty": { + "$ref": "#/$defs/Entity", + "description": "The destination party for this supply chain transaction - typically the buyer party." + }, + "epcList": { + "type": "array", + "items": { + "$ref": "#/$defs/Item" + }, + "description": "The list of uniquely identified trade items included in this supply chain transaction." + }, + "quantityList": { + "type": "array", + "items": { + "$ref": "#/$defs/QuantityElement" + }, + "description": "List of quantified product classes that are included in this transaction. Used when the trade items do not have unique identifiers (eg 100 reels of yarn)" + }, + "referenceDocument": { + "$ref": "#/$defs/TradeDocument", + "description": "The supply chain document reference for this transaction event - eg the invoice, order, or dispatch advice" + } + }, + "description": "Transaction represents an event in which one or more objects become associated or disassociated with one or more identified business transactions - such as the purchase / shipment of goods between buyer and seller." + }, + "TradeDocument": { + "type": "object", + "additionalProperties": false, + "properties": { + "documentType": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/BTT", + "description": "The document type representing the trade transaction drawn from the business transaction type vocabulary.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/BTT\n " + }, + "identifier": { + "type": "string", + "description": "The identifier of the trade transaction document - eg an invoice number or bill of lading number. Must be unique for a given source party" + }, + "documentURL": { + "type": "string", + "format": "uri", + "description": "The URL of the referenced trade document. For integrity reasons, it is recommended (but not required) that the documentURL is a hashlink (https://w3c-ccg.github.io/hashlink/) so that if the document the URL is changed then the hash verification will fail." + } + }, + "description": "A trade transaction between two parties such as an invoice, purchase order, or shipping notification." + }, + "AssociationEvent": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "AssociationEvent", + "Event" + ], + "default": [ + "AssociationEvent", + "Event" + ], + "items": { + "type": "string", + "enum": [ + "AssociationEvent", + "Event" + ] + } + }, + "id": { + "readOnly": true, + "type": "string", + "format": "uri", + "description": "The unique identifier of this event - SHOULD be a UUID" + }, + "eventTime": { + "type": "string", + "format": "date-time", + "description": "The ISO-8601 date time when the event occurred." + }, + "action": { + "type": "string", + "enum": [ + "observe", + "add", + "delete" + ], + "example": "observe", + "description": "Code describing how an event relates to the lifecycle of the entity impacted by the event." + }, + "disposition": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/Disp", + "description": "Disposition code describing the state of the item after the event. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/Disp\n " + }, + "bizStep": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/BizStep", + "description": "A business step code drawn from a controlled vocabulary. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/BizStep\n " + }, + "bizLocation": { + "type": "string", + "format": "uri", + "description": "A Business Location is a uniquely identified and discretely recorded geospatial location that is meant to designate the specific place where an object is assumed to be following an EPCIS event until it is reported to be at a different Business Location by a subsequent EPCIS event. The bizLocation must be a resolvable URI that links to facility information and geolocation data." + }, + "sensorElementList": { + "type": "array", + "items": { + "$ref": "#/$defs/SensorElement" + }, + "description": "An array (one for each sensor) of sensor device data sets associated with the event. " + }, + "parentEPC": { + "$ref": "#/$defs/Item", + "description": "The unique item identifier that is the parent of this association. Typically an assembled product ID such as a desktop computer that is built from the associated child components." + }, + "childEPCs": { + "type": "array", + "items": { + "$ref": "#/$defs/Item" + }, + "description": "The list of child items that have been assembled to create the parent - for example the power supply or hard drive components of a desktop computer." + }, + "childQuantityList": { + "type": "array", + "items": { + "$ref": "#/$defs/QuantityElement" + }, + "description": "List of quantified product classes that have been assembled into the parent. Used when the child items do not have unique identifiers (eg brackets and screws used in the assembly of a desktop computer)" + } + }, + "description": "The association event represents the assembly of child sub-components to create a parent assembled item. For example a desktop computer assembled from power supply, hard drive, and motherboard. The association event is very similar in structure to the aggregation event but is used for physical assembly. An association event may represent a bill of materials used to assemble a product whilst an aggregation event may represent a packing list or items for transport. " + }, + "Event": { + "type": "object", + "oneOf": [ + { + "$ref": "#/$defs/TransformationEvent" + }, + { + "$ref": "#/$defs/ObjectEvent" + }, + { + "$ref": "#/$defs/AggregationEvent" + }, + { + "$ref": "#/$defs/TransactionEvent" + }, + { + "$ref": "#/$defs/AssociationEvent" + } + ], + "description": "This abstract event structure provides a common language to describe supply chain events such as shipments, inspections, manufacturing processes, etc. There are four types of EPCIS event but this is an abstract class representing all common properties of an EPCIS event. " + } + } +} \ No newline at end of file diff --git a/packages/untp-test-suite/src/schemas/conformityCredential/v0.3.10/schema.json b/packages/untp-test-suite/src/schemas/conformityCredential/v0.3.10/schema.json new file mode 100644 index 00000000..5a4d8513 --- /dev/null +++ b/packages/untp-test-suite/src/schemas/conformityCredential/v0.3.10/schema.json @@ -0,0 +1,1028 @@ +{ + "type": "object", + "additionalProperties": false, + "properties": { + "render": { + "type": "array", + "items": { + "template": { + "example": " Digital Product Passport
Digital Product Passport
{{credentialSubject.name}}
Batch: {{credentialSubject.batchNumber}}
Serial: {{credentialSubject.serialNumber}}

Product Details

ID: {{credentialSubject.id}}

Description: {{credentialSubject.description}}

Category: {{#each credentialSubject.productCategory}} {{name}} {{/each}}

Dimensions: {{credentialSubject.dimensions.length.value}} x {{credentialSubject.dimensions.width.value}} x {{credentialSubject.dimensions.height.value}} {{credentialSubject.dimensions.length.unit}}

Weight: {{credentialSubject.dimensions.weight.value}} {{credentialSubject.dimensions.weight.unit}}

Country of Production: {{credentialSubject.countryOfProduction}}

Materials Provenance

{{#each credentialSubject.materialsProvenance}}
{{name}} {{originCountry}} {{materialType.name}} {{massFraction}}
{{/each}}

Conformity Declarations

{{#each credentialSubject.conformityDeclarations}}

{{referenceStandard.name}} - {{referenceRegulation.name}}

{{/each}}

Circularity and Emissions

Circularity Score: {{credentialSubject.circularityScorecard.materialCircularityIndicator}}
Carbon Footprint: {{credentialSubject.emissionsScorecard.carbonFootprint}}
", + "type": "string", + "description": "A template that renders the Verifiable Credential to HTML" + }, + "@type": { + "type": "string", + "enum": [ + "WebRenderingTemplate2022" + ], + "example": "WebRenderingTemplate2022", + "description": "Defines the rendering type." + } + }, + "description": "Defines a template to be used to render the Verifiable Credential." + }, + "type": { + "type": "array", + "readOnly": true, + "const": [ + "DigitalConformityCredential", + "VerifiableCredential" + ], + "default": [ + "DigitalConformityCredential", + "VerifiableCredential" + ], + "items": { + "type": "string", + "enum": [ + "DigitalConformityCredential", + "VerifiableCredential" + ] + } + }, + "@context": { + "example": "https://test.uncefact.org/vocabulary/untp/dpp/dpp-context.jsonld", + "type": "array", + "items": { + "type": "string", + "enum": [ + "https://www.w3.org/ns/credentials/v2", + "https://test.uncefact.org/vocabulary/untp/dcc/0.3.10/", + "https://dev-render-method-context.s3.ap-southeast-1.amazonaws.com/dev-render-method-context.json" + ] + }, + "description": "A list of JSON-LD context URIs that define the seamntic meaning of prperties within the credential. ", + "readOnly": true, + "const": [ + "https://www.w3.org/ns/credentials/v2", + "https://test.uncefact.org/vocabulary/untp/dcc/0.3.10/", + "https://dev-render-method-context.s3.ap-southeast-1.amazonaws.com/dev-render-method-context.json" + ], + "default": [ + "https://www.w3.org/ns/credentials/v2", + "https://test.uncefact.org/vocabulary/untp/dcc/0.3.10/", + "https://dev-render-method-context.s3.ap-southeast-1.amazonaws.com/dev-render-method-context.json" + ] + }, + "id": { + "example": "https://example-company.com/credentials/2a423366-a0d6-4855-ba65-2e0c926d09b0", + "type": "string", + "format": "uri", + "description": "A unique identifier (URI) assigned to the product passport. May be a UUID" + }, + "issuer": { + "$ref": "#/$defs/CredentialIssuer", + "description": "The organisation that is the isuer of this VC. Note that the \"id\" property MUST be a W3C DID. Other identifiers such as tax registration numbers can be listed in the \"otherIdentifiers\" property." + }, + "validFrom": { + "example": "2024-03-15T12:00:00", + "type": "string", + "format": "date-time", + "description": "The date and time from which the credential is valid." + }, + "validUntil": { + "example": "2034-03-15T12:00:00", + "type": "string", + "format": "date-time", + "description": "The expiry date (if applicable) of this verifiable credential." + }, + "credentialSubject": { + "$ref": "#/$defs/ConformityAttestation", + "description": "The conformity attestion is the subject of the verifiable credential. " + } + }, + "description": "A conformity attestation issued by a competent body that defines one or more assessments (eg carbon intensity) about a product (eg batttery) against a specification (eg LCA method) defined in a standard or regulation. ", + "required": [ + "@context", + "id", + "issuer" + ], + "$schema": "https://json-schema.org/draft/2020-12/schema", + "$defs": { + "CredentialIssuer": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "CredentialIssuer" + ], + "default": [ + "CredentialIssuer" + ], + "items": { + "type": "string", + "enum": [ + "CredentialIssuer" + ] + } + }, + "id": { + "example": "did:web:identifiers.example-company.com:12345", + "type": "string", + "format": "uri", + "description": "The W3C DID of the issuer - should be a did:web or did:tdw" + }, + "name": { + "example": "Example Company Pty Ltd", + "type": "string", + "description": "The name of the issuer person or organisation" + }, + "otherIdentifiers": { + "type": "array", + "items": { + "$ref": "#/$defs/Entity" + }, + "description": "An optional list of other registered identifiers for this credential issuer " + } + }, + "description": "The issuer party ()person or orgnaition) of a verifiable credential.", + "required": [ + "id", + "name" + ] + }, + "Entity": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "Entity" + ], + "default": [ + "Entity" + ], + "items": { + "type": "string", + "enum": [ + "Entity" + ] + } + }, + "id": { + "example": "https://id.gs1.org/01/09520123456788/21/12345", + "type": "string", + "format": "uri", + "description": "The globally unique ID of the entity as a resolvable URL according to ISO 18975. ExamplesProduct - id.gs1.org/01/09520123456788/21/12345 Party - abr.business.gov.au/ABN/View?abn=90664869327. Facility - did:web:facilities.example-company.com:123. " + }, + "name": { + "example": "EV battery 300Ah.", + "type": "string", + "description": "The registered name of the entity within the identifier scheme. Examplesproduct - EV battery 300Ahparty - Sample Company Pty Ltd. facility - Greenacres battery factory" + }, + "registeredId": { + "example": "90664869327", + "type": "string", + "description": "The registration number (alphanumeric) of the entity within the register. Unique within the register." + }, + "idScheme": { + "$ref": "#/$defs/IdentifierScheme", + "description": "The identifier scheme. Exampleproduct - id.gs1.org/01. party - business.gov.au/abn facility - did:web:facilities.acme.com. " + } + }, + "description": "The ID and Name of an identified entity such qs a product, facility, party, standard, etc. If the identifier is a W3C DID then the corresponding DID document SHOULD include a serviceEndpoint of type \"IdentityResolver\". If the identifier is not a W3C DID then the id peroperty SHOULD be an identity resolver URL.", + "required": [ + "id", + "name" + ] + }, + "IdentifierScheme": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "IdentifierScheme" + ], + "default": [ + "IdentifierScheme" + ], + "items": { + "type": "string", + "enum": [ + "IdentifierScheme" + ] + } + }, + "id": { + "example": "https://id.gs1.org/01/", + "type": "string", + "format": "uri", + "description": "The globally unique identifier of the registration scheme. The scheme should be registered and discoverable from vocabulary.uncefact.org/identifierSchemes" + }, + "name": { + "example": "Global Trade Identification Number (GTIN)", + "type": "string", + "description": "The name of the identifier scheme. " + } + }, + "description": "An identifier registration scheme for products, facilities, or organisations. Typically operated by a state, national or gloabl authority." + }, + "ConformityAttestation": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "ConformityAttestation", + "Attestation" + ], + "default": [ + "ConformityAttestation", + "Attestation" + ], + "items": { + "type": "string", + "enum": [ + "ConformityAttestation", + "Attestation" + ] + } + }, + "id": { + "example": "https://exampleCAB.com/38f73303-a39e-45a7-b8b7-e73517548f27", + "type": "string", + "format": "uri", + "description": "The globally unique ID of this conformity attestation." + }, + "name": { + "example": "Carbon Lifecycle assessment 12345567", + "type": "string", + "description": "Product GHG Footprint certificate in accordance with GBA Rulebook." + }, + "assessorLevel": { + "type": "string", + "enum": [ + "Self", + "Commercial", + "Buyer", + "Membership", + "Unspecified", + "3rdParty" + ], + "example": "Self", + "description": "Assurance code pertaining to assessor (relation to the object under assessment)" + }, + "assessmentLevel": { + "type": "string", + "enum": [ + "GovtApproval", + "GlobalMRA", + "Accredited", + "Verified", + "Validated", + "Unspecified" + ], + "example": "GovtApproval", + "description": "Assurance pertaining to assessment (any authority or support for the assessment process)" + }, + "attestationType": { + "type": "string", + "enum": [ + "certification", + "declaration", + "inspection", + "testing", + "verification", + "validation", + "calibration" + ], + "example": "certification", + "description": "The type of criterion (optional or mandatory)." + }, + "attestationDescription": { + "example": "Assessment of battery products against the GHG Protocol.", + "type": "string", + "description": "SampleCAB Inc attests that the product class LiFePO4 EV batteries manufactured at Sample battery facility have reported GHG foorptint that conform to the GBA rulebook version 1.5. " + }, + "issuedToParty": { + "$ref": "#/$defs/Entity", + "description": "The party to whom the conformity attestation was issued." + }, + "authorisations": { + "type": "array", + "items": { + "$ref": "#/$defs/Endorsement" + }, + "description": "The authority under which a conformity claim is issued. For example a national accrediation authority may accredit a test lab to issue test certificates about a product against a standard. " + }, + "conformityCertificate": { + "$ref": "#/$defs/SecureLink", + "description": "A reference to the human / printable version of this conformity attestation - typically represented as a PDF document. The document may have more details than are represented in the digital attestation." + }, + "auditableEvidence": { + "$ref": "#/$defs/SecureLink", + "description": "Auditable evidence supporting this assessment such as raw measurements, supporting documents. This is usally private data and would normally be encrypted." + }, + "scope": { + "$ref": "#/$defs/ConformityAssessmentScheme", + "description": "A list of relevant standards and/or regulations against which apply to this attestation (eg AS1163:2016). " + }, + "assessments": { + "type": "array", + "items": { + "$ref": "#/$defs/ConformityAssessment" + }, + "description": "The list of specific assessments made within this conformity attestation." + } + }, + "description": "A conformity attestation issued by a competent body that defines one or more assessments (eg carbon intensity) about a product (eg batttery) against a specification (eg LCA method) defined in a standard or regulation.", + "required": [ + "id", + "assessorLevel", + "assessmentLevel", + "attestationType", + "issuedToParty" + ] + }, + "Endorsement": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "Endorsement" + ], + "default": [ + "Endorsement" + ], + "items": { + "type": "string", + "enum": [ + "Endorsement" + ] + } + }, + "id": { + "example": "https://authority.gov/schemeABC/123456789", + "type": "string", + "format": "uri", + "description": "Globally unique identifier of an accreditation or authority issued to a confomrity assessment body by a regulator or national accreditation authority." + }, + "name": { + "example": "Accreditation of certifiers.com under the Australian National Greenhouse and Energy Reporting scheme (NGER).", + "type": "string", + "description": "The name of the accreditation." + }, + "trustmark": { + "$ref": "#/$defs/BinaryFile", + "description": "The trust mark image awarded by the AB to the CAB to indicate accrediation." + }, + "issuingAuthority": { + "$ref": "#/$defs/Entity", + "description": "The competent authority that issued the accreditation." + }, + "accreditationCertificate": { + "$ref": "#/$defs/Link", + "description": "The evidence that supports the authroty under which the attestation is issued - eg an accreditation certificate." + } + }, + "description": "The authority under which a conformity claim is issued. For example a national accrediation authority may accredit a test lab to issue test certificates about a product against a standard. ", + "required": [ + "id", + "name", + "issuingAuthority" + ] + }, + "BinaryFile": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "BinaryFile" + ], + "default": [ + "BinaryFile" + ], + "items": { + "type": "string", + "enum": [ + "BinaryFile" + ] + } + }, + "fileName": { + "example": "GHG protocol trust mark", + "type": "string", + "description": "A name for referenced binary file" + }, + "fileType": { + "type": "string", + "x-external-enumeration": "https://mimetype.io/all-types", + "description": "The type of file, represented as a MIME type.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://mimetype.io/all-types\n " + }, + "file": { + "example": "iVBORw0KGgoAAAANSUhEUgAAADkAAAA2CAYAAAB9TjFQAAAABGdBTUEAAi/9H3pWy6vI9uFdAAAAAElFTkSuQmCC", + "type": "string", + "format": "byte", + "description": "The binary file data encoded as Base64 string." + } + }, + "description": "A binary file reference including name and filetype" + }, + "Link": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "Link" + ], + "default": [ + "Link" + ], + "items": { + "type": "string", + "enum": [ + "Link" + ] + } + }, + "linkURL": { + "example": "https://files.example-certifier.com/1234567.json", + "type": "string", + "format": "uri", + "description": "The URL of the target resource. " + }, + "linkName": { + "example": "GBA rule book conformity certificate", + "type": "string", + "description": "A display name for the target resource " + }, + "linkType": { + "example": "https://test.uncefact.org/vocabulary/linkTypes/dcc", + "type": "string", + "description": "The type of the target resource - drawn from a controlled vocabulary " + } + }, + "description": "A structure to provide a URL link plus metadata associated with the link." + }, + "SecureLink": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "SecureLink", + "Link" + ], + "default": [ + "SecureLink", + "Link" + ], + "items": { + "type": "string", + "enum": [ + "SecureLink", + "Link" + ] + } + }, + "linkURL": { + "example": "https://files.example-certifier.com/1234567.json", + "type": "string", + "format": "uri", + "description": "The URL of the target resource. " + }, + "linkName": { + "example": "GBA rule book conformity certificate", + "type": "string", + "description": "A display name for the target resource " + }, + "linkType": { + "example": "https://test.uncefact.org/vocabulary/linkTypes/dcc", + "type": "string", + "description": "The type of the target resource - drawn from a controlled vocabulary " + }, + "hashDigest": { + "example": "6239119dda5bd4c8a6ffb832fe16feaa5c27b7dba154d24c53d4470a2c69adc2", + "type": "string", + "description": "The hash of the file." + }, + "hashMethod": { + "type": "string", + "enum": [ + "SHA-256", + "SHA-1" + ], + "example": "SHA-256", + "description": "The hashing algorithm used to create the target hash. SHA-265 is the recommedned standard" + }, + "encryptionMethod": { + "type": "string", + "enum": [ + "none", + "AES" + ], + "example": "none", + "description": "The symmetric encryption algorithm used to encrypt the link target. AES is the recommended standard. Decryption keys are expected to be passed out of bounds." + } + }, + "description": "A binary file that is hashed ()for tamper evidence) and optionally encrypted (for confidentiality)." + }, + "ConformityAssessmentScheme": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "ConformityAssessmentScheme", + "Standard" + ], + "default": [ + "ConformityAssessmentScheme", + "Standard" + ], + "items": { + "type": "string", + "enum": [ + "ConformityAssessmentScheme", + "Standard" + ] + } + }, + "id": { + "example": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf", + "type": "string", + "format": "uri", + "description": "A unique identifier for the standard (eg https://www.iso.org/standard/60857.html)." + }, + "name": { + "example": "GBA Battery Passport Greenhouse Gas Rulebook - V.2.0", + "type": "string", + "description": "The name of the standard" + }, + "issuingParty": { + "$ref": "#/$defs/Entity", + "description": "The party that issued the standard " + }, + "issueDate": { + "example": "2023-12-05", + "type": "string", + "format": "date", + "description": "The date when the standard was issued." + }, + "trustmark": { + "$ref": "#/$defs/BinaryFile", + "description": "The trust mark that represents the conformity assessment scheme." + } + }, + "description": "A formal governance scheme under which this attestation is issued (eg ACRS structural steel certification) ", + "required": [ + "issuingParty" + ] + }, + "ConformityAssessment": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "ConformityAssessment", + "Declaration" + ], + "default": [ + "ConformityAssessment", + "Declaration" + ], + "items": { + "type": "string", + "enum": [ + "ConformityAssessment", + "Declaration" + ] + } + }, + "id": { + "example": "https://exampleCAB.com/38f73303-a39e-45a7-b8b7-e73517548f27/01", + "type": "string", + "format": "uri", + "description": "A unique identifier for the delcaration. Often this will be an extension of the product.id or attestation.id. But could be a UUID." + }, + "referenceStandard": { + "$ref": "#/$defs/Standard", + "description": "The reference to the standard that defines the specification / criteria" + }, + "referenceRegulation": { + "$ref": "#/$defs/Regulation", + "description": "The reference to the regulation that defines the assessment criteria" + }, + "assessmentCriteria": { + "type": "array", + "items": { + "$ref": "#/$defs/Criterion" + }, + "description": "The specification against which the assessment is made." + }, + "declaredValues": { + "type": "array", + "items": { + "$ref": "#/$defs/Metric" + }, + "description": "The list of specific values measured as part of this assessment (eg tensile strength)" + }, + "compliance": { + "example": "true", + "type": "boolean", + "description": "An indicator of whether or not the assessment meets the specification." + }, + "conformityTopic": { + "type": "string", + "enum": [ + "environment.energy", + "environment.emissions", + "environment.water", + "environment.waste", + "environment.deforestation", + "environment.biodiversity", + "circularity.content", + "circularity.design", + "social.labour", + "social.rights", + "social.community", + "social.safety", + "governance.ethics", + "governance.compliance", + "governance.transparency" + ], + "example": "environment.energy", + "description": "The conformity topic category for this assessment (eg vocabulary.uncefact.org/sustainability/emissions)" + }, + "assessedProducts": { + "type": "array", + "items": { + "$ref": "#/$defs/Product" + }, + "description": "The list of products that are the subject of this conformity assessment" + }, + "assessedFacilities": { + "type": "array", + "items": { + "$ref": "#/$defs/Facility" + }, + "description": "The list of facilities that are the subject of this conformity assessment." + } + }, + "description": "A specific assessment about the product or facility against a specific specification. Eg the carbon intensity of a given product or batch.", + "required": [ + "id", + "compliance", + "conformityTopic" + ] + }, + "Standard": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "Standard" + ], + "default": [ + "Standard" + ], + "items": { + "type": "string", + "enum": [ + "Standard" + ] + } + }, + "id": { + "example": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf", + "type": "string", + "format": "uri", + "description": "A unique identifier for the standard (eg https://www.iso.org/standard/60857.html)." + }, + "name": { + "example": "GBA Battery Passport Greenhouse Gas Rulebook - V.2.0", + "type": "string", + "description": "The name of the standard" + }, + "issuingParty": { + "$ref": "#/$defs/Entity", + "description": "The party that issued the standard " + }, + "issueDate": { + "example": "2023-12-05", + "type": "string", + "format": "date", + "description": "The date when the standard was issued." + } + }, + "description": "A standard (eg ISO 14000) that specifies the criteria for conformance.", + "required": [ + "issuingParty" + ] + }, + "Regulation": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "Regulation" + ], + "default": [ + "Regulation" + ], + "items": { + "type": "string", + "enum": [ + "Regulation" + ] + } + }, + "id": { + "example": "https://www.legislation.gov.au/F2008L02309/latest/versions", + "type": "string", + "format": "uri", + "description": "The globally unique identifier of this regulation. " + }, + "name": { + "example": "NNational Greenhouse and Energy Reporting (Measurement) Determination", + "type": "string", + "description": "The name of the regulation or act." + }, + "jurisdictionCountry": { + "type": "string", + "x-external-enumeration": "https://vocabulary.uncefact.org/CountryId", + "description": "The legal jurisdiction (country) under which the regulation is issued.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://vocabulary.uncefact.org/CountryId\n " + }, + "administeredBy": { + "$ref": "#/$defs/Entity", + "description": "the issuing body of the regulation. For example Australin Goernment Department of Climate Change, Energy, the Environment and Water" + }, + "effectiveDate": { + "example": "2024-03-20", + "type": "string", + "format": "date", + "description": "the date at which the regulation came into effect." + } + }, + "description": "A regulation (eg EU deforestation regulation) that defines the criteria for assessment.", + "required": [ + "administeredBy" + ] + }, + "Criterion": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "Criterion" + ], + "default": [ + "Criterion" + ], + "items": { + "type": "string", + "enum": [ + "Criterion" + ] + } + }, + "id": { + "example": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf#BatteryAssembly", + "type": "string", + "format": "uri", + "description": "A unique identifier for the criteria within the standard or regulation. For example CO2 emissions calaculations for liquid fule combusion." + }, + "name": { + "example": "GBA Battery rule book v2.0 battery assembly guidelines.", + "type": "string", + "description": "A name that describes this criteria." + }, + "thresholdValues": { + "type": "array", + "items": { + "$ref": "#/$defs/Metric" + }, + "description": "A conformity threshold defined by the specification (eg minimum compressive strength) " + } + }, + "description": "A specific rule or criterion within a standard or regulation. eg a carbon intensity calculation rule within an emissions standard.", + "required": [ + "id", + "name" + ] + }, + "Metric": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "Metric" + ], + "default": [ + "Metric" + ], + "items": { + "type": "string", + "enum": [ + "Metric" + ] + } + }, + "metricName": { + "example": "GHG emissions intensity", + "type": "string", + "description": "A human readable name for this metric (for example \"Tensile strength\")" + }, + "metricValue": { + "$ref": "#/$defs/Measure", + "description": "A numeric value and unit of measure for this metric. Could be a measured value or a specified threshold. Eg {\"value\":400, \"unit\":\"MPA\"} as tensile strenght of structural steel" + }, + "accuracy": { + "example": 0.05, + "type": "number", + "description": "A percentage represented as a numeric between 0 and 1 indicating the rage of accuracy of the claimed value (eg 0.05 means that the actual value is within 5% of the claimed value.)" + } + }, + "description": "A specific measure of performance against the criteria that governs the claim. Expressed as an array of metric (ie unit of emasure) / value (ie the actual numeric value) pairs. ", + "required": [ + "metricName", + "metricValue" + ] + }, + "Measure": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "Measure" + ], + "default": [ + "Measure" + ], + "items": { + "type": "string", + "enum": [ + "Measure" + ] + } + }, + "value": { + "example": 10, + "type": "number", + "description": "The numeric value of the measure" + }, + "unit": { + "type": "string", + "x-external-enumeration": "https://vocabulary.uncefact.org/UnitMeasureCode", + "description": "Unit of measure drawn from the UNECE rec20 measure code list.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://vocabulary.uncefact.org/UnitMeasureCode\n " + } + }, + "description": "The measure class defines a numeric measured value (eg 10) and a coded unit of measure (eg KG).", + "required": [ + "value", + "unit" + ] + }, + "Product": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "Product", + "Entity" + ], + "default": [ + "Product", + "Entity" + ], + "items": { + "type": "string", + "enum": [ + "Product", + "Entity" + ] + } + }, + "id": { + "example": "https://id.gs1.org/01/09520123456788/21/12345", + "type": "string", + "format": "uri", + "description": "The globally unique ID of the entity as a resolvable URL according to ISO 18975. ExamplesProduct - id.gs1.org/01/09520123456788/21/12345 Party - abr.business.gov.au/ABN/View?abn=90664869327. Facility - did:web:facilities.example-company.com:123. " + }, + "name": { + "example": "EV battery 300Ah.", + "type": "string", + "description": "The registered name of the entity within the identifier scheme. Examplesproduct - EV battery 300Ahparty - Sample Company Pty Ltd. facility - Greenacres battery factory" + }, + "registeredId": { + "example": "90664869327", + "type": "string", + "description": "The registration number (alphanumeric) of the entity within the register. Unique within the register." + }, + "idScheme": { + "$ref": "#/$defs/IdentifierScheme", + "description": "The identifier scheme. Exampleproduct - id.gs1.org/01. party - business.gov.au/abn facility - did:web:facilities.acme.com. " + }, + "IDverifiedByCAB": { + "example": "true", + "type": "boolean", + "description": "Indicates whether the conformity assessment body has verified the identity product that is the subject of the assessment." + } + }, + "description": "The product which is the subject of this conformity assessment", + "required": [ + "id", + "name" + ] + }, + "Facility": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "Facility", + "Entity" + ], + "default": [ + "Facility", + "Entity" + ], + "items": { + "type": "string", + "enum": [ + "Facility", + "Entity" + ] + } + }, + "id": { + "example": "https://id.gs1.org/01/09520123456788/21/12345", + "type": "string", + "format": "uri", + "description": "The globally unique ID of the entity as a resolvable URL according to ISO 18975. ExamplesProduct - id.gs1.org/01/09520123456788/21/12345 Party - abr.business.gov.au/ABN/View?abn=90664869327. Facility - did:web:facilities.example-company.com:123. " + }, + "name": { + "example": "EV battery 300Ah.", + "type": "string", + "description": "The registered name of the entity within the identifier scheme. Examplesproduct - EV battery 300Ahparty - Sample Company Pty Ltd. facility - Greenacres battery factory" + }, + "registeredId": { + "example": "90664869327", + "type": "string", + "description": "The registration number (alphanumeric) of the entity within the register. Unique within the register." + }, + "idScheme": { + "$ref": "#/$defs/IdentifierScheme", + "description": "The identifier scheme. Exampleproduct - id.gs1.org/01. party - business.gov.au/abn facility - did:web:facilities.acme.com. " + }, + "IDverifiedByCAB": { + "example": "true", + "type": "boolean", + "description": "Indicates whether the conformity assessment body has verified the identity of the facility which is the subject of the assement." + } + }, + "description": "The facility which is the subject of this conformity assessment", + "required": [ + "id", + "name" + ] + } + } +} \ No newline at end of file diff --git a/packages/untp-test-suite/src/schemas/conformityCredential/v0.3.9/schema.json b/packages/untp-test-suite/src/schemas/conformityCredential/v0.3.9/schema.json new file mode 100644 index 00000000..115be0d2 --- /dev/null +++ b/packages/untp-test-suite/src/schemas/conformityCredential/v0.3.9/schema.json @@ -0,0 +1,879 @@ +{ + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "DigitalConformityCredential", + "VerifiableCredential" + ], + "default": [ + "DigitalConformityCredential", + "VerifiableCredential" + ], + "items": { + "type": "string", + "enum": [ + "DigitalConformityCredential", + "VerifiableCredential" + ] + } + }, + "@context": { + "example": "https://test.uncefact.org/vocabulary/untp/dpp/dpp-context.jsonld", + "type": "array", + "items": { + "type": "string", + "enum": [ + "https://www.w3.org/ns/credentials/v2", + "https://vocabulary.uncefact.org/untp/dcc/{{version}}/" + ] + }, + "description": "A list of JSON-LD context URIs that define the seamntic meaning of prperties within the credential. ", + "readOnly": true, + "const": [ + "https://www.w3.org/ns/credentials/v2", + "https://vocabulary.uncefact.org/untp/dcc/{{version}}/" + ], + "default": [ + "https://www.w3.org/ns/credentials/v2", + "https://vocabulary.uncefact.org/untp/dcc/{{version}}/" + ] + }, + "id": { + "example": "https://example-company.com/credentials/2a423366-a0d6-4855-ba65-2e0c926d09b0", + "type": "string", + "format": "uri", + "description": "A unique identifier (URI) assigned to the product passport. May be a UUID" + }, + "issuer": { + "$ref": "#/$defs/CredentialIssuer", + "description": "The organisation that is the isuer of this VC. Note that the \"id\" property MUST be a W3C DID. Other identifiers such as tax registration numbers can be listed in the \"otherIdentifiers\" property." + }, + "validFrom": { + "example": "2024-03-15", + "type": "string", + "format": "date-time", + "description": "The date and time from which the credential is valid." + }, + "validUntil": { + "example": "2034-03-15", + "type": "string", + "format": "date-time", + "description": "The expiry date (if applicable) of this verifiable credential." + }, + "credentialSubject": { + "$ref": "#/$defs/ConformityAttestation", + "description": "The conformity attestion is the subject of the verifiable credential. " + } + }, + "description": "A conformity attestation issued by a competent body that defines one or more assessments (eg carbon intensity) about a product (eg batttery) against a specification (eg LCA method) defined in a standard or regulation. ", + "required": [ + "@context", + "id", + "issuer" + ], + "$schema": "https://json-schema.org/draft/2020-12/schema", + "$defs": { + "CredentialIssuer": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "default": "CredentialIssuer", + "enum": [ + "CredentialIssuer" + ] + }, + "id": { + "example": "did:web:identifiers.example-company.com:12345", + "type": "string", + "format": "uri", + "description": "The W3C DID of the issuer - should be a did:web or did:tdw" + }, + "name": { + "example": "Example Company Pty Ltd", + "type": "string", + "description": "The name of the issuer person or organisation" + }, + "otherIdentifiers": { + "type": "array", + "items": { + "$ref": "#/$defs/Entity" + }, + "description": "An optional list of other registered identifiers for this credential issuer " + } + }, + "description": "The issuer party ()person or orgnaition) of a verifiable credential.", + "required": [ + "id", + "name" + ] + }, + "Entity": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "default": "Entity", + "enum": [ + "Entity" + ] + }, + "id": { + "example": "https://id.gs1.org/01/09520123456788/21/12345", + "type": "string", + "format": "uri", + "description": "The globally unique ID of the entity as a resolvable URL according to ISO 18975. ExamplesProduct - id.gs1.org/01/09520123456788/21/12345 Party - abr.business.gov.au/ABN/View?abn=90664869327. Facility - did:web:facilities.example-company.com:123. " + }, + "name": { + "example": "EV battery 300Ah.", + "type": "string", + "description": "The registered name of the entity within the identifier scheme. Examplesproduct - EV battery 300Ahparty - Sample Company Pty Ltd. facility - Greenacres battery factory" + }, + "registeredId": { + "example": "90664869327", + "type": "string", + "description": "The registration number (alphanumeric) of the entity within the register. Unique within the register." + }, + "idScheme": { + "$ref": "#/$defs/IdentifierScheme", + "description": "The identifier scheme. Exampleproduct - id.gs1.org/01. party - business.gov.au/abn facility - did:web:facilities.acme.com. " + } + }, + "description": "The ID and Name of an identified entity such qs a product, facility, party, standard, etc. If the identifier is a W3C DID then the corresponding DID document SHOULD include a serviceEndpoint of type \"IdentityResolver\". If the identifier is not a W3C DID then the id peroperty SHOULD be an identity resolver URL.", + "required": [ + "id", + "name" + ] + }, + "IdentifierScheme": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "default": "IdentifierScheme", + "enum": [ + "IdentifierScheme" + ] + }, + "id": { + "example": "https://id.gs1.org/01/", + "type": "string", + "format": "uri", + "description": "The globally unique identifier of the registration scheme. The scheme should be registered and discoverable from vocabulary.uncefact.org/identifierSchemes" + }, + "name": { + "example": "Global Trade Identification Number (GTIN)", + "type": "string", + "description": "The name of the identifier scheme. " + } + }, + "description": "An identifier registration scheme for products, facilities, or organisations. Typically operated by a state, national or gloabl authority." + }, + "ConformityAttestation": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "ConformityAttestation", + "Attestation" + ], + "default": [ + "ConformityAttestation", + "Attestation" + ], + "items": { + "type": "string", + "enum": [ + "ConformityAttestation", + "Attestation" + ] + } + }, + "id": { + "example": "https://exampleCAB.com/38f73303-a39e-45a7-b8b7-e73517548f27", + "type": "string", + "format": "uri", + "description": "The globally unique ID of this conformity attestation." + }, + "name": { + "example": "Carbon Lifecycle assessment 12345567", + "type": "string", + "description": "Product GHG Footprint certificate in accordance with GBA Rulebook." + }, + "assessorLevel": { + "type": "string", + "enum": [ + "Self", + "Commercial", + "Buyer", + "Membership", + "Unspecified", + "3rdParty" + ], + "example": "Self", + "description": "Assurance code pertaining to assessor (relation to the object under assessment)" + }, + "assessmentLevel": { + "type": "string", + "enum": [ + "GovtApproval", + "GlobalMRA", + "Accredited", + "Verified", + "Validated", + "Unspecified" + ], + "example": "GovtApproval", + "description": "Assurance pertaining to assessment (any authority or support for the assessment process)" + }, + "attestationType": { + "type": "string", + "enum": [ + "certification", + "declaration", + "inspection", + "testing", + "verification", + "validation", + "calibration" + ], + "example": "certification", + "description": "The type of criterion (optional or mandatory)." + }, + "attestationDescription": { + "example": "Assessment of battery products against the GHG Protocol.", + "type": "string", + "description": "SampleCAB Inc attests that the product class LiFePO4 EV batteries manufactured at Sample battery facility have reported GHG foorptint that conform to the GBA rulebook version 1.5. " + }, + "issuedToParty": { + "$ref": "#/$defs/Entity", + "description": "The party to whom the conformity attestation was issued." + }, + "authorisations": { + "type": "array", + "items": { + "$ref": "#/$defs/Endorsement" + }, + "description": "The authority under which a conformity claim is issued. For example a national accrediation authority may accredit a test lab to issue test certificates about a product against a standard. " + }, + "conformityCertificate": { + "$ref": "#/$defs/SecureLink", + "description": "A reference to the human / printable version of this conformity attestation - typically represented as a PDF document. The document may have more details than are represented in the digital attestation." + }, + "auditableEvidence": { + "$ref": "#/$defs/SecureLink", + "description": "Auditable evidence supporting this assessment such as raw measurements, supporting documents. This is usally private data and would normally be encrypted." + }, + "scope": { + "$ref": "#/$defs/ConformityAssessmentScheme", + "description": "A list of relevant standards and/or regulations against which apply to this attestation (eg AS1163:2016). " + }, + "assessments": { + "type": "array", + "items": { + "$ref": "#/$defs/ConformityAssessment" + }, + "description": "The list of specific assessments made within this conformity attestation." + } + }, + "description": "A conformity attestation issued by a competent body that defines one or more assessments (eg carbon intensity) about a product (eg batttery) against a specification (eg LCA method) defined in a standard or regulation.", + "required": [ + "id", + "assessorLevel", + "assessmentLevel", + "attestationType", + "issuedToParty" + ] + }, + "Endorsement": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "default": "Endorsement", + "enum": [ + "Endorsement" + ] + }, + "id": { + "example": "https://authority.gov/schemeABC/123456789", + "type": "string", + "format": "uri", + "description": "Globally unique identifier of an accreditation or authority issued to a confomrity assessment body by a regulator or national accreditation authority." + }, + "name": { + "example": "Accreditation of certifiers.com under the Australian National Greenhouse and Energy Reporting scheme (NGER).", + "type": "string", + "description": "The name of the accreditation." + }, + "trustmark": { + "$ref": "#/$defs/BinaryFile", + "description": "The trust mark image awarded by the AB to the CAB to indicate accrediation." + }, + "issuingAuthority": { + "$ref": "#/$defs/Entity", + "description": "The competent authority that issued the accreditation." + }, + "accreditationCertificate": { + "$ref": "#/$defs/Link", + "description": "The evidence that supports the authroty under which the attestation is issued - eg an accreditation certificate." + } + }, + "description": "The authority under which a conformity claim is issued. For example a national accrediation authority may accredit a test lab to issue test certificates about a product against a standard. ", + "required": [ + "id", + "name", + "issuingAuthority" + ] + }, + "BinaryFile": { + "type": "object", + "additionalProperties": false, + "properties": { + "fileName": { + "example": "GHG protocol trust mark", + "type": "string", + "description": "A name for referenced binary file" + }, + "fileType": { + "type": "string", + "x-external-enumeration": "https://mimetype.io/all-types", + "description": "The type of file, represented as a MIME type.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://mimetype.io/all-types\n " + }, + "file": { + "example": "iVBORw0KGgoAAAANSUhEUgAAADkAAAA2CAYAAAB9TjFQAAAABGdBTUEAAi/9H3pWy6vI9uFdAAAAAElFTkSuQmCC", + "type": "string", + "format": "byte", + "description": "The binary file data encoded as Base64 string." + } + }, + "description": "A binary file reference including name and filetype" + }, + "Link": { + "type": "object", + "additionalProperties": false, + "properties": { + "linkURL": { + "example": "https://files.example-certifier.com/1234567.json", + "type": "string", + "format": "uri", + "description": "The URL of the target resource. " + }, + "linkName": { + "example": "GBA rule book conformity certificate", + "type": "string", + "description": "A display name for the target resource " + }, + "linkType": { + "example": "https://test.uncefact.org/vocabulary/linkTypes/dcc", + "type": "string", + "description": "The type of the target resource - drawn from a controlled vocabulary " + } + }, + "description": "A structure to provide a URL link plus metadata associated with the link." + }, + "SecureLink": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "SecureLink", + "Link" + ], + "default": [ + "SecureLink", + "Link" + ], + "items": { + "type": "string", + "enum": [ + "SecureLink", + "Link" + ] + } + }, + "linkURL": { + "example": "https://files.example-certifier.com/1234567.json", + "type": "string", + "format": "uri", + "description": "The URL of the target resource. " + }, + "linkName": { + "example": "GBA rule book conformity certificate", + "type": "string", + "description": "A display name for the target resource " + }, + "linkType": { + "example": "https://test.uncefact.org/vocabulary/linkTypes/dcc", + "type": "string", + "description": "The type of the target resource - drawn from a controlled vocabulary " + }, + "hashDigest": { + "example": "6239119dda5bd4c8a6ffb832fe16feaa5c27b7dba154d24c53d4470a2c69adc2", + "type": "string", + "description": "The hash of the file." + }, + "hashMethod": { + "type": "string", + "enum": [ + "SHA-256", + "SHA-1" + ], + "example": "SHA-256", + "description": "The hashing algorithm used to create the target hash. SHA-265 is the recommedned standard" + }, + "encryptionMethod": { + "type": "string", + "enum": [ + "none", + "AES" + ], + "example": "none", + "description": "The symmetric encryption algorithm used to encrypt the link target. AES is the recommended standard. Decryption keys are expected to be passed out of bounds." + } + }, + "description": "A binary file that is hashed ()for tamper evidence) and optionally encrypted (for confidentiality)." + }, + "ConformityAssessmentScheme": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "ConformityAssessmentScheme", + "Standard" + ], + "default": [ + "ConformityAssessmentScheme", + "Standard" + ], + "items": { + "type": "string", + "enum": [ + "ConformityAssessmentScheme", + "Standard" + ] + } + }, + "id": { + "example": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf", + "type": "string", + "format": "uri", + "description": "A unique identifier for the standard (eg https://www.iso.org/standard/60857.html)." + }, + "name": { + "example": "GBA Battery Passport Greenhouse Gas Rulebook - V.2.0", + "type": "string", + "description": "The name of the standard" + }, + "issuingParty": { + "$ref": "#/$defs/Entity", + "description": "The party that issued the standard " + }, + "issueDate": { + "example": "2023-12-05", + "type": "string", + "format": "date", + "description": "The date when the standard was issued." + }, + "trustmark": { + "$ref": "#/$defs/BinaryFile", + "description": "The trust mark that represents the conformity assessment scheme." + } + }, + "description": "A formal governance scheme under which this attestation is issued (eg ACRS structural steel certification) ", + "required": [ + "issuingParty" + ] + }, + "ConformityAssessment": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "ConformityAssessment", + "Declaration" + ], + "default": [ + "ConformityAssessment", + "Declaration" + ], + "items": { + "type": "string", + "enum": [ + "ConformityAssessment", + "Declaration" + ] + } + }, + "id": { + "example": "https://exampleCAB.com/38f73303-a39e-45a7-b8b7-e73517548f27/01", + "type": "string", + "format": "uri", + "description": "A unique identifier for the delcaration. Often this will be an extension of the product.id or attestation.id. But could be a UUID." + }, + "referenceStandard": { + "$ref": "#/$defs/Standard", + "description": "The reference to the standard that defines the specification / criteria" + }, + "referenceRegulation": { + "$ref": "#/$defs/Regulation", + "description": "The reference to the regulation that defines the assessment criteria" + }, + "assessmentCriteria": { + "type": "array", + "items": { + "$ref": "#/$defs/Criterion" + }, + "description": "The specification against which the assessment is made." + }, + "declaredValues": { + "type": "array", + "items": { + "$ref": "#/$defs/Metric" + }, + "description": "The list of specific values measured as part of this assessment (eg tensile strength)" + }, + "compliance": { + "example": "true", + "type": "boolean", + "description": "An indicator of whether or not the assessment meets the specification." + }, + "conformityTopic": { + "type": "string", + "enum": [ + "environment.energy", + "environment.emissions", + "environment.water", + "environment.waste", + "environment.deforestation", + "environment.biodiversity", + "circularity.content", + "circularity.design", + "social.labour", + "social.rights", + "social.community", + "social.safety", + "governance.ethics", + "governance.compliance", + "governance.transparency" + ], + "example": "environment.energy", + "description": "The conformity topic category for this assessment (eg vocabulary.uncefact.org/sustainability/emissions)" + }, + "assessedProducts": { + "type": "array", + "items": { + "$ref": "#/$defs/Product" + }, + "description": "The list of products that are the subject of this conformity assessment" + }, + "assessedFacilities": { + "type": "array", + "items": { + "$ref": "#/$defs/Facility" + }, + "description": "The list of facilities that are the subject of this conformity assessment." + } + }, + "description": "A specific assessment about the product or facility against a specific specification. Eg the carbon intensity of a given product or batch.", + "required": [ + "id", + "compliance", + "conformityTopic" + ] + }, + "Standard": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "default": "Standard", + "enum": [ + "Standard" + ] + }, + "id": { + "example": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf", + "type": "string", + "format": "uri", + "description": "A unique identifier for the standard (eg https://www.iso.org/standard/60857.html)." + }, + "name": { + "example": "GBA Battery Passport Greenhouse Gas Rulebook - V.2.0", + "type": "string", + "description": "The name of the standard" + }, + "issuingParty": { + "$ref": "#/$defs/Entity", + "description": "The party that issued the standard " + }, + "issueDate": { + "example": "2023-12-05", + "type": "string", + "format": "date", + "description": "The date when the standard was issued." + } + }, + "description": "A standard (eg ISO 14000) that specifies the criteria for conformance.", + "required": [ + "issuingParty" + ] + }, + "Regulation": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "default": "Regulation", + "enum": [ + "Regulation" + ] + }, + "id": { + "example": "https://www.legislation.gov.au/F2008L02309/latest/versions", + "type": "string", + "format": "uri", + "description": "The globally unique identifier of this regulation. " + }, + "name": { + "example": "NNational Greenhouse and Energy Reporting (Measurement) Determination", + "type": "string", + "description": "The name of the regulation or act." + }, + "jurisdictionCountry": { + "type": "string", + "x-external-enumeration": "https://vocabulary.uncefact.org/CountryId", + "description": "The legal jurisdiction (country) under which the regulation is issued.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://vocabulary.uncefact.org/CountryId\n " + }, + "administeredBy": { + "$ref": "#/$defs/Entity", + "description": "the issuing body of the regulation. For example Australin Goernment Department of Climate Change, Energy, the Environment and Water" + }, + "effectiveDate": { + "example": "2024-03-20", + "type": "string", + "format": "date", + "description": "the date at which the regulation came into effect." + } + }, + "description": "A regulation (eg EU deforestation regulation) that defines the criteria for assessment.", + "required": [ + "administeredBy" + ] + }, + "Criterion": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "default": "Criterion", + "enum": [ + "Criterion" + ] + }, + "id": { + "example": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf#BatteryAssembly", + "type": "string", + "format": "uri", + "description": "A unique identifier for the criteria within the standard or regulation. For example CO2 emissions calaculations for liquid fule combusion." + }, + "name": { + "example": "GBA Battery rule book v2.0 battery assembly guidelines.", + "type": "string", + "description": "A name that describes this criteria." + }, + "thresholdValues": { + "type": "array", + "items": { + "$ref": "#/$defs/Metric" + }, + "description": "A conformity threshold defined by the specification (eg minimum compressive strength) " + } + }, + "description": "A specific rule or criterion within a standard or regulation. eg a carbon intensity calculation rule within an emissions standard.", + "required": [ + "id", + "name" + ] + }, + "Metric": { + "type": "object", + "additionalProperties": false, + "properties": { + "metricName": { + "example": "GHG emissions intensity", + "type": "string", + "description": "A human readable name for this metric (for example \"Tensile strength\")" + }, + "metricValue": { + "$ref": "#/$defs/Measure", + "description": "A numeric value and unit of measure for this metric. Could be a measured value or a specified threshold. Eg {\"value\":400, \"unit\":\"MPA\"} as tensile strenght of structural steel" + }, + "accuracy": { + "example": 0.05, + "type": "number", + "description": "A percentage represented as a numeric between 0 and 1 indicating the rage of accuracy of the claimed value (eg 0.05 means that the actual value is within 5% of the claimed value.)" + } + }, + "description": "A specific measure of performance against the criteria that governs the claim. Expressed as an array of metric (ie unit of emasure) / value (ie the actual numeric value) pairs. ", + "required": [ + "metricName", + "metricValue" + ] + }, + "Measure": { + "type": "object", + "additionalProperties": false, + "properties": { + "value": { + "example": 10, + "type": "number", + "description": "The numeric value of the measure" + }, + "unit": { + "type": "string", + "x-external-enumeration": "https://vocabulary.uncefact.org/UnitMeasureCode", + "description": "Unit of measure drawn from the UNECE rec20 measure code list.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://vocabulary.uncefact.org/UnitMeasureCode\n " + } + }, + "description": "The measure class defines a numeric measured value (eg 10) and a coded unit of measure (eg KG).", + "required": [ + "value", + "unit" + ] + }, + "Product": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "Product", + "Entity" + ], + "default": [ + "Product", + "Entity" + ], + "items": { + "type": "string", + "enum": [ + "Product", + "Entity" + ] + } + }, + "id": { + "example": "https://id.gs1.org/01/09520123456788/21/12345", + "type": "string", + "format": "uri", + "description": "The globally unique ID of the entity as a resolvable URL according to ISO 18975. ExamplesProduct - id.gs1.org/01/09520123456788/21/12345 Party - abr.business.gov.au/ABN/View?abn=90664869327. Facility - did:web:facilities.example-company.com:123. " + }, + "name": { + "example": "EV battery 300Ah.", + "type": "string", + "description": "The registered name of the entity within the identifier scheme. Examplesproduct - EV battery 300Ahparty - Sample Company Pty Ltd. facility - Greenacres battery factory" + }, + "registeredId": { + "example": "90664869327", + "type": "string", + "description": "The registration number (alphanumeric) of the entity within the register. Unique within the register." + }, + "idScheme": { + "$ref": "#/$defs/IdentifierScheme", + "description": "The identifier scheme. Exampleproduct - id.gs1.org/01. party - business.gov.au/abn facility - did:web:facilities.acme.com. " + }, + "IDverifiedByCAB": { + "example": "true", + "type": "boolean", + "description": "Indicates whether the conformity assessment body has verified the identity product that is the subject of the assessment." + } + }, + "description": "The product which is the subject of this conformity assessment", + "required": [ + "id", + "name" + ] + }, + "Facility": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "Facility", + "Entity" + ], + "default": [ + "Facility", + "Entity" + ], + "items": { + "type": "string", + "enum": [ + "Facility", + "Entity" + ] + } + }, + "id": { + "example": "https://id.gs1.org/01/09520123456788/21/12345", + "type": "string", + "format": "uri", + "description": "The globally unique ID of the entity as a resolvable URL according to ISO 18975. ExamplesProduct - id.gs1.org/01/09520123456788/21/12345 Party - abr.business.gov.au/ABN/View?abn=90664869327. Facility - did:web:facilities.example-company.com:123. " + }, + "name": { + "example": "EV battery 300Ah.", + "type": "string", + "description": "The registered name of the entity within the identifier scheme. Examplesproduct - EV battery 300Ahparty - Sample Company Pty Ltd. facility - Greenacres battery factory" + }, + "registeredId": { + "example": "90664869327", + "type": "string", + "description": "The registration number (alphanumeric) of the entity within the register. Unique within the register." + }, + "idScheme": { + "$ref": "#/$defs/IdentifierScheme", + "description": "The identifier scheme. Exampleproduct - id.gs1.org/01. party - business.gov.au/abn facility - did:web:facilities.acme.com. " + }, + "IDverifiedByCAB": { + "example": "true", + "type": "boolean", + "description": "Indicates whether the conformity assessment body has verified the identity of the facility which is the subject of the assement." + } + }, + "description": "The facility which is the subject of this conformity assessment", + "required": [ + "id", + "name" + ] + } + } + } \ No newline at end of file diff --git a/packages/untp-test-suite/src/schemas/objectEvent/v0.3.10/schema.json b/packages/untp-test-suite/src/schemas/objectEvent/v0.3.10/schema.json new file mode 100644 index 00000000..7eb01905 --- /dev/null +++ b/packages/untp-test-suite/src/schemas/objectEvent/v0.3.10/schema.json @@ -0,0 +1,926 @@ +{ + "type": "object", + "additionalProperties": false, + "properties": { + "render": { + "type": "array", + "items": { + "template": { + "example": " Digital Product Passport
Digital Product Passport
{{credentialSubject.name}}
Batch: {{credentialSubject.batchNumber}}
Serial: {{credentialSubject.serialNumber}}

Product Details

ID: {{credentialSubject.id}}

Description: {{credentialSubject.description}}

Category: {{#each credentialSubject.productCategory}} {{name}} {{/each}}

Dimensions: {{credentialSubject.dimensions.length.value}} x {{credentialSubject.dimensions.width.value}} x {{credentialSubject.dimensions.height.value}} {{credentialSubject.dimensions.length.unit}}

Weight: {{credentialSubject.dimensions.weight.value}} {{credentialSubject.dimensions.weight.unit}}

Country of Production: {{credentialSubject.countryOfProduction}}

Materials Provenance

{{#each credentialSubject.materialsProvenance}}
{{name}} {{originCountry}} {{materialType.name}} {{massFraction}}
{{/each}}

Conformity Declarations

{{#each credentialSubject.conformityDeclarations}}

{{referenceStandard.name}} - {{referenceRegulation.name}}

{{/each}}

Circularity and Emissions

Circularity Score: {{credentialSubject.circularityScorecard.materialCircularityIndicator}}
Carbon Footprint: {{credentialSubject.emissionsScorecard.carbonFootprint}}
", + "type": "string", + "description": "A template that renders the Verifiable Credential to HTML" + }, + "@type": { + "type": "string", + "enum": [ + "WebRenderingTemplate2022" + ], + "example": "WebRenderingTemplate2022", + "description": "Defines the rendering type." + } + }, + "description": "Defines a template to be used to render the Verifiable Credential." + }, + "type": { + "type": "array", + "readOnly": true, + "const": [ + "DigitalTraceabilityEvent", + "VerifiableCredential" + ], + "default": [ + "DigitalTraceabilityEvent", + "VerifiableCredential" + ], + "items": { + "type": "string", + "enum": [ + "DigitalTraceabilityEvent", + "VerifiableCredential" + ] + } + }, + "id": { + "example": "https://example-company.com/credentials/2a423366-a0d6-4855-ba65-2e0c926d09b0", + "type": "string", + "format": "uri", + "description": "A unique identifier (URI) assigned to the product passport. May be a UUID" + }, + "@context": { + "example": "https://test.uncefact.org/vocabulary/untp/dcc/dcc-context.jsonld", + "type": "array", + "items": { + "type": "string", + "enum": [ + "https://www.w3.org/ns/credentials/v2", + "https://test.uncefact.org/vocabulary/untp/dte/0.3.10", + "https://dev-render-method-context.s3.ap-southeast-1.amazonaws.com/dev-render-method-context.json" + ] + }, + "description": "A list of JSON-LD context URIs that define the seamntic meaning of prperties within the credential. ", + "readOnly": true, + "const": [ + "https://www.w3.org/ns/credentials/v2", + "https://test.uncefact.org/vocabulary/untp/dte/0.3.10", + "https://dev-render-method-context.s3.ap-southeast-1.amazonaws.com/dev-render-method-context.json" + ], + "default": [ + "https://www.w3.org/ns/credentials/v2", + "https://test.uncefact.org/vocabulary/untp/dte/0.3.10", + "https://dev-render-method-context.s3.ap-southeast-1.amazonaws.com/dev-render-method-context.json" + ] + }, + "issuer": { + "$ref": "#/$defs/CredentialIssuer", + "description": "The organisation that is the isuer of this VC. Note that the \"id\" property MUST be a W3C DID. Other identifiers such as tax registration numbers can be listed in the \"otherIdentifiers\" property." + }, + "validFrom": { + "example": "2024-03-15T12:00:00", + "type": "string", + "format": "date-time", + "description": "The date and time from which the credential is valid." + }, + "credentialSubject": { + "type": "array", + "items": { + "$ref": "#/$defs/Event" + }, + "description": "VC subject is the transaction event structure" + } + }, + "description": "Traceability Event as a VC", + "required": [ + "id", + "@context", + "issuer" + ], + "$schema": "https://json-schema.org/draft/2020-12/schema", + "$defs": { + "CredentialIssuer": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "CredentialIssuer" + ], + "default": [ + "CredentialIssuer" + ], + "items": { + "type": "string", + "enum": [ + "CredentialIssuer" + ] + } + }, + "id": { + "example": "did:web:identifiers.example-company.com:12345", + "type": "string", + "format": "uri", + "description": "The W3C DID of the issuer - should be a did:web or did:tdw" + }, + "name": { + "example": "Example Company Pty Ltd", + "type": "string", + "description": "The name of the issuer person or organisation" + }, + "otherIdentifiers": { + "type": "array", + "items": { + "$ref": "#/$defs/Entity" + }, + "description": "An optional list of other registered identifiers for this credential issuer " + } + }, + "description": "The issuer party ()person or orgnaition) of a verifiable credential.", + "required": [ + "id", + "name" + ] + }, + "Entity": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "Entity" + ], + "default": [ + "Entity" + ], + "items": { + "type": "string", + "enum": [ + "Entity" + ] + } + }, + "id": { + "example": "https://id.gs1.org/01/09520123456788/21/12345", + "type": "string", + "format": "uri", + "description": "The globally unique ID of the entity as a resolvable URL according to ISO 18975. ExamplesProduct - id.gs1.org/01/09520123456788/21/12345 Party - abr.business.gov.au/ABN/View?abn=90664869327. Facility - did:web:facilities.example-company.com:123. " + }, + "name": { + "example": "EV battery 300Ah.", + "type": "string", + "description": "The registered name of the entity within the identifier scheme. Examplesproduct - EV battery 300Ahparty - Sample Company Pty Ltd. facility - Greenacres battery factory" + }, + "registeredId": { + "example": "90664869327", + "type": "string", + "description": "The registration number (alphanumeric) of the entity within the register. Unique within the register." + }, + "idScheme": { + "$ref": "#/$defs/IdentifierScheme", + "description": "The identifier scheme. Exampleproduct - id.gs1.org/01. party - business.gov.au/abn facility - did:web:facilities.acme.com. " + } + }, + "description": "The ID and Name of an identified entity such qs a product, facility, party, standard, etc. If the identifier is a W3C DID then the corresponding DID document SHOULD include a serviceEndpoint of type \"IdentityResolver\". If the identifier is not a W3C DID then the id peroperty SHOULD be an identity resolver URL.", + "required": [ + "id", + "name" + ] + }, + "IdentifierScheme": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "IdentifierScheme" + ], + "default": [ + "IdentifierScheme" + ], + "items": { + "type": "string", + "enum": [ + "IdentifierScheme" + ] + } + }, + "id": { + "example": "https://id.gs1.org/01/", + "type": "string", + "format": "uri", + "description": "The globally unique identifier of the registration scheme. The scheme should be registered and discoverable from vocabulary.uncefact.org/identifierSchemes" + }, + "name": { + "example": "Global Trade Identification Number (GTIN)", + "type": "string", + "description": "The name of the identifier scheme. " + } + }, + "description": "An identifier registration scheme for products, facilities, or organisations. Typically operated by a state, national or gloabl authority." + }, + "TransformationEvent": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "TransformationEvent", + "Event" + ], + "default": [ + "TransformationEvent", + "Event" + ], + "items": { + "type": "string", + "enum": [ + "TransformationEvent", + "Event" + ] + } + }, + "id": { + "readOnly": true, + "example": "https://events.sample.com/b681df10-c682-454a-b11b-d0b9374c01bd", + "type": "string", + "format": "uri", + "description": "The unique identifier of this event - SHOULD be a UUID" + }, + "eventTime": { + "example": "2024-09-01T12:00:00", + "type": "string", + "format": "date-time", + "description": "The ISO-8601 date time when the event occurred." + }, + "action": { + "type": "string", + "enum": [ + "observe", + "add", + "delete" + ], + "example": "observe", + "description": "Code describing how an event relates to the lifecycle of the entity impacted by the event." + }, + "disposition": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/Disp", + "description": "Disposition code describing the state of the item after the event. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/Disp\n " + }, + "bizStep": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/BizStep", + "description": "A business step code drawn from a controlled vocabulary.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/BizStep\n " + }, + "bizLocation": { + "example": "https://id.gs1.org/414/9520123456788", + "type": "string", + "format": "uri", + "description": "A Business Location is a uniquely identified and discretely recorded geospatial location that is meant to designate the specific place where an object is assumed to be following an EPCIS event until it is reported to be at a different Business Location by a subsequent EPCIS event. The bizLocation must be a resolvable URI that links to facility information and geolocation data." + }, + "sensorElementList": { + "type": "array", + "items": { + "$ref": "#/$defs/SensorElement" + }, + "description": "An array (one for each sensor) of sensor device data sets associated with the event. " + }, + "outputEPCList": { + "type": "array", + "items": { + "$ref": "#/$defs/Item" + }, + "description": "The list of uniquely identified items that are the output of this transformation event - for example a list of individually identified bolts of cloth that are the output of a weaving process." + }, + "inputEPCList": { + "type": "array", + "items": { + "$ref": "#/$defs/Item" + }, + "description": "The list of uniquely identified items that are the input of this transformation event - for example a list of individually identified bobbins of yarn that are the input of a weaving process." + }, + "inputQuantityList": { + "type": "array", + "items": { + "$ref": "#/$defs/QuantityElement" + }, + "description": "The quantified list of product classes that are the input of this transformation event - used when each item does not have a unique identity. for example the weight of raw cotton that is the input to a ginning process." + }, + "outputQuantityList": { + "type": "array", + "items": { + "$ref": "#/$defs/QuantityElement" + }, + "description": "The quantified list of product classes that are the output of this transformation event - used when each item does not have a unique identity. for example a count of the bales of cleaned cotton that are the output of a ginning process." + }, + "processType": { + "example": "https://textileIndustry.org/spinning", + "type": "string", + "format": "uri", + "description": "An industry specific process type code. " + } + }, + "description": "Transformation represents an event in which input objects are fully or partially consumed and output objects are produced, such that any of the input objects may have contributed to all of the output objects - for example consuming bales of cotton to produce yarn." + }, + "SensorElement": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "SensorElement" + ], + "default": [ + "SensorElement" + ], + "items": { + "type": "string", + "enum": [ + "SensorElement" + ] + } + }, + "sensorMetadata": { + "$ref": "#/$defs/Sensor", + "description": "Data that describes the physical sensor that recorded the sensor data set." + }, + "sensorReport": { + "type": "array", + "items": { + "$ref": "#/$defs/SensorData" + }, + "description": "A list of sensor readings from the given sensor relevant to the traceability event context." + }, + "sensorIntegrityProof": { + "type": "string", + "format": "uri", + "description": "An optional reference to a verifiable credential signed by the sensor device or device manufacturer that contains the digitally signed raw data associated with this sensor report." + } + }, + "description": "A SensorElement is used to carry data related to an event that is captured one sensor such as an IoT device. Include one sensor property and an array of sensor data values." + }, + "Sensor": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "Sensor" + ], + "default": [ + "Sensor" + ], + "items": { + "type": "string", + "enum": [ + "Sensor" + ] + } + }, + "device": { + "$ref": "#/$defs/Item", + "description": "The device Identifier for the sensor as a URI (typically an EPC)" + }, + "dataProcessingMethod": { + "example": "https://standards.org/sensorMethod#1234", + "type": "string", + "format": "uri", + "description": "The data processing method used by the sensor - should reference a documented standard criteria as a URI" + } + }, + "description": "A physical sensor that records a sensor data set." + }, + "Item": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "Item", + "Entity" + ], + "default": [ + "Item", + "Entity" + ], + "items": { + "type": "string", + "enum": [ + "Item", + "Entity" + ] + } + }, + "id": { + "example": "https://id.gs1.org/01/09520123456788/21/12345", + "type": "string", + "format": "uri", + "description": "The globally unique ID of the entity as a resolvable URL according to ISO 18975. ExamplesProduct - id.gs1.org/01/09520123456788/21/12345 Party - abr.business.gov.au/ABN/View?abn=90664869327. Facility - did:web:facilities.example-company.com:123. " + }, + "name": { + "example": "EV battery 300Ah.", + "type": "string", + "description": "The name of the product class to which the product item belongs. " + }, + "registeredId": { + "example": "90664869327", + "type": "string", + "description": "The registration number (alphanumeric) of the entity within the register. Unique within the register." + }, + "idScheme": { + "$ref": "#/$defs/IdentifierScheme", + "description": "The identifier scheme. Exampleproduct - id.gs1.org/01. party - business.gov.au/abn facility - did:web:facilities.acme.com. " + } + }, + "description": "A specific serilaised trade item which is a type of a more generic product. Typically an SGTIN", + "required": [ + "id", + "name" + ] + }, + "SensorData": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "SensorData" + ], + "default": [ + "SensorData" + ], + "items": { + "type": "string", + "enum": [ + "SensorData" + ] + } + }, + "time": { + "example": "2024-07-24T12:00:00", + "type": "string", + "format": "date-time", + "description": "the timestamp at which the sensor reading was made." + }, + "sensorType": { + "example": "https://samplesensors.com/model1234", + "type": "string", + "format": "uri", + "description": "the measurement type of the sensor reading, as a URI reference to a measurement method specification." + }, + "value": { + "example": 25, + "type": "number", + "description": "the sensor reading" + }, + "uom": { + "type": "string", + "x-external-enumeration": "https://vocabulary.uncefact.org/UnitMeasureCode", + "description": "the unit of measure for the sensor reading, drawn from UNECE rec20 code list.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://vocabulary.uncefact.org/UnitMeasureCode\n " + } + }, + "description": "A data point read by a sensor." + }, + "QuantityElement": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "QuantityElement" + ], + "default": [ + "QuantityElement" + ], + "items": { + "type": "string", + "enum": [ + "QuantityElement" + ] + } + }, + "product": { + "$ref": "#/$defs/Entity", + "description": "THe identifier of a product class (as opposed to a product instance) such as a GTIN code for a manufactured product." + }, + "quantity": { + "example": 20, + "type": "number", + "description": "The numeric quantity of the product class (eg 100 kg of cotton)" + }, + "uom": { + "type": "string", + "x-external-enumeration": "https://vocabulary.uncefact.org/UnitMeasureCode", + "description": "The unit of measure for the quantity value (eg Kg or meters etc) using the UNECE Rec 20 unit of measure codelist.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://vocabulary.uncefact.org/UnitMeasureCode\n " + } + }, + "description": "The quantity element is used to define the quantities (eg 100), units of measure (eg Kg) and product class (eg GTIN or other class identifier) of products that are inputs or outputs or the subject of supply chain events. ", + "required": [ + "product", + "quantity" + ] + }, + "ObjectEvent": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "ObjectEvent", + "Event" + ], + "default": [ + "ObjectEvent", + "Event" + ], + "items": { + "type": "string", + "enum": [ + "ObjectEvent", + "Event" + ] + } + }, + "id": { + "readOnly": true, + "example": "https://events.sample.com/b681df10-c682-454a-b11b-d0b9374c01bd", + "type": "string", + "format": "uri", + "description": "The unique identifier of this event - SHOULD be a UUID" + }, + "eventTime": { + "example": "2024-09-01T12:00:00", + "type": "string", + "format": "date-time", + "description": "The ISO-8601 date time when the event occurred." + }, + "action": { + "type": "string", + "enum": [ + "observe", + "add", + "delete" + ], + "example": "observe", + "description": "Code describing how an event relates to the lifecycle of the entity impacted by the event." + }, + "disposition": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/Disp", + "description": "Disposition code describing the state of the item after the event. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/Disp\n " + }, + "bizStep": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/BizStep", + "description": "A business step code drawn from a controlled vocabulary.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/BizStep\n " + }, + "bizLocation": { + "example": "https://id.gs1.org/414/9520123456788", + "type": "string", + "format": "uri", + "description": "A Business Location is a uniquely identified and discretely recorded geospatial location that is meant to designate the specific place where an object is assumed to be following an EPCIS event until it is reported to be at a different Business Location by a subsequent EPCIS event. The bizLocation must be a resolvable URI that links to facility information and geolocation data." + }, + "sensorElementList": { + "type": "array", + "items": { + "$ref": "#/$defs/SensorElement" + }, + "description": "An array (one for each sensor) of sensor device data sets associated with the event. " + }, + "epcList": { + "type": "array", + "items": { + "$ref": "#/$defs/Item" + }, + "description": "A list of uniquely identified items (eg specific items serial numbers or tagged shipments / packages) that are the focus of this object event. " + }, + "quantityList": { + "type": "array", + "items": { + "$ref": "#/$defs/QuantityElement" + }, + "description": "A quantified list of product classes (eg GS1 GTINs) that are the focus of this object event" + } + }, + "description": "Object represents an event that happened to one or more physical or digital objects - such as an inspection or certification of a product or shipment. The physical objects may be identified either as specific items (eg a unique consignment number) or as a quantified amount of a product class (eg 100Kg of cotton yarn)" + }, + "AggregationEvent": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "AggregationEvent", + "Event" + ], + "default": [ + "AggregationEvent", + "Event" + ], + "items": { + "type": "string", + "enum": [ + "AggregationEvent", + "Event" + ] + } + }, + "id": { + "readOnly": true, + "example": "https://events.sample.com/b681df10-c682-454a-b11b-d0b9374c01bd", + "type": "string", + "format": "uri", + "description": "The unique identifier of this event - SHOULD be a UUID" + }, + "eventTime": { + "example": "2024-09-01T12:00:00", + "type": "string", + "format": "date-time", + "description": "The ISO-8601 date time when the event occurred." + }, + "action": { + "type": "string", + "enum": [ + "observe", + "add", + "delete" + ], + "example": "observe", + "description": "Code describing how an event relates to the lifecycle of the entity impacted by the event." + }, + "disposition": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/Disp", + "description": "Disposition code describing the state of the item after the event. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/Disp\n " + }, + "bizStep": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/BizStep", + "description": "A business step code drawn from a controlled vocabulary.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/BizStep\n " + }, + "bizLocation": { + "example": "https://id.gs1.org/414/9520123456788", + "type": "string", + "format": "uri", + "description": "A Business Location is a uniquely identified and discretely recorded geospatial location that is meant to designate the specific place where an object is assumed to be following an EPCIS event until it is reported to be at a different Business Location by a subsequent EPCIS event. The bizLocation must be a resolvable URI that links to facility information and geolocation data." + }, + "sensorElementList": { + "type": "array", + "items": { + "$ref": "#/$defs/SensorElement" + }, + "description": "An array (one for each sensor) of sensor device data sets associated with the event. " + }, + "parentEPC": { + "$ref": "#/$defs/Item", + "description": "The unique item identifier that is the result of this aggregation. Typically a packaging ID used in shipments that represents a box/ pallet / container of contained items." + }, + "childEPCs": { + "type": "array", + "items": { + "$ref": "#/$defs/Item" + }, + "description": "The list of child items that have been aggregated into the parent (or dis-aggregated from the parent). Maybe a list of package references (eg boxes on a pallet) or may be individual items (eg products in a box)." + }, + "childQuantityList": { + "type": "array", + "items": { + "$ref": "#/$defs/QuantityElement" + }, + "description": "List of quantified product classes that have been aggregated into the parent. Used whwn the child items do not have unique identifiers (eg 100 Kg of cotton bales)" + } + }, + "description": "Aggregation represents an event that happened to one or more objects that are physically aggregated together (physically constrained to be in the same place at the same time, as when cases are aggregated to a pallet). This event is also used to represent de-aggregation (eg unpacking) when businessStepCode is unpacking." + }, + "TransactionEvent": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "TransactionEvent", + "Event" + ], + "default": [ + "TransactionEvent", + "Event" + ], + "items": { + "type": "string", + "enum": [ + "TransactionEvent", + "Event" + ] + } + }, + "id": { + "readOnly": true, + "example": "https://events.sample.com/b681df10-c682-454a-b11b-d0b9374c01bd", + "type": "string", + "format": "uri", + "description": "The unique identifier of this event - SHOULD be a UUID" + }, + "eventTime": { + "example": "2024-09-01T12:00:00", + "type": "string", + "format": "date-time", + "description": "The ISO-8601 date time when the event occurred." + }, + "action": { + "type": "string", + "enum": [ + "observe", + "add", + "delete" + ], + "example": "observe", + "description": "Code describing how an event relates to the lifecycle of the entity impacted by the event." + }, + "disposition": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/Disp", + "description": "Disposition code describing the state of the item after the event. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/Disp\n " + }, + "bizStep": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/BizStep", + "description": "A business step code drawn from a controlled vocabulary.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/BizStep\n " + }, + "bizLocation": { + "example": "https://id.gs1.org/414/9520123456788", + "type": "string", + "format": "uri", + "description": "A Business Location is a uniquely identified and discretely recorded geospatial location that is meant to designate the specific place where an object is assumed to be following an EPCIS event until it is reported to be at a different Business Location by a subsequent EPCIS event. The bizLocation must be a resolvable URI that links to facility information and geolocation data." + }, + "sensorElementList": { + "type": "array", + "items": { + "$ref": "#/$defs/SensorElement" + }, + "description": "An array (one for each sensor) of sensor device data sets associated with the event. " + }, + "sourceParty": { + "$ref": "#/$defs/Entity", + "description": "The source party for this supply chain transaction - typically the seller party" + }, + "destinationParty": { + "$ref": "#/$defs/Entity", + "description": "The destination party for this supply chain transaction - typically the buyer party." + }, + "bizTransaction": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/BTT", + "description": "The document type representing the trade transaction drawn from the business transaction type vocabulary.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/BTT\n " + }, + "epcList": { + "type": "array", + "items": { + "$ref": "#/$defs/Item" + }, + "description": "The list of uniquely identified trade items included in this supply chain transaction." + }, + "quantityList": { + "type": "array", + "items": { + "$ref": "#/$defs/QuantityElement" + }, + "description": "List of quantified product classes that are included in this transaction. Used when the trade items do not have unique identifiers (eg 100 reels of yarn)" + } + }, + "description": "Transaction represents an event in which one or more objects become associated or disassociated with one or more identified business transactions - such as the purchase / shipment of goods between buyer and seller." + }, + "AssociationEvent": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "AssociationEvent", + "Event" + ], + "default": [ + "AssociationEvent", + "Event" + ], + "items": { + "type": "string", + "enum": [ + "AssociationEvent", + "Event" + ] + } + }, + "id": { + "readOnly": true, + "example": "https://events.sample.com/b681df10-c682-454a-b11b-d0b9374c01bd", + "type": "string", + "format": "uri", + "description": "The unique identifier of this event - SHOULD be a UUID" + }, + "eventTime": { + "example": "2024-09-01T12:00:00", + "type": "string", + "format": "date-time", + "description": "The ISO-8601 date time when the event occurred." + }, + "action": { + "type": "string", + "enum": [ + "observe", + "add", + "delete" + ], + "example": "observe", + "description": "Code describing how an event relates to the lifecycle of the entity impacted by the event." + }, + "disposition": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/Disp", + "description": "Disposition code describing the state of the item after the event. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/Disp\n " + }, + "bizStep": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/BizStep", + "description": "A business step code drawn from a controlled vocabulary.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/BizStep\n " + }, + "bizLocation": { + "example": "https://id.gs1.org/414/9520123456788", + "type": "string", + "format": "uri", + "description": "A Business Location is a uniquely identified and discretely recorded geospatial location that is meant to designate the specific place where an object is assumed to be following an EPCIS event until it is reported to be at a different Business Location by a subsequent EPCIS event. The bizLocation must be a resolvable URI that links to facility information and geolocation data." + }, + "sensorElementList": { + "type": "array", + "items": { + "$ref": "#/$defs/SensorElement" + }, + "description": "An array (one for each sensor) of sensor device data sets associated with the event. " + }, + "parentEPC": { + "$ref": "#/$defs/Item", + "description": "The unique item identifier that is the parent of this association. Typically an assembled product ID such as a desktop computer that is built from the associated child components." + }, + "childEPCs": { + "type": "array", + "items": { + "$ref": "#/$defs/Item" + }, + "description": "The list of child items that have been assembled to create the parent - for example the power supply or hard drive components of a desktop computer." + }, + "childQuantityList": { + "type": "array", + "items": { + "$ref": "#/$defs/QuantityElement" + }, + "description": "List of quantified product classes that have been assembled into the parent. Used when the child items do not have unique identifiers (eg brackets and screws used in the assembly of a desktop computer)" + } + }, + "description": "The association event represents the assembly of child sub-components to create a parent assembled item. For example a desktop computer assembled from power supply, hard drive, and motherboard. The association event is very similar in structure to the aggregation event but is used for physical assembly. An association event may represent a bill of materials used to assemble a product whilst an aggregation event may represent a packing list or items for transport. " + }, + "Event": { + "type": "object", + "oneOf": [ + { + "$ref": "#/$defs/TransformationEvent" + }, + { + "$ref": "#/$defs/ObjectEvent" + }, + { + "$ref": "#/$defs/AggregationEvent" + }, + { + "$ref": "#/$defs/TransactionEvent" + }, + { + "$ref": "#/$defs/AssociationEvent" + } + ], + "description": "This abstract event structure provides a common language to describe supply chain events such as shipments, inspections, manufacturing processes, etc. There are four types of EPCIS event but this is an abstract class representing all common properties of an EPCIS event. " + } + } +} \ No newline at end of file diff --git a/packages/untp-test-suite/src/schemas/objectEvent/v0.3.9/schema.json b/packages/untp-test-suite/src/schemas/objectEvent/v0.3.9/schema.json new file mode 100644 index 00000000..f24d452c --- /dev/null +++ b/packages/untp-test-suite/src/schemas/objectEvent/v0.3.9/schema.json @@ -0,0 +1,817 @@ +{ + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "DigitalTraceabilityEvent", + "VerifiableCredential" + ], + "default": [ + "DigitalTraceabilityEvent", + "VerifiableCredential" + ], + "items": { + "type": "string", + "enum": [ + "DigitalTraceabilityEvent", + "VerifiableCredential" + ] + } + }, + "@context": { + "example": "https://test.uncefact.org/vocabulary/untp/dpp/dpp-context.jsonld", + "type": "array", + "items": { + "type": "string", + "enum": [ + "https://www.w3.org/ns/credentials/v2", + "https://vocabulary.uncefact.org/untp/dte/{{version}}" + ] + }, + "description": "A list of JSON-LD context URIs that define the seamntic meaning of prperties within the credential. ", + "readOnly": true, + "const": [ + "https://www.w3.org/ns/credentials/v2", + "https://vocabulary.uncefact.org/untp/dte/{{version}}" + ], + "default": [ + "https://www.w3.org/ns/credentials/v2", + "https://vocabulary.uncefact.org/untp/dte/{{version}}" + ] + }, + "id": { + "example": "https://example-company.com/credentials/2a423366-a0d6-4855-ba65-2e0c926d09b0", + "type": "string", + "format": "uri", + "description": "A unique identifier (URI) assigned to the product passport. May be a UUID" + }, + "issuer": { + "$ref": "#/$defs/CredentialIssuer", + "description": "The organisation that is the isuer of this VC. Note that the \"id\" property MUST be a W3C DID. Other identifiers such as tax registration numbers can be listed in the \"otherIdentifiers\" property." + }, + "validFrom": { + "example": "2024-03-15", + "type": "string", + "format": "date-time", + "description": "The date and time from which the credential is valid." + }, + "validUntil": { + "example": "2034-03-15", + "type": "string", + "format": "date-time", + "description": "The expiry date (if applicable) of this verifiable credential." + }, + "credentialSubject": { + "type": "array", + "items": { + "$ref": "#/$defs/Event" + }, + "description": "VC subject is the transaction event structure" + } + }, + "description": "Traceability Event as a VC", + "required": [ + "@context", + "id", + "issuer" + ], + "$schema": "https://json-schema.org/draft/2020-12/schema", + "$defs": { + "CredentialIssuer": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "default": "CredentialIssuer", + "enum": [ + "CredentialIssuer" + ] + }, + "id": { + "example": "did:web:identifiers.example-company.com:12345", + "type": "string", + "format": "uri", + "description": "The W3C DID of the issuer - should be a did:web or did:tdw" + }, + "name": { + "example": "Example Company Pty Ltd", + "type": "string", + "description": "The name of the issuer person or organisation" + }, + "otherIdentifiers": { + "type": "array", + "items": { + "$ref": "#/$defs/Entity" + }, + "description": "An optional list of other registered identifiers for this credential issuer " + } + }, + "description": "The issuer party ()person or orgnaition) of a verifiable credential.", + "required": [ + "id", + "name" + ] + }, + "Entity": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "default": "Entity", + "enum": [ + "Entity" + ] + }, + "id": { + "example": "https://id.gs1.org/01/09520123456788/21/12345", + "type": "string", + "format": "uri", + "description": "The globally unique ID of the entity as a resolvable URL according to ISO 18975. ExamplesProduct - id.gs1.org/01/09520123456788/21/12345 Party - abr.business.gov.au/ABN/View?abn=90664869327. Facility - did:web:facilities.example-company.com:123. " + }, + "name": { + "example": "EV battery 300Ah.", + "type": "string", + "description": "The registered name of the entity within the identifier scheme. Examplesproduct - EV battery 300Ahparty - Sample Company Pty Ltd. facility - Greenacres battery factory" + }, + "registeredId": { + "example": "90664869327", + "type": "string", + "description": "The registration number (alphanumeric) of the entity within the register. Unique within the register." + }, + "idScheme": { + "$ref": "#/$defs/IdentifierScheme", + "description": "The identifier scheme. Exampleproduct - id.gs1.org/01. party - business.gov.au/abn facility - did:web:facilities.acme.com. " + } + }, + "description": "The ID and Name of an identified entity such qs a product, facility, party, standard, etc. If the identifier is a W3C DID then the corresponding DID document SHOULD include a serviceEndpoint of type \"IdentityResolver\". If the identifier is not a W3C DID then the id peroperty SHOULD be an identity resolver URL.", + "required": [ + "id", + "name" + ] + }, + "IdentifierScheme": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "default": "IdentifierScheme", + "enum": [ + "IdentifierScheme" + ] + }, + "id": { + "example": "https://id.gs1.org/01/", + "type": "string", + "format": "uri", + "description": "The globally unique identifier of the registration scheme. The scheme should be registered and discoverable from vocabulary.uncefact.org/identifierSchemes" + }, + "name": { + "example": "Global Trade Identification Number (GTIN)", + "type": "string", + "description": "The name of the identifier scheme. " + } + }, + "description": "An identifier registration scheme for products, facilities, or organisations. Typically operated by a state, national or gloabl authority." + }, + "TransformationEvent": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "TransformationEvent", + "Event" + ], + "default": [ + "TransformationEvent", + "Event" + ], + "items": { + "type": "string", + "enum": [ + "TransformationEvent", + "Event" + ] + } + }, + "id": { + "readOnly": true, + "type": "string", + "format": "uri", + "description": "The unique identifier of this event - SHOULD be a UUID" + }, + "eventTime": { + "type": "string", + "format": "date-time", + "description": "The ISO-8601 date time when the event occurred." + }, + "action": { + "type": "string", + "enum": [ + "observe", + "add", + "delete" + ], + "example": "observe", + "description": "Code describing how an event relates to the lifecycle of the entity impacted by the event." + }, + "disposition": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/Disp", + "description": "Disposition code describing the state of the item after the event. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/Disp\n " + }, + "bizStep": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/BizStep", + "description": "A business step code drawn from a controlled vocabulary. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/BizStep\n " + }, + "bizLocation": { + "type": "string", + "format": "uri", + "description": "A Business Location is a uniquely identified and discretely recorded geospatial location that is meant to designate the specific place where an object is assumed to be following an EPCIS event until it is reported to be at a different Business Location by a subsequent EPCIS event. The bizLocation must be a resolvable URI that links to facility information and geolocation data." + }, + "sensorElementList": { + "type": "array", + "items": { + "$ref": "#/$defs/SensorElement" + }, + "description": "An array (one for each sensor) of sensor device data sets associated with the event. " + }, + "outputEPCList": { + "type": "array", + "items": { + "$ref": "#/$defs/Item" + }, + "description": "The list of uniquely identified items that are the output of this transformation event - for example a list of individually identified bolts of cloth that are the output of a weaving process." + }, + "inputEPCList": { + "type": "array", + "items": { + "$ref": "#/$defs/Item" + }, + "description": "The list of uniquely identified items that are the input of this transformation event - for example a list of individually identified bobbins of yarn that are the input of a weaving process." + }, + "inputQuantityList": { + "type": "array", + "items": { + "$ref": "#/$defs/QuantityElement" + }, + "description": "The quantified list of product classes that are the input of this transformation event - used when each item does not have a unique identity. for example the weight of raw cotton that is the input to a ginning process." + }, + "outputQuantityList": { + "type": "array", + "items": { + "$ref": "#/$defs/QuantityElement" + }, + "description": "The quantified list of product classes that are the output of this transformation event - used when each item does not have a unique identity. for example a count of the bales of cleaned cotton that are the output of a ginning process." + }, + "processType": { + "type": "string", + "format": "uri", + "description": "An industry specific process type code. " + } + }, + "description": "Transformation represents an event in which input objects are fully or partially consumed and output objects are produced, such that any of the input objects may have contributed to all of the output objects - for example consuming bales of cotton to produce yarn." + }, + "SensorElement": { + "type": "object", + "additionalProperties": false, + "properties": { + "sensorMetadata": { + "$ref": "#/$defs/Sensor", + "description": "Data that describes the physical sensor that recorded the sensor data set." + }, + "sensorReport": { + "type": "array", + "items": { + "$ref": "#/$defs/SensorData" + }, + "description": "A list of sensor readings from the given sensor relevant to the traceability event context." + }, + "sensorIntegrityProof": { + "type": "string", + "format": "uri", + "description": "An optional reference to a verifiable credential signed by the sensor device or device manufacturer that contains the digitally signed raw data associated with this sensor report." + } + }, + "description": "A SensorElement is used to carry data related to an event that is captured one sensor such as an IoT device. Include one sensor property and an array of sensor data values." + }, + "Sensor": { + "type": "object", + "additionalProperties": false, + "properties": { + "device": { + "$ref": "#/$defs/Item", + "description": "The device Identifier for the sensor as a URI (typically an EPC)" + }, + "dataProcessingMethod": { + "type": "string", + "format": "uri", + "description": "The data processing method used by the sensor - should reference a documented standard criteria as a URI" + } + }, + "description": "A physical sensor that records a sensor data set." + }, + "Item": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "Item", + "Entity" + ], + "default": [ + "Item", + "Entity" + ], + "items": { + "type": "string", + "enum": [ + "Item", + "Entity" + ] + } + }, + "id": { + "example": "https://id.gs1.org/01/09520123456788/21/12345", + "type": "string", + "format": "uri", + "description": "The globally unique ID of the entity as a resolvable URL according to ISO 18975. ExamplesProduct - id.gs1.org/01/09520123456788/21/12345 Party - abr.business.gov.au/ABN/View?abn=90664869327. Facility - did:web:facilities.example-company.com:123. " + }, + "name": { + "example": "EV battery 300Ah.", + "type": "string", + "description": "The registered name of the entity within the identifier scheme. Examplesproduct - EV battery 300Ahparty - Sample Company Pty Ltd. facility - Greenacres battery factory" + }, + "registeredId": { + "example": "90664869327", + "type": "string", + "description": "The registration number (alphanumeric) of the entity within the register. Unique within the register." + }, + "idScheme": { + "$ref": "#/$defs/IdentifierScheme", + "description": "The identifier scheme. Exampleproduct - id.gs1.org/01. party - business.gov.au/abn facility - did:web:facilities.acme.com. " + } + }, + "description": "A specific serilaised trade item which is a type of a more generic product. Typically an SGTIN", + "required": [ + "id", + "name" + ] + }, + "SensorData": { + "type": "object", + "additionalProperties": false, + "properties": { + "time": { + "type": "string", + "format": "date-time", + "description": "the timestamp at which the sensor reading was made." + }, + "sensorType": { + "type": "string", + "format": "uri", + "description": "the measurement type of the sensor reading, as a URI reference to a measurement method specification." + }, + "value": { + "type": "number", + "description": "the sensor reading" + }, + "uom": { + "type": "string", + "x-external-enumeration": "https://vocabulary.uncefact.org/UnitMeasureCode", + "description": "the unit of measure for the sensor reading\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://vocabulary.uncefact.org/UnitMeasureCode\n " + } + }, + "description": "A data point read by a sensor." + }, + "QuantityElement": { + "type": "object", + "additionalProperties": false, + "properties": { + "product": { + "$ref": "#/$defs/Entity", + "description": "THe identifier of a product class (as opposed to a product instance) such as a GTIN code for a manufactured product." + }, + "quantity": { + "type": "number", + "description": "The numeric quantity of the product class (eg 100 kg of cotton)" + }, + "uom": { + "type": "string", + "x-external-enumeration": "https://vocabulary.uncefact.org/UnitMeasureCode", + "description": "The unit of measure for the quantity value (eg Kg or meters etc) using the UNECE Rec 20 unit of measure codelist.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://vocabulary.uncefact.org/UnitMeasureCode\n " + } + }, + "description": "The quantity element is used to define the quantities (eg 100), units of measure (eg Kg) and product class (eg GTIN or other class identifier) of products that are inputs or outputs or the subject of supply chain events. ", + "required": [ + "quantity" + ] + }, + "ObjectEvent": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "ObjectEvent", + "Event" + ], + "default": [ + "ObjectEvent", + "Event" + ], + "items": { + "type": "string", + "enum": [ + "ObjectEvent", + "Event" + ] + } + }, + "id": { + "readOnly": true, + "type": "string", + "format": "uri", + "description": "The unique identifier of this event - SHOULD be a UUID" + }, + "eventTime": { + "type": "string", + "format": "date-time", + "description": "The ISO-8601 date time when the event occurred." + }, + "action": { + "type": "string", + "enum": [ + "observe", + "add", + "delete" + ], + "example": "observe", + "description": "Code describing how an event relates to the lifecycle of the entity impacted by the event." + }, + "disposition": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/Disp", + "description": "Disposition code describing the state of the item after the event. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/Disp\n " + }, + "bizStep": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/BizStep", + "description": "A business step code drawn from a controlled vocabulary. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/BizStep\n " + }, + "bizLocation": { + "type": "string", + "format": "uri", + "description": "A Business Location is a uniquely identified and discretely recorded geospatial location that is meant to designate the specific place where an object is assumed to be following an EPCIS event until it is reported to be at a different Business Location by a subsequent EPCIS event. The bizLocation must be a resolvable URI that links to facility information and geolocation data." + }, + "sensorElementList": { + "type": "array", + "items": { + "$ref": "#/$defs/SensorElement" + }, + "description": "An array (one for each sensor) of sensor device data sets associated with the event. " + }, + "epcList": { + "type": "array", + "items": { + "$ref": "#/$defs/Item" + }, + "description": "A list of uniquely identified items (eg specific items serial numbers or tagged shipments / packages) that are the focus of this object event. " + }, + "quantityList": { + "type": "array", + "items": { + "$ref": "#/$defs/QuantityElement" + }, + "description": "A quantified list of product classes (eg GS1 GTINs) that are the focus of this object event" + } + }, + "description": "Object represents an event that happened to one or more physical or digital objects - such as an inspection or certification of a product or shipment. The physical objects may be identified either as specific items (eg a unique consignment number) or as a quantified amount of a product class (eg 100Kg of cotton yarn)" + }, + "AggregationEvent": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "AggregationEvent", + "Event" + ], + "default": [ + "AggregationEvent", + "Event" + ], + "items": { + "type": "string", + "enum": [ + "AggregationEvent", + "Event" + ] + } + }, + "id": { + "readOnly": true, + "type": "string", + "format": "uri", + "description": "The unique identifier of this event - SHOULD be a UUID" + }, + "eventTime": { + "type": "string", + "format": "date-time", + "description": "The ISO-8601 date time when the event occurred." + }, + "action": { + "type": "string", + "enum": [ + "observe", + "add", + "delete" + ], + "example": "observe", + "description": "Code describing how an event relates to the lifecycle of the entity impacted by the event." + }, + "disposition": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/Disp", + "description": "Disposition code describing the state of the item after the event. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/Disp\n " + }, + "bizStep": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/BizStep", + "description": "A business step code drawn from a controlled vocabulary. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/BizStep\n " + }, + "bizLocation": { + "type": "string", + "format": "uri", + "description": "A Business Location is a uniquely identified and discretely recorded geospatial location that is meant to designate the specific place where an object is assumed to be following an EPCIS event until it is reported to be at a different Business Location by a subsequent EPCIS event. The bizLocation must be a resolvable URI that links to facility information and geolocation data." + }, + "sensorElementList": { + "type": "array", + "items": { + "$ref": "#/$defs/SensorElement" + }, + "description": "An array (one for each sensor) of sensor device data sets associated with the event. " + }, + "parentEPC": { + "$ref": "#/$defs/Item", + "description": "The unique item identifier that is the result of this aggregation. Typically a packaging ID used in shipments that represents a box/ pallet / container of contained items." + }, + "childEPCs": { + "type": "array", + "items": { + "$ref": "#/$defs/Item" + }, + "description": "The list of child items that have been aggregated into the parent (or dis-aggregated from the parent). Maybe a list of package references (eg boxes on a pallet) or may be individual items (eg products in a box)." + }, + "childQuantityList": { + "type": "array", + "items": { + "$ref": "#/$defs/QuantityElement" + }, + "description": "List of quantified product classes that have been aggregated into the parent. Used whwn the child items do not have unique identifiers (eg 100 Kg of cotton bales)" + } + }, + "description": "Aggregation represents an event that happened to one or more objects that are physically aggregated together (physically constrained to be in the same place at the same time, as when cases are aggregated to a pallet). This event is also used to represent de-aggregation (eg unpacking) when businessStepCode is unpacking." + }, + "TransactionEvent": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "TransactionEvent", + "Event" + ], + "default": [ + "TransactionEvent", + "Event" + ], + "items": { + "type": "string", + "enum": [ + "TransactionEvent", + "Event" + ] + } + }, + "id": { + "readOnly": true, + "type": "string", + "format": "uri", + "description": "The unique identifier of this event - SHOULD be a UUID" + }, + "eventTime": { + "type": "string", + "format": "date-time", + "description": "The ISO-8601 date time when the event occurred." + }, + "action": { + "type": "string", + "enum": [ + "observe", + "add", + "delete" + ], + "example": "observe", + "description": "Code describing how an event relates to the lifecycle of the entity impacted by the event." + }, + "disposition": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/Disp", + "description": "Disposition code describing the state of the item after the event. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/Disp\n " + }, + "bizStep": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/BizStep", + "description": "A business step code drawn from a controlled vocabulary. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/BizStep\n " + }, + "bizLocation": { + "type": "string", + "format": "uri", + "description": "A Business Location is a uniquely identified and discretely recorded geospatial location that is meant to designate the specific place where an object is assumed to be following an EPCIS event until it is reported to be at a different Business Location by a subsequent EPCIS event. The bizLocation must be a resolvable URI that links to facility information and geolocation data." + }, + "sensorElementList": { + "type": "array", + "items": { + "$ref": "#/$defs/SensorElement" + }, + "description": "An array (one for each sensor) of sensor device data sets associated with the event. " + }, + "sourceParty": { + "$ref": "#/$defs/Entity", + "description": "The source party for this supply chain transaction - typically the seller party" + }, + "destinationParty": { + "$ref": "#/$defs/Entity", + "description": "The destination party for this supply chain transaction - typically the buyer party." + }, + "epcList": { + "type": "array", + "items": { + "$ref": "#/$defs/Item" + }, + "description": "The list of uniquely identified trade items included in this supply chain transaction." + }, + "quantityList": { + "type": "array", + "items": { + "$ref": "#/$defs/QuantityElement" + }, + "description": "List of quantified product classes that are included in this transaction. Used when the trade items do not have unique identifiers (eg 100 reels of yarn)" + }, + "referenceDocument": { + "$ref": "#/$defs/TradeDocument", + "description": "The supply chain document reference for this transaction event - eg the invoice, order, or dispatch advice" + } + }, + "description": "Transaction represents an event in which one or more objects become associated or disassociated with one or more identified business transactions - such as the purchase / shipment of goods between buyer and seller." + }, + "TradeDocument": { + "type": "object", + "additionalProperties": false, + "properties": { + "documentType": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/BTT", + "description": "The document type representing the trade transaction drawn from the business transaction type vocabulary.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/BTT\n " + }, + "identifier": { + "type": "string", + "description": "The identifier of the trade transaction document - eg an invoice number or bill of lading number. Must be unique for a given source party" + }, + "documentURL": { + "type": "string", + "format": "uri", + "description": "The URL of the referenced trade document. For integrity reasons, it is recommended (but not required) that the documentURL is a hashlink (https://w3c-ccg.github.io/hashlink/) so that if the document the URL is changed then the hash verification will fail." + } + }, + "description": "A trade transaction between two parties such as an invoice, purchase order, or shipping notification." + }, + "AssociationEvent": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "AssociationEvent", + "Event" + ], + "default": [ + "AssociationEvent", + "Event" + ], + "items": { + "type": "string", + "enum": [ + "AssociationEvent", + "Event" + ] + } + }, + "id": { + "readOnly": true, + "type": "string", + "format": "uri", + "description": "The unique identifier of this event - SHOULD be a UUID" + }, + "eventTime": { + "type": "string", + "format": "date-time", + "description": "The ISO-8601 date time when the event occurred." + }, + "action": { + "type": "string", + "enum": [ + "observe", + "add", + "delete" + ], + "example": "observe", + "description": "Code describing how an event relates to the lifecycle of the entity impacted by the event." + }, + "disposition": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/Disp", + "description": "Disposition code describing the state of the item after the event. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/Disp\n " + }, + "bizStep": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/BizStep", + "description": "A business step code drawn from a controlled vocabulary. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/BizStep\n " + }, + "bizLocation": { + "type": "string", + "format": "uri", + "description": "A Business Location is a uniquely identified and discretely recorded geospatial location that is meant to designate the specific place where an object is assumed to be following an EPCIS event until it is reported to be at a different Business Location by a subsequent EPCIS event. The bizLocation must be a resolvable URI that links to facility information and geolocation data." + }, + "sensorElementList": { + "type": "array", + "items": { + "$ref": "#/$defs/SensorElement" + }, + "description": "An array (one for each sensor) of sensor device data sets associated with the event. " + }, + "parentEPC": { + "$ref": "#/$defs/Item", + "description": "The unique item identifier that is the parent of this association. Typically an assembled product ID such as a desktop computer that is built from the associated child components." + }, + "childEPCs": { + "type": "array", + "items": { + "$ref": "#/$defs/Item" + }, + "description": "The list of child items that have been assembled to create the parent - for example the power supply or hard drive components of a desktop computer." + }, + "childQuantityList": { + "type": "array", + "items": { + "$ref": "#/$defs/QuantityElement" + }, + "description": "List of quantified product classes that have been assembled into the parent. Used when the child items do not have unique identifiers (eg brackets and screws used in the assembly of a desktop computer)" + } + }, + "description": "The association event represents the assembly of child sub-components to create a parent assembled item. For example a desktop computer assembled from power supply, hard drive, and motherboard. The association event is very similar in structure to the aggregation event but is used for physical assembly. An association event may represent a bill of materials used to assemble a product whilst an aggregation event may represent a packing list or items for transport. " + }, + "Event": { + "type": "object", + "oneOf": [ + { + "$ref": "#/$defs/TransformationEvent" + }, + { + "$ref": "#/$defs/ObjectEvent" + }, + { + "$ref": "#/$defs/AggregationEvent" + }, + { + "$ref": "#/$defs/TransactionEvent" + }, + { + "$ref": "#/$defs/AssociationEvent" + } + ], + "description": "This abstract event structure provides a common language to describe supply chain events such as shipments, inspections, manufacturing processes, etc. There are four types of EPCIS event but this is an abstract class representing all common properties of an EPCIS event. " + } + } +} \ No newline at end of file diff --git a/packages/untp-test-suite/src/schemas/productPassport/v0.3.10/schema.json b/packages/untp-test-suite/src/schemas/productPassport/v0.3.10/schema.json new file mode 100644 index 00000000..fc7a2595 --- /dev/null +++ b/packages/untp-test-suite/src/schemas/productPassport/v0.3.10/schema.json @@ -0,0 +1,1048 @@ +{ + "type": "object", + "additionalProperties": false, + "properties": { + "render": { + "type": "array", + "items": { + "template": { + "example": " Digital Product Passport
Digital Product Passport
{{credentialSubject.name}}
Batch: {{credentialSubject.batchNumber}}
Serial: {{credentialSubject.serialNumber}}

Product Details

ID: {{credentialSubject.id}}

Description: {{credentialSubject.description}}

Category: {{#each credentialSubject.productCategory}} {{name}} {{/each}}

Dimensions: {{credentialSubject.dimensions.length.value}} x {{credentialSubject.dimensions.width.value}} x {{credentialSubject.dimensions.height.value}} {{credentialSubject.dimensions.length.unit}}

Weight: {{credentialSubject.dimensions.weight.value}} {{credentialSubject.dimensions.weight.unit}}

Country of Production: {{credentialSubject.countryOfProduction}}

Materials Provenance

{{#each credentialSubject.materialsProvenance}}
{{name}} {{originCountry}} {{materialType.name}} {{massFraction}}
{{/each}}

Conformity Declarations

{{#each credentialSubject.conformityDeclarations}}

{{referenceStandard.name}} - {{referenceRegulation.name}}

{{/each}}

Circularity and Emissions

Circularity Score: {{credentialSubject.circularityScorecard.materialCircularityIndicator}}
Carbon Footprint: {{credentialSubject.emissionsScorecard.carbonFootprint}}
", + "type": "string", + "description": "A template that renders the Verifiable Credential to HTML" + }, + "@type": { + "type": "string", + "enum": [ + "WebRenderingTemplate2022" + ], + "example": "WebRenderingTemplate2022", + "description": "Defines the rendering type." + } + }, + "description": "Defines a template to be used to render the Verifiable Credential." + }, + "type": { + "type": "array", + "readOnly": true, + "const": [ + "DigitalProductPassport", + "VerifiableCredential" + ], + "default": [ + "DigitalProductPassport", + "VerifiableCredential" + ], + "items": { + "type": "string", + "enum": [ + "DigitalProductPassport", + "VerifiableCredential" + ] + } + }, + "@context": { + "example": "https://test.uncefact.org/vocabulary/untp/dpp/dpp-context.jsonld", + "type": "array", + "items": { + "type": "string", + "enum": [ + "https://www.w3.org/ns/credentials/v2", + "https://test.uncefact.org/vocabulary/untp/dpp/0.3.10/", + "https://dev-render-method-context.s3.ap-southeast-1.amazonaws.com/dev-render-method-context.json" + ] + }, + "description": "A list of JSON-LD context URIs that define the seamntic meaning of prperties within the credential. ", + "readOnly": true, + "const": [ + "https://www.w3.org/ns/credentials/v2", + "https://test.uncefact.org/vocabulary/untp/dpp/0.3.10/", + "https://dev-render-method-context.s3.ap-southeast-1.amazonaws.com/dev-render-method-context.json" + ], + "default": [ + "https://www.w3.org/ns/credentials/v2", + "https://test.uncefact.org/vocabulary/untp/dpp/0.3.10/", + "https://dev-render-method-context.s3.ap-southeast-1.amazonaws.com/dev-render-method-context.json" + ] + }, + "id": { + "example": "https://example-company.com/credentials/2a423366-a0d6-4855-ba65-2e0c926d09b0", + "type": "string", + "format": "uri", + "description": "A unique identifier (URI) assigned to the product passport. May be a UUID" + }, + "issuer": { + "$ref": "#/$defs/CredentialIssuer", + "description": "The organisation that is the isuer of this VC. Note that the \"id\" property MUST be a W3C DID. Other identifiers such as tax registration numbers can be listed in the \"otherIdentifiers\" property." + }, + "validFrom": { + "example": "2024-03-15T12:00:00", + "type": "string", + "format": "date-time", + "description": "The date and time from which the credential is valid." + }, + "validUntil": { + "example": "2034-03-15T12:00:00", + "type": "string", + "format": "date-time", + "description": "The expiry date (if applicable) of this verifiable credential." + }, + "credentialSubject": { + "$ref": "#/$defs/Product", + "description": "The subject of a digital product passport credential is the identified product. " + } + }, + "description": "The ProductPassport is a comprehensive data structure that encapsulates various details pertaining to a product, including its identification details, who issued it, batch information, provernance information, circularity information and a set of verifable product confomrity & sistainability claims.", + "required": [ + "@context", + "id", + "issuer" + ], + "$schema": "https://json-schema.org/draft/2020-12/schema", + "$defs": { + "CredentialIssuer": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "CredentialIssuer" + ], + "default": [ + "CredentialIssuer" + ], + "items": { + "type": "string", + "enum": [ + "CredentialIssuer" + ] + } + }, + "id": { + "example": "did:web:identifiers.example-company.com:12345", + "type": "string", + "format": "uri", + "description": "The W3C DID of the issuer - should be a did:web or did:tdw" + }, + "name": { + "example": "Example Company Pty Ltd", + "type": "string", + "description": "The name of the issuer person or organisation" + }, + "otherIdentifiers": { + "type": "array", + "items": { + "$ref": "#/$defs/Entity" + }, + "description": "An optional list of other registered identifiers for this credential issuer " + } + }, + "description": "The issuer party ()person or orgnaition) of a verifiable credential.", + "required": [ + "id", + "name" + ] + }, + "Entity": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "Entity" + ], + "default": [ + "Entity" + ], + "items": { + "type": "string", + "enum": [ + "Entity" + ] + } + }, + "id": { + "example": "https://id.gs1.org/01/09520123456788/21/12345", + "type": "string", + "format": "uri", + "description": "The globally unique ID of the entity as a resolvable URL according to ISO 18975. ExamplesProduct - id.gs1.org/01/09520123456788/21/12345 Party - abr.business.gov.au/ABN/View?abn=90664869327. Facility - did:web:facilities.example-company.com:123. " + }, + "name": { + "example": "EV battery 300Ah.", + "type": "string", + "description": "The registered name of the entity within the identifier scheme. Examplesproduct - EV battery 300Ahparty - Sample Company Pty Ltd. facility - Greenacres battery factory" + }, + "registeredId": { + "example": "90664869327", + "type": "string", + "description": "The registration number (alphanumeric) of the entity within the register. Unique within the register." + }, + "idScheme": { + "$ref": "#/$defs/IdentifierScheme", + "description": "The identifier scheme. Exampleproduct - id.gs1.org/01. party - business.gov.au/abn facility - did:web:facilities.acme.com. " + } + }, + "description": "The ID and Name of an identified entity such qs a product, facility, party, standard, etc. If the identifier is a W3C DID then the corresponding DID document SHOULD include a serviceEndpoint of type \"IdentityResolver\". If the identifier is not a W3C DID then the id peroperty SHOULD be an identity resolver URL.", + "required": [ + "id", + "name" + ] + }, + "IdentifierScheme": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "IdentifierScheme" + ], + "default": [ + "IdentifierScheme" + ], + "items": { + "type": "string", + "enum": [ + "IdentifierScheme" + ] + } + }, + "id": { + "example": "https://id.gs1.org/01/", + "type": "string", + "format": "uri", + "description": "The globally unique identifier of the registration scheme. The scheme should be registered and discoverable from vocabulary.uncefact.org/identifierSchemes" + }, + "name": { + "example": "Global Trade Identification Number (GTIN)", + "type": "string", + "description": "The name of the identifier scheme. " + } + }, + "description": "An identifier registration scheme for products, facilities, or organisations. Typically operated by a state, national or gloabl authority." + }, + "Product": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "Product", + "Entity" + ], + "default": [ + "Product", + "Entity" + ], + "items": { + "type": "string", + "enum": [ + "Product", + "Entity" + ] + } + }, + "id": { + "example": "https://id.gs1.org/01/09520123456788/21/12345", + "type": "string", + "format": "uri", + "description": "The globally unique ID of the entity as a resolvable URL according to ISO 18975. ExamplesProduct - id.gs1.org/01/09520123456788/21/12345 Party - abr.business.gov.au/ABN/View?abn=90664869327. Facility - did:web:facilities.example-company.com:123. " + }, + "name": { + "example": "EV battery 300Ah.", + "type": "string", + "description": "The registered name of the entity within the identifier scheme. Examplesproduct - EV battery 300Ahparty - Sample Company Pty Ltd. facility - Greenacres battery factory" + }, + "registeredId": { + "example": "90664869327", + "type": "string", + "description": "The registration number (alphanumeric) of the entity within the register. Unique within the register." + }, + "idScheme": { + "$ref": "#/$defs/IdentifierScheme", + "description": "The identifier scheme. Exampleproduct - id.gs1.org/01. party - business.gov.au/abn facility - did:web:facilities.acme.com. " + }, + "serialNumber": { + "example": "12345678", + "type": "string", + "description": "A number or code representing a specific serialised item of the product. Unique within product class." + }, + "batchNumber": { + "example": "6789", + "type": "string", + "description": "Identifier of the specific production batch of the product. Unique within the product class." + }, + "productImage": { + "$ref": "#/$defs/Link", + "description": "Reference information (location, type, name) of an image of the product." + }, + "description": { + "example": "400Ah 24v LiFePO4 battery", + "type": "string", + "description": "A textual description providing details about the product." + }, + "productCategory": { + "type": "array", + "items": { + "$ref": "#/$defs/Classification" + }, + "description": "A code representing the product's class, typically using the UN CPC (United Nations Central Product Classification) https://unstats.un.org/unsd/classifications/Econ/cpc" + }, + "furtherInformation": { + "type": "array", + "items": { + "$ref": "#/$defs/Link" + }, + "description": "A URL pointing to further human readable information about the product." + }, + "producedByParty": { + "$ref": "#/$defs/Entity", + "description": "The Party entity that manufactured the product." + }, + "producedAtFacility": { + "$ref": "#/$defs/Entity", + "description": "The Facility where the product batch was produced / manufactured." + }, + "dimensions": { + "$ref": "#/$defs/Dimension", + "description": "The physical dimensions of the product. Not every dimension is relevant to every products. For example bulk materials may have wieght and volume but not length, with, or height.\"weight\":{\"value\":10, \"unit\":\"KGM\"}" + }, + "productionDate": { + "example": "2024-04-25", + "type": "string", + "format": "date", + "description": "The ISO 8601 date on which the product batch was manufactured." + }, + "countryOfProduction": { + "type": "string", + "x-external-enumeration": "https://vocabulary.uncefact.org/CountryId", + "description": "The country in which this item was produced / manufactured.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://vocabulary.uncefact.org/CountryId\n " + }, + "materialsProvenance": { + "type": "array", + "items": { + "$ref": "#/$defs/Material" + }, + "description": "An array of Provenance objects providing details on the origin and mass fraction of components or ingredients of the product batch. " + }, + "conformityDeclarations": { + "type": "array", + "items": { + "$ref": "#/$defs/Declaration" + }, + "description": "An array of claim objects representing various product conformity claims about the product / batch. These can be sustainability claims, circularity claims, or any other claim type within the conformity topic list." + }, + "circularityScorecard": { + "$ref": "#/$defs/CircularityPerformance", + "description": "A circularity performance scorecard" + }, + "emissionsScorecard": { + "$ref": "#/$defs/EmissionsPerformance", + "description": "An emissions performacne scorecard" + }, + "traceabilityInformation": { + "type": "array", + "items": { + "$ref": "#/$defs/SecureLink" + }, + "description": "An array of secure links to TraceabilityEvent objects detailing EPCIS events related to the traceability of the product batch. SHOULD be provided for any product passport issued at batch or item level. Links should include the hash of the target and may point to encrypted targets." + } + }, + "description": "The ProductInformation class encapsulates detailed information regarding a specific product, including its identification details, manufacturer, and other pertinent details. ", + "required": [ + "id", + "name" + ] + }, + "Link": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "Link" + ], + "default": [ + "Link" + ], + "items": { + "type": "string", + "enum": [ + "Link" + ] + } + }, + "linkURL": { + "example": "https://files.example-certifier.com/1234567.json", + "type": "string", + "format": "uri", + "description": "The URL of the target resource. " + }, + "linkName": { + "example": "GBA rule book conformity certificate", + "type": "string", + "description": "A display name for the target resource " + }, + "linkType": { + "example": "https://test.uncefact.org/vocabulary/linkTypes/dcc", + "type": "string", + "description": "The type of the target resource - drawn from a controlled vocabulary " + } + }, + "description": "A structure to provide a URL link plus metadata associated with the link." + }, + "Classification": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "Classification" + ], + "default": [ + "Classification" + ], + "items": { + "type": "string", + "enum": [ + "Classification" + ] + } + }, + "id": { + "example": "https://unstats.un.org/unsd/classifications/Econ/cpc/46410", + "type": "string", + "format": "uri", + "description": "The globally unique URI representing the specific classifier value" + }, + "code": { + "example": "46410", + "type": "string", + "description": "classification code within the scheme" + }, + "name": { + "example": "Primary cells and primary batteries", + "type": "string", + "description": "Name of the classification represented by the code" + }, + "schemeID": { + "example": "https://unstats.un.org/unsd/classifications/Econ/cpc/", + "type": "string", + "format": "uri", + "description": "Classification scheme ID" + }, + "schemeName": { + "example": "UN Central Product Classification (CPC)", + "type": "string", + "description": "The name of the classification scheme" + } + }, + "description": "A classification scheme and code / name representing a category value for a product, entity, or facility.", + "required": [ + "id", + "name" + ] + }, + "Dimension": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "Dimension" + ], + "default": [ + "Dimension" + ], + "items": { + "type": "string", + "enum": [ + "Dimension" + ] + } + }, + "weight": { + "$ref": "#/$defs/Measure", + "description": "the weight of the product. EG {\"value\":10, \"unit\":\"KGM\"}" + }, + "length": { + "$ref": "#/$defs/Measure", + "description": "The length of the product or packaging eg {\"value\":840, \"unit\":\"MMT\"}" + }, + "width": { + "$ref": "#/$defs/Measure", + "description": "The width of the product or packaging. eg {\"value\":150, \"unit\":\"MMT\"}" + }, + "height": { + "$ref": "#/$defs/Measure", + "description": "The height of the product or packaging. eg {\"value\":220, \"unit\":\"MMT\"}" + }, + "volume": { + "$ref": "#/$defs/Measure", + "description": "The displacement volume of the product. eg {\"value\":7.5, \"unit\":\"LTR\"}" + } + }, + "description": "Overall (length, width, height) dimensions and weight/volume of an item." + }, + "Measure": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "Measure" + ], + "default": [ + "Measure" + ], + "items": { + "type": "string", + "enum": [ + "Measure" + ] + } + }, + "value": { + "example": 10, + "type": "number", + "description": "The numeric value of the measure" + }, + "unit": { + "type": "string", + "x-external-enumeration": "https://vocabulary.uncefact.org/UnitMeasureCode", + "description": "Unit of measure drawn from the UNECE rec20 measure code list.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://vocabulary.uncefact.org/UnitMeasureCode\n " + } + }, + "description": "The measure class defines a numeric measured value (eg 10) and a coded unit of measure (eg KG).", + "required": [ + "value", + "unit" + ] + }, + "Material": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "Material" + ], + "default": [ + "Material" + ], + "items": { + "type": "string", + "enum": [ + "Material" + ] + } + }, + "name": { + "example": "Lithium Spodumene", + "type": "string", + "description": "Name of this material (eg \"Egyptian Cotton\")" + }, + "originCountry": { + "type": "string", + "x-external-enumeration": "https://vocabulary.uncefact.org/CountryId", + "description": "A ISO 3166-1 code representing the country of origin of the component or ingredient.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://vocabulary.uncefact.org/CountryId\n " + }, + "materialType": { + "$ref": "#/$defs/Classification", + "description": "The type of this material - as a value drawn from a controlled vocabulary eg from UN Framework Classification for Resources (UNFC)." + }, + "massFraction": { + "example": 0.2, + "type": "number", + "description": "The mass fraction of the product represented by this material. The sum of all mass fraction values for a given passport should be 1." + }, + "recycledAmount": { + "example": 0.5, + "type": "number", + "description": "Mass fraction of this material that is recycled (eg 50% recycled Lithium)" + }, + "hazardous": { + "example": "false", + "type": "boolean", + "description": "Indicates whether this material is hazardous. If true then the materialSafetyInformation proerty must be present" + }, + "materialSafetyInformation": { + "$ref": "#/$defs/Link", + "description": "Refernece to further information obout safe handling of this hazardous material (for example a link to a material safety data sheet)" + } + }, + "description": "The material class encapsulates details about the origin or source of raw materials in a product, including the country of origin and the mass fraction.", + "required": [ + "name" + ] + }, + "Declaration": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "Declaration" + ], + "default": [ + "Declaration" + ], + "items": { + "type": "string", + "enum": [ + "Declaration" + ] + } + }, + "id": { + "example": "https://products.example-company.com/09520123456788/declarations/12345", + "type": "string", + "format": "uri", + "description": "A unique identifier for the delcaration. Often this will be an extension of the product.id or attestation.id. But could be a UUID." + }, + "referenceStandard": { + "$ref": "#/$defs/Standard", + "description": "The reference to the standard that defines the specification / criteria" + }, + "referenceRegulation": { + "$ref": "#/$defs/Regulation", + "description": "The reference to the regulation that defines the assessment criteria" + }, + "assessmentCriteria": { + "type": "array", + "items": { + "$ref": "#/$defs/Criterion" + }, + "description": "The specification against which the assessment is made." + }, + "declaredValues": { + "type": "array", + "items": { + "$ref": "#/$defs/Metric" + }, + "description": "The list of specific values measured as part of this assessment (eg tensile strength)" + }, + "compliance": { + "example": "true", + "type": "boolean", + "description": "An indicator of whether or not the assessment meets the specification." + }, + "conformityTopic": { + "type": "string", + "enum": [ + "environment.energy", + "environment.emissions", + "environment.water", + "environment.waste", + "environment.deforestation", + "environment.biodiversity", + "circularity.content", + "circularity.design", + "social.labour", + "social.rights", + "social.community", + "social.safety", + "governance.ethics", + "governance.compliance", + "governance.transparency" + ], + "example": "environment.energy", + "description": "The conformity topic category for this assessment (eg vocabulary.uncefact.org/sustainability/emissions)" + }, + "conformityEvidence": { + "$ref": "#/$defs/SecureLink", + "description": "A URI pointing to the evidence supporting the claim. SHOULD be a URL to a UNTP Digital COnformity Credential (DCC)" + } + }, + "description": "A declaration of conformance with one or more criteria from a specific standard or regulation. ", + "required": [ + "id", + "compliance", + "conformityTopic" + ] + }, + "Standard": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "Standard" + ], + "default": [ + "Standard" + ], + "items": { + "type": "string", + "enum": [ + "Standard" + ] + } + }, + "id": { + "example": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf", + "type": "string", + "format": "uri", + "description": "A unique identifier for the standard (eg https://www.iso.org/standard/60857.html)." + }, + "name": { + "example": "GBA Battery Passport Greenhouse Gas Rulebook - V.2.0", + "type": "string", + "description": "The name of the standard" + }, + "issuingParty": { + "$ref": "#/$defs/Entity", + "description": "The party that issued the standard " + }, + "issueDate": { + "example": "2023-12-05", + "type": "string", + "format": "date", + "description": "The date when the standard was issued." + } + }, + "description": "A standard (eg ISO 14000) that specifies the criteria for conformance.", + "required": [ + "issuingParty" + ] + }, + "Regulation": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "Regulation" + ], + "default": [ + "Regulation" + ], + "items": { + "type": "string", + "enum": [ + "Regulation" + ] + } + }, + "id": { + "example": "https://www.legislation.gov.au/F2008L02309/latest/versions", + "type": "string", + "format": "uri", + "description": "The globally unique identifier of this regulation. " + }, + "name": { + "example": "NNational Greenhouse and Energy Reporting (Measurement) Determination", + "type": "string", + "description": "The name of the regulation or act." + }, + "jurisdictionCountry": { + "type": "string", + "x-external-enumeration": "https://vocabulary.uncefact.org/CountryId", + "description": "The legal jurisdiction (country) under which the regulation is issued.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://vocabulary.uncefact.org/CountryId\n " + }, + "administeredBy": { + "$ref": "#/$defs/Entity", + "description": "the issuing body of the regulation. For example Australin Goernment Department of Climate Change, Energy, the Environment and Water" + }, + "effectiveDate": { + "example": "2024-03-20", + "type": "string", + "format": "date", + "description": "the date at which the regulation came into effect." + } + }, + "description": "A regulation (eg EU deforestation regulation) that defines the criteria for assessment.", + "required": [ + "administeredBy" + ] + }, + "Criterion": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "Criterion" + ], + "default": [ + "Criterion" + ], + "items": { + "type": "string", + "enum": [ + "Criterion" + ] + } + }, + "id": { + "example": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf#BatteryAssembly", + "type": "string", + "format": "uri", + "description": "A unique identifier for the criteria within the standard or regulation. For example CO2 emissions calaculations for liquid fule combusion." + }, + "name": { + "example": "GBA Battery rule book v2.0 battery assembly guidelines.", + "type": "string", + "description": "A name that describes this criteria." + }, + "thresholdValues": { + "type": "array", + "items": { + "$ref": "#/$defs/Metric" + }, + "description": "A conformity threshold defined by the specification (eg minimum compressive strength) " + } + }, + "description": "A specific rule or criterion within a standard or regulation. eg a carbon intensity calculation rule within an emissions standard.", + "required": [ + "id", + "name" + ] + }, + "Metric": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "Metric" + ], + "default": [ + "Metric" + ], + "items": { + "type": "string", + "enum": [ + "Metric" + ] + } + }, + "metricName": { + "example": "GHG emissions intensity", + "type": "string", + "description": "A human readable name for this metric (for example \"Tensile strength\")" + }, + "metricValue": { + "$ref": "#/$defs/Measure", + "description": "A numeric value and unit of measure for this metric. Could be a measured value or a specified threshold. Eg {\"value\":400, \"unit\":\"MPA\"} as tensile strenght of structural steel" + }, + "accuracy": { + "example": 0.05, + "type": "number", + "description": "A percentage represented as a numeric between 0 and 1 indicating the rage of accuracy of the claimed value (eg 0.05 means that the actual value is within 5% of the claimed value.)" + } + }, + "description": "A specific measure of performance against the criteria that governs the claim. Expressed as an array of metric (ie unit of emasure) / value (ie the actual numeric value) pairs. ", + "required": [ + "metricName", + "metricValue" + ] + }, + "SecureLink": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "SecureLink", + "Link" + ], + "default": [ + "SecureLink", + "Link" + ], + "items": { + "type": "string", + "enum": [ + "SecureLink", + "Link" + ] + } + }, + "linkURL": { + "example": "https://files.example-certifier.com/1234567.json", + "type": "string", + "format": "uri", + "description": "The URL of the target resource. " + }, + "linkName": { + "example": "GBA rule book conformity certificate", + "type": "string", + "description": "A display name for the target resource " + }, + "linkType": { + "example": "https://test.uncefact.org/vocabulary/linkTypes/dcc", + "type": "string", + "description": "The type of the target resource - drawn from a controlled vocabulary " + }, + "hashDigest": { + "example": "6239119dda5bd4c8a6ffb832fe16feaa5c27b7dba154d24c53d4470a2c69adc2", + "type": "string", + "description": "The hash of the file." + }, + "hashMethod": { + "type": "string", + "enum": [ + "SHA-256", + "SHA-1" + ], + "example": "SHA-256", + "description": "The hashing algorithm used to create the target hash. SHA-265 is the recommedned standard" + }, + "encryptionMethod": { + "type": "string", + "enum": [ + "none", + "AES" + ], + "example": "none", + "description": "The symmetric encryption algorithm used to encrypt the link target. AES is the recommended standard. Decryption keys are expected to be passed out of bounds." + } + }, + "description": "A binary file that is hashed ()for tamper evidence) and optionally encrypted (for confidentiality)." + }, + "CircularityPerformance": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "CircularityPerformance" + ], + "default": [ + "CircularityPerformance" + ], + "items": { + "type": "string", + "enum": [ + "CircularityPerformance" + ] + } + }, + "recyclingInformation": { + "$ref": "#/$defs/Link", + "description": "A URI pointing to recycling information for the product." + }, + "repairInformation": { + "$ref": "#/$defs/Link", + "description": "A URI pointing to repair instructions for this product." + }, + "recyclableContent": { + "example": 0.5, + "type": "number", + "format": "float", + "description": "The fraction of the this product (my mass) that has been designed to be recyclable / re-usable. This will be be the total fraction that can avoid waste / landfill." + }, + "recyecledContent": { + "example": 0.3, + "type": "number", + "format": "float", + "description": "The fraction (by mass) of recycled / repurposed, repaired content in this product. This will be the total virgin content fraction." + }, + "utilityFactor": { + "example": 1.2, + "type": "number", + "format": "float", + "description": "An indicator of durability defined as the lifetime (typically measures as usage cycles) for this product divided by the industry average. For example a battery with a 10,000 cycle lifetime where industry average is 5,000 cycles will have a durability factor of 2. If unknown set to 1 or omit. " + }, + "materialCircularityIndicator": { + "example": 0.67, + "type": "number", + "format": "float", + "description": "The overall circularity performance indicator for this product. Calculated as 1 - (V+W)/2D where - V = Virgin material proportion by mass (will be 1- recycled content) - W = Waste leakage proportion by mass (will be 1 - recyclableContent) - D = Utility factor (set to 1 if unknown). " + } + }, + "description": "High level corcularity information about this product. Note that this doens not substitute for detailed product circularity data sheet (PCDS) criteria which would be represented as a set of conformity claims against individual ISO PCDS criteria." + }, + "EmissionsPerformance": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "EmissionsPerformance" + ], + "default": [ + "EmissionsPerformance" + ], + "items": { + "type": "string", + "enum": [ + "EmissionsPerformance" + ] + } + }, + "carbonFootprint": { + "example": 1.8, + "type": "number", + "format": "float", + "description": "The carbon footprint of the product in KgCO2e per declared unit." + }, + "declaredUnit": { + "type": "string", + "x-external-enumeration": "https://vocabulary.uncefact.org/UnitMeasureCode", + "description": "The unit of product (EA, KGM, LTR, etc) that is the basis for carbon footprint.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://vocabulary.uncefact.org/UnitMeasureCode\n " + }, + "operationalScope": { + "type": "string", + "enum": [ + "None", + "CradleToGate", + "CradleToGrave" + ], + "example": "None", + "description": "The operational scope of the emissions performance. Only scope 1 & 2, or inlcuing upstream scope 3 (cradle to gate) or upstream and downstream scope 3 (cradle to grave)." + }, + "primarySourcedRatio": { + "example": 0.3, + "type": "number", + "format": "float", + "description": "The ratio of emissions data from primary sources (ie from supplier / product specific information rather than secondary / industry averages)." + }, + "reportingStandard": { + "$ref": "#/$defs/Standard", + "description": "The reporting standard (eg GHG Protocol, IFRS S2, ESRS, etc) against which this product emissions performance is assessed." + } + }, + "description": "Product specific characteristics. This class is an extension point for industry specific product characteristics or performance information such as clothing size or battery capacity.", + "required": [ + "carbonFootprint", + "declaredUnit", + "operationalScope", + "primarySourcedRatio" + ] + } + } +} \ No newline at end of file diff --git a/packages/untp-test-suite/src/schemas/productPassport/v0.3.9/schema.json b/packages/untp-test-suite/src/schemas/productPassport/v0.3.9/schema.json new file mode 100644 index 00000000..f07fc2fa --- /dev/null +++ b/packages/untp-test-suite/src/schemas/productPassport/v0.3.9/schema.json @@ -0,0 +1,851 @@ +{ + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "DigitalProductPassport", + "VerifiableCredential" + ], + "default": [ + "DigitalProductPassport", + "VerifiableCredential" + ], + "items": { + "type": "string", + "enum": [ + "DigitalProductPassport", + "VerifiableCredential" + ] + } + }, + "@context": { + "example": "https://test.uncefact.org/vocabulary/untp/dpp/dpp-context.jsonld", + "type": "array", + "items": { + "type": "string", + "enum": [ + "https://www.w3.org/ns/credentials/v2", + "https://vocabulary.uncefact.org/untp/dpp/{{version}}/" + ] + }, + "description": "A list of JSON-LD context URIs that define the seamntic meaning of prperties within the credential. ", + "readOnly": true, + "const": [ + "https://www.w3.org/ns/credentials/v2", + "https://vocabulary.uncefact.org/untp/dpp/{{version}}/" + ], + "default": [ + "https://www.w3.org/ns/credentials/v2", + "https://vocabulary.uncefact.org/untp/dpp/{{version}}/" + ] + }, + "id": { + "example": "https://example-company.com/credentials/2a423366-a0d6-4855-ba65-2e0c926d09b0", + "type": "string", + "format": "uri", + "description": "A unique identifier (URI) assigned to the product passport. May be a UUID" + }, + "issuer": { + "$ref": "#/$defs/CredentialIssuer", + "description": "The organisation that is the isuer of this VC. Note that the \"id\" property MUST be a W3C DID. Other identifiers such as tax registration numbers can be listed in the \"otherIdentifiers\" property." + }, + "validFrom": { + "example": "2024-03-15", + "type": "string", + "format": "date-time", + "description": "The date and time from which the credential is valid." + }, + "validUntil": { + "example": "2034-03-15", + "type": "string", + "format": "date-time", + "description": "The expiry date (if applicable) of this verifiable credential." + }, + "credentialSubject": { + "$ref": "#/$defs/Product", + "description": "The subject of a digital product passport credential is the identified product. " + } + }, + "description": "The ProductPassport is a comprehensive data structure that encapsulates various details pertaining to a product, including its identification details, who issued it, batch information, provernance information, circularity information and a set of verifable product confomrity & sistainability claims.", + "required": [ + "@context", + "id", + "issuer" + ], + "$schema": "https://json-schema.org/draft/2020-12/schema", + "$defs": { + "CredentialIssuer": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "default": "CredentialIssuer", + "enum": [ + "CredentialIssuer" + ] + }, + "id": { + "example": "did:web:identifiers.example-company.com:12345", + "type": "string", + "format": "uri", + "description": "The W3C DID of the issuer - should be a did:web or did:tdw" + }, + "name": { + "example": "Example Company Pty Ltd", + "type": "string", + "description": "The name of the issuer person or organisation" + }, + "otherIdentifiers": { + "type": "array", + "items": { + "$ref": "#/$defs/Entity" + }, + "description": "An optional list of other registered identifiers for this credential issuer " + } + }, + "description": "The issuer party ()person or orgnaition) of a verifiable credential.", + "required": [ + "id", + "name" + ] + }, + "Entity": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "default": "Entity", + "enum": [ + "Entity" + ] + }, + "id": { + "example": "https://id.gs1.org/01/09520123456788/21/12345", + "type": "string", + "format": "uri", + "description": "The globally unique ID of the entity as a resolvable URL according to ISO 18975. ExamplesProduct - id.gs1.org/01/09520123456788/21/12345 Party - abr.business.gov.au/ABN/View?abn=90664869327. Facility - did:web:facilities.example-company.com:123. " + }, + "name": { + "example": "EV battery 300Ah.", + "type": "string", + "description": "The registered name of the entity within the identifier scheme. Examplesproduct - EV battery 300Ahparty - Sample Company Pty Ltd. facility - Greenacres battery factory" + }, + "registeredId": { + "example": "90664869327", + "type": "string", + "description": "The registration number (alphanumeric) of the entity within the register. Unique within the register." + }, + "idScheme": { + "$ref": "#/$defs/IdentifierScheme", + "description": "The identifier scheme. Exampleproduct - id.gs1.org/01. party - business.gov.au/abn facility - did:web:facilities.acme.com. " + } + }, + "description": "The ID and Name of an identified entity such qs a product, facility, party, standard, etc. If the identifier is a W3C DID then the corresponding DID document SHOULD include a serviceEndpoint of type \"IdentityResolver\". If the identifier is not a W3C DID then the id peroperty SHOULD be an identity resolver URL.", + "required": [ + "id", + "name" + ] + }, + "IdentifierScheme": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "default": "IdentifierScheme", + "enum": [ + "IdentifierScheme" + ] + }, + "id": { + "example": "https://id.gs1.org/01/", + "type": "string", + "format": "uri", + "description": "The globally unique identifier of the registration scheme. The scheme should be registered and discoverable from vocabulary.uncefact.org/identifierSchemes" + }, + "name": { + "example": "Global Trade Identification Number (GTIN)", + "type": "string", + "description": "The name of the identifier scheme. " + } + }, + "description": "An identifier registration scheme for products, facilities, or organisations. Typically operated by a state, national or gloabl authority." + }, + "Product": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "Product", + "Entity" + ], + "default": [ + "Product", + "Entity" + ], + "items": { + "type": "string", + "enum": [ + "Product", + "Entity" + ] + } + }, + "id": { + "example": "https://id.gs1.org/01/09520123456788/21/12345", + "type": "string", + "format": "uri", + "description": "The globally unique ID of the entity as a resolvable URL according to ISO 18975. ExamplesProduct - id.gs1.org/01/09520123456788/21/12345 Party - abr.business.gov.au/ABN/View?abn=90664869327. Facility - did:web:facilities.example-company.com:123. " + }, + "name": { + "example": "EV battery 300Ah.", + "type": "string", + "description": "The registered name of the entity within the identifier scheme. Examplesproduct - EV battery 300Ahparty - Sample Company Pty Ltd. facility - Greenacres battery factory" + }, + "registeredId": { + "example": "90664869327", + "type": "string", + "description": "The registration number (alphanumeric) of the entity within the register. Unique within the register." + }, + "idScheme": { + "$ref": "#/$defs/IdentifierScheme", + "description": "The identifier scheme. Exampleproduct - id.gs1.org/01. party - business.gov.au/abn facility - did:web:facilities.acme.com. " + }, + "serialNumber": { + "example": "12345678", + "type": "string", + "description": "A number or code representing a specific serialised item of the product. Unique within product class." + }, + "batchNumber": { + "example": "6789", + "type": "string", + "description": "Identifier of the specific production batch of the product. Unique within the product class." + }, + "productImage": { + "$ref": "#/$defs/Link", + "description": "Reference information (location, type, name) of an image of the product." + }, + "description": { + "example": "400Ah 24v LiFePO4 battery", + "type": "string", + "description": "A textual description providing details about the product." + }, + "productCategory": { + "type": "array", + "items": { + "$ref": "#/$defs/Classification" + }, + "description": "A code representing the product's class, typically using the UN CPC (United Nations Central Product Classification) https://unstats.un.org/unsd/classifications/Econ/cpc" + }, + "furtherInformation": { + "type": "array", + "items": { + "$ref": "#/$defs/Link" + }, + "description": "A URL pointing to further human readable information about the product." + }, + "producedByParty": { + "$ref": "#/$defs/Entity", + "description": "The Party entity that manufactured the product." + }, + "producedAtFacility": { + "$ref": "#/$defs/Entity", + "description": "The Facility where the product batch was produced / manufactured." + }, + "dimensions": { + "$ref": "#/$defs/Dimension", + "description": "The physical dimensions of the product. Not every dimension is relevant to every products. For example bulk materials may have wieght and volume but not length, with, or height.\"weight\":{\"value\":10, \"unit\":\"KGM\"}" + }, + "productionDate": { + "example": "2024-04-25", + "type": "string", + "format": "date", + "description": "The ISO 8601 date on which the product batch was manufactured." + }, + "countryOfProduction": { + "type": "string", + "x-external-enumeration": "https://vocabulary.uncefact.org/CountryId", + "description": "The country in which this item was produced / manufactured.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://vocabulary.uncefact.org/CountryId\n " + }, + "materialsProvenance": { + "type": "array", + "items": { + "$ref": "#/$defs/Material" + }, + "description": "An array of Provenance objects providing details on the origin and mass fraction of components or ingredients of the product batch. " + }, + "conformityDeclarations": { + "type": "array", + "items": { + "$ref": "#/$defs/Declaration" + }, + "description": "An array of claim objects representing various product conformity claims about the product / batch. These can be sustainability claims, circularity claims, or any other claim type within the conformity topic list." + }, + "circularityScorecard": { + "$ref": "#/$defs/CircularityPerformance", + "description": "A circularity performance scorecard" + }, + "emissionsScorecard": { + "$ref": "#/$defs/EmissionsPerformance", + "description": "An emissions performacne scorecard" + }, + "traceabilityInformation": { + "type": "array", + "items": { + "$ref": "#/$defs/SecureLink" + }, + "description": "An array of secure links to TraceabilityEvent objects detailing EPCIS events related to the traceability of the product batch. SHOULD be provided for any product passport issued at batch or item level. Links should include the hash of the target and may point to encrypted targets." + } + }, + "description": "The ProductInformation class encapsulates detailed information regarding a specific product, including its identification details, manufacturer, and other pertinent details. ", + "required": [ + "id", + "name" + ] + }, + "Link": { + "type": "object", + "additionalProperties": false, + "properties": { + "linkURL": { + "example": "https://files.example-certifier.com/1234567.json", + "type": "string", + "format": "uri", + "description": "The URL of the target resource. " + }, + "linkName": { + "example": "GBA rule book conformity certificate", + "type": "string", + "description": "A display name for the target resource " + }, + "linkType": { + "example": "https://test.uncefact.org/vocabulary/linkTypes/dcc", + "type": "string", + "description": "The type of the target resource - drawn from a controlled vocabulary " + } + }, + "description": "A structure to provide a URL link plus metadata associated with the link." + }, + "Classification": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "default": "Classification", + "enum": [ + "Classification" + ] + }, + "id": { + "example": "https://unstats.un.org/unsd/classifications/Econ/cpc/46410", + "type": "string", + "format": "uri", + "description": "The globally unique URI representing the specific classifier value" + }, + "code": { + "example": "46410", + "type": "string", + "description": "classification code within the scheme" + }, + "name": { + "example": "Primary cells and primary batteries", + "type": "string", + "description": "Name of the classification represented by the code" + }, + "schemeID": { + "example": "https://unstats.un.org/unsd/classifications/Econ/cpc/", + "type": "string", + "format": "uri", + "description": "Classification scheme ID" + }, + "schemeName": { + "example": "UN Central Product Classification (CPC)", + "type": "string", + "description": "The name of the classification scheme" + } + }, + "description": "A classification scheme and code / name representing a category value for a product, entity, or facility.", + "required": [ + "id", + "name" + ] + }, + "Dimension": { + "type": "object", + "additionalProperties": false, + "properties": { + "weight": { + "$ref": "#/$defs/Measure", + "description": "the weight of the product. EG {\"value\":10, \"unit\":\"KGM\"}" + }, + "length": { + "$ref": "#/$defs/Measure", + "description": "The length of the product or packaging eg {\"value\":840, \"unit\":\"MMT\"}" + }, + "width": { + "$ref": "#/$defs/Measure", + "description": "The width of the product or packaging. eg {\"value\":150, \"unit\":\"MMT\"}" + }, + "height": { + "$ref": "#/$defs/Measure", + "description": "The height of the product or packaging. eg {\"value\":220, \"unit\":\"MMT\"}" + }, + "volume": { + "$ref": "#/$defs/Measure", + "description": "The displacement volume of the product. eg {\"value\":7.5, \"unit\":\"LTR\"}" + } + }, + "description": "Overall (length, width, height) dimensions and weight/volume of an item." + }, + "Measure": { + "type": "object", + "additionalProperties": false, + "properties": { + "value": { + "example": 10, + "type": "number", + "description": "The numeric value of the measure" + }, + "unit": { + "type": "string", + "x-external-enumeration": "https://vocabulary.uncefact.org/UnitMeasureCode", + "description": "Unit of measure drawn from the UNECE rec20 measure code list.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://vocabulary.uncefact.org/UnitMeasureCode\n " + } + }, + "description": "The measure class defines a numeric measured value (eg 10) and a coded unit of measure (eg KG).", + "required": [ + "value", + "unit" + ] + }, + "Material": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "example": "Lithium Spodumene", + "type": "string", + "description": "Name of this material (eg \"Egyptian Cotton\")" + }, + "originCountry": { + "type": "string", + "x-external-enumeration": "https://vocabulary.uncefact.org/CountryId", + "description": "A ISO 3166-1 code representing the country of origin of the component or ingredient.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://vocabulary.uncefact.org/CountryId\n " + }, + "materialType": { + "$ref": "#/$defs/Classification", + "description": "The type of this material - as a value drawn from a controlled vocabulary eg from UN Framework Classification for Resources (UNFC)." + }, + "massFraction": { + "example": 0.2, + "type": "number", + "description": "The mass fraction of the product represented by this material. The sum of all mass fraction values for a given passport should be 1." + }, + "recycledAmount": { + "example": 0.5, + "type": "number", + "description": "Mass fraction of this material that is recycled (eg 50% recycled Lithium)" + }, + "hazardous": { + "example": "false", + "type": "boolean", + "description": "Indicates whether this material is hazardous. If true then the materialSafetyInformation proerty must be present" + }, + "materialSafetyInformation": { + "$ref": "#/$defs/Link", + "description": "Refernece to further information obout safe handling of this hazardous material (for example a link to a material safety data sheet)" + } + }, + "description": "The material class encapsulates details about the origin or source of raw materials in a product, including the country of origin and the mass fraction.", + "required": [ + "name" + ] + }, + "Declaration": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "Declaration" + ], + "default": [ + "Declaration" + ], + "items": { + "type": "string", + "enum": [ + "Declaration" + ] + } + }, + "id": { + "example": "https://products.example-company.com/09520123456788/declarations/12345", + "type": "string", + "format": "uri", + "description": "A unique identifier for the delcaration. Often this will be an extension of the product.id or attestation.id. But could be a UUID." + }, + "referenceStandard": { + "$ref": "#/$defs/Standard", + "description": "The reference to the standard that defines the specification / criteria" + }, + "referenceRegulation": { + "$ref": "#/$defs/Regulation", + "description": "The reference to the regulation that defines the assessment criteria" + }, + "assessmentCriteria": { + "type": "array", + "items": { + "$ref": "#/$defs/Criterion" + }, + "description": "The specification against which the assessment is made." + }, + "declaredValues": { + "type": "array", + "items": { + "$ref": "#/$defs/Metric" + }, + "description": "The list of specific values measured as part of this assessment (eg tensile strength)" + }, + "compliance": { + "example": "true", + "type": "boolean", + "description": "An indicator of whether or not the assessment meets the specification." + }, + "conformityTopic": { + "type": "string", + "enum": [ + "environment.energy", + "environment.emissions", + "environment.water", + "environment.waste", + "environment.deforestation", + "environment.biodiversity", + "circularity.content", + "circularity.design", + "social.labour", + "social.rights", + "social.community", + "social.safety", + "governance.ethics", + "governance.compliance", + "governance.transparency" + ], + "example": "environment.energy", + "description": "The conformity topic category for this assessment (eg vocabulary.uncefact.org/sustainability/emissions)" + }, + "conformityEvidence": { + "$ref": "#/$defs/SecureLink", + "description": "A URI pointing to the evidence supporting the claim. SHOULD be a URL to a UNTP Digital COnformity Credential (DCC)" + } + }, + "description": "A declaration of conformance with one or more criteria from a specific standard or regulation. ", + "required": [ + "id", + "compliance", + "conformityTopic" + ] + }, + "Standard": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "default": "Standard", + "enum": [ + "Standard" + ] + }, + "id": { + "example": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf", + "type": "string", + "format": "uri", + "description": "A unique identifier for the standard (eg https://www.iso.org/standard/60857.html)." + }, + "name": { + "example": "GBA Battery Passport Greenhouse Gas Rulebook - V.2.0", + "type": "string", + "description": "The name of the standard" + }, + "issuingParty": { + "$ref": "#/$defs/Entity", + "description": "The party that issued the standard " + }, + "issueDate": { + "example": "2023-12-05", + "type": "string", + "format": "date", + "description": "The date when the standard was issued." + } + }, + "description": "A standard (eg ISO 14000) that specifies the criteria for conformance.", + "required": [ + "issuingParty" + ] + }, + "Regulation": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "default": "Regulation", + "enum": [ + "Regulation" + ] + }, + "id": { + "example": "https://www.legislation.gov.au/F2008L02309/latest/versions", + "type": "string", + "format": "uri", + "description": "The globally unique identifier of this regulation. " + }, + "name": { + "example": "NNational Greenhouse and Energy Reporting (Measurement) Determination", + "type": "string", + "description": "The name of the regulation or act." + }, + "jurisdictionCountry": { + "type": "string", + "x-external-enumeration": "https://vocabulary.uncefact.org/CountryId", + "description": "The legal jurisdiction (country) under which the regulation is issued.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://vocabulary.uncefact.org/CountryId\n " + }, + "administeredBy": { + "$ref": "#/$defs/Entity", + "description": "the issuing body of the regulation. For example Australin Goernment Department of Climate Change, Energy, the Environment and Water" + }, + "effectiveDate": { + "example": "2024-03-20", + "type": "string", + "format": "date", + "description": "the date at which the regulation came into effect." + } + }, + "description": "A regulation (eg EU deforestation regulation) that defines the criteria for assessment.", + "required": [ + "administeredBy" + ] + }, + "Criterion": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "default": "Criterion", + "enum": [ + "Criterion" + ] + }, + "id": { + "example": "https://www.globalbattery.org/media/publications/gba-rulebook-v2.0-master.pdf#BatteryAssembly", + "type": "string", + "format": "uri", + "description": "A unique identifier for the criteria within the standard or regulation. For example CO2 emissions calaculations for liquid fule combusion." + }, + "name": { + "example": "GBA Battery rule book v2.0 battery assembly guidelines.", + "type": "string", + "description": "A name that describes this criteria." + }, + "thresholdValues": { + "type": "array", + "items": { + "$ref": "#/$defs/Metric" + }, + "description": "A conformity threshold defined by the specification (eg minimum compressive strength) " + } + }, + "description": "A specific rule or criterion within a standard or regulation. eg a carbon intensity calculation rule within an emissions standard.", + "required": [ + "id", + "name" + ] + }, + "Metric": { + "type": "object", + "additionalProperties": false, + "properties": { + "metricName": { + "example": "GHG emissions intensity", + "type": "string", + "description": "A human readable name for this metric (for example \"Tensile strength\")" + }, + "metricValue": { + "$ref": "#/$defs/Measure", + "description": "A numeric value and unit of measure for this metric. Could be a measured value or a specified threshold. Eg {\"value\":400, \"unit\":\"MPA\"} as tensile strenght of structural steel" + }, + "accuracy": { + "example": 0.05, + "type": "number", + "description": "A percentage represented as a numeric between 0 and 1 indicating the rage of accuracy of the claimed value (eg 0.05 means that the actual value is within 5% of the claimed value.)" + } + }, + "description": "A specific measure of performance against the criteria that governs the claim. Expressed as an array of metric (ie unit of emasure) / value (ie the actual numeric value) pairs. ", + "required": [ + "metricName", + "metricValue" + ] + }, + "SecureLink": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "SecureLink", + "Link" + ], + "default": [ + "SecureLink", + "Link" + ], + "items": { + "type": "string", + "enum": [ + "SecureLink", + "Link" + ] + } + }, + "linkURL": { + "example": "https://files.example-certifier.com/1234567.json", + "type": "string", + "format": "uri", + "description": "The URL of the target resource. " + }, + "linkName": { + "example": "GBA rule book conformity certificate", + "type": "string", + "description": "A display name for the target resource " + }, + "linkType": { + "example": "https://test.uncefact.org/vocabulary/linkTypes/dcc", + "type": "string", + "description": "The type of the target resource - drawn from a controlled vocabulary " + }, + "hashDigest": { + "example": "6239119dda5bd4c8a6ffb832fe16feaa5c27b7dba154d24c53d4470a2c69adc2", + "type": "string", + "description": "The hash of the file." + }, + "hashMethod": { + "type": "string", + "enum": [ + "SHA-256", + "SHA-1" + ], + "example": "SHA-256", + "description": "The hashing algorithm used to create the target hash. SHA-265 is the recommedned standard" + }, + "encryptionMethod": { + "type": "string", + "enum": [ + "none", + "AES" + ], + "example": "none", + "description": "The symmetric encryption algorithm used to encrypt the link target. AES is the recommended standard. Decryption keys are expected to be passed out of bounds." + } + }, + "description": "A binary file that is hashed ()for tamper evidence) and optionally encrypted (for confidentiality)." + }, + "CircularityPerformance": { + "type": "object", + "additionalProperties": false, + "properties": { + "recyclingInformation": { + "$ref": "#/$defs/Link", + "description": "A URI pointing to recycling information for the product." + }, + "repairInformation": { + "$ref": "#/$defs/Link", + "description": "A URI pointing to repair instructions for this product." + }, + "recyclableContent": { + "example": 0.5, + "type": "number", + "format": "float", + "description": "The fraction of the this product (my mass) that has been designed to be recyclable / re-usable. This will be be the total fraction that can avoid waste / landfill." + }, + "recyecledContent": { + "example": 0.3, + "type": "number", + "format": "float", + "description": "The fraction (by mass) of recycled / repurposed, repaired content in this product. This will be the total virgin content fraction." + }, + "utilityFactor": { + "example": 1.2, + "type": "number", + "format": "float", + "description": "An indicator of durability defined as the lifetime (typically measures as usage cycles) for this product divided by the industry average. For example a battery with a 10,000 cycle lifetime where industry average is 5,000 cycles will have a durability factor of 2. If unknown set to 1 or omit. " + }, + "materialCircularityIndicator": { + "example": 0.67, + "type": "number", + "format": "float", + "description": "The overall circularity performance indicator for this product. Calculated as 1 - (V+W)/2D where - V = Virgin material proportion by mass (will be 1- recycled content) - W = Waste leakage proportion by mass (will be 1 - recyclableContent) - D = Utility factor (set to 1 if unknown). " + } + }, + "description": "High level corcularity information about this product. Note that this doens not substitute for detailed product circularity data sheet (PCDS) criteria which would be represented as a set of conformity claims against individual ISO PCDS criteria." + }, + "EmissionsPerformance": { + "type": "object", + "additionalProperties": false, + "properties": { + "carbonFootprint": { + "example": 1.8, + "type": "number", + "format": "float", + "description": "The carbon footprint of the product in KgCO2e per declared unit." + }, + "declaredUnit": { + "type": "string", + "x-external-enumeration": "https://vocabulary.uncefact.org/UnitMeasureCode", + "description": "The unit of product (EA, KGM, LTR, etc) that is the basis for carbon footprint.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://vocabulary.uncefact.org/UnitMeasureCode\n " + }, + "operationalScope": { + "type": "string", + "enum": [ + "None", + "CradleToGate", + "CradleToGrave" + ], + "example": "None", + "description": "The operational scope of the emissions performance. Only scope 1 & 2, or inlcuing upstream scope 3 (cradle to gate) or upstream and downstream scope 3 (cradle to grave)." + }, + "primarySourcedRatio": { + "example": 0.3, + "type": "number", + "format": "float", + "description": "The ratio of emissions data from primary sources (ie from supplier / product specific information rather than secondary / industry averages)." + }, + "reportingStandard": { + "$ref": "#/$defs/Standard", + "description": "The reporting standard (eg GHG Protocol, IFRS S2, ESRS, etc) against which this product emissions performance is assessed." + } + }, + "description": "Product specific characteristics. This class is an extension point for industry specific product characteristics or performance information such as clothing size or battery capacity.", + "required": [ + "carbonFootprint", + "declaredUnit", + "operationalScope", + "primarySourcedRatio" + ] + } + } +} \ No newline at end of file diff --git a/packages/untp-test-suite/src/schemas/transactionEvent/v0.3.9/schema.json b/packages/untp-test-suite/src/schemas/transactionEvent/v0.3.9/schema.json new file mode 100644 index 00000000..f24d452c --- /dev/null +++ b/packages/untp-test-suite/src/schemas/transactionEvent/v0.3.9/schema.json @@ -0,0 +1,817 @@ +{ + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "DigitalTraceabilityEvent", + "VerifiableCredential" + ], + "default": [ + "DigitalTraceabilityEvent", + "VerifiableCredential" + ], + "items": { + "type": "string", + "enum": [ + "DigitalTraceabilityEvent", + "VerifiableCredential" + ] + } + }, + "@context": { + "example": "https://test.uncefact.org/vocabulary/untp/dpp/dpp-context.jsonld", + "type": "array", + "items": { + "type": "string", + "enum": [ + "https://www.w3.org/ns/credentials/v2", + "https://vocabulary.uncefact.org/untp/dte/{{version}}" + ] + }, + "description": "A list of JSON-LD context URIs that define the seamntic meaning of prperties within the credential. ", + "readOnly": true, + "const": [ + "https://www.w3.org/ns/credentials/v2", + "https://vocabulary.uncefact.org/untp/dte/{{version}}" + ], + "default": [ + "https://www.w3.org/ns/credentials/v2", + "https://vocabulary.uncefact.org/untp/dte/{{version}}" + ] + }, + "id": { + "example": "https://example-company.com/credentials/2a423366-a0d6-4855-ba65-2e0c926d09b0", + "type": "string", + "format": "uri", + "description": "A unique identifier (URI) assigned to the product passport. May be a UUID" + }, + "issuer": { + "$ref": "#/$defs/CredentialIssuer", + "description": "The organisation that is the isuer of this VC. Note that the \"id\" property MUST be a W3C DID. Other identifiers such as tax registration numbers can be listed in the \"otherIdentifiers\" property." + }, + "validFrom": { + "example": "2024-03-15", + "type": "string", + "format": "date-time", + "description": "The date and time from which the credential is valid." + }, + "validUntil": { + "example": "2034-03-15", + "type": "string", + "format": "date-time", + "description": "The expiry date (if applicable) of this verifiable credential." + }, + "credentialSubject": { + "type": "array", + "items": { + "$ref": "#/$defs/Event" + }, + "description": "VC subject is the transaction event structure" + } + }, + "description": "Traceability Event as a VC", + "required": [ + "@context", + "id", + "issuer" + ], + "$schema": "https://json-schema.org/draft/2020-12/schema", + "$defs": { + "CredentialIssuer": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "default": "CredentialIssuer", + "enum": [ + "CredentialIssuer" + ] + }, + "id": { + "example": "did:web:identifiers.example-company.com:12345", + "type": "string", + "format": "uri", + "description": "The W3C DID of the issuer - should be a did:web or did:tdw" + }, + "name": { + "example": "Example Company Pty Ltd", + "type": "string", + "description": "The name of the issuer person or organisation" + }, + "otherIdentifiers": { + "type": "array", + "items": { + "$ref": "#/$defs/Entity" + }, + "description": "An optional list of other registered identifiers for this credential issuer " + } + }, + "description": "The issuer party ()person or orgnaition) of a verifiable credential.", + "required": [ + "id", + "name" + ] + }, + "Entity": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "default": "Entity", + "enum": [ + "Entity" + ] + }, + "id": { + "example": "https://id.gs1.org/01/09520123456788/21/12345", + "type": "string", + "format": "uri", + "description": "The globally unique ID of the entity as a resolvable URL according to ISO 18975. ExamplesProduct - id.gs1.org/01/09520123456788/21/12345 Party - abr.business.gov.au/ABN/View?abn=90664869327. Facility - did:web:facilities.example-company.com:123. " + }, + "name": { + "example": "EV battery 300Ah.", + "type": "string", + "description": "The registered name of the entity within the identifier scheme. Examplesproduct - EV battery 300Ahparty - Sample Company Pty Ltd. facility - Greenacres battery factory" + }, + "registeredId": { + "example": "90664869327", + "type": "string", + "description": "The registration number (alphanumeric) of the entity within the register. Unique within the register." + }, + "idScheme": { + "$ref": "#/$defs/IdentifierScheme", + "description": "The identifier scheme. Exampleproduct - id.gs1.org/01. party - business.gov.au/abn facility - did:web:facilities.acme.com. " + } + }, + "description": "The ID and Name of an identified entity such qs a product, facility, party, standard, etc. If the identifier is a W3C DID then the corresponding DID document SHOULD include a serviceEndpoint of type \"IdentityResolver\". If the identifier is not a W3C DID then the id peroperty SHOULD be an identity resolver URL.", + "required": [ + "id", + "name" + ] + }, + "IdentifierScheme": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "default": "IdentifierScheme", + "enum": [ + "IdentifierScheme" + ] + }, + "id": { + "example": "https://id.gs1.org/01/", + "type": "string", + "format": "uri", + "description": "The globally unique identifier of the registration scheme. The scheme should be registered and discoverable from vocabulary.uncefact.org/identifierSchemes" + }, + "name": { + "example": "Global Trade Identification Number (GTIN)", + "type": "string", + "description": "The name of the identifier scheme. " + } + }, + "description": "An identifier registration scheme for products, facilities, or organisations. Typically operated by a state, national or gloabl authority." + }, + "TransformationEvent": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "TransformationEvent", + "Event" + ], + "default": [ + "TransformationEvent", + "Event" + ], + "items": { + "type": "string", + "enum": [ + "TransformationEvent", + "Event" + ] + } + }, + "id": { + "readOnly": true, + "type": "string", + "format": "uri", + "description": "The unique identifier of this event - SHOULD be a UUID" + }, + "eventTime": { + "type": "string", + "format": "date-time", + "description": "The ISO-8601 date time when the event occurred." + }, + "action": { + "type": "string", + "enum": [ + "observe", + "add", + "delete" + ], + "example": "observe", + "description": "Code describing how an event relates to the lifecycle of the entity impacted by the event." + }, + "disposition": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/Disp", + "description": "Disposition code describing the state of the item after the event. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/Disp\n " + }, + "bizStep": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/BizStep", + "description": "A business step code drawn from a controlled vocabulary. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/BizStep\n " + }, + "bizLocation": { + "type": "string", + "format": "uri", + "description": "A Business Location is a uniquely identified and discretely recorded geospatial location that is meant to designate the specific place where an object is assumed to be following an EPCIS event until it is reported to be at a different Business Location by a subsequent EPCIS event. The bizLocation must be a resolvable URI that links to facility information and geolocation data." + }, + "sensorElementList": { + "type": "array", + "items": { + "$ref": "#/$defs/SensorElement" + }, + "description": "An array (one for each sensor) of sensor device data sets associated with the event. " + }, + "outputEPCList": { + "type": "array", + "items": { + "$ref": "#/$defs/Item" + }, + "description": "The list of uniquely identified items that are the output of this transformation event - for example a list of individually identified bolts of cloth that are the output of a weaving process." + }, + "inputEPCList": { + "type": "array", + "items": { + "$ref": "#/$defs/Item" + }, + "description": "The list of uniquely identified items that are the input of this transformation event - for example a list of individually identified bobbins of yarn that are the input of a weaving process." + }, + "inputQuantityList": { + "type": "array", + "items": { + "$ref": "#/$defs/QuantityElement" + }, + "description": "The quantified list of product classes that are the input of this transformation event - used when each item does not have a unique identity. for example the weight of raw cotton that is the input to a ginning process." + }, + "outputQuantityList": { + "type": "array", + "items": { + "$ref": "#/$defs/QuantityElement" + }, + "description": "The quantified list of product classes that are the output of this transformation event - used when each item does not have a unique identity. for example a count of the bales of cleaned cotton that are the output of a ginning process." + }, + "processType": { + "type": "string", + "format": "uri", + "description": "An industry specific process type code. " + } + }, + "description": "Transformation represents an event in which input objects are fully or partially consumed and output objects are produced, such that any of the input objects may have contributed to all of the output objects - for example consuming bales of cotton to produce yarn." + }, + "SensorElement": { + "type": "object", + "additionalProperties": false, + "properties": { + "sensorMetadata": { + "$ref": "#/$defs/Sensor", + "description": "Data that describes the physical sensor that recorded the sensor data set." + }, + "sensorReport": { + "type": "array", + "items": { + "$ref": "#/$defs/SensorData" + }, + "description": "A list of sensor readings from the given sensor relevant to the traceability event context." + }, + "sensorIntegrityProof": { + "type": "string", + "format": "uri", + "description": "An optional reference to a verifiable credential signed by the sensor device or device manufacturer that contains the digitally signed raw data associated with this sensor report." + } + }, + "description": "A SensorElement is used to carry data related to an event that is captured one sensor such as an IoT device. Include one sensor property and an array of sensor data values." + }, + "Sensor": { + "type": "object", + "additionalProperties": false, + "properties": { + "device": { + "$ref": "#/$defs/Item", + "description": "The device Identifier for the sensor as a URI (typically an EPC)" + }, + "dataProcessingMethod": { + "type": "string", + "format": "uri", + "description": "The data processing method used by the sensor - should reference a documented standard criteria as a URI" + } + }, + "description": "A physical sensor that records a sensor data set." + }, + "Item": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "Item", + "Entity" + ], + "default": [ + "Item", + "Entity" + ], + "items": { + "type": "string", + "enum": [ + "Item", + "Entity" + ] + } + }, + "id": { + "example": "https://id.gs1.org/01/09520123456788/21/12345", + "type": "string", + "format": "uri", + "description": "The globally unique ID of the entity as a resolvable URL according to ISO 18975. ExamplesProduct - id.gs1.org/01/09520123456788/21/12345 Party - abr.business.gov.au/ABN/View?abn=90664869327. Facility - did:web:facilities.example-company.com:123. " + }, + "name": { + "example": "EV battery 300Ah.", + "type": "string", + "description": "The registered name of the entity within the identifier scheme. Examplesproduct - EV battery 300Ahparty - Sample Company Pty Ltd. facility - Greenacres battery factory" + }, + "registeredId": { + "example": "90664869327", + "type": "string", + "description": "The registration number (alphanumeric) of the entity within the register. Unique within the register." + }, + "idScheme": { + "$ref": "#/$defs/IdentifierScheme", + "description": "The identifier scheme. Exampleproduct - id.gs1.org/01. party - business.gov.au/abn facility - did:web:facilities.acme.com. " + } + }, + "description": "A specific serilaised trade item which is a type of a more generic product. Typically an SGTIN", + "required": [ + "id", + "name" + ] + }, + "SensorData": { + "type": "object", + "additionalProperties": false, + "properties": { + "time": { + "type": "string", + "format": "date-time", + "description": "the timestamp at which the sensor reading was made." + }, + "sensorType": { + "type": "string", + "format": "uri", + "description": "the measurement type of the sensor reading, as a URI reference to a measurement method specification." + }, + "value": { + "type": "number", + "description": "the sensor reading" + }, + "uom": { + "type": "string", + "x-external-enumeration": "https://vocabulary.uncefact.org/UnitMeasureCode", + "description": "the unit of measure for the sensor reading\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://vocabulary.uncefact.org/UnitMeasureCode\n " + } + }, + "description": "A data point read by a sensor." + }, + "QuantityElement": { + "type": "object", + "additionalProperties": false, + "properties": { + "product": { + "$ref": "#/$defs/Entity", + "description": "THe identifier of a product class (as opposed to a product instance) such as a GTIN code for a manufactured product." + }, + "quantity": { + "type": "number", + "description": "The numeric quantity of the product class (eg 100 kg of cotton)" + }, + "uom": { + "type": "string", + "x-external-enumeration": "https://vocabulary.uncefact.org/UnitMeasureCode", + "description": "The unit of measure for the quantity value (eg Kg or meters etc) using the UNECE Rec 20 unit of measure codelist.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://vocabulary.uncefact.org/UnitMeasureCode\n " + } + }, + "description": "The quantity element is used to define the quantities (eg 100), units of measure (eg Kg) and product class (eg GTIN or other class identifier) of products that are inputs or outputs or the subject of supply chain events. ", + "required": [ + "quantity" + ] + }, + "ObjectEvent": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "ObjectEvent", + "Event" + ], + "default": [ + "ObjectEvent", + "Event" + ], + "items": { + "type": "string", + "enum": [ + "ObjectEvent", + "Event" + ] + } + }, + "id": { + "readOnly": true, + "type": "string", + "format": "uri", + "description": "The unique identifier of this event - SHOULD be a UUID" + }, + "eventTime": { + "type": "string", + "format": "date-time", + "description": "The ISO-8601 date time when the event occurred." + }, + "action": { + "type": "string", + "enum": [ + "observe", + "add", + "delete" + ], + "example": "observe", + "description": "Code describing how an event relates to the lifecycle of the entity impacted by the event." + }, + "disposition": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/Disp", + "description": "Disposition code describing the state of the item after the event. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/Disp\n " + }, + "bizStep": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/BizStep", + "description": "A business step code drawn from a controlled vocabulary. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/BizStep\n " + }, + "bizLocation": { + "type": "string", + "format": "uri", + "description": "A Business Location is a uniquely identified and discretely recorded geospatial location that is meant to designate the specific place where an object is assumed to be following an EPCIS event until it is reported to be at a different Business Location by a subsequent EPCIS event. The bizLocation must be a resolvable URI that links to facility information and geolocation data." + }, + "sensorElementList": { + "type": "array", + "items": { + "$ref": "#/$defs/SensorElement" + }, + "description": "An array (one for each sensor) of sensor device data sets associated with the event. " + }, + "epcList": { + "type": "array", + "items": { + "$ref": "#/$defs/Item" + }, + "description": "A list of uniquely identified items (eg specific items serial numbers or tagged shipments / packages) that are the focus of this object event. " + }, + "quantityList": { + "type": "array", + "items": { + "$ref": "#/$defs/QuantityElement" + }, + "description": "A quantified list of product classes (eg GS1 GTINs) that are the focus of this object event" + } + }, + "description": "Object represents an event that happened to one or more physical or digital objects - such as an inspection or certification of a product or shipment. The physical objects may be identified either as specific items (eg a unique consignment number) or as a quantified amount of a product class (eg 100Kg of cotton yarn)" + }, + "AggregationEvent": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "AggregationEvent", + "Event" + ], + "default": [ + "AggregationEvent", + "Event" + ], + "items": { + "type": "string", + "enum": [ + "AggregationEvent", + "Event" + ] + } + }, + "id": { + "readOnly": true, + "type": "string", + "format": "uri", + "description": "The unique identifier of this event - SHOULD be a UUID" + }, + "eventTime": { + "type": "string", + "format": "date-time", + "description": "The ISO-8601 date time when the event occurred." + }, + "action": { + "type": "string", + "enum": [ + "observe", + "add", + "delete" + ], + "example": "observe", + "description": "Code describing how an event relates to the lifecycle of the entity impacted by the event." + }, + "disposition": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/Disp", + "description": "Disposition code describing the state of the item after the event. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/Disp\n " + }, + "bizStep": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/BizStep", + "description": "A business step code drawn from a controlled vocabulary. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/BizStep\n " + }, + "bizLocation": { + "type": "string", + "format": "uri", + "description": "A Business Location is a uniquely identified and discretely recorded geospatial location that is meant to designate the specific place where an object is assumed to be following an EPCIS event until it is reported to be at a different Business Location by a subsequent EPCIS event. The bizLocation must be a resolvable URI that links to facility information and geolocation data." + }, + "sensorElementList": { + "type": "array", + "items": { + "$ref": "#/$defs/SensorElement" + }, + "description": "An array (one for each sensor) of sensor device data sets associated with the event. " + }, + "parentEPC": { + "$ref": "#/$defs/Item", + "description": "The unique item identifier that is the result of this aggregation. Typically a packaging ID used in shipments that represents a box/ pallet / container of contained items." + }, + "childEPCs": { + "type": "array", + "items": { + "$ref": "#/$defs/Item" + }, + "description": "The list of child items that have been aggregated into the parent (or dis-aggregated from the parent). Maybe a list of package references (eg boxes on a pallet) or may be individual items (eg products in a box)." + }, + "childQuantityList": { + "type": "array", + "items": { + "$ref": "#/$defs/QuantityElement" + }, + "description": "List of quantified product classes that have been aggregated into the parent. Used whwn the child items do not have unique identifiers (eg 100 Kg of cotton bales)" + } + }, + "description": "Aggregation represents an event that happened to one or more objects that are physically aggregated together (physically constrained to be in the same place at the same time, as when cases are aggregated to a pallet). This event is also used to represent de-aggregation (eg unpacking) when businessStepCode is unpacking." + }, + "TransactionEvent": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "TransactionEvent", + "Event" + ], + "default": [ + "TransactionEvent", + "Event" + ], + "items": { + "type": "string", + "enum": [ + "TransactionEvent", + "Event" + ] + } + }, + "id": { + "readOnly": true, + "type": "string", + "format": "uri", + "description": "The unique identifier of this event - SHOULD be a UUID" + }, + "eventTime": { + "type": "string", + "format": "date-time", + "description": "The ISO-8601 date time when the event occurred." + }, + "action": { + "type": "string", + "enum": [ + "observe", + "add", + "delete" + ], + "example": "observe", + "description": "Code describing how an event relates to the lifecycle of the entity impacted by the event." + }, + "disposition": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/Disp", + "description": "Disposition code describing the state of the item after the event. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/Disp\n " + }, + "bizStep": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/BizStep", + "description": "A business step code drawn from a controlled vocabulary. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/BizStep\n " + }, + "bizLocation": { + "type": "string", + "format": "uri", + "description": "A Business Location is a uniquely identified and discretely recorded geospatial location that is meant to designate the specific place where an object is assumed to be following an EPCIS event until it is reported to be at a different Business Location by a subsequent EPCIS event. The bizLocation must be a resolvable URI that links to facility information and geolocation data." + }, + "sensorElementList": { + "type": "array", + "items": { + "$ref": "#/$defs/SensorElement" + }, + "description": "An array (one for each sensor) of sensor device data sets associated with the event. " + }, + "sourceParty": { + "$ref": "#/$defs/Entity", + "description": "The source party for this supply chain transaction - typically the seller party" + }, + "destinationParty": { + "$ref": "#/$defs/Entity", + "description": "The destination party for this supply chain transaction - typically the buyer party." + }, + "epcList": { + "type": "array", + "items": { + "$ref": "#/$defs/Item" + }, + "description": "The list of uniquely identified trade items included in this supply chain transaction." + }, + "quantityList": { + "type": "array", + "items": { + "$ref": "#/$defs/QuantityElement" + }, + "description": "List of quantified product classes that are included in this transaction. Used when the trade items do not have unique identifiers (eg 100 reels of yarn)" + }, + "referenceDocument": { + "$ref": "#/$defs/TradeDocument", + "description": "The supply chain document reference for this transaction event - eg the invoice, order, or dispatch advice" + } + }, + "description": "Transaction represents an event in which one or more objects become associated or disassociated with one or more identified business transactions - such as the purchase / shipment of goods between buyer and seller." + }, + "TradeDocument": { + "type": "object", + "additionalProperties": false, + "properties": { + "documentType": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/BTT", + "description": "The document type representing the trade transaction drawn from the business transaction type vocabulary.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/BTT\n " + }, + "identifier": { + "type": "string", + "description": "The identifier of the trade transaction document - eg an invoice number or bill of lading number. Must be unique for a given source party" + }, + "documentURL": { + "type": "string", + "format": "uri", + "description": "The URL of the referenced trade document. For integrity reasons, it is recommended (but not required) that the documentURL is a hashlink (https://w3c-ccg.github.io/hashlink/) so that if the document the URL is changed then the hash verification will fail." + } + }, + "description": "A trade transaction between two parties such as an invoice, purchase order, or shipping notification." + }, + "AssociationEvent": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "AssociationEvent", + "Event" + ], + "default": [ + "AssociationEvent", + "Event" + ], + "items": { + "type": "string", + "enum": [ + "AssociationEvent", + "Event" + ] + } + }, + "id": { + "readOnly": true, + "type": "string", + "format": "uri", + "description": "The unique identifier of this event - SHOULD be a UUID" + }, + "eventTime": { + "type": "string", + "format": "date-time", + "description": "The ISO-8601 date time when the event occurred." + }, + "action": { + "type": "string", + "enum": [ + "observe", + "add", + "delete" + ], + "example": "observe", + "description": "Code describing how an event relates to the lifecycle of the entity impacted by the event." + }, + "disposition": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/Disp", + "description": "Disposition code describing the state of the item after the event. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/Disp\n " + }, + "bizStep": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/BizStep", + "description": "A business step code drawn from a controlled vocabulary. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/BizStep\n " + }, + "bizLocation": { + "type": "string", + "format": "uri", + "description": "A Business Location is a uniquely identified and discretely recorded geospatial location that is meant to designate the specific place where an object is assumed to be following an EPCIS event until it is reported to be at a different Business Location by a subsequent EPCIS event. The bizLocation must be a resolvable URI that links to facility information and geolocation data." + }, + "sensorElementList": { + "type": "array", + "items": { + "$ref": "#/$defs/SensorElement" + }, + "description": "An array (one for each sensor) of sensor device data sets associated with the event. " + }, + "parentEPC": { + "$ref": "#/$defs/Item", + "description": "The unique item identifier that is the parent of this association. Typically an assembled product ID such as a desktop computer that is built from the associated child components." + }, + "childEPCs": { + "type": "array", + "items": { + "$ref": "#/$defs/Item" + }, + "description": "The list of child items that have been assembled to create the parent - for example the power supply or hard drive components of a desktop computer." + }, + "childQuantityList": { + "type": "array", + "items": { + "$ref": "#/$defs/QuantityElement" + }, + "description": "List of quantified product classes that have been assembled into the parent. Used when the child items do not have unique identifiers (eg brackets and screws used in the assembly of a desktop computer)" + } + }, + "description": "The association event represents the assembly of child sub-components to create a parent assembled item. For example a desktop computer assembled from power supply, hard drive, and motherboard. The association event is very similar in structure to the aggregation event but is used for physical assembly. An association event may represent a bill of materials used to assemble a product whilst an aggregation event may represent a packing list or items for transport. " + }, + "Event": { + "type": "object", + "oneOf": [ + { + "$ref": "#/$defs/TransformationEvent" + }, + { + "$ref": "#/$defs/ObjectEvent" + }, + { + "$ref": "#/$defs/AggregationEvent" + }, + { + "$ref": "#/$defs/TransactionEvent" + }, + { + "$ref": "#/$defs/AssociationEvent" + } + ], + "description": "This abstract event structure provides a common language to describe supply chain events such as shipments, inspections, manufacturing processes, etc. There are four types of EPCIS event but this is an abstract class representing all common properties of an EPCIS event. " + } + } +} \ No newline at end of file diff --git a/packages/untp-test-suite/src/schemas/transformationEvent/v0.3.9/schema.json b/packages/untp-test-suite/src/schemas/transformationEvent/v0.3.9/schema.json new file mode 100644 index 00000000..f24d452c --- /dev/null +++ b/packages/untp-test-suite/src/schemas/transformationEvent/v0.3.9/schema.json @@ -0,0 +1,817 @@ +{ + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "DigitalTraceabilityEvent", + "VerifiableCredential" + ], + "default": [ + "DigitalTraceabilityEvent", + "VerifiableCredential" + ], + "items": { + "type": "string", + "enum": [ + "DigitalTraceabilityEvent", + "VerifiableCredential" + ] + } + }, + "@context": { + "example": "https://test.uncefact.org/vocabulary/untp/dpp/dpp-context.jsonld", + "type": "array", + "items": { + "type": "string", + "enum": [ + "https://www.w3.org/ns/credentials/v2", + "https://vocabulary.uncefact.org/untp/dte/{{version}}" + ] + }, + "description": "A list of JSON-LD context URIs that define the seamntic meaning of prperties within the credential. ", + "readOnly": true, + "const": [ + "https://www.w3.org/ns/credentials/v2", + "https://vocabulary.uncefact.org/untp/dte/{{version}}" + ], + "default": [ + "https://www.w3.org/ns/credentials/v2", + "https://vocabulary.uncefact.org/untp/dte/{{version}}" + ] + }, + "id": { + "example": "https://example-company.com/credentials/2a423366-a0d6-4855-ba65-2e0c926d09b0", + "type": "string", + "format": "uri", + "description": "A unique identifier (URI) assigned to the product passport. May be a UUID" + }, + "issuer": { + "$ref": "#/$defs/CredentialIssuer", + "description": "The organisation that is the isuer of this VC. Note that the \"id\" property MUST be a W3C DID. Other identifiers such as tax registration numbers can be listed in the \"otherIdentifiers\" property." + }, + "validFrom": { + "example": "2024-03-15", + "type": "string", + "format": "date-time", + "description": "The date and time from which the credential is valid." + }, + "validUntil": { + "example": "2034-03-15", + "type": "string", + "format": "date-time", + "description": "The expiry date (if applicable) of this verifiable credential." + }, + "credentialSubject": { + "type": "array", + "items": { + "$ref": "#/$defs/Event" + }, + "description": "VC subject is the transaction event structure" + } + }, + "description": "Traceability Event as a VC", + "required": [ + "@context", + "id", + "issuer" + ], + "$schema": "https://json-schema.org/draft/2020-12/schema", + "$defs": { + "CredentialIssuer": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "default": "CredentialIssuer", + "enum": [ + "CredentialIssuer" + ] + }, + "id": { + "example": "did:web:identifiers.example-company.com:12345", + "type": "string", + "format": "uri", + "description": "The W3C DID of the issuer - should be a did:web or did:tdw" + }, + "name": { + "example": "Example Company Pty Ltd", + "type": "string", + "description": "The name of the issuer person or organisation" + }, + "otherIdentifiers": { + "type": "array", + "items": { + "$ref": "#/$defs/Entity" + }, + "description": "An optional list of other registered identifiers for this credential issuer " + } + }, + "description": "The issuer party ()person or orgnaition) of a verifiable credential.", + "required": [ + "id", + "name" + ] + }, + "Entity": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "default": "Entity", + "enum": [ + "Entity" + ] + }, + "id": { + "example": "https://id.gs1.org/01/09520123456788/21/12345", + "type": "string", + "format": "uri", + "description": "The globally unique ID of the entity as a resolvable URL according to ISO 18975. ExamplesProduct - id.gs1.org/01/09520123456788/21/12345 Party - abr.business.gov.au/ABN/View?abn=90664869327. Facility - did:web:facilities.example-company.com:123. " + }, + "name": { + "example": "EV battery 300Ah.", + "type": "string", + "description": "The registered name of the entity within the identifier scheme. Examplesproduct - EV battery 300Ahparty - Sample Company Pty Ltd. facility - Greenacres battery factory" + }, + "registeredId": { + "example": "90664869327", + "type": "string", + "description": "The registration number (alphanumeric) of the entity within the register. Unique within the register." + }, + "idScheme": { + "$ref": "#/$defs/IdentifierScheme", + "description": "The identifier scheme. Exampleproduct - id.gs1.org/01. party - business.gov.au/abn facility - did:web:facilities.acme.com. " + } + }, + "description": "The ID and Name of an identified entity such qs a product, facility, party, standard, etc. If the identifier is a W3C DID then the corresponding DID document SHOULD include a serviceEndpoint of type \"IdentityResolver\". If the identifier is not a W3C DID then the id peroperty SHOULD be an identity resolver URL.", + "required": [ + "id", + "name" + ] + }, + "IdentifierScheme": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "default": "IdentifierScheme", + "enum": [ + "IdentifierScheme" + ] + }, + "id": { + "example": "https://id.gs1.org/01/", + "type": "string", + "format": "uri", + "description": "The globally unique identifier of the registration scheme. The scheme should be registered and discoverable from vocabulary.uncefact.org/identifierSchemes" + }, + "name": { + "example": "Global Trade Identification Number (GTIN)", + "type": "string", + "description": "The name of the identifier scheme. " + } + }, + "description": "An identifier registration scheme for products, facilities, or organisations. Typically operated by a state, national or gloabl authority." + }, + "TransformationEvent": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "TransformationEvent", + "Event" + ], + "default": [ + "TransformationEvent", + "Event" + ], + "items": { + "type": "string", + "enum": [ + "TransformationEvent", + "Event" + ] + } + }, + "id": { + "readOnly": true, + "type": "string", + "format": "uri", + "description": "The unique identifier of this event - SHOULD be a UUID" + }, + "eventTime": { + "type": "string", + "format": "date-time", + "description": "The ISO-8601 date time when the event occurred." + }, + "action": { + "type": "string", + "enum": [ + "observe", + "add", + "delete" + ], + "example": "observe", + "description": "Code describing how an event relates to the lifecycle of the entity impacted by the event." + }, + "disposition": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/Disp", + "description": "Disposition code describing the state of the item after the event. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/Disp\n " + }, + "bizStep": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/BizStep", + "description": "A business step code drawn from a controlled vocabulary. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/BizStep\n " + }, + "bizLocation": { + "type": "string", + "format": "uri", + "description": "A Business Location is a uniquely identified and discretely recorded geospatial location that is meant to designate the specific place where an object is assumed to be following an EPCIS event until it is reported to be at a different Business Location by a subsequent EPCIS event. The bizLocation must be a resolvable URI that links to facility information and geolocation data." + }, + "sensorElementList": { + "type": "array", + "items": { + "$ref": "#/$defs/SensorElement" + }, + "description": "An array (one for each sensor) of sensor device data sets associated with the event. " + }, + "outputEPCList": { + "type": "array", + "items": { + "$ref": "#/$defs/Item" + }, + "description": "The list of uniquely identified items that are the output of this transformation event - for example a list of individually identified bolts of cloth that are the output of a weaving process." + }, + "inputEPCList": { + "type": "array", + "items": { + "$ref": "#/$defs/Item" + }, + "description": "The list of uniquely identified items that are the input of this transformation event - for example a list of individually identified bobbins of yarn that are the input of a weaving process." + }, + "inputQuantityList": { + "type": "array", + "items": { + "$ref": "#/$defs/QuantityElement" + }, + "description": "The quantified list of product classes that are the input of this transformation event - used when each item does not have a unique identity. for example the weight of raw cotton that is the input to a ginning process." + }, + "outputQuantityList": { + "type": "array", + "items": { + "$ref": "#/$defs/QuantityElement" + }, + "description": "The quantified list of product classes that are the output of this transformation event - used when each item does not have a unique identity. for example a count of the bales of cleaned cotton that are the output of a ginning process." + }, + "processType": { + "type": "string", + "format": "uri", + "description": "An industry specific process type code. " + } + }, + "description": "Transformation represents an event in which input objects are fully or partially consumed and output objects are produced, such that any of the input objects may have contributed to all of the output objects - for example consuming bales of cotton to produce yarn." + }, + "SensorElement": { + "type": "object", + "additionalProperties": false, + "properties": { + "sensorMetadata": { + "$ref": "#/$defs/Sensor", + "description": "Data that describes the physical sensor that recorded the sensor data set." + }, + "sensorReport": { + "type": "array", + "items": { + "$ref": "#/$defs/SensorData" + }, + "description": "A list of sensor readings from the given sensor relevant to the traceability event context." + }, + "sensorIntegrityProof": { + "type": "string", + "format": "uri", + "description": "An optional reference to a verifiable credential signed by the sensor device or device manufacturer that contains the digitally signed raw data associated with this sensor report." + } + }, + "description": "A SensorElement is used to carry data related to an event that is captured one sensor such as an IoT device. Include one sensor property and an array of sensor data values." + }, + "Sensor": { + "type": "object", + "additionalProperties": false, + "properties": { + "device": { + "$ref": "#/$defs/Item", + "description": "The device Identifier for the sensor as a URI (typically an EPC)" + }, + "dataProcessingMethod": { + "type": "string", + "format": "uri", + "description": "The data processing method used by the sensor - should reference a documented standard criteria as a URI" + } + }, + "description": "A physical sensor that records a sensor data set." + }, + "Item": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "Item", + "Entity" + ], + "default": [ + "Item", + "Entity" + ], + "items": { + "type": "string", + "enum": [ + "Item", + "Entity" + ] + } + }, + "id": { + "example": "https://id.gs1.org/01/09520123456788/21/12345", + "type": "string", + "format": "uri", + "description": "The globally unique ID of the entity as a resolvable URL according to ISO 18975. ExamplesProduct - id.gs1.org/01/09520123456788/21/12345 Party - abr.business.gov.au/ABN/View?abn=90664869327. Facility - did:web:facilities.example-company.com:123. " + }, + "name": { + "example": "EV battery 300Ah.", + "type": "string", + "description": "The registered name of the entity within the identifier scheme. Examplesproduct - EV battery 300Ahparty - Sample Company Pty Ltd. facility - Greenacres battery factory" + }, + "registeredId": { + "example": "90664869327", + "type": "string", + "description": "The registration number (alphanumeric) of the entity within the register. Unique within the register." + }, + "idScheme": { + "$ref": "#/$defs/IdentifierScheme", + "description": "The identifier scheme. Exampleproduct - id.gs1.org/01. party - business.gov.au/abn facility - did:web:facilities.acme.com. " + } + }, + "description": "A specific serilaised trade item which is a type of a more generic product. Typically an SGTIN", + "required": [ + "id", + "name" + ] + }, + "SensorData": { + "type": "object", + "additionalProperties": false, + "properties": { + "time": { + "type": "string", + "format": "date-time", + "description": "the timestamp at which the sensor reading was made." + }, + "sensorType": { + "type": "string", + "format": "uri", + "description": "the measurement type of the sensor reading, as a URI reference to a measurement method specification." + }, + "value": { + "type": "number", + "description": "the sensor reading" + }, + "uom": { + "type": "string", + "x-external-enumeration": "https://vocabulary.uncefact.org/UnitMeasureCode", + "description": "the unit of measure for the sensor reading\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://vocabulary.uncefact.org/UnitMeasureCode\n " + } + }, + "description": "A data point read by a sensor." + }, + "QuantityElement": { + "type": "object", + "additionalProperties": false, + "properties": { + "product": { + "$ref": "#/$defs/Entity", + "description": "THe identifier of a product class (as opposed to a product instance) such as a GTIN code for a manufactured product." + }, + "quantity": { + "type": "number", + "description": "The numeric quantity of the product class (eg 100 kg of cotton)" + }, + "uom": { + "type": "string", + "x-external-enumeration": "https://vocabulary.uncefact.org/UnitMeasureCode", + "description": "The unit of measure for the quantity value (eg Kg or meters etc) using the UNECE Rec 20 unit of measure codelist.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://vocabulary.uncefact.org/UnitMeasureCode\n " + } + }, + "description": "The quantity element is used to define the quantities (eg 100), units of measure (eg Kg) and product class (eg GTIN or other class identifier) of products that are inputs or outputs or the subject of supply chain events. ", + "required": [ + "quantity" + ] + }, + "ObjectEvent": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "ObjectEvent", + "Event" + ], + "default": [ + "ObjectEvent", + "Event" + ], + "items": { + "type": "string", + "enum": [ + "ObjectEvent", + "Event" + ] + } + }, + "id": { + "readOnly": true, + "type": "string", + "format": "uri", + "description": "The unique identifier of this event - SHOULD be a UUID" + }, + "eventTime": { + "type": "string", + "format": "date-time", + "description": "The ISO-8601 date time when the event occurred." + }, + "action": { + "type": "string", + "enum": [ + "observe", + "add", + "delete" + ], + "example": "observe", + "description": "Code describing how an event relates to the lifecycle of the entity impacted by the event." + }, + "disposition": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/Disp", + "description": "Disposition code describing the state of the item after the event. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/Disp\n " + }, + "bizStep": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/BizStep", + "description": "A business step code drawn from a controlled vocabulary. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/BizStep\n " + }, + "bizLocation": { + "type": "string", + "format": "uri", + "description": "A Business Location is a uniquely identified and discretely recorded geospatial location that is meant to designate the specific place where an object is assumed to be following an EPCIS event until it is reported to be at a different Business Location by a subsequent EPCIS event. The bizLocation must be a resolvable URI that links to facility information and geolocation data." + }, + "sensorElementList": { + "type": "array", + "items": { + "$ref": "#/$defs/SensorElement" + }, + "description": "An array (one for each sensor) of sensor device data sets associated with the event. " + }, + "epcList": { + "type": "array", + "items": { + "$ref": "#/$defs/Item" + }, + "description": "A list of uniquely identified items (eg specific items serial numbers or tagged shipments / packages) that are the focus of this object event. " + }, + "quantityList": { + "type": "array", + "items": { + "$ref": "#/$defs/QuantityElement" + }, + "description": "A quantified list of product classes (eg GS1 GTINs) that are the focus of this object event" + } + }, + "description": "Object represents an event that happened to one or more physical or digital objects - such as an inspection or certification of a product or shipment. The physical objects may be identified either as specific items (eg a unique consignment number) or as a quantified amount of a product class (eg 100Kg of cotton yarn)" + }, + "AggregationEvent": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "AggregationEvent", + "Event" + ], + "default": [ + "AggregationEvent", + "Event" + ], + "items": { + "type": "string", + "enum": [ + "AggregationEvent", + "Event" + ] + } + }, + "id": { + "readOnly": true, + "type": "string", + "format": "uri", + "description": "The unique identifier of this event - SHOULD be a UUID" + }, + "eventTime": { + "type": "string", + "format": "date-time", + "description": "The ISO-8601 date time when the event occurred." + }, + "action": { + "type": "string", + "enum": [ + "observe", + "add", + "delete" + ], + "example": "observe", + "description": "Code describing how an event relates to the lifecycle of the entity impacted by the event." + }, + "disposition": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/Disp", + "description": "Disposition code describing the state of the item after the event. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/Disp\n " + }, + "bizStep": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/BizStep", + "description": "A business step code drawn from a controlled vocabulary. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/BizStep\n " + }, + "bizLocation": { + "type": "string", + "format": "uri", + "description": "A Business Location is a uniquely identified and discretely recorded geospatial location that is meant to designate the specific place where an object is assumed to be following an EPCIS event until it is reported to be at a different Business Location by a subsequent EPCIS event. The bizLocation must be a resolvable URI that links to facility information and geolocation data." + }, + "sensorElementList": { + "type": "array", + "items": { + "$ref": "#/$defs/SensorElement" + }, + "description": "An array (one for each sensor) of sensor device data sets associated with the event. " + }, + "parentEPC": { + "$ref": "#/$defs/Item", + "description": "The unique item identifier that is the result of this aggregation. Typically a packaging ID used in shipments that represents a box/ pallet / container of contained items." + }, + "childEPCs": { + "type": "array", + "items": { + "$ref": "#/$defs/Item" + }, + "description": "The list of child items that have been aggregated into the parent (or dis-aggregated from the parent). Maybe a list of package references (eg boxes on a pallet) or may be individual items (eg products in a box)." + }, + "childQuantityList": { + "type": "array", + "items": { + "$ref": "#/$defs/QuantityElement" + }, + "description": "List of quantified product classes that have been aggregated into the parent. Used whwn the child items do not have unique identifiers (eg 100 Kg of cotton bales)" + } + }, + "description": "Aggregation represents an event that happened to one or more objects that are physically aggregated together (physically constrained to be in the same place at the same time, as when cases are aggregated to a pallet). This event is also used to represent de-aggregation (eg unpacking) when businessStepCode is unpacking." + }, + "TransactionEvent": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "TransactionEvent", + "Event" + ], + "default": [ + "TransactionEvent", + "Event" + ], + "items": { + "type": "string", + "enum": [ + "TransactionEvent", + "Event" + ] + } + }, + "id": { + "readOnly": true, + "type": "string", + "format": "uri", + "description": "The unique identifier of this event - SHOULD be a UUID" + }, + "eventTime": { + "type": "string", + "format": "date-time", + "description": "The ISO-8601 date time when the event occurred." + }, + "action": { + "type": "string", + "enum": [ + "observe", + "add", + "delete" + ], + "example": "observe", + "description": "Code describing how an event relates to the lifecycle of the entity impacted by the event." + }, + "disposition": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/Disp", + "description": "Disposition code describing the state of the item after the event. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/Disp\n " + }, + "bizStep": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/BizStep", + "description": "A business step code drawn from a controlled vocabulary. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/BizStep\n " + }, + "bizLocation": { + "type": "string", + "format": "uri", + "description": "A Business Location is a uniquely identified and discretely recorded geospatial location that is meant to designate the specific place where an object is assumed to be following an EPCIS event until it is reported to be at a different Business Location by a subsequent EPCIS event. The bizLocation must be a resolvable URI that links to facility information and geolocation data." + }, + "sensorElementList": { + "type": "array", + "items": { + "$ref": "#/$defs/SensorElement" + }, + "description": "An array (one for each sensor) of sensor device data sets associated with the event. " + }, + "sourceParty": { + "$ref": "#/$defs/Entity", + "description": "The source party for this supply chain transaction - typically the seller party" + }, + "destinationParty": { + "$ref": "#/$defs/Entity", + "description": "The destination party for this supply chain transaction - typically the buyer party." + }, + "epcList": { + "type": "array", + "items": { + "$ref": "#/$defs/Item" + }, + "description": "The list of uniquely identified trade items included in this supply chain transaction." + }, + "quantityList": { + "type": "array", + "items": { + "$ref": "#/$defs/QuantityElement" + }, + "description": "List of quantified product classes that are included in this transaction. Used when the trade items do not have unique identifiers (eg 100 reels of yarn)" + }, + "referenceDocument": { + "$ref": "#/$defs/TradeDocument", + "description": "The supply chain document reference for this transaction event - eg the invoice, order, or dispatch advice" + } + }, + "description": "Transaction represents an event in which one or more objects become associated or disassociated with one or more identified business transactions - such as the purchase / shipment of goods between buyer and seller." + }, + "TradeDocument": { + "type": "object", + "additionalProperties": false, + "properties": { + "documentType": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/BTT", + "description": "The document type representing the trade transaction drawn from the business transaction type vocabulary.\n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/BTT\n " + }, + "identifier": { + "type": "string", + "description": "The identifier of the trade transaction document - eg an invoice number or bill of lading number. Must be unique for a given source party" + }, + "documentURL": { + "type": "string", + "format": "uri", + "description": "The URL of the referenced trade document. For integrity reasons, it is recommended (but not required) that the documentURL is a hashlink (https://w3c-ccg.github.io/hashlink/) so that if the document the URL is changed then the hash verification will fail." + } + }, + "description": "A trade transaction between two parties such as an invoice, purchase order, or shipping notification." + }, + "AssociationEvent": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "array", + "readOnly": true, + "const": [ + "AssociationEvent", + "Event" + ], + "default": [ + "AssociationEvent", + "Event" + ], + "items": { + "type": "string", + "enum": [ + "AssociationEvent", + "Event" + ] + } + }, + "id": { + "readOnly": true, + "type": "string", + "format": "uri", + "description": "The unique identifier of this event - SHOULD be a UUID" + }, + "eventTime": { + "type": "string", + "format": "date-time", + "description": "The ISO-8601 date time when the event occurred." + }, + "action": { + "type": "string", + "enum": [ + "observe", + "add", + "delete" + ], + "example": "observe", + "description": "Code describing how an event relates to the lifecycle of the entity impacted by the event." + }, + "disposition": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/Disp", + "description": "Disposition code describing the state of the item after the event. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/Disp\n " + }, + "bizStep": { + "type": "string", + "x-external-enumeration": "https://ref.gs1.org/cbv/BizStep", + "description": "A business step code drawn from a controlled vocabulary. \n\n This is an enumerated value, but the list of valid values are too big, or change too often to include here. You can access the list of allowable values at this URL: https://ref.gs1.org/cbv/BizStep\n " + }, + "bizLocation": { + "type": "string", + "format": "uri", + "description": "A Business Location is a uniquely identified and discretely recorded geospatial location that is meant to designate the specific place where an object is assumed to be following an EPCIS event until it is reported to be at a different Business Location by a subsequent EPCIS event. The bizLocation must be a resolvable URI that links to facility information and geolocation data." + }, + "sensorElementList": { + "type": "array", + "items": { + "$ref": "#/$defs/SensorElement" + }, + "description": "An array (one for each sensor) of sensor device data sets associated with the event. " + }, + "parentEPC": { + "$ref": "#/$defs/Item", + "description": "The unique item identifier that is the parent of this association. Typically an assembled product ID such as a desktop computer that is built from the associated child components." + }, + "childEPCs": { + "type": "array", + "items": { + "$ref": "#/$defs/Item" + }, + "description": "The list of child items that have been assembled to create the parent - for example the power supply or hard drive components of a desktop computer." + }, + "childQuantityList": { + "type": "array", + "items": { + "$ref": "#/$defs/QuantityElement" + }, + "description": "List of quantified product classes that have been assembled into the parent. Used when the child items do not have unique identifiers (eg brackets and screws used in the assembly of a desktop computer)" + } + }, + "description": "The association event represents the assembly of child sub-components to create a parent assembled item. For example a desktop computer assembled from power supply, hard drive, and motherboard. The association event is very similar in structure to the aggregation event but is used for physical assembly. An association event may represent a bill of materials used to assemble a product whilst an aggregation event may represent a packing list or items for transport. " + }, + "Event": { + "type": "object", + "oneOf": [ + { + "$ref": "#/$defs/TransformationEvent" + }, + { + "$ref": "#/$defs/ObjectEvent" + }, + { + "$ref": "#/$defs/AggregationEvent" + }, + { + "$ref": "#/$defs/TransactionEvent" + }, + { + "$ref": "#/$defs/AssociationEvent" + } + ], + "description": "This abstract event structure provides a common language to describe supply chain events such as shipments, inspections, manufacturing processes, etc. There are four types of EPCIS event but this is an abstract class representing all common properties of an EPCIS event. " + } + } +} \ No newline at end of file