@twin.org/standards-gs1 0.0.3-next.10 → 0.0.3-next.12

package/dist/es/schemas/EpcisTransactionEvent.json

@@ -0,0 +1,274 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/gs1-epcis/EpcisTransactionEvent",
+    "description": "EPCIS 2.0 TransactionEvent relating objects or quantities to one or more business transactions, optionally with a parent identifier.",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "description": "Allowed shapes for an EPCIS 2.0 JSON-LD `@context`, anchored on the GS1 context root and optionally augmented with custom entries.",
+            "anyOf": [
+                {
+                    "type": "string",
+                    "const": "https://ref.gs1.org/epcis/"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "const": "https://ref.gs1.org/epcis/"
+                    },
+                    "minItems": 1,
+                    "maxItems": 1
+                },
+                {
+                    "type": "array",
+                    "minItems": 2,
+                    "prefixItems": [
+                        {
+                            "type": "string",
+                            "const": "https://ref.gs1.org/epcis/"
+                        },
+                        {
+                            "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                        }
+                    ],
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    }
+                },
+                {
+                    "type": "array",
+                    "minItems": 2,
+                    "prefixItems": [
+                        {
+                            "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                        },
+                        {
+                            "type": "string",
+                            "const": "https://ref.gs1.org/epcis/"
+                        }
+                    ],
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    }
+                }
+            ]
+        },
+        "@id": {
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            ]
+        },
+        "@included": {
+            "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
+        },
+        "@graph": {
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                    }
+                }
+            ]
+        },
+        "@nest": {
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
+                    }
+                }
+            ]
+        },
+        "@type": {
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            ]
+        },
+        "@reverse": {
+            "type": "object",
+            "additionalProperties": {
+                "type": "string"
+            }
+        },
+        "@index": {
+            "type": "string"
+        },
+        "type": {
+            "type": "string",
+            "const": "TransactionEvent",
+            "description": "Fixed to TransactionEvent."
+        },
+        "eventID": {
+            "type": "string",
+            "description": "URI identifier of a specific EPCIS event (alias of id in JSON or XML)."
+        },
+        "certificationInfo": {
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            ],
+            "description": "(Optional) CertificationDetails relevant for Objects, Places and/or Organizations mentioned in this Event."
+        },
+        "errorDeclaration": {
+            "$ref": "https://schema.twindev.org/gs1-epcis/EpcisErrorDeclaration",
+            "description": "Error declaration."
+        },
+        "eventTime": {
+            "type": "string",
+            "description": "The date and time at which the EPCIS Capturing Applications asserts the event occurred."
+        },
+        "eventTimeZoneOffset": {
+            "type": "string",
+            "description": "The time zone offset in effect at the time and place the event occurred, expressed as an offset from UTC."
+        },
+        "recordTime": {
+            "type": "string",
+            "description": "(Optional) The date and time at which this event was recorded by an EPCIS Repository; ignored at capture and present on query results."
+        },
+        "bizTransactionList": {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.twindev.org/gs1-epcis/EpcisBizTransaction"
+            },
+            "description": "Business transaction list (required by schema)."
+        },
+        "parentID": {
+            "type": "string",
+            "description": "(Optional when action is OBSERVE, required otherwise) Identifier of the parent of the aggregation or association; use the pure identity URI when the parent is an EPC."
+        },
+        "epcList": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            },
+            "description": "(Optional) An unordered list of one or more EPCs naming specific objects to which the event pertained."
+        },
+        "quantityList": {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.twindev.org/gs1-epcis/EpcisQuantity"
+            },
+            "description": "An unordered list of one or more QuantityElements identifying (at the class level) contained objects."
+        },
+        "action": {
+            "$ref": "https://schema.twindev.org/gs1-epcis/EpcisActionTypes",
+            "description": "How this event relates to the lifecycle of the EPCs named in this event."
+        },
+        "bizStep": {
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/gs1-epcis/EpcisBizStepTypes"
+                },
+                {
+                    "type": "string"
+                }
+            ],
+            "description": "(Optional) The business step of which this event was a part."
+        },
+        "disposition": {
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/gs1-epcis/EpcisDispositionTypes"
+                },
+                {
+                    "type": "string"
+                }
+            ],
+            "description": "(Optional) The business condition of the objects associated with the EPCs, presumed to hold true until contradicted by a subsequent event."
+        },
+        "readPoint": {
+            "$ref": "https://schema.twindev.org/gs1-epcis/EpcisLocation",
+            "description": "(Optional) The read point at which the event took place."
+        },
+        "bizLocation": {
+            "$ref": "https://schema.twindev.org/gs1-epcis/EpcisLocation",
+            "description": "(Optional) The business location where the objects associated with the EPCs may be found, until contradicted by a subsequent event."
+        },
+        "sourceList": {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.twindev.org/gs1-epcis/EpcisSource"
+            },
+            "description": "(Optional) Unordered list of Source elements that provide context about the originating endpoint of a business transfer of which this event is a part."
+        },
+        "destinationList": {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.twindev.org/gs1-epcis/EpcisDestination"
+            },
+            "description": "(Optional) Unordered list of Destination elements that provide context about the terminating endpoint of a business transfer of which this event is a part."
+        },
+        "sensorElementList": {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.twindev.org/gs1-epcis/EpcisSensorElement"
+            },
+            "description": "(Optional) Connects event to one or more SensorElements."
+        }
+    },
+    "required": [
+        "@context",
+        "action",
+        "bizTransactionList",
+        "eventTime",
+        "eventTimeZoneOffset",
+        "type"
+    ],
+    "additionalProperties": {
+        "anyOf": [
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdIndexMap"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdIdMap"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdTypeMap"
+            },
+            {
+                "type": "array"
+            }
+        ]
+    }
+}

