@http-forge/codegen

Generate typed TypeScript API clients from HTTP Forge collections.

Features

- 🔧 CLI Tool - Generate clients from command line
- 📝 Full TypeScript Support - Autocomplete for URL, query params, headers, body
- 🔄 Variable Resolution - {{variable}} syntax supported
- 📦 Barrel Exports - Easy imports with index.ts files
- 🎯 Granular Generation - Generate all, single collection, or single request

Installation

``bash
npm install @http-forge/codegen
`

Usage

$3

`bash


Generate ALL collections

npx http-forge-codegen --input ./collections --output ./tests/api-clients

Generate SINGLE collection

npx http-forge-codegen -i ./collections -o ./api-clients -c forgerock-login

Generate SINGLE request

npx http-forge-codegen -i ./collections -o ./api-clients -r forgerock-login/login-request

With overwrite

npx http-forge-codegen -i ./collections -o ./api-clients -r forgerock-login/login-request --overwrite

Skip barrel file update

npx http-forge-codegen -i ./collections -o ./api-clients -r forgerock-login/login-request --no-barrel
`

$3

`typescript
import { generateClients, generateCollection, generateSingleRequest } from '@http-forge/codegen';

// Generate all collections
await generateClients({
input: './collections',
output: './tests/api-clients',
overwrite: true,
});

// Generate single collection
await generateCollection({
input: './collections',
output: './tests/api-clients',
collection: 'forgerock-login',
});

// Generate single request
await generateSingleRequest({
input: './collections',
output: './tests/api-clients',
request: 'forgerock-login/login-request',
});
`

Generated Structure

`
api-clients/
├── forgerock-login/
│ ├── login-request/
│ │ └── request.ts
│ ├── form-submission/
│ │ └── request.ts
│ ├── user-sessions/
│ │ └── request.ts
│ └── index.ts # barrel exports
├── user-api/
│ └── ...
└── index.ts # root barrel
`

Using Generated Clients

`typescript
import { forgerockLogin } from './api-clients';
import { createForgeEnv } from '@http-forge/codegen/env';

// Create environment
const env = createForgeEnv({
baseUrl: 'https://api.example.com',
client_id: 'my-client',
});

// Use generated client with full autocomplete!
const response = await forgerockLogin.loginRequest({
env,
query: {
client_id: 'override-client', // autocomplete works!
response_type: 'code',
},
});

// Set variables for next request
env.set('actionURL', response.json().actionURL);

// Next request uses actionURL automatically
const form = await forgerockLogin.formSubmission({
env,
body: {
username: 'test',
password: 'test123',
},
});
`

ForgeEnv API

`typescript
interface ForgeEnv {
get(key: string): string | undefined;
set(key: string, value: string): void;
has(key: string): boolean;
delete(key: string): void;
clear(): void;
getAll(): Record;
resolve(template: string): string; // {{var}} → value
resolveObject(obj: T): T; // recursive resolution
}
``

License

MIT