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

package/dist/es/models/epcis20/dispositionTypes.js

@@ -0,0 +1,45 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/* cSpell:disable */
+/**
+ * EPCIS 2.0 disposition types.
+ *
+ * See EPCIS CVB for more details.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const DispositionTypes = {
+    Active: "active",
+    ContainerClosed: "container_closed",
+    Damaged: "damaged",
+    Destroyed: "destroyed",
+    Dispensed: "dispensed",
+    Disposed: "disposed",
+    Encoded: "encoded",
+    Expired: "expired",
+    InProgress: "in_progress",
+    InTransit: "in_transit",
+    Inactive: "inactive",
+    NoPedigreeMatch: "no_pedigree_match",
+    NonSellableOther: "non_sellable_other",
+    PartiallyDispensed: "partially_dispensed",
+    Recalled: "recalled",
+    Reserved: "reserved",
+    RetailSold: "retail_sold",
+    Returned: "returned",
+    SellableAccessible: "sellable_accessible",
+    SellableNotAccessible: "sellable_not_accessible",
+    Stolen: "stolen",
+    Unknown: "unknown",
+    Available: "available",
+    CompletenessVerified: "completeness_verified",
+    CompletenessInferred: "completeness_inferred",
+    Conformant: "conformant",
+    ContainerOpen: "container_open",
+    MismatchInstance: "mismatch_instance",
+    MismatchClass: "mismatch_class",
+    MismatchQuantity: "mismatch_quantity",
+    NeedsReplacement: "needs_replacement",
+    NonConformant: "non_conformant",
+    Unavailable: "unavailable"
+};
+//# sourceMappingURL=dispositionTypes.js.map

package/dist/es/models/epcis20/dispositionTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dispositionTypes.js","sourceRoot":"","sources":["../../../../src/models/epcis20/dispositionTypes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,oBAAoB;AAEpB;;;;GAIG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC/B,MAAM,EAAE,QAAQ;IAEhB,eAAe,EAAE,kBAAkB;IAEnC,OAAO,EAAE,SAAS;IAElB,SAAS,EAAE,WAAW;IAEtB,SAAS,EAAE,WAAW;IAEtB,QAAQ,EAAE,UAAU;IAEpB,OAAO,EAAE,SAAS;IAElB,OAAO,EAAE,SAAS;IAElB,UAAU,EAAE,aAAa;IAEzB,SAAS,EAAE,YAAY;IAEvB,QAAQ,EAAE,UAAU;IAEpB,eAAe,EAAE,mBAAmB;IAEpC,gBAAgB,EAAE,oBAAoB;IAEtC,kBAAkB,EAAE,qBAAqB;IAEzC,QAAQ,EAAE,UAAU;IAEpB,QAAQ,EAAE,UAAU;IAEpB,UAAU,EAAE,aAAa;IAEzB,QAAQ,EAAE,UAAU;IAEpB,kBAAkB,EAAE,qBAAqB;IAEzC,qBAAqB,EAAE,yBAAyB;IAEhD,MAAM,EAAE,QAAQ;IAEhB,OAAO,EAAE,SAAS;IAElB,SAAS,EAAE,WAAW;IAEtB,oBAAoB,EAAE,uBAAuB;IAE7C,oBAAoB,EAAE,uBAAuB;IAE7C,UAAU,EAAE,YAAY;IAExB,aAAa,EAAE,gBAAgB;IAE/B,gBAAgB,EAAE,mBAAmB;IAErC,aAAa,EAAE,gBAAgB;IAE/B,gBAAgB,EAAE,mBAAmB;IAErC,gBAAgB,EAAE,mBAAmB;IAErC,aAAa,EAAE,gBAAgB;IAE/B,WAAW,EAAE,aAAa;CACjB,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n/* cSpell:disable */\n\n/**\n * EPCIS 2.0 disposition types.\n *\n * See EPCIS CVB for more details.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const DispositionTypes = {\n\tActive: \"active\",\n\n\tContainerClosed: \"container_closed\",\n\n\tDamaged: \"damaged\",\n\n\tDestroyed: \"destroyed\",\n\n\tDispensed: \"dispensed\",\n\n\tDisposed: \"disposed\",\n\n\tEncoded: \"encoded\",\n\n\tExpired: \"expired\",\n\n\tInProgress: \"in_progress\",\n\n\tInTransit: \"in_transit\",\n\n\tInactive: \"inactive\",\n\n\tNoPedigreeMatch: \"no_pedigree_match\",\n\n\tNonSellableOther: \"non_sellable_other\",\n\n\tPartiallyDispensed: \"partially_dispensed\",\n\n\tRecalled: \"recalled\",\n\n\tReserved: \"reserved\",\n\n\tRetailSold: \"retail_sold\",\n\n\tReturned: \"returned\",\n\n\tSellableAccessible: \"sellable_accessible\",\n\n\tSellableNotAccessible: \"sellable_not_accessible\",\n\n\tStolen: \"stolen\",\n\n\tUnknown: \"unknown\",\n\n\tAvailable: \"available\",\n\n\tCompletenessVerified: \"completeness_verified\",\n\n\tCompletenessInferred: \"completeness_inferred\",\n\n\tConformant: \"conformant\",\n\n\tContainerOpen: \"container_open\",\n\n\tMismatchInstance: \"mismatch_instance\",\n\n\tMismatchClass: \"mismatch_class\",\n\n\tMismatchQuantity: \"mismatch_quantity\",\n\n\tNeedsReplacement: \"needs_replacement\",\n\n\tNonConformant: \"non_conformant\",\n\n\tUnavailable: \"unavailable\"\n} as const;\n\n/**\n * EPCIS 2.0 disposition types.\n */\nexport type DispositionTypes = (typeof DispositionTypes)[keyof typeof DispositionTypes];\n"]}

