@twin.org/standards-gs1 0.0.3-next.1 → 0.0.3-next.11

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/es/utils/gs1Validation.js

@@ -3,8 +3,8 @@
 import { Is, Validation } from "@twin.org/core";
 import { IdentifierHandlerFactory } from "@twin.org/data-core";
 import { Gs1IdentifierTypes } from "../models/gs1/gs1IdentifierTypes.js";
-import { SubSiteAttributes } from "../models/gs1/subSiteAttributes.js";
-import { SubSiteTypes } from "../models/gs1/subSiteTypes.js";
+import { Gs1SubSiteAttributes } from "../models/gs1/gs1SubSiteAttributes.js";
+import { Gs1SubSiteTypes } from "../models/gs1/gs1SubSiteTypes.js";
 /**
  * Validation for GS1 types.
  */
@@ -39,10 +39,10 @@ export class Gs1Validation {
                 });
             }
             if (Is.notEmpty(value.sst)) {
-                Validation.arrayOneOf("value.sst", value.sst, Object.values(SubSiteTypes), failures);
+                Validation.arrayOneOf("value.sst", value.sst, Object.values(Gs1SubSiteTypes), failures);
             }
             if (Is.notEmpty(value.ssa)) {
-                Validation.arrayOneOf("value.ssa", value.ssa, Object.values(SubSiteAttributes), failures);
+                Validation.arrayOneOf("value.ssa", value.ssa, Object.values(Gs1SubSiteAttributes), failures);
             }
         }
         return is;

package/dist/es/utils/gs1Validation.js.map

