@grest-ts/config 0.0.6 → 0.0.8

package/src/GGConfigStore.ts

@@ -1,100 +1,100 @@
-import {GGConfigKey} from "./GGConfigKey";
-import {GG_CONFIG} from "./GG_CONFIG";
-
-export type ConfigUpdateCallback = (value: any) => void | Promise<void>;
-
-/**
- * Important when extending: Use resolveValue() to resolve and validate config values.
- */
-export abstract class GGConfigStore<Key extends GGConfigKey> {
-
-    #keys: Key[] = []
-    public get keys(): readonly Key[] { return this.#keys }
-    readonly #watchers: Map<GGConfigKey, ConfigUpdateCallback[]> = new Map()
-
-    protected isStarted = false;
-
-    public get started(): boolean {
-        return this.isStarted;
-    }
-
-    public setKeys(keys: readonly Key[]): void {
-        if (this.isStarted) {
-            throw new Error(`Cannot set keys after store is started: ${this.constructor.name}`);
-        }
-        this.#keys.push(...keys);
-    }
-
-    public abstract getValue<T>(key: GGConfigKey<T>): T
-
-    /**
-     * Resolves the final value for a config key: uses storeValue if present, falls back to key.getDefault(),
-     * then validates against schema. If the resolved value is undefined and the schema doesn't allow it,
-     * validation will fail — this is how missing required keys are caught.
-     */
-    protected resolveValue<T>(key: GGConfigKey<T>, storeValue: unknown, isInitialLoad: boolean = false): T {
-        const val = storeValue !== undefined ? storeValue : key.getDefault();
-        const check = key.schema.safeParse(val);
-        if (check.success === false) {
-            const errors = JSON.stringify(check.issues.toJSON(), null, 2).replaceAll("\n", "\n\t\t")
-            throw new Error(`Config validation failed for "${key.name}" during ${isInitialLoad ? "initial-load" : "reload"}.\n\tDefined at:\n\t\t${key.definedAt}\n\tIssues:\n\t\t${errors}`);
-        } else {
-            return check.value as T;
-        }
-    }
-
-    public async start(): Promise<void> {
-        if (this.isStarted === true) {
-            throw new Error(`Config store already started: ${this.constructor.name}`);
-        }
-        this.isStarted = true;
-        Object.freeze(this.#keys);
-
-        this.keys.forEach(key => {
-            this.getValue(key); // Get every value so that config values are definitely initialized (or they would throw)
-        });
-    }
-
-    public async teardown(): Promise<void> {
-        this.#watchers.clear();
-        this.isStarted = false;
-    }
-
-    public watch(key: GGConfigKey, callback: ConfigUpdateCallback): () => void {
-        if (!this.#watchers.has(key)) {
-            this.#watchers.set(key, []);
-        }
-        this.#watchers.get(key)!.push(callback);
-        return () => {
-            const list = this.#watchers.get(key);
-            if (!list) return;
-            const index = list.indexOf(callback);
-            if (index >= 0) list.splice(index, 1);
-        };
-    }
-
-    public async notify(key: GGConfigKey) {
-        if (this.#watchers.has(key)) {
-            const promises: Promise<void>[] = [];
-            const newValue = this.getValue(key);
-            this.#watchers.get(key).forEach(callback => {
-                try {
-                    const result = callback(newValue);
-                    if (result instanceof Promise) {
-                        promises.push(result);
-                    }
-                } catch (err) {
-                    GG_CONFIG.get().onNotifyError(err);
-                }
-            })
-            if (promises.length > 0) {
-                const results = await Promise.allSettled(promises);
-                for (const result of results) {
-                    if (result.status === 'rejected') {
-                        GG_CONFIG.get().onNotifyError(result.reason);
-                    }
-                }
-            }
-        }
-    }
-}
+import {GGConfigKey} from "./GGConfigKey";
+import {GG_CONFIG} from "./GG_CONFIG";
+
+export type ConfigUpdateCallback = (value: any) => void | Promise<void>;
+
+/**
+ * Important when extending: Use resolveValue() to resolve and validate config values.
+ */
+export abstract class GGConfigStore<Key extends GGConfigKey> {
+
+    #keys: Key[] = []
+    public get keys(): readonly Key[] { return this.#keys }
+    readonly #watchers: Map<GGConfigKey, ConfigUpdateCallback[]> = new Map()
+
+    protected isStarted = false;
+
+    public get started(): boolean {
+        return this.isStarted;
+    }
+
+    public setKeys(keys: readonly Key[]): void {
+        if (this.isStarted) {
+            throw new Error(`Cannot set keys after store is started: ${this.constructor.name}`);
+        }
+        this.#keys.push(...keys);
+    }
+
+    public abstract getValue<T>(key: GGConfigKey<T>): T
+
+    /**
+     * Resolves the final value for a config key: uses storeValue if present, falls back to key.getDefault(),
+     * then validates against schema. If the resolved value is undefined and the schema doesn't allow it,
+     * validation will fail — this is how missing required keys are caught.
+     */
+    protected resolveValue<T>(key: GGConfigKey<T>, storeValue: unknown, isInitialLoad: boolean = false): T {
+        const val = storeValue !== undefined ? storeValue : key.getDefault();
+        const check = key.schema.safeParse(val);
+        if (check.success === false) {
+            const errors = JSON.stringify(check.issues.toJSON(), null, 2).replaceAll("\n", "\n\t\t")
+            throw new Error(`Config validation failed for "${key.name}" during ${isInitialLoad ? "initial-load" : "reload"}.\n\tDefined at:\n\t\t${key.definedAt}\n\tIssues:\n\t\t${errors}`);
+        } else {
+            return check.value as T;
+        }
+    }
+
+    public async start(): Promise<void> {
+        if (this.isStarted === true) {
+            throw new Error(`Config store already started: ${this.constructor.name}`);
+        }
+        this.isStarted = true;
+        Object.freeze(this.#keys);
+
+        this.keys.forEach(key => {
+            this.getValue(key); // Get every value so that config values are definitely initialized (or they would throw)
+        });
+    }
+
+    public async teardown(): Promise<void> {
+        this.#watchers.clear();
+        this.isStarted = false;
+    }
+
+    public watch(key: GGConfigKey, callback: ConfigUpdateCallback): () => void {
+        if (!this.#watchers.has(key)) {
+            this.#watchers.set(key, []);
+        }
+        this.#watchers.get(key)!.push(callback);
+        return () => {
+            const list = this.#watchers.get(key);
+            if (!list) return;
+            const index = list.indexOf(callback);
+            if (index >= 0) list.splice(index, 1);
+        };
+    }
+
+    public async notify(key: GGConfigKey) {
+        if (this.#watchers.has(key)) {
+            const promises: Promise<void>[] = [];
+            const newValue = this.getValue(key);
+            this.#watchers.get(key).forEach(callback => {
+                try {
+                    const result = callback(newValue);
+                    if (result instanceof Promise) {
+                        promises.push(result);
+                    }
+                } catch (err) {
+                    GG_CONFIG.get().onNotifyError(err);
+                }
+            })
+            if (promises.length > 0) {
+                const results = await Promise.allSettled(promises);
+                for (const result of results) {
+                    if (result.status === 'rejected') {
+                        GG_CONFIG.get().onNotifyError(result.reason);
+                    }
+                }
+            }
+        }
+    }
+}