package/dist/es/models/epcis20/epcisErrorTypes.js

@@ -0,0 +1,11 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * EPCIS Error types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const EpcisErrorTypes = {
+    ValidationFailed: "epcisException:ValidationException",
+    NoSuchResource: "epcisException:NoSuchResourceException"
+};
+//# sourceMappingURL=epcisErrorTypes.js.map

package/dist/es/models/epcis20/epcisErrorTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"epcisErrorTypes.js","sourceRoot":"","sources":["../../../../src/models/epcis20/epcisErrorTypes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,eAAe,GAAG;IAC9B,gBAAgB,EAAE,oCAAoC;IAEtD,cAAc,EAAE,wCAAwC;CAC/C,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * EPCIS Error types.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const EpcisErrorTypes = {\n\tValidationFailed: \"epcisException:ValidationException\",\n\n\tNoSuchResource: \"epcisException:NoSuchResourceException\"\n} as const;\n\n/**\n * EPCIS Error types.\n */\nexport type EpcisErrorTypes = (typeof EpcisErrorTypes)[keyof typeof EpcisErrorTypes];\n"]}

package/dist/es/models/epcis20/epcisEventUnionType.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=epcisEventUnionType.js.map

package/dist/es/models/epcis20/epcisEventUnionType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"epcisEventUnionType.js","sourceRoot":"","sources":["../../../../src/models/epcis20/epcisEventUnionType.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IAggregationEvent } from \"./IAggregationEvent.js\";\nimport type { IAssociationEvent } from \"./IAssociationEvent.js\";\nimport type { IObjectEvent } from \"./IObjectEvent.js\";\n\n/**\n * The type that subsumes an EPCIS Event.\n */\nexport type EpcisEventUnionType = IObjectEvent | IAssociationEvent | IAggregationEvent;\n"]}

package/dist/es/models/epcis20/eventTypes.js

@@ -0,0 +1,29 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * EPCIS 2.0 event types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const EventTypes = {
+    /**
+     * ObjectEvent.
+     */
+    ObjectEvent: "ObjectEvent",
+    /**
+     * Aggregation Event.
+     */
+    AggregationEvent: "AggregationEvent",
+    /**
+     * Association Event.
+     */
+    AssociationEvent: "AssociationEvent",
+    /**
+     * Transformation Event.
+     */
+    TransformationEvent: "TransformationEvent",
+    /**
+     * Transaction Event.
+     */
+    TransactionEvent: "TransactionEvent"
+};
+//# sourceMappingURL=eventTypes.js.map

package/dist/es/models/epcis20/eventTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"eventTypes.js","sourceRoot":"","sources":["../../../../src/models/epcis20/eventTypes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,UAAU,GAAG;IACzB;;OAEG;IACH,WAAW,EAAE,aAAa;IAE1B;;OAEG;IACH,gBAAgB,EAAE,kBAAkB;IAEpC;;OAEG;IACH,gBAAgB,EAAE,kBAAkB;IAEpC;;OAEG;IACH,mBAAmB,EAAE,qBAAqB;IAE1C;;OAEG;IACH,gBAAgB,EAAE,kBAAkB;CAC3B,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * EPCIS 2.0 event types.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const EventTypes = {\n\t/**\n\t * ObjectEvent.\n\t */\n\tObjectEvent: \"ObjectEvent\",\n\n\t/**\n\t * Aggregation Event.\n\t */\n\tAggregationEvent: \"AggregationEvent\",\n\n\t/**\n\t * Association Event.\n\t */\n\tAssociationEvent: \"AssociationEvent\",\n\n\t/**\n\t * Transformation Event.\n\t */\n\tTransformationEvent: \"TransformationEvent\",\n\n\t/**\n\t * Transaction Event.\n\t */\n\tTransactionEvent: \"TransactionEvent\"\n} as const;\n\n/**\n * EPCIS 2.0 event types.\n */\nexport type EventTypes = (typeof EventTypes)[keyof typeof EventTypes];\n"]}

package/dist/es/models/gs1/gs1Contexts.js

@@ -0,0 +1,13 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The contexts of GS1.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const GS1Contexts = {
+    /**
+     * The context root for the GS1 types.
+     */
+    ContextRoot: "https://gs1.org/voc/"
+};
+//# sourceMappingURL=gs1Contexts.js.map

