@twin.org/standards-gs1 0.0.1-next.21

package/docs/reference/classes/Gs1IdentifiersValidation.md

@@ -0,0 +1,215 @@
+# Class: Gs1IdentifiersValidation
+
+Validation for GS1 identifiers.
+
+## Constructors
+
+### new Gs1IdentifiersValidation()
+
+> **new Gs1IdentifiersValidation**(): [`Gs1IdentifiersValidation`](Gs1IdentifiersValidation.md)
+
+#### Returns
+
+[`Gs1IdentifiersValidation`](Gs1IdentifiersValidation.md)
+
+## Methods
+
+### epcId()
+
+> `static` **epcId**(`propertyName`, `value`, `failures`): `value is string`
+
+Validate if the property is a valid epc.
+
+#### Parameters
+
+##### propertyName
+
+`string`
+
+The name of the property being validated.
+
+##### value
+
+`unknown`
+
+The value to test.
+
+##### failures
+
+`IValidationFailure`[]
+
+The list of failures to add to.
+
+#### Returns
+
+`value is string`
+
+True if the value is valid epc.
+
+***
+
+### epcIdGtin()
+
+> `static` **epcIdGtin**(`propertyName`, `value`, `failures`): `value is string`
+
+Validate if the property is a valid epc id gtin.
+
+#### Parameters
+
+##### propertyName
+
+`string`
+
+The name of the property being validated.
+
+##### value
+
+`unknown`
+
+The value to test.
+
+##### failures
+
+`IValidationFailure`[]
+
+The list of failures to add to.
+
+#### Returns
+
+`value is string`
+
+True if the value is valid epc.
+
+***
+
+### epcIdGln()
+
+> `static` **epcIdGln**(`propertyName`, `value`, `failures`): `value is string`
+
+Validate if the property is a valid epc id gln.
+
+#### Parameters
+
+##### propertyName
+
+`string`
+
+The name of the property being validated.
+
+##### value
+
+`unknown`
+
+The value to test.
+
+##### failures
+
+`IValidationFailure`[]
+
+The list of failures to add to.
+
+#### Returns
+
+`value is string`
+
+True if the value is valid epc.
+
+***
+
+### epcClass()
+
+> `static` **epcClass**(`propertyName`, `value`, `failures`): `value is string`
+
+Validate if the property is a valid epc class.
+
+#### Parameters
+
+##### propertyName
+
+`string`
+
+The name of the property being validated.
+
+##### value
+
+`unknown`
+
+The value to test.
+
+##### failures
+
+`IValidationFailure`[]
+
+The list of failures to add to.
+
+#### Returns
+
+`value is string`
+
+True if the value is valid epc.
+
+***
+
+### extractEpcIdGtin()
+
+> `static` **extractEpcIdGtin**(`epc`): `undefined` \| `string`
+
+Extract the EPC gtin from the URI.
+
+#### Parameters
+
+##### epc
+
+`string`
+
+The uri to extract from.
+
+#### Returns
+
+`undefined` \| `string`
+
+The extracted data or undefined.
+
+***
+
+### extractEpcIdGln()
+
+> `static` **extractEpcIdGln**(`epc`): `undefined` \| `string`
+
+Extract the EPC gln from the URI.
+
+#### Parameters
+
+##### epc
+
+`string`
+
+The uri to extract from.
+
+#### Returns
+
+`undefined` \| `string`
+
+The extracted data or undefined.
+
+***
+
+### extractEpcClassUri()
+
+> `static` **extractEpcClassUri**(`epc`): `undefined` \| [`IEPCClassUri`](../interfaces/IEPCClassUri.md)
+
+Extract The EPC Class from the URI.
+
+#### Parameters
+
+##### epc
+
+`string`
+
+The uri to extract from.
+
+#### Returns
+
+`undefined` \| [`IEPCClassUri`](../interfaces/IEPCClassUri.md)
+
+The extracted data or undefined.

package/docs/reference/classes/Gs1Is.md

