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

package/docs/reference/variables/EpcisBizStepTypes.md

@@ -2,172 +2,269 @@
 
 > `const` **EpcisBizStepTypes**: `object`
 
-Supported EPCIS 2.0 bizStep.
+Supported EPCIS 2.0 `bizStep` values.
 
-See EPCIS CVB specification for details.
+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
+### Accepting {#accepting}
 
 > `readonly` **Accepting**: `"accepting"` = `"accepting"`
 
-### Arriving
+Activity where an object changes possession and/or ownership.
+
+### Arriving {#arriving}
 
 > `readonly` **Arriving**: `"arriving"` = `"arriving"`
 
-### Assembling
+Activity where an object arrives at a location.
+
+### Assembling {#assembling}
 
 > `readonly` **Assembling**: `"assembling"` = `"assembling"`
 
-### Collecting
+Combining one or more objects to create a new finished product while originals
+remain recognisable.
+
+### Collecting {#collecting}
 
 > `readonly` **Collecting**: `"collecting"` = `"collecting"`
 
-### Commissioning
+Picking up and collecting an object for future disposal, recycling, or re-use.
+
+### Commissioning {#commissioning}
 
 > `readonly` **Commissioning**: `"commissioning"` = `"commissioning"`
 
-### Consigning
+Associating a new instance- or class-level identifier with a specific object
+for the first time.
+
+### Consigning {#consigning}
 
 > `readonly` **Consigning**: `"consigning"` = `"consigning"`
 
-### CreatingClassInstance
+Overall process covering staging_outbound, loading, departing, and accepting
+when granular steps are unknown.
+
+### CreatingClassInstance {#creatingclassinstance}
 
 > `readonly` **CreatingClassInstance**: `"creating_class_instance"` = `"creating_class_instance"`
 
-### CycleCounting
+Step where an instance or increased quantity of a class-level identifier is
+produced and may repeat.
+
+### CycleCounting {#cyclecounting}
 
 > `readonly` **CycleCounting**: `"cycle_counting"` = `"cycle_counting"`
 
-### Decommissioning
+Counting objects within a location for business needs other than accounting.
+
+### Decommissioning {#decommissioning}
 
 > `readonly` **Decommissioning**: `"decommissioning"` = `"decommissioning"`
 
-### Departing
+Disassociating an instance-level identifier from an object; it may be
+re-commissioned later with a new identifier.
+
+### Departing {#departing}
 
 > `readonly` **Departing**: `"departing"` = `"departing"`
 
-### Destroying
+Activity where an object leaves a location on its way to a destination.
+
+### Destroying {#destroying}
 
 > `readonly` **Destroying**: `"destroying"` = `"destroying"`
 
-### Disassembling
+Process of terminating an object so it should not be subject of subsequent events.
+
+### Disassembling {#disassembling}
 
 > `readonly` **Disassembling**: `"disassembling"` = `"disassembling"`
 
-### Dispensing
+Breaking down an object into separate, uniquely identified component parts.
+
+### Dispensing {#dispensing}
 
 > `readonly` **Dispensing**: `"dispensing"` = `"dispensing"`
 
-### Encoding
+Making a product available in full or part to a consumer.
+
+### Encoding {#encoding}
 
 > `readonly` **Encoding**: `"encoding"` = `"encoding"`
 
-### EnteringExiting
+Writing an instance-level identifier to a barcode or RFID tag before
+association with an object.
+
+### EnteringExiting {#enteringexiting}
 
 > `readonly` **EnteringExiting**: `"entering_exiting"` = `"entering_exiting"`
 
-### Holding
+Activity at a facility entrance/exit where customers leave with purchases or
+enter with returns.
+
+### Holding {#holding}
 
 > `readonly` **Holding**: `"holding"` = `"holding"`
 
-### Inspecting
+Segregating an object for further review.
+
+### Inspecting {#inspecting}
 
 > `readonly` **Inspecting**: `"inspecting"` = `"inspecting"`
 
-### Installing
+Reviewing objects to address potential defects while keeping them viable in the
+supply chain.
+
+### Installing {#installing}
 
 > `readonly` **Installing**: `"installing"` = `"installing"`
 
-### Killing
+Putting an object into a composite object that already exists.
+
+### Killing {#killing}
 
 > `readonly` **Killing**: `"killing"` = `"killing"`
 
-### Loading
+Terminating an RFID tag previously associated with an object while the object
+continues to exist.
+
+### Loading {#loading}
 
 > `readonly` **Loading**: `"loading"` = `"loading"`
 