package/dist/es/models/gs1/gs1Contexts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gs1Contexts.js","sourceRoot":"","sources":["../../../../src/models/gs1/gs1Contexts.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,WAAW,GAAG;IAC1B;;OAEG;IACH,WAAW,EAAE,sBAAsB;CAC1B,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The contexts of GS1.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const GS1Contexts = {\n\t/**\n\t * The context root for the GS1 types.\n\t */\n\tContextRoot: \"https://gs1.org/voc/\"\n} as const;\n\n/**\n * The contexts of GS1.\n */\nexport type GS1Contexts = (typeof GS1Contexts)[keyof typeof GS1Contexts];\n"]}

package/dist/es/models/gs1/gs1IdTypes.js

@@ -0,0 +1,90 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/* cSpell:disable */
+/**
+ * GS1 EPC Identifiers.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const Gs1IdTypes = {
+    /**
+     * GTIN - Trade Item.
+     */
+    Gtin: "sgtin",
+    /**
+     * SSCC - Logistics Unit.
+     */
+    Sscc: "sscc",
+    /**
+     * GLN - Location.
+     */
+    Gln: "sgln",
+    /**
+     * GRAI - Returnable Asset.
+     */
+    Grai: "grai",
+    /**
+     * GIAI - Fixed Asset.
+     */
+    Giai: "giai",
+    /**
+     * GSRN - Recipient - Hospital Admission or Club Membership.
+     */
+    GsrnRecipient: "gsrn",
+    /**
+     * GSRN - Provider - Medical Caregiver or Loyalty Club.
+     */
+    GsrnProvider: "gsrnp",
+    /**
+     * GDTI - Document.
+     */
+    Gtdi: "gtdi",
+    /**
+     * Technical Industries for unique identification of parts and components.
+     */
+    None: "cpi",
+    /**
+     * GCN - Coupon.
+     */
+    Gcn: "sgcn",
+    /**
+     * Logical grouping of goods intended for transport as a whole assigned by a freight forwarder.
+     */
+    Ginc: "ginc",
+    /**
+     * Logical grouping of logistic units travelling under one dispatch advice and/or bill of lading.
+     */
+    Gsin: "gsin",
+    /**
+     * One of multiple pieces comprising, and subordinate to, a whole.
+     */
+    Ai: "itip",
+    /**
+     * Pack identification to combat illicit trade.
+     */
+    GtinTpx: "upui",
+    /**
+     * Identification of Economic Operator, Owning party or processing party in CoC/CoO.
+     */
+    GlnAi: "pgln",
+    /**
+     * Unspecified.
+     */
+    Unspecified: "gid",
+    /**
+     * US Dept of Defense supply chain.
+     */
+    UsDod: "usdod",
+    /**
+     * Aerospace and Defense sector for unique identification of aircraft and other parts and items.
+     */
+    AerospaceDefence: "adi",
+    /**
+     * Intermodal shipping containers.
+     */
+    Intermodal: "bic",
+    /**
+     * Vessel Identification.
+     */
+    Vessel: "imovn"
+};
+//# sourceMappingURL=gs1IdTypes.js.map

package/dist/es/models/gs1/gs1IdTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gs1IdTypes.js","sourceRoot":"","sources":["../../../../src/models/gs1/gs1IdTypes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,oBAAoB;AACpB;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,UAAU,GAAG;IACzB;;OAEG;IACH,IAAI,EAAE,OAAO;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM;IAEZ;;OAEG;IACH,GAAG,EAAE,MAAM;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM;IAEZ;;OAEG;IACH,IAAI,EAAE,MAAM;IAEZ;;OAEG;IACH,aAAa,EAAE,MAAM;IAErB;;OAEG;IACH,YAAY,EAAE,OAAO;IAErB;;OAEG;IACH,IAAI,EAAE,MAAM;IAEZ;;OAEG;IACH,IAAI,EAAE,KAAK;IAEX;;OAEG;IACH,GAAG,EAAE,MAAM;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM;IAEZ;;OAEG;IACH,IAAI,EAAE,MAAM;IAEZ;;OAEG;IACH,EAAE,EAAE,MAAM;IAEV;;OAEG;IACH,OAAO,EAAE,MAAM;IAEf;;OAEG;IACH,KAAK,EAAE,MAAM;IAEb;;OAEG;IACH,WAAW,EAAE,KAAK;IAElB;;OAEG;IACH,KAAK,EAAE,OAAO;IAEd;;OAEG;IACH,gBAAgB,EAAE,KAAK;IAEvB;;OAEG;IACH,UAAU,EAAE,KAAK;IAEjB;;OAEG;IACH,MAAM,EAAE,OAAO;CACN,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n/* cSpell:disable */\n/**\n * GS1 EPC Identifiers.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const Gs1IdTypes = {\n\t/**\n\t * GTIN - Trade Item.\n\t */\n\tGtin: \"sgtin\",\n\n\t/**\n\t * SSCC - Logistics Unit.\n\t */\n\tSscc: \"sscc\",\n\n\t/**\n\t * GLN - Location.\n\t */\n\tGln: \"sgln\",\n\n\t/**\n\t * GRAI - Returnable Asset.\n\t */\n\tGrai: \"grai\",\n\n\t/**\n\t * GIAI - Fixed Asset.\n\t */\n\tGiai: \"giai\",\n\n\t/**\n\t * GSRN - Recipient - Hospital Admission or Club Membership.\n\t */\n\tGsrnRecipient: \"gsrn\",\n\n\t/**\n\t * GSRN - Provider - Medical Caregiver or Loyalty Club.\n\t */\n\tGsrnProvider: \"gsrnp\",\n\n\t/**\n\t * GDTI - Document.\n\t */\n\tGtdi: \"gtdi\",\n\n\t/**\n\t * Technical Industries for unique identification of parts and components.\n\t */\n\tNone: \"cpi\",\n\n\t/**\n\t * GCN - Coupon.\n\t */\n\tGcn: \"sgcn\",\n\n\t/**\n\t * Logical grouping of goods intended for transport as a whole assigned by a freight forwarder.\n\t */\n\tGinc: \"ginc\",\n\n\t/**\n\t * Logical grouping of logistic units travelling under one dispatch advice and/or bill of lading.\n\t */\n\tGsin: \"gsin\",\n\n\t/**\n\t * One of multiple pieces comprising, and subordinate to, a whole.\n\t */\n\tAi: \"itip\",\n\n\t/**\n\t * Pack identification to combat illicit trade.\n\t */\n\tGtinTpx: \"upui\",\n\n\t/**\n\t * Identification of Economic Operator, Owning party or processing party in CoC/CoO.\n\t */\n\tGlnAi: \"pgln\",\n\n\t/**\n\t * Unspecified.\n\t */\n\tUnspecified: \"gid\",\n\n\t/**\n\t * US Dept of Defense supply chain.\n\t */\n\tUsDod: \"usdod\",\n\n\t/**\n\t * Aerospace and Defense sector for unique identification of aircraft and other parts and items.\n\t */\n\tAerospaceDefence: \"adi\",\n\n\t/**\n\t * Intermodal shipping containers.\n\t */\n\tIntermodal: \"bic\",\n\n\t/**\n\t * Vessel Identification.\n\t */\n\tVessel: \"imovn\"\n} as const;\n\n/**\n * GS1 EPC Identifiers\n */\nexport type Gs1IdTypes = (typeof Gs1IdTypes)[keyof typeof Gs1IdTypes];\n"]}

