Initial work for file plugin

package.json

@@ -19,7 +19,7 @@
     "packages/*"
   ],
   "scripts": {
-    "build": "npm run build --workspace=config-dug --workspace=@config-dug/plugin-aws-secrets-manager",
+    "build": "npm run build --workspace=config-dug --workspace=@config-dug/plugin-aws-secrets-manager --workspace=@config-dug/plugin-file",
     "clean": "rimraf packages/*/build",
     "clean:modules": "rimraf node_modules examples/*/node_modules packages/*/node_modules",
     "format": "prettier --write \"**/*.{ts,js,cjs,mjs,json,md}\"",

packages/plugin-config-cat/src/index.ts

@@ -14,7 +14,7 @@ export const targetedConfigCatFlagSchema = z
       email: z.string().optional(),
       country: z.string().optional(),
       custom: z.record(z.string(), z.string() || z.number()).optional(),
-    }),
+    })
   )
   .returns(z.promise(z.union([z.boolean(), z.string(), z.number(), z.null(), z.undefined()])));
 
@@ -68,7 +68,7 @@ class ConfigCatPlugin extends BaseConfigDugPlugin<ConfigCatPluginOptions> {
 
     if (!sdkKey) {
       throw new Error(
-        `Config value: ${this.pluginOptions.sdkKeyName} is required to be configured before loading this plugin.`,
+        `Config value: ${this.pluginOptions.sdkKeyName} is required to be configured before loading this plugin.`
       );
     }
 

packages/plugin-config-cat/test/config-cat-plugin.test.ts

@@ -47,7 +47,7 @@ describe('configCatPlugin', () => {
     });
 
     await expect(configDug.load()).rejects.toThrowError(
-      'Config value: CONFIG_CAT_SDK_KEY is required to be configured before loading this plugin.',
+      'Config value: CONFIG_CAT_SDK_KEY is required to be configured before loading this plugin.'
     );
   });
 

packages/plugin-file/.eslintignore

@@ -0,0 +1,4 @@
+**/build
+**/coverage
+**/node_modules
+.eslintrc.cjs

packages/plugin-file/.eslintrc.cjs

@@ -0,0 +1,16 @@
+module.exports = {
+  extends: ['eslint-config-neo/config-base'],
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint'],
+  parserOptions: {
+    project: ['./tsconfig.cjs.json', './test/tsconfig.json'],
+    sourceType: 'module',
+  },
+  rules: {
+    jest: 'off',
+    'jest/no-commented-out-tests': 'off',
+    'jest/no-deprecated-functions': 'off',
+    'jest/valid-expect': 'off',
+    'jest/valid-expect-in-promise': 'off',
+  },
+};

packages/plugin-file/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Plugin AWS Secrets Manager Changelog
+
+## 1.0.0 (TBD)
+
+- Initial release

packages/plugin-file/README.md

@@ -0,0 +1,90 @@
+# File Plugin
+
+A file plugin for Config Dug
+
+This plugin is used to support loading configuration values via the File API: https://api.configcat.com/docs/
+
+# Usage
+
+## Defining the File plugin
+
+```ts
+const filePlugin = new FilePlugin({
+  files: ['config.json'],
+});
+```
+
+### Parameter Reference
+
+| Parameter        | Type     | Description                                                               |
+| :--------------- | :------- | :------------------------------------------------------------------------ |
+| `sourceKeyStyle` | `number` | The naming convention used by the plugin source. ex. SCREAMING_SNAKE_CASE |
+| `targetedFlags`  | `array`  | The definition of all targeted flags to be loaded by the plugin.          |
+
+## Adding targeted flags to the Config Dug schema
+
+> [!IMPORTANT]
+> The File plugin exports a custom type `targetedFileFlagSchema` That can be used to define targeted flags within the schema. This is a custom zod definition that matches function definition returned by this plugin and should be used for all targeted flags.
+
+```ts
+const schema = {
+  value1: {
+    schema: targetedFileFlagSchema,
+    description: 'Targeted File config boolean',
+    sensitive: false,
+  },
+};
+```
+
+## Adding the plugin to Config Dug
+
+The File flugin can be added to the plugins array in config dug constructor. Keep in mind the plugin load order dictates which values will be used.
+
+```ts
+const configDug = new ConfigDug(schema, {
+  plugins: [filePlugin],
+  printConfig: true,
+});
+```
+
+## Complete example
+
+```ts
+const schema = {
+  value1: {
+    schema: z.string(),
+    description: 'Non-targeted File string',
+    sensitive: false,
+  },
+  value2: {
+    schema: targetedFileFlagSchema,
+    description: 'Targeted File value',
+    sensitive: true,
+  },
+};
+
+const filePlugin = new FilePlugin({
+  sourceKeyStyle: 'SCREAMING_SNAKE_CASE',
+  targetedFlags: [
+    {
+      key: 'value1',
+      defaultValue: false,
+    },
+    {
+      key: 'value2',
+      defaultValue: 'test default',
+    },
+  ],
+});
+
+const configDug = new ConfigDug(schema, {
+  plugins: [filePlugin],
+  printConfig: true,
+});
+
+await configDug.load();
+const config = configDug.getConfig();
+
+console.log(config.value1); // returns a string value from File
+console.log(await config.value2({ identifier: 'Some Id Value' })); // returns the targeted flag response
+```

