@zetra/citrineos-base 1.8.3-fork.1

package/dist/assertion/assertion.d.ts

@@ -0,0 +1,9 @@
+export declare function assert(predicate: boolean | (() => boolean), message?: string): asserts predicate;
+export declare function notNull(object: any): boolean;
+/**
+ * Ensures that obj2 contains all keys from obj1.
+ * @param obj1
+ * @param obj2
+ * @returns
+ */
+export declare function deepDirectionalEqual(obj1: any, obj2: any, seenObjects?: WeakSet<object>): boolean;

package/dist/assertion/assertion.js

@@ -0,0 +1,54 @@
+// SPDX-FileCopyrightText: 2025 Contributors to the CitrineOS Project
+//
+// SPDX-License-Identifier: Apache-2.0
+export function assert(predicate, message) {
+    switch (typeof predicate) {
+        case 'boolean': {
+            if (!predicate) {
+                throw new Error(message);
+            }
+            break;
+        }
+        case 'function': {
+            if (!predicate()) {
+                throw new Error(message);
+            }
+            break;
+        }
+        default: {
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            const exhaustiveCheck = predicate;
+        }
+    }
+}
+export function notNull(object) {
+    return object !== undefined && object !== null;
+}
+/**
+ * Ensures that obj2 contains all keys from obj1.
+ * @param obj1
+ * @param obj2
+ * @returns
+ */
+export function deepDirectionalEqual(obj1, obj2, seenObjects = new WeakSet()) {
+    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;
+}
+//# sourceMappingURL=assertion.js.map

package/dist/assertion/assertion.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assertion.js","sourceRoot":"","sources":["../../src/assertion/assertion.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,EAAE;AACF,sCAAsC;AACtC,MAAM,UAAU,MAAM,CAAC,SAAoC,EAAE,OAAgB;IAC3E,QAAQ,OAAO,SAAS,EAAE,CAAC;QACzB,KAAK,SAAS,CAAC,CAAC,CAAC;YACf,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;YAC3B,CAAC;YACD,MAAM;QACR,CAAC;QACD,KAAK,UAAU,CAAC,CAAC,CAAC;YAChB,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC;gBACjB,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;YAC3B,CAAC;YACD,MAAM;QACR,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,6DAA6D;YAC7D,MAAM,eAAe,GAAU,SAAS,CAAC;QAC3C,CAAC;IACH,CAAC;AACH,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,MAAW;IACjC,OAAO,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,IAAI,CAAC;AACjD,CAAC;AAED;;;;;GAKG;AAEH,MAAM,UAAU,oBAAoB,CAAC,IAAS,EAAE,IAAS,EAAE,WAAW,GAAG,IAAI,OAAO,EAAE;IACpF,IAAI,IAAI,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAE/B,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QAC3F,OAAO,KAAK,CAAC;IACf,CAAC;IAED,sDAAsD;IACtD,IAAI,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;QAC1B,OAAO,IAAI,CAAC,CAAC,yDAAyD;IACxE,CAAC;IAED,2BAA2B;IAC3B,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAEtB,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChC,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAEhC,KAAK,MAAM,GAAG,IAAI,KAAK,EAAE,CAAC;QACxB,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE,WAAW,CAAC,EAAE,CAAC;YACrF,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC"}

package/dist/config/BootConfig.d.ts

@@ -0,0 +1,40 @@
+export interface BootConfig {
+    /**
+     *  Also declared in SystemConfig. If absent, SystemConfig value is used.
+     */
+    heartbeatInterval?: number | null;
+    /**
+     * Also declared in SystemConfig. If absent, SystemConfig value is used.
+     */
+    bootRetryInterval?: number | null;
+    status: string;
+    statusInfo?: object | null;
+    /**
+     * Also declared in SystemConfig. If absent, SystemConfig value is used.
+     */
+    getBaseReportOnPending?: boolean | null;
+    /**
+     * Ids of variable attributes to be sent in SetVariablesRequest on pending boot
+     */
+    pendingBootSetVariableIds?: number[] | null;
+    /**
+     * Also declared in SystemConfig. If absent, SystemConfig value is used.
+     */
+    bootWithRejectedVariables?: boolean | null;
+    /**
+     * Specifically for OCPP 1.6 which plays similar role to pendingBootSetVariableIds
+     */
+    changeConfigurationsOnPending?: boolean | null;
+    /**
+     * Specifically for OCPP 1.6 which plays similar role to getBaseReportOnPending
+     */
+    getConfigurationsOnPending?: boolean | null;
+}
+/**
+ * Cache boot status is used to keep track of the overall boot process for Rejected or Pending.
+ * When Accepting a boot, blacklist needs to be cleared if and only if there was a previously
+ * Rejected or Pending boot. When starting to configure charger, i.e. sending GetBaseReport or
+ * SetVariables, this should only be done if configuring is not still ongoing from a previous
+ * BootNotificationRequest. Cache boot status mediates this behavior.
+ */
+export declare const BOOT_STATUS = "boot_status";

