@zetra/citrineos-util 1.8.3-fork.1

package/dist/util/emaidCheckDigitCalculator.js

@@ -0,0 +1,179 @@
+// SPDX-FileCopyrightText: 2025 Contributors to the CitrineOS Project
+//
+// SPDX-License-Identifier: Apache-2.0
+/**
+ * Calculate check digit for eMAID according to eMI³ specification
+ * Based on the algorithm described in "Check Digit Calculation for Contract-IDs"
+ *
+ * This implementation can detect five most frequent error types:
+ * 1. Single error: one character is wrong
+ * 2. Adjacent transposition: two adjacent characters are swapped
+ * 3. Twin error: two identical adjacent characters are both changed
+ * 4. Jump transposition: abc becomes cba
+ * 5. Jump twin error: aca becomes bcb
+ *
+ * @param emaidWithoutCheckDigit - The first 14 characters of the eMAID (without check digit)
+ * @returns The calculated check digit character
+ */
+export function calculateCheckDigit(emaidWithoutCheckDigit) {
+    // Ensure input is uppercase and 14 characters
+    const input = emaidWithoutCheckDigit.toUpperCase();
+    if (input.length !== 14) {
+        throw new Error('Input must be exactly 14 characters');
+    }
+    // Validate that input contains only alphanumeric characters
+    if (!/^[A-Z0-9]+$/.test(input)) {
+        throw new Error('Input must contain only alphanumeric characters');
+    }
+    // Lookup tables for q1, q2, r1, r2 values based on the PDF specification
+    const lookupTable = {
+        '0': { q1: 0, q2: 0, r1: 0, r2: 0 },
+        '1': { q1: 0, q2: 0, r1: 0, r2: 1 },
+        '2': { q1: 0, q2: 0, r1: 0, r2: 2 },
+        '3': { q1: 0, q2: 0, r1: 1, r2: 0 },
+        '4': { q1: 0, q2: 0, r1: 1, r2: 1 },
+        '5': { q1: 0, q2: 0, r1: 1, r2: 2 },
+        '6': { q1: 0, q2: 0, r1: 2, r2: 0 },
+        '7': { q1: 0, q2: 0, r1: 2, r2: 1 },
+        '8': { q1: 0, q2: 0, r1: 2, r2: 2 },
+        '9': { q1: 0, q2: 1, r1: 0, r2: 0 },
+        A: { q1: 0, q2: 1, r1: 0, r2: 1 },
+        B: { q1: 0, q2: 1, r1: 0, r2: 2 },
+        C: { q1: 0, q2: 1, r1: 1, r2: 0 },
+        D: { q1: 0, q2: 1, r1: 1, r2: 1 },
+        E: { q1: 0, q2: 1, r1: 1, r2: 2 },
+        F: { q1: 0, q2: 1, r1: 2, r2: 0 },
+        G: { q1: 0, q2: 1, r1: 2, r2: 1 },
+        H: { q1: 0, q2: 1, r1: 2, r2: 2 },
+        I: { q1: 1, q2: 0, r1: 0, r2: 0 },
+        J: { q1: 1, q2: 0, r1: 0, r2: 1 },
+        K: { q1: 1, q2: 0, r1: 0, r2: 2 },
+        L: { q1: 1, q2: 0, r1: 1, r2: 0 },
+        M: { q1: 1, q2: 0, r1: 1, r2: 1 },
+        N: { q1: 1, q2: 0, r1: 1, r2: 2 },
+        O: { q1: 1, q2: 0, r1: 2, r2: 0 },
+        P: { q1: 1, q2: 0, r1: 2, r2: 1 },
+        Q: { q1: 1, q2: 0, r1: 2, r2: 2 },
+        R: { q1: 1, q2: 1, r1: 0, r2: 0 },
+        S: { q1: 1, q2: 1, r1: 0, r2: 1 },
+        T: { q1: 1, q2: 1, r1: 0, r2: 2 },
+        U: { q1: 1, q2: 1, r1: 1, r2: 0 },
+        V: { q1: 1, q2: 1, r1: 1, r2: 1 },
+        W: { q1: 1, q2: 1, r1: 1, r2: 2 },
+        X: { q1: 1, q2: 1, r1: 2, r2: 0 },
+        Y: { q1: 1, q2: 1, r1: 2, r2: 1 },
+        Z: { q1: 1, q2: 1, r1: 2, r2: 2 },
+    };
+    // Matrix P1 powers over Z2 (modulo 2)
+    // The pattern repeats every 3 positions
+    const getP1Power = (index) => {
+        const position = (index % 3) + 1;
+        if (position === 3) {
+            return [
+                [1, 0],
+                [0, 1],
+            ]; // Identity matrix for positions 3, 6, 9, 12, 15
+        }
+        else if (position === 1) {
+            return [
+                [0, 1],
+                [1, 1],
+            ]; // P1 for positions 1, 4, 7, 10, 13
+        }
+        else {
+            return [
+                [1, 1],
+                [1, 0],
+            ]; // P1^2 for positions 2, 5, 8, 11, 14
+        }
+    };
+    // Matrix P2 powers over Z3 (modulo 3)
+    // The pattern repeats every 8 positions
+    const P2_powers = [
+        [
+            [0, 1],
+            [1, 2],
+        ], // P2^1
+        [
+            [1, 2],
+            [2, 2],
+        ], // P2^2
+        [
+            [2, 2],
+            [2, 0],
+        ], // P2^3
+        [
+            [2, 0],
+            [0, 2],
+        ], // P2^4
+        [
+            [0, 2],
+            [2, 1],
+        ], // P2^5
+        [
+            [2, 1],
+            [1, 1],
+        ], // P2^6
+        [
+            [1, 1],
+            [1, 0],
+        ], // P2^7
+        [
+            [1, 0],
+            [0, 1],
+        ], // P2^8 (Identity)
+    ];
+    const getP2Power = (index) => {
+        return P2_powers[index % 8];
+    };
+    // Initialize accumulators for check equations
+    const q_sum = [0, 0]; // For Z2 calculation
+    const r_sum = [0, 0]; // For Z3 calculation
+    // Process each character
+    for (let i = 0; i < 14; i++) {
+        const char = input[i];
+        const values = lookupTable[char];
+        if (!values) {
+            throw new Error(`Invalid character '${char}' at position ${i}`);
+        }
+        // Matrix multiplication for q (Z2)
+        const P1 = getP1Power(i);
+        const q_vec = [values.q1, values.q2];
+        const q_result = [
+            (P1[0][0] * q_vec[0] + P1[0][1] * q_vec[1]) % 2,
+            (P1[1][0] * q_vec[0] + P1[1][1] * q_vec[1]) % 2,
+        ];
+        q_sum[0] = (q_sum[0] + q_result[0]) % 2;
+        q_sum[1] = (q_sum[1] + q_result[1]) % 2;
+        // Matrix multiplication for r (Z3)
+        const P2 = getP2Power(i);
+        const r_vec = [values.r1, values.r2];
+        const r_result = [
+            (P2[0][0] * r_vec[0] + P2[0][1] * r_vec[1]) % 3,
+            (P2[1][0] * r_vec[0] + P2[1][1] * r_vec[1]) % 3,
+        ];
+        r_sum[0] = (r_sum[0] + r_result[0]) % 3;
+        r_sum[1] = (r_sum[1] + r_result[1]) % 3;
+    }
+    // Calculate check digit values
+    // For position 15: P1^15 = Identity, P2^15 = [[1,1],[1,0]]
+    // Solve for q15 such that the check equation equals 0
+    // Since P1^15 is identity, q15 = -q_sum (mod 2)
+    const q15 = [(2 - q_sum[0]) % 2, (2 - q_sum[1]) % 2];
+    // Solve for r15 such that the check equation equals 0
+    // For P2^15 = [[1,1],[1,0]], we solve: [r15_1, r15_2] * P2^15 = -r_sum
+    // This gives: r15_1 = -r_sum[1] and r15_1 + r15_2 = -r_sum[0]
+    const r15 = [(3 - r_sum[1]) % 3, (((3 - r_sum[0]) % 3) + r_sum[1]) % 3];
+    // Convert from two-dimensional to single values
+    const q_value = q15[0] * 2 + q15[1]; // Convert from Z2 × Z2 to {0,1,2,3}
+    const r_value = r15[0] * 3 + r15[1]; // Convert from Z3 × Z3 to {0,1,2,...,8}
+    // Combine using the formula: a = q * 9 + r
+    const checkValue = q_value * 9 + r_value;
+    // Map the check value (0-35) directly to alphanumeric characters
+    const charset = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ';
+    if (checkValue < 0 || checkValue >= 36) {
+        throw new Error(`Invalid check value: ${checkValue}`);
+    }
+    return charset[checkValue];
+}
+//# sourceMappingURL=emaidCheckDigitCalculator.js.map

