@grest-ts/config 0.0.6 → 0.0.8

package/src/GGConfig.ts

@@ -1,70 +1,70 @@
-import {GGConfigDefinition} from "./GGConfigLocator";
-import {AsyncLocalStorage} from "node:async_hooks";
-import {GGConfigKey} from "./GGConfigKey";
-import {ConstructorOf} from "@grest-ts/common";
-
-export interface GGConfigKeyCreationContext {
-    name: string
-    add: (key: GGConfigKey) => void;
-}
-
-const defineContext = new AsyncLocalStorage<GGConfigKeyCreationContext>();
-
-export class GGConfig {
-
-    public static define<T>(name: string, define: () => T): GGConfigDefinition<T> {
-        const keysMap: Map<ConstructorOf<GGConfigKey>, GGConfigKey[]> = new Map()
-        const ctx: GGConfigKeyCreationContext = Object.freeze({
-            name,
-            add: (key: GGConfigKey) => {
-                const cls = key.constructor as ConstructorOf<GGConfigKey>;
-                if (!keysMap.has(cls)) {
-                    keysMap.set(cls, [])
-                }
-                keysMap.get(cls).push(key)
-            }
-        });
-        const result = defineContext.run(ctx, define) as GGConfigDefinition<T>;
-        keysMap.forEach(list => Object.freeze(list))
-        result.__getKeysMap = ((cls: ConstructorOf<GGConfigKey>) => keysMap) as any
-        Object.freeze(result);
-        return result
-    }
-
-    public static getCreationContext(): GGConfigKeyCreationContext {
-        const store = defineContext.getStore()
-        if (!store) {
-            throw new Error("No prefix defined in context")
-        }
-        return store;
-    }
-
-    public static toJSON(config: GGConfigDefinition<any>): Record<string, unknown> {
-        const result: Record<string, Record<string, unknown>> = {};
-        this.collectKeys(config, result);
-        return result;
-    }
-
-    private static collectKeys(obj: unknown, result: Record<string, Record<string, unknown>>): void {
-        if (obj instanceof GGConfigKey) {
-            const storeKey = obj.getStoreKey();
-            if (!result[storeKey]) {
-                result[storeKey] = {};
-            }
-            const segments = obj.name.split('/').filter(s => s.length > 0);
-            let current: Record<string, unknown> = result[storeKey];
-            for (let i = 0; i < segments.length - 1; i++) {
-                if (!current[segments[i]]) {
-                    current[segments[i]] = {};
-                }
-                current = current[segments[i]] as Record<string, unknown>;
-            }
-            current[segments[segments.length - 1]] = obj.getDefault();
-        } else if (obj && typeof obj === 'object') {
-            for (const value of Object.values(obj)) {
-                this.collectKeys(value, result);
-            }
-        }
-    }
-
+import {GGConfigDefinition} from "./GGConfigLocator";
+import {AsyncLocalStorage} from "node:async_hooks";
+import {GGConfigKey} from "./GGConfigKey";
+import {ConstructorOf} from "@grest-ts/common";
+
+export interface GGConfigKeyCreationContext {
+    name: string
+    add: (key: GGConfigKey) => void;
+}
+
+const defineContext = new AsyncLocalStorage<GGConfigKeyCreationContext>();
+
+export class GGConfig {
+
+    public static define<T>(name: string, define: () => T): GGConfigDefinition<T> {
+        const keysMap: Map<ConstructorOf<GGConfigKey>, GGConfigKey[]> = new Map()
+        const ctx: GGConfigKeyCreationContext = Object.freeze({
+            name,
+            add: (key: GGConfigKey) => {
+                const cls = key.constructor as ConstructorOf<GGConfigKey>;
+                if (!keysMap.has(cls)) {
+                    keysMap.set(cls, [])
+                }
+                keysMap.get(cls).push(key)
+            }
+        });
+        const result = defineContext.run(ctx, define) as GGConfigDefinition<T>;
+        keysMap.forEach(list => Object.freeze(list))
+        result.__getKeysMap = ((cls: ConstructorOf<GGConfigKey>) => keysMap) as any
+        Object.freeze(result);
+        return result
+    }
+
+    public static getCreationContext(): GGConfigKeyCreationContext {
+        const store = defineContext.getStore()
+        if (!store) {
+            throw new Error("No prefix defined in context")
+        }
+        return store;
+    }
+
+    public static toJSON(config: GGConfigDefinition<any>): Record<string, unknown> {
+        const result: Record<string, Record<string, unknown>> = {};
+        this.collectKeys(config, result);
+        return result;
+    }
+
+    private static collectKeys(obj: unknown, result: Record<string, Record<string, unknown>>): void {
+        if (obj instanceof GGConfigKey) {
+            const storeKey = obj.getStoreKey();
+            if (!result[storeKey]) {
+                result[storeKey] = {};
+            }
+            const segments = obj.name.split('/').filter(s => s.length > 0);
+            let current: Record<string, unknown> = result[storeKey];
+            for (let i = 0; i < segments.length - 1; i++) {
+                if (!current[segments[i]]) {
+                    current[segments[i]] = {};
+                }
+                current = current[segments[i]] as Record<string, unknown>;
+            }
+            current[segments[segments.length - 1]] = obj.getDefault();
+        } else if (obj && typeof obj === 'object') {
+            for (const value of Object.values(obj)) {
+                this.collectKeys(value, result);
+            }
+        }
+    }
+
 }

package/src/GGConfigKey.ts

@@ -1,107 +1,107 @@
-import {GGConfig} from "./GGConfig";
-import {assureValidConfigPath} from "./assureValidConfigPath";
-import {GGValidator} from "@grest-ts/schema";
-import {GG_CONFIG} from "./GG_CONFIG";
-
-/**
- * Widens literal types to their base primitive type.
- * This allows T to be inferred from the validator while defaultValue accepts compatible values.
- * e.g., Widen<tPosInt> = number, so defaultValue can be 5000
- */
-export type Widen<T> = T extends number ? number : T extends string ? string : T extends boolean ? boolean : T;
-
-export type GGConfigKeyConstructor<T = unknown> = {
-    readonly NAME: string,
-    new(...args: any[]): GGConfigKey<T>
-};
-
-export abstract class GGConfigKey<T = unknown> {
-
-    private static readonly registry = new Map<string, GGConfigKey>();
-
-    public static hasKey(name: string): boolean {
-        return GGConfigKey.registry.has(name);
-    }
-
-    public static getKey(name: string): GGConfigKey {
-        const result = GGConfigKey.registry.get(name);
-        if (result === undefined) {
-            throw new Error(`Config key not found: ${name}`);
-        }
-        return result;
-    }
-
-    public readonly root: string;
-    public readonly name: string;
-    public readonly description: string | undefined;
-    public readonly schema: GGValidator<T> | undefined;
-    /** File location where this ConfigKey was defined (file:line:col) */
-    public readonly definedAt: string | undefined;
-
-    constructor(name: string, schema: GGValidator<T>, description: string) {
-        this.definedAt = captureDefinitionLocation();
-        const ctx = GGConfig.getCreationContext();
-        ctx.add(this);
-        this.root = ctx.name
-        this.name = this.root + name;
-        assureValidConfigPath(this.name);
-        this.description = description;
-        this.schema = schema;
-
-        Object.freeze(this);
-
-        if (GGConfigKey.registry.has(this.name)) {
-            throw new Error(`Duplicate config key: ${this.name}`);
-        }
-        GGConfigKey.registry.set(this.name, this);
-    }
-
-    public getDefault(): T | undefined {
-        return undefined;
-    }
-
-    protected getValue(): T {
-        const store = this.getStore();
-        if (!store.started) {
-            throw new Error(`Cannot read config key "${this.name}" before the config store has been started.`);
-        }
-        return store.getValue(this);
-    }
-
-    public watch(listener: (value: T) => void): () => void {
-        return this.getStore().watch(this, listener);
-    }
-
-    public abstract getStoreKey(): string;
-
-    public getStore() {
-        return GG_CONFIG.get().getStore(this.constructor as GGConfigKeyConstructor<any>);
-    }
-}
-
-function captureDefinitionLocation(): string | undefined {
-    const stack = new Error().stack;
-
-    /* This could be one possible error we are filtering for.
-    Error
-    at captureDefinitionLocation (\GG_ROOT\packages\config\src\GGConfigKey.ts:24:19)
-    at new GGConfigKey (\GG_ROOT\packages\config\src\GGConfigKey.ts:60:26)
-    at new GGResource (\GG_ROOT\packages\config\src\keys\GGResource.ts:3:8)
-    at Object.createAwsSnsProviderConfig (\GG_ROOT\packages-libs\events\events-aws\src\AwsSnsAdapter.ts:26:19)
-    at new EventPublisherConfig (\GG_ROOT\packages-libs\events\events\src\pub\EventPublisherConfig.ts:56:52)
-    at EventPublisherResource.config (\GG_ROOT\packages-libs\events\events\src\pub\EventPublisherResource.ts:39:16)
-    at <anonymous> (\GG_ROOT\examples\checklist\checklist\ChecklistConfig.ts:26:41)
-    at AsyncLocalStorage.run (node:internal/async_local_storage/async_context_frame:63:14)
-    at GGConfig.define (\GG_ROOT\packages\config\src\GGConfig.ts:27:38)
-    at <anonymous> (\GG_ROOT\examples\checklist\checklist\ChecklistConfig.ts:8:41)
-     */
-    const lines = stack.split('\n').reverse();
-    for (let i = 1; i < lines.length; i++) {
-        const line = lines[i];
-        // Remember that minification might change the names of things.
-        if (lines[i - 1]?.includes('at AsyncLocalStorage.run ') && line?.includes('at <anonymous>')) {
-            return line.substring(0, line.length - 1).trim().replace("at <anonymous> (", "")
-        }
-    }
-    return stack;
+import {GGConfig} from "./GGConfig";
+import {assureValidConfigPath} from "./assureValidConfigPath";
+import {GGValidator} from "@grest-ts/schema";
+import {GG_CONFIG} from "./GG_CONFIG";
+
+/**
+ * Widens literal types to their base primitive type.
+ * This allows T to be inferred from the validator while defaultValue accepts compatible values.
+ * e.g., Widen<tPosInt> = number, so defaultValue can be 5000
+ */
+export type Widen<T> = T extends number ? number : T extends string ? string : T extends boolean ? boolean : T;
+
+export type GGConfigKeyConstructor<T = unknown> = {
+    readonly NAME: string,
+    new(...args: any[]): GGConfigKey<T>
+};
+
+export abstract class GGConfigKey<T = unknown> {
+
+    private static readonly registry = new Map<string, GGConfigKey>();
+
+    public static hasKey(name: string): boolean {
+        return GGConfigKey.registry.has(name);
+    }
+
+    public static getKey(name: string): GGConfigKey {
+        const result = GGConfigKey.registry.get(name);
+        if (result === undefined) {
+            throw new Error(`Config key not found: ${name}`);
+        }
+        return result;
+    }
+
+    public readonly root: string;
+    public readonly name: string;
+    public readonly description: string | undefined;
+    public readonly schema: GGValidator<T> | undefined;
+    /** File location where this ConfigKey was defined (file:line:col) */
+    public readonly definedAt: string | undefined;
+
+    constructor(name: string, schema: GGValidator<T>, description: string) {
+        this.definedAt = captureDefinitionLocation();
+        const ctx = GGConfig.getCreationContext();
+        ctx.add(this);
+        this.root = ctx.name
+        this.name = this.root + name;
+        assureValidConfigPath(this.name);
+        this.description = description;
+        this.schema = schema;
+
+        Object.freeze(this);
+
+        if (GGConfigKey.registry.has(this.name)) {
+            throw new Error(`Duplicate config key: ${this.name}`);
+        }
+        GGConfigKey.registry.set(this.name, this);
+    }
+
+    public getDefault(): T | undefined {
+        return undefined;
+    }
+
+    protected getValue(): T {
+        const store = this.getStore();
+        if (!store.started) {
+            throw new Error(`Cannot read config key "${this.name}" before the config store has been started.`);
+        }
+        return store.getValue(this);
+    }
+
+    public watch(listener: (value: T) => void): () => void {
+        return this.getStore().watch(this, listener);
+    }
+
+    public abstract getStoreKey(): string;
+
+    public getStore() {
+        return GG_CONFIG.get().getStore(this.constructor as GGConfigKeyConstructor<any>);
+    }
+}
+
+function captureDefinitionLocation(): string | undefined {
+    const stack = new Error().stack;
+
+    /* This could be one possible error we are filtering for.
+    Error
+    at captureDefinitionLocation (\GG_ROOT\packages\config\src\GGConfigKey.ts:24:19)
+    at new GGConfigKey (\GG_ROOT\packages\config\src\GGConfigKey.ts:60:26)
+    at new GGResource (\GG_ROOT\packages\config\src\keys\GGResource.ts:3:8)
+    at Object.createAwsSnsProviderConfig (\GG_ROOT\packages-libs\events\events-aws\src\AwsSnsAdapter.ts:26:19)
+    at new EventPublisherConfig (\GG_ROOT\packages-libs\events\events\src\pub\EventPublisherConfig.ts:56:52)
+    at EventPublisherResource.config (\GG_ROOT\packages-libs\events\events\src\pub\EventPublisherResource.ts:39:16)
+    at <anonymous> (\GG_ROOT\examples\checklist\checklist\ChecklistConfig.ts:26:41)
+    at AsyncLocalStorage.run (node:internal/async_local_storage/async_context_frame:63:14)
+    at GGConfig.define (\GG_ROOT\packages\config\src\GGConfig.ts:27:38)
+    at <anonymous> (\GG_ROOT\examples\checklist\checklist\ChecklistConfig.ts:8:41)
+     */
+    const lines = stack.split('\n').reverse();
+    for (let i = 1; i < lines.length; i++) {
+        const line = lines[i];
+        // Remember that minification might change the names of things.
+        if (lines[i - 1]?.includes('at AsyncLocalStorage.run ') && line?.includes('at <anonymous>')) {
+            return line.substring(0, line.length - 1).trim().replace("at <anonymous> (", "")
+        }
+    }
+    return stack;
 }

package/src/GGConfigLocator.ts

@@ -1,112 +1,112 @@
-import {GGConfigStore} from "./GGConfigStore";
-import {GGConfigKey, GGConfigKeyConstructor} from "./GGConfigKey";
-import {GGLocator, GGLocatorServiceType} from "@grest-ts/locator";
-import {GG_CONFIG} from "./GG_CONFIG";
-import {ConfigValues, GGConfigStoreLocal} from "./stores/GGConfigStoreLocal";
-
-export type GGConfigDefinition<T> = T & {
-    __isGGConfigDefinition: never,
-    __getKeysMap: () => ReadonlyMap<GGConfigKeyConstructor, GGConfigKey[]>
-};
-
-export class GGConfigLocator<T extends object> {
-
-    #isStarted = false;
-    readonly #config: GGConfigDefinition<T>;
-    readonly #storesList: GGConfigStore<GGConfigKey>[] = []
-    readonly #storesMap: Map<string, GGConfigStore<GGConfigKey>> = new Map()
-
-    protected readonly localConfig: GGConfigStoreLocal<T, any> = undefined
-
-    /**
-     * @param config - Config definition.
-     * @param localConfig - Optional local config values. If provided, stores will use this instead of the real values when not running in production.
-     *  new GGConfigLocator(MyConfig, localConfig) is shorthand for this: new GGConfigLocator(MyConfig).add(AllKeys, new GGConfigStoreLocal(MyConfig, localConfig))
-     */
-    constructor(config: GGConfigDefinition<T>, localConfig?: ConfigValues<T>) {
-        if (!config) throw new Error("Config definition is required");
-        this.#config = config;
-        this.localConfig = localConfig ? new GGConfigStoreLocal(config, localConfig) : undefined
-        GGLocator.getScope().setWithLifecycle(GG_CONFIG, this, {
-            type: GGLocatorServiceType.CONFIG,
-            start: () => this.start(),
-            teardown: () => this.teardown()
-        });
-    }
-
-    /**
-     * Can override this if you want custom handling.
-     */
-    public onNotifyError = (error: Error): never => {
-        throw error;
-    }
-
-    /**
-     * Add a config store for a key type.
-     *
-     * Note for framework development: Testkit overrides this function.
-     */
-    public add<Key extends GGConfigKey>(key: GGConfigKeyConstructor<Key> | GGConfigKeyConstructor<Key>[], store: GGConfigStore<Key>): this {
-        return this._add(key, this._useLocalStoreIfNeeded(store))
-    }
-
-    protected _useLocalStoreIfNeeded<Key extends GGConfigKey>(store: GGConfigStore<Key>): GGConfigStore<Key> {
-        if (process.env.NODE_ENV === "production" || !this.localConfig) {
-            return store;
-        } else {
-            return this.localConfig;
-        }
-    }
-
-    protected _add<Key extends GGConfigKey>(key: GGConfigKeyConstructor<Key> | GGConfigKeyConstructor<Key>[], store: GGConfigStore<Key>): this {
-        if (this.#isStarted) {
-            throw new Error("Cannot add store after config holder is started");
-        }
-        const keyTypes = Array.isArray(key) ? key : [key];
-        const keysMap = this.#config.__getKeysMap();
-        for (const keyType of keyTypes) {
-            const keysForType = (keysMap.get(keyType) ?? []) as Key[];
-            store.setKeys(keysForType);
-            this.#storesMap.set(keyType.NAME, store as GGConfigStore<GGConfigKey>);
-        }
-        if (!this.#storesList.includes(store as GGConfigStore<GGConfigKey>)) {
-            this.#storesList.push(store as GGConfigStore<GGConfigKey>);
-        }
-        return this;
-    }
-
-    public getStore<Key extends GGConfigKey>(keyType: GGConfigKeyConstructor<Key>): GGConfigStore<Key> {
-        return this.getStoreByConfigKeyName(keyType.NAME);
-    }
-
-    public getStoreByConfigKeyName<Key extends GGConfigKey>(name: string): GGConfigStore<Key> {
-        const store = this.#storesMap.get(name);
-        if (!store) {
-            throw new Error(`No store for store key: ${name ?? 'undefined'}.`);
-        }
-        return store as GGConfigStore<Key>
-    }
-
-    public getStores(): GGConfigStore<GGConfigKey>[] {
-        return this.#storesList;
-    }
-
-    public async start(): Promise<void> {
-        if (this.#isStarted) {
-            throw new Error("Already started");
-        }
-        this.#isStarted = true;
-        this.#config.__getKeysMap().forEach((_, keyType) => {
-            if (!this.#storesMap.has(keyType.NAME)) {
-                throw new Error(`Missing stores for config key type '${keyType.NAME}'`);
-            }
-        })
-        Object.freeze(this.#storesMap);
-        Object.freeze(this.#storesList);
-        await Promise.all(this.#storesList.map((store) => store.start()));
-    }
-
-    public async teardown(): Promise<void> {
-        await Promise.all(this.#storesList.map(s => s.teardown()));
-    }
-}
+import {GGConfigStore} from "./GGConfigStore";
+import {GGConfigKey, GGConfigKeyConstructor} from "./GGConfigKey";
+import {GGLocator, GGLocatorServiceType} from "@grest-ts/locator";
+import {GG_CONFIG} from "./GG_CONFIG";
+import {ConfigValues, GGConfigStoreLocal} from "./stores/GGConfigStoreLocal";
+
+export type GGConfigDefinition<T> = T & {
+    __isGGConfigDefinition: never,
+    __getKeysMap: () => ReadonlyMap<GGConfigKeyConstructor, GGConfigKey[]>
+};
+
+export class GGConfigLocator<T extends object> {
+
+    #isStarted = false;
+    readonly #config: GGConfigDefinition<T>;
+    readonly #storesList: GGConfigStore<GGConfigKey>[] = []
+    readonly #storesMap: Map<string, GGConfigStore<GGConfigKey>> = new Map()
+
+    protected readonly localConfig: GGConfigStoreLocal<T, any> = undefined
+
+    /**
+     * @param config - Config definition.
+     * @param localConfig - Optional local config values. If provided, stores will use this instead of the real values when not running in production.
+     *  new GGConfigLocator(MyConfig, localConfig) is shorthand for this: new GGConfigLocator(MyConfig).add(AllKeys, new GGConfigStoreLocal(MyConfig, localConfig))
+     */
+    constructor(config: GGConfigDefinition<T>, localConfig?: ConfigValues<T>) {
+        if (!config) throw new Error("Config definition is required");
+        this.#config = config;
+        this.localConfig = localConfig ? new GGConfigStoreLocal(config, localConfig) : undefined
+        GGLocator.getScope().setWithLifecycle(GG_CONFIG, this, {
+            type: GGLocatorServiceType.CONFIG,
+            start: () => this.start(),
+            teardown: () => this.teardown()
+        });
+    }
+
+    /**
+     * Can override this if you want custom handling.
+     */
+    public onNotifyError = (error: Error): never => {
+        throw error;
+    }
+
+    /**
+     * Add a config store for a key type.
+     *
+     * Note for framework development: Testkit overrides this function.
+     */
+    public add<Key extends GGConfigKey>(key: GGConfigKeyConstructor<Key> | GGConfigKeyConstructor<Key>[], store: GGConfigStore<Key>): this {
+        return this._add(key, this._useLocalStoreIfNeeded(store))
+    }
+
+    protected _useLocalStoreIfNeeded<Key extends GGConfigKey>(store: GGConfigStore<Key>): GGConfigStore<Key> {
+        if (process.env.NODE_ENV === "production" || !this.localConfig) {
+            return store;
+        } else {
+            return this.localConfig;
+        }
+    }
+
+    protected _add<Key extends GGConfigKey>(key: GGConfigKeyConstructor<Key> | GGConfigKeyConstructor<Key>[], store: GGConfigStore<Key>): this {
+        if (this.#isStarted) {
+            throw new Error("Cannot add store after config holder is started");
+        }
+        const keyTypes = Array.isArray(key) ? key : [key];
+        const keysMap = this.#config.__getKeysMap();
+        for (const keyType of keyTypes) {
+            const keysForType = (keysMap.get(keyType) ?? []) as Key[];
+            store.setKeys(keysForType);
+            this.#storesMap.set(keyType.NAME, store as GGConfigStore<GGConfigKey>);
+        }
+        if (!this.#storesList.includes(store as GGConfigStore<GGConfigKey>)) {
+            this.#storesList.push(store as GGConfigStore<GGConfigKey>);
+        }
+        return this;
+    }
+
+    public getStore<Key extends GGConfigKey>(keyType: GGConfigKeyConstructor<Key>): GGConfigStore<Key> {
+        return this.getStoreByConfigKeyName(keyType.NAME);
+    }
+
+    public getStoreByConfigKeyName<Key extends GGConfigKey>(name: string): GGConfigStore<Key> {
+        const store = this.#storesMap.get(name);
+        if (!store) {
+            throw new Error(`No store for store key: ${name ?? 'undefined'}.`);
+        }
+        return store as GGConfigStore<Key>
+    }
+
+    public getStores(): GGConfigStore<GGConfigKey>[] {
+        return this.#storesList;
+    }
+
+    public async start(): Promise<void> {
+        if (this.#isStarted) {
+            throw new Error("Already started");
+        }
+        this.#isStarted = true;
+        this.#config.__getKeysMap().forEach((_, keyType) => {
+            if (!this.#storesMap.has(keyType.NAME)) {
+                throw new Error(`Missing stores for config key type '${keyType.NAME}'`);
+            }
+        })
+        Object.freeze(this.#storesMap);
+        Object.freeze(this.#storesList);
+        await Promise.all(this.#storesList.map((store) => store.start()));
+    }
+
+    public async teardown(): Promise<void> {
+        await Promise.all(this.#storesList.map(s => s.teardown()));
+    }
+}