package/dist/config/BootConfig.js

@@ -0,0 +1,12 @@
+// SPDX-FileCopyrightText: 2025 Contributors to the CitrineOS Project
+//
+// SPDX-License-Identifier: Apache-2.0
+/**
+ * Cache boot status is used to keep track of the overall boot process for Rejected or Pending.
+ * When Accepting a boot, blacklist needs to be cleared if and only if there was a previously
+ * Rejected or Pending boot. When starting to configure charger, i.e. sending GetBaseReport or
+ * SetVariables, this should only be done if configuring is not still ongoing from a previous
+ * BootNotificationRequest. Cache boot status mediates this behavior.
+ */
+export const BOOT_STATUS = 'boot_status';
+//# sourceMappingURL=BootConfig.js.map

package/dist/config/BootConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BootConfig.js","sourceRoot":"","sources":["../../src/config/BootConfig.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,EAAE;AACF,sCAAsC;AAmCtC;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,aAAa,CAAC"}

package/dist/config/ConfigStore.d.ts

@@ -0,0 +1,11 @@
+import type { IFileStorage } from '../interfaces/files/index.js';
+import type { SystemConfig } from './types.js';
+export interface ConfigStore extends IFileStorage {
+    fetchConfig(): Promise<SystemConfig | null>;
+    saveConfig(config: SystemConfig): Promise<void>;
+}
+export declare class ConfigStoreFactory {
+    private static instance;
+    static setConfigStore(configStorage: ConfigStore): ConfigStore;
+    static getInstance(): ConfigStore;
+}

package/dist/config/ConfigStore.js

@@ -0,0 +1,22 @@
+// SPDX-FileCopyrightText: 2025 Contributors to the CitrineOS Project
+//
+// SPDX-License-Identifier: Apache-2.0
+export class ConfigStoreFactory {
+    static instance = null;
+    static setConfigStore(configStorage) {
+        if (this.instance === null) {
+            this.instance = configStorage;
+        }
+        else {
+            console.warn('ConfigStore has already been initialized.');
+        }
+        return this.instance;
+    }
+    static getInstance() {
+        if (this.instance === null) {
+            throw new Error('ConfigStore has not been initialized. Call ConfigStoreFactory.setConfigStore() first.');
+        }
+        return this.instance;
+    }
+}
+//# sourceMappingURL=ConfigStore.js.map

package/dist/config/ConfigStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigStore.js","sourceRoot":"","sources":["../../src/config/ConfigStore.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,EAAE;AACF,sCAAsC;AAUtC,MAAM,OAAO,kBAAkB;IACrB,MAAM,CAAC,QAAQ,GAAuB,IAAI,CAAC;IAEnD,MAAM,CAAC,cAAc,CAAC,aAA0B;QAC9C,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;YAC3B,IAAI,CAAC,QAAQ,GAAG,aAAa,CAAC;QAChC,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,IAAI,CAAC,2CAA2C,CAAC,CAAC;QAC5D,CAAC;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,MAAM,CAAC,WAAW;QAChB,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CACb,uFAAuF,CACxF,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC"}

package/dist/config/bootstrap.config.d.ts

