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

package/docs/reference/variables/EpcisBizStepTypes.md

@@ -0,0 +1,270 @@
+# Variable: EpcisBizStepTypes
+
+> `const` **EpcisBizStepTypes**: `object`
+
+Supported EPCIS 2.0 `bizStep` values.
+
+These values come from the GS1 EPCIS / CBV (Core Business Vocabulary).
+Use the union type `EpcisBizStepTypes` when you want to restrict a field to known CBV values.
+
+## Type Declaration
+
+### Accepting
+
+> `readonly` **Accepting**: `"accepting"` = `"accepting"`
+
+Activity where an object changes possession and/or ownership.
+
+### Arriving
+
+> `readonly` **Arriving**: `"arriving"` = `"arriving"`
+
+Activity where an object arrives at a location.
+
+### Assembling
+
+> `readonly` **Assembling**: `"assembling"` = `"assembling"`
+
+Combining one or more objects to create a new finished product while originals
+remain recognisable.
+
+### Collecting
+
+> `readonly` **Collecting**: `"collecting"` = `"collecting"`
+
+Picking up and collecting an object for future disposal, recycling, or re-use.
+
+### Commissioning
+
+> `readonly` **Commissioning**: `"commissioning"` = `"commissioning"`
+
+Associating a new instance- or class-level identifier with a specific object
+for the first time.
+
+### Consigning
+
+> `readonly` **Consigning**: `"consigning"` = `"consigning"`
+
+Overall process covering staging_outbound, loading, departing, and accepting
+when granular steps are unknown.
+
+### CreatingClassInstance
+
+> `readonly` **CreatingClassInstance**: `"creating_class_instance"` = `"creating_class_instance"`
+
+Step where an instance or increased quantity of a class-level identifier is
+produced and may repeat.
+
+### CycleCounting
+
+> `readonly` **CycleCounting**: `"cycle_counting"` = `"cycle_counting"`
+
+Counting objects within a location for business needs other than accounting.
+
+### Decommissioning
+
+> `readonly` **Decommissioning**: `"decommissioning"` = `"decommissioning"`
+
+Disassociating an instance-level identifier from an object; it may be
+re-commissioned later with a new identifier.
+
+### Departing
+
+> `readonly` **Departing**: `"departing"` = `"departing"`
+
+Activity where an object leaves a location on its way to a destination.
+
+### Destroying
+
+> `readonly` **Destroying**: `"destroying"` = `"destroying"`
+
+Process of terminating an object so it should not be subject of subsequent events.
+
+### Disassembling
+
+> `readonly` **Disassembling**: `"disassembling"` = `"disassembling"`
+
+Breaking down an object into separate, uniquely identified component parts.
+
+### Dispensing
+
+> `readonly` **Dispensing**: `"dispensing"` = `"dispensing"`
+
+Making a product available in full or part to a consumer.
+
+### Encoding
+
+> `readonly` **Encoding**: `"encoding"` = `"encoding"`
+
+Writing an instance-level identifier to a barcode or RFID tag before
+association with an object.
+
+### EnteringExiting
+
+> `readonly` **EnteringExiting**: `"entering_exiting"` = `"entering_exiting"`
+
+Activity at a facility entrance/exit where customers leave with purchases or
+enter with returns.
+
+### Holding
+
+> `readonly` **Holding**: `"holding"` = `"holding"`
+
+Segregating an object for further review.
+
+### Inspecting
+
+> `readonly` **Inspecting**: `"inspecting"` = `"inspecting"`
+
+Reviewing objects to address potential defects while keeping them viable in the
+supply chain.
+
+### Installing
+
+> `readonly` **Installing**: `"installing"` = `"installing"`
+
+Putting an object into a composite object that already exists.
+
+### Killing
+
+> `readonly` **Killing**: `"killing"` = `"killing"`
+
+Terminating an RFID tag previously associated with an object while the object
+continues to exist.
+
+### Loading
+
+> `readonly` **Loading**: `"loading"` = `"loading"`
+
+Loading an object into a shipping conveyance.
+
+### Other
+
+> `readonly` **Other**: `"other"` = `"other"`
+
+A business step not identified by the CBV list.
+
+### Packing
+
+> `readonly` **Packing**: `"packing"` = `"packing"`
+
+Putting objects into a larger container for shipping, typically where
+aggregation occurs.
+
+### Picking
+
+> `readonly` **Picking**: `"picking"` = `"picking"`
+
+Selecting objects to fill an order.
+
+### Receiving
+
+> `readonly` **Receiving**: `"receiving"` = `"receiving"`
+
+Indicating an object is being received at a location and added to inventory.
+
+### Removing
+
+> `readonly` **Removing**: `"removing"` = `"removing"`
+
+Taking an object out of a composite object; opposite of installing.
+
+### Repackaging
+
+> `readonly` **Repackaging**: `"repackaging"` = `"repackaging"`
+
+Changing an object's packaging configuration.
+
+### Repairing
+
+> `readonly` **Repairing**: `"repairing"` = `"repairing"`
+
+Repairing a malfunctioning product without replacing it.
+
+### Replacing
+
+> `readonly` **Replacing**: `"replacing"` = `"replacing"`
+
+Substituting or exchanging an object for another object.
+
+### Reserving
+
+> `readonly` **Reserving**: `"reserving"` = `"reserving"`
+
+Providing a set of not-yet-commissioned instance identifiers for use by another party.
+
+### RetailSelling
+
+> `readonly` **RetailSelling**: `"retail_selling"` = `"retail_selling"`
+
+Point-of-sale activity transferring ownership to a customer for value.
+
+### Shipping
+
+> `readonly` **Shipping**: `"shipping"` = `"shipping"`
+
+Overall process covering staging_outbound, loading, and departing when finer
+detail is unavailable.
+
+### StagingOutbound
+
+> `readonly` **StagingOutbound**: `"staging_outbound"` = `"staging_outbound"`
+
+Moving an object from a facility to an area where it awaits transport pick-up.
+
+### StockTaking
+
+> `readonly` **StockTaking**: `"stock_taking"` = `"stock_taking"`
+
+Counting objects within a location following established rules for accounting purposes.
+
+### Stocking
+
+> `readonly` **Stocking**: `"stocking"` = `"stocking"`
+
+Activity within a location to make an object available to customers or order
+fulfilment.
+
+### Storing
+
+> `readonly` **Storing**: `"storing"` = `"storing"`
+
+Moving an object into and out of storage within a location.
+
+### Transporting
+
+> `readonly` **Transporting**: `"transporting"` = `"transporting"`
+
+Moving an object from one location to another using a vehicle.
+
+### Unloading
+
+> `readonly` **Unloading**: `"unloading"` = `"unloading"`
+
+Unloading an object from a shipping conveyance.
+
+### Unpacking
+
+> `readonly` **Unpacking**: `"unpacking"` = `"unpacking"`
+
+Removing products from a larger container, usually after receiving or
+accepting.
+
+### VoidShipping
+
+> `readonly` **VoidShipping**: `"void_shipping"` = `"void_shipping"`
+
+Declaring that objects in a prior outbound process were not shipped as previously indicated.
+
+### SensorReporting
+
+> `readonly` **SensorReporting**: `"sensor_reporting"` = `"sensor_reporting"`
+
+Returning sensor data about the physical properties or condition of an object or location.
+
+### Sampling
+
+> `readonly` **Sampling**: `"sampling"` = `"sampling"`
+
+Testing activity where portions of an object are examined, rendering the
+sampled object no longer viable.