-### Other
+Loading an object into a shipping conveyance.
+
+### Other {#other}
 
 > `readonly` **Other**: `"other"` = `"other"`
 
-### Packing
+A business step not identified by the CBV list.
+
+### Packing {#packing}
 
 > `readonly` **Packing**: `"packing"` = `"packing"`
 
-### Picking
+Putting objects into a larger container for shipping, typically where
+aggregation occurs.
+
+### Picking {#picking}
 
 > `readonly` **Picking**: `"picking"` = `"picking"`
 
-### Receiving
+Selecting objects to fill an order.
+
+### Receiving {#receiving}
 
 > `readonly` **Receiving**: `"receiving"` = `"receiving"`
 
-### Removing
+Indicating an object is being received at a location and added to inventory.
+
+### Removing {#removing}
 
 > `readonly` **Removing**: `"removing"` = `"removing"`
 
-### Repackaging
+Taking an object out of a composite object; opposite of installing.
+
+### Repackaging {#repackaging}
 
 > `readonly` **Repackaging**: `"repackaging"` = `"repackaging"`
 
-### Repairing
+Changing an object's packaging configuration.
+
+### Repairing {#repairing}
 
 > `readonly` **Repairing**: `"repairing"` = `"repairing"`
 
-### Replacing
+Repairing a malfunctioning product without replacing it.
+
+### Replacing {#replacing}
 
 > `readonly` **Replacing**: `"replacing"` = `"replacing"`
 
-### Reserving
+Substituting or exchanging an object for another object.
+
+### Reserving {#reserving}
 
 > `readonly` **Reserving**: `"reserving"` = `"reserving"`
 
-### RetailSelling
+Providing a set of not-yet-commissioned instance identifiers for use by another party.
+
+### RetailSelling {#retailselling}
 
 > `readonly` **RetailSelling**: `"retail_selling"` = `"retail_selling"`
 
-### Shipping
+Point-of-sale activity transferring ownership to a customer for value.
+
+### Shipping {#shipping}
 
 > `readonly` **Shipping**: `"shipping"` = `"shipping"`
 
-### StagingOutbound
+Overall process covering staging_outbound, loading, and departing when finer
+detail is unavailable.
+
+### StagingOutbound {#stagingoutbound}
 
 > `readonly` **StagingOutbound**: `"staging_outbound"` = `"staging_outbound"`
 
-### StockTaking
+Moving an object from a facility to an area where it awaits transport pick-up.
+
+### StockTaking {#stocktaking}
 
 > `readonly` **StockTaking**: `"stock_taking"` = `"stock_taking"`
 
-### Stocking
+Counting objects within a location following established rules for accounting purposes.
+
+### Stocking {#stocking}
 
 > `readonly` **Stocking**: `"stocking"` = `"stocking"`
 
-### Storing
+Activity within a location to make an object available to customers or order
+fulfilment.
+
+### Storing {#storing}
 
 > `readonly` **Storing**: `"storing"` = `"storing"`
 
-### Transporting
+Moving an object into and out of storage within a location.
+
+### Transporting {#transporting}
 
 > `readonly` **Transporting**: `"transporting"` = `"transporting"`
 
-### Unloading
+Moving an object from one location to another using a vehicle.
+
+### Unloading {#unloading}
 
 > `readonly` **Unloading**: `"unloading"` = `"unloading"`
 
-### Unpacking
+Unloading an object from a shipping conveyance.
+
+### Unpacking {#unpacking}
 
 > `readonly` **Unpacking**: `"unpacking"` = `"unpacking"`
 
-### VoidShipping
+Removing products from a larger container, usually after receiving or
+accepting.
+
+### VoidShipping {#voidshipping}
 
 > `readonly` **VoidShipping**: `"void_shipping"` = `"void_shipping"`
 
-### SensorReporting
+Declaring that objects in a prior outbound process were not shipped as previously indicated.
+
+### SensorReporting {#sensorreporting}
 
 > `readonly` **SensorReporting**: `"sensor_reporting"` = `"sensor_reporting"`
 
