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

package/dist/types/models/epcis20/epcisEventUnionType.d.ts

@@ -1,7 +0,0 @@
-import type { IAggregationEvent } from "./IAggregationEvent.js";
-import type { IAssociationEvent } from "./IAssociationEvent.js";
-import type { IObjectEvent } from "./IObjectEvent.js";
-/**
- * The type that subsumes an EPCIS Event.
- */
-export type EpcisEventUnionType = IObjectEvent | IAssociationEvent | IAggregationEvent;

package/dist/types/models/epcis20/eventTypes.d.ts

@@ -1,29 +0,0 @@
-/**
- * EPCIS 2.0 event types.
- */
-export declare const EventTypes: {
-    /**
-     * ObjectEvent.
-     */
-    readonly ObjectEvent: "ObjectEvent";
-    /**
-     * Aggregation Event.
-     */
-    readonly AggregationEvent: "AggregationEvent";
-    /**
-     * Association Event.
-     */
-    readonly AssociationEvent: "AssociationEvent";
-    /**
-     * Transformation Event.
-     */
-    readonly TransformationEvent: "TransformationEvent";
-    /**
-     * Transaction Event.
-     */
-    readonly TransactionEvent: "TransactionEvent";
-};
-/**
- * EPCIS 2.0 event types.
- */
-export type EventTypes = (typeof EventTypes)[keyof typeof EventTypes];

package/docs/reference/interfaces/IAggregationEvent.md