package/docs/reference/variables/EpcisBizTransactionTypes.md

@@ -0,0 +1,98 @@
+# Variable: EpcisBizTransactionTypes
+
+> `const` **EpcisBizTransactionTypes**: `object`
+
+Supported EPCIS 2.0 `bizTransaction-type` values.
+
+## Type Declaration
+
+### Bol
+
+> `readonly` **Bol**: `"bol"` = `"bol"`
+
+A document issued by a carrier to a shipper, listing and acknowledging receipt
+of goods for transport and specifying terms of delivery.
+
+### Cert
+
+> `readonly` **Cert**: `"cert"` = `"cert"`
+
+A document confirming certain characteristics of an object, person, or
+organisation, typically issued by a third party.
+
+### Desadv
+
+> `readonly` **Desadv**: `"desadv"` = `"desadv"`
+
+A document/message by which the seller or consignor informs the consignee
+about the despatch of goods (Advanced Shipment Notice).
+
+### Inv
+
+> `readonly` **Inv**: `"inv"` = `"inv"`
+
+A document/message claiming payment for goods or services supplied under agreed
+conditions.
+
+### Pedigree
+
+> `readonly` **Pedigree**: `"pedigree"` = `"pedigree"`
+
+A record that traces the ownership or custody and transactions of a product as
+it moves among trading partners.
+
+### Po
+
+> `readonly` **Po**: `"po"` = `"po"`
+
+A document/message that specifies details for goods and services ordered under
+agreed conditions.
+
+### Poc
+
+> `readonly` **Poc**: `"poc"` = `"poc"`
+
+A document that provides confirmation from an external supplier to the request
+of a purchaser to deliver a specified quantity/service.
+
+### Prodorder
+
+> `readonly` **Prodorder**: `"prodorder"` = `"prodorder"`
+
+An organisation-internal document or message issued by a producer that
+initiates a manufacturing process of goods.
+
+### Recadv
+
+> `readonly` **Recadv**: `"recadv"` = `"recadv"`
+
+A document/message that lets the receiver inform the shipper of actual goods
+received compared to what was advised.
+
+### Rma
+
+> `readonly` **Rma**: `"rma"` = `"rma"`
+
+A document issued by the seller that authorises a buyer to return merchandise
+for credit determination.
+
+### Testprd
+
+> `readonly` **Testprd**: `"testprd"` = `"testprd"`
+
+A document that provides a formal specification of a sequence of instructions
+for verifying one or several criteria.
+
+### Testres
+
+> `readonly` **Testres**: `"testres"` = `"testres"`
+
+A document that includes the outcome of the execution of a given test
+procedure.
+
+### Upevt
+
+> `readonly` **Upevt**: `"upevt"` = `"upevt"`
+
+Event ID URI(s) of event(s) provided by an upstream supplier, such as packing
+and shipping events.

