@contractkit/plugin-bruno 0.9.1

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

@@ -0,0 +1,35 @@
+
+
+> @contractkit/plugin-bruno@0.9.0 build:ci /Users/robert/projects/contractkit/packages/plugin-bruno
+> 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-bruno@0.9.0 build /Users/robert/projects/contractkit/packages/plugin-bruno
+> 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.94 KB
+ESM dist/index.js.map 46.49 KB
+ESM ⚡️ Build success in 41ms
+DTS Build start
+DTS ⚡️ Build success in 622ms
+DTS dist/index.d.ts 1.37 KB

package/.turbo/turbo-build.log

@@ -0,0 +1,15 @@
+
+> @contractkit/plugin-bruno@0.9.0 build /Users/robert/projects/contractkit/packages/plugin-bruno
+> 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.94 KB
+ESM dist/index.js.map 46.49 KB
+ESM ⚡️ Build success in 69ms
+DTS Build start
+DTS ⚡️ Build success in 594ms
+DTS dist/index.d.ts 1.37 KB

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

@@ -0,0 +1,128 @@
+
+
+> @contractkit/plugin-bruno@0.9.0 test:ci /Users/robert/projects/contractkit/packages/plugin-bruno
+> vitest run --coverage
+
+[?25l
+ RUN  v4.1.5 /Users/robert/projects/contractkit/packages/plugin-bruno
+      Coverage enabled with v8
+
+[?2026h
+ ❯ tests/codegen-bruno.test.ts [queued]
+
+ Test Files 0 passed (1)
+      Tests 0 passed (0)
+   Start at 08:51:09
+   Duration 407ms
+[?2026l[?2026h
+ ❯ tests/codegen-bruno.test.ts [queued]
+
+ Test Files 0 passed (1)
+      Tests 0 passed (0)
+   Start at 08:51:09
+   Duration 927ms
+[?2026l ✓ tests/codegen-bruno.test.ts (85 tests) 11ms
+   ✓ generateOpenCollection (80)
+     ✓ generates opencollection.yml with correct spec version and collection name 2ms
+     ✓ generates Local environment file with baseUrl variable 0ms
+     ✓ emits requests for internal operations by default 0ms
+     ✓ skips internal operations when includeInternal is false 0ms
+     ✓ creates one folder per op root file 0ms
+     ✓ folder.yml has info block with name, type: folder, and seq 0ms
+     ✓ generates one .yml file per route+method combination 0ms
+     ✓ request info block has name, type: http, and seq 0ms
+     ✓ seq increments across operations within a folder 0ms
+     ✓ uses slugified name as filename when op.name is set 0ms
+     ✓ falls back to method-path filename when op.name is not set 0ms
+     ✓ uses area meta as the top-level folder name 0ms
+     ✓ falls back to filename when no area meta 0ms
+     ✓ places request files in subfolder when subarea meta is set 0ms
+     ✓ generates folder.yml for subarea with correct name 0ms
+     ✓ still generates top-level folder.yml when subarea is set 0ms
+     ✓ slugifies subarea for the folder path 0ms
+     ✓ places request files directly in folder when no subarea 0ms
+     ✓ uses {{baseUrl}} prefix and Bruno :param syntax for path params 0ms
+     ✓ generates path params as flat array entries with type: path 0ms
+     ✓ uses uuid example value for uuid path params 0ms
+     ✓ uses typed example values for scalar path params 0ms
+     ✓ uses ISO 8601 duration example value for duration path params 0ms
+     ✓ uses first enum value as example for enum path params 0ms
+     ✓ falls back to empty string for untyped path params 0ms
+     ✓ does not generate params block when path has no params and no query 0ms
+     ✓ generates query params as flat array entries with type: query 0ms
+     ✓ uses typed example values for query params 0ms
+     ✓ falls back to single placeholder entry for ref query params with no registry 0ms
+     ✓ expands ref query params into individual fields when model registry provided 0ms
+     ✓ mixes path and query params in the same flat array 0ms
+     ✓ generates headers block from op.headers inline params 0ms
+     ✓ falls back to single placeholder entry for ref header source with no registry 0ms
+     ✓ expands ref header source into individual fields when model registry provided 0ms
+     ✓ does not generate headers block when op has no headers 0ms
+     ✓ generates body with type: json and data block literal for JSON requests 0ms
+     ✓ expands inline object body type into a JSON skeleton 0ms
+     ✓ uses ISO 8601 duration example value in body skeleton 0ms
+     ✓ excludes readonly fields from inline object body skeleton 0ms
+     ✓ uses empty object for ref body types when no contractRoots provided 0ms
+     ✓ expands ref body type into a JSON skeleton when contractRoots provided 0ms
+     ✓ excludes readonly fields from expanded ref body 0ms
+     ✓ sets optional fields to null in expanded ref body 0ms
+     ✓ expands inherited fields from base model in ref body 0ms
+     ✓ uses field default value in body for non-optional fields 0ms
+     ✓ uses field default value in body for optional fields 0ms
+     ✓ uses field defaults from expanded ref model body 1ms
+     ✓ uses first enum value in body 0ms
+     ✓ uses example values for nested array fields in body 0ms
+     ✓ leaves ref fields as empty objects in body 0ms
+     ✓ generates body with type: multipart-form for multipart requests 0ms
+     ✓ does not generate body block when no request body 0ms
+     ✓ handles empty roots array 0ms
+     ✓ derives folder name from file path with directory prefix 0ms
+     ✓ does not generate any .bru files 0ms
+     ✓ adds bearer auth block to opencollection.yml when security config provided 0ms
+     ✓ adds apikey auth block to opencollection.yml 0ms
+     ✓ adds basic auth block to opencollection.yml 0ms
+     ✓ adds auth env vars to local.yml for bearer 0ms
+     ✓ does not add request or auth to opencollection.yml when no security config 0ms
+     ✓ adds auth: none inside http block when operation security is none 0ms
+     ✓ adds auth: inherit inside http block for normal operations when default scheme is set 0ms
+     ✓ does not add auth when no default scheme is set 0ms
+     ✓ emits a status-code assertion using the first declared 2xx response 0ms
+     ✓ falls back to the first response when no 2xx is declared 0ms
+     ✓ does not emit a runtime block when the operation declares no responses 0ms
+     ✓ emits assertions for required response headers and lists them in the docs 0ms
+     ✓ emits a docs block from the operation description 0ms
+     ✓ combines route and operation descriptions into the docs block 0ms
+     ✓ does not emit a docs block when no description is set 0ms
+     ✓ marks optional query params with disabled: true 0ms
+     ✓ marks optional headers with disabled: true 0ms
+     ✓ does not mark path params as disabled even though they have no optional flag 0ms
+     ✓ marks optional fields from a ref-expanded query model as disabled 0ms
+     ✓ emits a manifest listing every generated file 0ms
+     ✓ parseManifest returns [] for malformed input 0ms
+     ✓ emits Bruno faker templates for compatible scalar params when randomExamples is true 0ms
+     ✓ keeps deterministic placeholders when randomExamples is false 0ms
+     ✓ uses faker templates inside JSON body skeletons for string-valued scalars 0ms
+     ✓ does not override field defaults when randomExamples is true 0ms
+   ✓ sanitizePath (5)
+     ✓ converts simple path to filename-safe string 0ms
+     ✓ replaces path params with their names 0ms
+     ✓ handles multiple segments and params 0ms
+     ✓ returns root for bare slash 0ms
+     ✓ collapses consecutive dashes 0ms
+
+ Test Files  1 passed (1)
+      Tests  85 passed (85)
+   Start at  08:51:09
+   Duration  1.08s (transform 161ms, setup 0ms, import 586ms, tests 11ms, environment 0ms)
+
+ % Coverage report from v8
+-------------------|---------|----------|---------|---------|-------------------------------------------------------------------------------------------------
+File               | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s                                                                               
+-------------------|---------|----------|---------|---------|-------------------------------------------------------------------------------------------------
+All files          |   83.77 |    74.26 |   84.05 |   85.42 |                                                                                                 
+ src               |    86.1 |     75.1 |    90.9 |   87.54 |                                                                                                 
+  codegen-bruno.ts |    86.1 |     75.1 |    90.9 |   87.54 | 239-240,324,332,385-388,395-402,422,428,432-434,450,460,484,494-496,502-504,509,513-521,530,534 
+ tests             |   68.18 |    67.74 |      72 |   71.05 |                                                                                                 
+  helpers.ts       |   68.18 |    67.74 |      72 |   71.05 | 43-47,55-59,71,113,131-135,145                                                                  
+-------------------|---------|----------|---------|---------|-------------------------------------------------------------------------------------------------
+[?25h

package/.turbo/turbo-test.log

@@ -0,0 +1,14 @@
+
+> @contractkit/plugin-bruno@0.9.0 test /Users/robert/projects/contractkit/packages/plugin-bruno
+> vitest run
+
+
+ RUN  v4.1.5 /Users/robert/projects/contractkit/packages/plugin-bruno
+
+ ✓ tests/codegen-bruno.test.ts (85 tests) 9ms
+
+ Test Files  1 passed (1)
+      Tests  85 passed (85)
+   Start at  08:51:33
+   Duration  414ms (transform 136ms, setup 0ms, import 255ms, tests 9ms, environment 0ms)
+

package/CHANGELOG.md

@@ -0,0 +1,110 @@
+# @contractkit/contractkit-plugin-bruno
+
+## 0.9.1
+
+### Patch Changes
+
+- Updated dependencies [c9f2166]
+    - @contractkit/core@0.11.0
+
+## 0.9.0
+
+### Minor Changes
+
+- bbee232: prep for public release
+
+### Patch Changes
+
+- Updated dependencies [bbee232]
+    - @contractkit/core@0.10.0
+
+## 0.8.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.7.1
+
+### Patch Changes
+
+- Updated dependencies [d13614c]
+    - @maroonedsoftware/contractkit@0.9.0
+
+## 0.7.0
+
+### Minor Changes
+
+- 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.6.0
+
+### Minor Changes
+
+- 5d42e39: Enhance Python and TypeScript SDKs to support typed response headers. Updated the Python client to generate `TypedDict` for response headers and modified return types accordingly. The TypeScript SDK now includes runtime assertions for required headers and documents them in the generated markdown. Tests were added to verify the correct handling of response headers in both SDKs.
+
+## 0.5.1
+
+### Patch Changes
+
+- Updated dependencies [16ac3a7]
+    - @maroonedsoftware/contractkit@0.7.0
+
+## 0.5.0
+
+### Minor Changes
+
+- 5ccdeea: Enhance contractkit-plugin-bruno by adding support for random example generation in request files. Introduced a manifest file to track generated files, enabling cleanup of stale outputs while preserving user-added files. Updated README and tests to reflect these changes.
+
+## 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,80 @@
+# @contractkit/contractkit-plugin-bruno
+
+ContractKit plugin that generates a [Bruno](https://www.usebruno.com/) REST API collection from `.ck` operation files. The output is a ready-to-open OpenCollection directory.
+
+## Installation
+
+```bash
+pnpm add @contractkit/contractkit-plugin-bruno
+```
+
+## Configuration
+
+```json
+{
+  "plugins": {
+    "@contractkit/contractkit-plugin-bruno": {
+      "output": "bruno-collection",
+      "collectionName": "Acme API",
+      "auth": {
+        "defaultScheme": "bearerAuth",
+        "schemes": {
+          "bearerAuth": {
+            "type": "http",
+            "scheme": "bearer"
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+## Options
+
+| Option | Type | Default | Description |
+|---|---|---|---|
+| `baseDir` | `string` | `rootDir` | Base directory for the output |
+| `output` | `string` | `"bruno-collection"` | Output directory name |
+| `collectionName` | `string` | basename of `rootDir` | Collection name shown in Bruno |
+| `randomExamples` | `boolean` | `true` | Use Bruno faker templates (`{{$randomUUID}}`, `{{$randomEmail}}`, etc.) for compatible scalar fields so each send produces fresh data. Set to `false` for stable, deterministic placeholders. |
+| `auth.defaultScheme` | `string` | — | Key from `auth.schemes` to apply by default |
+| `auth.schemes` | `object` | — | Map of scheme name → security scheme definition |
+
+### Auth scheme types
+
+| `type` | Required fields | Description |
+|---|---|---|
+| `"http"` with `scheme: "bearer"` | — | Bearer token auth |
+| `"http"` with `scheme: "basic"` | — | HTTP Basic auth |
+| `"apiKey"` | `name`, `in` (`"header"` or `"query"`) | API key in a header or query param |
+
+## Output structure
+
+```
+bruno-collection/
+├── bruno.json             # Collection manifest
+├── environments/
+│   └── Local.bru          # Default environment with base URL variable
+└── <area>/
+    └── <operation>.bru    # One request file per HTTP verb per operation
+```
+
+The output directory is fully replaced on each run — stale request files from removed operations are automatically cleaned up.
+
+## Programmatic use
+
+```typescript
+import { createBrunoPlugin } from '@contractkit/contractkit-plugin-bruno';
+
+const plugin = createBrunoPlugin({
+  output: 'bruno-collection',
+  collectionName: 'My API',
+  auth: {
+    defaultScheme: 'bearerAuth',
+    schemes: {
+      bearerAuth: { type: 'http', scheme: 'bearer' },
+    },
+  },
+});
+```

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;
+}