package/dist/es/schemas/EpcisTransformationEvent.json

@@ -0,0 +1,290 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/gs1-epcis/EpcisTransformationEvent",
+    "description": "EPCIS 2.0 TransformationEvent describing how inputs are transformed into outputs during a business process.",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "description": "Allowed shapes for an EPCIS 2.0 JSON-LD `@context`, anchored on the GS1 context root and optionally augmented with custom entries.",
+            "anyOf": [
+                {
+                    "type": "string",
+                    "const": "https://ref.gs1.org/epcis/"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "const": "https://ref.gs1.org/epcis/"
+                    },
+                    "minItems": 1,
+                    "maxItems": 1
+                },
+                {
+                    "type": "array",
+                    "minItems": 2,
+                    "prefixItems": [
+                        {
+                            "type": "string",
+                            "const": "https://ref.gs1.org/epcis/"
+                        },
+                        {
+                            "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                        }
+                    ],
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    }
+                },
+                {
+                    "type": "array",
+                    "minItems": 2,
+                    "prefixItems": [
+                        {
+                            "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                        },
+                        {
+                            "type": "string",
+                            "const": "https://ref.gs1.org/epcis/"
+                        }
+                    ],
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    }
+                }
+            ]
+        },
+        "@id": {
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            ]
+        },
+        "@included": {
+            "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
+        },
+        "@graph": {
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                    }
+                }
+            ]
+        },
+        "@nest": {
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
+                    }
+                }
+            ]
+        },
+        "@type": {
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            ]
+        },
+        "@reverse": {
+            "type": "object",
+            "additionalProperties": {
+                "type": "string"
+            }
+        },
+        "@index": {
+            "type": "string"
+        },
+        "type": {
+            "type": "string",
+            "const": "TransformationEvent",
+            "description": "Fixed to TransformationEvent."
+        },
+        "eventID": {
+            "type": "string",
+            "description": "URI identifier of a specific EPCIS event (alias of id in JSON or XML)."
+        },
+        "certificationInfo": {
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            ],
+            "description": "(Optional) CertificationDetails relevant for Objects, Places and/or Organizations mentioned in this Event."
+        },
+        "errorDeclaration": {
+            "$ref": "https://schema.twindev.org/gs1-epcis/EpcisErrorDeclaration",
+            "description": "Error declaration."
+        },
+        "eventTime": {
+            "type": "string",
+            "description": "The date and time at which the EPCIS Capturing Applications asserts the event occurred."
+        },
+        "eventTimeZoneOffset": {
+            "type": "string",
+            "description": "The time zone offset in effect at the time and place the event occurred, expressed as an offset from UTC."
+        },
+        "recordTime": {
+            "type": "string",
+            "description": "(Optional) The date and time at which this event was recorded by an EPCIS Repository; ignored at capture and present on query results."
+        },
+        "inputEPCList": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            },
+            "description": "(Optional) Unordered list of one or more EPCs identifying (at the instance level) objects that were inputs to the transformation."
+        },
+        "inputQuantityList": {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.twindev.org/gs1-epcis/EpcisQuantity"
+            },
+            "description": "(Optional) Unordered list of one or more QuantityElements identifying class-level inputs; may be omitted subject to the EPCIS quantity-list constraints."
+        },
+        "outputEPCList": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            },
+            "description": "(Optional) Unordered list of one or more EPCs naming (at the instance level) objects that were outputs from the transformation."
+        },
+        "outputQuantityList": {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.twindev.org/gs1-epcis/EpcisQuantity"
+            },
+            "description": "(Optional) Unordered list of one or more QuantityElements identifying class-level outputs; may be omitted subject to the EPCIS quantity-list constraints."
+        },
+        "transformationID": {
+            "type": "string",
+            "description": "A unique identifier linking TransformationEvents; shared values connect inputs and outputs across those events."
+        },
+        "bizStep": {
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/gs1-epcis/EpcisBizStepTypes"
+                },
+                {
+                    "type": "string"
+                }
+            ],
+            "description": "(Optional) The business step of which this event was a part."
+        },
+        "disposition": {
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/gs1-epcis/EpcisDispositionTypes"
+                },
+                {
+                    "type": "string"
+                }
+            ],
+            "description": "(Optional) The business condition of the objects associated with the EPCs, presumed to hold true until contradicted by a subsequent event."
+        },
+        "persistentDisposition": {
+            "$ref": "https://schema.twindev.org/gs1-epcis/EpcisPersistentDisposition",
+            "description": "Persistent disposition."
+        },
+        "readPoint": {
+            "$ref": "https://schema.twindev.org/gs1-epcis/EpcisLocation",
+            "description": "(Optional) The read point at which the event took place."
+        },
+        "bizLocation": {
+            "$ref": "https://schema.twindev.org/gs1-epcis/EpcisLocation",
+            "description": "(Optional) The business location where the objects associated with the EPCs may be found, until contradicted by a subsequent event."
+        },
+        "bizTransactionList": {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.twindev.org/gs1-epcis/EpcisBizTransaction"
+            },
+            "description": "An unordered list of business transactions that define the context of this event."
+        },
+        "sourceList": {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.twindev.org/gs1-epcis/EpcisSource"
+            },
+            "description": "(Optional) Unordered list of Source elements that provide context about the originating endpoint of a business transfer of which this event is a part."
+        },
+        "destinationList": {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.twindev.org/gs1-epcis/EpcisDestination"
+            },
+            "description": "(Optional) Unordered list of Destination elements that provide context about the terminating endpoint of a business transfer of which this event is a part."
+        },
+        "sensorElementList": {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.twindev.org/gs1-epcis/EpcisSensorElement"
+            },
+            "description": "(Optional) Connects event to one or more SensorElements."
+        },
+        "ilmd": {
+            "$ref": "https://schema.twindev.org/gs1-epcis/EpcisIlmd",
+            "description": "(Optional) Instance/Lot master data that describes the objects created during this event."
+        }
+    },
+    "required": [
+        "@context",
+        "eventTime",
+        "eventTimeZoneOffset",
+        "type"
+    ],
+    "additionalProperties": {
+        "anyOf": [
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdIndexMap"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdIdMap"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdTypeMap"
+            },
+            {
+                "type": "array"
+            }
+        ]
+    }
+}