package/docs/reference/variables/EpcisComponentTypes.md

@@ -0,0 +1,102 @@
+# Variable: EpcisComponentTypes
+
+> `const` **EpcisComponentTypes**: `object`
+
+Supported EPCIS 2.0 `component` values.
+
+## Type Declaration
+
+### X
+
+> `readonly` **X**: `"x"` = `"x"`
+
+Component or projection along the x axis in Cartesian coordinates (X, Y, Z).
+
+### Y
+
+> `readonly` **Y**: `"y"` = `"y"`
+
+Component or projection along the y axis in Cartesian coordinates (X, Y, Z).
+
+### Z
+
+> `readonly` **Z**: `"z"` = `"z"`
+
+Component or projection along the z axis in Cartesian coordinates (X, Y, Z).
+
+### AxialDistance
+
+> `readonly` **AxialDistance**: `"axial_distance"` = `"axial_distance"`
+
+Radial distance from the cylindrical axis in a cylindrical polar coordinate
+system.
+
+### Azimuth
+
+> `readonly` **Azimuth**: `"azimuth"` = `"azimuth"`
+
+Angle measured in the XY plane, anticlockwise from the X axis to the plane
+containing the vector and the Z axis.
+
+### Height
+
+> `readonly` **Height**: `"height"` = `"height"`
+
+Height parallel to the cylindrical axis in a cylindrical polar coordinate
+system.
+
+### SphericalRadius
+
+> `readonly` **SphericalRadius**: `"spherical_radius"` = `"spherical_radius"`
+
+Radial distance from the centre of a sphere in a spherical polar coordinate
+system.
+
+### PolarAngle
+
+> `readonly` **PolarAngle**: `"polar_angle"` = `"polar_angle"`
+
+Angle measured from the Z axis to the vector in a spherical polar coordinate
+system.
+
+### ElevationAngle
+
+> `readonly` **ElevationAngle**: `"elevation_angle"` = `"elevation_angle"`
+
+Angle measured from the XY plane to the vector in a spherical polar coordinate
+system.
+
+### Easting
+
+> `readonly` **Easting**: `"easting"` = `"easting"`
+
+Component or projection along an east-pointing axis in a geographic Cartesian
+coordinate system.
+
+### Northing
+
+> `readonly` **Northing**: `"northing"` = `"northing"`
+
+Component or projection along a north-pointing axis in a geographic Cartesian
+coordinate system.
+
+### Latitude
+
+> `readonly` **Latitude**: `"latitude"` = `"latitude"`
+
+Angle of elevation from the equatorial plane in a geographic coordinate
+system.
+
+### Longitude
+
+> `readonly` **Longitude**: `"longitude"` = `"longitude"`
+
+Angle, measured within the equatorial plane, east of the prime meridian in a
+geographic coordinate system.
+
+### Altitude
+
+> `readonly` **Altitude**: `"altitude"` = `"altitude"`
+
+Height above a defined surface (such as mean sea level) in a geographic
+coordinate system.

