kirby-ocpp 0.1.1 → 0.2.0

package/dist/ocpp/client.js

@@ -1,299 +0,0 @@
-import EventEmitter from "node:events";
-import { readFileSync } from "node:fs";
-import { nanoid } from "nanoid";
-import WebSocket from "ws";
-import { OcppSchemaValidator } from "./schema-validator.js";
-export class OcppClient extends EventEmitter {
-    centralSystemUrl;
-    chargePointId;
-    options;
-    socket;
-    pingTimer;
-    awaitingPong = false;
-    pending = new Map();
-    incomingCalls = new Map();
-    schemaValidator = new OcppSchemaValidator();
-    constructor(centralSystemUrl, chargePointId, options = {}) {
-        super();
-        this.centralSystemUrl = centralSystemUrl;
-        this.chargePointId = chargePointId;
-        this.options = options;
-    }
-    get isConnected() {
-        return this.socket?.readyState === WebSocket.OPEN;
-    }
-    connect() {
-        this.close();
-        const url = this.buildChargePointUrl();
-        const subprotocol = this.options.subprotocol ?? "ocpp1.6";
-        this.socket = new WebSocket(url, [subprotocol], this.buildWebSocketOptions());
-        this.socket.on("open", () => {
-            if (this.socket?.protocol !== subprotocol) {
-                const error = new Error(`Central System did not negotiate required WebSocket subprotocol ${subprotocol}`);
-                this.emit("error", error);
-                this.socket?.close(1002, "OCPP subprotocol required");
-                return;
-            }
-            this.startPingTimer();
-            this.emit("connected");
-        });
-        this.socket.on("message", (data) => this.handleMessage(data.toString()));
-        this.socket.on("pong", () => {
-            this.awaitingPong = false;
-        });
-        this.socket.on("close", (code, reason) => {
-            this.stopPingTimer();
-            this.rejectPending(new Error(`Connection closed (${code})`));
-            this.emit("disconnected", code, reason.toString());
-        });
-        this.socket.on("error", (error) => this.emit("error", error));
-    }
-    close() {
-        if (!this.socket) {
-            return;
-        }
-        this.rejectPending(new Error("Connection closed"));
-        this.stopPingTimer();
-        const socket = this.socket;
-        socket.removeAllListeners();
-        socket.on("error", () => { });
-        if (socket.readyState === WebSocket.OPEN) {
-            socket.close();
-        }
-        else if (socket.readyState === WebSocket.CONNECTING) {
-            socket.terminate();
-        }
-        this.socket = undefined;
-    }
-    async call(action, payload, timeoutMs = 30_000) {
-        if (!this.isConnected || !this.socket) {
-            throw new Error("Not connected to Central System");
-        }
-        this.assertValidRequest(action, payload);
-        const messageId = nanoid(12);
-        const message = [2, messageId, action, payload];
-        const response = new Promise((resolve, reject) => {
-            const timeout = setTimeout(() => {
-                this.pending.delete(messageId);
-                reject(new Error(`${action} timed out after ${timeoutMs}ms`));
-            }, timeoutMs);
-            this.pending.set(messageId, { action, resolve, reject, timeout });
-        });
-        this.send(message);
-        return response;
-    }
-    reply(messageId, payload) {
-        const action = this.incomingCalls.get(messageId);
-        if (!action) {
-            throw new Error(`Cannot reply to unknown CALL ${messageId}`);
-        }
-        this.assertValidResponse(action, payload);
-        this.incomingCalls.delete(messageId);
-        this.send([3, messageId, payload]);
-    }
-    replyError(messageId, code, description, details = {}) {
-        this.incomingCalls.delete(messageId);
-        this.send([4, messageId, code, description, details]);
-    }
-    send(message) {
-        if (!this.socket || this.socket.readyState !== WebSocket.OPEN) {
-            throw new Error("WebSocket is not open");
-        }
-        this.socket.send(JSON.stringify(message));
-        this.emit("log", "out", message);
-    }
-    handleMessage(raw) {
-        let message;
-        try {
-            message = JSON.parse(raw);
-        }
-        catch (error) {
-            this.emit("error", error instanceof Error ? error : new Error(String(error)));
-            return;
-        }
-        this.emit("log", "in", message);
-        if (!Array.isArray(message)) {
-            this.emit("error", new Error("Invalid OCPP message: expected array"));
-            return;
-        }
-        if (message[0] === 2) {
-            if (!this.isValidCall(message)) {
-                const messageId = this.readMessageId(message);
-                if (messageId) {
-                    this.replyError(messageId, "FormationViolation", "Invalid CALL frame");
-                }
-                this.emit("error", new Error("Invalid CALL frame"));
-                return;
-            }
-            const call = message;
-            if (!this.schemaValidator.hasRequestSchema(call[2])) {
-                this.replyError(call[1], "NotImplemented", `${call[2]} is not an OCPP 1.6J action`);
-                return;
-            }
-            const validation = this.schemaValidator.validateRequest(call[2], call[3]);
-            if (!validation.valid) {
-                this.replyError(call[1], this.validationErrorCode(validation.errorNames), validation.errors.join("; "));
-                return;
-            }
-            this.incomingCalls.set(call[1], call[2]);
-            this.emit("call", call[1], call[2], call[3] ?? {});
-            return;
-        }
-        if (message[0] === 3) {
-            if (!this.isValidCallResult(message)) {
-                this.emit("error", new Error("Invalid CALLRESULT frame"));
-                return;
-            }
-            this.resolveCall(message);
-            return;
-        }
-        if (message[0] === 4) {
-            if (!this.isValidCallError(message)) {
-                this.emit("error", new Error("Invalid CALLERROR frame"));
-                return;
-            }
-            this.rejectCall(message);
-            return;
-        }
-        this.emit("error", new Error(`Unsupported OCPP message type: ${message[0]}`));
-    }
-    resolveCall(message) {
-        const [, messageId, payload] = message;
-        const pending = this.pending.get(messageId);
-        if (!pending) {
-            return;
-        }
-        clearTimeout(pending.timeout);
-        this.pending.delete(messageId);
-        const validation = this.schemaValidator.validateResponse(pending.action, payload);
-        if (!validation.valid) {
-            pending.reject(new Error(`${pending.action} response violates OCPP 1.6J schema (${this.validationErrorCode(validation.errorNames)}): ${validation.errors.join("; ")}`));
-            return;
-        }
-        pending.resolve({ messageId, payload });
-    }
-    rejectCall(message) {
-        const error = this.toError(message);
-        const pending = this.pending.get(error.messageId);
-        if (!pending) {
-            this.emit("error", new Error(error.description || error.code));
-            return;
-        }
-        clearTimeout(pending.timeout);
-        this.pending.delete(error.messageId);
-        pending.reject(new Error(`${pending.action} failed: ${error.code} ${error.description}`.trim()));
-    }
-    rejectPending(error) {
-        for (const [messageId, pending] of this.pending) {
-            clearTimeout(pending.timeout);
-            pending.reject(error);
-            this.pending.delete(messageId);
-        }
-    }
-    toError(message) {
-        const [, messageId, code, description, details] = message;
-        return { messageId, code, description, details };
-    }
-    assertValidRequest(action, payload) {
-        const validation = this.schemaValidator.validateRequest(action, payload);
-        if (!validation.valid) {
-            throw new Error(`${action} request violates OCPP 1.6J schema (${this.validationErrorCode(validation.errorNames)}): ${validation.errors.join("; ")}`);
-        }
-    }
-    assertValidResponse(action, payload) {
-        const validation = this.schemaValidator.validateResponse(action, payload);
-        if (!validation.valid) {
-            throw new Error(`${action} response violates OCPP 1.6J schema (${this.validationErrorCode(validation.errorNames)}): ${validation.errors.join("; ")}`);
-        }
-    }
-    validationErrorCode(errorNames) {
-        if (errorNames.includes("required")) {
-            return "OccurenceConstraintViolation";
-        }
-        if (errorNames.includes("type")) {
-            return "TypeConstraintViolation";
-        }
-        if (errorNames.some((name) => ["additionalProperties", "enum", "maxLength", "minLength", "minimum", "maximum", "multipleOf", "format"].includes(name))) {
-            return "PropertyConstraintViolation";
-        }
-        return "FormationViolation";
-    }
-    isValidCall(message) {
-        return (message.length === 4 &&
-            message[0] === 2 &&
-            typeof message[1] === "string" &&
-            typeof message[2] === "string" &&
-            this.isObjectPayload(message[3]));
-    }
-    isValidCallResult(message) {
-        return message.length === 3 && message[0] === 3 && typeof message[1] === "string" && this.isObjectPayload(message[2]);
-    }
-    isValidCallError(message) {
-        return (message.length === 5 &&
-            message[0] === 4 &&
-            typeof message[1] === "string" &&
-            typeof message[2] === "string" &&
-            typeof message[3] === "string" &&
-            this.isObjectPayload(message[4]));
-    }
-    isObjectPayload(value) {
-        return Boolean(value) && typeof value === "object" && !Array.isArray(value);
-    }
-    readMessageId(message) {
-        return typeof message[1] === "string" ? message[1] : undefined;
-    }
-    startPingTimer() {
-        this.stopPingTimer();
-        const intervalSeconds = this.options.pingIntervalSeconds ?? 30;
-        if (intervalSeconds <= 0) {
-            return;
-        }
-        this.awaitingPong = false;
-        this.pingTimer = setInterval(() => {
-            if (this.socket?.readyState === WebSocket.OPEN) {
-                if (this.awaitingPong) {
-                    this.emit("error", new Error("WebSocket pong timed out"));
-                    this.socket.terminate();
-                    return;
-                }
-                this.awaitingPong = true;
-                this.socket.ping();
-            }
-        }, intervalSeconds * 1000);
-        this.pingTimer.unref();
-    }
-    stopPingTimer() {
-        if (!this.pingTimer) {
-            return;
-        }
-        clearInterval(this.pingTimer);
-        this.pingTimer = undefined;
-        this.awaitingPong = false;
-    }
-    buildChargePointUrl() {
-        const base = this.centralSystemUrl.replace(/\/+$/, "");
-        const id = encodeURIComponent(this.chargePointId);
-        if (base.endsWith(`/${id}`)) {
-            return base;
-        }
-        return `${base}/${id}`;
-    }
-    buildWebSocketOptions() {
-        const options = {
-            rejectUnauthorized: this.options.tlsRejectUnauthorized ?? true
-        };
-        if (this.options.tlsCaFile) {
-            options.ca = readFileSync(this.options.tlsCaFile);
-        }
-        if (this.options.tlsCertFile) {
-            options.cert = readFileSync(this.options.tlsCertFile);
-        }
-        if (this.options.tlsKeyFile) {
-            options.key = readFileSync(this.options.tlsKeyFile);
-        }
-        if (this.options.tlsServerName) {
-            options.servername = this.options.tlsServerName;
-        }
-        return options;
-    }
-}

