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

package/docs/reference/interfaces/IEpcisEvent.md

@@ -1,79 +1,83 @@
 # Interface: IEpcisEvent
 
-EPCIS Event.
+Base EPCIS 2.0 Event carrying shared fields across all event types.
+
+## See
+
+https://ref.gs1.org/epcis/Event
 
 ## Extended by
 
-- [`IEpcisEventDetails`](IEpcisEventDetails.md)
+- [`IEpcisAggregationEvent`](IEpcisAggregationEvent.md)
+- [`IEpcisAssociationEvent`](IEpcisAssociationEvent.md)
+- [`IEpcisObjectEvent`](IEpcisObjectEvent.md)
+- [`IEpcisTransactionEvent`](IEpcisTransactionEvent.md)
+- [`IEpcisTransformationEvent`](IEpcisTransformationEvent.md)
 
 ## Properties
 
-### @context?
+### @context {#context}
 
-> `optional` **@context**: `IJsonLdContextDefinition`
+> **@context**: [`EpcisContextType`](../type-aliases/EpcisContextType.md)
 
 JSON-LD @context.
 
 ***
 
-### id?
-
-> `optional` **id**: `string`
-
-UUID of the event.
-
-***
-
-### eventID?
+### type {#type}
 
-> `optional` **eventID**: `string`
+> **type**: `string`
 
-The id of the event. Marked here as optional as we usually won't store it on Tangle.
+Type of Event.
 
 ***
 
-### type
+### eventID? {#eventid}
 
-> **type**: `string`
+> `optional` **eventID?**: `string`
 
-Type of Event.
+URI identifier of a specific EPCIS event (alias of id in JSON or XML).
 
 ***
 
-### eventTime
+### certificationInfo? {#certificationinfo}
 
-> **eventTime**: `string`
+> `optional` **certificationInfo?**: `ObjectOrArray`\<`string`\>
 
-Timestamp in UTC.
+(Optional) CertificationDetails relevant for Objects, Places and/or
+Organizations mentioned in this Event.
 
 ***
 
-### eventTimeZoneOffset
+### errorDeclaration? {#errordeclaration}
 
-> **eventTimeZoneOffset**: `string`
+> `optional` **errorDeclaration?**: [`IEpcisErrorDeclaration`](IEpcisErrorDeclaration.md)
 
-Timezone offset. Useful if we want to represent timestamp in local timezone.
+Error declaration.
 
 ***
 
-### recordTime?
+### eventTime {#eventtime}
 
-> `optional` **recordTime**: `string`
+> **eventTime**: `string`
 
-When the event was recorded. It will be automatically generated.
+The date and time at which the EPCIS Capturing Applications asserts the event
+occurred.
 
 ***
 
-### sourceList?
+### eventTimeZoneOffset {#eventtimezoneoffset}
 
-> `optional` **sourceList**: [`ISource`](ISource.md)[]
+> **eventTimeZoneOffset**: `string`
 
-Source list. Semantics according to EPCIS standard.
+The time zone offset in effect at the time and place the event occurred,
+expressed as an offset from UTC.
 
 ***
 
-### destinationList?
+### recordTime? {#recordtime}
 
-> `optional` **destinationList**: [`IDestination`](IDestination.md)[]
+> `optional` **recordTime?**: `string`
 
-Destination list. Semantics according to EPCIS standard.
+(Optional) The date and time at which this event was recorded by an EPCIS
+Repository; ignored at capture and present on query results.

package/docs/reference/interfaces/IEpcisHeader.md

@@ -0,0 +1,23 @@
+# Interface: IEpcisHeader
+
+EPCIS 2.0 Header carrying optional master data alongside an EPCIS document.
+
+## See
+
+https://ref.gs1.org/epcis/EPCISHeader
+
+## Properties
+
+### epcisMasterData? {#epcismasterdata}
+
+> `optional` **epcisMasterData?**: `IJsonLdNodeObject` & `object`
+
+EPCIS master data.
+
+#### Type Declaration
+
+##### vocabularyList?
+
+> `optional` **vocabularyList?**: [`IEpcisVocabulary`](IEpcisVocabulary.md)[]
+
+Vocabulary list.

package/docs/reference/interfaces/IEpcisIlmd.md

@@ -0,0 +1,8 @@
+# Interface: IEpcisIlmd
+
+EPCIS 2.0 Instance/Lot Master Data (ILMD) container for event-level master
+data extensions.
+
+## See
+
+https://ref.gs1.org/epcis/ILMD