@@ -1 +1 @@
-{"version":3,"file":"gs1Validation.js","sourceRoot":"","sources":["../../../src/utils/gs1Validation.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,EAAE,EAA2B,UAAU,EAAE,MAAM,gBAAgB,CAAC;AACzE,OAAO,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AAG/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AACzE,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AACvE,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAE7D;;GAEG;AACH,MAAM,OAAO,aAAa;IACzB;;;;;;;OAOG;IACI,MAAM,CAAC,kBAAkB,CAC/B,YAAoB,EACpB,KAAkB,EAClB,QAA8B,EAC9B,SAAmB;QAEnB,MAAM,EAAE,GAAG,EAAE,CAAC,MAAM,CAAc,KAAK,CAAC,CAAC;QAEzC,IAAI,EAAE,EAAE,CAAC;YACR,IAAI,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC;gBAC9B,MAAM,iBAAiB,GAAG,wBAAwB,CAAC,GAAG,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;gBACpF,IAAI,iBAAiB,EAAE,CAAC;oBACvB,iBAAiB,CAAC,QAAQ,uBAAiC,KAAK,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;gBAChF,CAAC;YACF,CAAC;YAED,IAAI,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC/D,QAAQ,CAAC,IAAI,CAAC;oBACb,QAAQ,4BAAsC;oBAC9C,MAAM,EAAE,mCAAmC;iBAC3C,CAAC,CAAC;YACJ,CAAC;YAED,IAAI,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;gBACjE,QAAQ,CAAC,IAAI,CAAC;oBACb,QAAQ,6BAAuC;oBAC/C,MAAM,EAAE,oCAAoC;iBAC5C,CAAC,CAAC;YACJ,CAAC;YAED,IAAI,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC5B,UAAU,CAAC,UAAU,cAAoB,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,QAAQ,CAAC,CAAC;YAC5F,CAAC;YAED,IAAI,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC5B,UAAU,CAAC,UAAU,cAEpB,KAAK,CAAC,GAAG,EACT,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAChC,QAAQ,CACR,CAAC;YACH,CAAC;QACF,CAAC;QAED,OAAO,EAAE,CAAC;IACX,CAAC;CACD","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Is, type IValidationFailure, Validation } from \"@twin.org/core\";\nimport { IdentifierHandlerFactory } from \"@twin.org/data-core\";\nimport { nameof } from \"@twin.org/nameof\";\nimport type { Gs1Location } from \"../entities/gs1Location.js\";\nimport { Gs1IdentifierTypes } from \"../models/gs1/gs1IdentifierTypes.js\";\nimport { SubSiteAttributes } from \"../models/gs1/subSiteAttributes.js\";\nimport { SubSiteTypes } from \"../models/gs1/subSiteTypes.js\";\n\n/**\n * Validation for GS1 types.\n */\nexport class Gs1Validation {\n\t/**\n\t * Validate if the property is a valid location.\n\t * @param propertyName The name of the property being validated.\n\t * @param value The value to test.\n\t * @param failures The list of failures to add to.\n\t * @param container The object which contains this one.\n\t * @returns True if the value is a location.\n\t */\n\tpublic static locationMasterData(\n\t\tpropertyName: string,\n\t\tvalue: Gs1Location,\n\t\tfailures: IValidationFailure[],\n\t\tcontainer?: unknown\n\t): value is Gs1Location {\n\t\tconst is = Is.object<Gs1Location>(value);\n\n\t\tif (is) {\n\t\t\tif (Is.stringValue(value.id)) {\n\t\t\t\tconst identifierHandler = IdentifierHandlerFactory.get(Gs1IdentifierTypes.EpcIdGln);\n\t\t\t\tif (identifierHandler) {\n\t\t\t\t\tidentifierHandler.validate(nameof(value.id, propertyName), value.id, failures);\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tif (Is.notEmpty(value.latitude) && !Is.number(value.latitude)) {\n\t\t\t\tfailures.push({\n\t\t\t\t\tproperty: nameof(value.latitude, propertyName),\n\t\t\t\t\treason: \"validation.geoCoordinatesLatitude\"\n\t\t\t\t});\n\t\t\t}\n\n\t\t\tif (Is.notEmpty(value.longitude) && !Is.number(value.longitude)) {\n\t\t\t\tfailures.push({\n\t\t\t\t\tproperty: nameof(value.longitude, propertyName),\n\t\t\t\t\treason: \"validation.geoCoordinatesLongitude\"\n\t\t\t\t});\n\t\t\t}\n\n\t\t\tif (Is.notEmpty(value.sst)) {\n\t\t\t\tValidation.arrayOneOf(nameof(value.sst), value.sst, Object.values(SubSiteTypes), failures);\n\t\t\t}\n\n\t\t\tif (Is.notEmpty(value.ssa)) {\n\t\t\t\tValidation.arrayOneOf(\n\t\t\t\t\tnameof(value.ssa),\n\t\t\t\t\tvalue.ssa,\n\t\t\t\t\tObject.values(SubSiteAttributes),\n\t\t\t\t\tfailures\n\t\t\t\t);\n\t\t\t}\n\t\t}\n\n\t\treturn is;\n\t}\n}\n"]}
+{"version":3,"file":"gs1Validation.js","sourceRoot":"","sources":["../../../src/utils/gs1Validation.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,EAAE,EAA2B,UAAU,EAAE,MAAM,gBAAgB,CAAC;AACzE,OAAO,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AAG/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AACzE,OAAO,EAAE,oBAAoB,EAAE,MAAM,uCAAuC,CAAC;AAC7E,OAAO,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AAEnE;;GAEG;AACH,MAAM,OAAO,aAAa;IACzB;;;;;;;OAOG;IACI,MAAM,CAAC,kBAAkB,CAC/B,YAAoB,EACpB,KAAkB,EAClB,QAA8B,EAC9B,SAAmB;QAEnB,MAAM,EAAE,GAAG,EAAE,CAAC,MAAM,CAAc,KAAK,CAAC,CAAC;QAEzC,IAAI,EAAE,EAAE,CAAC;YACR,IAAI,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC;gBAC9B,MAAM,iBAAiB,GAAG,wBAAwB,CAAC,GAAG,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;gBACpF,IAAI,iBAAiB,EAAE,CAAC;oBACvB,iBAAiB,CAAC,QAAQ,uBAAiC,KAAK,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;gBAChF,CAAC;YACF,CAAC;YAED,IAAI,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC/D,QAAQ,CAAC,IAAI,CAAC;oBACb,QAAQ,4BAAsC;oBAC9C,MAAM,EAAE,mCAAmC;iBAC3C,CAAC,CAAC;YACJ,CAAC;YAED,IAAI,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;gBACjE,QAAQ,CAAC,IAAI,CAAC;oBACb,QAAQ,6BAAuC;oBAC/C,MAAM,EAAE,oCAAoC;iBAC5C,CAAC,CAAC;YACJ,CAAC;YAED,IAAI,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC5B,UAAU,CAAC,UAAU,cAEpB,KAAK,CAAC,GAAG,EACT,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,EAC9B,QAAQ,CACR,CAAC;YACH,CAAC;YAED,IAAI,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC5B,UAAU,CAAC,UAAU,cAEpB,KAAK,CAAC,GAAG,EACT,MAAM,CAAC,MAAM,CAAC,oBAAoB,CAAC,EACnC,QAAQ,CACR,CAAC;YACH,CAAC;QACF,CAAC;QAED,OAAO,EAAE,CAAC;IACX,CAAC;CACD","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Is, type IValidationFailure, Validation } from \"@twin.org/core\";\nimport { IdentifierHandlerFactory } from \"@twin.org/data-core\";\nimport { nameof } from \"@twin.org/nameof\";\nimport type { Gs1Location } from \"../entities/gs1Location.js\";\nimport { Gs1IdentifierTypes } from \"../models/gs1/gs1IdentifierTypes.js\";\nimport { Gs1SubSiteAttributes } from \"../models/gs1/gs1SubSiteAttributes.js\";\nimport { Gs1SubSiteTypes } from \"../models/gs1/gs1SubSiteTypes.js\";\n\n/**\n * Validation for GS1 types.\n */\nexport class Gs1Validation {\n\t/**\n\t * Validate if the property is a valid location.\n\t * @param propertyName The name of the property being validated.\n\t * @param value The value to test.\n\t * @param failures The list of failures to add to.\n\t * @param container The object which contains this one.\n\t * @returns True if the value is a location.\n\t */\n\tpublic static locationMasterData(\n\t\tpropertyName: string,\n\t\tvalue: Gs1Location,\n\t\tfailures: IValidationFailure[],\n\t\tcontainer?: unknown\n\t): value is Gs1Location {\n\t\tconst is = Is.object<Gs1Location>(value);\n\n\t\tif (is) {\n\t\t\tif (Is.stringValue(value.id)) {\n\t\t\t\tconst identifierHandler = IdentifierHandlerFactory.get(Gs1IdentifierTypes.EpcIdGln);\n\t\t\t\tif (identifierHandler) {\n\t\t\t\t\tidentifierHandler.validate(nameof(value.id, propertyName), value.id, failures);\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tif (Is.notEmpty(value.latitude) && !Is.number(value.latitude)) {\n\t\t\t\tfailures.push({\n\t\t\t\t\tproperty: nameof(value.latitude, propertyName),\n\t\t\t\t\treason: \"validation.geoCoordinatesLatitude\"\n\t\t\t\t});\n\t\t\t}\n\n\t\t\tif (Is.notEmpty(value.longitude) && !Is.number(value.longitude)) {\n\t\t\t\tfailures.push({\n\t\t\t\t\tproperty: nameof(value.longitude, propertyName),\n\t\t\t\t\treason: \"validation.geoCoordinatesLongitude\"\n\t\t\t\t});\n\t\t\t}\n\n\t\t\tif (Is.notEmpty(value.sst)) {\n\t\t\t\tValidation.arrayOneOf(\n\t\t\t\t\tnameof(value.sst),\n\t\t\t\t\tvalue.sst,\n\t\t\t\t\tObject.values(Gs1SubSiteTypes),\n\t\t\t\t\tfailures\n\t\t\t\t);\n\t\t\t}\n\n\t\t\tif (Is.notEmpty(value.ssa)) {\n\t\t\t\tValidation.arrayOneOf(\n\t\t\t\t\tnameof(value.ssa),\n\t\t\t\t\tvalue.ssa,\n\t\t\t\t\tObject.values(Gs1SubSiteAttributes),\n\t\t\t\t\tfailures\n\t\t\t\t);\n\t\t\t}\n\t\t}\n\n\t\treturn is;\n\t}\n}\n"]}

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/entities/gs1Location.d.ts

@@ -1,5 +1,5 @@
-import type { SubSiteAttributes } from "../models/gs1/subSiteAttributes.js";
-import type { SubSiteTypes } from "../models/gs1/subSiteTypes.js";
+import type { Gs1SubSiteAttributes } from "../models/gs1/gs1SubSiteAttributes.js";
+import type { Gs1SubSiteTypes } from "../models/gs1/gs1SubSiteTypes.js";
 /**
  * Interface describing a GS1 Location master data.
  * Spec https://www.gs1.org/sites/default/files/docs/epc/CBV-Standard-1-2-1-r-2017-05-05.pdf .
@@ -17,11 +17,11 @@ export declare class Gs1Location {
     /**
      * Sub site type describes the primary business function of the sub site location.
      */
-    sst?: SubSiteTypes;
+    sst?: Gs1SubSiteTypes;
     /**
      * Sub site attribute further qualifies the business function of the sub site location.
      */
-    ssa?: SubSiteAttributes;
+    ssa?: Gs1SubSiteAttributes;
     /**
      * Sub site detail provides additional proprietary information.
      */