package/dist/util/emaidCheckDigitCalculator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"emaidCheckDigitCalculator.js","sourceRoot":"","sources":["../../src/util/emaidCheckDigitCalculator.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,EAAE;AACF,sCAAsC;AACtC;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,mBAAmB,CAAC,sBAA8B;IAChE,8CAA8C;IAC9C,MAAM,KAAK,GAAG,sBAAsB,CAAC,WAAW,EAAE,CAAC;IACnD,IAAI,KAAK,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;IACzD,CAAC;IAED,4DAA4D;IAC5D,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;IACrE,CAAC;IAED,yEAAyE;IACzE,MAAM,WAAW,GAAuE;QACtF,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACnC,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACnC,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACnC,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACnC,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACnC,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACnC,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACnC,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACnC,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACnC,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACnC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACjC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACjC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACjC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACjC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACjC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACjC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACjC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACjC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACjC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACjC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACjC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACjC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACjC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACjC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACjC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACjC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACjC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACjC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACjC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACjC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACjC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACjC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACjC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACjC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;QACjC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE;KAClC,CAAC;IAEF,sCAAsC;IACtC,wCAAwC;IACxC,MAAM,UAAU,GAAG,CAAC,KAAa,EAAc,EAAE;QAC/C,MAAM,QAAQ,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;QACjC,IAAI,QAAQ,KAAK,CAAC,EAAE,CAAC;YACnB,OAAO;gBACL,CAAC,CAAC,EAAE,CAAC,CAAC;gBACN,CAAC,CAAC,EAAE,CAAC,CAAC;aACP,CAAC,CAAC,gDAAgD;QACrD,CAAC;aAAM,IAAI,QAAQ,KAAK,CAAC,EAAE,CAAC;YAC1B,OAAO;gBACL,CAAC,CAAC,EAAE,CAAC,CAAC;gBACN,CAAC,CAAC,EAAE,CAAC,CAAC;aACP,CAAC,CAAC,mCAAmC;QACxC,CAAC;aAAM,CAAC;YACN,OAAO;gBACL,CAAC,CAAC,EAAE,CAAC,CAAC;gBACN,CAAC,CAAC,EAAE,CAAC,CAAC;aACP,CAAC,CAAC,qCAAqC;QAC1C,CAAC;IACH,CAAC,CAAC;IAEF,sCAAsC;IACtC,wCAAwC;IACxC,MAAM,SAAS,GAAiB;QAC9B;YACE,CAAC,CAAC,EAAE,CAAC,CAAC;YACN,CAAC,CAAC,EAAE,CAAC,CAAC;SACP,EAAE,OAAO;QACV;YACE,CAAC,CAAC,EAAE,CAAC,CAAC;YACN,CAAC,CAAC,EAAE,CAAC,CAAC;SACP,EAAE,OAAO;QACV;YACE,CAAC,CAAC,EAAE,CAAC,CAAC;YACN,CAAC,CAAC,EAAE,CAAC,CAAC;SACP,EAAE,OAAO;QACV;YACE,CAAC,CAAC,EAAE,CAAC,CAAC;YACN,CAAC,CAAC,EAAE,CAAC,CAAC;SACP,EAAE,OAAO;QACV;YACE,CAAC,CAAC,EAAE,CAAC,CAAC;YACN,CAAC,CAAC,EAAE,CAAC,CAAC;SACP,EAAE,OAAO;QACV;YACE,CAAC,CAAC,EAAE,CAAC,CAAC;YACN,CAAC,CAAC,EAAE,CAAC,CAAC;SACP,EAAE,OAAO;QACV;YACE,CAAC,CAAC,EAAE,CAAC,CAAC;YACN,CAAC,CAAC,EAAE,CAAC,CAAC;SACP,EAAE,OAAO;QACV;YACE,CAAC,CAAC,EAAE,CAAC,CAAC;YACN,CAAC,CAAC,EAAE,CAAC,CAAC;SACP,EAAE,kBAAkB;KACtB,CAAC;IAEF,MAAM,UAAU,GAAG,CAAC,KAAa,EAAc,EAAE;QAC/C,OAAO,SAAS,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;IAC9B,CAAC,CAAC;IAEF,8CAA8C;IAC9C,MAAM,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,qBAAqB;IAC3C,MAAM,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,qBAAqB;IAE3C,yBAAyB;IACzB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC;QAC5B,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACtB,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;QAEjC,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,sBAAsB,IAAI,iBAAiB,CAAC,EAAE,CAAC,CAAC;QAClE,CAAC;QAED,mCAAmC;QACnC,MAAM,EAAE,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;QACzB,MAAM,KAAK,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;QACrC,MAAM,QAAQ,GAAG;YACf,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;YAC/C,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;SAChD,CAAC;QACF,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QACxC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QAExC,mCAAmC;QACnC,MAAM,EAAE,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;QACzB,MAAM,KAAK,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;QACrC,MAAM,QAAQ,GAAG;YACf,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;YAC/C,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;SAChD,CAAC;QACF,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QACxC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IAC1C,CAAC;IAED,+BAA+B;IAC/B,2DAA2D;IAE3D,sDAAsD;IACtD,gDAAgD;IAChD,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAErD,sDAAsD;IACtD,uEAAuE;IACvE,8DAA8D;IAC9D,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAExE,gDAAgD;IAChD,MAAM,OAAO,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,oCAAoC;IACzE,MAAM,OAAO,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,wCAAwC;IAE7E,2CAA2C;IAC3C,MAAM,UAAU,GAAG,OAAO,GAAG,CAAC,GAAG,OAAO,CAAC;IAEzC,iEAAiE;IACjE,MAAM,OAAO,GAAG,sCAAsC,CAAC;IACvD,IAAI,UAAU,GAAG,CAAC,IAAI,UAAU,IAAI,EAAE,EAAE,CAAC;QACvC,MAAM,IAAI,KAAK,CAAC,wBAAwB,UAAU,EAAE,CAAC,CAAC;IACxD,CAAC;IAED,OAAO,OAAO,CAAC,UAAU,CAAC,CAAC;AAC7B,CAAC"}