package/dist/es/models/gs1/gs1IdentifierTypes.js

@@ -0,0 +1,26 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Gs1IdTypes } from "./gs1IdTypes.js";
+/**
+ * The types of GS1 Identifier data.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const Gs1IdentifierTypes = {
+    /**
+     * Identifier epc id namespace.
+     */
+    EpcId: "epc:id",
+    /**
+     * Identifier epc:id:gtin namespace.
+     */
+    EpcIdGtin: `epc:id:${Gs1IdTypes.Gtin}`,
+    /**
+     * Identifier epc:id:sgln namespace.
+     */
+    EpcIdGln: `epc:id:${Gs1IdTypes.Gln}`,
+    /**
+     * Identifier epc id namespace.
+     */
+    EpcClass: "epc:class"
+};
+//# sourceMappingURL=gs1IdentifierTypes.js.map

package/dist/es/models/gs1/gs1IdentifierTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gs1IdentifierTypes.js","sourceRoot":"","sources":["../../../../src/models/gs1/gs1IdentifierTypes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,kBAAkB,GAAG;IACjC;;OAEG;IACH,KAAK,EAAE,QAAQ;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,UAAU,CAAC,IAAI,EAAE;IAEtC;;OAEG;IACH,QAAQ,EAAE,UAAU,UAAU,CAAC,GAAG,EAAE;IAEpC;;OAEG;IACH,QAAQ,EAAE,WAAW;CACZ,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Gs1IdTypes } from \"./gs1IdTypes.js\";\n\n/**\n * The types of GS1 Identifier data.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const Gs1IdentifierTypes = {\n\t/**\n\t * Identifier epc id namespace.\n\t */\n\tEpcId: \"epc:id\",\n\n\t/**\n\t * Identifier epc:id:gtin namespace.\n\t */\n\tEpcIdGtin: `epc:id:${Gs1IdTypes.Gtin}`,\n\n\t/**\n\t * Identifier epc:id:sgln namespace.\n\t */\n\tEpcIdGln: `epc:id:${Gs1IdTypes.Gln}`,\n\n\t/**\n\t * Identifier epc id namespace.\n\t */\n\tEpcClass: \"epc:class\"\n} as const;\n\n/**\n * The types of GS1 Identifier data.\n */\nexport type Gs1IdentifierTypes = (typeof Gs1IdentifierTypes)[keyof typeof Gs1IdentifierTypes];\n"]}

package/dist/es/models/gs1/gs1Types.js

@@ -0,0 +1,13 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types of GS1 data.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const Gs1Types = {
+    /**
+     * Represents Location Master Data.
+     */
+    LocationMasterData: "gs1_location_masterdata"
+};
+//# sourceMappingURL=gs1Types.js.map

package/dist/es/models/gs1/gs1Types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gs1Types.js","sourceRoot":"","sources":["../../../../src/models/gs1/gs1Types.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,QAAQ,GAAG;IACvB;;OAEG;IACH,kBAAkB,EAAE,yBAAyB;CACpC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The types of GS1 data.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const Gs1Types = {\n\t/**\n\t * Represents Location Master Data.\n\t */\n\tLocationMasterData: \"gs1_location_masterdata\"\n} as const;\n\n/**\n * The types of GS1 data.\n */\nexport type Gs1Types = (typeof Gs1Types)[keyof typeof Gs1Types];\n"]}