package/docs/reference/variables/EpcisContexts.md

@@ -0,0 +1,19 @@
+# Variable: EpcisContexts
+
+> `const` **EpcisContexts**: `object`
+
+Canonical EPCIS JSON-LD context IRIs as defined by GS1.
+
+## Type Declaration
+
+### Namespace
+
+> `readonly` **Namespace**: `"https://ref.gs1.org/epcis/"` = `"https://ref.gs1.org/epcis/"`
+
+The namespace for the objects.
+
+### JsonLdContext
+
+> `readonly` **JsonLdContext**: `"https://ref.gs1.org/standards/epcis/2.0.0/epcis-context.jsonld"` = `"https://ref.gs1.org/standards/epcis/2.0.0/epcis-context.jsonld"`
+
+The JSON-LD Context URL.

package/docs/reference/variables/{DispositionTypes.md → EpcisDispositionTypes.md}

@@ -1,10 +1,12 @@
-# Variable: DispositionTypes
+# Variable: EpcisDispositionTypes
 
-> `const` **DispositionTypes**: `object`
+> `const` **EpcisDispositionTypes**: `object`
 
-EPCIS 2.0 disposition types.
+Supported EPCIS 2.0 `disposition` values from the GS1 Core Business
+Vocabulary (CBV).
 
-See EPCIS CVB for more details.
+Use the union type `EpcisDispositionTypes` to restrict a field to known CBV
+values.
 
 ## Type Declaration
 
@@ -12,130 +14,205 @@ See EPCIS CVB for more details.
 
 > `readonly` **Active**: `"active"` = `"active"`
 
+A commissioned object has just been introduced into the supply chain.
+
 ### ContainerClosed
 
 > `readonly` **ContainerClosed**: `"container_closed"` = `"container_closed"`
 
+Object has been loaded onto a container, the doors closed, and the shipment
+sealed.
+
 ### Damaged
 
 > `readonly` **Damaged**: `"damaged"` = `"damaged"`
 
+Object is impaired in usefulness or value due to a defect.
+
 ### Destroyed
 
 > `readonly` **Destroyed**: `"destroyed"` = `"destroyed"`
 
+Object has been fully rendered non-usable.
+
 ### Dispensed
 
 > `readonly` **Dispensed**: `"dispensed"` = `"dispensed"`
 
+A full quantity of product is distributed to a consumer.
+
 ### Disposed
 
 > `readonly` **Disposed**: `"disposed"` = `"disposed"`
 
+Object has been returned for disposal.
+
 ### Encoded
 
 > `readonly` **Encoded**: `"encoded"` = `"encoded"`
 
+An instance-level identifier has been written to a barcode or RFID tag, but
+not yet commissioned.
+
 ### Expired
 
 > `readonly` **Expired**: `"expired"` = `"expired"`
 
+Object's expiration date is in the past.
+
 ### InProgress
 
 > `readonly` **InProgress**: `"in_progress"` = `"in_progress"`
 
+Optional disposition for objects proceeding through points in the supply
+chain.
+
 ### InTransit
 
 > `readonly` **InTransit**: `"in_transit"` = `"in_transit"`
 
+Object is being shipped between two trading partners.
+
 ### Inactive
 
 > `readonly` **Inactive**: `"inactive"` = `"inactive"`
 
