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

package/docs/reference/variables/DispositionTypes.md

@@ -0,0 +1,141 @@
+# Variable: DispositionTypes
+
+> `const` **DispositionTypes**: `object`
+
+EPCIS 2.0 disposition types.
+
+See EPCIS CVB for more details.
+
+## Type declaration
+
+### Active
+
+> `readonly` **Active**: `"active"` = `"active"`
+
+### ContainerClosed
+
+> `readonly` **ContainerClosed**: `"container_closed"` = `"container_closed"`
+
+### Damaged
+
+> `readonly` **Damaged**: `"damaged"` = `"damaged"`
+
+### Destroyed
+
+> `readonly` **Destroyed**: `"destroyed"` = `"destroyed"`
+
+### Dispensed
+
+> `readonly` **Dispensed**: `"dispensed"` = `"dispensed"`
+
+### Disposed
+
+> `readonly` **Disposed**: `"disposed"` = `"disposed"`
+
+### Encoded
+
+> `readonly` **Encoded**: `"encoded"` = `"encoded"`
+
+### Expired
+
+> `readonly` **Expired**: `"expired"` = `"expired"`
+
+### InProgress
+
+> `readonly` **InProgress**: `"in_progress"` = `"in_progress"`
+
+### InTransit
+
+> `readonly` **InTransit**: `"in_transit"` = `"in_transit"`
+
+### Inactive
+
+> `readonly` **Inactive**: `"inactive"` = `"inactive"`
+
+### NoPedigreeMatch
+
+> `readonly` **NoPedigreeMatch**: `"no_pedigree_match"` = `"no_pedigree_match"`
+
+### NonSellableOther
+
+> `readonly` **NonSellableOther**: `"non_sellable_other"` = `"non_sellable_other"`
+
+### PartiallyDispensed
+
+> `readonly` **PartiallyDispensed**: `"partially_dispensed"` = `"partially_dispensed"`
+
+### Recalled
+
+> `readonly` **Recalled**: `"recalled"` = `"recalled"`
+
+### Reserved
+
+> `readonly` **Reserved**: `"reserved"` = `"reserved"`
+
+### RetailSold
+
+> `readonly` **RetailSold**: `"retail_sold"` = `"retail_sold"`
+
+### Returned
+
+> `readonly` **Returned**: `"returned"` = `"returned"`
+
+### SellableAccessible
+
+> `readonly` **SellableAccessible**: `"sellable_accessible"` = `"sellable_accessible"`
+
+### SellableNotAccessible
+
+> `readonly` **SellableNotAccessible**: `"sellable_not_accessible"` = `"sellable_not_accessible"`
+
+### Stolen
+
+> `readonly` **Stolen**: `"stolen"` = `"stolen"`
+
+### Unknown
+
+> `readonly` **Unknown**: `"unknown"` = `"unknown"`
+
+### Available
+
+> `readonly` **Available**: `"available"` = `"available"`
+
+### CompletenessVerified
+
+> `readonly` **CompletenessVerified**: `"completeness_verified"` = `"completeness_verified"`
+
+### CompletenessInferred
+
+> `readonly` **CompletenessInferred**: `"completeness_inferred"` = `"completeness_inferred"`
+
+### Conformant
+
+> `readonly` **Conformant**: `"conformant"` = `"conformant"`
+
+### ContainerOpen
+
+> `readonly` **ContainerOpen**: `"container_open"` = `"container_open"`
+
+### MismatchInstance
+
+> `readonly` **MismatchInstance**: `"mismatch_instance"` = `"mismatch_instance"`
+
+### MismatchClass
+
+> `readonly` **MismatchClass**: `"mismatch_class"` = `"mismatch_class"`
+
+### MismatchQuantity
+
+> `readonly` **MismatchQuantity**: `"mismatch_quantity"` = `"mismatch_quantity"`
+
+### NeedsReplacement
+
+> `readonly` **NeedsReplacement**: `"needs_replacement"` = `"needs_replacement"`
+
+### NonConformant
+
+> `readonly` **NonConformant**: `"non_conformant"` = `"non_conformant"`
+
+### Unavailable
+
+> `readonly` **Unavailable**: `"unavailable"` = `"unavailable"`

package/docs/reference/variables/EpcisErrorTypes.md

@@ -0,0 +1,15 @@
+# Variable: EpcisErrorTypes
+
+> `const` **EpcisErrorTypes**: `object`
+
+EPCIS Error types.
+
+## Type declaration
+
+### ValidationFailed
+
+> `readonly` **ValidationFailed**: `"epcisException:ValidationException"` = `"epcisException:ValidationException"`
+
+### NoSuchResource
+
+> `readonly` **NoSuchResource**: `"epcisException:NoSuchResourceException"` = `"epcisException:NoSuchResourceException"`

package/docs/reference/variables/EventTypes.md