@@ -0,0 +1,49 @@
+import { z } from 'zod';
+export declare const bootstrapConfigSchema: z.ZodObject<{
+    configFileName: z.ZodDefault<z.ZodString>;
+    configDir: z.ZodOptional<z.ZodString>;
+    database: z.ZodObject<{
+        host: z.ZodDefault<z.ZodString>;
+        port: z.ZodDefault<z.ZodNumber>;
+        database: z.ZodDefault<z.ZodString>;
+        dialect: z.ZodDefault<z.ZodString>;
+        username: z.ZodDefault<z.ZodString>;
+        password: z.ZodDefault<z.ZodString>;
+        pool: z.ZodOptional<z.ZodObject<{
+            max: z.ZodOptional<z.ZodNumber>;
+            min: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>;
+        sync: z.ZodDefault<z.ZodBoolean>;
+        alter: z.ZodDefault<z.ZodBoolean>;
+        force: z.ZodDefault<z.ZodBoolean>;
+        maxRetries: z.ZodDefault<z.ZodNumber>;
+        retryDelay: z.ZodDefault<z.ZodNumber>;
+    }, z.core.$strip>;
+    fileAccess: z.ZodObject<{
+        type: z.ZodEnum<{
+            local: "local";
+            s3: "s3";
+            gcp: "gcp";
+        }>;
+        local: z.ZodOptional<z.ZodObject<{
+            defaultFilePath: z.ZodDefault<z.ZodString>;
+        }, z.core.$strip>>;
+        s3: z.ZodOptional<z.ZodObject<{
+            region: z.ZodOptional<z.ZodString>;
+            endpoint: z.ZodOptional<z.ZodString>;
+            defaultBucketName: z.ZodDefault<z.ZodString>;
+            s3ForcePathStyle: z.ZodDefault<z.ZodBoolean>;
+            accessKeyId: z.ZodOptional<z.ZodString>;
+            secretAccessKey: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        gcp: z.ZodOptional<z.ZodObject<{
+            projectId: z.ZodString;
+            credentials: z.ZodOptional<z.ZodObject<{}, z.core.$strip>>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type BootstrapConfig = z.infer<typeof bootstrapConfigSchema>;
+/**
+ * Load bootstrap configuration from environment variables
+ */
+export declare function loadBootstrapConfig(): BootstrapConfig;

package/dist/config/bootstrap.config.js

@@ -0,0 +1,157 @@
+// SPDX-FileCopyrightText: 2025 Contributors to the CitrineOS Project
+//
+// SPDX-License-Identifier: Apache-2.0
+import { z } from 'zod';
+import { BOOTSTRAP_CONFIG_ENV_VAR_PREFIX } from './defineConfig.js';
+// Bootstrap schema contains what's needed to start the application
+export const bootstrapConfigSchema = z.object({
+    configFileName: z.string().default('config.json'),
+    configDir: z.string().optional(),
+    // Database configuration
+    database: z.object({
+        host: z.string().default('localhost'),
+        port: z.number().int().positive().default(5432),
+        database: z.string().default('citrine'),
+        dialect: z.string().default('postgres'),
+        username: z.string().default('citrine'),
+        password: z.string().default('citrine'),
+        pool: z
+            .object({
+            max: z.number().int().positive().optional(),
+            min: z.number().int().nonnegative().optional(),
+        })
+            .optional(),
+        sync: z.boolean().default(false),
+        alter: z.boolean().default(false),
+        force: z.boolean().default(false),
+        maxRetries: z.number().int().positive().default(3),
+        retryDelay: z.number().int().positive().default(1000),
+    }),
+    // File access configuration
+    fileAccess: z
+        .object({
+        type: z.enum(['local', 's3', 'gcp']),
+        local: z
+            .object({
+            defaultFilePath: z.string().default('data'),
+        })
+            .optional(),
+        s3: z
+            .object({
+            region: z.string().optional(),
+            endpoint: z.string().optional(),
+            defaultBucketName: z.string().default('citrineos-s3-bucket'),
+            s3ForcePathStyle: z.boolean().default(true),
+            accessKeyId: z.string().optional(),
+            secretAccessKey: z.string().optional(),
+        })
+            .optional(),
+        gcp: z
+            .object({
+            projectId: z.string(),
+            credentials: z.object().optional(),
+        })
+            .optional(),
+    })
+        .refine((obj) => {
+        // Ensure the selected type has corresponding config
+        switch (obj.type) {
+            case 'local':
+                return !!obj.local;
+            case 's3':
+                return !!obj.s3;
+            case 'gcp':
+                return !!obj.gcp;
+            default:
+                return false;
+        }
+    }, {
+        message: 'Configuration for the selected file access type must be provided',
+    }),
+});
+/**
+ * Helper function to load environment variables based on prefix
+ */
+function getEnvVarValue(key) {
+    const envKey = `${BOOTSTRAP_CONFIG_ENV_VAR_PREFIX}${key}`.toUpperCase();
+    return process.env[envKey];
+}
+/**
+ * Parse a potentially JSON-formatted environment variable
+ */
+function parseEnvValue(value) {
+    try {
+        return JSON.parse(value);
+    }
+    catch {
+        return value;
+    }
+}
+/**
+ * Load bootstrap configuration from environment variables
+ */
+export function loadBootstrapConfig() {
+    const config = {
+        configFileName: getEnvVarValue('config_filename') || 'config.json',
+        configDir: getEnvVarValue('config_dir'),
+        // Database configuration
+        database: {
+            host: getEnvVarValue('database_host'),
+            port: getEnvVarValue('database_port') && parseInt(getEnvVarValue('database_port'), 10),
+            database: getEnvVarValue('database_name'),
+            dialect: getEnvVarValue('database_dialect'),
+            username: getEnvVarValue('database_username'),
+            password: getEnvVarValue('database_password'),
+            sync: getEnvVarValue('database_sync') && parseEnvValue(getEnvVarValue('database_sync')),
+            alter: getEnvVarValue('database_alter') && parseEnvValue(getEnvVarValue('database_alter')),
+            force: getEnvVarValue('database_force') && parseEnvValue(getEnvVarValue('database_force')),
+            maxRetries: getEnvVarValue('database_max_retries') &&
+                parseInt(getEnvVarValue('database_max_retries'), 10),
+            retryDelay: getEnvVarValue('database_retry_delay') &&
+                parseInt(getEnvVarValue('database_retry_delay'), 10),
+        },
+        fileAccess: {
+            type: getEnvVarValue('file_access_type') || 'local',
+        },
+    };
+    const pool = {
+        max: getEnvVarValue('database_pool_max') && parseInt(getEnvVarValue('database_pool_max'), 10),
+        min: getEnvVarValue('database_pool_min') && parseInt(getEnvVarValue('database_pool_min'), 10),
+    };
+    if (Object.keys(pool).length > 0) {
+        config.database.pool = pool;
+    }
+    // File access configuration
+    switch (config.fileAccess.type) {
+        case 'local':
+            config.fileAccess.local = {
+                defaultFilePath: getEnvVarValue('file_access_local_default_file_path'),
+            };
+            break;
+        case 's3':
+            config.fileAccess.s3 = {
+                region: getEnvVarValue('file_access_s3_region'),
+                endpoint: getEnvVarValue('file_access_s3_endpoint'),
+                defaultBucketName: getEnvVarValue('file_access_s3_default_bucket_name'),
+                s3ForcePathStyle: getEnvVarValue('file_access_s3_force_path_style') &&
+                    parseEnvValue(getEnvVarValue('file_access_s3_force_path_style')),
+                accessKeyId: getEnvVarValue('file_access_s3_access_key_id'),
+                secretAccessKey: getEnvVarValue('file_access_s3_secret_access_key'),
+            };
+            break;
+        case 'gcp':
+            config.fileAccess.gcp = {
+                projectId: getEnvVarValue('file_access_gcp_project_id'),
+                credentials: getEnvVarValue('file_access_gcp_credentials'),
+            };
+            break;
+    }
+    try {
+        return bootstrapConfigSchema.parse(config);
+    }
+    catch (error) {
+        console.error('Bootstrap configuration validation failed:', error);
+        throw error;
+    }
+}
+//# sourceMappingURL=bootstrap.config.js.map

package/dist/config/bootstrap.config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bootstrap.config.js","sourceRoot":"","sources":["../../src/config/bootstrap.config.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,EAAE;AACF,sCAAsC;AAEtC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,+BAA+B,EAAE,MAAM,mBAAmB,CAAC;AAEpE,mEAAmE;AACnE,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,aAAa,CAAC;IACjD,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAEhC,yBAAyB;IACzB,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC;QACjB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC;QACrC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;QAC/C,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC;QACvC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC;QACvC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC;QACvC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC;QACvC,IAAI,EAAE,CAAC;aACJ,MAAM,CAAC;YACN,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;YAC3C,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE;SAC/C,CAAC;aACD,QAAQ,EAAE;QACb,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;QAChC,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;QACjC,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;QACjC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;QAClD,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;KACtD,CAAC;IAEF,4BAA4B;IAC5B,UAAU,EAAE,CAAC;SACV,MAAM,CAAC;QACN,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;QACpC,KAAK,EAAE,CAAC;aACL,MAAM,CAAC;YACN,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC;SAC5C,CAAC;aACD,QAAQ,EAAE;QACb,EAAE,EAAE,CAAC;aACF,MAAM,CAAC;YACN,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YAC7B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YAC/B,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,qBAAqB,CAAC;YAC5D,gBAAgB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;YAC3C,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YAClC,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;SACvC,CAAC;aACD,QAAQ,EAAE;QACb,GAAG,EAAE,CAAC;aACH,MAAM,CAAC;YACN,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;YACrB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;SACnC,CAAC;aACD,QAAQ,EAAE;KACd,CAAC;SACD,MAAM,CACL,CAAC,GAAG,EAAE,EAAE;QACN,oDAAoD;QACpD,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;YACjB,KAAK,OAAO;gBACV,OAAO,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC;YACrB,KAAK,IAAI;gBACP,OAAO,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;YAClB,KAAK,KAAK;gBACR,OAAO,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;YACnB;gBACE,OAAO,KAAK,CAAC;QACjB,CAAC;IACH,CAAC,EACD;QACE,OAAO,EAAE,kEAAkE;KAC5E,CACF;CACJ,CAAC,CAAC;AAIH;;GAEG;AACH,SAAS,cAAc,CAAC,GAAW;IACjC,MAAM,MAAM,GAAG,GAAG,+BAA+B,GAAG,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;IACxE,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;AAC7B,CAAC;AAED;;GAEG;AACH,SAAS,aAAa,CAAC,KAAa;IAClC,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,mBAAmB;IACjC,MAAM,MAAM,GAAwB;QAClC,cAAc,EAAE,cAAc,CAAC,iBAAiB,CAAC,IAAI,aAAa;QAClE,SAAS,EAAE,cAAc,CAAC,YAAY,CAAC;QAEvC,yBAAyB;QACzB,QAAQ,EAAE;YACR,IAAI,EAAE,cAAc,CAAC,eAAe,CAAC;YACrC,IAAI,EAAE,cAAc,CAAC,eAAe,CAAC,IAAI,QAAQ,CAAC,cAAc,CAAC,eAAe,CAAE,EAAE,EAAE,CAAC;YACvF,QAAQ,EAAE,cAAc,CAAC,eAAe,CAAC;YACzC,OAAO,EAAE,cAAc,CAAC,kBAAkB,CAAC;YAC3C,QAAQ,EAAE,cAAc,CAAC,mBAAmB,CAAC;YAC7C,QAAQ,EAAE,cAAc,CAAC,mBAAmB,CAAC;YAC7C,IAAI,EAAE,cAAc,CAAC,eAAe,CAAC,IAAI,aAAa,CAAC,cAAc,CAAC,eAAe,CAAE,CAAC;YACxF,KAAK,EAAE,cAAc,CAAC,gBAAgB,CAAC,IAAI,aAAa,CAAC,cAAc,CAAC,gBAAgB,CAAE,CAAC;YAC3F,KAAK,EAAE,cAAc,CAAC,gBAAgB,CAAC,IAAI,aAAa,CAAC,cAAc,CAAC,gBAAgB,CAAE,CAAC;YAC3F,UAAU,EACR,cAAc,CAAC,sBAAsB,CAAC;gBACtC,QAAQ,CAAC,cAAc,CAAC,sBAAsB,CAAE,EAAE,EAAE,CAAC;YACvD,UAAU,EACR,cAAc,CAAC,sBAAsB,CAAC;gBACtC,QAAQ,CAAC,cAAc,CAAC,sBAAsB,CAAE,EAAE,EAAE,CAAC;SACxD;QAED,UAAU,EAAE;YACV,IAAI,EAAE,cAAc,CAAC,kBAAkB,CAAC,IAAI,OAAO;SACpD;KACF,CAAC;IACF,MAAM,IAAI,GAAG;QACX,GAAG,EAAE,cAAc,CAAC,mBAAmB,CAAC,IAAI,QAAQ,CAAC,cAAc,CAAC,mBAAmB,CAAE,EAAE,EAAE,CAAC;QAC9F,GAAG,EAAE,cAAc,CAAC,mBAAmB,CAAC,IAAI,QAAQ,CAAC,cAAc,CAAC,mBAAmB,CAAE,EAAE,EAAE,CAAC;KAC/F,CAAC;IACF,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACjC,MAAM,CAAC,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC;IAC9B,CAAC;IAED,4BAA4B;IAC5B,QAAQ,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;QAC/B,KAAK,OAAO;YACV,MAAM,CAAC,UAAU,CAAC,KAAK,GAAG;gBACxB,eAAe,EAAE,cAAc,CAAC,qCAAqC,CAAC;aACvE,CAAC;YACF,MAAM;QACR,KAAK,IAAI;YACP,MAAM,CAAC,UAAU,CAAC,EAAE,GAAG;gBACrB,MAAM,EAAE,cAAc,CAAC,uBAAuB,CAAC;gBAC/C,QAAQ,EAAE,cAAc,CAAC,yBAAyB,CAAC;gBACnD,iBAAiB,EAAE,cAAc,CAAC,oCAAoC,CAAC;gBACvE,gBAAgB,EACd,cAAc,CAAC,iCAAiC,CAAC;oBACjD,aAAa,CAAC,cAAc,CAAC,iCAAiC,CAAE,CAAC;gBACnE,WAAW,EAAE,cAAc,CAAC,8BAA8B,CAAC;gBAC3D,eAAe,EAAE,cAAc,CAAC,kCAAkC,CAAC;aACpE,CAAC;YACF,MAAM;QACR,KAAK,KAAK;YACR,MAAM,CAAC,UAAU,CAAC,GAAG,GAAG;gBACtB,SAAS,EAAE,cAAc,CAAC,4BAA4B,CAAC;gBACvD,WAAW,EAAE,cAAc,CAAC,6BAA6B,CAAC;aAC3D,CAAC;YACF,MAAM;IACV,CAAC;IAED,IAAI,CAAC;QACH,OAAO,qBAAqB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC7C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,4CAA4C,EAAE,KAAK,CAAC,CAAC;QACnE,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC"}

package/dist/config/defineConfig.d.ts

@@ -0,0 +1,12 @@
+import type { SystemConfig, SystemConfigInput } from './types.js';
+export declare const CITRINE_ENV_VAR_PREFIX: string;
+export declare const BOOTSTRAP_CONFIG_ENV_VAR_PREFIX: string;
+/**
+ * Defines the application configuration by merging input configuration which is defined in a file with environment variables.
+ * Takes environment variables over predefined
+ * @param inputConfig The file defined input configuration.
+ * @returns The final system configuration.
+ * @throws Error if required environment variables are not set or if there are parsing errors.
+ */
+export declare function defineConfig(inputConfig: SystemConfigInput): SystemConfig;
+export declare const DEFAULT_TENANT_ID = 1;

package/dist/config/defineConfig.js

@@ -0,0 +1,126 @@
+// SPDX-FileCopyrightText: 2025 Contributors to the CitrineOS Project
+//
+// SPDX-License-Identifier: Apache-2.0
+import { z } from 'zod';
+import { systemConfigSchema } from './types.js';
+const args = typeof process !== 'undefined' && process.argv ? process.argv.slice(2) : [];
+let dynamicPrefix = 'citrineos_';
+for (const arg of args) {
+    if (arg.startsWith('--env-prefix=')) {
+        dynamicPrefix = arg.split('=')[1].toLowerCase();
+        break;
+    }
+}
+export const CITRINE_ENV_VAR_PREFIX = dynamicPrefix;
+export const BOOTSTRAP_CONFIG_ENV_VAR_PREFIX = `bootstrap_${CITRINE_ENV_VAR_PREFIX}`;
+/**
+ * Finds a case-insensitive match for a key in an object.
+ * @param obj The object to search.
+ * @param targetKey The target key.
+ * @returns The matching key or undefined.
+ */
+function findCaseInsensitiveMatch(obj, targetKey) {
+    const lowerTargetKey = targetKey.toLowerCase();
+    return Object.keys(obj).find((key) => key.toLowerCase() === lowerTargetKey);
+}
+const getZodSchemaKeyMap = (schema) => {
+    if (schema instanceof z.ZodNullable || schema instanceof z.ZodOptional) {
+        return getZodSchemaKeyMap(schema.unwrap());
+    }
+    if (schema instanceof z.ZodArray) {
+        return getZodSchemaKeyMap(schema.element);
+    }
+    if (schema instanceof z.ZodObject) {
+        const entries = Object.entries(schema.shape);
+        return entries.reduce((acc, [key, value]) => {
+            const nested = getZodSchemaKeyMap(value);
+            if (Object.keys(nested).length > 0) {
+                acc[key] = nested;
+            }
+            else {
+                acc[key.toLowerCase()] = key;
+            }
+            return acc;
+        }, {});
+    }
+    return {};
+};
+/**
+ * Merges configuration from environment variables into the default configuration. Allows any to keep it as generic as possible.
+ * @param defaultConfig The default configuration.
+ * @param envVars The environment variables.
+ * @returns The merged configuration.
+ */
+function mergeConfigFromEnvVars(defaultConfig, envVars, configKeyMap) {
+    const config = { ...defaultConfig };
+    const errors = [];
+    for (const [fullEnvKey, value] of Object.entries(envVars)) {
+        if (!value) {
+            continue;
+        }
+        const lowercaseEnvKey = fullEnvKey.toLowerCase();
+        if (lowercaseEnvKey.startsWith(CITRINE_ENV_VAR_PREFIX)) {
+            const envKeyWithoutPrefix = lowercaseEnvKey.substring(CITRINE_ENV_VAR_PREFIX.length);
+            const path = envKeyWithoutPrefix.split('_');
+            let currentConfigPart = config;
+            let currentConfigKeyMap = configKeyMap;
+            let validMapping = true;
+            for (let i = 0; i < path.length - 1; i++) {
+                const part = path[i];
+                const matchingKey = findCaseInsensitiveMatch(currentConfigKeyMap, part);
+                if (!matchingKey) {
+                    errors.push(`Environment variable '${fullEnvKey}' refers to unknown configuration segment '${part}'.`);
+                    validMapping = false;
+                    break;
+                }
+                if (currentConfigPart[matchingKey] === undefined) {
+                    currentConfigPart[matchingKey] = {};
+                }
+                else if (typeof currentConfigPart[matchingKey] !== 'object' ||
+                    currentConfigPart[matchingKey] === null) {
+                    errors.push(`Environment variable '${fullEnvKey}' refers to configuration segment '${part}', but its current value is not an object.`);
+                    validMapping = false;
+                    break;
+                }
+                currentConfigPart = currentConfigPart[matchingKey];
+                currentConfigKeyMap = currentConfigKeyMap[matchingKey];
+            }
+            if (!validMapping) {
+                continue;
+            }
+            const finalPart = path[path.length - 1];
+            const keyToUse = currentConfigKeyMap[finalPart.toLowerCase()] || finalPart;
+            try {
+                currentConfigPart[keyToUse] = JSON.parse(value);
+            }
+            catch {
+                console.debug(`Mapping '${value}' as string for environment variable '${fullEnvKey}'.`);
+                currentConfigPart[keyToUse] = value;
+            }
+        }
+    }
+    errors.forEach((err) => console.error(err));
+    return config;
+}
+/**
+ * Validates the  system configuration to ensure required properties are set.
+ * @param finalConfig The final system configuration.
+ * @throws Error if required properties are not set.
+ */
+function validateFinalConfig(finalConfig) {
+    return systemConfigSchema.parse(finalConfig);
+}
+/**
+ * Defines the application configuration by merging input configuration which is defined in a file with environment variables.
+ * Takes environment variables over predefined
+ * @param inputConfig The file defined input configuration.
+ * @returns The final system configuration.
+ * @throws Error if required environment variables are not set or if there are parsing errors.
+ */
+export function defineConfig(inputConfig) {
+    const configKeyMap = getZodSchemaKeyMap(systemConfigSchema);
+    const appConfig = mergeConfigFromEnvVars(inputConfig, process.env, configKeyMap);
+    return validateFinalConfig(appConfig);
+}
+export const DEFAULT_TENANT_ID = 1;
+//# sourceMappingURL=defineConfig.js.map

package/dist/config/defineConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defineConfig.js","sourceRoot":"","sources":["../../src/config/defineConfig.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,EAAE;AACF,sCAAsC;AAEtC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAEhD,MAAM,IAAI,GAAG,OAAO,OAAO,KAAK,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAEzF,IAAI,aAAa,GAAG,YAAY,CAAC;AACjC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;IACvB,IAAI,GAAG,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,CAAC;QACpC,aAAa,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;QAChD,MAAM;IACR,CAAC;AACH,CAAC;AAED,MAAM,CAAC,MAAM,sBAAsB,GAAG,aAAa,CAAC;AACpD,MAAM,CAAC,MAAM,+BAA+B,GAAG,aAAa,sBAAsB,EAAE,CAAC;AAErF;;;;;GAKG;AACH,SAAS,wBAAwB,CAC/B,GAAsB,EACtB,SAAiB;IAEjB,MAAM,cAAc,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;IAC/C,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,WAAW,EAAE,KAAK,cAAc,CAAC,CAAC;AAC9E,CAAC;AAED,MAAM,kBAAkB,GAAG,CAAC,MAAoB,EAAuB,EAAE;IACvE,IAAI,MAAM,YAAY,CAAC,CAAC,WAAW,IAAI,MAAM,YAAY,CAAC,CAAC,WAAW,EAAE,CAAC;QACvE,OAAO,kBAAkB,CAAE,MAAkD,CAAC,MAAM,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED,IAAI,MAAM,YAAY,CAAC,CAAC,QAAQ,EAAE,CAAC;QACjC,OAAO,kBAAkB,CAAC,MAAM,CAAC,OAAuB,CAAC,CAAC;IAC5D,CAAC;IAED,IAAI,MAAM,YAAY,CAAC,CAAC,SAAS,EAAE,CAAC;QAClC,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAY,MAAM,CAAC,KAAK,CAAC,CAAC;QAExD,OAAO,OAAO,CAAC,MAAM,CACnB,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YACpB,MAAM,MAAM,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAEzC,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACnC,GAAG,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC;YACpB,CAAC;iBAAM,CAAC;gBACN,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,GAAG,GAAG,CAAC;YAC/B,CAAC;YAED,OAAO,GAAG,CAAC;QACb,CAAC,EACD,EAAyB,CAC1B,CAAC;IACJ,CAAC;IAED,OAAO,EAAE,CAAC;AACZ,CAAC,CAAC;AAEF;;;;;GAKG;AACH,SAAS,sBAAsB,CAC7B,aAAgB,EAChB,OAA0B,EAC1B,YAAiC;IAEjC,MAAM,MAAM,GAAM,EAAE,GAAG,aAAa,EAAE,CAAC;IACvC,MAAM,MAAM,GAAa,EAAE,CAAC;IAE5B,KAAK,MAAM,CAAC,UAAU,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QAC1D,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,SAAS;QACX,CAAC;QACD,MAAM,eAAe,GAAG,UAAU,CAAC,WAAW,EAAE,CAAC;QACjD,IAAI,eAAe,CAAC,UAAU,CAAC,sBAAsB,CAAC,EAAE,CAAC;YACvD,MAAM,mBAAmB,GAAG,eAAe,CAAC,SAAS,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC;YACrF,MAAM,IAAI,GAAG,mBAAmB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAE5C,IAAI,iBAAiB,GAAwB,MAAM,CAAC;YACpD,IAAI,mBAAmB,GAAwB,YAAY,CAAC;YAC5D,IAAI,YAAY,GAAG,IAAI,CAAC;YAExB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;gBACzC,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;gBACrB,MAAM,WAAW,GAAG,wBAAwB,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC;gBACxE,IAAI,CAAC,WAAW,EAAE,CAAC;oBACjB,MAAM,CAAC,IAAI,CACT,yBAAyB,UAAU,8CAA8C,IAAI,IAAI,CAC1F,CAAC;oBACF,YAAY,GAAG,KAAK,CAAC;oBACrB,MAAM;gBACR,CAAC;gBAED,IAAI,iBAAiB,CAAC,WAAW,CAAC,KAAK,SAAS,EAAE,CAAC;oBACjD,iBAAiB,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC;gBACtC,CAAC;qBAAM,IACL,OAAO,iBAAiB,CAAC,WAAW,CAAC,KAAK,QAAQ;oBAClD,iBAAiB,CAAC,WAAW,CAAC,KAAK,IAAI,EACvC,CAAC;oBACD,MAAM,CAAC,IAAI,CACT,yBAAyB,UAAU,sCAAsC,IAAI,4CAA4C,CAC1H,CAAC;oBACF,YAAY,GAAG,KAAK,CAAC;oBACrB,MAAM;gBACR,CAAC;gBAED,iBAAiB,GAAG,iBAAiB,CAAC,WAAW,CAAC,CAAC;gBACnD,mBAAmB,GAAG,mBAAmB,CAAC,WAAW,CAAC,CAAC;YACzD,CAAC;YAED,IAAI,CAAC,YAAY,EAAE,CAAC;gBAClB,SAAS;YACX,CAAC;YAED,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACxC,MAAM,QAAQ,GAAG,mBAAmB,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC,IAAI,SAAS,CAAC;YAE3E,IAAI,CAAC;gBACH,iBAAiB,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,KAAe,CAAC,CAAC;YAC5D,CAAC;YAAC,MAAM,CAAC;gBACP,OAAO,CAAC,KAAK,CAAC,YAAY,KAAK,yCAAyC,UAAU,IAAI,CAAC,CAAC;gBACxF,iBAAiB,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC;YACtC,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IAE5C,OAAO,MAAW,CAAC;AACrB,CAAC;AAED;;;;GAIG;AACH,SAAS,mBAAmB,CAAC,WAA8B;IACzD,OAAO,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;AAC/C,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAAC,WAA8B;IACzD,MAAM,YAAY,GAAwB,kBAAkB,CAAC,kBAAkB,CAAC,CAAC;IACjF,MAAM,SAAS,GAAG,sBAAsB,CACtC,WAAW,EACX,OAAO,CAAC,GAAG,EACX,YAAY,CACb,CAAC;IAEF,OAAO,mBAAmB,CAAC,SAAS,CAAC,CAAC;AACxC,CAAC;AAED,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC"}

package/dist/config/signedMeterValuesConfig.d.ts

@@ -0,0 +1,4 @@
+export declare class SignedMeterValuesConfig {
+    publicKeyFileId: string;
+    signingMethod: string;
+}

package/dist/config/signedMeterValuesConfig.js

@@ -0,0 +1,8 @@
+// SPDX-FileCopyrightText: 2025 Contributors to the CitrineOS Project
+//
+// SPDX-License-Identifier: Apache-2.0
+export class SignedMeterValuesConfig {
+    publicKeyFileId;
+    signingMethod;
+}
+//# sourceMappingURL=signedMeterValuesConfig.js.map

package/dist/config/signedMeterValuesConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"signedMeterValuesConfig.js","sourceRoot":"","sources":["../../src/config/signedMeterValuesConfig.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,EAAE;AACF,sCAAsC;AACtC,MAAM,OAAO,uBAAuB;IAClC,eAAe,CAAU;IACzB,aAAa,CAAU;CACxB"}