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

package/docs/reference/classes/VdaIdentifiersValidation.md

@@ -0,0 +1,237 @@
+# Class: VdaIdentifiersValidation
+
+Validation for identifier types for VDA.
+
+## Constructors
+
+### new VdaIdentifiersValidation()
+
+> **new VdaIdentifiersValidation**(): [`VdaIdentifiersValidation`](VdaIdentifiersValidation.md)
+
+#### Returns
+
+[`VdaIdentifiersValidation`](VdaIdentifiersValidation.md)
+
+## Methods
+
+### jaifId()
+
+> `static` **jaifId**(`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.
+
+***
+
+### jaifIdLocation()
+
+> `static` **jaifIdLocation**(`propertyName`, `value`, `failures`): `value is string`
+
+Validate if the property is a valid epc vda id location.
+
+#### 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.
+
+***
+
+### jaifIdItem()
+
+> `static` **jaifIdItem**(`propertyName`, `value`, `failures`): `value is string`
+
+Validate if the property is a valid epc vda id item.
+
+#### 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.
+
+***
+
+### uriPlp()
+
+> `static` **uriPlp**(`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.
+
+***
+
+### extractReadPoint()
+
+> `static` **extractReadPoint**(`urn`): `undefined` \| [`IVdaReadPoint`](../interfaces/IVdaReadPoint.md)
+
+Function to validate and extract RFID read points URNs.
+
+#### Parameters
+
+##### urn
+
+`string`
+
+The URN to validate.
+
+#### Returns
+
+`undefined` \| [`IVdaReadPoint`](../interfaces/IVdaReadPoint.md)
+
+The extracted read point object or undefined.
+
+***
+
+### extractBizLocation()
+
+> `static` **extractBizLocation**(`urn`): `undefined` \| [`IVdaBizLocation`](../interfaces/IVdaBizLocation.md)
+
+Function to validate and extract Biz Location URN.
+
+#### Parameters
+
+##### urn
+
+`string`
+
+The URN to validate.
+
+#### Returns
+
+`undefined` \| [`IVdaBizLocation`](../interfaces/IVdaBizLocation.md)
+
+The extracted biz location object or undefined.
+
+***
+
+### extractUriPlp()
+
+> `static` **extractUriPlp**(`id`): `undefined` \| [`IVdaUriPlates`](../interfaces/IVdaUriPlates.md)
+
+Function to validate VDA URI Packages License Plates.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The VDA URI to validate.
+
+#### Returns
+
+`undefined` \| [`IVdaUriPlates`](../interfaces/IVdaUriPlates.md)
+
+The VDA URI object or undefined.
+
+***
+
+### extractIdentifier()
+
+> `static` **extractIdentifier**(`epc`): `undefined` \| [`IVdaObjectIdentifier`](../interfaces/IVdaObjectIdentifier.md)
+
+VDA object identifier verifier function.
+
+#### Parameters
+
+##### epc
+
+`string`
+
+The epc to validate.
+
+#### Returns
+
+`undefined` \| [`IVdaObjectIdentifier`](../interfaces/IVdaObjectIdentifier.md)
+
+The VDA object or undefined.

package/docs/reference/index.md

@@ -0,0 +1,28 @@
+# @twin.org/standards-vda
+
+## Classes
+
+- [VdaIdentifiers](classes/VdaIdentifiers.md)
+- [VdaIdentifiersValidation](classes/VdaIdentifiersValidation.md)
+
+## Interfaces
+
+- [IVdaBizLocation](interfaces/IVdaBizLocation.md)
+- [IVdaCommon](interfaces/IVdaCommon.md)
+- [IVdaObjectIdentifier](interfaces/IVdaObjectIdentifier.md)
+- [IVdaReadPoint](interfaces/IVdaReadPoint.md)
+- [IVdaUriPlates](interfaces/IVdaUriPlates.md)
+
+## Type Aliases
+
+- [VdaIdTypes](type-aliases/VdaIdTypes.md)
+- [VdaIdentifierTypes](type-aliases/VdaIdentifierTypes.md)
+- [VdaUriIdentifiers](type-aliases/VdaUriIdentifiers.md)
+- [VdaUriPackages](type-aliases/VdaUriPackages.md)
+
+## Variables
+
+- [VdaIdTypes](variables/VdaIdTypes.md)
+- [VdaIdentifierTypes](variables/VdaIdentifierTypes.md)
+- [VdaUriIdentifiers](variables/VdaUriIdentifiers.md)
+- [VdaUriPackages](variables/VdaUriPackages.md)

package/docs/reference/interfaces/IVdaBizLocation.md

@@ -0,0 +1,47 @@
+# Interface: IVdaBizLocation
+
+Interface for a VDA Biz Location.
+
+## Extends
+
+- [`IVdaCommon`](IVdaCommon.md)
+
+## Properties
+
+### dunsNumber
+
+> **dunsNumber**: `string`
+
+DUNS Number.
+
+***
+
+### plantBuildingFloorRoom
+
+> **plantBuildingFloorRoom**: `string`
+
+Plant Building Floor and Room.
+
+***
+
+### dataIdentifier
+
+> **dataIdentifier**: `string`
+
+Data Identifier (DI).
+
+#### Inherited from
+
+[`IVdaCommon`](IVdaCommon.md).[`dataIdentifier`](IVdaCommon.md#dataidentifier)
+
+***
+
+### issuingAgencyCode
+
+> **issuingAgencyCode**: `string`
+
+Issuing Agency Code (IAC).
+
+#### Inherited from
+
+[`IVdaCommon`](IVdaCommon.md).[`issuingAgencyCode`](IVdaCommon.md#issuingagencycode)

package/docs/reference/interfaces/IVdaCommon.md

@@ -0,0 +1,25 @@
+# Interface: IVdaCommon
+
+Common VDA interface.
+
+## Extended by
+
+- [`IVdaBizLocation`](IVdaBizLocation.md)
+- [`IVdaObjectIdentifier`](IVdaObjectIdentifier.md)
+- [`IVdaReadPoint`](IVdaReadPoint.md)
+
+## Properties
+
+### dataIdentifier
+
+> **dataIdentifier**: `string`
+
+Data Identifier (DI).
+
+***
+
+### issuingAgencyCode
+
+> **issuingAgencyCode**: `string`
+
+Issuing Agency Code (IAC).

package/docs/reference/interfaces/IVdaObjectIdentifier.md

@@ -0,0 +1,55 @@
+# Interface: IVdaObjectIdentifier
+
+Interface for VDA object identifier.
+
+## Extends
+
+- [`IVdaCommon`](IVdaCommon.md)
+
+## Properties
+
+### dataIdentifier
+
+> **dataIdentifier**: `string`
+
+Data Identifier (DI).
+
+#### Inherited from
+
+[`IVdaCommon`](IVdaCommon.md).[`dataIdentifier`](IVdaCommon.md#dataidentifier)
+
+***
+
+### issuingAgencyCode
+
+> **issuingAgencyCode**: `string`
+
+Issuing Agency Code (IAC).
+
+#### Inherited from
+
+[`IVdaCommon`](IVdaCommon.md).[`issuingAgencyCode`](IVdaCommon.md#issuingagencycode)
+
+***
+
+### companyIdNumber
+
+> **companyIdNumber**: `string`
+
+The company identification number.
+
+***
+
+### partNumber
+
+> **partNumber**: `string`
+
+The part number.
+
+***
+
+### partSerialNumber
+
+> **partSerialNumber**: `string`
+
+The part serial number.

package/docs/reference/interfaces/IVdaReadPoint.md

@@ -0,0 +1,63 @@
+# Interface: IVdaReadPoint
+
+Interface for VDA read point.
+
+## Extends
+
+- [`IVdaCommon`](IVdaCommon.md)
+
+## Properties
+
+### dataIdentifier
+
+> **dataIdentifier**: `string`
+
+Data Identifier (DI).
+
+#### Inherited from
+
+[`IVdaCommon`](IVdaCommon.md).[`dataIdentifier`](IVdaCommon.md#dataidentifier)
+
+***
+
+### issuingAgencyCode
+
+> **issuingAgencyCode**: `string`
+
+Issuing Agency Code (IAC).
+
+#### Inherited from
+
+[`IVdaCommon`](IVdaCommon.md).[`issuingAgencyCode`](IVdaCommon.md#issuingagencycode)
+
+***
+
+### dunsNumber
+
+> **dunsNumber**: `string`
+
+DUNS Number.
+
+***
+
+### plant
+
+> **plant**: `string`
+
+Plant.
+
+***
+
+### costCenter
+
+> **costCenter**: `string`
+
+Cost Center.
+
+***
+
+### serialNumber
+
+> **serialNumber**: `string`
+
+Device Name/Serial Number.

package/docs/reference/interfaces/IVdaUriPlates.md

@@ -0,0 +1,43 @@
+# Interface: IVdaUriPlates
+
+Interface for VDA URI plates.
+
+## Properties
+
+### applicationFamilyIdentifier
+
+> **applicationFamilyIdentifier**: `string`
+
+Application family identifier A2 or A5.
+
+***
+
+### typeOfPackage
+
+> **typeOfPackage**: `string`
+
+The type of package 2. Alphanumeric characters.
+
+***
+
+### issuingAgencyCode
+
+> **issuingAgencyCode**: `string`
+
+The issuing agency. 2 alphanumeric characters.
+
+***
+
+### companyIdentificationNumber
+
+> **companyIdentificationNumber**: `string`
+
+The company identification number.
+
+***
+
+### packageSerialNumber
+
+> **packageSerialNumber**: `string`
+
+The serial number of the package.

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

@@ -0,0 +1,5 @@
+# Type Alias: VdaIdTypes
+
+> **VdaIdTypes**: *typeof* [`VdaIdTypes`](../variables/VdaIdTypes.md)\[keyof *typeof* [`VdaIdTypes`](../variables/VdaIdTypes.md)\]
+
+VDA identifiers.

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

@@ -0,0 +1,5 @@
+# Type Alias: VdaIdentifierTypes
+
+> **VdaIdentifierTypes**: *typeof* [`VdaIdentifierTypes`](../variables/VdaIdentifierTypes.md)\[keyof *typeof* [`VdaIdentifierTypes`](../variables/VdaIdentifierTypes.md)\]
+
+The types of VDA Identifier data.

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

@@ -0,0 +1,5 @@
+# Type Alias: VdaUriIdentifiers
+
+> **VdaUriIdentifiers**: *typeof* [`VdaUriIdentifiers`](../variables/VdaUriIdentifiers.md)\[keyof *typeof* [`VdaUriIdentifiers`](../variables/VdaUriIdentifiers.md)\]
+
+VDA URI Packages License Plates identifiers.

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

@@ -0,0 +1,5 @@
+# Type Alias: VdaUriPackages
+
+> **VdaUriPackages**: *typeof* [`VdaUriPackages`](../variables/VdaUriPackages.md)\[keyof *typeof* [`VdaUriPackages`](../variables/VdaUriPackages.md)\]
+
+VDA URI Packages License Plates identifiers.

package/docs/reference/variables/VdaIdTypes.md

@@ -0,0 +1,19 @@
+# Variable: VdaIdTypes
+
+> `const` **VdaIdTypes**: `object`
+
+VDA identifiers.
+
+## Type declaration
+
+### Obj
+
+> `readonly` **Obj**: `"obj"` = `"obj"`
+
+Object.
+
+### Loc
+
+> `readonly` **Loc**: `"loc"` = `"loc"`
+
+Location.

package/docs/reference/variables/VdaIdentifierTypes.md

@@ -0,0 +1,25 @@
+# Variable: VdaIdentifierTypes
+
+> `const` **VdaIdentifierTypes**: `object`
+
+The types of VDA Identifier data.
+
+## Type declaration
+
+### JaifId
+
+> `readonly` **JaifId**: `"jaif:id"` = `"jaif:id"`
+
+Identifier Joint Automotive Industry Format namespace.
+
+### JaifLocation
+
+> `readonly` **JaifLocation**: `"jaif:id@location"` = `"jaif:id@location"`
+
+Specific extended namespace for location validation.
+
+### JaifItem
+
+> `readonly` **JaifItem**: `"jaif:id@item"` = `"jaif:id@item"`
+
+Specific extended namespace for item validation.

package/docs/reference/variables/VdaUriIdentifiers.md

@@ -0,0 +1,73 @@
+# Variable: VdaUriIdentifiers
+
+> `const` **VdaUriIdentifiers**: `object`
+
+VDA URI Packages License Plates identifiers.
+
+## Type declaration
+
+### RfidProductTagging
+
+> `readonly` **RfidProductTagging**: `"A1"` = `"A1"`
+
+ISO 17367 Supply chain applications for RFID - Product tagging.
+
+### RfidTransportUnit
+
+> `readonly` **RfidTransportUnit**: `"A2"` = `"A2"`
+
+ISO 17365 Supply chain applications for RFID - Transport unit.
+
+### RfidReturnableTransportItem
+
+> `readonly` **RfidReturnableTransportItem**: `"A3"` = `"A3"`
+
+ISO 17364 Supply chain applications for RFID - Returnable transport item.
+
+### RfidProductTaggingHazmat
+
+> `readonly` **RfidProductTaggingHazmat**: `"A4"` = `"A4"`
+
+ISO 17367 Supply chain applications for RFID - Product tagging (HazMat).
+
+### RfidProductPackaging
+
+> `readonly` **RfidProductPackaging**: `"A5"` = `"A5"`
+
+ISO 17366 Supply chain applications for RFID - Product packaging.
+
+### RfidProductPackagingHazmat
+
+> `readonly` **RfidProductPackagingHazmat**: `"A6"` = `"A6"`
+
+ISO 17366 Supply chain applications for RFID - Product packaging (HazMat).
+
+### RfidTransportUnitHazmat
+
+> `readonly` **RfidTransportUnitHazmat**: `"A7"` = `"A7"`
+
+ISO 17365 Supply chain applications for RFID - Transport unit (HazMat).
+
+### RfidReturnableTransportItemHazmat
+
+> `readonly` **RfidReturnableTransportItemHazmat**: `"A8"` = `"A8"`
+
+ISO 17364 Supply chain applications for RFID - Returnable transport item (Hazmat).
+
+### RfidFreightContainer
+
+> `readonly` **RfidFreightContainer**: `"A9"` = `"A9"`
+
+ISO 17363 Supply chain applications for RFID - Freight container.
+
+### RfidFreightContainerHazmat
+
+> `readonly` **RfidFreightContainerHazmat**: `"AA"` = `"AA"`
+
+ISO 17363 Supply chain applications for RFID - Freight container (HazMat).
+
+### VehicleIdentificationNumber
+
+> `readonly` **VehicleIdentificationNumber**: `"90"` = `"90"`
+
+Vehicle identified with the Vehicle Identification Number (VIN) as defined in ISO 3779.

package/docs/reference/variables/VdaUriPackages.md

@@ -0,0 +1,37 @@
+# Variable: VdaUriPackages
+
+> `const` **VdaUriPackages**: `object`
+
+VDA URI Packages License Plates identifiers.
+
+## Type declaration
+
+### Package1J
+
+> `readonly` **Package1J**: `"1J"` = `"1J"`
+
+Unique package ID of inner packaging (Single Label).
+
+### Package3J
+
+> `readonly` **Package3J**: `"3J"` = `"3J"`
+
+Unique package ID of JIS loading unit with compartments.
+
+### Package4J
+
+> `readonly` **Package4J**: `"4J"` = `"4J"`
+
+Unique package ID of JIS loading unit with 1...n JIS packages.
+
+### Package5J
+
+> `readonly` **Package5J**: `"5J"` = `"5J"`
+
+Unique package ID of mixed loading unit with intermediate packaging level (mixed master).
+
+### Package67
+
+> `readonly` **Package67**: `"6J"` = `"6J"`
+
+Unique package ID of loading unit or intermediate packaging containing identical parts.

package/locales/en.json

@@ -0,0 +1 @@
+{}