package/dist/ocpp/schema-validator.d.ts

@@ -1,15 +0,0 @@
-export interface OcppSchemaValidationResult {
-    valid: boolean;
-    errors: string[];
-    errorNames: string[];
-}
-export declare class OcppSchemaValidator {
-    private readonly validator;
-    private readonly schemas;
-    constructor(schemaDirectory?: string);
-    hasRequestSchema(action: string): boolean;
-    hasResponseSchema(action: string): boolean;
-    validateRequest(action: string, payload: unknown): OcppSchemaValidationResult;
-    validateResponse(action: string, payload: unknown): OcppSchemaValidationResult;
-    private validate;
-}

package/dist/ocpp/schema-validator.js

@@ -1,75 +0,0 @@
-import { existsSync, readdirSync, readFileSync } from "node:fs";
-import { dirname, join } from "node:path";
-import { fileURLToPath } from "node:url";
-import { Validator } from "jsonschema";
-export class OcppSchemaValidator {
-    validator = new Validator();
-    schemas = new Map();
-    constructor(schemaDirectory = findSchemaDirectory()) {
-        for (const file of readdirSync(schemaDirectory)) {
-            if (!file.endsWith(".json")) {
-                continue;
-            }
-            const schema = JSON.parse(readFileSync(join(schemaDirectory, file), "utf8"));
-            const name = file.replace(/\.json$/, "");
-            this.schemas.set(name, stripSchemaMetadata(schema, true));
-        }
-    }
-    hasRequestSchema(action) {
-        return this.schemas.has(action);
-    }
-    hasResponseSchema(action) {
-        return this.schemas.has(`${action}Response`);
-    }
-    validateRequest(action, payload) {
-        return this.validate(action, payload);
-    }
-    validateResponse(action, payload) {
-        return this.validate(`${action}Response`, payload);
-    }
-    validate(schemaName, payload) {
-        const schema = this.schemas.get(schemaName);
-        if (!schema) {
-            return {
-                valid: false,
-                errors: [`No JSON schema found for ${schemaName}`],
-                errorNames: ["schema"]
-            };
-        }
-        const result = this.validator.validate(payload, schema);
-        return {
-            valid: result.valid,
-            errors: result.errors.map((error) => error.stack),
-            errorNames: result.errors.map((error) => error.name)
-        };
-    }
-}
-function stripSchemaMetadata(value, root = false) {
-    if (Array.isArray(value)) {
-        return value.map((item) => stripSchemaMetadata(item));
-    }
-    if (!value || typeof value !== "object") {
-        return value;
-    }
-    const output = {};
-    for (const [key, child] of Object.entries(value)) {
-        if (key === "$schema" || key === "title" || (root && key === "id")) {
-            continue;
-        }
-        output[key] = stripSchemaMetadata(child);
-    }
-    return output;
-}
-function findSchemaDirectory() {
-    const currentDir = dirname(fileURLToPath(import.meta.url));
-    const candidates = [
-        join(currentDir, "schemas/json"),
-        join(currentDir, "../../src/ocpp/schemas/json")
-    ];
-    for (const candidate of candidates) {
-        if (existsSync(candidate)) {
-            return candidate;
-        }
-    }
-    throw new Error("OCPP 1.6J JSON schemas were not found");
-}

