@james-pre/config 1.0.0 → 1.0.2

package/dist/manager.d.ts

@@ -3,12 +3,13 @@ import type { FlattenKeys, GetByString, PartialRecursive } from 'utilium';
 import * as z from 'zod';
 export type FileType = 'system' | 'user' | 'local';
 /** Information about a loaded config file */
-interface File<Value> {
+interface File<Value, Options extends LoadOptions = LoadOptions> {
     path: string;
     wasIncluded: boolean;
     data: Value;
     type: FileType;
     auto: boolean;
+    options: Partial<Options>;
 }
 /**
  * How a file is being loaded
@@ -23,21 +24,21 @@ export interface LoadOptions {
     /**
      * If enabled, the config file will still be loaded if it does not match the schema.
      */
-    loose?: boolean;
+    loose: boolean;
     /**
      * If enabled, the config file will be skipped if it does not exist.
      */
-    optional?: boolean;
+    optional: boolean;
     /**
      * If enabled, an empty config file will be created when it does not exist.
      * Included files are never created.
      */
-    create?: boolean;
+    create: boolean;
     /**
      * Used to mark files that are included, auto-loaded, etc.
      * @internal
      */
-    [kInit]?: FileLoadInit;
+    [kInit]: FileLoadInit;
 }
 declare const kInit: unique symbol;
 export interface ManagerOptions {
@@ -57,9 +58,9 @@ export interface ManagerOptions {
 /**
  * Manager for configuration files
  */
-export declare class Manager<Shape extends Readonly<Record<string, z.ZodType>>, LoadOpts extends LoadOptions = LoadOptions, out In extends z.input<z.ZodObject<Shape>> = z.input<z.ZodObject<Shape>>, out FileData = z.output<ReturnType<typeof z.deepPartial<z.ZodObject<Shape>>>>> extends EventEmitter<{
-    load: [path: string, config: FileData];
-    post_load: [path: string, config: FileData];
+export declare class Manager<LoadOpts extends LoadOptions = LoadOptions, Shape extends Readonly<Record<string, z.ZodType>> = Readonly<Record<string, z.ZodType>>, out In extends z.input<z.ZodObject<Shape>> = z.input<z.ZodObject<Shape>>, out FileData = z.output<ReturnType<typeof z.deepPartial<z.ZodObject<Shape>>>>> extends EventEmitter<{
+    load: [path: string, config: FileData, options: Partial<LoadOpts>];
+    post_load: [path: string, config: FileData, options: Partial<LoadOpts>];
     load_error: [path: string, stage: 'read' | 'create' | 'parse', error: Error];
     create: [path: string];
     change: [];
@@ -69,7 +70,8 @@ export declare class Manager<Shape extends Readonly<Record<string, z.ZodType>>,
     protected options: ManagerOptions;
     readonly schema: z.ZodObject<Shape>;
     readonly fileSchema: ReturnType<typeof z.deepPartial<z.ZodObject<Shape>>>;
-    protected files: Map<string, File<FileData>>;
+    protected readonly files: Map<string, File<FileData>>;
+    get filePaths(): MapIterator<string>;
     readonly data: z.output<z.ZodObject<Shape>>;
     constructor(shape: Shape, options?: ManagerOptions);
     /**
@@ -84,7 +86,7 @@ export declare class Manager<Shape extends Readonly<Record<string, z.ZodType>>,
     merge(config: PartialRecursive<In>): void;
     /** Replace the current config with `config`, applying defaults for anything missing. */
     replace(config: In): void;
-    loadFile(path: string, options: LoadOpts): void;
+    loadFile(path: string, options: Partial<LoadOpts>): void;
     /** Get the entry for `path`, adding one for a file that has not been loaded */
     protected fileAt(path: string): File<FileData>;
     protected writeFile(file: File<FileData>): void;
@@ -108,7 +110,7 @@ export declare class Manager<Shape extends Readonly<Record<string, z.ZodType>>,
     /**
      * Load the files from `defaultPaths`. Missing files are skipped unless `options` says otherwise.
      */
-    loadDefaults(options: LoadOpts): void;
+    loadDefaults(options?: Partial<LoadOpts>): void;
     /**
      * The file a change of the given type is written to:
      * the most recently loaded file of that type, or the path `loadDefaults` would use for it.
@@ -118,6 +120,6 @@ export declare class Manager<Shape extends Readonly<Record<string, z.ZodType>>,
      * Merge `config` into the current config and save it.
      */
     update(config: PartialRecursive<In>, type?: FileType): void;
-    reloadFiles(options: LoadOpts): void;
+    reloadFiles(options?: Partial<LoadOpts>): void;
 }
 export {};

package/dist/manager.js

@@ -149,6 +149,9 @@ let Manager = (() => {
         schema;
         fileSchema;
         files = new Map();
+        get filePaths() {
+            return this.files.keys();
+        }
         data;
         constructor(shape, options = {}) {
             super({ captureRejections: true });
@@ -227,9 +230,10 @@ let Manager = (() => {
                 ...(options[kInit] || {}),
                 data: file,
                 path,
+                options,
             });
+            this.emit('load', path, file, options);
             this.merge(file);
-            this.emit('load', path, file);
             if (canInclude(this.options, file))
                 for (const include of file.include ?? []) {
                     this.loadFile(resolve(dirname(path), include), {
@@ -239,7 +243,7 @@ let Manager = (() => {
                         [kInit]: { ...options[kInit], wasIncluded: true },
                     });
                 }
-            this.emit('post_load', path, file);
+            this.emit('post_load', path, file, options);
         }
         /** Get the entry for `path`, adding one for a file that has not been loaded */
         fileAt(path) {
@@ -252,6 +256,7 @@ let Manager = (() => {
                 type: typeFromPath(path),
                 auto: false,
                 wasIncluded: false,
+                options: {},
             };
             this.files.set(path, file);
             return file;
@@ -298,7 +303,7 @@ let Manager = (() => {
         /**
          * Load the files from `defaultPaths`. Missing files are skipped unless `options` says otherwise.
          */
-        loadDefaults(options) {
+        loadDefaults(options = {}) {
             for (const { path, type } of this.defaultPaths) {
                 this.loadFile(path, { optional: true, ...options, [kInit]: { type, auto: true } });
             }
@@ -326,7 +331,7 @@ let Manager = (() => {
         update(config, type) {
             this.updateFile(this.findPath(type), config);
         }
-        reloadFiles(options) {
+        reloadFiles(options = {}) {
             const files = this.files
                 .values()
                 .filter(file => !file.wasIncluded)

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@james-pre/config",
-	"version": "1.0.0",
+	"version": "1.0.2",
 	"description": "Manage configuration files",
 	"funding": {
 		"type": "individual",
@@ -20,8 +20,8 @@
 	"scripts": {
 		"format:check": "prettier --check .",
 		"format": "prettier --write .",
-		"build": "tsc",
-		"lint": "tsc --noEmit && eslint src",
+		"build": "tsc -b",
+		"lint": "tsc -b --noEmit && eslint src",
 		"prepublishOnly": "npx tsc"
 	},
 	"repository": {
@@ -63,5 +63,6 @@
 		"printWidth": 120,
 		"arrowParens": "avoid",
 		"experimentalOperatorPosition": "start"
-	}
+	},
+	"sideEffects": false
 }