@twin.org/standards-gs1 0.0.3-next.9 → 0.9.0

package/dist/es/schemas/EpcisAggregationEvent.json

@@ -0,0 +1,102 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/gs1-epcis/EpcisAggregationEvent",
+    "title": "EpcisAggregationEvent",
+    "description": "EPCIS 2.0 AggregationEvent describing how child objects are associated with or\ndisassociated from a parent object.",
+    "type": "object",
+    "properties": {
+        "type": {
+            "const": "AggregationEvent",
+            "description": "The type."
+        },
+        "parentID": {
+            "type": "string",
+            "description": "(Optional when action is OBSERVE, required otherwise) Identifier of the parent\nof the aggregation or association; use the pure identity URI when the parent is\nan EPC."
+        },
+        "childEPCs": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            },
+            "description": "(Optional) Unordered list of contained objects identified at the instance\nlevel; AggregationEvents normally include childEPCs or childQuantityList unless\naction is DELETE."
+        },
+        "childQuantityList": {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.twindev.org/gs1-epcis/EpcisQuantity"
+            },
+            "description": "Unordered list of one or more QuantityElements identifying contained objects\nat the class level; may be empty only with action DELETE when disaggregating\nall children."
+        },
+        "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,\npresumed 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\nmay be found, until contradicted by a subsequent event."
+        },
+        "bizTransactionList": {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.twindev.org/gs1-epcis/EpcisBizTransaction"
+            },
+            "description": "(Optional) An unordered list of business transactions that define the context\nof 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\noriginating 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\nterminating 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": [
+        "type",
+        "action"
+    ],
+    "allOf": [
+        {
+            "$ref": "https://schema.twindev.org/gs1-epcis/EpcisEvent"
+        }
+    ]
+}

package/dist/es/schemas/EpcisAssociationEvent.json

@@ -0,0 +1,103 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/gs1-epcis/EpcisAssociationEvent",
+    "title": "EpcisAssociationEvent",
+    "description": "EPCIS 2.0 AssociationEvent describing membership relationships between parent\nand child objects without implying physical containment.",
+    "type": "object",
+    "properties": {
+        "type": {
+            "const": "AssociationEvent",
+            "description": "Type."
+        },
+        "parentID": {
+            "type": "string",
+            "description": "Identifier of the parent of the aggregation or association; use the pure\nidentity URI when the parent is an EPC."
+        },
+        "childEPCs": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            },
+            "description": "(Optional) Unordered list of contained objects identified at the instance\nlevel; AssociationEvents normally include childEPCs or childQuantityList\nunless action is DELETE."
+        },
+        "childQuantityList": {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.twindev.org/gs1-epcis/EpcisQuantity"
+            },
+            "description": "Unordered list of one or more QuantityElements identifying contained objects\nat the class level; may be empty only with action DELETE when disassociating\nall children."
+        },
+        "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,\npresumed 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\nmay be found, until contradicted by a subsequent event."
+        },
+        "bizTransactionList": {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.twindev.org/gs1-epcis/EpcisBizTransaction"
+            },
+            "description": "(Optional) An unordered list of business transactions that define the context\nof 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\noriginating 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\nthe 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": [
+        "type",
+        "parentID",
+        "action"
+    ],
+    "allOf": [
+        {
+            "$ref": "https://schema.twindev.org/gs1-epcis/EpcisEvent"
+        }
+    ]
+}

package/dist/es/schemas/EpcisContextType.json

@@ -0,0 +1,30 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/gs1-epcis/EpcisContextType",
+    "title": "EpcisContextType",
+    "description": "Allowed shapes for an EPCIS 2.0 JSON-LD `@context`, anchored on the GS1\ncontext root and optionally augmented with custom entries.",
+    "anyOf": [
+        {
+            "const": "https://ref.gs1.org/epcis"
+        },
+        {
+            "type": "array",
+            "items": {
+                "anyOf": [
+                    {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    },
+                    {
+                        "const": "https://ref.gs1.org/epcis"
+                    }
+                ]
+            },
+            "contains": {
+                "const": "https://ref.gs1.org/epcis"
+            },
+            "minContains": 1,
+            "maxContains": 1,
+            "minItems": 1
+        }
+    ]
+}

package/dist/es/schemas/EpcisDocument.json

