@twin.org/standards-gs1 0.0.1-next.21

package/dist/types/models/epcis20/eventTypes.d.ts

@@ -0,0 +1,29 @@
+/**
+ * EPCIS 2.0 event types.
+ */
+export declare const EventTypes: {
+    /**
+     * ObjectEvent.
+     */
+    readonly ObjectEvent: "ObjectEvent";
+    /**
+     * Aggregation Event.
+     */
+    readonly AggregationEvent: "AggregationEvent";
+    /**
+     * Association Event.
+     */
+    readonly AssociationEvent: "AssociationEvent";
+    /**
+     * Transformation Event.
+     */
+    readonly TransformationEvent: "TransformationEvent";
+    /**
+     * Transaction Event.
+     */
+    readonly TransactionEvent: "TransactionEvent";
+};
+/**
+ * EPCIS 2.0 event types.
+ */
+export type EventTypes = (typeof EventTypes)[keyof typeof EventTypes];

package/dist/types/models/gs1/gs1IdTypes.d.ts

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

package/dist/types/models/gs1/gs1IdentifierTypes.d.ts

@@ -0,0 +1,25 @@
+/**
+ * The types of GS1 Identifier data.
+ */
+export declare const Gs1IdentifierTypes: {
+    /**
+     * Identifier epc id namespace.
+     */
+    readonly EpcId: "epc:id";
+    /**
+     * Identifier epc:id:gtin namespace.
+     */
+    readonly EpcIdGtin: "epc:id:sgtin";
+    /**
+     * Identifier epc:id:sgln namespace.
+     */
+    readonly EpcIdGln: "epc:id:sgln";
+    /**
+     * Identifier epc id namespace.
+     */
+    readonly EpcClass: "epc:class";
+};
+/**
+ * The types of GS1 Identifier data.
+ */
+export type Gs1IdentifierTypes = (typeof Gs1IdentifierTypes)[keyof typeof Gs1IdentifierTypes];

package/dist/types/models/gs1/gs1Types.d.ts

@@ -0,0 +1,13 @@
+/**
+ * The types of GS1 data.
+ */
+export declare const Gs1Types: {
+    /**
+     * Represents Location Master Data.
+     */
+    readonly LocationMasterData: "gs1_location_masterdata";
+};
+/**
+ * The types of GS1 data.
+ */
+export type Gs1Types = (typeof Gs1Types)[keyof typeof Gs1Types];

package/dist/types/models/gs1/subSiteAttributes.d.ts