@@ -0,0 +1,57 @@
+# Class: Gs1Is
+
+Is checks for GS1 data.
+
+## Constructors
+
+### new Gs1Is()
+
+> **new Gs1Is**(): [`Gs1Is`](Gs1Is.md)
+
+#### Returns
+
+[`Gs1Is`](Gs1Is.md)
+
+## Methods
+
+### isEpcHex()
+
+> `static` **isEpcHex**(`value`): `boolean`
+
+Is the value an EPC identifier.
+
+#### Parameters
+
+##### value
+
+`string`
+
+The value to test.
+
+#### Returns
+
+`boolean`
+
+True if the value is an epc.
+
+***
+
+### isGeoUri()
+
+> `static` **isGeoUri**(`value`): `boolean`
+
+Is the value a valid geo uri https://en.wikipedia.org/wiki/Geo_URI_scheme.
+
+#### Parameters
+
+##### value
+
+`string`
+
+The value to check.
+
+#### Returns
+
+`boolean`
+
+True if the value matches a geo uri.

package/docs/reference/classes/Gs1Location.md

@@ -0,0 +1,135 @@
+# Class: Gs1Location
+
+Interface describing a GS1 Location master data.
+Spec https://www.gs1.org/sites/default/files/docs/epc/CBV-Standard-1-2-1-r-2017-05-05.pdf .
+Section 10.2 .
+
+## Constructors
+
+### new Gs1Location()
+
+> **new Gs1Location**(): [`Gs1Location`](Gs1Location.md)
+
+#### Returns
+
+[`Gs1Location`](Gs1Location.md)
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+The GS1 sgln identifier.
+
+***
+
+### site?
+
+> `optional` **site**: `string`
+
+Identifies the site in which the location is contained.
+
+***
+
+### sst?
+
+> `optional` **sst**: [`SubSiteTypes`](../type-aliases/SubSiteTypes.md)
+
+Sub site type describes the primary business function of the sub site location.
+
+***
+
+### ssa?
+
+> `optional` **ssa**: [`SubSiteAttributes`](../type-aliases/SubSiteAttributes.md)
+
+Sub site attribute further qualifies the business function of the sub site location.
+
+***
+
+### ssd?
+
+> `optional` **ssd**: `string`
+
+Sub site detail provides additional proprietary information.
+
+***
+
+### name?
+
+> `optional` **name**: `string`
+
+The name of the location.
+
+***
+
+### streetAddressOne?
+
+> `optional` **streetAddressOne**: `string`
+
+The street address line 1.
+
+***
+
+### streetAddressTwo?
+
+> `optional` **streetAddressTwo**: `string`
+
+The street address line 2.
+
+***
+
+### streetAddressThree?
+
+> `optional` **streetAddressThree**: `string`
+
+The street address line 3.
+
+***
+
+### city?
+
+> `optional` **city**: `string`
+
+City.
+
+***
+
+### state?
+
+> `optional` **state**: `string`
+
+State.
+
+***
+
+### postalCode?
+
+> `optional` **postalCode**: `string`
+
+Postal Code.
+
+***
+
+### countryCode?
+
+> `optional` **countryCode**: `string`
+
+Country Code The ISO 3166-1 alpha-2 code specifying the country for the address.
+
+***
+
+### latitude?
+
+> `optional` **latitude**: `number`
+
+The latitude of the location in degrees.
+
+***
+
+### longitude?
+
+> `optional` **longitude**: `number`
+
+The longitude of the location in degrees.

package/docs/reference/classes/Gs1Validation.md