@@ -0,0 +1,37 @@
+# Variable: EventTypes
+
+> `const` **EventTypes**: `object`
+
+EPCIS 2.0 event types.
+
+## Type declaration
+
+### ObjectEvent
+
+> `readonly` **ObjectEvent**: `"ObjectEvent"` = `"ObjectEvent"`
+
+ObjectEvent.
+
+### AggregationEvent
+
+> `readonly` **AggregationEvent**: `"AggregationEvent"` = `"AggregationEvent"`
+
+Aggregation Event.
+
+### AssociationEvent
+
+> `readonly` **AssociationEvent**: `"AssociationEvent"` = `"AssociationEvent"`
+
+Association Event.
+
+### TransformationEvent
+
+> `readonly` **TransformationEvent**: `"TransformationEvent"` = `"TransformationEvent"`
+
+Transformation Event.
+
+### TransactionEvent
+
+> `readonly` **TransactionEvent**: `"TransactionEvent"` = `"TransactionEvent"`
+
+Transaction Event.

package/docs/reference/variables/Gs1IdTypes.md

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

package/docs/reference/variables/Gs1IdentifierTypes.md

@@ -0,0 +1,31 @@
+# Variable: Gs1IdentifierTypes
+
+> `const` **Gs1IdentifierTypes**: `object`
+
+The types of GS1 Identifier data.
+
+## Type declaration
+
+### EpcId
+
+> `readonly` **EpcId**: `"epc:id"` = `"epc:id"`
+
+Identifier epc id namespace.
+
+### EpcIdGtin
+
+> `readonly` **EpcIdGtin**: `"epc:id:sgtin"`
+
+Identifier epc:id:gtin namespace.
+
+### EpcIdGln
+
+> `readonly` **EpcIdGln**: `"epc:id:sgln"`
+
+Identifier epc:id:sgln namespace.
+
+### EpcClass
+
+> `readonly` **EpcClass**: `"epc:class"` = `"epc:class"`
+
+Identifier epc id namespace.

package/docs/reference/variables/Gs1Types.md

@@ -0,0 +1,13 @@
+# Variable: Gs1Types
+
+> `const` **Gs1Types**: `object`
+
+The types of GS1 data.
+
+## Type declaration
+
+### LocationMasterData
+
+> `readonly` **LocationMasterData**: `"gs1_location_masterdata"` = `"gs1_location_masterdata"`
+
+Represents Location Master Data.

package/docs/reference/variables/SubSiteAttributes.md

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

package/docs/reference/variables/SubSiteTypes.md

@@ -0,0 +1,105 @@
+# Variable: SubSiteTypes
+
+> `const` **SubSiteTypes**: `object`
+
+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 .
+
+## Type declaration
+
+### Backroom
+
+> `readonly` **Backroom**: `"201"` = `"201"`
+
+The Backroom.
+
+### StorageArea
+
+> `readonly` **StorageArea**: `"202"` = `"202"`
+
+The Storage Area.
+
+### SalesFloor
+
+> `readonly` **SalesFloor**: `"203"` = `"203"`
+
+The Sales Floor.
+
+### ReturnsArea
+
+> `readonly` **ReturnsArea**: `"207"` = `"207"`
+
+The Returns Area.
+
+### ProductionArea
+
+> `readonly` **ProductionArea**: `"208"` = `"208"`
+
+The Production Area.
+
+### ReceivingArea
+
+> `readonly` **ReceivingArea**: `"209"` = `"209"`
+
+The Receiving Area.
+
+### ShippingArea
+
+> `readonly` **ShippingArea**: `"210"` = `"210"`
+
+The Shipping Area.
+
+### SalesFloorTransitionArea
+
+> `readonly` **SalesFloorTransitionArea**: `"211"` = `"211"`
+
+The Sales Floor Transition Area.
+
+### CustomerPickupArea
+
+> `readonly` **CustomerPickupArea**: `"212"` = `"212"`
+
+The Customer Pick-Up Area.
+
+### Yard
+
+> `readonly` **Yard**: `"213"` = `"213"`
+
+The Yard.
+
+### ContainerDeck
+
+> `readonly` **ContainerDeck**: `"214"` = `"214"`
+
+The Container Deck.
+
+### CargoTerminal
+
+> `readonly` **CargoTerminal**: `"215"` = `"215"`
+
+The Cargo Terminal.
+
+### PackagingArea
+
+> `readonly` **PackagingArea**: `"251"` = `"251"`
+
+The Packaging Area.
+
+### PickingArea
+
+> `readonly` **PickingArea**: `"252"` = `"252"`
+
+The Picking Area.
+
+### PharmacyArea
+
+> `readonly` **PharmacyArea**: `"253"` = `"253"`
+
+The Pharmacy Area.
+
+### Undefined
+
+> `readonly` **Undefined**: `"299"` = `"299"`
+
+Undefined.

package/locales/en.json

@@ -0,0 +1,12 @@
+{
+	"error": {
+		"validation": {
+			"gs1SegmentMissing": "The GS1 EPC for should contain \"{segment}\"",
+			"gs1IncorrectSegmentCount": "The GS1 EPC has an incorrect segment count",
+			"gs1ValueIncorrect": "The GS1 EPC value segment is not in the correct format",
+			"gs1EpcClassIncorrect": "The GS1 EPC class uri is not in the correct format",
+			"geoCoordinatesLatitude": "The Master data latitude is not in the correct format",
+			"geoCoordinatesLongitude": "The Master data longitude is not in the correct format"
+		}
+	}
+}