@@ -0,0 +1,145 @@
+/**
+ * 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 .
+ */
+export declare const SubSiteAttributes: {
+    /**
+     * Electronics.
+     */
+    readonly Electronics: "401";
+    /**
+     * Cold Storage.
+     */
+    readonly ColdStorage: "402";
+    /**
+     * Shelf.
+     */
+    readonly Shelf: "403";
+    /**
+     * Frozen.
+     */
+    readonly Frozen: "404";
+    /**
+     * Fresh.
+     */
+    readonly Fresh: "405";
+    /**
+     * Promotion.
+     */
+    readonly Promotion: "406";
+    /**
+     * End Cap.
+     */
+    readonly EndCap: "407";
+    /**
+     * Point of Sale.
+     */
+    readonly PointOfSale: "408";
+    /**
+     * Security.
+     */
+    readonly Security: "409";
+    /**
+     * General Mdse.
+     */
+    readonly GeneralMdse: "411";
+    /**
+     * Grocery.
+     */
+    readonly Grocery: "412";
+    /**
+     * Box crusher.
+     */
+    readonly BoxCrusher: "413";
+    /**
+     * Dock/Door.
+     */
+    readonly DockDoor: "414";
+    /**
+     * Conveyor Belt.
+     */
+    readonly ConveyorBelt: "415";
+    /**
+     * Pallet Wrapper.
+     */
+    readonly PalletWrapper: "416";
+    /**
+     * Fixed Reader.
+     */
+    readonly FixedReader: "417";
+    /**
+     * Mobile Reader.
+     */
+    readonly MobileReader: "418";
+    /**
+     * Shelf Storage.
+     */
+    readonly ShelfStorage: "419";
+    /**
+     * Returns.
+     */
+    readonly Returns: "420";
+    /**
+     * Staging.
+     */
+    readonly Staging: "421";
+    /**
+     * Assembly.
+     */
+    readonly Assembly: "422";
+    /**
+     * Lay-Away.
+     */
+    readonly LayAway: "423";
+    /**
+     * Dispenser.
+     */
+    readonly Dispenser: "424";
+    /**
+     * Quarantine.
+     */
+    readonly Quarantine: "425";
+    /**
+     * Controlled Substance.
+     */
+    readonly ControlledSubstance: "426";
+    /**
+     * Recalled Product.
+     */
+    readonly RecalledProduct: "427";
+    /**
+     * Quality Control.
+     */
+    readonly QualityControl: "428";
+    /**
+     * Printing Room.
+     */
+    readonly PrintingRoom: "429";
+    /**
+     * Loading Dock.
+     */
+    readonly LoadingDock: "420";
+    /**
+     * Entrance Gate.
+     */
+    readonly EntranceGate: "431";
+    /**
+     * Exit Gate.
+     */
+    readonly ExitGate: "432";
+    /**
+     * Gate.
+     */
+    readonly Gate: "433";
+    /**
+     * Read Point Verification Spot.
+     */
+    readonly ReadPointVerificationSpot: "434";
+};
+/**
+ * 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 .
+ */
+export type SubSiteAttributes = (typeof SubSiteAttributes)[keyof typeof SubSiteAttributes];

package/dist/types/models/gs1/subSiteTypes.d.ts

@@ -0,0 +1,77 @@
+/**
+ * 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 .
+ */
+export declare const SubSiteTypes: {
+    /**
+     * The Backroom.
+     */
+    readonly Backroom: "201";
+    /**
+     * The Storage Area.
+     */
+    readonly StorageArea: "202";
+    /**
+     * The Sales Floor.
+     */
+    readonly SalesFloor: "203";
+    /**
+     * The Returns Area.
+     */
+    readonly ReturnsArea: "207";
+    /**
+     * The Production Area.
+     */
+    readonly ProductionArea: "208";
+    /**
+     * The Receiving Area.
+     */
+    readonly ReceivingArea: "209";
+    /**
+     * The Shipping Area.
+     */
+    readonly ShippingArea: "210";
+    /**
+     * The Sales Floor Transition Area.
+     */
+    readonly SalesFloorTransitionArea: "211";
+    /**
+     * The Customer Pick-Up Area.
+     */
+    readonly CustomerPickupArea: "212";
+    /**
+     * The Yard.
+     */
+    readonly Yard: "213";
+    /**
+     * The Container Deck.
+     */
+    readonly ContainerDeck: "214";
+    /**
+     * The Cargo Terminal.
+     */
+    readonly CargoTerminal: "215";
+    /**
+     * The Packaging Area.
+     */
+    readonly PackagingArea: "251";
+    /**
+     * The Picking Area.
+     */
+    readonly PickingArea: "252";
+    /**
+     * The Pharmacy Area.
+     */
+    readonly PharmacyArea: "253";
+    /**
+     * Undefined.
+     */
+    readonly Undefined: "299";
+};
+/**
+ * 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 .
+ */
+export type SubSiteTypes = (typeof SubSiteTypes)[keyof typeof SubSiteTypes];

package/dist/types/utils/gs1IdentifiersValidation.d.ts

