npm - @twin.org/standards-gs1 - Versions diffs - 0.0.3-next.10 → 0.0.3-next.11 - Mend

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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (219) hide show

package/docs/reference/interfaces/IObjectEvent.md DELETED Viewed

@@ -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**: [`EpcisActionTypes`](../type-aliases/EpcisActionTypes.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**: [`EpcisBizStepTypes`](../type-aliases/EpcisBizStepTypes.md)
-The business step as per EPCIS.
-#### Inherited from
-[`IEpcisEventDetails`](IEpcisEventDetails.md).[`bizStep`](IEpcisEventDetails.md#bizstep)
-***
-### disposition?
-> `optional` **disposition**: [`EpcisDispositionTypes`](../type-aliases/EpcisDispositionTypes.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 DELETED Viewed

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

package/docs/reference/interfaces/ISensorElement.md DELETED Viewed

@@ -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 DELETED Viewed

@@ -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 DELETED Viewed

@@ -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 DELETED Viewed

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

package/docs/reference/interfaces/ISource.md DELETED Viewed

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

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

@@ -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 DELETED Viewed

@@ -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/variables/EpcisErrorTypes.md DELETED Viewed

@@ -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"`