+Decommissioned object that may be reintroduced to the supply chain.
+
 ### NoPedigreeMatch
 
 > `readonly` **NoPedigreeMatch**: `"no_pedigree_match"` = `"no_pedigree_match"`
 
+No pedigree match was found during validation, so the product is quarantined
+for investigation.
+
 ### NonSellableOther
 
 > `readonly` **NonSellableOther**: `"non_sellable_other"` = `"non_sellable_other"`
 
+Object cannot be sold to a customer.
+
 ### PartiallyDispensed
 
 > `readonly` **PartiallyDispensed**: `"partially_dispensed"` = `"partially_dispensed"`
 
+A portion of a product is distributed to a customer while additional product
+is retained.
+
 ### Recalled
 
 > `readonly` **Recalled**: `"recalled"` = `"recalled"`
 
+Object is non-sellable because of public safety reasons.
+
 ### Reserved
 
 > `readonly` **Reserved**: `"reserved"` = `"reserved"`
 
+Instance-level identifier has been allocated for a third party.
+
 ### RetailSold
 
 > `readonly` **RetailSold**: `"retail_sold"` = `"retail_sold"`
 
+Product has been purchased by a customer.
+
 ### Returned
 
 > `readonly` **Returned**: `"returned"` = `"returned"`
 
+Object has been sent or brought back for various reasons; it may or may not
+be sellable.
+
 ### SellableAccessible
 
 > `readonly` **SellableAccessible**: `"sellable_accessible"` = `"sellable_accessible"`
 
+Product can be sold as is and a customer can access it for purchase.
+
 ### SellableNotAccessible
 
 > `readonly` **SellableNotAccessible**: `"sellable_not_accessible"` = `"sellable_not_accessible"`
 
+Product can be sold as is, but a customer cannot access it for purchase.
+
 ### Stolen
 
 > `readonly` **Stolen**: `"stolen"` = `"stolen"`
 
+An object has been taken without permission or right.
+
 ### Unknown
 
 > `readonly` **Unknown**: `"unknown"` = `"unknown"`
 
+An object's condition is not known.
+
 ### Available
 
 > `readonly` **Available**: `"available"` = `"available"`
 
+Object has been returned to service or the supply chain after repair.
+
 ### CompletenessVerified
 
 > `readonly` **CompletenessVerified**: `"completeness_verified"` = `"completeness_verified"`
 
+Explicitly indicates verified integrity of an aggregation when children are
+unpacked or verified.
+
 ### CompletenessInferred
 
 > `readonly` **CompletenessInferred**: `"completeness_inferred"` = `"completeness_inferred"`
 
+Indicates inferred integrity of an aggregation based on upstream aggregation
+information.
+
 ### Conformant
 
 > `readonly` **Conformant**: `"conformant"` = `"conformant"`
 
+Outcome of a successful inspection in an inspecting or repairing step.
+
 ### ContainerOpen
 
 > `readonly` **ContainerOpen**: `"container_open"` = `"container_open"`
 
+Container doors have been opened or a shipment seal has been broken.
+
 ### MismatchInstance
 
 > `readonly` **MismatchInstance**: `"mismatch_instance"` = `"mismatch_instance"`
 
+Instance-level identifiers do not match what was expected.
+
 ### MismatchClass
 
 > `readonly` **MismatchClass**: `"mismatch_class"` = `"mismatch_class"`
 
+Class-level identifiers do not match what was expected.
+
 ### MismatchQuantity
 
 > `readonly` **MismatchQuantity**: `"mismatch_quantity"` = `"mismatch_quantity"`
 
+Quantities do not match what was expected.
+
 ### NeedsReplacement
 
 > `readonly` **NeedsReplacement**: `"needs_replacement"` = `"needs_replacement"`
 
+Components or assets must be replaced to ensure functional requirements.
+
 ### NonConformant
 
 > `readonly` **NonConformant**: `"non_conformant"` = `"non_conformant"`
 
+Outcome of an unsuccessful inspection in an inspecting or repairing step.
+
 ### Unavailable
 
 > `readonly` **Unavailable**: `"unavailable"` = `"unavailable"`
+
+Object has been removed from service or the supply chain, for example pending
+repair.