package/dist/util/idGenerator.d.ts

@@ -0,0 +1,7 @@
+import type { ChargingStationSequenceTypeEnumType } from '@citrineos/base';
+import type { IChargingStationSequenceRepository } from '@citrineos/data';
+export declare class IdGenerator {
+    private _stationSequenceRepository;
+    constructor(stationSequenceRepository: IChargingStationSequenceRepository);
+    generateRequestId(tenantId: number, stationId: string, type: ChargingStationSequenceTypeEnumType): Promise<number>;
+}

package/dist/util/idGenerator.js

@@ -0,0 +1,10 @@
+export class IdGenerator {
+    _stationSequenceRepository;
+    constructor(stationSequenceRepository) {
+        this._stationSequenceRepository = stationSequenceRepository;
+    }
+    async generateRequestId(tenantId, stationId, type) {
+        return this._stationSequenceRepository.getNextSequenceValue(tenantId, stationId, type);
+    }
+}
+//# sourceMappingURL=idGenerator.js.map

package/dist/util/idGenerator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"idGenerator.js","sourceRoot":"","sources":["../../src/util/idGenerator.ts"],"names":[],"mappings":"AAMA,MAAM,OAAO,WAAW;IACd,0BAA0B,CAAqC;IAEvE,YAAY,yBAA6D;QACvE,IAAI,CAAC,0BAA0B,GAAG,yBAAyB,CAAC;IAC9D,CAAC;IAED,KAAK,CAAC,iBAAiB,CACrB,QAAgB,EAChB,SAAiB,EACjB,IAAyC;QAEzC,OAAO,IAAI,CAAC,0BAA0B,CAAC,oBAAoB,CAAC,QAAQ,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;IACzF,CAAC;CACF"}

