@contractkit/plugin-openapi 0.8.1

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

@@ -0,0 +1,35 @@
+
+
+> @contractkit/plugin-openapi@0.8.0 build:ci /Users/robert/projects/contractkit/packages/plugin-openapi
+> 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/plugin-openapi@0.8.0 build /Users/robert/projects/contractkit/packages/plugin-openapi
+> tsup src/index.ts --format esm --sourcemap --dts && tsc --emitDeclarationOnly --declaration
+
+CLI Building entry: src/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v8.5.1
+CLI Target: esnext
+ESM Build start
+ESM dist/index.js     19.85 KB
+ESM dist/index.js.map 44.92 KB
+ESM ⚡️ Build success in 38ms
+DTS Build start
+DTS ⚡️ Build success in 657ms
+DTS dist/index.d.ts 1.33 KB

package/.turbo/turbo-build.log

@@ -0,0 +1,15 @@
+
+> @contractkit/plugin-openapi@0.8.0 build /Users/robert/projects/contractkit/packages/plugin-openapi
+> tsup src/index.ts --format esm --sourcemap --dts && tsc --emitDeclarationOnly --declaration
+
+CLI Building entry: src/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v8.5.1
+CLI Target: esnext
+ESM Build start
+ESM dist/index.js     19.85 KB
+ESM dist/index.js.map 44.92 KB
+ESM ⚡️ Build success in 60ms
+DTS Build start
+DTS ⚡️ Build success in 671ms
+DTS dist/index.d.ts 1.33 KB

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

