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

package/dist/esm/index.mjs

@@ -0,0 +1,327 @@
+import { IdentifierHandlerFactory } from '@twin.org/data-core';
+import { Urn, Is } from '@twin.org/core';
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types of VDA Identifier data.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const VdaIdentifierTypes = {
+    /**
+     * Identifier Joint Automotive Industry Format namespace.
+     */
+    JaifId: "jaif:id",
+    /**
+     * Specific extended namespace for location validation.
+     */
+    JaifLocation: "jaif:id@location",
+    /**
+     * Specific extended namespace for item validation.
+     */
+    JaifItem: "jaif:id@item"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * VDA URI Packages License Plates identifiers.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const VdaUriIdentifiers = {
+    /**
+     * ISO 17367 Supply chain applications for RFID - Product tagging.
+     */
+    RfidProductTagging: "A1",
+    /**
+     * ISO 17365 Supply chain applications for RFID - Transport unit.
+     */
+    RfidTransportUnit: "A2",
+    /**
+     * ISO 17364 Supply chain applications for RFID - Returnable transport item.
+     */
+    RfidReturnableTransportItem: "A3",
+    /**
+     * ISO 17367 Supply chain applications for RFID - Product tagging (HazMat).
+     */
+    RfidProductTaggingHazmat: "A4",
+    /**
+     * ISO 17366 Supply chain applications for RFID - Product packaging.
+     */
+    RfidProductPackaging: "A5",
+    /**
+     * ISO 17366 Supply chain applications for RFID - Product packaging (HazMat).
+     */
+    RfidProductPackagingHazmat: "A6",
+    /**
+     * ISO 17365 Supply chain applications for RFID - Transport unit (HazMat).
+     */
+    RfidTransportUnitHazmat: "A7",
+    /**
+     * ISO 17364 Supply chain applications for RFID - Returnable transport item (Hazmat).
+     */
+    RfidReturnableTransportItemHazmat: "A8",
+    /**
+     * ISO 17363 Supply chain applications for RFID - Freight container.
+     */
+    RfidFreightContainer: "A9",
+    /**
+     * ISO 17363 Supply chain applications for RFID - Freight container (HazMat).
+     */
+    RfidFreightContainerHazmat: "AA",
+    /**
+     * Vehicle identified with the Vehicle Identification Number (VIN) as defined in ISO 3779.
+     */
+    VehicleIdentificationNumber: "90"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * VDA URI Packages License Plates identifiers.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const VdaUriPackages = {
+    /**
+     * Unique package ID of inner packaging (Single Label).
+     */
+    Package1J: "1J",
+    /**
+     * Unique package ID of JIS loading unit with compartments.
+     */
+    Package3J: "3J",
+    /**
+     * Unique package ID of JIS loading unit with 1...n JIS packages.
+     */
+    Package4J: "4J",
+    /**
+     * Unique package ID of mixed loading unit with intermediate packaging level (mixed master).
+     */
+    Package5J: "5J",
+    /**
+     * Unique package ID of loading unit or intermediate packaging containing identical parts.
+     */
+    Package67: "6J"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Validation for identifier types for VDA.
+ */
+class VdaIdentifiersValidation {
+    /**
+     * Validate if the property is a valid epc.
+     * @param propertyName The name of the property being validated.
+     * @param value The value to test.
+     * @param failures The list of failures to add to.
+     * @returns True if the value is valid epc.
+     */
+    static jaifId(propertyName, value, failures) {
+        const is = Urn.validate("value", value, failures);
+        if (is) {
+            const urn = Urn.fromValidString(value);
+            const specificParts = urn.namespaceSpecific().split(":");
+            if (specificParts[0] !== "id") {
+                failures.push({
+                    property: propertyName,
+                    reason: "validation.vdaEpcNoId"
+                });
+            }
+            else if (specificParts.length < 2) {
+                failures.push({
+                    property: propertyName,
+                    reason: "validation.vdaIncorrectSegmentCount"
+                });
+            }
+        }
+        return is;
+    }
+    /**
+     * Validate if the property is a valid epc vda id location.
+     * @param propertyName The name of the property being validated.
+     * @param value The value to test.
+     * @param failures The list of failures to add to.
+     * @returns True if the value is valid epc.
+     */
+    static jaifIdLocation(propertyName, value, failures) {
+        const is = Urn.validate("value", value, failures);
+        if (is &&
+            Is.undefined(VdaIdentifiersValidation.extractBizLocation(value)) &&
+            Is.undefined(VdaIdentifiersValidation.extractReadPoint(value))) {
+            failures.push({
+                property: propertyName,
+                reason: "validation.vdaValueIncorrect"
+            });
+            return false;
+        }
+        return is;
+    }
+    /**
+     * Validate if the property is a valid epc vda id item.
+     * @param propertyName The name of the property being validated.
+     * @param value The value to test.
+     * @param failures The list of failures to add to.
+     * @returns True if the value is valid epc.
+     */
+    static jaifIdItem(propertyName, value, failures) {
+        const is = Urn.validate("value", value, failures);
+        if (is &&
+            Is.undefined(VdaIdentifiersValidation.extractUriPlp(value)) &&
+            Is.undefined(VdaIdentifiersValidation.extractIdentifier(value))) {
+            failures.push({
+                property: propertyName,
+                reason: "validation.vdaValueIncorrect"
+            });
+            return false;
+        }
+        return is;
+    }
+    /**
+     * Validate if the property is a valid epc id gtin.
+     * @param propertyName The name of the property being validated.
+     * @param value The value to test.
+     * @param failures The list of failures to add to.
+     * @returns True if the value is valid epc.
+     */
+    static uriPlp(propertyName, value, failures) {
+        const is = Urn.validate("value", value, failures);
+        if (is) {
+            const plp = VdaIdentifiersValidation.extractUriPlp(value);
+            if (Is.undefined(plp)) {
+                failures.push({
+                    property: propertyName,
+                    reason: "validation.vdaValueIncorrect"
+                });
+                return false;
+            }
+        }
+        return is;
+    }
+    /**
+     * Function to validate and extract RFID read points URNs.
+     * @param urn The URN to validate.
+     * @returns The extracted read point object or undefined.
+     */
+    static extractReadPoint(urn) {
+        const parts = /^urn:jaif:id:obj:([\dA-Za-z]{3})([\dA-Za-z]{2})(\d{9})([\dA-Za-z]{2})(\d{5})([\dA-Za-z]*)/.exec(urn);
+        if (parts) {
+            return {
+                dataIdentifier: parts[1],
+                issuingAgencyCode: parts[2],
+                dunsNumber: parts[3],
+                plant: parts[4],
+                costCenter: parts[5],
+                serialNumber: parts[6]
+            };
+        }
+    }
+    /**
+     * Function to validate and extract Biz Location URN.
+     * @param urn The URN to validate.
+     * @returns The extracted biz location object or undefined.
+     */
+    static extractBizLocation(urn) {
+        const parts = /^urn:jaif:id:obj:([\dA-Za-z]{3})([\dA-Za-z]{2})(\d{9})([\dA-Za-z]*)/.exec(urn);
+        if (parts) {
+            return {
+                dataIdentifier: parts[1],
+                issuingAgencyCode: parts[2],
+                dunsNumber: parts[3],
+                plantBuildingFloorRoom: parts[4]
+            };
+        }
+    }
+    /**
+     * Function to validate VDA URI Packages License Plates.
+     * @param id The VDA URI to validate.
+     * @returns The VDA URI object or undefined.
+     */
+    static extractUriPlp(id) {
+        const parts = /^urn:jaif:id:([\dA-Z]{2}):([\dA-Z]{2})([\dA-Z]{2})([\dA-Z]{9})(\d{9})/.exec(id);
+        if (parts && parts.length === 6 && id.split(":")[4].length === 22) {
+            const data = {
+                applicationFamilyIdentifier: parts[1],
+                typeOfPackage: parts[2],
+                issuingAgencyCode: parts[3],
+                companyIdentificationNumber: parts[4],
+                packageSerialNumber: parts[5]
+            };
+            if (!Is.arrayOneOf(data.applicationFamilyIdentifier, Object.values(VdaUriIdentifiers))) {
+                return;
+            }
+            if (!Is.arrayOneOf(data.typeOfPackage, Object.values(VdaUriPackages))) {
+                return;
+            }
+            return data;
+        }
+    }
+    /**
+     * VDA object identifier verifier function.
+     * @param epc The epc to validate.
+     * @returns The VDA object or undefined.
+     */
+    static extractIdentifier(epc) {
+        if ((epc.startsWith("urn:jaif:id:obj:") || epc.startsWith("urn:jaif:id:A1:")) &&
+            epc.length <= 56) {
+            const split = epc.split(":");
+            if (split.length === 5) {
+                const parts = /([\dA-Z]{3})([\dA-Z]{2})(\d+){1,9}(([\dA-Z]+)\+([\dA-Z]+))/.exec(split[4]);
+                if (parts && parts.length === 7) {
+                    return {
+                        dataIdentifier: parts[1],
+                        issuingAgencyCode: parts[2],
+                        companyIdNumber: parts[3],
+                        // skipped part[4] since it is a concatenation of part[5] + part[6]
+                        partNumber: parts[5],
+                        partSerialNumber: parts[6]
+                    };
+                }
+            }
+        }
+    }
+}
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Handle all identifier types for VDA.
+ */
+class VdaIdentifiers {
+    /**
+     * Register all the identifiers.
+     */
+    static registerIdentifiers() {
+        IdentifierHandlerFactory.register(VdaIdentifierTypes.JaifId, () => ({
+            namespace: VdaIdentifierTypes.JaifId,
+            validate: (propertyName, value, failures) => VdaIdentifiersValidation.jaifId(propertyName, value, failures)
+        }));
+        IdentifierHandlerFactory.register(VdaIdentifierTypes.JaifLocation, () => ({
+            namespace: VdaIdentifierTypes.JaifLocation,
+            validate: (propertyName, value, failures) => VdaIdentifiersValidation.jaifIdLocation(propertyName, value, failures)
+        }));
+        IdentifierHandlerFactory.register(VdaIdentifierTypes.JaifItem, () => ({
+            namespace: VdaIdentifierTypes.JaifItem,
+            validate: (propertyName, value, failures) => VdaIdentifiersValidation.jaifIdItem(propertyName, value, failures)
+        }));
+    }
+}
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * VDA identifiers.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const VdaIdTypes = {
+    /**
+     * Object.
+     */
+    Obj: "obj",
+    /**
+     * Location.
+     */
+    Loc: "loc"
+};
+
+export { VdaIdTypes, VdaIdentifierTypes, VdaIdentifiers, VdaIdentifiersValidation, VdaUriIdentifiers, VdaUriPackages };

package/dist/types/identifiers/vdaIdentifiers.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Handle all identifier types for VDA.
+ */
+export declare class VdaIdentifiers {
+    /**
+     * Register all the identifiers.
+     */
+    static registerIdentifiers(): void;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,11 @@
+export * from "./identifiers/vdaIdentifiers";
+export * from "./models/IVdaBizLocation";
+export * from "./models/IVdaCommon";
+export * from "./models/IVdaObjectIdentifier";
+export * from "./models/IVdaReadPoint";
+export * from "./models/IVdaUriPlates";
+export * from "./models/vdaIdentifierTypes";
+export * from "./models/vdaIdTypes";
+export * from "./models/vdaUriIdentifiers";
+export * from "./models/vdaUriPackages";
+export * from "./utils/vdaIdentifiersValidation";

package/dist/types/models/IVdaBizLocation.d.ts

@@ -0,0 +1,14 @@
+import type { IVdaCommon } from "./IVdaCommon";
+/**
+ * Interface for a VDA Biz Location.
+ */
+export interface IVdaBizLocation extends IVdaCommon {
+    /**
+     * DUNS Number.
+     */
+    dunsNumber: string;
+    /**
+     * Plant Building Floor and Room.
+     */
+    plantBuildingFloorRoom: string;
+}

package/dist/types/models/IVdaCommon.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Common VDA interface.
+ */
+export interface IVdaCommon {
+    /**
+     * Data Identifier (DI).
+     */
+    dataIdentifier: string;
+    /**
+     * Issuing Agency Code (IAC).
+     */
+    issuingAgencyCode: string;
+}

package/dist/types/models/IVdaObjectIdentifier.d.ts

@@ -0,0 +1,18 @@
+import type { IVdaCommon } from "./IVdaCommon";
+/**
+ * Interface for VDA object identifier.
+ */
+export interface IVdaObjectIdentifier extends IVdaCommon {
+    /**
+     * The company identification number.
+     */
+    companyIdNumber: string;
+    /**
+     * The part number.
+     */
+    partNumber: string;
+    /**
+     * The part serial number.
+     */
+    partSerialNumber: string;
+}

package/dist/types/models/IVdaReadPoint.d.ts

@@ -0,0 +1,22 @@
+import type { IVdaCommon } from "./IVdaCommon";
+/**
+ * Interface for VDA read point.
+ */
+export interface IVdaReadPoint extends IVdaCommon {
+    /**
+     * DUNS Number.
+     */
+    dunsNumber: string;
+    /**
+     * Plant.
+     */
+    plant: string;
+    /**
+     * Cost Center.
+     */
+    costCenter: string;
+    /**
+     * Device Name/Serial Number.
+     */
+    serialNumber: string;
+}

package/dist/types/models/IVdaUriPlates.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Interface for VDA URI plates.
+ */
+export interface IVdaUriPlates {
+    /**
+     * Application family identifier A2 or A5.
+     */
+    applicationFamilyIdentifier: string;
+    /**
+     * The type of package 2. Alphanumeric characters.
+     */
+    typeOfPackage: string;
+    /**
+     * The issuing agency. 2 alphanumeric characters.
+     */
+    issuingAgencyCode: string;
+    /**
+     * The company identification number.
+     */
+    companyIdentificationNumber: string;
+    /**
+     * The serial number of the package.
+     */
+    packageSerialNumber: string;
+}

package/dist/types/models/vdaIdTypes.d.ts

@@ -0,0 +1,17 @@
+/**
+ * VDA identifiers.
+ */
+export declare const VdaIdTypes: {
+    /**
+     * Object.
+     */
+    readonly Obj: "obj";
+    /**
+     * Location.
+     */
+    readonly Loc: "loc";
+};
+/**
+ * VDA identifiers.
+ */
+export type VdaIdTypes = (typeof VdaIdTypes)[keyof typeof VdaIdTypes];

package/dist/types/models/vdaIdentifierTypes.d.ts

@@ -0,0 +1,21 @@
+/**
+ * The types of VDA Identifier data.
+ */
+export declare const VdaIdentifierTypes: {
+    /**
+     * Identifier Joint Automotive Industry Format namespace.
+     */
+    readonly JaifId: "jaif:id";
+    /**
+     * Specific extended namespace for location validation.
+     */
+    readonly JaifLocation: "jaif:id@location";
+    /**
+     * Specific extended namespace for item validation.
+     */
+    readonly JaifItem: "jaif:id@item";
+};
+/**
+ * The types of VDA Identifier data.
+ */
+export type VdaIdentifierTypes = (typeof VdaIdentifierTypes)[keyof typeof VdaIdentifierTypes];

package/dist/types/models/vdaUriIdentifiers.d.ts

@@ -0,0 +1,53 @@
+/**
+ * VDA URI Packages License Plates identifiers.
+ */
+export declare const VdaUriIdentifiers: {
+    /**
+     * ISO 17367 Supply chain applications for RFID - Product tagging.
+     */
+    readonly RfidProductTagging: "A1";
+    /**
+     * ISO 17365 Supply chain applications for RFID - Transport unit.
+     */
+    readonly RfidTransportUnit: "A2";
+    /**
+     * ISO 17364 Supply chain applications for RFID - Returnable transport item.
+     */
+    readonly RfidReturnableTransportItem: "A3";
+    /**
+     * ISO 17367 Supply chain applications for RFID - Product tagging (HazMat).
+     */
+    readonly RfidProductTaggingHazmat: "A4";
+    /**
+     * ISO 17366 Supply chain applications for RFID - Product packaging.
+     */
+    readonly RfidProductPackaging: "A5";
+    /**
+     * ISO 17366 Supply chain applications for RFID - Product packaging (HazMat).
+     */
+    readonly RfidProductPackagingHazmat: "A6";
+    /**
+     * ISO 17365 Supply chain applications for RFID - Transport unit (HazMat).
+     */
+    readonly RfidTransportUnitHazmat: "A7";
+    /**
+     * ISO 17364 Supply chain applications for RFID - Returnable transport item (Hazmat).
+     */
+    readonly RfidReturnableTransportItemHazmat: "A8";
+    /**
+     * ISO 17363 Supply chain applications for RFID - Freight container.
+     */
+    readonly RfidFreightContainer: "A9";
+    /**
+     * ISO 17363 Supply chain applications for RFID - Freight container (HazMat).
+     */
+    readonly RfidFreightContainerHazmat: "AA";
+    /**
+     * Vehicle identified with the Vehicle Identification Number (VIN) as defined in ISO 3779.
+     */
+    readonly VehicleIdentificationNumber: "90";
+};
+/**
+ * VDA URI Packages License Plates identifiers.
+ */
+export type VdaUriIdentifiers = (typeof VdaUriIdentifiers)[keyof typeof VdaUriIdentifiers];

package/dist/types/models/vdaUriPackages.d.ts

@@ -0,0 +1,29 @@
+/**
+ * VDA URI Packages License Plates identifiers.
+ */
+export declare const VdaUriPackages: {
+    /**
+     * Unique package ID of inner packaging (Single Label).
+     */
+    readonly Package1J: "1J";
+    /**
+     * Unique package ID of JIS loading unit with compartments.
+     */
+    readonly Package3J: "3J";
+    /**
+     * Unique package ID of JIS loading unit with 1...n JIS packages.
+     */
+    readonly Package4J: "4J";
+    /**
+     * Unique package ID of mixed loading unit with intermediate packaging level (mixed master).
+     */
+    readonly Package5J: "5J";
+    /**
+     * Unique package ID of loading unit or intermediate packaging containing identical parts.
+     */
+    readonly Package67: "6J";
+};
+/**
+ * VDA URI Packages License Plates identifiers.
+ */
+export type VdaUriPackages = (typeof VdaUriPackages)[keyof typeof VdaUriPackages];

package/dist/types/utils/vdaIdentifiersValidation.d.ts

@@ -0,0 +1,66 @@
+import { type IValidationFailure } from "@twin.org/core";
+import type { IVdaBizLocation } from "../models/IVdaBizLocation";
+import type { IVdaObjectIdentifier } from "../models/IVdaObjectIdentifier";
+import type { IVdaReadPoint } from "../models/IVdaReadPoint";
+import type { IVdaUriPlates } from "../models/IVdaUriPlates";
+/**
+ * Validation for identifier types for VDA.
+ */
+export declare class VdaIdentifiersValidation {
+    /**
+     * Validate if the property is a valid epc.
+     * @param propertyName The name of the property being validated.
+     * @param value The value to test.
+     * @param failures The list of failures to add to.
+     * @returns True if the value is valid epc.
+     */
+    static jaifId(propertyName: string, value: unknown, failures: IValidationFailure[]): value is string;
+    /**
+     * Validate if the property is a valid epc vda id location.
+     * @param propertyName The name of the property being validated.
+     * @param value The value to test.
+     * @param failures The list of failures to add to.
+     * @returns True if the value is valid epc.
+     */
+    static jaifIdLocation(propertyName: string, value: unknown, failures: IValidationFailure[]): value is string;
+    /**
+     * Validate if the property is a valid epc vda id item.
+     * @param propertyName The name of the property being validated.
+     * @param value The value to test.
+     * @param failures The list of failures to add to.
+     * @returns True if the value is valid epc.
+     */
+    static jaifIdItem(propertyName: string, value: unknown, failures: IValidationFailure[]): value is string;
+    /**
+     * Validate if the property is a valid epc id gtin.
+     * @param propertyName The name of the property being validated.
+     * @param value The value to test.
+     * @param failures The list of failures to add to.
+     * @returns True if the value is valid epc.
+     */
+    static uriPlp(propertyName: string, value: unknown, failures: IValidationFailure[]): value is string;
+    /**
+     * Function to validate and extract RFID read points URNs.
+     * @param urn The URN to validate.
+     * @returns The extracted read point object or undefined.
+     */
+    static extractReadPoint(urn: string): IVdaReadPoint | undefined;
+    /**
+     * Function to validate and extract Biz Location URN.
+     * @param urn The URN to validate.
+     * @returns The extracted biz location object or undefined.
+     */
+    static extractBizLocation(urn: string): IVdaBizLocation | undefined;
+    /**
+     * Function to validate VDA URI Packages License Plates.
+     * @param id The VDA URI to validate.
+     * @returns The VDA URI object or undefined.
+     */
+    static extractUriPlp(id: string): IVdaUriPlates | undefined;
+    /**
+     * VDA object identifier verifier function.
+     * @param epc The epc to validate.
+     * @returns The VDA object or undefined.
+     */
+    static extractIdentifier(epc: string): IVdaObjectIdentifier | undefined;
+}

package/docs/changelog.md

@@ -0,0 +1,5 @@
+# @twin.org/standards-vda - Changelog
+
+## v0.0.1-next.21
+
+- Initial Release

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/standards-vda - Examples

package/docs/reference/classes/VdaIdentifiers.md

@@ -0,0 +1,25 @@
+# Class: VdaIdentifiers
+
+Handle all identifier types for VDA.
+
+## Constructors
+
+### new VdaIdentifiers()
+
+> **new VdaIdentifiers**(): [`VdaIdentifiers`](VdaIdentifiers.md)
+
+#### Returns
+
+[`VdaIdentifiers`](VdaIdentifiers.md)
+
+## Methods
+
+### registerIdentifiers()
+
+> `static` **registerIdentifiers**(): `void`
+
+Register all the identifiers.
+
+#### Returns
+
+`void`