@nubisco/openbridge-config 0.29.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Nubisco Lda
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,21 @@
+# @nubisco/openbridge-config
+
+Zod-validated JSON configuration loader for OpenBridge.
+
+Part of [OpenBridge](https://github.com/nubisco/openbridge), a local-first home automation bridge for developers.
+
+## Install
+
+```sh
+npm install @nubisco/openbridge-config
+```
+
+Requires Node.js >= 20.
+
+## Documentation
+
+See the [OpenBridge documentation](https://github.com/nubisco/openbridge#readme). This package is published from the OpenBridge monorepo and versioned in lockstep with the `openbridge` daemon.
+
+## License
+
+MIT (c) Jose Silva

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export type { OpenBridgeConfig, BridgeConfig, PluginEntry, PlatformConfig } from './schema.js';
+export { OpenBridgeConfigSchema, BridgeConfigSchema } from './schema.js';
+export { loadConfig, saveConfig, defaultConfigPath } from './loader.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,gBAAgB,EAAE,YAAY,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAC9F,OAAO,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AACxE,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA"}

package/dist/index.js

@@ -0,0 +1,3 @@
+export { OpenBridgeConfigSchema, BridgeConfigSchema } from './schema.js';
+export { loadConfig, saveConfig, defaultConfigPath } from './loader.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AACxE,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA"}

package/dist/loader.d.ts

@@ -0,0 +1,5 @@
+import { type OpenBridgeConfig } from './schema.js';
+export declare function loadConfig(configPath: string): Promise<OpenBridgeConfig>;
+export declare function saveConfig(configPath: string, config: OpenBridgeConfig): Promise<void>;
+export declare function defaultConfigPath(): string;
+//# sourceMappingURL=loader.d.ts.map

package/dist/loader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loader.d.ts","sourceRoot":"","sources":["../src/loader.ts"],"names":[],"mappings":"AAGA,OAAO,EAA0B,KAAK,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAE3E,wBAAsB,UAAU,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAmB9E;AAED,wBAAsB,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAM5F;AAED,wBAAgB,iBAAiB,IAAI,MAAM,CAG1C"}

package/dist/loader.js

@@ -0,0 +1,34 @@
+import { readFile, writeFile, mkdir } from 'fs/promises';
+import { existsSync } from 'fs';
+import { dirname } from 'path';
+import { OpenBridgeConfigSchema } from './schema.js';
+export async function loadConfig(configPath) {
+    if (!existsSync(configPath)) {
+        return OpenBridgeConfigSchema.parse({});
+    }
+    const raw = await readFile(configPath, 'utf-8');
+    let parsed;
+    try {
+        parsed = JSON.parse(raw);
+    }
+    catch {
+        throw new Error(`Invalid JSON in config file: ${configPath}`);
+    }
+    const result = OpenBridgeConfigSchema.safeParse(parsed);
+    if (!result.success) {
+        throw new Error(`Config validation failed: ${result.error.message}`);
+    }
+    return result.data;
+}
+export async function saveConfig(configPath, config) {
+    const dir = dirname(configPath);
+    if (!existsSync(dir)) {
+        await mkdir(dir, { recursive: true });
+    }
+    await writeFile(configPath, JSON.stringify(config, null, 2), 'utf-8');
+}
+export function defaultConfigPath() {
+    const home = process.env.HOME ?? process.env.USERPROFILE ?? '.';
+    return `${home}/.openbridge/config.json`;
+}
+//# sourceMappingURL=loader.js.map

package/dist/loader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loader.js","sourceRoot":"","sources":["../src/loader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,IAAI,CAAA;AAC/B,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAC9B,OAAO,EAAE,sBAAsB,EAAyB,MAAM,aAAa,CAAA;AAE3E,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,UAAkB;IACjD,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;QAC5B,OAAO,sBAAsB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;IACzC,CAAC;IAED,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC,CAAA;IAC/C,IAAI,MAAe,CAAA;IACnB,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAC1B,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,KAAK,CAAC,gCAAgC,UAAU,EAAE,CAAC,CAAA;IAC/D,CAAC;IAED,MAAM,MAAM,GAAG,sBAAsB,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;IACvD,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CAAC,6BAA6B,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAA;IACtE,CAAC;IAED,OAAO,MAAM,CAAC,IAAI,CAAA;AACpB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,UAAkB,EAAE,MAAwB;IAC3E,MAAM,GAAG,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAC/B,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACrB,MAAM,KAAK,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;IACvC,CAAC;IACD,MAAM,SAAS,CAAC,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,CAAA;AACvE,CAAC;AAED,MAAM,UAAU,iBAAiB;IAC/B,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC,WAAW,IAAI,GAAG,CAAA;IAC/D,OAAO,GAAG,IAAI,0BAA0B,CAAA;AAC1C,CAAC"}

package/dist/schema.d.ts

@@ -0,0 +1,138 @@
+import { z } from 'zod';
+export declare const PluginConfigSchema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+export declare const PlatformConfigSchema: z.ZodIntersection<z.ZodObject<{
+    platform: z.ZodString;
+    plugin: z.ZodOptional<z.ZodString>;
+    enabled: z.ZodDefault<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    platform: string;
+    enabled: boolean;
+    plugin?: string | undefined;
+}, {
+    platform: string;
+    plugin?: string | undefined;
+    enabled?: boolean | undefined;
+}>, z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+export declare const BridgeConfigSchema: z.ZodObject<{
+    name: z.ZodDefault<z.ZodString>;
+    port: z.ZodDefault<z.ZodNumber>;
+    hapPort: z.ZodDefault<z.ZodNumber>;
+    pincode: z.ZodDefault<z.ZodString>;
+    username: z.ZodOptional<z.ZodString>;
+    logLevel: z.ZodDefault<z.ZodEnum<["debug", "info", "warn", "error"]>>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    port: number;
+    hapPort: number;
+    pincode: string;
+    logLevel: "debug" | "info" | "warn" | "error";
+    username?: string | undefined;
+}, {
+    name?: string | undefined;
+    port?: number | undefined;
+    hapPort?: number | undefined;
+    pincode?: string | undefined;
+    username?: string | undefined;
+    logLevel?: "debug" | "info" | "warn" | "error" | undefined;
+}>;
+export declare const OpenBridgeConfigSchema: z.ZodObject<{
+    bridge: z.ZodDefault<z.ZodObject<{
+        name: z.ZodDefault<z.ZodString>;
+        port: z.ZodDefault<z.ZodNumber>;
+        hapPort: z.ZodDefault<z.ZodNumber>;
+        pincode: z.ZodDefault<z.ZodString>;
+        username: z.ZodOptional<z.ZodString>;
+        logLevel: z.ZodDefault<z.ZodEnum<["debug", "info", "warn", "error"]>>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        port: number;
+        hapPort: number;
+        pincode: string;
+        logLevel: "debug" | "info" | "warn" | "error";
+        username?: string | undefined;
+    }, {
+        name?: string | undefined;
+        port?: number | undefined;
+        hapPort?: number | undefined;
+        pincode?: string | undefined;
+        username?: string | undefined;
+        logLevel?: "debug" | "info" | "warn" | "error" | undefined;
+    }>>;
+    plugins: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        path: z.ZodOptional<z.ZodString>;
+        enabled: z.ZodDefault<z.ZodBoolean>;
+        config: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+    }, "strip", z.ZodTypeAny, {
+        enabled: boolean;
+        name: string;
+        config: Record<string, unknown>;
+        path?: string | undefined;
+    }, {
+        name: string;
+        path?: string | undefined;
+        enabled?: boolean | undefined;
+        config?: Record<string, unknown> | undefined;
+    }>, "many">>;
+    platforms: z.ZodDefault<z.ZodArray<z.ZodIntersection<z.ZodObject<{
+        platform: z.ZodString;
+        plugin: z.ZodOptional<z.ZodString>;
+        enabled: z.ZodDefault<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        platform: string;
+        enabled: boolean;
+        plugin?: string | undefined;
+    }, {
+        platform: string;
+        plugin?: string | undefined;
+        enabled?: boolean | undefined;
+    }>, z.ZodRecord<z.ZodString, z.ZodUnknown>>, "many">>;
+    localPluginSources: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+}, "strip", z.ZodTypeAny, {
+    bridge: {
+        name: string;
+        port: number;
+        hapPort: number;
+        pincode: string;
+        logLevel: "debug" | "info" | "warn" | "error";
+        username?: string | undefined;
+    };
+    plugins: {
+        enabled: boolean;
+        name: string;
+        config: Record<string, unknown>;
+        path?: string | undefined;
+    }[];
+    platforms: ({
+        platform: string;
+        enabled: boolean;
+        plugin?: string | undefined;
+    } & Record<string, unknown>)[];
+    localPluginSources: string[];
+}, {
+    bridge?: {
+        name?: string | undefined;
+        port?: number | undefined;
+        hapPort?: number | undefined;
+        pincode?: string | undefined;
+        username?: string | undefined;
+        logLevel?: "debug" | "info" | "warn" | "error" | undefined;
+    } | undefined;
+    plugins?: {
+        name: string;
+        path?: string | undefined;
+        enabled?: boolean | undefined;
+        config?: Record<string, unknown> | undefined;
+    }[] | undefined;
+    platforms?: ({
+        platform: string;
+        plugin?: string | undefined;
+        enabled?: boolean | undefined;
+    } & Record<string, unknown>)[] | undefined;
+    localPluginSources?: string[] | undefined;
+}>;
+export type OpenBridgeConfig = z.infer<typeof OpenBridgeConfigSchema>;
+export type BridgeConfig = z.infer<typeof BridgeConfigSchema>;
+export type PluginEntry = OpenBridgeConfig['plugins'][number];
+export type PlatformConfig = z.infer<typeof PlatformConfigSchema>;
+//# sourceMappingURL=schema.d.ts.map

package/dist/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,eAAO,MAAM,kBAAkB,wCAAwB,CAAA;AAEvD,eAAO,MAAM,oBAAoB;;;;;;;;;;;;2CAMJ,CAAA;AAE7B,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;EAO7B,CAAA;AAEF,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAcjC,CAAA;AAEF,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AACrE,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAC7D,MAAM,MAAM,WAAW,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAA;AAC7D,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA"}

package/dist/schema.js

@@ -0,0 +1,31 @@
+import { z } from 'zod';
+export const PluginConfigSchema = z.record(z.unknown());
+export const PlatformConfigSchema = z
+    .object({
+    platform: z.string(),
+    plugin: z.string().optional(), // path to the plugin's main JS file
+    enabled: z.boolean().default(true),
+})
+    .and(z.record(z.unknown()));
+export const BridgeConfigSchema = z.object({
+    name: z.string().default('OpenBridge'),
+    port: z.number().int().min(1024).max(65535).default(8582),
+    hapPort: z.number().int().min(1024).max(65535).default(51829),
+    pincode: z.string().default('031-45-154'),
+    username: z.string().optional(),
+    logLevel: z.enum(['debug', 'info', 'warn', 'error']).default('info'),
+});
+export const OpenBridgeConfigSchema = z.object({
+    bridge: BridgeConfigSchema.default({}),
+    plugins: z
+        .array(z.object({
+        name: z.string(),
+        path: z.string().optional(),
+        enabled: z.boolean().default(true),
+        config: PluginConfigSchema.optional().default({}),
+    }))
+        .default([]),
+    platforms: z.array(PlatformConfigSchema).default([]),
+    localPluginSources: z.array(z.string()).default([]),
+});
+//# sourceMappingURL=schema.js.map

package/dist/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAA;AAEvD,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC;KAClC,MAAM,CAAC;IACN,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,oCAAoC;IACnE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;CACnC,CAAC;KACD,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAA;AAE7B,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC;IACtC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;IACzD,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;IAC7D,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC;IACzC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;CACrE,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7C,MAAM,EAAE,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAAC;IACtC,OAAO,EAAE,CAAC;SACP,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;QAChB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC3B,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;QAClC,MAAM,EAAE,kBAAkB,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;KAClD,CAAC,CACH;SACA,OAAO,CAAC,EAAE,CAAC;IACd,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;IACpD,kBAAkB,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;CACpD,CAAC,CAAA"}

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@nubisco/openbridge-config",
+  "version": "0.29.0",
+  "description": "Zod-validated JSON configuration loader for OpenBridge",
+  "author": "José Silva <jose@nubisco.io>",
+  "license": "MIT",
+  "homepage": "https://github.com/nubisco/openbridge#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nubisco/openbridge.git",
+    "directory": "packages/config"
+  },
+  "bugs": {
+    "url": "https://github.com/nubisco/openbridge/issues"
+  },
+  "keywords": [
+    "config",
+    "configuration",
+    "zod",
+    "validation",
+    "typescript",
+    "openbridge"
+  ],
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist/",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "zod": "^3.22.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.4.0",
+    "@types/node": "^20.0.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "typecheck": "tsc --noEmit"
+  }
+}