AGENTS.md

1# Types Generator
2 
3Generates TypeScript types from JSON Schema files. Used by `injected/` and `special-pages/` workspaces.
4 
5## Structure
6 
7```
8build-types.mjs     # Main entry — buildTypes(config)
9json-schema.mjs     # Schema → TypeScript conversion logic
10json-schema-fs.mjs  # File system utilities for schema resolution
11unit-test/          # Unit tests
12```
13 
14## Usage
15 
16```javascript
17import { buildTypes } from "../types-generator/build-types.mjs";
18 
19const config = {
20    "featureName": {
21        "schema": "path/to/schema.json",
22        "types": "path/to/output/types.d.ts",
23        "kind": "settings"  // or "messages"
24    }
25};
26 
27buildTypes(config);  // writes directly to disk
28```
29 
30Two mapping kinds:
31- **`SettingsKind`** — schemas representing feature settings → TypeScript types
32- **`MessagesKind`** — messaging schemas → TypeScript types integrated with `@duckduckgo/messaging`
33 
34## Rules
35 
36- **Never manually edit generated `.ts` files** — they are overwritten on each run
37- The script **fails fast** — errors are not caught, to ensure visibility during type generation
38- Platform-specific exclusions can be specified per mapping entry
39 
40## Testing
41 
42```shell
43# Run from types-generator/ directory
44npm test
45```
46