package/dist/types/dataTypes/epcisDataTypes.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Handle all the data types for EPCIS.
+ */
+export declare class EpcisDataTypes {
+    /**
+     * Register the JSON-LD Redirects.
+     */
+    static registerRedirects(): void;
+    /**
+     * Register all the data types.
+     */
+    static registerTypes(): void;
+}

package/dist/types/index.d.ts

@@ -1,35 +1,54 @@
+export * from "./dataTypes/epcisDataTypes.js";
 export * from "./dataTypes/gs1DataTypes.js";
 export * from "./entities/gs1Location.js";
 export * from "./identifiers/gs1Identifiers.js";
 export * from "./models/epc/IEPCClassUri.js";
 export * from "./models/epcis20/epcisActionTypes.js";
 export * from "./models/epcis20/epcisBizStepTypes.js";
+export * from "./models/epcis20/epcisBizTransactionTypes.js";
+export * from "./models/epcis20/epcisComponentTypes.js";
+export * from "./models/epcis20/epcisContexts.js";
+export * from "./models/epcis20/epcisContextType.js";
 export * from "./models/epcis20/epcisDispositionTypes.js";
-export * from "./models/epcis20/epcisErrorTypes.js";
-export * from "./models/epcis20/epcisEventUnionType.js";
+export * from "./models/epcis20/epcisErrorReasonTypes.js";
+export * from "./models/epcis20/epcisEvents.js";
 export * from "./models/epcis20/epcisEventTypes.js";
