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

package/docs/examples.md

@@ -1 +1,58 @@
-# @twin.org/standards-gs1 - Examples
+# Standards GS1 Examples
+
+These snippets cover identifier checks, helper extraction methods, validation utilities, and schema registration.
+
+## Gs1IdentifiersValidation
+
+```typescript
+import type { IValidationFailure } from '@twin.org/core';
+import { Gs1IdentifiersValidation } from '@twin.org/standards-gs1';
+
+const failures: IValidationFailure[] = [];
+const epc = 'urn:epc:id:sgtin:0614141.112345.400';
+
+const valid = Gs1IdentifiersValidation.epcId('item.id', epc, failures);
+const gtin = Gs1IdentifiersValidation.extractEpcIdGtin(epc);
+const gln = Gs1IdentifiersValidation.extractEpcIdGln('urn:epc:id:sgln:0614141.12345.0');
+
+console.log(valid); // true
+console.log(gtin); // 0614141.112345.400
+console.log(gln); // 0614141.12345.0
+```
+
+## Gs1Validation
+
+```typescript
+import type { IValidationFailure } from '@twin.org/core';
+import { Gs1Location, Gs1Validation } from '@twin.org/standards-gs1';
+
+const failures: IValidationFailure[] = [];
+const location = new Gs1Location();
+location.id = 'urn:epc:id:sgln:0614141.12345.0';
+location.city = 'Rotterdam';
+location.countryCode = 'NL';
+location.latitude = 51.9244;
+location.longitude = 4.4777;
+
+const valid = Gs1Validation.locationMasterData('location', location, failures);
+
+console.log(valid); // true
+console.log(failures.length); // 0
+```
+
+## Gs1Is And Data Type Registration
+
+```typescript
+import { EpcisDataTypes, Gs1DataTypes, Gs1Identifiers, Gs1Is } from '@twin.org/standards-gs1';
+
+EpcisDataTypes.registerRedirects();
+EpcisDataTypes.registerTypes();
+Gs1DataTypes.registerTypes();
+Gs1Identifiers.registerIdentifiers();
+
+const isHex = Gs1Is.isEpcHex('3034257BF7194E4000001A85');
+const isGeo = Gs1Is.isGeoUri('geo:51.9244,4.4777');
+
+console.log(isHex); // true
+console.log(isGeo); // true
+```

package/docs/reference/classes/EpcisDataTypes.md

@@ -0,0 +1,37 @@
+# Class: EpcisDataTypes
+
+Handle all the data types for EPCIS.
+
+## Constructors
+
+### Constructor
+
+> **new EpcisDataTypes**(): `EpcisDataTypes`
+
+#### Returns
+
+`EpcisDataTypes`
+
+## Methods
+
+### registerRedirects() {#registerredirects}
+
+> `static` **registerRedirects**(): `void`
+
+Register the JSON-LD Redirects.
+
+#### Returns
+
+`void`
+
+***
+
+### registerTypes() {#registertypes}
+
+> `static` **registerTypes**(): `void`
+
+Register all the data types.
+
+#### Returns
+
+`void`

package/docs/reference/classes/Gs1DataTypes.md

@@ -1,7 +1,10 @@
 # Class: Gs1DataTypes
 
 Handle all the data types for GS1.
-Vocabulary https://www.gs1.org/voc .
+
+## See
+
+https://www.gs1.org/voc
 
 ## Constructors
 
@@ -15,7 +18,7 @@ Vocabulary https://www.gs1.org/voc .
 
 ## Methods
 
-### registerTypes()
+### registerTypes() {#registertypes}
 
 > `static` **registerTypes**(): `void`
 

package/docs/reference/classes/Gs1Identifiers.md

@@ -14,7 +14,7 @@ Handle all identifier types for GS1.
 
 ## Methods
 
-### registerIdentifiers()
+### registerIdentifiers() {#registeridentifiers}
 
 > `static` **registerIdentifiers**(): `void`
 

package/docs/reference/classes/Gs1IdentifiersValidation.md

@@ -14,7 +14,7 @@ Validation for GS1 identifiers.
 
 ## Methods
 
-### epcId()
+### epcId() {#epcid}
 
 > `static` **epcId**(`propertyName`, `value`, `failures`): `value is string`
 
@@ -48,7 +48,7 @@ True if the value is valid epc.
 
 ***
 
-### epcIdGtin()
+### epcIdGtin() {#epcidgtin}
 
 > `static` **epcIdGtin**(`propertyName`, `value`, `failures`): `value is string`
 
