@twin.org/standards-gs1 0.0.3-next.1 → 0.0.3-next.11

package/docs/reference/interfaces/IObjectEvent.md

@@ -1,211 +0,0 @@
-# Interface: IObjectEvent
-
-Defines an EPCIS 2.0 Object Event.
-
-## Extends
-
-- [`IEpcisEventDetails`](IEpcisEventDetails.md)
-
-## Properties
-
-### @context?
-
-> `optional` **@context**: `IJsonLdContextDefinition`
-
-JSON-LD @context.
-
-#### Inherited from
-
-[`IEpcisEventDetails`](IEpcisEventDetails.md).[`@context`](IEpcisEventDetails.md#context)
-
-***
-
-### id?
-
-> `optional` **id**: `string`
-
-UUID of the event.
-
-#### Inherited from
-
-[`IEpcisEventDetails`](IEpcisEventDetails.md).[`id`](IEpcisEventDetails.md#id)
-
-***
-
-### eventID?
-
-> `optional` **eventID**: `string`
-
-The id of the event. Marked here as optional as we usually won't store it on Tangle.
-
-#### Inherited from
-
-[`IEpcisEventDetails`](IEpcisEventDetails.md).[`eventID`](IEpcisEventDetails.md#eventid)
-
-***
-
-### eventTime
-
-> **eventTime**: `string`
-
-Timestamp in UTC.
-
-#### Inherited from
-
-[`IEpcisEventDetails`](IEpcisEventDetails.md).[`eventTime`](IEpcisEventDetails.md#eventtime)
-
-***
-
-### eventTimeZoneOffset
-
-> **eventTimeZoneOffset**: `string`
-
-Timezone offset. Useful if we want to represent timestamp in local timezone.
-
-#### Inherited from
-
-[`IEpcisEventDetails`](IEpcisEventDetails.md).[`eventTimeZoneOffset`](IEpcisEventDetails.md#eventtimezoneoffset)
-
-***
-
-### recordTime?
-
-> `optional` **recordTime**: `string`
-
-When the event was recorded. It will be automatically generated.
-
-#### Inherited from
-
-[`IEpcisEventDetails`](IEpcisEventDetails.md).[`recordTime`](IEpcisEventDetails.md#recordtime)
-
-***
-
-### sourceList?
-
-> `optional` **sourceList**: [`ISource`](ISource.md)[]
-
-Source list. Semantics according to EPCIS standard.
-
-#### Inherited from
-
-[`IEpcisEventDetails`](IEpcisEventDetails.md).[`sourceList`](IEpcisEventDetails.md#sourcelist)
-
-***
-
-### destinationList?
-
-> `optional` **destinationList**: [`IDestination`](IDestination.md)[]
-
-Destination list. Semantics according to EPCIS standard.
-
-#### Inherited from
-
-[`IEpcisEventDetails`](IEpcisEventDetails.md).[`destinationList`](IEpcisEventDetails.md#destinationlist)
-
-***
-
-### action
-
-> **action**: [`ActionTypes`](../type-aliases/ActionTypes.md)
-
-Action: ADD, OBSERVE, DELETE.
-
-#### Inherited from
-
-[`IEpcisEventDetails`](IEpcisEventDetails.md).[`action`](IEpcisEventDetails.md#action)
-
-***
-
-### readPoint?
-
-> `optional` **readPoint**: [`ISimpleLocation`](ISimpleLocation.md)
-
-The location of reading point.
-
-#### Inherited from
-
-[`IEpcisEventDetails`](IEpcisEventDetails.md).[`readPoint`](IEpcisEventDetails.md#readpoint)
-
-***
-
-### bizLocation?
-
-> `optional` **bizLocation**: [`ISimpleLocation`](ISimpleLocation.md)
-
-The biz location where the item ends up.
-
-#### Inherited from
-
-[`IEpcisEventDetails`](IEpcisEventDetails.md).[`bizLocation`](IEpcisEventDetails.md#bizlocation)
-
-***
-
-### bizStep?
-
-> `optional` **bizStep**: [`BizStepTypes`](../type-aliases/BizStepTypes.md)
-
-The business step as per EPCIS.
-
-#### Inherited from
-
-[`IEpcisEventDetails`](IEpcisEventDetails.md).[`bizStep`](IEpcisEventDetails.md#bizstep)
-
-***
-
-### disposition?
-
-> `optional` **disposition**: [`DispositionTypes`](../type-aliases/DispositionTypes.md)
-
-The disposition as per EPCIS.
-
-#### Inherited from
-
-[`IEpcisEventDetails`](IEpcisEventDetails.md).[`disposition`](IEpcisEventDetails.md#disposition)
-
-***
-
-### bizTransactionList?
-
-> `optional` **bizTransactionList**: [`IBizTransaction`](IBizTransaction.md)[]
-
-The list of related business transactions.
-
-#### Inherited from
-
-[`IEpcisEventDetails`](IEpcisEventDetails.md).[`bizTransactionList`](IEpcisEventDetails.md#biztransactionlist)
-
-***
-
-### type
-
-> **type**: `"ObjectEvent"`
-
-Fixed to ObjectEvent.
-
-#### Overrides
-
-[`IEpcisEventDetails`](IEpcisEventDetails.md).[`type`](IEpcisEventDetails.md#type)
-
-***
-
-### epcList
-
-> **epcList**: `string`[]
-
-List of EPCs involved.
-
-***
-
-### quantityList?
-
-> `optional` **quantityList**: [`IQuantity`](IQuantity.md)[]
-
-Quantity in case of class-level event visibility data.
-
-***
-
-### sensorElementList?
-
-> `optional` **sensorElementList**: [`ISensorElement`](ISensorElement.md)[]
-
-Sensor element list.

package/docs/reference/interfaces/IQuantity.md

@@ -1,19 +0,0 @@
-# Interface: IQuantity
-
-EPCIS Quantity.
-
-## Properties
-
-### epcClass
-
-> **epcClass**: `string`
-
-EPC Class.
-
-***
-
-### quantity
-
-> **quantity**: `number`
-
-Quantity.

package/docs/reference/interfaces/ISensorElement.md

@@ -1,19 +0,0 @@
-# Interface: ISensorElement
-
-EPCIS SensorElement.
-
-## Properties
-
-### sensorMetadata?
-
-> `optional` **sensorMetadata**: [`ISensorMetadata`](ISensorMetadata.md)
-
-Sensor metadata.
-
-***
-
-### sensorReport
-
-> **sensorReport**: [`ISensorReport`](ISensorReport.md)[]
-
-Sensor report.

package/docs/reference/interfaces/ISensorMetadata.md

@@ -1,35 +0,0 @@
-# Interface: ISensorMetadata
-
-EPCIS Sensor metadata.
-
-## Properties
-
-### time
-
-> **time**: `string`
-
-Time.
-
-***
-
-### deviceID
-
-> **deviceID**: `string`
-
-Device ID.
-
-***
-
-### deviceMetadata
-
-> **deviceMetadata**: `string`
-
-Device Metadata.
-
-***
-
-### rawData
-
-> **rawData**: `string`
-
-Raw data.

package/docs/reference/interfaces/ISensorReport.md

@@ -1,27 +0,0 @@
-# Interface: ISensorReport
-
-EPCIS SensorReport.
-
-## Properties
-
-### type
-
-> **type**: `string`
-
-Type.
-
-***
-
-### value
-
-> **value**: `number`
-
-Value.
-
-***
-
-### uom
-
-> **uom**: `string`
-
-Unit of measurement.

package/docs/reference/interfaces/ISimpleLocation.md

@@ -1,11 +0,0 @@
-# Interface: ISimpleLocation
-
-EPCIS Location.
-
-## Properties
-
-### id
-
-> **id**: `string`
-
-The id.

package/docs/reference/interfaces/ISource.md

@@ -1,19 +0,0 @@
-# Interface: ISource
-
-EPCIS Biz Transaction.
-
-## Properties
-
-### type
-
-> **type**: `string`
-
-Type.
-
-***
-
-### source
-
-> **source**: `string`
-
-The source.

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

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

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

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

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

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

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

@@ -1,5 +0,0 @@
-# Type Alias: EpcisErrorTypes
-
-> **EpcisErrorTypes** = *typeof* [`EpcisErrorTypes`](../variables/EpcisErrorTypes.md)\[keyof *typeof* [`EpcisErrorTypes`](../variables/EpcisErrorTypes.md)\]
-
-EPCIS Error types.

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

@@ -1,5 +0,0 @@
-# Type Alias: EpcisEventUnionType
-
-> **EpcisEventUnionType** = [`IObjectEvent`](../interfaces/IObjectEvent.md) \| [`IAssociationEvent`](../interfaces/IAssociationEvent.md) \| [`IAggregationEvent`](../interfaces/IAggregationEvent.md)
-
-The type that subsumes an EPCIS Event.

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

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

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

@@ -1,7 +0,0 @@
-# Type Alias: SubSiteAttributes
-
-> **SubSiteAttributes** = *typeof* [`SubSiteAttributes`](../variables/SubSiteAttributes.md)\[keyof *typeof* [`SubSiteAttributes`](../variables/SubSiteAttributes.md)\]
-
-Sub Site Attributes.
-Spec https://www.gs1.org/sites/default/files/docs/epc/CBV-Standard-1-2-1-r-2017-05-05.pdf .
-Section 10.3.2 .

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

@@ -1,7 +0,0 @@
-# Type Alias: SubSiteTypes
-
-> **SubSiteTypes** = *typeof* [`SubSiteTypes`](../variables/SubSiteTypes.md)\[keyof *typeof* [`SubSiteTypes`](../variables/SubSiteTypes.md)\]
-
-Sub Site Identifier Types.
-Spec https://www.gs1.org/sites/default/files/docs/epc/CBV-Standard-1-2-1-r-2017-05-05.pdf .
-Section 10.3.1 .

package/docs/reference/variables/ActionTypes.md

@@ -1,25 +0,0 @@
-# Variable: ActionTypes
-
-> `const` **ActionTypes**: `object`
-
-EPCIS 2.0 action types.
-
-## Type Declaration
-
-### Add
-
-> `readonly` **Add**: `"ADD"` = `"ADD"`
-
-ADD action.
-
-### Observe
-
-> `readonly` **Observe**: `"OBSERVE"` = `"OBSERVE"`
-
-OBSERVE action.
-
-### Delete
-
-> `readonly` **Delete**: `"DELETE"` = `"DELETE"`
-
-DELETE action.

package/docs/reference/variables/BizStepTypes.md

@@ -1,173 +0,0 @@
-# Variable: BizStepTypes
-
-> `const` **BizStepTypes**: `object`
-
-Supported EPCIS 2.0 bizStep.
-
-See EPCIS CVB specification for details.
-
-## Type Declaration
-
-### Accepting
-
-> `readonly` **Accepting**: `"accepting"` = `"accepting"`
-
-### Arriving
-
-> `readonly` **Arriving**: `"arriving"` = `"arriving"`
-
-### Assembling
-
-> `readonly` **Assembling**: `"assembling"` = `"assembling"`
-
-### Collecting
-
-> `readonly` **Collecting**: `"collecting"` = `"collecting"`
-
-### Commissioning
-
-> `readonly` **Commissioning**: `"commissioning"` = `"commissioning"`
-
-### Consigning
-
-> `readonly` **Consigning**: `"consigning"` = `"consigning"`
-
-### CreatingClassInstance
-
-> `readonly` **CreatingClassInstance**: `"creating_class_instance"` = `"creating_class_instance"`
-
-### CycleCounting
-
-> `readonly` **CycleCounting**: `"cycle_counting"` = `"cycle_counting"`
-
-### Decommissioning
-
-> `readonly` **Decommissioning**: `"decommissioning"` = `"decommissioning"`
-
-### Departing
-
-> `readonly` **Departing**: `"departing"` = `"departing"`
-
-### Destroying
-
-> `readonly` **Destroying**: `"destroying"` = `"destroying"`
-
-### Disassembling
-
-> `readonly` **Disassembling**: `"disassembling"` = `"disassembling"`
-
-### Dispensing
-
-> `readonly` **Dispensing**: `"dispensing"` = `"dispensing"`
-
-### Encoding
-
-> `readonly` **Encoding**: `"encoding"` = `"encoding"`
-
-### EnteringExiting
-
-> `readonly` **EnteringExiting**: `"entering_exiting"` = `"entering_exiting"`
-
-### Holding
-
-> `readonly` **Holding**: `"holding"` = `"holding"`
-
-### Inspecting
-
-> `readonly` **Inspecting**: `"inspecting"` = `"inspecting"`
-
-### Installing
-
-> `readonly` **Installing**: `"installing"` = `"installing"`
-
-### Killing
-
-> `readonly` **Killing**: `"killing"` = `"killing"`
-
-### Loading
-
-> `readonly` **Loading**: `"loading"` = `"loading"`
-
-### Other
-
-> `readonly` **Other**: `"other"` = `"other"`
-
-### Packing
-
-> `readonly` **Packing**: `"packing"` = `"packing"`
-
-### Picking
-
-> `readonly` **Picking**: `"picking"` = `"picking"`
-
-### Receiving
-
-> `readonly` **Receiving**: `"receiving"` = `"receiving"`
-
-### Removing
-
-> `readonly` **Removing**: `"removing"` = `"removing"`
-
-### Repackaging
-
-> `readonly` **Repackaging**: `"repackaging"` = `"repackaging"`
-
-### Repairing
-
-> `readonly` **Repairing**: `"repairing"` = `"repairing"`
-
-### Replacing
-
-> `readonly` **Replacing**: `"replacing"` = `"replacing"`
-
-### Reserving
-
-> `readonly` **Reserving**: `"reserving"` = `"reserving"`
-
-### RetailSelling
-
-> `readonly` **RetailSelling**: `"retail_selling"` = `"retail_selling"`
-
-### Shipping
-
-> `readonly` **Shipping**: `"shipping"` = `"shipping"`
-
-### StagingOutbound
-
-> `readonly` **StagingOutbound**: `"staging_outbound"` = `"staging_outbound"`
-
-### StockTaking
-
-> `readonly` **StockTaking**: `"stock_taking"` = `"stock_taking"`
-
-### Stocking
-
-> `readonly` **Stocking**: `"stocking"` = `"stocking"`
-
-### Storing
-
-> `readonly` **Storing**: `"storing"` = `"storing"`
-
-### Transporting
-
-> `readonly` **Transporting**: `"transporting"` = `"transporting"`
-
-### Unloading
-
-> `readonly` **Unloading**: `"unloading"` = `"unloading"`
-
-### Unpacking
-
-> `readonly` **Unpacking**: `"unpacking"` = `"unpacking"`
-
-### VoidShipping
-
-> `readonly` **VoidShipping**: `"void_shipping"` = `"void_shipping"`
-
-### SensorReporting
-
-> `readonly` **SensorReporting**: `"sensor_reporting"` = `"sensor_reporting"`
-
-### Sampling
-
-> `readonly` **Sampling**: `"sampling"` = `"sampling"`

package/docs/reference/variables/EpcisErrorTypes.md

@@ -1,15 +0,0 @@
-# Variable: EpcisErrorTypes
-
-> `const` **EpcisErrorTypes**: `object`
-
-EPCIS Error types.
-
-## Type Declaration
-
-### ValidationFailed
-
-> `readonly` **ValidationFailed**: `"epcisException:ValidationException"` = `"epcisException:ValidationException"`
-
-### NoSuchResource
-
-> `readonly` **NoSuchResource**: `"epcisException:NoSuchResourceException"` = `"epcisException:NoSuchResourceException"`