@@ -0,0 +1,57 @@
+import { type IValidationFailure } from "@twin.org/core";
+import type { IEPCClassUri } from "../models/epc/IEPCClassUri";
+/**
+ * Validation for GS1 identifiers.
+ */
+export declare 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: string, value: unknown, failures: IValidationFailure[]): value is string;
+    /**
+     * 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: string, value: unknown, failures: IValidationFailure[]): value is string;
+    /**
+     * 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: string, value: unknown, failures: IValidationFailure[]): value is string;
+    /**
+     * 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: string, value: unknown, failures: IValidationFailure[]): value is string;
+    /**
+     * Extract the EPC gtin from the URI.
+     * @param epc The uri to extract from.
+     * @returns The extracted data or undefined.
+     */
+    static extractEpcIdGtin(epc: string): string | undefined;
+    /**
+     * Extract the EPC gln from the URI.
+     * @param epc The uri to extract from.
+     * @returns The extracted data or undefined.
+     */
+    static extractEpcIdGln(epc: string): string | undefined;
+    /**
+     * Extract The EPC Class from the URI.
+     * @param epc The uri to extract from.
+     * @returns The extracted data or undefined.
+     */
+    static extractEpcClassUri(epc: string): IEPCClassUri | undefined;
+}

package/dist/types/utils/gs1Is.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Is checks for GS1 data.
+ */
+export declare class Gs1Is {
+    /**
+     * Is the value an EPC identifier.
+     * @param value The value to test.
+     * @returns True if the value is an epc.
+     */
+    static isEpcHex(value: string): boolean;
+    /**
+     * Is the value a valid geo uri https://en.wikipedia.org/wiki/Geo_URI_scheme.
+     * @param value The value to check.
+     * @returns True if the value matches a geo uri.
+     */
+    static isGeoUri(value: string): boolean;
+}

package/dist/types/utils/gs1Validation.d.ts

@@ -0,0 +1,16 @@
+import { type IValidationFailure } from "@twin.org/core";
+import type { Gs1Location } from "../entities/gs1Location";
+/**
+ * Validation for GS1 types.
+ */
+export declare class Gs1Validation {
+    /**
+     * Validate if the property is a valid location.
+     * @param propertyName The name of the property being validated.
+     * @param value The value to test.
+     * @param failures The list of failures to add to.
+     * @param container The object which contains this one.
+     * @returns True if the value is a location.
+     */
+    static locationMasterData(propertyName: string, value: Gs1Location, failures: IValidationFailure[], container?: unknown): value is Gs1Location;
+}

package/docs/changelog.md

@@ -0,0 +1,5 @@
+# @twin.org/standards-gs1 - Changelog
+
+## v0.0.1-next.21
+
+- Initial Release

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/standards-gs1 - Examples

package/docs/reference/classes/Gs1DataTypes.md

@@ -0,0 +1,26 @@
+# Class: Gs1DataTypes
+
+Handle all the data types for GS1.
+Vocabulary https://www.gs1.org/voc .
+
+## Constructors
+
+### new Gs1DataTypes()
+
+> **new Gs1DataTypes**(): [`Gs1DataTypes`](Gs1DataTypes.md)
+
+#### Returns
+
+[`Gs1DataTypes`](Gs1DataTypes.md)
+
+## Methods
+
+### registerTypes()
+
+> `static` **registerTypes**(): `void`
+
+Register all the data types.
+
+#### Returns
+
+`void`

package/docs/reference/classes/Gs1Identifiers.md

@@ -0,0 +1,25 @@
+# Class: Gs1Identifiers
+
+Handle all identifier types for GS1.
+
+## Constructors
+
+### new Gs1Identifiers()
+
+> **new Gs1Identifiers**(): [`Gs1Identifiers`](Gs1Identifiers.md)
+
+#### Returns
+
+[`Gs1Identifiers`](Gs1Identifiers.md)
+
+## Methods
+
+### registerIdentifiers()
+
+> `static` **registerIdentifiers**(): `void`
+
+Register all the identifiers.
+
+#### Returns
+
+`void`