package/dist/es/models/gs1/subSiteAttributes.js

@@ -0,0 +1,143 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Sub Site Attributes.
+ * Spec https://www.gs1.org/sites/default/files/docs/epc/CBV-Standard-1-2-1-r-2017-05-05.pdf .
+ * Section 10.3.2 .
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const SubSiteAttributes = {
+    /**
+     * Electronics.
+     */
+    Electronics: "401",
+    /**
+     * Cold Storage.
+     */
+    ColdStorage: "402",
+    /**
+     * Shelf.
+     */
+    Shelf: "403",
+    /**
+     * Frozen.
+     */
+    Frozen: "404",
+    /**
+     * Fresh.
+     */
+    Fresh: "405",
+    /**
+     * Promotion.
+     */
+    Promotion: "406",
+    /**
+     * End Cap.
+     */
+    EndCap: "407",
+    /**
+     * Point of Sale.
+     */
+    PointOfSale: "408",
+    /**
+     * Security.
+     */
+    Security: "409",
+    /**
+     * General Mdse.
+     */
+    GeneralMdse: "411",
+    /**
+     * Grocery.
+     */
+    Grocery: "412",
+    /**
+     * Box crusher.
+     */
+    BoxCrusher: "413",
+    /**
+     * Dock/Door.
+     */
+    DockDoor: "414",
+    /**
+     * Conveyor Belt.
+     */
+    ConveyorBelt: "415",
+    /**
+     * Pallet Wrapper.
+     */
+    PalletWrapper: "416",
+    /**
+     * Fixed Reader.
+     */
+    FixedReader: "417",
+    /**
+     * Mobile Reader.
+     */
+    MobileReader: "418",
+    /**
+     * Shelf Storage.
+     */
+    ShelfStorage: "419",
+    /**
+     * Returns.
+     */
+    Returns: "420",
+    /**
+     * Staging.
+     */
+    Staging: "421",
+    /**
+     * Assembly.
+     */
+    Assembly: "422",
+    /**
+     * Lay-Away.
+     */
+    LayAway: "423",
+    /**
+     * Dispenser.
+     */
+    Dispenser: "424",
+    /**
+     * Quarantine.
+     */
+    Quarantine: "425",
+    /**
+     * Controlled Substance.
+     */
+    ControlledSubstance: "426",
+    /**
+     * Recalled Product.
+     */
+    RecalledProduct: "427",
+    /**
+     * Quality Control.
+     */
+    QualityControl: "428",
+    /**
+     * Printing Room.
+     */
+    PrintingRoom: "429",
+    /**
+     * Loading Dock.
+     */
+    LoadingDock: "420",
+    /**
+     * Entrance Gate.
+     */
+    EntranceGate: "431",
+    /**
+     * Exit Gate.
+     */
+    ExitGate: "432",
+    /**
+     * Gate.
+     */
+    Gate: "433",
+    /**
+     * Read Point Verification Spot.
+     */
+    ReadPointVerificationSpot: "434"
+};
+//# sourceMappingURL=subSiteAttributes.js.map

