@http-forge/core 0.2.3 → 0.2.5

package/README.md

@@ -14,6 +14,7 @@
 - 📝 **JavaScript Scripting** - Pre-request and post-response scripts with full `pm.*` API (variables, assertions, execution flow, visualizer)
 - 🔄 **Dynamic Variables** - Built-in generators: `{{$randomInt}}`, `{{$timestamp}}`, `{{$uuid}}`, `{{$guid}}`, etc.
 - 🌍 **Environments** - Full variable scoping (globals, collection, environment, session, iterationData)
+- 👁️ **File Watching** - Automatic reload on collection/environment file changes with notification callbacks
 - 🍪 **Cookie Persistence** - Automatic cookie storage and reuse, `pm.cookies.jar()` and `.toObject()`
 - 📊 **Test Assertions** - BDD-style testing with `pm.test()` (sync/async) and full Chai `expect()` chains
 - 🔐 **CryptoJS** - Full crypto library: hash, HMAC, AES/DES/TripleDES, PBKDF2, encoding helpers
@@ -77,6 +78,25 @@ forge.setEnvironment({
 const result = await forge.execute(request, collection);
 ```
 
+### URL Path Parameters
+
+If your request URL uses Express-style route parameters, provide values using the request `params` field.
+
+```typescript
+const request = {
+    name: 'Redirect Test',
+    method: 'GET',
+    url: '{{baseUrl}}/redirect/:redirectNumber',
+    params: {
+        redirectNumber: '3'
+    }
+};
+
+const result = await forge.execute(request, collection);
+```
+
+The engine will substitute `:redirectNumber` before execution, while still resolving environment variables and dynamic template expressions.
+
 ### With Custom Configuration
 
 ```typescript
@@ -391,6 +411,9 @@ interface ForgeContainerOptions {
     // History
     enableHistory?: boolean;         // Enable request history
     maxHistoryEntries?: number;      // Max history size
+    
+    // File Watching
+    fileWatcherFactory?: IFileWatcherFactory; // Watch for collection/environment file changes
 }
 ```
 
@@ -614,9 +637,11 @@ my-api/
   requests/
     login/
       request.json
+      doc.md               # Optional request documentation (Markdown)
     users/
       get-users/
         request.json
+        doc.md
       create-user/
         request.json
 ```
@@ -637,6 +662,14 @@ MIT © Henry Huang
 
 ## 📝 Changelog
 
+### 0.2.4 (File Watching & Request Documentation)
+
+- ✅ **File watching for CollectionService** - Automatic reload and `onCollectionsChanged` callback when collection files change on disk
+- ✅ **File watching for EnvironmentConfigService** - Automatic reload and `onEnvironmentsChanged` callback when environment JSON files change on disk
+- ✅ **Request documentation (`doc.md`)** - Persist per-request Markdown documentation as `doc.md` alongside `request.json`
+- ✅ **`doc` field on UnifiedRequest / CollectionRequest** - Optional `doc?: string` field for request documentation content
+- ✅ **`fileWatcherFactory` bootstrap option** - Pass `IFileWatcherFactory` to enable file watching in both collection and environment services
+
 ### 0.2.0 (Postman API Parity)
 
 - ✅ **Async `pm.test()` support** - Tests with async callbacks are properly awaited