@contractkit/plugin-openapi 0.8.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/.turbo/turbo-build$colon$ci.log +35 -0
  2. package/.turbo/turbo-build.log +15 -0
  3. package/.turbo/turbo-test$colon$ci.log +105 -0
  4. package/.turbo/turbo-test.log +14 -0
  5. package/CHANGELOG.md +103 -0
  6. package/README.md +78 -0
  7. package/coverage/base.css +224 -0
  8. package/coverage/block-navigation.js +87 -0
  9. package/coverage/clover.xml +403 -0
  10. package/coverage/coverage-final.json +3 -0
  11. package/coverage/favicon.png +0 -0
  12. package/coverage/index.html +131 -0
  13. package/coverage/prettify.css +1 -0
  14. package/coverage/prettify.js +2 -0
  15. package/coverage/sort-arrow-sprite.png +0 -0
  16. package/coverage/sorter.js +210 -0
  17. package/coverage/src/codegen-openapi.ts.html +2308 -0
  18. package/coverage/src/index.html +116 -0
  19. package/coverage/tests/helpers.ts.html +616 -0
  20. package/coverage/tests/index.html +116 -0
  21. package/dist/codegen-openapi.d.ts +44 -0
  22. package/dist/codegen-openapi.d.ts.map +1 -0
  23. package/dist/index.d.ts +10 -0
  24. package/dist/index.d.ts.map +1 -0
  25. package/dist/index.js +701 -0
  26. package/dist/index.js.map +1 -0
  27. package/dist/src/codegen-openapi.d.ts +38 -0
  28. package/dist/src/codegen-openapi.d.ts.map +1 -0
  29. package/dist/src/index.d.ts +4 -0
  30. package/dist/src/index.d.ts.map +1 -0
  31. package/dist/tests/codegen-openapi.test.d.ts +2 -0
  32. package/dist/tests/codegen-openapi.test.d.ts.map +1 -0
  33. package/dist/tests/helpers.d.ts +31 -0
  34. package/dist/tests/helpers.d.ts.map +1 -0
  35. package/eslint.config.js +6 -0
  36. package/package.json +43 -0
  37. package/src/codegen-openapi.ts +741 -0
  38. package/src/index.ts +43 -0
  39. package/tests/codegen-openapi.test.ts +767 -0
  40. package/tests/helpers.ts +177 -0
  41. package/tsconfig.json +9 -0
  42. package/vitest.config.ts +14 -0
