@contractkit/openapi-to-ck 0.7.1 → 0.7.3

package/.turbo/turbo-build$colon$ci.log

@@ -1,40 +1,24 @@
-
-
-> @contractkit/openapi-to-ck@0.7.0 build:ci /Users/robert/projects/contractkit/packages/openapi-to-ck
-> eslint --max-warnings=0 && pnpm run build
-
-=============
-
-
-WARNING: You are currently running a version of TypeScript which is not officially supported by @typescript-eslint/typescript-estree.
-
-
-* @typescript-eslint/typescript-estree version: 8.57.2
-* Supported TypeScript versions: >=4.8.4 <6.0.0
-* Your TypeScript version: 6.0.2
-
-
-Please only submit bug reports when using the officially supported version.
-
-
-=============
-
-> @contractkit/openapi-to-ck@0.7.0 build /Users/robert/projects/contractkit/packages/openapi-to-ck
-> tsup src/index.ts src/plugin.ts --format esm --sourcemap --dts && tsc --emitDeclarationOnly --declaration
-
-CLI Building entry: src/index.ts, src/plugin.ts
-CLI Using tsconfig: tsconfig.json
-CLI tsup v8.5.1
-CLI Target: esnext
-ESM Build start
-ESM dist/index.js              498.00 B
-ESM dist/chunk-YP7FWA4H.js     50.65 KB
-ESM dist/plugin.js             2.51 KB
-ESM dist/index.js.map          71.00 B
-ESM dist/chunk-YP7FWA4H.js.map 117.23 KB
-ESM dist/plugin.js.map         4.95 KB
-ESM ⚡️ Build success in 71ms
-DTS Build start
-DTS ⚡️ Build success in 1043ms
-DTS dist/index.d.ts  8.29 KB
-DTS dist/plugin.d.ts 128.00 B
+
+> @contractkit/openapi-to-ck@0.7.3 build:ci /home/runner/work/ContractKit/ContractKit/packages/openapi-to-ck
+> eslint --max-warnings=0 && pnpm run build
+
+
+> @contractkit/openapi-to-ck@0.7.3 build /home/runner/work/ContractKit/ContractKit/packages/openapi-to-ck
+> tsup src/index.ts src/plugin.ts --format esm --sourcemap --dts && tsc --emitDeclarationOnly --declaration
+
+CLI Building entry: src/index.ts, src/plugin.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v8.5.1
+CLI Target: esnext
+ESM Build start
+ESM dist/index.js              498.00 B
+ESM dist/plugin.js             2.51 KB
+ESM dist/chunk-YP7FWA4H.js     50.65 KB
+ESM dist/index.js.map          71.00 B
+ESM dist/plugin.js.map         4.95 KB
+ESM dist/chunk-YP7FWA4H.js.map 117.23 KB
+ESM ⚡️ Build success in 200ms
+DTS Build start
+DTS ⚡️ Build success in 6425ms
+DTS dist/index.d.ts  8.29 KB
+DTS dist/plugin.d.ts 128.00 B

package/.turbo/turbo-test$colon$ci.log