package/dist/util/parser.d.ts

@@ -0,0 +1,31 @@
+import type { OcppRequest } from '@citrineos/base';
+/**
+ * Calculate the size of a request.
+ *
+ * @param {object} request - The ocpp request.
+ * @return {number} The size of the request (Bytes).
+ */
+export declare function getSizeOfRequest(request: OcppRequest): number;
+/**
+ * Slice array into pieces according to the given size.
+ *
+ * @param {array} array - An array.
+ * @param {number} size - The expected size of a batch.
+ * @return {map} A map with index as key and batch as value. Index is the position of the 1st batch element in the given
+ * array. Batch is a subarray of the given array.
+ */
+export declare function getBatches(array: object[] | string[] | boolean[] | number[], size: number): Map<number, object[] | string[] | boolean[] | number[]>;
+/**
+ * Get the number of fraction digits in a number, e.g, 1.23 -> 2
+ *
+ * @param num - The number to get the number of fraction digits
+ * @returns The number of fraction digits
+ */
+export declare function getNumberOfFractionDigit(num: number): number;
+/**
+ * Convert string to set. For example, 'a,b,c' -> new Set(['a', 'b', 'c'])
+ *
+ * @param input - The string to convert
+ * @returns Set
+ */
+export declare function stringToSet(input: string): Set<string>;

package/dist/util/parser.js

@@ -0,0 +1,60 @@
+// SPDX-FileCopyrightText: 2025 Contributors to the CitrineOS Project
+//
+// SPDX-License-Identifier: Apache-2.0
+/**
+ * Calculate the size of a request.
+ *
+ * @param {object} request - The ocpp request.
+ * @return {number} The size of the request (Bytes).
+ */
+export function getSizeOfRequest(request) {
+    return new TextEncoder().encode(JSON.stringify(request)).length;
+}
+/**
+ * Slice array into pieces according to the given size.
+ *
+ * @param {array} array - An array.
+ * @param {number} size - The expected size of a batch.
+ * @return {map} A map with index as key and batch as value. Index is the position of the 1st batch element in the given
+ * array. Batch is a subarray of the given array.
+ */
+export function getBatches(array, size) {
+    if (!Number.isInteger(size) || size <= 0) {
+        size = array.length;
+    }
+    const batchMap = new Map();
+    let lastIndex = 0;
+    while (array.length > 0) {
+        const batch = array.slice(0, size);
+        batchMap.set(lastIndex, batch);
+        lastIndex += batch.length;
+        array = array.slice(size);
+    }
+    return batchMap;
+}
+/**
+ * Get the number of fraction digits in a number, e.g, 1.23 -> 2
+ *
+ * @param num - The number to get the number of fraction digits
+ * @returns The number of fraction digits
+ */
+export function getNumberOfFractionDigit(num) {
+    const numString = num.toString();
+    const match = numString.match(/\.(\d+)/);
+    if (!match) {
+        return 0;
+    }
+    else {
+        return match[1].length;
+    }
+}
+/**
+ * Convert string to set. For example, 'a,b,c' -> new Set(['a', 'b', 'c'])
+ *
+ * @param input - The string to convert
+ * @returns Set
+ */
+export function stringToSet(input) {
+    return new Set(input.split(',').map((item) => item.trim()));
+}
+//# sourceMappingURL=parser.js.map