package/dist/es/models/gs1/subSiteAttributes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"subSiteAttributes.js","sourceRoot":"","sources":["../../../../src/models/gs1/subSiteAttributes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;;;GAIG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAChC;;OAEG;IACH,WAAW,EAAE,KAAK;IAElB;;OAEG;IACH,WAAW,EAAE,KAAK;IAElB;;OAEG;IACH,KAAK,EAAE,KAAK;IAEZ;;OAEG;IACH,MAAM,EAAE,KAAK;IAEb;;OAEG;IACH,KAAK,EAAE,KAAK;IAEZ;;OAEG;IACH,SAAS,EAAE,KAAK;IAEhB;;OAEG;IACH,MAAM,EAAE,KAAK;IAEb;;OAEG;IACH,WAAW,EAAE,KAAK;IAElB;;OAEG;IACH,QAAQ,EAAE,KAAK;IAEf;;OAEG;IACH,WAAW,EAAE,KAAK;IAElB;;OAEG;IACH,OAAO,EAAE,KAAK;IAEd;;OAEG;IACH,UAAU,EAAE,KAAK;IAEjB;;OAEG;IACH,QAAQ,EAAE,KAAK;IAEf;;OAEG;IACH,YAAY,EAAE,KAAK;IAEnB;;OAEG;IACH,aAAa,EAAE,KAAK;IAEpB;;OAEG;IACH,WAAW,EAAE,KAAK;IAElB;;OAEG;IACH,YAAY,EAAE,KAAK;IAEnB;;OAEG;IACH,YAAY,EAAE,KAAK;IAEnB;;OAEG;IACH,OAAO,EAAE,KAAK;IAEd;;OAEG;IACH,OAAO,EAAE,KAAK;IAEd;;OAEG;IACH,QAAQ,EAAE,KAAK;IAEf;;OAEG;IACH,OAAO,EAAE,KAAK;IAEd;;OAEG;IACH,SAAS,EAAE,KAAK;IAEhB;;OAEG;IACH,UAAU,EAAE,KAAK;IAEjB;;OAEG;IACH,mBAAmB,EAAE,KAAK;IAE1B;;OAEG;IACH,eAAe,EAAE,KAAK;IAEtB;;OAEG;IACH,cAAc,EAAE,KAAK;IAErB;;OAEG;IACH,YAAY,EAAE,KAAK;IAEnB;;OAEG;IACH,WAAW,EAAE,KAAK;IAElB;;OAEG;IACH,YAAY,EAAE,KAAK;IAEnB;;OAEG;IACH,QAAQ,EAAE,KAAK;IAEf;;OAEG;IACH,IAAI,EAAE,KAAK;IAEX;;OAEG;IACH,yBAAyB,EAAE,KAAK;CACvB,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Sub Site Attributes.\n * Spec https://www.gs1.org/sites/default/files/docs/epc/CBV-Standard-1-2-1-r-2017-05-05.pdf .\n * Section 10.3.2 .\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const SubSiteAttributes = {\n\t/**\n\t * Electronics.\n\t */\n\tElectronics: \"401\",\n\n\t/**\n\t * Cold Storage.\n\t */\n\tColdStorage: \"402\",\n\n\t/**\n\t * Shelf.\n\t */\n\tShelf: \"403\",\n\n\t/**\n\t * Frozen.\n\t */\n\tFrozen: \"404\",\n\n\t/**\n\t * Fresh.\n\t */\n\tFresh: \"405\",\n\n\t/**\n\t * Promotion.\n\t */\n\tPromotion: \"406\",\n\n\t/**\n\t * End Cap.\n\t */\n\tEndCap: \"407\",\n\n\t/**\n\t * Point of Sale.\n\t */\n\tPointOfSale: \"408\",\n\n\t/**\n\t * Security.\n\t */\n\tSecurity: \"409\",\n\n\t/**\n\t * General Mdse.\n\t */\n\tGeneralMdse: \"411\",\n\n\t/**\n\t * Grocery.\n\t */\n\tGrocery: \"412\",\n\n\t/**\n\t * Box crusher.\n\t */\n\tBoxCrusher: \"413\",\n\n\t/**\n\t * Dock/Door.\n\t */\n\tDockDoor: \"414\",\n\n\t/**\n\t * Conveyor Belt.\n\t */\n\tConveyorBelt: \"415\",\n\n\t/**\n\t * Pallet Wrapper.\n\t */\n\tPalletWrapper: \"416\",\n\n\t/**\n\t * Fixed Reader.\n\t */\n\tFixedReader: \"417\",\n\n\t/**\n\t * Mobile Reader.\n\t */\n\tMobileReader: \"418\",\n\n\t/**\n\t * Shelf Storage.\n\t */\n\tShelfStorage: \"419\",\n\n\t/**\n\t * Returns.\n\t */\n\tReturns: \"420\",\n\n\t/**\n\t * Staging.\n\t */\n\tStaging: \"421\",\n\n\t/**\n\t * Assembly.\n\t */\n\tAssembly: \"422\",\n\n\t/**\n\t * Lay-Away.\n\t */\n\tLayAway: \"423\",\n\n\t/**\n\t * Dispenser.\n\t */\n\tDispenser: \"424\",\n\n\t/**\n\t * Quarantine.\n\t */\n\tQuarantine: \"425\",\n\n\t/**\n\t * Controlled Substance.\n\t */\n\tControlledSubstance: \"426\",\n\n\t/**\n\t * Recalled Product.\n\t */\n\tRecalledProduct: \"427\",\n\n\t/**\n\t * Quality Control.\n\t */\n\tQualityControl: \"428\",\n\n\t/**\n\t * Printing Room.\n\t */\n\tPrintingRoom: \"429\",\n\n\t/**\n\t * Loading Dock.\n\t */\n\tLoadingDock: \"420\",\n\n\t/**\n\t * Entrance Gate.\n\t */\n\tEntranceGate: \"431\",\n\n\t/**\n\t * Exit Gate.\n\t */\n\tExitGate: \"432\",\n\n\t/**\n\t * Gate.\n\t */\n\tGate: \"433\",\n\n\t/**\n\t * Read Point Verification Spot.\n\t */\n\tReadPointVerificationSpot: \"434\"\n} as const;\n\n/**\n * Sub Site Attributes.\n * Spec https://www.gs1.org/sites/default/files/docs/epc/CBV-Standard-1-2-1-r-2017-05-05.pdf .\n * Section 10.3.2 .\n */\nexport type SubSiteAttributes = (typeof SubSiteAttributes)[keyof typeof SubSiteAttributes];\n"]}

package/dist/es/models/gs1/subSiteTypes.js