+export * from "./models/epcis20/epcisMeasurementTypes.js";
+export * from "./models/epcis20/epcisSensorAlertTypes.js";
+export * from "./models/epcis20/epcisSourceDestTypes.js";
 export * from "./models/epcis20/IEpcisAggregationEvent.js";
 export * from "./models/epcis20/IEpcisAssociationEvent.js";
+export * from "./models/epcis20/IEpcisAttribute.js";
 export * from "./models/epcis20/IEpcisBizTransaction.js";
 export * from "./models/epcis20/IEpcisDestination.js";
 export * from "./models/epcis20/IEpcisDocument.js";
+export * from "./models/epcis20/IEpcisErrorDeclaration.js";
 export * from "./models/epcis20/IEpcisEvent.js";
-export * from "./models/epcis20/IEpcisEventDetails.js";
-export * from "./models/epcis20/IEpcisQuery.js";
-export * from "./models/epcis20/IEpcisQueryDocument.js";
+export * from "./models/epcis20/IEpcisHeader.js";
+export * from "./models/epcis20/IEpcisIlmd.js";
+export * from "./models/epcis20/IEpcisLocation.js";
 export * from "./models/epcis20/IEpcisObjectEvent.js";
+export * from "./models/epcis20/IEpcisPersistentDisposition.js";
 export * from "./models/epcis20/IEpcisQuantity.js";
+export * from "./models/epcis20/IEpcisQuery.js";
+export * from "./models/epcis20/IEpcisQueryDocument.js";
+export * from "./models/epcis20/IEpcisQueryDocumentBody.js";
+export * from "./models/epcis20/IEpcisQueryResults.js";
+export * from "./models/epcis20/IEpcisQueryResultsBody.js";
 export * from "./models/epcis20/IEpcisSensorElement.js";
 export * from "./models/epcis20/IEpcisSensorMetadata.js";
 export * from "./models/epcis20/IEpcisSensorReport.js";
-export * from "./models/epcis20/IEpcisSimpleLocation.js";
 export * from "./models/epcis20/IEpcisSource.js";
+export * from "./models/epcis20/IEpcisTransactionEvent.js";
+export * from "./models/epcis20/IEpcisTransformationEvent.js";
+export * from "./models/epcis20/IEpcisVocabulary.js";
+export * from "./models/epcis20/IEpcisVocabularyElement.js";
 export * from "./models/gs1/gs1Contexts.js";
 export * from "./models/gs1/gs1IdentifierTypes.js";
 export * from "./models/gs1/gs1IdTypes.js";
-export * from "./models/gs1/gs1Types.js";
 export * from "./models/gs1/gs1SubSiteAttributes.js";
 export * from "./models/gs1/gs1SubSiteTypes.js";
+export * from "./models/gs1/gs1Types.js";
 export * from "./utils/gs1IdentifiersValidation.js";
 export * from "./utils/gs1Is.js";
 export * from "./utils/gs1Validation.js";