@@ -0,0 +1,105 @@
+
+
+> @contractkit/plugin-openapi@0.8.0 test:ci /Users/robert/projects/contractkit/packages/plugin-openapi
+> vitest run --coverage
+
+[?25l
+ RUN  v4.1.5 /Users/robert/projects/contractkit/packages/plugin-openapi
+      Coverage enabled with v8
+
+[?2026h
+ ❯ tests/codegen-openapi.test.ts [queued]
+
+ Test Files 0 passed (1)
+      Tests 0 passed (0)
+   Start at 08:51:09
+   Duration 204ms
+[?2026l[?2026h
+ ❯ tests/codegen-openapi.test.ts 0/53
+
+ Test Files 0 passed (1)
+      Tests 0 passed (53)
+   Start at 08:51:09
+   Duration 863ms
+[?2026l ✓ tests/codegen-openapi.test.ts (53 tests) 46ms
+   ✓ toYaml (8)
+     ✓ serializes simple scalars 1ms
+     ✓ quotes strings that look like YAML reserved words 0ms
+     ✓ quotes empty strings 0ms
+     ✓ quotes strings starting with digits 0ms
+     ✓ serializes flat objects 0ms
+     ✓ serializes nested objects 3ms
+     ✓ serializes simple arrays inline 1ms
+     ✓ serializes object arrays as block sequences 0ms
+   ✓ generateOpenApi (31)
+     ✓ document structure (5)
+       ✓ generates openapi 3.1.0 header 0ms
+       ✓ uses config info values 0ms
+       ✓ defaults title and version when not specified 0ms
+       ✓ includes servers when configured 0ms
+       ✓ includes security when configured 10ms
+     ✓ component schemas (12)
+       ✓ generates schema for simple model 6ms
+       ✓ handles optional fields by omitting from required 1ms
+       ✓ marks readonly/writeonly fields 1ms
+       ✓ handles default values 0ms
+       ✓ generates enum schema 0ms
+       ✓ generates array field schema 0ms
+       ✓ generates model with base (allOf) 0ms
+       ✓ emits one $ref per base for multi-base inheritance 0ms
+       ✓ handles scalar type constraints 0ms
+       ✓ handles record type 0ms
+       ✓ handles description on models and fields 0ms
+       ✓ emits oneOf with a discriminator block for discriminated unions 1ms
+     ✓ paths (12)
+       ✓ converts :param to {param} in paths 0ms
+       ✓ generates GET operation 0ms
+       ✓ generates POST with request body 0ms
+       ✓ generates path parameters 0ms
+       ✓ generates query parameters 0ms
+       ✓ generates header parameters 0ms
+       ✓ uses operationId from service binding 0ms
+       ✓ uses operationId from sdk name 0ms
+       ✓ generates 204 No content response 0ms
+       ✓ includes operation description 0ms
+       ✓ emits response headers 0ms
+       ✓ handles inline object response body 0ms
+     ✓ combining multiple files (2)
+       ✓ merges paths from multiple op files 0ms
+       ✓ merges schemas from multiple contract files 0ms
+   ✓ route modifiers (11)
+     ✓ internal (4)
+       ✓ excludes an internal operation from paths 0ms
+       ✓ includes internal operations when config.includeInternal is true 0ms
+       ✓ excludes all operations when route is internal 0ms
+       ✓ operation-level override on internal route makes that operation visible 0ms
+     ✓ schema filtering — internal operations (4)
+       ✓ excludes schemas only referenced by internal operations 0ms
+       ✓ transitively includes schemas referenced by public types 0ms
+       ✓ excludes all schemas when all operations are internal 0ms
+       ✓ includes all schemas when there are no op files 0ms
+     ✓ deprecated (3)
+       ✓ sets deprecated: true for a deprecated operation 0ms
+       ✓ does not set deprecated for a normal operation 0ms
+       ✓ cascades route-level deprecated to all operations 0ms
+   ✓ options-level header globals (3)
+     ✓ renders global response headers on every status code, including bodyless and 4xx/5xx 3ms
+     ✓ omits global response headers on a status code that opts out via headers: none 1ms
+     ✓ renders global request headers as parameters on every operation 9ms
+
+ Test Files  1 passed (1)
+      Tests  53 passed (53)
+   Start at  08:51:09
+   Duration  1.02s (transform 161ms, setup 0ms, import 651ms, tests 46ms, environment 0ms)
+
+ % Coverage report from v8
+---------------------|---------|----------|---------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------
+File                 | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s                                                                                                                                
+---------------------|---------|----------|---------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------
+All files            |   78.88 |    74.52 |   82.25 |   81.03 |                                                                                                                                                  
+ src                 |    79.5 |    75.26 |   86.11 |    81.5 |                                                                                                                                                  
+  codegen-openapi.ts |    79.5 |    75.26 |   86.11 |    81.5 | 56-60,67-68,78-79,85,278,288,302,315,323,345,351,363-364,376-377,382-385,392-394,399-409,415-417,424-437,468-474,525,567,588-609,669-672,696,706 
+ tests               |   73.33 |    67.74 |   76.92 |   76.92 |                                                                                                                                                  
+  helpers.ts         |   73.33 |    67.74 |   76.92 |   76.92 | 44,60,76,110-118,138,149-150                                                                                                                     
+---------------------|---------|----------|---------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------
+[?25h

package/.turbo/turbo-test.log

@@ -0,0 +1,14 @@
+
+> @contractkit/plugin-openapi@0.8.0 test /Users/robert/projects/contractkit/packages/plugin-openapi
+> vitest run
+
+
+ RUN  v4.1.5 /Users/robert/projects/contractkit/packages/plugin-openapi
+
+ ✓ tests/codegen-openapi.test.ts (53 tests) 11ms
+
+ Test Files  1 passed (1)
+      Tests  53 passed (53)
+   Start at  08:51:33
+   Duration  418ms (transform 180ms, setup 0ms, import 274ms, tests 11ms, environment 0ms)
+

package/CHANGELOG.md

@@ -0,0 +1,103 @@
+# @contractkit/contractkit-plugin-openapi
+
+## 0.8.1
+
+### Patch Changes
+
+- Updated dependencies [c9f2166]
+    - @contractkit/core@0.11.0
+
+## 0.8.0
+
+### Minor Changes
+
+- bbee232: prep for public release
+
+### Patch Changes
+
+- Updated dependencies [bbee232]
+    - @contractkit/core@0.10.0
+
+## 0.7.0
+
+### Minor Changes
+
+- e27b771: Add an `includeInternal: boolean` config option to every plugin so consumers can override whether `internal` operations are emitted. Defaults preserve today's behavior: server router and Bruno default to `true` (include); TS SDK, Python SDK, OpenAPI, and Markdown default to `false` (exclude).
+
+## 0.6.1
+
+### Patch Changes
+
+- Updated dependencies [d13614c]
+    - @maroonedsoftware/contractkit@0.9.0
+
+## 0.6.0
+
+### Minor Changes
+
+- 353aa10: Implement options-level header globals for request and response in the contract DSL. This update allows headers to be declared at the file level, merging them into every operation's request and response. Added normalization logic to handle header collisions and opt-out scenarios. Updated documentation and tests to reflect these changes, ensuring proper round-trip formatting and validation of headers.
+- 888ded5: Enhance contract DSL with multi-base inheritance support and override modifier. This update introduces the ability to declare multiple base contracts, along with validation rules for field conflicts across bases. The `override` modifier is now required for redeclaring conflicting fields, and the documentation has been updated to reflect these changes. Tests have been added to ensure correct behavior for inheritance and modifier usage.
+
+### Patch Changes
+
+- Updated dependencies [353aa10]
+- Updated dependencies [888ded5]
+    - @maroonedsoftware/contractkit@0.8.0
+
+## 0.5.0
+
+### Minor Changes
+
+- 16ac3a7: Implement support for typed response headers in API operations. Added functionality to declare headers alongside response bodies, affecting OpenAPI, TypeScript SDK, and Markdown documentation generation. Updated related tests to ensure correct parsing and rendering of response headers, including handling optional headers and duplicate declarations.
+
+### Patch Changes
+
+- Updated dependencies [16ac3a7]
+    - @maroonedsoftware/contractkit@0.7.0
+
+## 0.4.1
+
+### Patch Changes
+
+- Updated dependencies [d3ea773]
+    - @maroonedsoftware/contractkit@0.6.0
+
+## 0.4.0
+
+### Minor Changes
+
+- 181dadb: Refactor request handling to support multiple content types in operations. Updated OpRequestNode to accept an array of bodies, modified related functions and tests to accommodate multi-MIME requests, and enhanced validation for nested structures in URL-encoded bodies. Improved code generation across various plugins to handle new request structure.
+
+### Patch Changes
+
+- Updated dependencies [181dadb]
+    - @maroonedsoftware/contractkit@0.5.0
+
+## 0.3.0
+
+### Minor Changes
+
+- ada5f84: Implement discriminated unions in ContractKit with validation and code generation support. Update README and tests to reflect new functionality, including parsing, rendering, and OpenAPI generation for discriminated unions.
+
+### Patch Changes
+
+- Updated dependencies [ada5f84]
+    - @maroonedsoftware/contractkit@0.4.0
+
+## 0.2.1
+
+### Patch Changes
+
+- Updated dependencies [f396a68]
+    - @maroonedsoftware/contractkit@0.3.0
+
+## 0.2.0
+
+### Minor Changes
+
+- db7345b: updating to contractkit as the org
+
+### Patch Changes
+
+- Updated dependencies [db7345b]
+    - @contractkit/core@0.2.0

package/README.md

@@ -0,0 +1,78 @@
+# @contractkit/contractkit-plugin-openapi
+
+ContractKit plugin that generates an OpenAPI 3.0 YAML specification from `.ck` contract and operation files.
+
+## Installation
+
+```bash
+pnpm add @contractkit/contractkit-plugin-openapi
+```
+
+## Configuration
+
+```json
+{
+  "plugins": {
+    "@contractkit/contractkit-plugin-openapi": {
+      "output": "openapi.yaml",
+      "info": {
+        "title": "Acme API",
+        "version": "1.0.0",
+        "description": "Public API for Acme services"
+      },
+      "servers": [
+        { "url": "https://api.acme.com", "description": "Production" },
+        { "url": "https://api.staging.acme.com", "description": "Staging" }
+      ],
+      "security": [{ "bearerAuth": [] }],
+      "securitySchemes": {
+        "bearerAuth": {
+          "type": "http",
+          "scheme": "bearer",
+          "bearerFormat": "JWT"
+        }
+      }
+    }
+  }
+}
+```
+
+## Options
+
+| Option | Type | Default | Description |
+|---|---|---|---|
+| `baseDir` | `string` | `rootDir` | Base directory for the output file |
+| `output` | `string` | `"openapi.yaml"` | Output file path |
+| `info.title` | `string` | — | API title in the `info` block |
+| `info.version` | `string` | — | API version in the `info` block |
+| `info.description` | `string` | — | API description in the `info` block |
+| `servers` | `array` | — | List of server objects (`url`, optional `description`) |
+| `security` | `array` | — | Global security requirements (e.g. `[{ "bearerAuth": [] }]`) |
+| `securitySchemes` | `object` | — | Security scheme definitions added to `components.securitySchemes` |
+
+### Security scheme types
+
+| `type` | Required fields | Description |
+|---|---|---|
+| `"http"` | `scheme` (`"bearer"` or `"basic"`), optional `bearerFormat` | HTTP auth (Bearer JWT, Basic, etc.) |
+| `"apiKey"` | `name`, `in` (`"header"` or `"query"`) | API key passed in a header or query param |
+| `"oauth2"` | — | OAuth 2.0 |
+| `"openIdConnect"` | — | OpenID Connect |
+
+## Output
+
+The plugin writes a single YAML file. All `contract` declarations become entries in `components/schemas`. All `operation` declarations become paths with their HTTP verbs, request bodies, parameters, and response schemas.
+
+Operations marked `internal` are omitted from the generated spec by default. Set `includeInternal: true` in the plugin config to include them (e.g. for an internal-use API spec).
+
+## Programmatic use
+
+```typescript
+import { createOpenApiPlugin } from '@contractkit/contractkit-plugin-openapi';
+
+const plugin = createOpenApiPlugin({
+  output: 'dist/openapi.yaml',
+  info: { title: 'My API', version: '2.0.0' },
+  servers: [{ url: 'https://api.example.com' }],
+});
+```

package/coverage/base.css

@@ -0,0 +1,224 @@
+body, html {
+  margin:0; padding: 0;
+  height: 100%;
+}
+body {
+    font-family: Helvetica Neue, Helvetica, Arial;
+    font-size: 14px;
+    color:#333;
+}
+.small { font-size: 12px; }
+*, *:after, *:before {
+  -webkit-box-sizing:border-box;
+     -moz-box-sizing:border-box;
+          box-sizing:border-box;
+  }
+h1 { font-size: 20px; margin: 0;}
+h2 { font-size: 14px; }
+pre {
+    font: 12px/1.4 Consolas, "Liberation Mono", Menlo, Courier, monospace;
+    margin: 0;
+    padding: 0;
+    -moz-tab-size: 2;
+    -o-tab-size:  2;
+    tab-size: 2;
+}
+a { color:#0074D9; text-decoration:none; }
+a:hover { text-decoration:underline; }
+.strong { font-weight: bold; }
+.space-top1 { padding: 10px 0 0 0; }
+.pad2y { padding: 20px 0; }
+.pad1y { padding: 10px 0; }
+.pad2x { padding: 0 20px; }
+.pad2 { padding: 20px; }
+.pad1 { padding: 10px; }
+.space-left2 { padding-left:55px; }
+.space-right2 { padding-right:20px; }
+.center { text-align:center; }
+.clearfix { display:block; }
+.clearfix:after {
+  content:'';
+  display:block;
+  height:0;
+  clear:both;
+  visibility:hidden;
+  }
+.fl { float: left; }
+@media only screen and (max-width:640px) {
+  .col3 { width:100%; max-width:100%; }
+  .hide-mobile { display:none!important; }
+}
+
+.quiet {
+  color: #7f7f7f;
+  color: rgba(0,0,0,0.5);
+}
+.quiet a { opacity: 0.7; }
+
+.fraction {
+  font-family: Consolas, 'Liberation Mono', Menlo, Courier, monospace;
+  font-size: 10px;
+  color: #555;
+  background: #E8E8E8;
+  padding: 4px 5px;
+  border-radius: 3px;
+  vertical-align: middle;
+}
+
+div.path a:link, div.path a:visited { color: #333; }
+table.coverage {
+  border-collapse: collapse;
+  margin: 10px 0 0 0;
+  padding: 0;
+}
+
+table.coverage td {
+  margin: 0;
+  padding: 0;
+  vertical-align: top;
+}
+table.coverage td.line-count {
+    text-align: right;
+    padding: 0 5px 0 20px;
+}
+table.coverage td.line-coverage {
+    text-align: right;
+    padding-right: 10px;
+    min-width:20px;
+}
+
+table.coverage td span.cline-any {
+    display: inline-block;
+    padding: 0 5px;
+    width: 100%;
+}
+.missing-if-branch {
+    display: inline-block;
+    margin-right: 5px;
+    border-radius: 3px;
+    position: relative;
+    padding: 0 4px;
+    background: #333;
+    color: yellow;
+}
+
+.skip-if-branch {
+    display: none;
+    margin-right: 10px;
+    position: relative;
+    padding: 0 4px;
+    background: #ccc;
+    color: white;
+}
+.missing-if-branch .typ, .skip-if-branch .typ {
+    color: inherit !important;
+}
+.coverage-summary {
+  border-collapse: collapse;
+  width: 100%;
+}
+.coverage-summary tr { border-bottom: 1px solid #bbb; }
+.keyline-all { border: 1px solid #ddd; }
+.coverage-summary td, .coverage-summary th { padding: 10px; }
+.coverage-summary tbody { border: 1px solid #bbb; }
+.coverage-summary td { border-right: 1px solid #bbb; }
+.coverage-summary td:last-child { border-right: none; }
+.coverage-summary th {
+  text-align: left;
+  font-weight: normal;
+  white-space: nowrap;
+}
+.coverage-summary th.file { border-right: none !important; }
+.coverage-summary th.pct { }
+.coverage-summary th.pic,
+.coverage-summary th.abs,
+.coverage-summary td.pct,
+.coverage-summary td.abs { text-align: right; }
+.coverage-summary td.file { white-space: nowrap;  }
+.coverage-summary td.pic { min-width: 120px !important;  }
+.coverage-summary tfoot td { }
+
+.coverage-summary .sorter {
+    height: 10px;
+    width: 7px;
+    display: inline-block;
+    margin-left: 0.5em;
+    background: url(sort-arrow-sprite.png) no-repeat scroll 0 0 transparent;
+}
+.coverage-summary .sorted .sorter {
+    background-position: 0 -20px;
+}
+.coverage-summary .sorted-desc .sorter {
+    background-position: 0 -10px;
+}
+.status-line {  height: 10px; }
+/* yellow */
+.cbranch-no { background: yellow !important; color: #111; }
+/* dark red */
+.red.solid, .status-line.low, .low .cover-fill { background:#C21F39 }
+.low .chart { border:1px solid #C21F39 }
+.highlighted,
+.highlighted .cstat-no, .highlighted .fstat-no, .highlighted .cbranch-no{
+  background: #C21F39 !important;
+}
+/* medium red */
+.cstat-no, .fstat-no, .cbranch-no, .cbranch-no { background:#F6C6CE }
+/* light red */
+.low, .cline-no { background:#FCE1E5 }
+/* light green */
+.high, .cline-yes { background:rgb(230,245,208) }
+/* medium green */
+.cstat-yes { background:rgb(161,215,106) }
+/* dark green */
+.status-line.high, .high .cover-fill { background:rgb(77,146,33) }
+.high .chart { border:1px solid rgb(77,146,33) }
+/* dark yellow (gold) */
+.status-line.medium, .medium .cover-fill { background: #f9cd0b; }
+.medium .chart { border:1px solid #f9cd0b; }
+/* light yellow */
+.medium { background: #fff4c2; }
+
+.cstat-skip { background: #ddd; color: #111; }
+.fstat-skip { background: #ddd; color: #111 !important; }
+.cbranch-skip { background: #ddd !important; color: #111; }
+
+span.cline-neutral { background: #eaeaea; }
+
+.coverage-summary td.empty {
+    opacity: .5;
+    padding-top: 4px;
+    padding-bottom: 4px;
+    line-height: 1;
+    color: #888;
+}
+
+.cover-fill, .cover-empty {
+  display:inline-block;
+  height: 12px;
+}
+.chart {
+  line-height: 0;
+}
+.cover-empty {
+    background: white;
+}
+.cover-full {
+    border-right: none !important;
+}
+pre.prettyprint {
+    border: none !important;
+    padding: 0 !important;
+    margin: 0 !important;
+}
+.com { color: #999 !important; }
+.ignore-none { color: #999; font-weight: normal; }
+
+.wrapper {
+  min-height: 100%;
+  height: auto !important;
+  height: 100%;
+  margin: 0 auto -48px;
+}
+.footer, .push {
+  height: 48px;
+}

package/coverage/block-navigation.js

@@ -0,0 +1,87 @@
+/* eslint-disable */
+var jumpToCode = (function init() {
+    // Classes of code we would like to highlight in the file view
+    var missingCoverageClasses = ['.cbranch-no', '.cstat-no', '.fstat-no'];
+
+    // Elements to highlight in the file listing view
+    var fileListingElements = ['td.pct.low'];
+
+    // We don't want to select elements that are direct descendants of another match
+    var notSelector = ':not(' + missingCoverageClasses.join('):not(') + ') > '; // becomes `:not(a):not(b) > `
+
+    // Selector that finds elements on the page to which we can jump
+    var selector =
+        fileListingElements.join(', ') +
+        ', ' +
+        notSelector +
+        missingCoverageClasses.join(', ' + notSelector); // becomes `:not(a):not(b) > a, :not(a):not(b) > b`
+
+    // The NodeList of matching elements
+    var missingCoverageElements = document.querySelectorAll(selector);
+
+    var currentIndex;
+
+    function toggleClass(index) {
+        missingCoverageElements
+            .item(currentIndex)
+            .classList.remove('highlighted');
+        missingCoverageElements.item(index).classList.add('highlighted');
+    }
+
+    function makeCurrent(index) {
+        toggleClass(index);
+        currentIndex = index;
+        missingCoverageElements.item(index).scrollIntoView({
+            behavior: 'smooth',
+            block: 'center',
+            inline: 'center'
+        });
+    }
+
+    function goToPrevious() {
+        var nextIndex = 0;
+        if (typeof currentIndex !== 'number' || currentIndex === 0) {
+            nextIndex = missingCoverageElements.length - 1;
+        } else if (missingCoverageElements.length > 1) {
+            nextIndex = currentIndex - 1;
+        }
+
+        makeCurrent(nextIndex);
+    }
+
+    function goToNext() {
+        var nextIndex = 0;
+
+        if (
+            typeof currentIndex === 'number' &&
+            currentIndex < missingCoverageElements.length - 1
+        ) {
+            nextIndex = currentIndex + 1;
+        }
+
+        makeCurrent(nextIndex);
+    }
+
+    return function jump(event) {
+        if (
+            document.getElementById('fileSearch') === document.activeElement &&
+            document.activeElement != null
+        ) {
+            // if we're currently focused on the search input, we don't want to navigate
+            return;
+        }
+
+        switch (event.which) {
+            case 78: // n
+            case 74: // j
+                goToNext();
+                break;
+            case 66: // b
+            case 75: // k
+            case 80: // p
+                goToPrevious();
+                break;
+        }
+    };
+})();
+window.addEventListener('keydown', jumpToCode);