package/dist/util/parser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parser.js","sourceRoot":"","sources":["../../src/util/parser.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,EAAE;AACF,sCAAsC;AAItC;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,OAAoB;IACnD,OAAO,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;AAClE,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,UAAU,CACxB,KAAiD,EACjD,IAAY;IAEZ,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,CAAC;QACzC,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC;IACtB,CAAC;IACD,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAE,CAAC;IAC3B,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;QACnC,QAAQ,CAAC,GAAG,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QAC/B,SAAS,IAAI,KAAK,CAAC,MAAM,CAAC;QAC1B,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,wBAAwB,CAAC,GAAW;IAClD,MAAM,SAAS,GAAG,GAAG,CAAC,QAAQ,EAAE,CAAC;IACjC,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IAEzC,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,CAAC,CAAC;IACX,CAAC;SAAM,CAAC;QACN,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,KAAa;IACvC,OAAO,IAAI,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;AAC9D,CAAC"}

package/dist/util/swagger.d.ts

@@ -0,0 +1,5 @@
+import type { SystemConfig } from '@citrineos/base';
+import type { FastifyInstance, FastifyRequest } from 'fastify';
+export declare const getHeaderValue: (headers: string[], key: string) => string | undefined;
+export declare const getAuthorizationTokenFromRequest: (request: FastifyRequest) => string;
+export declare function initSwagger(systemConfig: SystemConfig, server: FastifyInstance): Promise<void>;

package/dist/util/swagger.js