@@ -82,7 +82,7 @@ True if the value is valid epc.
 
 ***
 
-### epcIdGln()
+### epcIdGln() {#epcidgln}
 
 > `static` **epcIdGln**(`propertyName`, `value`, `failures`): `value is string`
 
@@ -116,7 +116,7 @@ True if the value is valid epc.
 
 ***
 
-### epcClass()
+### epcClass() {#epcclass}
 
 > `static` **epcClass**(`propertyName`, `value`, `failures`): `value is string`
 
@@ -150,7 +150,7 @@ True if the value is valid epc.
 
 ***
 
-### extractEpcIdGtin()
+### extractEpcIdGtin() {#extractepcidgtin}
 
 > `static` **extractEpcIdGtin**(`epc`): `string` \| `undefined`
 
@@ -172,7 +172,7 @@ The extracted data or undefined.
 
 ***
 
-### extractEpcIdGln()
+### extractEpcIdGln() {#extractepcidgln}
 
 > `static` **extractEpcIdGln**(`epc`): `string` \| `undefined`
 
@@ -194,7 +194,7 @@ The extracted data or undefined.
 
 ***
 
-### extractEpcClassUri()
+### extractEpcClassUri() {#extractepcclassuri}
 
 > `static` **extractEpcClassUri**(`epc`): [`IEPCClassUri`](../interfaces/IEPCClassUri.md) \| `undefined`
 

package/docs/reference/classes/Gs1Is.md

@@ -14,7 +14,7 @@ Is checks for GS1 data.
 
 ## Methods
 
-### isEpcHex()
+### isEpcHex() {#isepchex}
 
 > `static` **isEpcHex**(`value`): `boolean`
 
@@ -36,11 +36,11 @@ True if the value is an epc.
 
 ***
 
-### isGeoUri()
+### isGeoUri() {#isgeouri}
 
 > `static` **isGeoUri**(`value`): `boolean`
 
-Is the value a valid geo uri https://en.wikipedia.org/wiki/Geo_URI_scheme.
+Is the value a valid geo URI.
 
 #### Parameters
 
@@ -54,4 +54,8 @@ The value to check.
 
 `boolean`
 
-True if the value matches a geo uri.
+True if the value matches the geo URI scheme.
+
+#### See
+
+https://en.wikipedia.org/wiki/Geo_URI_scheme

package/docs/reference/classes/Gs1Location.md

@@ -1,8 +1,10 @@
 # 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 .
+GS1 Location master data entity.
+
+## See
+
+https://www.gs1.org/sites/default/files/docs/epc/CBV-Standard-1-2-1-r-2017-05-05.pdf
 
 ## Constructors
 
@@ -16,7 +18,7 @@ Section 10.2 .
 
 ## Properties
 
-### id
+### id {#id}
 
 > **id**: `string`
 
@@ -24,112 +26,112 @@ The GS1 sgln identifier.
 
 ***
 
-### site?
+### site? {#site}
 
-> `optional` **site**: `string`
+> `optional` **site?**: `string`
 
 Identifies the site in which the location is contained.
 
 ***
 
-### sst?
+### sst? {#sst}
 
-> `optional` **sst**: [`Gs1SubSiteTypes`](../type-aliases/Gs1SubSiteTypes.md)
+> `optional` **sst?**: [`Gs1SubSiteTypes`](../type-aliases/Gs1SubSiteTypes.md)
 
 Sub site type describes the primary business function of the sub site location.
 
 ***
 
-### ssa?
+### ssa? {#ssa}
 
-> `optional` **ssa**: [`Gs1SubSiteAttributes`](../type-aliases/Gs1SubSiteAttributes.md)
+> `optional` **ssa?**: [`Gs1SubSiteAttributes`](../type-aliases/Gs1SubSiteAttributes.md)
 
 Sub site attribute further qualifies the business function of the sub site location.
 
 ***
 
-### ssd?
+### ssd? {#ssd}
 
-> `optional` **ssd**: `string`
+> `optional` **ssd?**: `string`
 
 Sub site detail provides additional proprietary information.
 
 ***
 
-### name?
+### name? {#name}
 
-> `optional` **name**: `string`
+> `optional` **name?**: `string`
 
 The name of the location.
 
 ***
 
-### streetAddressOne?
+### streetAddressOne? {#streetaddressone}
 
-> `optional` **streetAddressOne**: `string`
+> `optional` **streetAddressOne?**: `string`
 
 The street address line 1.
 
 ***
 