@@ -0,0 +1,53 @@
+# Class: Gs1Validation
+
+Validation for GS1 types.
+
+## Constructors
+
+### new Gs1Validation()
+
+> **new Gs1Validation**(): [`Gs1Validation`](Gs1Validation.md)
+
+#### Returns
+
+[`Gs1Validation`](Gs1Validation.md)
+
+## Methods
+
+### locationMasterData()
+
+> `static` **locationMasterData**(`propertyName`, `value`, `failures`, `container`?): `value is Gs1Location`
+
+Validate if the property is a valid location.
+
+#### Parameters
+
+##### propertyName
+
+`string`
+
+The name of the property being validated.
+
+##### value
+
+[`Gs1Location`](Gs1Location.md)
+
+The value to test.
+
+##### failures
+
+`IValidationFailure`[]
+
+The list of failures to add to.
+
+##### container?
+
+`unknown`
+
+The object which contains this one.
+
+#### Returns
+
+`value is Gs1Location`
+
+True if the value is a location.

package/docs/reference/index.md

@@ -0,0 +1,57 @@
+# @twin.org/standards-gs1
+
+## Classes
+
+- [Gs1DataTypes](classes/Gs1DataTypes.md)
+- [Gs1Location](classes/Gs1Location.md)
+- [Gs1Identifiers](classes/Gs1Identifiers.md)
+- [Gs1IdentifiersValidation](classes/Gs1IdentifiersValidation.md)
+- [Gs1Is](classes/Gs1Is.md)
+- [Gs1Validation](classes/Gs1Validation.md)
+
+## Interfaces
+
+- [IEPCClassUri](interfaces/IEPCClassUri.md)
+- [IAggregationEvent](interfaces/IAggregationEvent.md)
+- [IAssociationEvent](interfaces/IAssociationEvent.md)
+- [IBizTransaction](interfaces/IBizTransaction.md)
+- [IDestination](interfaces/IDestination.md)
+- [IEpcisDocument](interfaces/IEpcisDocument.md)
+- [IEpcisEvent](interfaces/IEpcisEvent.md)
+- [IEpcisEventDetails](interfaces/IEpcisEventDetails.md)
+- [IEpcisQuery](interfaces/IEpcisQuery.md)
+- [IEpcisQueryDocument](interfaces/IEpcisQueryDocument.md)
+- [IObjectEvent](interfaces/IObjectEvent.md)
+- [IQuantity](interfaces/IQuantity.md)
+- [ISensorElement](interfaces/ISensorElement.md)
+- [ISensorMetadata](interfaces/ISensorMetadata.md)
+- [ISensorReport](interfaces/ISensorReport.md)
+- [ISimpleLocation](interfaces/ISimpleLocation.md)
+- [ISource](interfaces/ISource.md)
+
+## Type Aliases
+
+- [ActionTypes](type-aliases/ActionTypes.md)
+- [BizStepTypes](type-aliases/BizStepTypes.md)
+- [DispositionTypes](type-aliases/DispositionTypes.md)
+- [EpcisErrorTypes](type-aliases/EpcisErrorTypes.md)
+- [EpcisEventUnionType](type-aliases/EpcisEventUnionType.md)
+- [EventTypes](type-aliases/EventTypes.md)
+- [Gs1IdTypes](type-aliases/Gs1IdTypes.md)
+- [Gs1IdentifierTypes](type-aliases/Gs1IdentifierTypes.md)
+- [Gs1Types](type-aliases/Gs1Types.md)
+- [SubSiteAttributes](type-aliases/SubSiteAttributes.md)
+- [SubSiteTypes](type-aliases/SubSiteTypes.md)
+
+## Variables
+
+- [ActionTypes](variables/ActionTypes.md)
+- [BizStepTypes](variables/BizStepTypes.md)
+- [DispositionTypes](variables/DispositionTypes.md)
+- [EpcisErrorTypes](variables/EpcisErrorTypes.md)
+- [EventTypes](variables/EventTypes.md)
+- [Gs1IdTypes](variables/Gs1IdTypes.md)
+- [Gs1IdentifierTypes](variables/Gs1IdentifierTypes.md)
+- [Gs1Types](variables/Gs1Types.md)
+- [SubSiteAttributes](variables/SubSiteAttributes.md)
+- [SubSiteTypes](variables/SubSiteTypes.md)

package/docs/reference/interfaces/IAggregationEvent.md

@@ -0,0 +1,223 @@
+# 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`