@@ -0,0 +1,154 @@
+// SPDX-FileCopyrightText: 2025 Contributors to the CitrineOS Project
+//
+// SPDX-License-Identifier: Apache-2.0
+import { HttpHeader, HttpStatus, UnauthorizedError } from '@citrineos/base';
+import * as FastifyAuth from '@fastify/auth';
+import fastifySwagger from '@fastify/swagger';
+import fastifySwaggerUi from '@fastify/swagger-ui';
+import fs from 'fs';
+import { OpenAPIV2, OpenAPIV3 } from 'openapi-types';
+import * as packageJson from '../../package.json' with { type: 'json' };
+/**
+ * This transformation is used to set default tags
+ *
+ * @param {object} swaggerObject - The original Swagger object to be transformed.
+ * @param {object} openapiObject - The original OpenAPI object to be transformed.
+ * @return {object} The transformed OpenAPI object.
+ */
+function OcppTransformObject({ swaggerObject, openapiObject, }) {
+    console.log('OcppTransformObject: Transforming OpenAPI object...');
+    if (openapiObject.paths && openapiObject.components) {
+        for (const pathKey in openapiObject.paths) {
+            const path = openapiObject.paths[pathKey];
+            if (path) {
+                for (const methodKey in path) {
+                    const method = path[methodKey];
+                    if (method) {
+                        // Set tags based on path key if tags were not passed in
+                        if (!method.tags) {
+                            // Get tag index
+                            // e.g, '/ocpp/1.6/evdriver' -> 'evdriver'
+                            // e.g, '/data/evdriver' -> 'evdriver'
+                            const pathSegments = pathKey.split('/');
+                            const tagIndex = pathSegments.find((segment) => segment === 'data') ? 2 : 3;
+                            method.tags = pathKey
+                                .split('/')
+                                .slice(tagIndex, -1)
+                                .map((tag) => tag.charAt(0).toUpperCase() + tag.slice(1));
+                        }
+                    }
+                }
+            }
+        }
+    }
+    return openapiObject;
+}
+const registerSwaggerUi = (systemConfig, server) => {
+    const swaggerUiOptions = {
+        routePrefix: systemConfig.util.swagger?.path,
+        securityDefinitions: {
+            authorization: {
+                name: 'authorization',
+                type: 'apiKey',
+                in: 'header',
+            },
+        },
+        exposeRoute: true,
+        uiConfig: {
+            filter: true,
+        },
+        theme: {
+            title: 'CitrineOS Central System API',
+            css: [
+                {
+                    filename: '',
+                    content: '.swagger-ui .topbar { background-color: #fafafa; } .swagger-ui .topbar .download-url-wrapper { display: none; }',
+                },
+            ],
+        },
+    };
+    if (systemConfig.util.swagger?.logoPath) {
+        swaggerUiOptions['logo'] = {
+            type: 'image/png',
+            content: fs.readFileSync(systemConfig.util.swagger?.logoPath),
+        };
+    }
+    server.register(fastifySwaggerUi, swaggerUiOptions);
+};
+export const getHeaderValue = (headers, key) => {
+    for (let i = 0; i < headers.length; i += 2) {
+        if (headers[i].toLowerCase() === key.toLowerCase()) {
+            return headers[i + 1];
+        }
+    }
+    return undefined;
+};
+const getTokenFromAuthHeader = (authorizationHeader) => {
+    if (!!authorizationHeader) {
+        const token = authorizationHeader.split('Bearer ')[1];
+        return token;
+    }
+    return undefined;
+};
+const getAuthorizationTokenFromRawHeaders = (headers) => {
+    const authorizationHeader = getHeaderValue(headers, HttpHeader.Authorization);
+    return getTokenFromAuthHeader(authorizationHeader);
+};
+export const getAuthorizationTokenFromRequest = (request) => {
+    const token = getAuthorizationTokenFromRawHeaders(request.raw.rawHeaders);
+    if (!token) {
+        throw new UnauthorizedError('Token not found in headers');
+    }
+    return token;
+};
+const registerFastifyAuth = async (server) => {
+    await server.register(FastifyAuth).after();
+    console.log(server.authorization);
+    server.decorate('authorization', function (request, reply, done) {
+        try {
+            const token = getAuthorizationTokenFromRequest(request);
+            console.log('Received authorization token', token);
+            done();
+        }
+        catch (e) {
+            reply.code(HttpStatus.UNAUTHORIZED);
+        }
+    });
+};
+const buildLocalReference = (json, _parent, _property, i) => {
+    // If title is missing but $id is available, set title to $id
+    if (!json.title && json.$id) {
+        json.title = json.$id;
+    }
+    // Return title if available, otherwise fallback to $id, or def-<index> as a last resort
+    return json.title || json.$id || `def-${i}`;
+};
+const registerFastifySwagger = (systemConfig, server) => {
+    server.register(fastifySwagger, {
+        openapi: {
+            info: {
+                title: 'CitrineOS Central System API',
+                description: 'Central System API for OCPP 2.0.1 messaging.',
+                version: packageJson.default.version,
+            },
+            components: {
+                securitySchemes: {
+                    authorization: {
+                        type: 'http',
+                        scheme: 'bearer',
+                    },
+                },
+            },
+        },
+        transformObject: OcppTransformObject,
+        refResolver: {
+            buildLocalReference,
+        },
+    });
+};
+export async function initSwagger(systemConfig, server) {
+    registerFastifySwagger(systemConfig, server);
+    registerSwaggerUi(systemConfig, server);
+    await registerFastifyAuth(server);
+}
+//# sourceMappingURL=swagger.js.map