package/dist/ocpp/schemas/json/Authorize.json

@@ -1,16 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-04/schema#",
-    "id": "urn:OCPP:1.6:2019:12:AuthorizeRequest",
-    "title": "AuthorizeRequest",
-    "type": "object",
-    "properties": {
-        "idTag": {
-            "type": "string",
-            "maxLength": 20
-        }
-    },
-    "additionalProperties": false,
-    "required": [
-        "idTag"
-    ]
-}

package/dist/ocpp/schemas/json/AuthorizeResponse.json

@@ -1,40 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-04/schema#",
-    "id": "urn:OCPP:1.6:2019:12:AuthorizeResponse",
-    "title": "AuthorizeResponse",
-    "type": "object",
-    "properties": {
-        "idTagInfo": {
-            "type": "object",
-            "properties": {
-                "expiryDate": {
-                    "type": "string",
-                    "format": "date-time"
-                },
-                "parentIdTag": {
-                    "type": "string",
-                    "maxLength": 20
-                },
-                "status": {
-                    "type": "string",
-                    "additionalProperties": false,
-                    "enum": [
-                        "Accepted",
-                        "Blocked",
-                        "Expired",
-                        "Invalid",
-                        "ConcurrentTx"
-                    ]
-                }
-            },
-            "additionalProperties": false,
-            "required": [
-                "status"
-            ]
-        }
-    },
-    "additionalProperties": false,
-    "required": [
-        "idTagInfo"
-    ]
-}