@@ -0,0 +1,68 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/gs1-epcis/EpcisDocument",
+    "title": "EpcisDocument",
+    "description": "EPCIS 2.0 capture document containing header metadata and an event list.",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "$ref": "https://schema.twindev.org/gs1-epcis/EpcisContextType",
+            "description": "The"
+        },
+        "id": {
+            "type": "string",
+            "description": "The JSON-LD document id."
+        },
+        "type": {
+            "const": "EPCISDocument",
+            "description": "JSON-LD Type."
+        },
+        "schemaVersion": {
+            "type": "string",
+            "description": "Schema version."
+        },
+        "creationDate": {
+            "type": "string",
+            "description": "Creation Date."
+        },
+        "instanceIdentifier": {
+            "type": "string",
+            "description": "(Optional) The instance identifier of an EPCISDocument."
+        },
+        "sender": {
+            "type": "string",
+            "description": "(Optional) The sender of an EPCISDocument."
+        },
+        "receiver": {
+            "type": "string",
+            "description": "(Optional) The intended receiver of an EPCISDocument."
+        },
+        "epcisHeader": {
+            "$ref": "https://schema.twindev.org/gs1-epcis/EpcisHeader",
+            "description": "EPCIS Header."
+        },
+        "epcisBody": {
+            "type": "object",
+            "properties": {
+                "eventList": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://schema.twindev.org/gs1-epcis/EpcisEvents"
+                    },
+                    "description": "The list of events."
+                }
+            },
+            "required": [
+                "eventList"
+            ],
+            "description": "The EPCIS Body."
+        }
+    },
+    "required": [
+        "@context",
+        "type",
+        "schemaVersion",
+        "creationDate",
+        "epcisBody"
+    ]
+}

package/dist/es/schemas/EpcisObjectEvent.json

@@ -0,0 +1,106 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/gs1-epcis/EpcisObjectEvent",
+    "title": "EpcisObjectEvent",
+    "description": "EPCIS 2.0 ObjectEvent describing one or more objects (instance- or class-level)\nobserved at a point in the business process.",
+    "type": "object",
+    "properties": {
+        "type": {
+            "const": "ObjectEvent",
+            "description": "Fixed to ObjectEvent."
+        },
+        "epcList": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            },
+            "description": "(Optional) Unordered list of one or more EPCs naming specific objects to which\nthe event pertained."
+        },
+        "quantityList": {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.twindev.org/gs1-epcis/EpcisQuantity"
+            },
+            "description": "Unordered list of one or more QuantityElements identifying contained objects at\nthe class level."
+        },
+        "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,\npresumed 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\nbe found, until contradicted by a subsequent event."
+        },
+        "bizTransactionList": {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.twindev.org/gs1-epcis/EpcisBizTransaction"
+            },
+            "description": "(Optional) Unordered list of business transactions that define the context of\nthis 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\noriginating 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\nterminating 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\nthis event."
+        }
+    },
+    "required": [
+        "type",
+        "action"
+    ],
+    "allOf": [
+        {
+            "$ref": "https://schema.twindev.org/gs1-epcis/EpcisEvent"
+        }
+    ]
+}

package/dist/es/schemas/EpcisQueryDocument.json

@@ -0,0 +1,38 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/gs1-epcis/EpcisQueryDocument",
+    "title": "EpcisQueryDocument",
+    "description": "EPCIS 2.0 QueryDocument used to submit queries to an EPCIS repository.",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "$ref": "https://schema.twindev.org/gs1-epcis/EpcisContextType",
+            "description": "The"
+        },
+        "id": {
+            "type": "string",
+            "description": "The JSON-LD document id."
+        },
+        "type": {
+            "const": "EPCISQueryDocument",
+            "description": "JSON-LD Type."
+        },
+        "schemaVersion": {
+            "type": "string",
+            "description": "Schema version."
+        },
+        "creationDate": {
+            "type": "string",
+            "description": "Creation Date."
+        },
+        "epcisBody": {
+            "$ref": "https://schema.twindev.org/gs1-epcis/EpcisQueryDocumentBody",
+            "description": "The EPCIS Body."
+        }
+    },
+    "required": [
+        "@context",
+        "type",
+        "epcisBody"
+    ]
+}

package/dist/es/schemas/EpcisTransactionEvent.json

@@ -0,0 +1,103 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/gs1-epcis/EpcisTransactionEvent",
+    "title": "EpcisTransactionEvent",
+    "description": "EPCIS 2.0 TransactionEvent relating objects or quantities to one or more\nbusiness transactions, optionally with a parent identifier.",
+    "type": "object",
+    "properties": {
+        "type": {
+            "const": "TransactionEvent",
+            "description": "Fixed to TransactionEvent."
+        },
+        "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\nof the aggregation or association; use the pure identity URI when the parent is\nan EPC."
+        },
+        "epcList": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            },
+            "description": "(Optional) An unordered list of one or more EPCs naming specific objects to\nwhich 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\nlevel) 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,\npresumed 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\nmay 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\noriginating 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\nterminating 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": [
+        "type",
+        "bizTransactionList",
+        "action"
+    ],
+    "allOf": [
+        {
+            "$ref": "https://schema.twindev.org/gs1-epcis/EpcisEvent"
+        }
+    ]
+}