@@ -1,77 +1,37 @@
-
-
-> @contractkit/openapi-to-ck@0.7.0 test:ci /Users/robert/projects/contractkit/packages/openapi-to-ck
-> vitest run --coverage
-
-[?25l
- RUN  v4.1.5 /Users/robert/projects/contractkit/packages/openapi-to-ck
-      Coverage enabled with v8
-
-[?2026h
- ❯ tests/convert.test.ts [queued]
-
- Test Files 0 passed (6)
-      Tests 0 passed (0)
-   Start at 08:51:09
-   Duration 205ms
-[?2026l[?2026h
- ❯ tests/convert.test.ts [queued]
- ❯ tests/normalize.test.ts [queued]
- ❯ tests/schema-to-ast.test.ts [queued]
- ❯ tests/tag-splitter.test.ts [queued]
-
- Test Files 0 passed (6)
-      Tests 0 passed (0)
-   Start at 08:51:09
-   Duration 442ms
-[?2026l[?2026h ✓ tests/circular-refs.test.ts (8 tests) 3ms
-
- ❯ tests/ast-to-ck.test.ts [queued]
- ❯ tests/convert.test.ts [queued]
- ❯ tests/normalize.test.ts [queued]
- ❯ tests/schema-to-ast.test.ts [queued]
- ❯ tests/tag-splitter.test.ts 0/5
-
- Test Files 1 passed (6)
-      Tests 8 passed (13)
-   Start at 08:51:09
-   Duration 562ms
-[?2026l[?2026h ✓ tests/normalize.test.ts (6 tests) 4ms
- ✓ tests/tag-splitter.test.ts (5 tests) 9ms
- ✓ tests/schema-to-ast.test.ts (36 tests) 9ms
- ✓ tests/ast-to-ck.test.ts (35 tests) 5ms
-
-
-
-
- ❯ tests/convert.test.ts 0/16
-
- Test Files 5 passed (6)
-      Tests 90 passed (106)
-   Start at 08:51:09
-   Duration 884ms
-[?2026l ✓ tests/convert.test.ts (16 tests) 17ms
-
- Test Files  6 passed (6)
-      Tests  106 passed (106)
-   Start at  08:51:09
-   Duration  1.13s (transform 549ms, setup 0ms, import 1.57s, tests 46ms, environment 0ms)
-
- % Coverage report from v8
--------------------|---------|----------|---------|---------|-------------------------------------------------------------
-File               | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s                                           
--------------------|---------|----------|---------|---------|-------------------------------------------------------------
-All files          |   80.49 |    70.11 |   94.69 |   82.95 |                                                             
- src               |   80.24 |    70.39 |   93.47 |   82.57 |                                                             
-  ast-to-ck.ts     |   90.65 |    82.01 |     100 |   91.91 | 82-91,168,263,295-296,311,344-345,355,415                   
-  circular-refs.ts |     100 |       90 |     100 |     100 | 20-23                                                       
-  convert.ts       |   77.19 |     87.5 |      80 |   77.77 | 83-98,112-117                                               
-  normalize.ts     |   62.96 |     56.6 |      80 |   63.33 | 79,121-163,237-255,270-271,280-309,346,350,358              
-  paths-to-ast.ts  |    81.2 |    64.48 |     100 |   85.12 | 100,125,130,140-141,149,192,206,247,277,283,320-332         
-  schema-to-ast.ts |   84.69 |       75 |   95.65 |   87.65 | 128-129,151,159,173,196-197,205-206,311-314,353-360,396-404 
-  tag-splitter.ts  |      70 |    57.14 |   81.81 |   76.47 | 63-71,137-138,141-146,162-163,171-178                       
-  warnings.ts      |     100 |      100 |     100 |     100 |                                                             
- tests             |   86.48 |       60 |     100 |   93.33 |                                                             
-  helpers.ts       |   86.48 |       60 |     100 |   93.33 | 138-139                                                     
--------------------|---------|----------|---------|---------|-------------------------------------------------------------
-[?25h
+
+> @contractkit/openapi-to-ck@0.7.3 test:ci /home/runner/work/ContractKit/ContractKit/packages/openapi-to-ck
+> vitest run --coverage
+
+
+ RUN  v4.1.5 /home/runner/work/ContractKit/ContractKit/packages/openapi-to-ck
+      Coverage enabled with v8
+
+ ✓ tests/ast-to-ck.test.ts (35 tests) 83ms
+ ✓ tests/schema-to-ast.test.ts (36 tests) 70ms
+ ✓ tests/normalize.test.ts (6 tests) 45ms
+ ✓ tests/tag-splitter.test.ts (5 tests) 53ms
+ ✓ tests/convert.test.ts (16 tests) 162ms
+ ✓ tests/circular-refs.test.ts (8 tests) 15ms
+
+ Test Files  6 passed (6)
+      Tests  106 passed (106)
+   Start at  18:49:08
+   Duration  5.30s (transform 3.09s, setup 0ms, import 6.09s, tests 428ms, environment 1ms)
+
+ % Coverage report from v8
+-------------------|---------|----------|---------|---------|-------------------------------------------------------------
+File               | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s                                           
+-------------------|---------|----------|---------|---------|-------------------------------------------------------------
+All files          |   80.49 |    70.11 |   94.69 |   82.95 |                                                             
+ src               |   80.24 |    70.39 |   93.47 |   82.57 |                                                             
+  ast-to-ck.ts     |   90.65 |    82.01 |     100 |   91.91 | 82-91,168,263,295-296,311,344-345,355,415                   
+  circular-refs.ts |     100 |       90 |     100 |     100 | 20-23                                                       
+  convert.ts       |   77.19 |     87.5 |      80 |   77.77 | 83-98,112-117                                               
+  normalize.ts     |   62.96 |     56.6 |      80 |   63.33 | 79,121-163,237-255,270-271,280-309,346,350,358              
+  paths-to-ast.ts  |    81.2 |    64.48 |     100 |   85.12 | 100,125,130,140-141,149,192,206,247,277,283,320-332         
+  schema-to-ast.ts |   84.69 |       75 |   95.65 |   87.65 | 128-129,151,159,173,196-197,205-206,311-314,353-360,396-404 
+  tag-splitter.ts  |      70 |    57.14 |   81.81 |   76.47 | 63-71,137-138,141-146,162-163,171-178                       
+  warnings.ts      |     100 |      100 |     100 |     100 |                                                             
+ tests             |   86.48 |       60 |     100 |   93.33 |                                                             
+  helpers.ts       |   86.48 |       60 |     100 |   93.33 | 138-139                                                     
+-------------------|---------|----------|---------|---------|-------------------------------------------------------------

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @contractkit/openapi-to-ck
 
+## 0.7.3
+
+### Patch Changes
+
+- Updated dependencies [7555412]
+    - @contractkit/core@0.13.0
+
+## 0.7.2
+
+### Patch Changes
+
+- Updated dependencies [876696f]
+    - @contractkit/core@0.12.0
+
 ## 0.7.1
 
 ### Patch Changes

package/README.md

@@ -0,0 +1,78 @@
+# @contractkit/openapi-to-ck
+
+Convert OpenAPI specs (2.0, 3.0, 3.1) into ContractKit `.ck` files. Useful for adopting ContractKit in projects that already have an OpenAPI document, or for round-tripping a spec through CK.
+
+## Installation
+
+```bash
+pnpm add -D @contractkit/openapi-to-ck
+```
+
+## Use as a CLI subcommand
+
+When the package is installed, the `@contractkit/cli` binary picks up an `openapi-to-ck` subcommand:
+
+```bash
+contractkit openapi-to-ck --input openapi.yaml --output contracts/
+```
+
+| Flag | Description |
+| --- | --- |
+| `--input <path>` | Path to an OpenAPI YAML or JSON file. |
+| `--output <dir>` | Directory to write `.ck` files into. |
+| `--split <single \| by-tag>` | Output mode. `by-tag` (default) writes one file per OpenAPI tag; `single` writes one combined file. |
+| `--no-comments` | Don't emit OpenAPI descriptions as `#` comments. |
+
+## Programmatic use
+
+```typescript
+import { convertOpenApiToCk } from '@contractkit/openapi-to-ck';
+
+const { files, warnings } = await convertOpenApiToCk({
+    input: 'openapi.yaml',          // file path, JSON/YAML string, or pre-parsed object
+    split: 'by-tag',                // 'single' | 'by-tag'  (default: 'by-tag')
+    includeComments: true,          // emit OpenAPI descriptions as # comments (default: true)
+    onWarning: w => console.warn(w),
+});
+
+// `files` is a Map<filename, ckSource>
+for (const [filename, source] of files) {
+    await fs.writeFile(filename, source);
+}
+```
+
+`Warning` entries carry a JSON-pointer-style `path` into the OpenAPI spec, a human-readable `message`, and a `severity` of `'info' | 'warn'`.
+
+## What's converted
+
+| OpenAPI | `.ck` |
+| --- | --- |
+| `paths` | `operation /path: { ... }` blocks |
+| `components.schemas` | `contract Name: { ... }` declarations |
+| `parameters` (path / query / header) | `params: { ... }` / `query: { ... }` / `headers: { ... }` blocks |
+| `requestBody.content[mime].schema` | `request: { mime: Type }` |
+| `responses[code].content[mime].schema` | `response: { code: { mime: Type } }` |
+| `responses[code].headers` | per-status `headers: { name: type }` |
+| `allOf` | `&` intersection on `contract` declarations |
+| `oneOf` + `discriminator` | `discriminated(by=field, A \| B)` |
+| `oneOf` / `anyOf` (no discriminator) | `\|` union |
+| `enum`, `pattern`, `minimum/maximum`, `minLength/maxLength` | type constraint args |
+
+## Other exports
+
+For tools that want to operate on the intermediate AST rather than emit `.ck` source:
+
+```typescript
+import {
+    schemasToModels,        // OpenAPI schemas → ContractKit ModelNode[]
+    pathsToRoutes,          // OpenAPI paths   → ContractKit OpRouteNode[]
+    splitByTag,             // group routes by OpenAPI tag
+    mergeIntoSingle,        // collapse roots into one
+    detectCircularRefs,     // find $ref cycles
+    extractRefName,         // "#/components/schemas/Foo" → "Foo"
+    sanitizeName,           // turn an arbitrary string into a valid CK identifier
+    normalize,              // upgrade 2.0/3.0 → 3.1 + dereference
+    astToCk,                // ContractKit AST → `.ck` source string
+    serializeType,          // ContractTypeNode → `.ck` type expression
+} from '@contractkit/openapi-to-ck';
+```

package/coverage/clover.xml

@@ -1,10 +1,10 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<coverage generated="1777467070166" clover="3.2.0">
-  <project timestamp="1777467070166" name="All files">
+<coverage generated="1777661353649" clover="3.2.0">
+  <project timestamp="1777661353649" name="All files">
     <metrics statements="839" coveredstatements="696" conditionals="753" coveredconditionals="528" methods="113" coveredmethods="107" elements="1705" coveredelements="1331" complexity="0" loc="839" ncloc="839" packages="2" files="9" classes="9"/>
     <package name="src">
       <metrics statements="809" coveredstatements="668" conditionals="733" coveredconditionals="516" methods="92" coveredmethods="86"/>
-      <file name="ast-to-ck.ts" path="/Users/robert/projects/contractkit/packages/openapi-to-ck/src/ast-to-ck.ts">
+      <file name="ast-to-ck.ts" path="/home/runner/work/ContractKit/ContractKit/packages/openapi-to-ck/src/ast-to-ck.ts">
         <metrics statements="198" coveredstatements="182" conditionals="189" coveredconditionals="155" methods="18" coveredmethods="18"/>
         <line num="17" count="2" type="stmt"/>
         <line num="27" count="47" type="cond" truecount="1" falsecount="0"/>
@@ -205,7 +205,7 @@
         <line num="413" count="1" type="stmt"/>
         <line num="415" count="0" type="stmt"/>
       </file>
-      <file name="circular-refs.ts" path="/Users/robert/projects/contractkit/packages/openapi-to-ck/src/circular-refs.ts">
+      <file name="circular-refs.ts" path="/home/runner/work/ContractKit/ContractKit/packages/openapi-to-ck/src/circular-refs.ts">
         <metrics statements="33" coveredstatements="33" conditionals="20" coveredconditionals="18" methods="5" coveredmethods="5"/>
         <line num="7" count="21" type="stmt"/>
         <line num="8" count="21" type="stmt"/>
@@ -241,7 +241,7 @@
         <line num="69" count="58" type="stmt"/>
         <line num="70" count="58" type="stmt"/>
       </file>
-      <file name="convert.ts" path="/Users/robert/projects/contractkit/packages/openapi-to-ck/src/convert.ts">
+      <file name="convert.ts" path="/home/runner/work/ContractKit/ContractKit/packages/openapi-to-ck/src/convert.ts">
         <metrics statements="54" coveredstatements="42" conditionals="24" coveredconditionals="21" methods="5" coveredmethods="4"/>
         <line num="19" count="16" type="cond" truecount="2" falsecount="0"/>
         <line num="20" count="16" type="stmt"/>
@@ -298,7 +298,7 @@
         <line num="147" count="693" type="stmt"/>
         <line num="148" count="1528" type="stmt"/>
       </file>
-      <file name="normalize.ts" path="/Users/robert/projects/contractkit/packages/openapi-to-ck/src/normalize.ts">
+      <file name="normalize.ts" path="/home/runner/work/ContractKit/ContractKit/packages/openapi-to-ck/src/normalize.ts">
         <metrics statements="150" coveredstatements="95" conditionals="159" coveredconditionals="90" methods="10" coveredmethods="8"/>
         <line num="13" count="22" type="stmt"/>
         <line num="15" count="22" type="cond" truecount="2" falsecount="0"/>
@@ -451,7 +451,7 @@
         <line num="354" count="8" type="stmt"/>
         <line num="358" count="0" type="stmt"/>
       </file>
-      <file name="paths-to-ast.ts" path="/Users/robert/projects/contractkit/packages/openapi-to-ck/src/paths-to-ast.ts">
+      <file name="paths-to-ast.ts" path="/home/runner/work/ContractKit/ContractKit/packages/openapi-to-ck/src/paths-to-ast.ts">
         <metrics statements="121" coveredstatements="103" conditionals="107" coveredconditionals="69" methods="16" coveredmethods="16"/>
         <line num="25" count="1" type="stmt"/>
         <line num="26" count="1" type="stmt"/>
@@ -575,7 +575,7 @@
         <line num="354" count="53" type="stmt"/>
         <line num="359" count="88" type="stmt"/>
       </file>
-      <file name="schema-to-ast.ts" path="/Users/robert/projects/contractkit/packages/openapi-to-ck/src/schema-to-ast.ts">
+      <file name="schema-to-ast.ts" path="/home/runner/work/ContractKit/ContractKit/packages/openapi-to-ck/src/schema-to-ast.ts">
         <metrics statements="162" coveredstatements="142" conditionals="164" coveredconditionals="123" methods="23" coveredmethods="22"/>
         <line num="25" count="2" type="stmt"/>
         <line num="29" count="2" type="stmt"/>
@@ -740,7 +740,7 @@
         <line num="427" count="3" type="stmt"/>
         <line num="430" count="40" type="cond" truecount="1" falsecount="1"/>
       </file>
-      <file name="tag-splitter.ts" path="/Users/robert/projects/contractkit/packages/openapi-to-ck/src/tag-splitter.ts">
+      <file name="tag-splitter.ts" path="/home/runner/work/ContractKit/ContractKit/packages/openapi-to-ck/src/tag-splitter.ts">
         <metrics statements="85" coveredstatements="65" conditionals="70" coveredconditionals="40" methods="11" coveredmethods="9"/>
         <line num="14" count="8" type="stmt"/>
         <line num="15" count="8" type="stmt"/>
@@ -828,7 +828,7 @@
         <line num="186" count="10" type="stmt"/>
         <line num="193" count="19" type="stmt"/>
       </file>
-      <file name="warnings.ts" path="/Users/robert/projects/contractkit/packages/openapi-to-ck/src/warnings.ts">
+      <file name="warnings.ts" path="/home/runner/work/ContractKit/ContractKit/packages/openapi-to-ck/src/warnings.ts">
         <metrics statements="6" coveredstatements="6" conditionals="0" coveredconditionals="0" methods="4" coveredmethods="4"/>
         <line num="4" count="58" type="stmt"/>
         <line num="8" count="58" type="stmt"/>
@@ -840,7 +840,7 @@
     </package>
     <package name="tests">
       <metrics statements="30" coveredstatements="28" conditionals="20" coveredconditionals="12" methods="21" coveredmethods="21"/>
-      <file name="helpers.ts" path="/Users/robert/projects/contractkit/packages/openapi-to-ck/tests/helpers.ts">
+      <file name="helpers.ts" path="/home/runner/work/ContractKit/ContractKit/packages/openapi-to-ck/tests/helpers.ts">
         <metrics statements="30" coveredstatements="28" conditionals="20" coveredconditionals="12" methods="21" coveredmethods="21"/>
         <line num="32" count="74" type="stmt"/>
         <line num="36" count="42" type="stmt"/>