@maroonedsoftware/appconfig 1.4.0 → 1.4.1

package/README.md

@@ -27,11 +27,12 @@ import { AppConfig } from '@maroonedsoftware/appconfig';
 const config = new AppConfig({
   database: { host: 'localhost', port: 5432 },
   api: { timeout: 5000 },
+  port: '3000',
 });
 
-const host = config.get('database');         // Type-safe access
-const port = config.getNumber('port');       // Returns as number
-const db = config.getAs<{ host: string }>('database'); // Cast to interface
+const database = config.get('database');                // Type-safe access
+const port = config.getNumber('port');                  // Returns 3000 as number
+const db = config.getAs<{ host: string }>('database');  // Cast to interface
 ```
 
 ### Using the Builder
@@ -309,10 +310,10 @@ const provider = new AppConfigProviderGcpSecrets('my-project-id');
 const provider = new AppConfigProviderGcpSecrets('my-project-id', /\$\{secret:([^}]+)\}/g);
 ```
 
-| Parameter   | Type               | Description                                                            |
-| ----------- | ------------------ | ---------------------------------------------------------------------- |
-| `projectId` | `string`           | The GCP project ID where secrets are stored                            |
-| `prefix`    | `string \| RegExp` | Optional regex pattern to match secret references. Default: `${gcp:*}` |
+| Parameter   | Type               | Description                                                                                  |
+| ----------- | ------------------ | -------------------------------------------------------------------------------------------- |
+| `projectId` | `string`           | The GCP project ID where secrets are stored                                                  |
+| `prefix`    | `string \| RegExp` | Optional pattern to match secret references. Default: `/\$\{gcp:(.+)\}/g` (matches `${gcp:NAME}`) |
 
 The provider:
 
@@ -369,20 +370,22 @@ class MyCustomSource implements AppConfigSource {
 ### Creating a Custom Provider
 
 ```typescript
-import { AppConfigProvider, ObjectVisitorMeta } from '@maroonedsoftware/appconfig';
+import { AppConfigProvider } from '@maroonedsoftware/appconfig';
 
 class MyCustomProvider implements AppConfigProvider {
   canParse(value: string): boolean {
     return value.startsWith('custom:');
   }
 
-  async parse(value: string, meta: ObjectVisitorMeta): Promise<void> {
+  async parse(value: string, meta): Promise<void> {
     const transformed = value.replace('custom:', '');
     (meta.owner as Record<string, unknown>)[meta.propertyPath] = transformed;
   }
 }
 ```
 
+The `meta` parameter is an `ObjectVisitorMeta` describing where the value lives in the configuration object (`owner`, `propertyPath`, `arrayIndex`, etc.). Mutate `meta.owner[meta.propertyPath]` (or `meta.owner[meta.arrayIndex]` for array entries) to write the transformed value back.
+
 ## Configuration Merging
 
 When using multiple sources, configurations are deep-merged in the order they are added. Later sources override earlier ones:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maroonedsoftware/appconfig",
-  "version": "1.4.0",
+  "version": "1.4.1",
   "description": "A flexible, type-safe configuration management library with support for multiple sources and value transformation.",
   "author": {
     "name": "Marooned Software",
@@ -31,13 +31,13 @@
   ],
   "dependencies": {
     "deepmerge-ts": "^7.1.5",
-    "dotenv": "^17.3.1",
-    "injectkit": "^1.1.3"
+    "dotenv": "^17.4.2",
+    "injectkit": "^1.2.0"
   },
   "devDependencies": {
-    "@google-cloud/secret-manager": "^6.1.1",
-    "yaml": "^2.8.3",
-    "@repo/config-eslint": "0.2.0",
+    "@google-cloud/secret-manager": "^6.1.2",
+    "yaml": "^2.8.4",
+    "@repo/config-eslint": "0.2.1",
     "@repo/config-typescript": "0.1.0"
   },
   "peerDependencies": {