-### streetAddressTwo?
+### streetAddressTwo? {#streetaddresstwo}
 
-> `optional` **streetAddressTwo**: `string`
+> `optional` **streetAddressTwo?**: `string`
 
 The street address line 2.
 
 ***
 
-### streetAddressThree?
+### streetAddressThree? {#streetaddressthree}
 
-> `optional` **streetAddressThree**: `string`
+> `optional` **streetAddressThree?**: `string`
 
 The street address line 3.
 
 ***
 
-### city?
+### city? {#city}
 
-> `optional` **city**: `string`
+> `optional` **city?**: `string`
 
 City.
 
 ***
 
-### state?
+### state? {#state}
 
-> `optional` **state**: `string`
+> `optional` **state?**: `string`
 
 State.
 
 ***
 
-### postalCode?
+### postalCode? {#postalcode}
 
-> `optional` **postalCode**: `string`
+> `optional` **postalCode?**: `string`
 
 Postal Code.
 
 ***
 
-### countryCode?
+### countryCode? {#countrycode}
 
-> `optional` **countryCode**: `string`
+> `optional` **countryCode?**: `string`
 
 Country Code The ISO 3166-1 alpha-2 code specifying the country for the address.
 
 ***
 
-### latitude?
+### latitude? {#latitude}
 
-> `optional` **latitude**: `number`
+> `optional` **latitude?**: `number`
 
 The latitude of the location in degrees.
 
 ***
 
-### longitude?
+### longitude? {#longitude}
 
-> `optional` **longitude**: `number`
+> `optional` **longitude?**: `number`
 
 The longitude of the location in degrees.

package/docs/reference/classes/Gs1Validation.md

@@ -14,7 +14,7 @@ Validation for GS1 types.
 
 ## Methods
 
-### locationMasterData()
+### locationMasterData() {#locationmasterdata}
 
 > `static` **locationMasterData**(`propertyName`, `value`, `failures`, `container?`): `value is Gs1Location`
 

package/docs/reference/index.md

@@ -2,6 +2,7 @@
 
 ## Classes
 
+- [EpcisDataTypes](classes/EpcisDataTypes.md)
 - [Gs1DataTypes](classes/Gs1DataTypes.md)
 - [Gs1Location](classes/Gs1Location.md)
 - [Gs1Identifiers](classes/Gs1Identifiers.md)
@@ -12,31 +13,49 @@
 ## Interfaces
 
 - [IEPCClassUri](interfaces/IEPCClassUri.md)
-- [IAggregationEvent](interfaces/IAggregationEvent.md)
-- [IAssociationEvent](interfaces/IAssociationEvent.md)
-- [IBizTransaction](interfaces/IBizTransaction.md)
-- [IDestination](interfaces/IDestination.md)
+- [IEpcisAggregationEvent](interfaces/IEpcisAggregationEvent.md)
+- [IEpcisAssociationEvent](interfaces/IEpcisAssociationEvent.md)
+- [IEpcisAttribute](interfaces/IEpcisAttribute.md)
+- [IEpcisBizTransaction](interfaces/IEpcisBizTransaction.md)
+- [IEpcisDestination](interfaces/IEpcisDestination.md)
 - [IEpcisDocument](interfaces/IEpcisDocument.md)
+- [IEpcisErrorDeclaration](interfaces/IEpcisErrorDeclaration.md)
 - [IEpcisEvent](interfaces/IEpcisEvent.md)
-- [IEpcisEventDetails](interfaces/IEpcisEventDetails.md)
-- [IObjectEvent](interfaces/IObjectEvent.md)
-- [IQuantity](interfaces/IQuantity.md)
+- [IEpcisHeader](interfaces/IEpcisHeader.md)
+- [IEpcisIlmd](interfaces/IEpcisIlmd.md)
+- [IEpcisLocation](interfaces/IEpcisLocation.md)
+- [IEpcisObjectEvent](interfaces/IEpcisObjectEvent.md)
+- [IEpcisPersistentDisposition](interfaces/IEpcisPersistentDisposition.md)
+- [IEpcisQuantity](interfaces/IEpcisQuantity.md)
 - [IEpcisQuery](interfaces/IEpcisQuery.md)
 - [IEpcisQueryDocument](interfaces/IEpcisQueryDocument.md)