@@ -1,223 +0,0 @@
-# Interface: IAggregationEvent
-
-Describes an AggregationEvent.
-
-## Extends
-
-- `IBaseAggregationEvent`
-
-## Properties
-
-### type
-
-> **type**: `"AggregationEvent"`
-
-The type.
-
-#### Overrides
-
-`IBaseAggregationEvent.type`
-
-***
-
-### parentID?
-
-> `optional` **parentID**: `string`
-
-Parent is only optional when action is OBSERVE.
-
-#### Inherited from
-
-`IBaseAggregationEvent.parentID`
-
-***
-
-### childEPCs?
-
-> `optional` **childEPCs**: `string`[]
-
-The children EPC which can be empty when action is DELETE.
-
-#### Inherited from
-
-`IBaseAggregationEvent.childEPCs`
-
-***
-
-### childQuantityList?
-
-> `optional` **childQuantityList**: [`IQuantity`](IQuantity.md)[]
-
-Quantity in case of class-level event visibility data.
-
-#### Inherited from
-
-`IBaseAggregationEvent.childQuantityList`
-
-***
-
-### @context?
-
-> `optional` **@context**: `IJsonLdContextDefinition`
-
-JSON-LD @context.
-
-#### Inherited from
-
-`IBaseAggregationEvent.@context`
-
-***
-
-### id?
-
-> `optional` **id**: `string`
-
-UUID of the event.
-
-#### Inherited from
-
-`IBaseAggregationEvent.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
-
-`IBaseAggregationEvent.eventID`
-
-***
-
-### eventTime
-
-> **eventTime**: `string`
-
-Timestamp in UTC.
-
-#### Inherited from
-
-`IBaseAggregationEvent.eventTime`
-
-***
-
-### eventTimeZoneOffset
-
-> **eventTimeZoneOffset**: `string`
-
-Timezone offset. Useful if we want to represent timestamp in local timezone.
-
-#### Inherited from
-
-`IBaseAggregationEvent.eventTimeZoneOffset`
-
-***
-
-### recordTime?
-
-> `optional` **recordTime**: `string`
-
-When the event was recorded. It will be automatically generated.
-
-#### Inherited from
-
-`IBaseAggregationEvent.recordTime`
-
-***
-
-### sourceList?
-
-> `optional` **sourceList**: [`ISource`](ISource.md)[]
-
-Source list. Semantics according to EPCIS standard.
-
-#### Inherited from
-
-`IBaseAggregationEvent.sourceList`
-
-***
-
-### destinationList?
-
-> `optional` **destinationList**: [`IDestination`](IDestination.md)[]
-
-Destination list. Semantics according to EPCIS standard.
-
-#### Inherited from
-
-`IBaseAggregationEvent.destinationList`
-
-***
-
-### action
-
-> **action**: [`ActionTypes`](../type-aliases/ActionTypes.md)
-
-Action: ADD, OBSERVE, DELETE.
-
-#### Inherited from
-
-`IBaseAggregationEvent.action`
-
-***
-
-### readPoint?
-
-> `optional` **readPoint**: [`ISimpleLocation`](ISimpleLocation.md)
-
-The location of reading point.
-
-#### Inherited from
-
-`IBaseAggregationEvent.readPoint`
-
-***
-
-### bizLocation?
-
-> `optional` **bizLocation**: [`ISimpleLocation`](ISimpleLocation.md)
-
-The biz location where the item ends up.
-
-#### Inherited from
-
-`IBaseAggregationEvent.bizLocation`
-
-***
-
-### bizStep?
-
-> `optional` **bizStep**: [`BizStepTypes`](../type-aliases/BizStepTypes.md)
-
-The business step as per EPCIS.
-
-#### Inherited from
-
-`IBaseAggregationEvent.bizStep`
-
-***
-
-### disposition?
-
-> `optional` **disposition**: [`DispositionTypes`](../type-aliases/DispositionTypes.md)
-
-The disposition as per EPCIS.
-
-#### Inherited from
-
-`IBaseAggregationEvent.disposition`
-
-***
-
-### bizTransactionList?
-
-> `optional` **bizTransactionList**: [`IBizTransaction`](IBizTransaction.md)[]
-
-The list of related business transactions.
-
-#### Inherited from
-
-`IBaseAggregationEvent.bizTransactionList`

package/docs/reference/interfaces/IAssociationEvent.md

@@ -1,223 +0,0 @@
-# Interface: IAssociationEvent
-
-Association Event.
-
-## Extends
-
-- `IBaseAggregationEvent`
-
-## Properties
-
-### type
-
-> **type**: `"AssociationEvent"`
-
-Type.
-
-#### Overrides
-
-`IBaseAggregationEvent.type`
-
-***
-
-### parentID?
-
-> `optional` **parentID**: `string`
-
-Parent is only optional when action is OBSERVE.
-
-#### Inherited from
-
-`IBaseAggregationEvent.parentID`
-
-***
-
-### childEPCs?
-
-> `optional` **childEPCs**: `string`[]
-
-The children EPC which can be empty when action is DELETE.
-
-#### Inherited from
-
-`IBaseAggregationEvent.childEPCs`
-
-***
-
-### childQuantityList?
-
-> `optional` **childQuantityList**: [`IQuantity`](IQuantity.md)[]
-
-Quantity in case of class-level event visibility data.
-
-#### Inherited from
-
-`IBaseAggregationEvent.childQuantityList`
-
-***
-
-### @context?
-
-> `optional` **@context**: `IJsonLdContextDefinition`
-
-JSON-LD @context.
-
-#### Inherited from
-
-`IBaseAggregationEvent.@context`
-
-***
-
-### id?
-
-> `optional` **id**: `string`
-
-UUID of the event.
-
-#### Inherited from
-
-`IBaseAggregationEvent.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
-
-`IBaseAggregationEvent.eventID`
-
-***
-
-### eventTime
-
-> **eventTime**: `string`
-
-Timestamp in UTC.
-
-#### Inherited from
-
-`IBaseAggregationEvent.eventTime`
-
-***
-
-### eventTimeZoneOffset
-
-> **eventTimeZoneOffset**: `string`
-
-Timezone offset. Useful if we want to represent timestamp in local timezone.
-
-#### Inherited from
-
-`IBaseAggregationEvent.eventTimeZoneOffset`
-
-***
-
-### recordTime?
-
-> `optional` **recordTime**: `string`
-
-When the event was recorded. It will be automatically generated.
-
-#### Inherited from
-
-`IBaseAggregationEvent.recordTime`
-
-***
-
-### sourceList?
-
-> `optional` **sourceList**: [`ISource`](ISource.md)[]
-
-Source list. Semantics according to EPCIS standard.
-
-#### Inherited from
-
-`IBaseAggregationEvent.sourceList`
-
-***
-
-### destinationList?
-
-> `optional` **destinationList**: [`IDestination`](IDestination.md)[]
-
-Destination list. Semantics according to EPCIS standard.
-
-#### Inherited from
-
-`IBaseAggregationEvent.destinationList`
-
-***
-
-### action
-
-> **action**: [`ActionTypes`](../type-aliases/ActionTypes.md)
-
-Action: ADD, OBSERVE, DELETE.
-
-#### Inherited from
-
-`IBaseAggregationEvent.action`
-
-***
-
-### readPoint?
-
-> `optional` **readPoint**: [`ISimpleLocation`](ISimpleLocation.md)
-
-The location of reading point.
-
-#### Inherited from
-
-`IBaseAggregationEvent.readPoint`
-
-***
-
-### bizLocation?
-
-> `optional` **bizLocation**: [`ISimpleLocation`](ISimpleLocation.md)
-
-The biz location where the item ends up.
-
-#### Inherited from
-
-`IBaseAggregationEvent.bizLocation`
-
-***
-
-### bizStep?
-
-> `optional` **bizStep**: [`BizStepTypes`](../type-aliases/BizStepTypes.md)
-
-The business step as per EPCIS.
-
-#### Inherited from
-
-`IBaseAggregationEvent.bizStep`
-
-***
-
-### disposition?
-
-> `optional` **disposition**: [`DispositionTypes`](../type-aliases/DispositionTypes.md)
-
-The disposition as per EPCIS.
-
-#### Inherited from
-
-`IBaseAggregationEvent.disposition`
-
-***
-
-### bizTransactionList?
-
-> `optional` **bizTransactionList**: [`IBizTransaction`](IBizTransaction.md)[]
-
-The list of related business transactions.
-
-#### Inherited from
-
-`IBaseAggregationEvent.bizTransactionList`