package/dist/ocpp/schemas/json/BootNotification.json

@@ -1,49 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-04/schema#",
-    "id": "urn:OCPP:1.6:2019:12:BootNotificationRequest",
-    "title": "BootNotificationRequest",
-    "type": "object",
-    "properties": {
-        "chargePointVendor": {
-            "type": "string",
-            "maxLength": 20
-        },
-        "chargePointModel": {
-            "type": "string",
-            "maxLength": 20
-        },
-        "chargePointSerialNumber": {
-            "type": "string",
-            "maxLength": 25
-        },
-        "chargeBoxSerialNumber": {
-            "type": "string",
-            "maxLength": 25
-        },
-        "firmwareVersion": {
-            "type": "string",
-            "maxLength": 50
-        },
-        "iccid": {
-            "type": "string",
-            "maxLength": 20
-        },
-        "imsi": {
-            "type": "string",
-            "maxLength": 20
-        },
-        "meterType": {
-            "type": "string",
-            "maxLength": 25
-        },
-        "meterSerialNumber": {
-            "type": "string",
-            "maxLength": 25
-        }
-    },
-    "additionalProperties": false,
-    "required": [
-        "chargePointVendor",
-        "chargePointModel"
-    ]
-}

package/dist/ocpp/schemas/json/BootNotificationResponse.json