package/coverage/tests/index.html ADDED
@@ -0,0 +1,116 @@
1
+
2
+ <!doctype html>
3
+ <html lang="en">
4
+
5
+ <head>
6
+ <title>Code coverage report for tests</title>
7
+ <meta charset="utf-8" />
8
+ <link rel="stylesheet" href="../prettify.css" />
9
+ <link rel="stylesheet" href="../base.css" />
10
+ <link rel="shortcut icon" type="image/x-icon" href="../favicon.png" />
11
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
12
+ <style type='text/css'>
13
+ .coverage-summary .sorter {
14
+ background-image: url(../sort-arrow-sprite.png);
15
+ }
16
+ </style>
17
+ </head>
18
+
19
+ <body>
20
+ <div class='wrapper'>
21
+ <div class='pad1'>
22
+ <h1><a href="../index.html">All files</a> tests</h1>
23
+ <div class='clearfix'>
24
+
25
+ <div class='fl pad1y space-right2'>
26
+ <span class="strong">73.33% </span>
27
+ <span class="quiet">Statements</span>
28
+ <span class='fraction'>33/45</span>
29
+ </div>
30
+
31
+
32
+ <div class='fl pad1y space-right2'>
33
+ <span class="strong">67.74% </span>
34
+ <span class="quiet">Branches</span>
35
+ <span class='fraction'>21/31</span>
36
+ </div>
37
+
38
+
39
+ <div class='fl pad1y space-right2'>
40
+ <span class="strong">76.92% </span>
41
+ <span class="quiet">Functions</span>
42
+ <span class='fraction'>20/26</span>
43
+ </div>
44
+
45
+
46
+ <div class='fl pad1y space-right2'>
47
+ <span class="strong">76.92% </span>
48
+ <span class="quiet">Lines</span>
49
+ <span class='fraction'>30/39</span>
50
+ </div>
51
+
52
+
53
+ </div>
54
+ <p class="quiet">
55
+ Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
56
+ </p>
57
+ <template id="filterTemplate">
58
+ <div class="quiet">
59
+ Filter:
60
+ <input type="search" id="fileSearch">
61
+ </div>
62
+ </template>
63
+ </div>
64
+ <div class='status-line medium'></div>
65
+ <div class="pad1">
66
+ <table class="coverage-summary">
67
+ <thead>
68
+ <tr>
69
+ <th data-col="file" data-fmt="html" data-html="true" class="file">File</th>
70
+ <th data-col="pic" data-type="number" data-fmt="html" data-html="true" class="pic"></th>
71
+ <th data-col="statements" data-type="number" data-fmt="pct" class="pct">Statements</th>
72
+ <th data-col="statements_raw" data-type="number" data-fmt="html" class="abs"></th>
73
+ <th data-col="branches" data-type="number" data-fmt="pct" class="pct">Branches</th>
74
+ <th data-col="branches_raw" data-type="number" data-fmt="html" class="abs"></th>
75
+ <th data-col="functions" data-type="number" data-fmt="pct" class="pct">Functions</th>
76
+ <th data-col="functions_raw" data-type="number" data-fmt="html" class="abs"></th>
77
+ <th data-col="lines" data-type="number" data-fmt="pct" class="pct">Lines</th>
78
+ <th data-col="lines_raw" data-type="number" data-fmt="html" class="abs"></th>
79
+ </tr>
80
+ </thead>
81
+ <tbody><tr>
82
+ <td class="file medium" data-value="helpers.ts"><a href="helpers.ts.html">helpers.ts</a></td>
83
+ <td data-value="73.33" class="pic medium">
84
+ <div class="chart"><div class="cover-fill" style="width: 73%"></div><div class="cover-empty" style="width: 27%"></div></div>
85
+ </td>
86
+ <td data-value="73.33" class="pct medium">73.33%</td>
87
+ <td data-value="45" class="abs medium">33/45</td>
88
+ <td data-value="67.74" class="pct medium">67.74%</td>
89
+ <td data-value="31" class="abs medium">21/31</td>
90
+ <td data-value="76.92" class="pct medium">76.92%</td>
91
+ <td data-value="26" class="abs medium">20/26</td>
92
+ <td data-value="76.92" class="pct medium">76.92%</td>
93
+ <td data-value="39" class="abs medium">30/39</td>
94
+ </tr>
95
+
96
+ </tbody>
97
+ </table>
98
+ </div>
99
+ <div class='push'></div><!-- for sticky footer -->
100
+ </div><!-- /wrapper -->
101
+ <div class='footer quiet pad2 space-top1 center small'>
102
+ Code coverage generated by
103
+ <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
104
+ at 2026-04-29T12:51:10.108Z
105
+ </div>
106
+ <script src="../prettify.js"></script>
107
+ <script>
108
+ window.onload = function () {
109
+ prettyPrint();
110
+ };
111
+ </script>
112
+ <script src="../sorter.js"></script>
113
+ <script src="../block-navigation.js"></script>
114
+ </body>
115
+ </html>
116
+
package/dist/codegen-openapi.d.ts ADDED
@@ -0,0 +1,44 @@
1
+ import type { ContractRootNode, OpRootNode } from '@contractkit/core';
2
+ export interface OpenApiServerEntry {
3
+ url: string;
4
+ description?: string;
5
+ }
6
+ export interface OpenApiSecurityScheme {
7
+ type: string;
8
+ scheme?: string;
9
+ bearerFormat?: string;
10
+ name?: string;
11
+ in?: string;
12
+ }
13
+ export interface OpenApiConfig {
14
+ baseDir?: string;
15
+ output?: string;
16
+ info?: {
17
+ title?: string;
18
+ version?: string;
19
+ description?: string;
20
+ };
21
+ servers?: OpenApiServerEntry[];
22
+ /** Global OpenAPI security requirements (e.g. [{ bearerAuth: [] }]). Distinct from scheme definitions. */
23
+ security?: Record<string, string[]>[];
24
+ /**
25
+ * Whether to document operations marked `internal`. Defaults to `false` — internal ops
26
+ * are omitted from the spec so external consumers don't see them. Set to `true` for an
27
+ * internal-use spec.
28
+ */
29
+ includeInternal?: boolean;
30
+ }
31
+ export interface OpenApiCodegenContext {
32
+ contractRoots: ContractRootNode[];
33
+ opRoots: OpRootNode[];
34
+ config: OpenApiConfig;
35
+ /** Named OpenAPI security scheme definitions to include in components.securitySchemes */
36
+ securitySchemes?: Record<string, OpenApiSecurityScheme>;
37
+ }
38
+ export declare function generateOpenApi(ctx: OpenApiCodegenContext): string;
39
+ /**
40
+ * Minimal YAML serializer sufficient for OpenAPI documents.
41
+ * Avoids external dependency while producing clean, readable output.
42
+ */
43
+ export declare function toYaml(value: unknown, indent?: number): string;
44
+ //# sourceMappingURL=codegen-openapi.d.ts.map
package/dist/codegen-openapi.d.ts.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"codegen-openapi.d.ts","sourceRoot":"","sources":["../src/codegen-openapi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACR,gBAAgB,EAChB,UAAU,EAOb,MAAM,mBAAmB,CAAC;AAG3B,MAAM,WAAW,kBAAkB;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,qBAAqB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,aAAa;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,WAAW,CAAC,EAAE,MAAM,CAAC;KACxB,CAAC;IACF,OAAO,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAC/B,0GAA0G;IAC1G,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;IACtC;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC7B;AA8FD,MAAM,WAAW,qBAAqB;IAClC,aAAa,EAAE,gBAAgB,EAAE,CAAC;IAClC,OAAO,EAAE,UAAU,EAAE,CAAC;IACtB,MAAM,EAAE,aAAa,CAAC;IACtB,yFAAyF;IACzF,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;CAC3D;AAED,wBAAgB,eAAe,CAAC,GAAG,EAAE,qBAAqB,GAAG,MAAM,CAoFlE;AAiZD;;;GAGG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,SAAI,GAAG,MAAM,CA+DzD"}
package/dist/index.d.ts ADDED
@@ -0,0 +1,10 @@
1
+ import type { ContractKitPlugin } from '@contractkit/core';
2
+ import type { OpenApiConfig, OpenApiSecurityScheme } from './codegen-openapi.js';
3
+ export type { OpenApiServerEntry, OpenApiConfig, OpenApiSecurityScheme } from './codegen-openapi.js';
4
+ export interface OpenApiPluginOptions extends OpenApiConfig {
5
+ securitySchemes?: Record<string, OpenApiSecurityScheme>;
6
+ }
7
+ declare const plugin: ContractKitPlugin;
8
+ export default plugin;
9
+ export declare function createOpenApiPlugin(openapiConfig: OpenApiConfig, rootDir: string, securitySchemes?: Record<string, OpenApiSecurityScheme>): ContractKitPlugin;
10
+ //# sourceMappingURL=index.d.ts.map
package/dist/index.d.ts.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAC3D,OAAO,KAAK,EAAE,aAAa,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AACjF,YAAY,EAAE,kBAAkB,EAAE,aAAa,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAErG,MAAM,WAAW,oBAAqB,SAAQ,aAAa;IACvD,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;CAC3D;AAID,QAAA,MAAM,MAAM,EAAE,iBASb,CAAC;AAEF,eAAe,MAAM,CAAC;AAItB,wBAAgB,mBAAmB,CAC/B,aAAa,EAAE,aAAa,EAC5B,OAAO,EAAE,MAAM,EACf,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,GACxD,iBAAiB,CAWnB"}