package/docs/reference/interfaces/IBizTransaction.md

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

package/docs/reference/interfaces/IDestination.md

@@ -1,19 +0,0 @@
-# Interface: IDestination
-
-EPCIS Destination.
-
-## Properties
-
-### type
-
-> **type**: `string`
-
-Type.
-
-***
-
-### destination
-
-> **destination**: `string`
-
-The destination.

package/docs/reference/interfaces/IEpcisEventDetails.md

@@ -1,167 +0,0 @@
-# Interface: IEpcisEventDetails
-
-EPCIS Event Details.
-
-## Extends
-
-- [`IEpcisEvent`](IEpcisEvent.md)
-
-## Extended by
-
-- [`IObjectEvent`](IObjectEvent.md)
-
-## Properties
-
-### @context?
-
-> `optional` **@context**: `IJsonLdContextDefinition`
-
-JSON-LD @context.
-
-#### Inherited from
-
-[`IEpcisEvent`](IEpcisEvent.md).[`@context`](IEpcisEvent.md#context)
-
-***
-
-### id?
-
-> `optional` **id**: `string`
-
-UUID of the event.
-
-#### Inherited from
-
-[`IEpcisEvent`](IEpcisEvent.md).[`id`](IEpcisEvent.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
-
-[`IEpcisEvent`](IEpcisEvent.md).[`eventID`](IEpcisEvent.md#eventid)
-
-***
-
-### type
-
-> **type**: `string`
-
-Type of Event.
-
-#### Inherited from
-
-[`IEpcisEvent`](IEpcisEvent.md).[`type`](IEpcisEvent.md#type)
-
-***
-
-### eventTime
-
-> **eventTime**: `string`
-
-Timestamp in UTC.
-
-#### Inherited from
-
-[`IEpcisEvent`](IEpcisEvent.md).[`eventTime`](IEpcisEvent.md#eventtime)
-
-***
-
-### eventTimeZoneOffset
-
-> **eventTimeZoneOffset**: `string`
-
-Timezone offset. Useful if we want to represent timestamp in local timezone.
-
-#### Inherited from
-
-[`IEpcisEvent`](IEpcisEvent.md).[`eventTimeZoneOffset`](IEpcisEvent.md#eventtimezoneoffset)
-
-***
-
-### recordTime?
-
-> `optional` **recordTime**: `string`
-
-When the event was recorded. It will be automatically generated.
-
-#### Inherited from
-
-[`IEpcisEvent`](IEpcisEvent.md).[`recordTime`](IEpcisEvent.md#recordtime)
-
-***
-
-### sourceList?
-
-> `optional` **sourceList**: [`ISource`](ISource.md)[]
-
-Source list. Semantics according to EPCIS standard.
-
-#### Inherited from
-
-[`IEpcisEvent`](IEpcisEvent.md).[`sourceList`](IEpcisEvent.md#sourcelist)
-
-***
-
-### destinationList?
-
-> `optional` **destinationList**: [`IDestination`](IDestination.md)[]
-
-Destination list. Semantics according to EPCIS standard.
-
-#### Inherited from
-
-[`IEpcisEvent`](IEpcisEvent.md).[`destinationList`](IEpcisEvent.md#destinationlist)
-
-***
-
-### action
-
-> **action**: [`ActionTypes`](../type-aliases/ActionTypes.md)
-
-Action: ADD, OBSERVE, DELETE.
-
-***
-
-### readPoint?
-
-> `optional` **readPoint**: [`ISimpleLocation`](ISimpleLocation.md)
-
-The location of reading point.
-
-***
-
-### bizLocation?
-
-> `optional` **bizLocation**: [`ISimpleLocation`](ISimpleLocation.md)
-
-The biz location where the item ends up.
-
-***
-
-### bizStep?
-
-> `optional` **bizStep**: [`BizStepTypes`](../type-aliases/BizStepTypes.md)
-
-The business step as per EPCIS.
-
-***
-
-### disposition?
-
-> `optional` **disposition**: [`DispositionTypes`](../type-aliases/DispositionTypes.md)
-
-The disposition as per EPCIS.
-
-***
-
-### bizTransactionList?
-
-> `optional` **bizTransactionList**: [`IBizTransaction`](IBizTransaction.md)[]
-
-The list of related business transactions.