@http-forge/core 0.2.18 → 0.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +36 -1
- package/dist/index.d.ts +2 -1
- package/dist/index.js +370 -141
- package/dist/index.mjs +367 -138
- package/dist/infrastructure/config/config-service.d.ts +2 -1
- package/dist/infrastructure/config/config.interface.d.ts +40 -0
- package/dist/infrastructure/config/index.d.ts +1 -1
- package/dist/infrastructure/test-suite/html-report-generator.d.ts +20 -0
- package/dist/infrastructure/test-suite/result-storage-service.d.ts +2 -1
- package/dist/infrastructure/test-suite/result-storage.d.ts +2 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -571,7 +571,42 @@ The core library includes full OpenAPI 3.0.3 import and export with constraint p
|
|
|
571
571
|
- Parameters with **different constraint kinds** are wrapped in `oneOf` — each variant keeps its self-consistent schema
|
|
572
572
|
- All constraint fields round-trip without data loss
|
|
573
573
|
|
|
574
|
-
##
|
|
574
|
+
## � Exported Types
|
|
575
|
+
|
|
576
|
+
### Configuration
|
|
577
|
+
|
|
578
|
+
`HttpForgeConfig` is the shape of `http-forge.config.json`. Key sub-interfaces:
|
|
579
|
+
|
|
580
|
+
| Interface | Description |
|
|
581
|
+
|---|---|
|
|
582
|
+
| `StorageConfig` | Root/history/results paths |
|
|
583
|
+
| `RequestConfig` | Timeout, redirects, SSL |
|
|
584
|
+
| `ScriptsConfig` | Module search paths |
|
|
585
|
+
| `RunnerConfig` | Retention, index page size |
|
|
586
|
+
| `EnvironmentsConfig` | Default environment |
|
|
587
|
+
| `RestClientExportConfig` | REST Client export path/merge settings |
|
|
588
|
+
| `McpConfig` | MCP server project-level settings (see below) |
|
|
589
|
+
| `ProxyConfig` | HTTP/HTTPS proxy URLs |
|
|
590
|
+
|
|
591
|
+
**`McpConfig`** — controls what the HTTP Forge MCP server exposes to AI agents. All fields are optional; the service fills defaults automatically via `IConfigService.getMcpConfig()`.
|
|
592
|
+
|
|
593
|
+
```typescript
|
|
594
|
+
interface McpConfig {
|
|
595
|
+
excludedCollections: string[]; // IDs or names to hide (default: [] = expose all)
|
|
596
|
+
excludedSuites: string[]; // IDs or names to hide (default: [] = expose all)
|
|
597
|
+
toolPrefix: string; // Prefix for every tool name (default: "")
|
|
598
|
+
maxRequestsPerCall: number; // Safety cap per collection/suite call (default: 50)
|
|
599
|
+
cors: {
|
|
600
|
+
allowedOrigins: string[]; // CORS origins (default: ["http://localhost","http://127.0.0.1"])
|
|
601
|
+
};
|
|
602
|
+
}
|
|
603
|
+
```
|
|
604
|
+
|
|
605
|
+
Use `IConfigService.getMcpConfig()` to read the resolved config with all defaults applied.
|
|
606
|
+
|
|
607
|
+
---
|
|
608
|
+
|
|
609
|
+
## �🛠️ Use Cases
|
|
575
610
|
|
|
576
611
|
### CLI Tool
|
|
577
612
|
|
package/dist/index.d.ts
CHANGED
|
@@ -93,7 +93,8 @@ export { ExampleGenerator, HistoryAnalyzer, OpenApiExporter, OpenApiImporter, Re
|
|
|
93
93
|
export type { OpenApiExportOptions, OpenApiImportOptions, ScriptAnalysisResult } from './infrastructure/openapi';
|
|
94
94
|
export * from './infrastructure/openapi/interfaces';
|
|
95
95
|
export { CONFIG_FILES, ConfigService, DEFAULT_CONFIG, ROOT_DIRECTORIES } from './infrastructure/config';
|
|
96
|
-
export type { EnvironmentsConfig, HttpForgeConfig, IConfigService, ProxyConfig, RequestConfig, RestClientExportConfig, RunnerConfig, ScriptsConfig, StorageConfig } from './infrastructure/config';
|
|
96
|
+
export type { EnvironmentsConfig, HttpForgeConfig, IConfigService, McpConfig, McpCorsConfig, ProxyConfig, RequestConfig, RestClientExportConfig, RunnerConfig, ScriptsConfig, StorageConfig } from './infrastructure/config';
|
|
97
|
+
export { HtmlReportGenerator } from './infrastructure/test-suite/html-report-generator';
|
|
97
98
|
export { DEFAULT_SUITE_CONFIG } from './infrastructure/test-suite/interfaces';
|
|
98
99
|
export type { ErrorSummary, IStatisticsService, ITestSuiteService, RequestStatistics, RunStatistics, RunSummary, SuiteConfig, SuiteRequest, TestSuite } from './infrastructure/test-suite/interfaces';
|
|
99
100
|
export { buildResultFileName, expandSummary, HTTP_METHOD_MAP, HTTP_METHOD_REVERSE } from './infrastructure/test-suite/result-storage';
|