@twin.org/standards-gs1 0.0.3-next.2 → 0.0.3-next.20

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.

package/docs/reference/variables/EpcisErrorReasonTypes.md

@@ -0,0 +1,21 @@
+# Variable: EpcisErrorReasonTypes
+
+> `const` **EpcisErrorReasonTypes**: `object`
+
+Supported EPCIS 2.0 `error-reason` values from the GS1 EPCIS JSON Schema.
+
+## Type Declaration
+
+### DidNotOccur
+
+> `readonly` **DidNotOccur**: `"did_not_occur"` = `"did_not_occur"`
+
+Prior event is erroneous because it did not actually occur; no corrective
+events exist.
+
+### IncorrectData
+
+> `readonly` **IncorrectData**: `"incorrect_data"` = `"incorrect_data"`
+
+Prior event has incorrect data and may be corrected by subsequent linked
+events.

package/docs/reference/variables/{EventTypes.md → EpcisEventTypes.md}

@@ -1,8 +1,8 @@
-# Variable: EventTypes
+# Variable: EpcisEventTypes
 
-> `const` **EventTypes**: `object`
+> `const` **EpcisEventTypes**: `object`
 
-EPCIS 2.0 event types.
+EPCIS 2.0 event type identifiers used in EPCIS JSON and XML documents.
 
 ## Type Declaration
 
@@ -10,28 +10,28 @@ EPCIS 2.0 event types.
 
 > `readonly` **ObjectEvent**: `"ObjectEvent"` = `"ObjectEvent"`
 
-ObjectEvent.
+Event that observes one or more instance- or class-level objects.
 
 ### AggregationEvent
 
 > `readonly` **AggregationEvent**: `"AggregationEvent"` = `"AggregationEvent"`
 
-Aggregation Event.
+Event recording child objects aggregated under a parent identifier.
 
 ### AssociationEvent
 
 > `readonly` **AssociationEvent**: `"AssociationEvent"` = `"AssociationEvent"`
 
-Association Event.
+Event recording parent/child associations without implying containment.
 
 ### TransformationEvent
 
 > `readonly` **TransformationEvent**: `"TransformationEvent"` = `"TransformationEvent"`
 
-Transformation Event.
+Event recording how inputs are transformed into outputs.
 
 ### TransactionEvent
 
 > `readonly` **TransactionEvent**: `"TransactionEvent"` = `"TransactionEvent"`
 
-Transaction Event.
+Event linking objects or quantities to business transactions.