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

package/docs/reference/interfaces/IEpcisTransformationEvent.md

@@ -0,0 +1,245 @@
+# Interface: IEpcisTransformationEvent
+
+EPCIS 2.0 TransformationEvent describing how inputs are transformed into
+outputs during a business process.
+
+## See
+
+https://ref.gs1.org/epcis/TransformationEvent
+
+## Extends
+
+- [`IEpcisEvent`](IEpcisEvent.md)
+
+## Properties
+
+### @context {#context}
+
+> **@context**: [`EpcisContextType`](../type-aliases/EpcisContextType.md)
+
+JSON-LD @context.
+
+#### Inherited from
+
+[`IEpcisEvent`](IEpcisEvent.md).[`@context`](IEpcisEvent.md#context)
+
+***
+
+### eventID? {#eventid}
+
+> `optional` **eventID?**: `string`
+
+URI identifier of a specific EPCIS event (alias of id in JSON or XML).
+
+#### Inherited from
+
+[`IEpcisEvent`](IEpcisEvent.md).[`eventID`](IEpcisEvent.md#eventid)
+
+***
+
+### certificationInfo? {#certificationinfo}
+
+> `optional` **certificationInfo?**: `ObjectOrArray`\<`string`\>
+
+(Optional) CertificationDetails relevant for Objects, Places and/or
+Organizations mentioned in this Event.
+
+#### Inherited from
+
+[`IEpcisEvent`](IEpcisEvent.md).[`certificationInfo`](IEpcisEvent.md#certificationinfo)
+
+***
+
+### errorDeclaration? {#errordeclaration}
+
+> `optional` **errorDeclaration?**: [`IEpcisErrorDeclaration`](IEpcisErrorDeclaration.md)
+
+Error declaration.
+
+#### Inherited from
+
+[`IEpcisEvent`](IEpcisEvent.md).[`errorDeclaration`](IEpcisEvent.md#errordeclaration)
+
+***
+
+### eventTime {#eventtime}
+
+> **eventTime**: `string`
+
+The date and time at which the EPCIS Capturing Applications asserts the event
+occurred.
+
+#### Inherited from
+
+[`IEpcisEvent`](IEpcisEvent.md).[`eventTime`](IEpcisEvent.md#eventtime)
+
+***
+
+### eventTimeZoneOffset {#eventtimezoneoffset}
+
+> **eventTimeZoneOffset**: `string`
+
+The time zone offset in effect at the time and place the event occurred,
+expressed as an offset from UTC.
+
+#### Inherited from
+
+[`IEpcisEvent`](IEpcisEvent.md).[`eventTimeZoneOffset`](IEpcisEvent.md#eventtimezoneoffset)
+
+***
+
+### recordTime? {#recordtime}
+
+> `optional` **recordTime?**: `string`
+
+(Optional) The date and time at which this event was recorded by an EPCIS
+Repository; ignored at capture and present on query results.
+
+#### Inherited from
+
+[`IEpcisEvent`](IEpcisEvent.md).[`recordTime`](IEpcisEvent.md#recordtime)
+
+***
+
+### type {#type}
+
+> **type**: `"TransformationEvent"`
+
+Fixed to TransformationEvent.
+
+#### Overrides
+
+[`IEpcisEvent`](IEpcisEvent.md).[`type`](IEpcisEvent.md#type)
+
+***
+
+### inputEPCList? {#inputepclist}
+
+> `optional` **inputEPCList?**: `string`[]
+
+(Optional) Unordered list of one or more EPCs identifying (at the instance
+level) objects that were inputs to the transformation.
+
+***
+
+### inputQuantityList? {#inputquantitylist}
+
+> `optional` **inputQuantityList?**: [`IEpcisQuantity`](IEpcisQuantity.md)[]
+
+(Optional) Unordered list of one or more QuantityElements identifying
+class-level inputs; may be omitted subject to the EPCIS quantity-list
+constraints.
+
+***
+
+### outputEPCList? {#outputepclist}
+
+> `optional` **outputEPCList?**: `string`[]
+
+(Optional) Unordered list of one or more EPCs naming (at the instance level)
+objects that were outputs from the transformation.
+
+***
+
+### outputQuantityList? {#outputquantitylist}
+
+> `optional` **outputQuantityList?**: [`IEpcisQuantity`](IEpcisQuantity.md)[]
+
+(Optional) Unordered list of one or more QuantityElements identifying
+class-level outputs; may be omitted subject to the EPCIS quantity-list
+constraints.
+
+***
+
+### transformationID? {#transformationid}
+
+> `optional` **transformationID?**: `string`
+
+A unique identifier linking TransformationEvents; shared values connect inputs
+and outputs across those events.
+
+***
+
+### bizStep? {#bizstep}
+
+> `optional` **bizStep?**: `string`
+
+(Optional) The business step of which this event was a part.
+
+***
+
+### disposition? {#disposition}
+
+> `optional` **disposition?**: `string`
+
+(Optional) The business condition of the objects associated with the EPCs,
+presumed to hold true until contradicted by a subsequent event.
+
+***
+
+### persistentDisposition? {#persistentdisposition}
+
+> `optional` **persistentDisposition?**: [`IEpcisPersistentDisposition`](IEpcisPersistentDisposition.md)
+
+Persistent disposition.
+
+***
+
+### readPoint? {#readpoint}
+
+> `optional` **readPoint?**: [`IEpcisLocation`](IEpcisLocation.md)
+
+(Optional) The read point at which the event took place.
+
+***
+
+### bizLocation? {#bizlocation}
+
+> `optional` **bizLocation?**: [`IEpcisLocation`](IEpcisLocation.md)
+
+(Optional) The business location where the objects associated with the EPCs
+may be found, until contradicted by a subsequent event.
+
+***
+
+### bizTransactionList? {#biztransactionlist}
+
+> `optional` **bizTransactionList?**: [`IEpcisBizTransaction`](IEpcisBizTransaction.md)[]
+
+An unordered list of business transactions that define the context of this
+event.
+
+***
+
+### sourceList? {#sourcelist}
+
+> `optional` **sourceList?**: [`IEpcisSource`](IEpcisSource.md)[]
+
+(Optional) Unordered list of Source elements that provide context about the
+originating endpoint of a business transfer of which this event is a part.
+
+***
+
+### destinationList? {#destinationlist}
+
+> `optional` **destinationList?**: [`IEpcisDestination`](IEpcisDestination.md)[]
+
+(Optional) Unordered list of Destination elements that provide context about
+the terminating endpoint of a business transfer of which this event is a part.
+
+***
+
+### sensorElementList? {#sensorelementlist}
+
+> `optional` **sensorElementList?**: [`IEpcisSensorElement`](IEpcisSensorElement.md)[]
+
+(Optional) Connects event to one or more SensorElements.
+
+***
+
+### ilmd? {#ilmd}
+
+> `optional` **ilmd?**: [`IEpcisIlmd`](IEpcisIlmd.md)
+
+(Optional) Instance/Lot master data that describes the objects created during
+this event.

package/docs/reference/interfaces/IEpcisVocabulary.md

@@ -0,0 +1,23 @@
+# Interface: IEpcisVocabulary
+
+EPCIS 2.0 Vocabulary container that groups related vocabulary elements.
+
+## See
+
+https://ref.gs1.org/epcis/Vocabulary
+
+## Properties
+
+### type {#type}
+
+> **type**: `string`
+
+Vocabulary type.
+
+***
+
+### vocabularyElementList? {#vocabularyelementlist}
+
+> `optional` **vocabularyElementList?**: [`IEpcisVocabularyElement`](IEpcisVocabularyElement.md)[]
+
+List of vocabulary elements.

package/docs/reference/interfaces/IEpcisVocabularyElement.md

@@ -0,0 +1,32 @@
+# Interface: IEpcisVocabularyElement
+
+EPCIS 2.0 VocabularyElement representing a master data entity with
+attributes and optional children.
+
+## See
+
+https://ref.gs1.org/epcis/VocabularyElement
+
+## Properties
+
+### id {#id}
+
+> **id**: `string`
+
+Element id.
+
+***
+
+### attributes? {#attributes}
+
+> `optional` **attributes?**: [`IEpcisAttribute`](IEpcisAttribute.md)[]
+
+Attributes.
+
+***
+
+### children? {#children}
+
+> `optional` **children?**: `string`[]
+
+Children.

package/docs/reference/type-aliases/EpcisActionTypes.md

@@ -2,4 +2,5 @@
 
 > **EpcisActionTypes** = *typeof* [`EpcisActionTypes`](../variables/EpcisActionTypes.md)\[keyof *typeof* [`EpcisActionTypes`](../variables/EpcisActionTypes.md)\]
 
-EPCIS 2.0 action types.
+GS1 EPCIS 2.0 action values capturing whether an event adds, observes, or
+removes associations.

package/docs/reference/type-aliases/EpcisBizStepTypes.md

@@ -2,4 +2,7 @@
 
 > **EpcisBizStepTypes** = *typeof* [`EpcisBizStepTypes`](../variables/EpcisBizStepTypes.md)\[keyof *typeof* [`EpcisBizStepTypes`](../variables/EpcisBizStepTypes.md)\]
 
-EPCIS 2.0 action types.
+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.

package/docs/reference/type-aliases/EpcisBizTransactionTypes.md

@@ -0,0 +1,5 @@
+# Type Alias: EpcisBizTransactionTypes
+
+> **EpcisBizTransactionTypes** = *typeof* [`EpcisBizTransactionTypes`](../variables/EpcisBizTransactionTypes.md)\[keyof *typeof* [`EpcisBizTransactionTypes`](../variables/EpcisBizTransactionTypes.md)\]
+
+Supported EPCIS 2.0 `bizTransaction-type` values.

package/docs/reference/type-aliases/EpcisComponentTypes.md

@@ -0,0 +1,5 @@
+# Type Alias: EpcisComponentTypes
+
+> **EpcisComponentTypes** = *typeof* [`EpcisComponentTypes`](../variables/EpcisComponentTypes.md)\[keyof *typeof* [`EpcisComponentTypes`](../variables/EpcisComponentTypes.md)\]
+
+Supported EPCIS 2.0 `component` values.

package/docs/reference/type-aliases/EpcisContextType.md

@@ -0,0 +1,6 @@
+# Type Alias: EpcisContextType
+
+> **EpcisContextType** = *typeof* [`Context`](../variables/EpcisContexts.md#context) \| `SingleOccurrenceArray`\<`IJsonLdContextDefinitionElement`, *typeof* [`Context`](../variables/EpcisContexts.md#context)\>
+
+Allowed shapes for an EPCIS 2.0 JSON-LD `@context`, anchored on the GS1
+context root and optionally augmented with custom entries.

package/docs/reference/type-aliases/EpcisContexts.md

@@ -0,0 +1,5 @@
+# Type Alias: EpcisContexts
+
+> **EpcisContexts** = *typeof* [`EpcisContexts`](../variables/EpcisContexts.md)\[keyof *typeof* [`EpcisContexts`](../variables/EpcisContexts.md)\]
+
+Canonical EPCIS JSON-LD context IRIs as defined by GS1.

package/docs/reference/type-aliases/EpcisDispositionTypes.md

@@ -2,4 +2,8 @@
 
 > **EpcisDispositionTypes** = *typeof* [`EpcisDispositionTypes`](../variables/EpcisDispositionTypes.md)\[keyof *typeof* [`EpcisDispositionTypes`](../variables/EpcisDispositionTypes.md)\]
 
-EPCIS 2.0 disposition types.
+Supported EPCIS 2.0 `disposition` values from the GS1 Core Business
+Vocabulary (CBV).
+
+Use the union type `EpcisDispositionTypes` to restrict a field to known CBV
+values.

package/docs/reference/type-aliases/EpcisErrorReasonTypes.md

@@ -0,0 +1,5 @@
+# Type Alias: EpcisErrorReasonTypes
+
+> **EpcisErrorReasonTypes** = *typeof* [`EpcisErrorReasonTypes`](../variables/EpcisErrorReasonTypes.md)\[keyof *typeof* [`EpcisErrorReasonTypes`](../variables/EpcisErrorReasonTypes.md)\]
+
+Supported EPCIS 2.0 `error-reason` values from the GS1 EPCIS JSON Schema.

package/docs/reference/type-aliases/EpcisEventTypes.md

@@ -2,4 +2,4 @@
 
 > **EpcisEventTypes** = *typeof* [`EpcisEventTypes`](../variables/EpcisEventTypes.md)\[keyof *typeof* [`EpcisEventTypes`](../variables/EpcisEventTypes.md)\]
 
-EPCIS 2.0 event types.
+EPCIS 2.0 event type identifiers used in EPCIS JSON and XML documents.

package/docs/reference/type-aliases/EpcisEvents.md

@@ -0,0 +1,6 @@
+# Type Alias: EpcisEvents
+
+> **EpcisEvents** = [`IEpcisObjectEvent`](../interfaces/IEpcisObjectEvent.md) \| [`IEpcisAssociationEvent`](../interfaces/IEpcisAssociationEvent.md) \| [`IEpcisAggregationEvent`](../interfaces/IEpcisAggregationEvent.md) \| [`IEpcisTransactionEvent`](../interfaces/IEpcisTransactionEvent.md) \| [`IEpcisTransformationEvent`](../interfaces/IEpcisTransformationEvent.md) \| [`IEpcisEvent`](../interfaces/IEpcisEvent.md)
+
+Discriminated union covering all EPCIS 2.0 event interfaces used in this
+package.

package/docs/reference/type-aliases/EpcisMeasurementTypes.md

@@ -0,0 +1,8 @@
+# Type Alias: EpcisMeasurementTypes
+
+> **EpcisMeasurementTypes** = *typeof* [`EpcisMeasurementTypes`](../variables/EpcisMeasurementTypes.md)\[keyof *typeof* [`EpcisMeasurementTypes`](../variables/EpcisMeasurementTypes.md)\]
+
+Supported EPCIS 2.0 `measurementType` values.
+
+These values come from the GS1 EPCIS JSON Schema enumeration.
+Use the union type `EpcisMeasurementTypes` when you want to restrict a field to known values.

package/docs/reference/type-aliases/EpcisSensorAlertTypes.md

@@ -0,0 +1,6 @@
+# Type Alias: EpcisSensorAlertTypes
+
+> **EpcisSensorAlertTypes** = *typeof* [`EpcisSensorAlertTypes`](../variables/EpcisSensorAlertTypes.md)\[keyof *typeof* [`EpcisSensorAlertTypes`](../variables/EpcisSensorAlertTypes.md)\]
+
+Supported EPCIS 2.0 `sensorAlertType` values for sensor-generated alarms or
+errors.

package/docs/reference/type-aliases/EpcisSourceDestTypes.md

@@ -0,0 +1,6 @@
+# Type Alias: EpcisSourceDestTypes
+
+> **EpcisSourceDestTypes** = *typeof* [`EpcisSourceDestTypes`](../variables/EpcisSourceDestTypes.md)\[keyof *typeof* [`EpcisSourceDestTypes`](../variables/EpcisSourceDestTypes.md)\]
+
+Supported EPCIS 2.0 `source-dest-type` values describing the role of a party
+or location in a transfer.

package/docs/reference/variables/EpcisActionTypes.md

@@ -2,24 +2,27 @@
 
 > `const` **EpcisActionTypes**: `object`
 
-EPCIS 2.0 action types.
+GS1 EPCIS 2.0 action values capturing whether an event adds, observes, or
+removes associations.
 
 ## Type Declaration
 
-### Add
+### Add {#add}
 
 > `readonly` **Add**: `"ADD"` = `"ADD"`
 
-ADD action.
+Indicates that associations described by the event are created as of
+eventTime.
 
-### Observe
+### Observe {#observe}
 
 > `readonly` **Observe**: `"OBSERVE"` = `"OBSERVE"`
 
-OBSERVE action.
+Reports an observation of existing associations without changing them.
 
-### Delete
+### Delete {#delete}
 
 > `readonly` **Delete**: `"DELETE"` = `"DELETE"`
 
-DELETE action.
+Indicates that associations described by the event no longer hold as of
+eventTime.