-- [ISensorElement](interfaces/ISensorElement.md)
-- [ISensorMetadata](interfaces/ISensorMetadata.md)
-- [ISensorReport](interfaces/ISensorReport.md)
-- [ISimpleLocation](interfaces/ISimpleLocation.md)
-- [ISource](interfaces/ISource.md)
+- [IEpcisQueryDocumentBody](interfaces/IEpcisQueryDocumentBody.md)
+- [IEpcisQueryResults](interfaces/IEpcisQueryResults.md)
+- [IEpcisQueryResultsBody](interfaces/IEpcisQueryResultsBody.md)
+- [IEpcisSensorElement](interfaces/IEpcisSensorElement.md)
+- [IEpcisSensorMetadata](interfaces/IEpcisSensorMetadata.md)
+- [IEpcisSensorReport](interfaces/IEpcisSensorReport.md)
+- [IEpcisSource](interfaces/IEpcisSource.md)
+- [IEpcisTransactionEvent](interfaces/IEpcisTransactionEvent.md)
+- [IEpcisTransformationEvent](interfaces/IEpcisTransformationEvent.md)
+- [IEpcisVocabulary](interfaces/IEpcisVocabulary.md)
+- [IEpcisVocabularyElement](interfaces/IEpcisVocabularyElement.md)
 
 ## Type Aliases
 
 - [EpcisActionTypes](type-aliases/EpcisActionTypes.md)
 - [EpcisBizStepTypes](type-aliases/EpcisBizStepTypes.md)
+- [EpcisBizTransactionTypes](type-aliases/EpcisBizTransactionTypes.md)
+- [EpcisComponentTypes](type-aliases/EpcisComponentTypes.md)
+- [EpcisContextType](type-aliases/EpcisContextType.md)
+- [EpcisContexts](type-aliases/EpcisContexts.md)
 - [EpcisDispositionTypes](type-aliases/EpcisDispositionTypes.md)
-- [EpcisErrorTypes](type-aliases/EpcisErrorTypes.md)
+- [EpcisErrorReasonTypes](type-aliases/EpcisErrorReasonTypes.md)
 - [EpcisEventTypes](type-aliases/EpcisEventTypes.md)
-- [EpcisEventUnionType](type-aliases/EpcisEventUnionType.md)
+- [EpcisEvents](type-aliases/EpcisEvents.md)
+- [EpcisMeasurementTypes](type-aliases/EpcisMeasurementTypes.md)
+- [EpcisSensorAlertTypes](type-aliases/EpcisSensorAlertTypes.md)
+- [EpcisSourceDestTypes](type-aliases/EpcisSourceDestTypes.md)
 - [GS1Contexts](type-aliases/GS1Contexts.md)
 - [Gs1IdTypes](type-aliases/Gs1IdTypes.md)
 - [Gs1IdentifierTypes](type-aliases/Gs1IdentifierTypes.md)
@@ -48,9 +67,15 @@
 
 - [EpcisActionTypes](variables/EpcisActionTypes.md)
 - [EpcisBizStepTypes](variables/EpcisBizStepTypes.md)
+- [EpcisBizTransactionTypes](variables/EpcisBizTransactionTypes.md)
+- [EpcisComponentTypes](variables/EpcisComponentTypes.md)
+- [EpcisContexts](variables/EpcisContexts.md)
 - [EpcisDispositionTypes](variables/EpcisDispositionTypes.md)
-- [EpcisErrorTypes](variables/EpcisErrorTypes.md)
+- [EpcisErrorReasonTypes](variables/EpcisErrorReasonTypes.md)
 - [EpcisEventTypes](variables/EpcisEventTypes.md)
+- [EpcisMeasurementTypes](variables/EpcisMeasurementTypes.md)
+- [EpcisSensorAlertTypes](variables/EpcisSensorAlertTypes.md)
+- [EpcisSourceDestTypes](variables/EpcisSourceDestTypes.md)
 - [GS1Contexts](variables/GS1Contexts.md)
 - [Gs1IdTypes](variables/Gs1IdTypes.md)
 - [Gs1IdentifierTypes](variables/Gs1IdentifierTypes.md)

package/docs/reference/interfaces/IEPCClassUri.md

@@ -4,7 +4,7 @@ Interface for EPC class URI.
 
 ## Properties
 
-### companyPrefix
+### companyPrefix {#companyprefix}
 
 > **companyPrefix**: `string`
 
@@ -12,7 +12,7 @@ The company prefix.
 
 ***
 
-### itemRefAndIndicator
+### itemRefAndIndicator {#itemrefandindicator}
 
 > **itemRefAndIndicator**: `string`
 
@@ -20,7 +20,7 @@ The item reference number.
 
 ***
 
-### lot
+### lot {#lot}
 
 > **lot**: `string`