package/dist/util/swagger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"swagger.js","sourceRoot":"","sources":["../../src/util/swagger.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,EAAE;AACF,sCAAsC;AAKtC,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAC5E,OAAO,KAAK,WAAW,MAAM,eAAe,CAAC;AAC7C,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,gBAAgB,MAAM,qBAAqB,CAAC;AAEnD,OAAO,EAAE,MAAM,IAAI,CAAC;AAEpB,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,KAAK,WAAW,MAAM,oBAAoB,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAExE;;;;;;GAMG;AACH,SAAS,mBAAmB,CAAC,EAC3B,aAAa,EACb,aAAa,GAId;IACC,OAAO,CAAC,GAAG,CAAC,qDAAqD,CAAC,CAAC;IACnE,IAAI,aAAa,CAAC,KAAK,IAAI,aAAa,CAAC,UAAU,EAAE,CAAC;QACpD,KAAK,MAAM,OAAO,IAAI,aAAa,CAAC,KAAK,EAAE,CAAC;YAC1C,MAAM,IAAI,GAA0B,aAAa,CAAC,KAAK,CAAC,OAAO,CAA0B,CAAC;YAC1F,IAAI,IAAI,EAAE,CAAC;gBACT,KAAK,MAAM,SAAS,IAAI,IAAI,EAAE,CAAC;oBAC7B,MAAM,MAAM,GAA8B,IAAI,CAAC,SAAS,CAA8B,CAAC;oBACvF,IAAI,MAAM,EAAE,CAAC;wBACX,wDAAwD;wBACxD,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;4BACjB,gBAAgB;4BAChB,0CAA0C;4BAC1C,sCAAsC;4BACtC,MAAM,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;4BACxC,MAAM,QAAQ,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;4BAC5E,MAAM,CAAC,IAAI,GAAG,OAAO;iCAClB,KAAK,CAAC,GAAG,CAAC;iCACV,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;iCACnB,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;wBAC9D,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,aAAa,CAAC;AACvB,CAAC;AAED,MAAM,iBAAiB,GAAG,CAAC,YAA0B,EAAE,MAAuB,EAAE,EAAE;IAChF,MAAM,gBAAgB,GAAQ;QAC5B,WAAW,EAAE,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI;QAC5C,mBAAmB,EAAE;YACnB,aAAa,EAAE;gBACb,IAAI,EAAE,eAAe;gBACrB,IAAI,EAAE,QAAQ;gBACd,EAAE,EAAE,QAAQ;aACb;SACF;QACD,WAAW,EAAE,IAAI;QACjB,QAAQ,EAAE;YACR,MAAM,EAAE,IAAI;SACb;QACD,KAAK,EAAE;YACL,KAAK,EAAE,8BAA8B;YACrC,GAAG,EAAE;gBACH;oBACE,QAAQ,EAAE,EAAE;oBACZ,OAAO,EACL,iHAAiH;iBACpH;aACF;SACF;KACF,CAAC;IAEF,IAAI,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC;QACxC,gBAAgB,CAAC,MAAM,CAAC,GAAG;YACzB,IAAI,EAAE,WAAW;YACjB,OAAO,EAAE,EAAE,CAAC,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC;SAC9D,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,CAAC;AACtD,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,OAAiB,EAAE,GAAW,EAAsB,EAAE;IACnF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3C,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,KAAK,GAAG,CAAC,WAAW,EAAE,EAAE,CAAC;YACnD,OAAO,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QACxB,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAAG,CAAC,mBAAuC,EAAsB,EAAE;IAC7F,IAAI,CAAC,CAAC,mBAAmB,EAAE,CAAC;QAC1B,MAAM,KAAK,GAAG,mBAAmB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QACtD,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,mCAAmC,GAAG,CAAC,OAAiB,EAAsB,EAAE;IACpF,MAAM,mBAAmB,GAAG,cAAc,CAAC,OAAO,EAAE,UAAU,CAAC,aAAa,CAAC,CAAC;IAC9E,OAAO,sBAAsB,CAAC,mBAAmB,CAAC,CAAC;AACrD,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAAC,OAAuB,EAAU,EAAE;IAClF,MAAM,KAAK,GAAG,mCAAmC,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC1E,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,iBAAiB,CAAC,4BAA4B,CAAC,CAAC;IAC5D,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,KAAK,EAAE,MAAuB,EAAE,EAAE;IAC5D,MAAM,MAAM,CAAC,QAAQ,CAAC,WAAkB,CAAC,CAAC,KAAK,EAAE,CAAC;IAClD,OAAO,CAAC,GAAG,CAAE,MAAc,CAAC,aAAa,CAAC,CAAC;IAE3C,MAAM,CAAC,QAAQ,CAAC,eAAe,EAAE,UAAU,OAAY,EAAE,KAAU,EAAE,IAAS;QAC5E,IAAI,CAAC;YACH,MAAM,KAAK,GAAG,gCAAgC,CAAC,OAAO,CAAC,CAAC;YACxD,OAAO,CAAC,GAAG,CAAC,8BAA8B,EAAE,KAAK,CAAC,CAAC;YACnD,IAAI,EAAE,CAAC;QACT,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;QACtC,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,IAAS,EAAE,OAAgB,EAAE,SAAkB,EAAE,CAAS,EAAE,EAAE;IACzF,6DAA6D;IAC7D,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;QAC5B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC;IACxB,CAAC;IAED,wFAAwF;IACxF,OAAO,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,GAAG,IAAI,OAAO,CAAC,EAAE,CAAC;AAC9C,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAAG,CAAC,YAA0B,EAAE,MAAuB,EAAE,EAAE;IACrF,MAAM,CAAC,QAAQ,CAAC,cAAqB,EAAE;QACrC,OAAO,EAAE;YACP,IAAI,EAAE;gBACJ,KAAK,EAAE,8BAA8B;gBACrC,WAAW,EAAE,8CAA8C;gBAC3D,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC,OAAO;aACrC;YACD,UAAU,EAAE;gBACV,eAAe,EAAE;oBACf,aAAa,EAAE;wBACb,IAAI,EAAE,MAAM;wBACZ,MAAM,EAAE,QAAQ;qBACjB;iBACF;aACF;SACF;QACD,eAAe,EAAE,mBAAmB;QACpC,WAAW,EAAE;YACX,mBAAmB;SACpB;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,YAA0B,EAAE,MAAuB;IACnF,sBAAsB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;IAC7C,iBAAiB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;IACxC,MAAM,mBAAmB,CAAC,MAAM,CAAC,CAAC;AACpC,CAAC"}

package/dist/util/validator.d.ts