packages/plugin-file/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@config-dug/plugin-file",
+  "version": "1.0.0-alpha.0",
+  "author": "Neo Financial Engineering <[email protected]>",
+  "description": "A file loading plugin",
+  "license": "MIT",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "type": "module",
+  "main": "./build/cjs/index.js",
+  "module": "./build/esm/index.js",
+  "types": "./build/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./build/types/index.d.ts",
+      "require": "./build/cjs/index.js",
+      "import": "./build/esm/index.js",
+      "default": "./build/cjs/index.js"
+    },
+    "./*": {
+      "types": "./build/types/*.d.ts",
+      "require": "./build/cjs/*.js",
+      "import": "./build/esm/*.js",
+      "default": "./build/cjs/*.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "build",
+    "CHANGELOG.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -b tsconfig.cjs.json tsconfig.esm.json tsconfig.types.json",
+    "watch": "tsc -b tsconfig.cjs.json tsconfig.esm.json tsconfig.types.json --watch",
+    "clean": "rimraf build",
+    "prepublishOnly": "npm run clean && npm run build"
+  },
+  "dependencies": {
+    "globby": "^11.1.0",
+    "ms": "^2.1.3"
+  },
+  "peerDependencies": {
+    "config-dug": "^2.0.0-alpha.1"
+  },
+  "devDependencies": {
+    "@tsconfig/node18": "^1.0.3",
+    "@types/debug": "^4.1.7",
+    "@types/node": "^18.11.18",
+    "debug": "^4.3.4",
+    "typescript": "^5.0.4",
+    "vitest": "^2.1.8"
+  }
+}

packages/plugin-file/src/index.ts

@@ -0,0 +1,110 @@
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import { ConfigDugOptions, ConfigDugPluginOutput, BaseConfigDugPlugin } from '../../config-dug/src/index';
+import createDebug from 'debug';
+import globby from 'globby';
+import ms from 'ms';
+
+export interface FilePluginOptions {
+  files: string[];
+  reloadInterval?: string | number;
+}
+
+const debug = createDebug('config-dug:plugin:file');
+
+class FilePlugin extends BaseConfigDugPlugin<FilePluginOptions> {
+  private configDugOptions: ConfigDugOptions | undefined;
+  private valueOrigins: Record<string, string[]> = {};
+
+  constructor(options: FilePluginOptions) {
+    super(options);
+    this.pluginOptions = options;
+  }
+
+  public override initialize = async (configDugOptions: ConfigDugOptions): Promise<void> => {
+    this.configDugOptions = configDugOptions;
+    this.initialized = true;
+  };
+
+  public load = async (): Promise<ConfigDugPluginOutput> => {
+    if (!this.initialized) {
+      throw new Error('Plugin not initialized');
+    }
+
+    if (this.configDugOptions === undefined) {
+      throw new Error('ConfigDugOptions not set');
+    }
+
+    this.valueOrigins = {};
+    let values: Record<string, unknown> = {};
+    let nextReloadIn: number | undefined;
+
+    const paths = await globby(this.pluginOptions.files);
+
+    debug('paths', paths);
+
+    for (const file of paths) {
+      if (path.extname(file) === '.js') {
+        debug('basePath', this.configDugOptions.basePath);
+        const basePath = this.configDugOptions.basePath;
+        if (!basePath) {
+          throw new Error('basePath is not set in configDugOptions');
+        }
+        const module = await import(path.join(basePath, file));
+
+        if (typeof module === 'object') {
+          values = { ...values, ...module };
+          this.recordValueOrigins(module, file);
+        }
+      } else if (path.extname(file) === '.json') {
+        const contents = await fs.readFile(file, 'utf8');
+
+        try {
+          const module = JSON.parse(contents);
+
+          if (typeof module === 'object') {
+            values = { ...values, ...module };
+            this.recordValueOrigins(module, file);
+          }
+        } catch (error) {
+          console.error('Error parsing JSON file', file, error);
+        }
+      }
+    }
+
+    nextReloadIn = this.getNextReloadInterval(this.pluginOptions.reloadInterval);
+
+    debug('plugin values', values);
+    debug('plugin value origins', this.valueOrigins);
+    debug('plugin reload in', nextReloadIn);
+
+    return {
+      values,
+      valueOrigins: this.valueOrigins,
+      nextReloadIn,
+    };
+  };
+
+  private recordValueOrigins = (values: Record<string, unknown>, origin: string) => {
+    for (const key of Object.keys(values)) {
+      if (!this.valueOrigins[key]) {
+        this.valueOrigins[key] = [];
+      }
+      if (!this.valueOrigins[key].includes(origin)) {
+        this.valueOrigins[key].push(origin);
+      }
+    }
+  };
+
+  private getNextReloadInterval(reloadInterval: string | number | undefined): number | undefined {
+    if (typeof reloadInterval === 'string') {
+      const reloadIn = ms(reloadInterval);
+
+      return reloadIn + Date.now();
+    } else if (typeof reloadInterval === 'number') {
+      return reloadInterval + Date.now();
+    }
+  }
+}
+
+export { FilePlugin };