package/docs/reference/interfaces/IEpcisLocation.md

@@ -0,0 +1,16 @@
+# Interface: IEpcisLocation
+
+EPCIS 2.0 Location reference (readPoint/bizLocation) that wraps a location
+identifier.
+
+## See
+
+https://ref.gs1.org/epcis/ReadPoint
+
+## Properties
+
+### id {#id}
+
+> **id**: `string`
+
+The location identifier (URI/IRI per EPCIS schema and SHACL).

package/docs/reference/interfaces/IEpcisObjectEvent.md

@@ -0,0 +1,224 @@
+# Interface: IEpcisObjectEvent
+
+EPCIS 2.0 ObjectEvent describing one or more objects (instance- or class-level)
+observed at a point in the business process.
+
+## See
+
+https://ref.gs1.org/epcis/ObjectEvent
+
+## 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**: `"ObjectEvent"`
+
+Fixed to ObjectEvent.
+
+#### Overrides
+
+[`IEpcisEvent`](IEpcisEvent.md).[`type`](IEpcisEvent.md#type)
+
+***
+
+### epcList? {#epclist}
+
+> `optional` **epcList?**: `string`[]
+
+(Optional) Unordered list of one or more EPCs naming specific objects to which
+the event pertained.
+
+***
+
+### quantityList? {#quantitylist}
+
+> `optional` **quantityList?**: [`IEpcisQuantity`](IEpcisQuantity.md)[]
+
+Unordered list of one or more QuantityElements identifying contained objects at
+the class level.
+
+***
+
+### action {#action}
+
+> **action**: [`EpcisActionTypes`](../type-aliases/EpcisActionTypes.md)
+
+How this event relates to the lifecycle of the EPCs named in this event.
+
+***
+
+### 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)[]
+
+(Optional) 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/IEpcisPersistentDisposition.md

@@ -0,0 +1,24 @@
+# Interface: IEpcisPersistentDisposition
+
+EPCIS 2.0 PersistentDisposition indicating business conditions to set or unset
+independently of event disposition.
+
+## See
+
+https://ref.gs1.org/epcis/PersistentDisposition
+
+## Properties
+
+### set? {#set}
+
+> `optional` **set?**: `string`[]
+
+(Optional) List of persistentDisposition URI values to be set.
+
+***
+
+### unset? {#unset}
+
+> `optional` **unset?**: `string`[]
+
+(Optional) List of persistentDisposition URI values to be unset (revoked).

package/docs/reference/interfaces/IEpcisQuantity.md

@@ -0,0 +1,34 @@
+# Interface: IEpcisQuantity
+
+EPCIS 2.0 QuantityElement defining class-level identifiers and amounts.
+
+## See
+
+https://ref.gs1.org/epcis/QuantityElement
+
+## Properties
+
+### epcClass {#epcclass}
+
+> **epcClass**: `string`
+
+A class-level identifier for the class to which the specified quantity of
+objects belongs.
+
+***
+
+### quantity? {#quantity}
+
+> `optional` **quantity?**: `number`
+
+(Optional) A number that specifies how many or how much of the specified
+EPCClass is denoted by this QuantityElement.
+
+***
+
+### uom? {#uom}
+
+> `optional` **uom?**: `string`
+
+(Optional) Unit of measure by which the specified value(s) of the property
+specified by type should be interpreted.

package/docs/reference/interfaces/IEpcisQuery.md

@@ -1,7 +1,11 @@
 # Interface: IEpcisQuery
 
-EPCIS Query type.
+EPCIS 2.0 Query key/value parameter map used in query documents.
+
+## See
+
+https://ref.gs1.org/epcis/Query
 
 ## Indexable
 
-\[`key`: `string`\]: `string`
+> \[`key`: `string`\]: `string`

package/docs/reference/interfaces/IEpcisQueryDocument.md

@@ -1,81 +1,55 @@
 # Interface: IEpcisQueryDocument
 
-EPCIS Query Document.
+EPCIS 2.0 QueryDocument used to submit queries to an EPCIS repository.
+
+## See
+
+https://ref.gs1.org/epcis/EPCISQueryDocument
 
 ## Properties
 
-### @context
+### @context {#context}
 
-> **@context**: `IJsonLdContextDefinition`
+> **@context**: [`EpcisContextType`](../type-aliases/EpcisContextType.md)
 
 The @context.
 
 ***
 
-### id?
+### id? {#id}
 
-> `optional` **id**: `string`
+> `optional` **id?**: `string`
 
 The JSON-LD document id.
 
 ***
 
-### type
+### type {#type}
 
-> **type**: `string`
+> **type**: `"EPCISQueryDocument"`
 
 JSON-LD Type.
 
 ***
 
-### schemaVersion?
+### schemaVersion? {#schemaversion}
 
-> `optional` **schemaVersion**: `string`
+> `optional` **schemaVersion?**: `string`
 
 Schema version.
 
 ***
 
-### creationDate?
+### creationDate? {#creationdate}
 
-> `optional` **creationDate**: `string`
+> `optional` **creationDate?**: `string`
 
 Creation Date.
 
 ***
 
-### epcisBody
+### epcisBody {#epcisbody}
 
-> **epcisBody**: `object`
+> **epcisBody**: [`IEpcisQueryDocumentBody`](IEpcisQueryDocumentBody.md)
 
 The EPCIS Body.
-
-#### queryResults
-
-> **queryResults**: `object`
-
-The results of the query.
-
-##### queryResults.subscriptionID?
-
-> `optional` **subscriptionID**: `string`
-
-The concerned subscription.
-
-##### queryResults.queryName
-
-> **queryName**: `string`
-
-The concerned query.
-
-##### queryResults.resultsBody
-
-> **resultsBody**: `object`
-
-And now the results.
-
-##### queryResults.resultsBody.eventList
-
-> **eventList**: [`IEpcisEvent`](IEpcisEvent.md)[]
-
-The list of events.

package/docs/reference/interfaces/IEpcisQueryDocumentBody.md

@@ -0,0 +1,15 @@
+# Interface: IEpcisQueryDocumentBody
+
+EPCIS 2.0 QueryDocumentBody wrapper that carries query results.
+
+## See
+
+https://ref.gs1.org/epcis/QueryDocumentBody
+
+## Properties
+
+### queryResults {#queryresults}
+
+> **queryResults**: [`IEpcisQueryResults`](IEpcisQueryResults.md)
+
+The results of the query.

package/docs/reference/interfaces/IEpcisQueryResults.md

@@ -0,0 +1,31 @@
+# Interface: IEpcisQueryResults
+
+EPCIS 2.0 QueryResults payload returned from a repository query.
+
+## See
+
+https://ref.gs1.org/epcis/QueryResults
+
+## Properties
+
+### subscriptionID? {#subscriptionid}
+
+> `optional` **subscriptionID?**: `string`
+
+The concerned subscription.
+
+***
+
+### queryName {#queryname}
+
+> **queryName**: `string`
+
+The concerned query.
+
+***
+
+### resultsBody {#resultsbody}
+
+> **resultsBody**: [`IEpcisQueryResultsBody`](IEpcisQueryResultsBody.md)
+
+The query results payload.

package/docs/reference/interfaces/IEpcisQueryResultsBody.md

@@ -0,0 +1,23 @@
+# Interface: IEpcisQueryResultsBody
+
+EPCIS 2.0 QueryResultsBody containing events and optional master data.
+
+## See
+
+https://ref.gs1.org/epcis/QueryResultsBody
+
+## Properties
+
+### eventList {#eventlist}
+
+> **eventList**: [`EpcisEvents`](../type-aliases/EpcisEvents.md)[]
+
+The list of events.
+
+***
+
+### vocabularyList? {#vocabularylist}
+
+> `optional` **vocabularyList?**: [`IEpcisVocabulary`](IEpcisVocabulary.md)[]
+
+Optional master data.

package/docs/reference/interfaces/IEpcisSensorElement.md

@@ -0,0 +1,26 @@
+# Interface: IEpcisSensorElement
+
+EPCIS 2.0 SensorElement grouping metadata and one or more SensorReport
+entries.
+
+## See
+
+https://ref.gs1.org/epcis/SensorElement
+
+## Properties
+
+### sensorMetadata? {#sensormetadata}
+
+> `optional` **sensorMetadata?**: [`IEpcisSensorMetadata`](IEpcisSensorMetadata.md)
+
+(Optional) Element containing metadata attributes applicable to all
+sensorReport entries within this sensorElement.
+
+***
+
+### sensorReport {#sensorreport}
+
+> **sensorReport**: [`IEpcisSensorReport`](IEpcisSensorReport.md)[]
+
+An element containing one or several attributes that pertain to a specific
+sensor observation.