@@ -0,0 +1,110 @@
+import { OCPP2_0_1 } from '@citrineos/base';
+import type { IChargingProfileRepository, IDeviceModelRepository, ITransactionEventRepository } from '@citrineos/data';
+import type { ILogObj } from 'tslog';
+import { Logger } from 'tslog';
+/**
+ * Validate a language tag is an RFC-5646 tag, see: {@link https://tools.ietf.org/html/rfc5646},
+ * example: US English is: "en-US"
+ *
+ * @param languageTag
+ * @returns {boolean} true if the languageTag is an RFC-5646 tag
+ */
+export declare function validateLanguageTag(languageTag: string): boolean;
+/**
+ * Validate constraints of ChargingProfileType defined in OCPP 2.0.1
+ *
+ * @param chargingProfileType ChargingProfileType from the request
+ * @param tenantId tenant id the profile belongs to
+ * @param stationId station id
+ * @param deviceModelRepository deviceModelRepository
+ * @param chargingProfileRepository chargingProfileRepository
+ * @param transactionEventRepository transactionEventRepository
+ * @param logger logger
+ * @param evseId evse id
+ */
+export declare function validateChargingProfileType(chargingProfileType: OCPP2_0_1.ChargingProfileType, tenantId: number, stationId: string, deviceModelRepository: IDeviceModelRepository, chargingProfileRepository: IChargingProfileRepository, transactionEventRepository: ITransactionEventRepository, logger: Logger<ILogObj>, evseId?: number | null): Promise<void>;
+/**
+ * Validate ISO15693 ID token format
+ * ISO 15693 UID should be exactly 8 bytes (16 hex characters)
+ */
+export declare function validateISO15693IdToken(idToken: string): boolean;
+/**
+ * Validate ISO14443 ID token format
+ * ISO 14443 UID should be 4 or 7 bytes (8 or 14 hex characters)
+ */
+export declare function validateISO14443IdToken(idToken: string): boolean;
+/**
+ * Validate identifier string format per OCPP 2.0.1. We expect this validation already from the JSON schema,
+ * but we add this extra validation to be sure.
+ * Only allows: a-z, A-Z, 0-9, *, -, _, =, :, +, |, @, .
+ */
+export declare function validateIdentifierStringIdToken(idToken: string): boolean;
+/**
+ * Validates an eMAID string according to eMI³ specifications
+ * @param emaid - The eMAID string to validate
+ * @returns errors - String array with errors, empty if valid
+ */
+export declare function validateEMAIDIdToken(emaid: string): string[];
+/**
+ * Validate NoAuthorization ID token (should be empty)
+ */
+export declare function validateNoAuthorizationIdToken(idToken: string): boolean;
+/**
+ * Generic validation result for all validators
+ */
+export interface ValidationResult {
+    isValid: boolean;
+    errorMessage?: string;
+}
+/**
+ * ID token validator - routes to appropriate validator based on type
+ * Returns validation result with detailed error message if invalid
+ */
+export declare function validateIdToken(idTokenType: OCPP2_0_1.IdTokenEnumType, idToken: string): ValidationResult;
+/**
+ * Validate ASCII content - only printable ASCII allowed (characters 32-126)
+ * @param content Content string to validate
+ * @returns {boolean} true if content contains only printable ASCII characters
+ */
+export declare function validateASCIIContent(content: string): boolean;
+/**
+ * Validate HTML content - checks for basic HTML structure validity
+ * @param content Content string to validate
+ * @returns {boolean} true if content appears to be valid HTML
+ */
+export declare function validateHTMLContent(content: string): boolean;
+/**
+ * Validate URI content - checks if content is a valid URI
+ * @param content Content string to validate
+ * @returns {boolean} true if content is a valid URI
+ */
+export declare function validateURIContent(content: string): boolean;
+/**
+ * Validate UTF-8 content - in JavaScript, strings are already UTF-16 encoded
+ * This function checks for invalid surrogate pairs and control characters
+ * @param content Content string to validate
+ * @returns {boolean} true if content is valid UTF-8
+ */
+export declare function validateUTF8Content(content: string): boolean;
+/**
+ * Message content validator - routes to appropriate validator based on format
+ * Returns validation result with detailed error message if invalid
+ * @param format Message format type (ASCII, HTML, URI, UTF8)
+ * @param content Message content to validate
+ * @returns {ValidationResult} Validation result with error message if invalid
+ */
+export declare function validateMessageContent(format: OCPP2_0_1.MessageFormatEnumType, content: string): ValidationResult;
+/**
+ * Validate a complete MessageContentType object
+ * Convenience function that validates both language tag (if present) and content against format
+ * @param messageContent MessageContentType object to validate
+ * @returns {ValidationResult} Validation result with error message if invalid
+ */
+export declare function validateMessageContentType(messageContent: OCPP2_0_1.MessageContentType): ValidationResult;
+/**
+ * Validate PEM-encoded Certificate Signing Request (CSR)
+ * According to RFC 2986, CSR must be PEM-encoded with proper headers and valid base64 content
+ * @param csr CSR string to validate
+ * @returns {ValidationResult} Validation result with error message if invalid
+ */
+export declare function validatePEMEncodedCSR(csr: string): ValidationResult;