package/src/GG_CONFIG.ts

@@ -1,4 +1,4 @@
-import {GGLocatorKey} from "@grest-ts/locator";
-import type {GGConfigLocator} from "./GGConfigLocator";
-
-export const GG_CONFIG = new GGLocatorKey<GGConfigLocator<any>>("GGConfig");
+import {GGLocatorKey} from "@grest-ts/locator";
+import type {GGConfigLocator} from "./GGConfigLocator";
+
+export const GG_CONFIG = new GGLocatorKey<GGConfigLocator<any>>("GGConfig");

package/src/assureValidConfigPath.spec.ts

@@ -1,140 +1,140 @@
-import {describe, it, expect} from 'vitest';
-import {assureValidConfigPath} from './assureValidConfigPath';
-
-describe('assureValidConfigPath', () => {
-
-    describe('valid paths', () => {
-        it('accepts simple path', () => {
-            expect(() => assureValidConfigPath('/app/setting')).not.toThrow();
-        });
-
-        it('accepts path with multiple segments', () => {
-            expect(() => assureValidConfigPath('/app/db/host')).not.toThrow();
-        });
-
-        it('accepts path with underscores', () => {
-            expect(() => assureValidConfigPath('/my_app/my_setting')).not.toThrow();
-        });
-
-        it('accepts path with numbers after letter', () => {
-            expect(() => assureValidConfigPath('/app1/setting2')).not.toThrow();
-        });
-
-        it('accepts mixed valid characters', () => {
-            expect(() => assureValidConfigPath('/my_app_v2/db_connection_pool_size')).not.toThrow();
-        });
-
-        it('accepts uppercase letters', () => {
-            expect(() => assureValidConfigPath('/MyApp/DbHost')).not.toThrow();
-        });
-
-        it('accepts single segment', () => {
-            expect(() => assureValidConfigPath('/setting')).not.toThrow();
-        });
-    });
-
-    describe('must start with slash', () => {
-        it('rejects path without leading slash', () => {
-            expect(() => assureValidConfigPath('app/setting')).toThrow("must start with '/'");
-        });
-
-        it('rejects single word without slash', () => {
-            expect(() => assureValidConfigPath('setting')).toThrow("must start with '/'");
-        });
-    });
-
-    describe('cannot end with slash', () => {
-        it('rejects path with trailing slash', () => {
-            expect(() => assureValidConfigPath('/app/setting/')).toThrow("cannot end with '/'");
-        });
-
-        it('rejects root path (just slash)', () => {
-            expect(() => assureValidConfigPath('/')).toThrow("cannot end with '/'");
-        });
-    });
-
-    describe('no double slashes', () => {
-        it('rejects double slash in middle', () => {
-            expect(() => assureValidConfigPath('/app//setting')).toThrow("cannot contain '//'");
-        });
-
-        it('rejects double slash at start', () => {
-            expect(() => assureValidConfigPath('//app/setting')).toThrow("cannot contain '//'");
-        });
-
-        it('rejects multiple double slashes', () => {
-            expect(() => assureValidConfigPath('/app//db//host')).toThrow("cannot contain '//'");
-        });
-    });
-
-    describe('invalid characters', () => {
-        it('rejects dots', () => {
-            expect(() => assureValidConfigPath('/app/db.host')).toThrow('invalid characters');
-        });
-
-        it('rejects hyphens', () => {
-            expect(() => assureValidConfigPath('/my-app/setting')).toThrow('invalid characters');
-        });
-
-        it('rejects spaces', () => {
-            expect(() => assureValidConfigPath('/app/my setting')).toThrow('invalid characters');
-        });
-
-        it('rejects special characters @', () => {
-            expect(() => assureValidConfigPath('/app@host/setting')).toThrow('invalid characters');
-        });
-
-        it('rejects special characters #', () => {
-            expect(() => assureValidConfigPath('/app#1/setting')).toThrow('invalid characters');
-        });
-
-        it('rejects special characters $', () => {
-            expect(() => assureValidConfigPath('/app/$setting')).toThrow('invalid characters');
-        });
-
-        it('rejects special characters %', () => {
-            expect(() => assureValidConfigPath('/app/100%')).toThrow('invalid characters');
-        });
-
-        it('rejects colon', () => {
-            expect(() => assureValidConfigPath('/app:setting')).toThrow('invalid characters');
-        });
-
-        it('rejects backslash', () => {
-            expect(() => assureValidConfigPath('/app\\setting')).toThrow('invalid characters');
-        });
-    });
-
-    describe('segments must start with letter', () => {
-        it('rejects segment starting with number', () => {
-            expect(() => assureValidConfigPath('/app/1setting')).toThrow('must start with a letter');
-        });
-
-        it('rejects segment starting with underscore', () => {
-            expect(() => assureValidConfigPath('/app/_setting')).toThrow('must start with a letter');
-        });
-
-        it('rejects first segment starting with number', () => {
-            expect(() => assureValidConfigPath('/1app/setting')).toThrow('must start with a letter');
-        });
-
-        it('accepts segment with numbers after first letter', () => {
-            expect(() => assureValidConfigPath('/app/s1e2t3')).not.toThrow();
-        });
-    });
-
-    describe('max length', () => {
-        it('accepts path at exactly 2048 characters', () => {
-            const path = '/' + 'a'.repeat(2047);
-            expect(path.length).toBe(2048);
-            expect(() => assureValidConfigPath(path)).not.toThrow();
-        });
-
-        it('rejects path exceeding 2048 characters', () => {
-            const path = '/' + 'a'.repeat(2048);
-            expect(path.length).toBe(2049);
-            expect(() => assureValidConfigPath(path)).toThrow('exceeds 2048 characters');
-        });
-    });
-
-});
+import {describe, it, expect} from 'vitest';
+import {assureValidConfigPath} from './assureValidConfigPath';
+
+describe('assureValidConfigPath', () => {
+
+    describe('valid paths', () => {
+        it('accepts simple path', () => {
+            expect(() => assureValidConfigPath('/app/setting')).not.toThrow();
+        });
+
+        it('accepts path with multiple segments', () => {
+            expect(() => assureValidConfigPath('/app/db/host')).not.toThrow();
+        });
+
+        it('accepts path with underscores', () => {
+            expect(() => assureValidConfigPath('/my_app/my_setting')).not.toThrow();
+        });
+
+        it('accepts path with numbers after letter', () => {
+            expect(() => assureValidConfigPath('/app1/setting2')).not.toThrow();
+        });
+
+        it('accepts mixed valid characters', () => {
+            expect(() => assureValidConfigPath('/my_app_v2/db_connection_pool_size')).not.toThrow();
+        });
+
+        it('accepts uppercase letters', () => {
+            expect(() => assureValidConfigPath('/MyApp/DbHost')).not.toThrow();
+        });
+
+        it('accepts single segment', () => {
+            expect(() => assureValidConfigPath('/setting')).not.toThrow();
+        });
+    });
+
+    describe('must start with slash', () => {
+        it('rejects path without leading slash', () => {
+            expect(() => assureValidConfigPath('app/setting')).toThrow("must start with '/'");
+        });
+
+        it('rejects single word without slash', () => {
+            expect(() => assureValidConfigPath('setting')).toThrow("must start with '/'");
+        });
+    });
+
+    describe('cannot end with slash', () => {
+        it('rejects path with trailing slash', () => {
+            expect(() => assureValidConfigPath('/app/setting/')).toThrow("cannot end with '/'");
+        });
+
+        it('rejects root path (just slash)', () => {
+            expect(() => assureValidConfigPath('/')).toThrow("cannot end with '/'");
+        });
+    });
+
+    describe('no double slashes', () => {
+        it('rejects double slash in middle', () => {
+            expect(() => assureValidConfigPath('/app//setting')).toThrow("cannot contain '//'");
+        });
+
+        it('rejects double slash at start', () => {
+            expect(() => assureValidConfigPath('//app/setting')).toThrow("cannot contain '//'");
+        });
+
+        it('rejects multiple double slashes', () => {
+            expect(() => assureValidConfigPath('/app//db//host')).toThrow("cannot contain '//'");
+        });
+    });
+
+    describe('invalid characters', () => {
+        it('rejects dots', () => {
+            expect(() => assureValidConfigPath('/app/db.host')).toThrow('invalid characters');
+        });
+
+        it('rejects hyphens', () => {
+            expect(() => assureValidConfigPath('/my-app/setting')).toThrow('invalid characters');
+        });
+
+        it('rejects spaces', () => {
+            expect(() => assureValidConfigPath('/app/my setting')).toThrow('invalid characters');
+        });
+
+        it('rejects special characters @', () => {
+            expect(() => assureValidConfigPath('/app@host/setting')).toThrow('invalid characters');
+        });
+
+        it('rejects special characters #', () => {
+            expect(() => assureValidConfigPath('/app#1/setting')).toThrow('invalid characters');
+        });
+
+        it('rejects special characters $', () => {
+            expect(() => assureValidConfigPath('/app/$setting')).toThrow('invalid characters');
+        });
+
+        it('rejects special characters %', () => {
+            expect(() => assureValidConfigPath('/app/100%')).toThrow('invalid characters');
+        });
+
+        it('rejects colon', () => {
+            expect(() => assureValidConfigPath('/app:setting')).toThrow('invalid characters');
+        });
+
+        it('rejects backslash', () => {
+            expect(() => assureValidConfigPath('/app\\setting')).toThrow('invalid characters');
+        });
+    });
+
+    describe('segments must start with letter', () => {
+        it('rejects segment starting with number', () => {
+            expect(() => assureValidConfigPath('/app/1setting')).toThrow('must start with a letter');
+        });
+
+        it('rejects segment starting with underscore', () => {
+            expect(() => assureValidConfigPath('/app/_setting')).toThrow('must start with a letter');
+        });
+
+        it('rejects first segment starting with number', () => {
+            expect(() => assureValidConfigPath('/1app/setting')).toThrow('must start with a letter');
+        });
+
+        it('accepts segment with numbers after first letter', () => {
+            expect(() => assureValidConfigPath('/app/s1e2t3')).not.toThrow();
+        });
+    });
+
+    describe('max length', () => {
+        it('accepts path at exactly 2048 characters', () => {
+            const path = '/' + 'a'.repeat(2047);
+            expect(path.length).toBe(2048);
+            expect(() => assureValidConfigPath(path)).not.toThrow();
+        });
+
+        it('rejects path exceeding 2048 characters', () => {
+            const path = '/' + 'a'.repeat(2048);
+            expect(path.length).toBe(2049);
+            expect(() => assureValidConfigPath(path)).toThrow('exceeds 2048 characters');
+        });
+    });
+
+});