@@ -1,30 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-04/schema#",
-    "id": "urn:OCPP:1.6:2019:12:BootNotificationResponse",
-    "title": "BootNotificationResponse",
-    "type": "object",
-    "properties": {
-        "status": {
-            "type": "string",
-            "additionalProperties": false,
-            "enum": [
-                "Accepted",
-                "Pending",
-                "Rejected"
-            ]
-        },
-        "currentTime": {
-            "type": "string",
-            "format": "date-time"
-        },
-        "interval": {
-            "type": "integer"
-        }
-    },
-    "additionalProperties": false,
-    "required": [
-        "status",
-        "currentTime",
-        "interval"
-    ]
-}

package/dist/ocpp/schemas/json/CancelReservation.json

@@ -1,15 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-04/schema#",
-    "id": "urn:OCPP:1.6:2019:12:CancelReservationRequest",
-    "title": "CancelReservationRequest",
-    "type": "object",
-    "properties": {
-        "reservationId": {
-            "type": "integer"
-        }
-    },
-    "additionalProperties": false,
-    "required": [
-        "reservationId"
-    ]
-}

package/dist/ocpp/schemas/json/CancelReservationResponse.json

@@ -1,20 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-04/schema#",
-    "id": "urn:OCPP:1.6:2019:12:CancelReservationResponse",
-    "title": "CancelReservationResponse",
-    "type": "object",
-    "properties": {
-        "status": {
-            "type": "string",
-            "additionalProperties": false,
-            "enum": [
-                "Accepted",
-                "Rejected"
-            ]
-        }
-    },
-    "additionalProperties": false,
-    "required": [
-        "status"
-    ]
-}

package/dist/ocpp/schemas/json/ChangeAvailability.json

@@ -1,24 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-04/schema#",
-    "id": "urn:OCPP:1.6:2019:12:ChangeAvailabilityRequest",
-    "title": "ChangeAvailabilityRequest",
-    "type": "object",
-    "properties": {
-        "connectorId": {
-            "type": "integer"
-        },
-        "type": {
-            "type": "string",
-            "additionalProperties": false,
-            "enum": [
-                "Inoperative",
-                "Operative"
-            ]
-        }
-    },
-    "additionalProperties": false,
-    "required": [
-        "connectorId",
-        "type"
-    ]
-}

package/dist/ocpp/schemas/json/ChangeAvailabilityResponse.json

@@ -1,21 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-04/schema#",
-    "id": "urn:OCPP:1.6:2019:12:ChangeAvailabilityResponse",
-    "title": "ChangeAvailabilityResponse",
-    "type": "object",
-    "properties": {
-        "status": {
-            "type": "string",
-            "additionalProperties": false,
-            "enum": [
-                "Accepted",
-                "Rejected",
-                "Scheduled"
-            ]
-        }
-    },
-    "additionalProperties": false,
-    "required": [
-        "status"
-    ]
-}

package/dist/ocpp/schemas/json/ChangeConfiguration.json

@@ -1,21 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-04/schema#",
-    "id": "urn:OCPP:1.6:2019:12:ChangeConfigurationRequest",
-    "title": "ChangeConfigurationRequest",
-    "type": "object",
-    "properties": {
-        "key": {
-            "type": "string",
-            "maxLength": 50
-        },
-        "value": {
-            "type": "string",
-            "maxLength": 500
-        }
-    },
-    "additionalProperties": false,
-    "required": [
-        "key",
-        "value"
-    ]
-}

package/dist/ocpp/schemas/json/ChangeConfigurationResponse.json

@@ -1,22 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-04/schema#",
-    "id": "urn:OCPP:1.6:2019:12:ChangeConfigurationResponse",
-    "title": "ChangeConfigurationResponse",
-    "type": "object",
-    "properties": {
-        "status": {
-            "type": "string",
-            "additionalProperties": false,
-            "enum": [
-                "Accepted",
-                "Rejected",
-                "RebootRequired",
-                "NotSupported"
-            ]
-        }
-    },
-    "additionalProperties": false,
-    "required": [
-        "status"
-    ]
-}

package/dist/ocpp/schemas/json/ClearCache.json

@@ -1,8 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-04/schema#",
-    "id": "urn:OCPP:1.6:2019:12:ClearCacheRequest",
-    "title": "ClearCacheRequest",
-    "type": "object",
-    "properties": {},
-    "additionalProperties": false
-}