@@ -0,0 +1,75 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Sub Site Identifier Types.
+ * Spec https://www.gs1.org/sites/default/files/docs/epc/CBV-Standard-1-2-1-r-2017-05-05.pdf .
+ * Section 10.3.1 .
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const SubSiteTypes = {
+    /**
+     * The Backroom.
+     */
+    Backroom: "201",
+    /**
+     * The Storage Area.
+     */
+    StorageArea: "202",
+    /**
+     * The Sales Floor.
+     */
+    SalesFloor: "203",
+    /**
+     * The Returns Area.
+     */
+    ReturnsArea: "207",
+    /**
+     * The Production Area.
+     */
+    ProductionArea: "208",
+    /**
+     * The Receiving Area.
+     */
+    ReceivingArea: "209",
+    /**
+     * The Shipping Area.
+     */
+    ShippingArea: "210",
+    /**
+     * The Sales Floor Transition Area.
+     */
+    SalesFloorTransitionArea: "211",
+    /**
+     * The Customer Pick-Up Area.
+     */
+    CustomerPickupArea: "212",
+    /**
+     * The Yard.
+     */
+    Yard: "213",
+    /**
+     * The Container Deck.
+     */
+    ContainerDeck: "214",
+    /**
+     * The Cargo Terminal.
+     */
+    CargoTerminal: "215",
+    /**
+     * The Packaging Area.
+     */
+    PackagingArea: "251",
+    /**
+     * The Picking Area.
+     */
+    PickingArea: "252",
+    /**
+     * The Pharmacy Area.
+     */
+    PharmacyArea: "253",
+    /**
+     * Undefined.
+     */
+    Undefined: "299"
+};
+//# sourceMappingURL=subSiteTypes.js.map

package/dist/es/models/gs1/subSiteTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"subSiteTypes.js","sourceRoot":"","sources":["../../../../src/models/gs1/subSiteTypes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;;;GAIG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,YAAY,GAAG;IAC3B;;OAEG;IACH,QAAQ,EAAE,KAAK;IAEf;;OAEG;IACH,WAAW,EAAE,KAAK;IAElB;;OAEG;IACH,UAAU,EAAE,KAAK;IAEjB;;OAEG;IACH,WAAW,EAAE,KAAK;IAElB;;OAEG;IACH,cAAc,EAAE,KAAK;IAErB;;OAEG;IACH,aAAa,EAAE,KAAK;IAEpB;;OAEG;IACH,YAAY,EAAE,KAAK;IAEnB;;OAEG;IACH,wBAAwB,EAAE,KAAK;IAE/B;;OAEG;IACH,kBAAkB,EAAE,KAAK;IAEzB;;OAEG;IACH,IAAI,EAAE,KAAK;IAEX;;OAEG;IACH,aAAa,EAAE,KAAK;IAEpB;;OAEG;IACH,aAAa,EAAE,KAAK;IAEpB;;OAEG;IACH,aAAa,EAAE,KAAK;IAEpB;;OAEG;IACH,WAAW,EAAE,KAAK;IAElB;;OAEG;IACH,YAAY,EAAE,KAAK;IAEnB;;OAEG;IACH,SAAS,EAAE,KAAK;CACP,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Sub Site Identifier Types.\n * Spec https://www.gs1.org/sites/default/files/docs/epc/CBV-Standard-1-2-1-r-2017-05-05.pdf .\n * Section 10.3.1 .\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const SubSiteTypes = {\n\t/**\n\t * The Backroom.\n\t */\n\tBackroom: \"201\",\n\n\t/**\n\t * The Storage Area.\n\t */\n\tStorageArea: \"202\",\n\n\t/**\n\t * The Sales Floor.\n\t */\n\tSalesFloor: \"203\",\n\n\t/**\n\t * The Returns Area.\n\t */\n\tReturnsArea: \"207\",\n\n\t/**\n\t * The Production Area.\n\t */\n\tProductionArea: \"208\",\n\n\t/**\n\t * The Receiving Area.\n\t */\n\tReceivingArea: \"209\",\n\n\t/**\n\t * The Shipping Area.\n\t */\n\tShippingArea: \"210\",\n\n\t/**\n\t * The Sales Floor Transition Area.\n\t */\n\tSalesFloorTransitionArea: \"211\",\n\n\t/**\n\t * The Customer Pick-Up Area.\n\t */\n\tCustomerPickupArea: \"212\",\n\n\t/**\n\t * The Yard.\n\t */\n\tYard: \"213\",\n\n\t/**\n\t * The Container Deck.\n\t */\n\tContainerDeck: \"214\",\n\n\t/**\n\t * The Cargo Terminal.\n\t */\n\tCargoTerminal: \"215\",\n\n\t/**\n\t * The Packaging Area.\n\t */\n\tPackagingArea: \"251\",\n\n\t/**\n\t * The Picking Area.\n\t */\n\tPickingArea: \"252\",\n\n\t/**\n\t * The Pharmacy Area.\n\t */\n\tPharmacyArea: \"253\",\n\n\t/**\n\t * Undefined.\n\t */\n\tUndefined: \"299\"\n} as const;\n\n/**\n * Sub Site Identifier Types.\n * Spec https://www.gs1.org/sites/default/files/docs/epc/CBV-Standard-1-2-1-r-2017-05-05.pdf .\n * Section 10.3.1 .\n */\nexport type SubSiteTypes = (typeof SubSiteTypes)[keyof typeof SubSiteTypes];\n"]}

package/dist/es/utils/gs1IdentifiersValidation.js

