Merge pull request #264 from citrineos/rc-1.4.3

Rc 1.4.3

00_Base/json-schema-processor.js

@@ -139,6 +139,7 @@ async function processJsonSchema(data, writeToFile = true) {
       .compile(jsonSchema, id, {
         style: { singleQuote: true, trailingComma: 'all' },
         format: true,
+        enableConstEnums: false,
       })
       .then((ts) => {
         // Add licence comment
@@ -185,8 +186,7 @@ async function processJsonSchema(data, writeToFile = true) {
 
         // Add null type to all optional properties
         // This regex means a string starts with '?:' and ends with ';'
-        // and contains no '[' or ']' in between
-        const regex = /(\?:[^;\[\]]*);/g;
+        const regex = /(\?:[^;]*);/g;
         ts = ts.replaceAll(regex, '$1 | null;');
 
         if (writeToFile) {
@@ -252,18 +252,15 @@ function processNode(node) {
 
 function extractEnums(ts) {
   const pattern =
-    /^\/\*\*\s*\n([^\*]|(\*(?!\/)))*\*\/\nexport const enum (\w)* {(\s|\w|-|\.|=|'|,)*}\n*/gm;
-  const undocumentedPattern =
-    /^export const enum (\w)* {(\s|\w|-|\.|=|'|,)*}\n*/gm;
+    /^\/\*\*\s*\n([^\*]|(\*(?!\/)))*\*\/\nexport enum (\w)* {(\s|\w|-|\.|=|'|,)*}\n*/gm;
+  const undocumentedPattern = /^export enum (\w)* {(\s|\w|-|\.|=|'|,)*}\n*/gm;
   const matches = ts.match(pattern);
   let undocumentedMatches = ts.match(undocumentedPattern);
 
   if (matches && undocumentedMatches) {
-    const namePattern = /export const enum (\w)*/g;
+    const namePattern = /export enum (\w)*/g;
     matches.forEach((match) => {
-      const enumName = match
-        .match(namePattern)[0]
-        .replace('export const enum ', '');
+      const enumName = match.match(namePattern)[0].replace('export enum ', '');
       undocumentedMatches = undocumentedMatches.filter(
         (undocumentedMatch) => !undocumentedMatch.includes(enumName),
       );
@@ -278,10 +275,10 @@ function extractEnums(ts) {
 
 function splitEnum(enumDefinition) {
   const commentPattern = /^\/\*\*\s*\n([^\*]|(\*(?!\/)))*\*\/\n/gm;
-  const namePattern = /export const enum (\w)*/g;
+  const namePattern = /export enum (\w)*/g;
   const enumName = enumDefinition
     .match(namePattern)[0]
-    .replace('export const enum ', '');
+    .replace('export enum ', '');
   let enumDocumentation = enumDefinition.match(commentPattern);
   enumDocumentation = enumDocumentation ? enumDocumentation[0] : '';
   return { enumName, enumDocumentation, enumDefinition };

00_Base/package.json

@@ -1,16 +1,18 @@
 {
   "name": "@citrineos/base",
-  "version": "1.4.2",
+  "version": "1.4.3",
   "description": "The base module for OCPP v2.0.1 including all interfaces. This module is not intended to be used directly, but rather as a dependency for other modules.",
   "main": "dist/index.js",
+  "module": "dist/esm/index.js",
   "types": "dist/index.d.ts",
   "files": [
     "dist"
   ],
   "scripts": {
     "prepublish": "npx eslint ./src",
     "generate-interfaces": "node json-schema-processor.js",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build:esm": "tsc --project tsconfig.esm.json"
   },
   "keywords": [
     "ocpp",
@@ -40,6 +42,6 @@
     "reflect-metadata": "0.1.13",
     "tslog": "4.9.2",
     "uuid": "9.0.0",
-    "zod": "3.22.2"
+    "zod": "3.22.3"
   }
 }

00_Base/src/assertion/assertion.ts

@@ -25,3 +25,38 @@ export function assert(
 export function notNull(object: any): boolean {
   return object !== undefined && object !== null;
 }
+
+/**
+ * Ensures that obj2 contains all keys from obj1.
+ * @param obj1 
+ * @param obj2 
+ * @returns 
+ */
+
+export function deepDirectionalEqual(obj1: any, obj2: any, seenObjects = new WeakSet()): boolean {
+  if (obj1 === obj2) return true;
+
+  if (typeof obj1 !== 'object' || obj1 === null ||
+    typeof obj2 !== 'object' || obj2 === null) {
+    return false;
+  }
+
+  // Check if obj1 has already been seen to avoid cycles
+  if (seenObjects.has(obj1)) {
+    return true; // If we've already seen obj1, we assume it's equivalent.
+  }
+
+  // Add obj1 to the seen set
+  seenObjects.add(obj1);
+
+  const keys1 = Object.keys(obj1);
+  const keys2 = Object.keys(obj2);
+
+  for (const key of keys1) {
+    if (!keys2.includes(key) || !deepDirectionalEqual(obj1[key], obj2[key], seenObjects)) {
+      return false;
+    }
+  }
+
+  return true;
+}

00_Base/src/index.ts

@@ -16,6 +16,7 @@ export { CacheNamespace, ICache } from './interfaces/cache/cache';
 export {
   AbstractMessageRouter,
   IAuthenticator,
+  AuthenticationOptions,
   IMessageRouter,
 } from './interfaces/router';
 export {
@@ -68,6 +69,8 @@ export const LOG_LEVEL_OCPP = 10;
 
 export * from './ocpp/model';
 
+export { UpdateChargingStationPasswordRequest } from './ocpp/model/UpdateChargingStationPasswordRequest';
+
 import {
   AuthorizeRequestSchema,
   BootNotificationRequestSchema,
@@ -237,7 +240,7 @@ export { HttpHeader } from './interfaces/api/http.header';
 export { HttpStatus } from './interfaces/api/http.status';
 export { Money } from './money/Money';
 export { Currency, CurrencyCode } from './money/Currency';
-export { assert, notNull } from './assertion/assertion';
+export { assert, notNull, deepDirectionalEqual } from './assertion/assertion';
 export { UnauthorizedError } from './interfaces/api/exception/UnauthorizedError';
 export { AuthorizationSecurity } from './interfaces/api/AuthorizationSecurity';
 export { Ajv };

00_Base/src/interfaces/api/AbstractModuleApi.ts

@@ -23,7 +23,7 @@ import {
   IMessageQuerystringSchema,
 } from './MessageQuerystring';
 import { IModuleApi } from './ModuleApi';
-import {AuthorizationSecurity} from "./AuthorizationSecurity";
+import { AuthorizationSecurity } from './AuthorizationSecurity';
 
 /**
  * Abstract module api class implementation.

00_Base/src/interfaces/api/ExceptionHandler.ts

@@ -1,4 +1,4 @@
-import {FastifyError, FastifyReply, FastifyRequest} from 'fastify';
+import { FastifyError, FastifyReply, FastifyRequest } from 'fastify';
 
 export interface ExceptionHandler {
   handle(

00_Base/src/interfaces/router/AuthenticationOptions.ts

@@ -0,0 +1,4 @@
+export type AuthenticationOptions = {
+  securityProfile: number;
+  allowUnknownChargingStations: boolean;
+};

00_Base/src/interfaces/router/Authenticator.ts

@@ -2,11 +2,12 @@
 //
 // SPDX-License-Identifier: Apache 2.0
 
+import { IncomingMessage } from 'http';
+import { AuthenticationOptions } from './AuthenticationOptions';
+
 export interface IAuthenticator {
   authenticate(
-    allowUnknownChargingStations: boolean,
-    identifier: string,
-    username?: string,
-    password?: string,
-  ): Promise<boolean>;
+    request: IncomingMessage,
+    options: AuthenticationOptions,
+  ): Promise<{ identifier: string }>;
 }

00_Base/src/interfaces/router/index.ts

@@ -6,3 +6,4 @@
 export { IMessageRouter } from './Router';
 export { AbstractMessageRouter } from './AbstractRouter';
 export { IAuthenticator } from './Authenticator';
+export { AuthenticationOptions } from './AuthenticationOptions';