package/src/assureValidConfigPath.ts

@@ -1,34 +1,34 @@
-/**
- * Validates config key name for compatibility with external providers.
- * Rules:
- * - Must start with forward slash
- * - Only letters, numbers, underscore, forward slash allowed
- * - Each segment (word) must start with a letter
- * - No double slashes
- * - Cannot end with slash
- * - Max 2048 characters (AWS limit)
- */
-export function assureValidConfigPath(path: string) {
-    if (path.length > 2048) {
-        throw new Error(`Config key name exceeds 2048 characters: ${path}`);
-    }
-    if (!path.startsWith('/')) {
-        throw new Error(`Config key name must start with '/': ${path}`);
-    }
-    if (path.endsWith('/')) {
-        throw new Error(`Config key name cannot end with '/': ${path}`);
-    }
-    if (path.includes('//')) {
-        throw new Error(`Config key name cannot contain '//': ${path}`);
-    }
-    if (!/^[a-zA-Z0-9_\/]+$/.test(path)) {
-        throw new Error(`Config key name contains invalid characters (allowed: a-z, A-Z, 0-9, _, /): ${path}`);
-    }
-    // Each segment must start with a letter
-    const segments = path.split('/').filter(s => s.length > 0);
-    for (const segment of segments) {
-        if (!/^[a-zA-Z]/.test(segment)) {
-            throw new Error(`Each path segment must start with a letter: ${path}`);
-        }
-    }
+/**
+ * Validates config key name for compatibility with external providers.
+ * Rules:
+ * - Must start with forward slash
+ * - Only letters, numbers, underscore, forward slash allowed
+ * - Each segment (word) must start with a letter
+ * - No double slashes
+ * - Cannot end with slash
+ * - Max 2048 characters (AWS limit)
+ */
+export function assureValidConfigPath(path: string) {
+    if (path.length > 2048) {
+        throw new Error(`Config key name exceeds 2048 characters: ${path}`);
+    }
+    if (!path.startsWith('/')) {
+        throw new Error(`Config key name must start with '/': ${path}`);
+    }
+    if (path.endsWith('/')) {
+        throw new Error(`Config key name cannot end with '/': ${path}`);
+    }
+    if (path.includes('//')) {
+        throw new Error(`Config key name cannot contain '//': ${path}`);
+    }
+    if (!/^[a-zA-Z0-9_\/]+$/.test(path)) {
+        throw new Error(`Config key name contains invalid characters (allowed: a-z, A-Z, 0-9, _, /): ${path}`);
+    }
+    // Each segment must start with a letter
+    const segments = path.split('/').filter(s => s.length > 0);
+    for (const segment of segments) {
+        if (!/^[a-zA-Z]/.test(segment)) {
+            throw new Error(`Each path segment must start with a letter: ${path}`);
+        }
+    }
 }

package/src/index-node.ts

@@ -1,11 +1,11 @@
-export * from './GGConfig';
-export * from './GG_CONFIG';
-export * from './GGConfigLocator';
-export * from "./GGConfigKey";
-export * from "./GGConfigStore";
-export * from "./stores/GGConfigStoreFile";
-export * from "./stores/GGConfigStoreLocal";
-export * from "./keys/GGSetting";
-export * from "./keys/GGSecret";
-export * from "./keys/GGResource";
+export * from './GGConfig';
+export * from './GG_CONFIG';
+export * from './GGConfigLocator';
+export * from "./GGConfigKey";
+export * from "./GGConfigStore";
+export * from "./stores/GGConfigStoreFile";
+export * from "./stores/GGConfigStoreLocal";
+export * from "./keys/GGSetting";
+export * from "./keys/GGSecret";
+export * from "./keys/GGResource";
 export {assureValidConfigPath} from "./assureValidConfigPath";

package/src/keys/GGResource.ts

@@ -1,20 +1,20 @@
-import {GGConfigKey} from "../GGConfigKey";
-import {GGValidator} from "@grest-ts/schema";
-
-export class GGResource<T> extends GGConfigKey<T> {
-
-    public static readonly NAME = "[GGResource]";
-
-    constructor(name: string, schema: GGValidator<T>, description: string) {
-        super(name, schema, description);
-    }
-
-    public getStoreKey(): string {
-        return GGResource.NAME;
-    }
-
-    public get(): T {
-        return this.getValue();
-    }
-
-}
+import {GGConfigKey} from "../GGConfigKey";
+import {GGValidator} from "@grest-ts/schema";
+
+export class GGResource<T> extends GGConfigKey<T> {
+
+    public static readonly NAME = "[GGResource]";
+
+    constructor(name: string, schema: GGValidator<T>, description: string) {
+        super(name, schema, description);
+    }
+
+    public getStoreKey(): string {
+        return GGResource.NAME;
+    }
+
+    public get(): T {
+        return this.getValue();
+    }
+
+}