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

package/docs/reference/variables/EpcisDispositionTypes.md

@@ -2,140 +2,217 @@
 
 > `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
 
-### Active
+### Active {#active}
 
 > `readonly` **Active**: `"active"` = `"active"`
 
-### ContainerClosed
+A commissioned object has just been introduced into the supply chain.
+
+### ContainerClosed {#containerclosed}
 
 > `readonly` **ContainerClosed**: `"container_closed"` = `"container_closed"`
 
-### Damaged
+Object has been loaded onto a container, the doors closed, and the shipment
+sealed.
+
+### Damaged {#damaged}
 
 > `readonly` **Damaged**: `"damaged"` = `"damaged"`
 
-### Destroyed
+Object is impaired in usefulness or value due to a defect.
+
+### Destroyed {#destroyed}
 
 > `readonly` **Destroyed**: `"destroyed"` = `"destroyed"`
 
-### Dispensed
+Object has been fully rendered non-usable.
+
+### Dispensed {#dispensed}
 
 > `readonly` **Dispensed**: `"dispensed"` = `"dispensed"`
 
-### Disposed
+A full quantity of product is distributed to a consumer.
+
+### Disposed {#disposed}
 
 > `readonly` **Disposed**: `"disposed"` = `"disposed"`
 
-### Encoded
+Object has been returned for disposal.
+
+### Encoded {#encoded}
 
 > `readonly` **Encoded**: `"encoded"` = `"encoded"`
 
-### Expired
+An instance-level identifier has been written to a barcode or RFID tag, but
+not yet commissioned.
+
+### Expired {#expired}
 
 > `readonly` **Expired**: `"expired"` = `"expired"`
 
-### InProgress
+Object's expiration date is in the past.
+
+### InProgress {#inprogress}
 
 > `readonly` **InProgress**: `"in_progress"` = `"in_progress"`
 
-### InTransit
+Optional disposition for objects proceeding through points in the supply
+chain.
+
+### InTransit {#intransit}
 
 > `readonly` **InTransit**: `"in_transit"` = `"in_transit"`
 
-### Inactive
+Object is being shipped between two trading partners.
+
+### Inactive {#inactive}
 
 > `readonly` **Inactive**: `"inactive"` = `"inactive"`
 
-### NoPedigreeMatch
+Decommissioned object that may be reintroduced to the supply chain.
+
+### NoPedigreeMatch {#nopedigreematch}
 
 > `readonly` **NoPedigreeMatch**: `"no_pedigree_match"` = `"no_pedigree_match"`
 
-### NonSellableOther
+No pedigree match was found during validation, so the product is quarantined
+for investigation.
+
+### NonSellableOther {#nonsellableother}
 
 > `readonly` **NonSellableOther**: `"non_sellable_other"` = `"non_sellable_other"`
 
-### PartiallyDispensed
+Object cannot be sold to a customer.
+
+### PartiallyDispensed {#partiallydispensed}
 
 > `readonly` **PartiallyDispensed**: `"partially_dispensed"` = `"partially_dispensed"`
 
-### Recalled
+A portion of a product is distributed to a customer while additional product
+is retained.
+
+### Recalled {#recalled}
 
 > `readonly` **Recalled**: `"recalled"` = `"recalled"`
 
-### Reserved
+Object is non-sellable because of public safety reasons.
+
+### Reserved {#reserved}
 
 > `readonly` **Reserved**: `"reserved"` = `"reserved"`
 
-### RetailSold
+Instance-level identifier has been allocated for a third party.
+
+### RetailSold {#retailsold}
 
 > `readonly` **RetailSold**: `"retail_sold"` = `"retail_sold"`
 
-### Returned
+Product has been purchased by a customer.
+
+### Returned {#returned}
 
 > `readonly` **Returned**: `"returned"` = `"returned"`
 
-### SellableAccessible
+Object has been sent or brought back for various reasons; it may or may not
+be sellable.
+
+### SellableAccessible {#sellableaccessible}
 
 > `readonly` **SellableAccessible**: `"sellable_accessible"` = `"sellable_accessible"`
 
-### SellableNotAccessible
+Product can be sold as is and a customer can access it for purchase.
+
+### SellableNotAccessible {#sellablenotaccessible}
 
 > `readonly` **SellableNotAccessible**: `"sellable_not_accessible"` = `"sellable_not_accessible"`
 
-### Stolen
+Product can be sold as is, but a customer cannot access it for purchase.
+
+### Stolen {#stolen}
 
 > `readonly` **Stolen**: `"stolen"` = `"stolen"`
 
-### Unknown
+An object has been taken without permission or right.
+
+### Unknown {#unknown}
 
 > `readonly` **Unknown**: `"unknown"` = `"unknown"`
 
-### Available
+An object's condition is not known.
+
+### Available {#available}
 
 > `readonly` **Available**: `"available"` = `"available"`
 
-### CompletenessVerified
+Object has been returned to service or the supply chain after repair.
+
+### CompletenessVerified {#completenessverified}
 
 > `readonly` **CompletenessVerified**: `"completeness_verified"` = `"completeness_verified"`
 
-### CompletenessInferred
+Explicitly indicates verified integrity of an aggregation when children are
+unpacked or verified.
+
+### CompletenessInferred {#completenessinferred}
 
 > `readonly` **CompletenessInferred**: `"completeness_inferred"` = `"completeness_inferred"`
 
-### Conformant
+Indicates inferred integrity of an aggregation based on upstream aggregation
+information.
+
+### Conformant {#conformant}
 
 > `readonly` **Conformant**: `"conformant"` = `"conformant"`
 
-### ContainerOpen
+Outcome of a successful inspection in an inspecting or repairing step.
+
+### ContainerOpen {#containeropen}
 
 > `readonly` **ContainerOpen**: `"container_open"` = `"container_open"`
 
-### MismatchInstance
+Container doors have been opened or a shipment seal has been broken.
+
+### MismatchInstance {#mismatchinstance}
 
 > `readonly` **MismatchInstance**: `"mismatch_instance"` = `"mismatch_instance"`
 
-### MismatchClass
+Instance-level identifiers do not match what was expected.
+
+### MismatchClass {#mismatchclass}
 
 > `readonly` **MismatchClass**: `"mismatch_class"` = `"mismatch_class"`
 
-### MismatchQuantity
+Class-level identifiers do not match what was expected.
+
+### MismatchQuantity {#mismatchquantity}
 
 > `readonly` **MismatchQuantity**: `"mismatch_quantity"` = `"mismatch_quantity"`
 
-### NeedsReplacement
+Quantities do not match what was expected.
+
+### NeedsReplacement {#needsreplacement}
 
 > `readonly` **NeedsReplacement**: `"needs_replacement"` = `"needs_replacement"`
 
-### NonConformant
+Components or assets must be replaced to ensure functional requirements.
+
+### NonConformant {#nonconformant}
 
 > `readonly` **NonConformant**: `"non_conformant"` = `"non_conformant"`
 
-### Unavailable
+Outcome of an unsuccessful inspection in an inspecting or repairing step.
+
+### Unavailable {#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 {#didnotoccur}
+
+> `readonly` **DidNotOccur**: `"did_not_occur"` = `"did_not_occur"`
+
+Prior event is erroneous because it did not actually occur; no corrective
+events exist.
+
+### IncorrectData {#incorrectdata}
+
+> `readonly` **IncorrectData**: `"incorrect_data"` = `"incorrect_data"`
+
+Prior event has incorrect data and may be corrected by subsequent linked
+events.

package/docs/reference/variables/EpcisEventTypes.md

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