-### Sampling
+Returning sensor data about the physical properties or condition of an object or location.
+
+### Sampling {#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 {#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 {#cert}
+
+> `readonly` **Cert**: `"cert"` = `"cert"`
+
+A document confirming certain characteristics of an object, person, or
+organisation, typically issued by a third party.
+
+### Desadv {#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 {#inv}
+
+> `readonly` **Inv**: `"inv"` = `"inv"`
+
+A document/message claiming payment for goods or services supplied under agreed
+conditions.
+
+### Pedigree {#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 {#po}
+
+> `readonly` **Po**: `"po"` = `"po"`
+
+A document/message that specifies details for goods and services ordered under
+agreed conditions.
+
+### Poc {#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 {#prodorder}
+
+> `readonly` **Prodorder**: `"prodorder"` = `"prodorder"`
+
+An organisation-internal document or message issued by a producer that
+initiates a manufacturing process of goods.
+
+### Recadv {#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 {#rma}
+
+> `readonly` **Rma**: `"rma"` = `"rma"`
+
+A document issued by the seller that authorises a buyer to return merchandise
+for credit determination.
+
+### Testprd {#testprd}
+
+> `readonly` **Testprd**: `"testprd"` = `"testprd"`
+
+A document that provides a formal specification of a sequence of instructions
+for verifying one or several criteria.
+
+### Testres {#testres}
+
+> `readonly` **Testres**: `"testres"` = `"testres"`
+
+A document that includes the outcome of the execution of a given test
+procedure.
+
+### Upevt {#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 {#x}
+
+> `readonly` **X**: `"x"` = `"x"`
+
+Component or projection along the x axis in Cartesian coordinates (X, Y, Z).
+
+### Y {#y}
+
+> `readonly` **Y**: `"y"` = `"y"`
+
+Component or projection along the y axis in Cartesian coordinates (X, Y, Z).
+
+### Z {#z}
+
+> `readonly` **Z**: `"z"` = `"z"`
+
+Component or projection along the z axis in Cartesian coordinates (X, Y, Z).
+
+### AxialDistance {#axialdistance}
+
+> `readonly` **AxialDistance**: `"axial_distance"` = `"axial_distance"`
+
+Radial distance from the cylindrical axis in a cylindrical polar coordinate
+system.
+
+### Azimuth {#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 {#height}
+
+> `readonly` **Height**: `"height"` = `"height"`
+
+Height parallel to the cylindrical axis in a cylindrical polar coordinate
+system.
+
+### SphericalRadius {#sphericalradius}
+
+> `readonly` **SphericalRadius**: `"spherical_radius"` = `"spherical_radius"`
+
+Radial distance from the centre of a sphere in a spherical polar coordinate
+system.
+
+### PolarAngle {#polarangle}
+
+> `readonly` **PolarAngle**: `"polar_angle"` = `"polar_angle"`
+
+Angle measured from the Z axis to the vector in a spherical polar coordinate
+system.
+
+### ElevationAngle {#elevationangle}
+
+> `readonly` **ElevationAngle**: `"elevation_angle"` = `"elevation_angle"`
+
+Angle measured from the XY plane to the vector in a spherical polar coordinate
+system.
+
+### Easting {#easting}
+
+> `readonly` **Easting**: `"easting"` = `"easting"`
+
+Component or projection along an east-pointing axis in a geographic Cartesian
+coordinate system.
+
+### Northing {#northing}
+
+> `readonly` **Northing**: `"northing"` = `"northing"`
+
+Component or projection along a north-pointing axis in a geographic Cartesian
+coordinate system.
+
+### Latitude {#latitude}
+
+> `readonly` **Latitude**: `"latitude"` = `"latitude"`
+
+Angle of elevation from the equatorial plane in a geographic coordinate
+system.
+
+### Longitude {#longitude}
+
+> `readonly` **Longitude**: `"longitude"` = `"longitude"`
+
+Angle, measured within the equatorial plane, east of the prime meridian in a
+geographic coordinate system.
+
+### Altitude {#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,33 @@
+# Variable: EpcisContexts
+
+> `const` **EpcisContexts**: `object`
+
+Canonical EPCIS JSON-LD context IRIs as defined by GS1.
+
+## Type Declaration
+
+### Namespace {#namespace}
+
+> `readonly` **Namespace**: `"https://ref.gs1.org/epcis/"` = `"https://ref.gs1.org/epcis/"`
+
+The canonical RDF namespace URI.
+
+### Context {#context}
+
+> `readonly` **Context**: `"https://ref.gs1.org/epcis"` = `"https://ref.gs1.org/epcis"`
+
+The value to use in JSON-LD context.
+Note: Context differs from Namespace (no trailing slash) as per GS1 EPCIS standard specification.
+The EPCIS JSON-LD context URL format does not include a trailing slash.
+
+### JsonLdContext {#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.
+
+### JsonSchemaNamespace {#jsonschemanamespace}
+
+> `readonly` **JsonSchemaNamespace**: `"https://schema.twindev.org/gs1/"` = `"https://schema.twindev.org/gs1/"`
+
+The namespace location of the hosted version of the JSON Schema.