@@ -0,0 +1,144 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Is, Urn, Validation } from "@twin.org/core";
+import { Gs1IdTypes } from "../models/gs1/gs1IdTypes.js";
+/**
+ * Validation for GS1 identifiers.
+ */
+export class Gs1IdentifiersValidation {
+    /**
+     * Validate if the property is a valid epc.
+     * @param propertyName The name of the property being validated.
+     * @param value The value to test.
+     * @param failures The list of failures to add to.
+     * @returns True if the value is valid epc.
+     */
+    static epcId(propertyName, value, failures) {
+        const is = Urn.validate("value", value, failures);
+        if (is) {
+            const urn = Urn.fromValidString(value);
+            const specificParts = urn.namespaceSpecific().split(":");
+            if (specificParts.length < 2) {
+                failures.push({
+                    property: propertyName,
+                    reason: "validation.gs1IncorrectSegmentCount"
+                });
+            }
+            else {
+                const isValid = Validation.arrayOneOf(propertyName, specificParts[1], Object.values(Gs1IdTypes), failures);
+                if (isValid) {
+                    switch (specificParts[1]) {
+                        case Gs1IdTypes.Gtin:
+                            Gs1IdentifiersValidation.epcIdGtin(propertyName, urn, failures);
+                            break;
+                        case Gs1IdTypes.Gln:
+                            Gs1IdentifiersValidation.epcIdGln(propertyName, urn, failures);
+                            break;
+                    }
+                }
+            }
+        }
+        return is;
+    }
+    /**
+     * Validate if the property is a valid epc id gtin.
+     * @param propertyName The name of the property being validated.
+     * @param value The value to test.
+     * @param failures The list of failures to add to.
+     * @returns True if the value is valid epc.
+     */
+    static epcIdGtin(propertyName, value, failures) {
+        const is = Urn.validate("value", value, failures);
+        if (is) {
+            const gtin = Gs1IdentifiersValidation.extractEpcIdGtin(value);
+            if (Is.undefined(gtin)) {
+                failures.push({
+                    property: propertyName,
+                    reason: "validation.gs1ValueIncorrect"
+                });
+                return false;
+            }
+        }
+        return is;
+    }
+    /**
+     * Validate if the property is a valid epc id gln.
+     * @param propertyName The name of the property being validated.
+     * @param value The value to test.
+     * @param failures The list of failures to add to.
+     * @returns True if the value is valid epc.
+     */
+    static epcIdGln(propertyName, value, failures) {
+        const is = Urn.validate("value", value, failures);
+        if (is) {
+            const gtin = Gs1IdentifiersValidation.extractEpcIdGln(value);
+            if (Is.undefined(gtin)) {
+                failures.push({
+                    property: propertyName,
+                    reason: "validation.gs1ValueIncorrect"
+                });
+                return false;
+            }
+        }
+        return is;
+    }
+    /**
+     * Validate if the property is a valid epc class.
+     * @param propertyName The name of the property being validated.
+     * @param value The value to test.
+     * @param failures The list of failures to add to.
+     * @returns True if the value is valid epc.
+     */
+    static epcClass(propertyName, value, failures) {
+        const is = Urn.validate("value", value, failures);
+        if (is) {
+            const extracted = Gs1IdentifiersValidation.extractEpcClassUri(value);
+            if (Is.undefined(extracted)) {
+                failures.push({
+                    property: propertyName,
+                    reason: "validation.gs1EpcClassIncorrect"
+                });
+                return false;
+            }
+        }
+        return is;
+    }
+    /**
+     * Extract the EPC gtin from the URI.
+     * @param epc The uri to extract from.
+     * @returns The extracted data or undefined.
+     */
+    static extractEpcIdGtin(epc) {
+        const parts = /^urn:epc:id:sgtin:(\d+)\.(\d+)\.([\w!%'()*+,-.:;=]+)/.exec(epc);
+        if (parts && parts.length >= 3 && parts[1].length + parts[2].length === 13) {
+            return parts.slice(1).join(".");
+        }
+    }
+    /**
+     * Extract the EPC gln from the URI.
+     * @param epc The uri to extract from.
+     * @returns The extracted data or undefined.
+     */
+    static extractEpcIdGln(epc) {
+        const parts = /^urn:epc:id:sgln:(\d+)\.(\d+)\.([\w!%'()*+,-.:;=]+)/.exec(epc);
+        if (parts && parts.length >= 3 && parts[1].length + parts[2].length === 12) {
+            return parts.slice(1).join(".");
+        }
+    }
+    /**
+     * Extract The EPC Class from the URI.
+     * @param epc The uri to extract from.
+     * @returns The extracted data or undefined.
+     */
+    static extractEpcClassUri(epc) {
+        const parts = /^urn:epc:class:lgtin:(\d+)\.(\d+)\.([\w!%'()*+,-.:;=]+)/.exec(epc);
+        if (parts?.length === 4 && parts[1].length + parts[2].length === 13) {
+            return {
+                companyPrefix: parts[1],
+                itemRefAndIndicator: parts[2],
+                lot: parts[3]
+            };
+        }
+    }
+}
+//# sourceMappingURL=gs1IdentifiersValidation.js.map