@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/src/index.ts ADDED
@@ -0,0 +1,43 @@
1
+ import { resolve } from 'node:path';
2
+ import { generateOpenApi } from './codegen-openapi.js';
3
+ import type { ContractKitPlugin } from '@contractkit/core';
4
+ import type { OpenApiConfig, OpenApiSecurityScheme } from './codegen-openapi.js';
5
+ export type { OpenApiServerEntry, OpenApiConfig, OpenApiSecurityScheme } from './codegen-openapi.js';
6
+
7
+ export interface OpenApiPluginOptions extends OpenApiConfig {
8
+ securitySchemes?: Record<string, OpenApiSecurityScheme>;
9
+ }
10
+
11
+ // ─── Default export: loaded via plugins array, reads config from ctx.options ─
12
+
13
+ const plugin: ContractKitPlugin = {
14
+ name: 'openapi',
15
+ cacheKey: 'openapi',
16
+ async generateTargets({ contractRoots, opRoots }, ctx) {
17
+ const { securitySchemes, ...openapiConfig } = ctx.options as OpenApiPluginOptions;
18
+ const base = openapiConfig.baseDir ? resolve(ctx.rootDir, openapiConfig.baseDir) : ctx.rootDir;
19
+ const outPath = resolve(base, openapiConfig.output ?? 'openapi.yaml');
20
+ ctx.emitFile(outPath, generateOpenApi({ contractRoots, opRoots, config: openapiConfig, securitySchemes }));
21
+ },
22
+ };
23
+
24
+ export default plugin;
25
+
26
+ // ─── Factory: for programmatic use with explicit config ────────────────────
27
+
28
+ export function createOpenApiPlugin(
29
+ openapiConfig: OpenApiConfig,
30
+ rootDir: string,
31
+ securitySchemes?: Record<string, OpenApiSecurityScheme>,
32
+ ): ContractKitPlugin {
33
+ return {
34
+ name: 'openapi',
35
+ cacheKey: `openapi:${JSON.stringify(openapiConfig)}`,
36
+ async generateTargets({ contractRoots, opRoots }, ctx) {
37
+ const base = openapiConfig.baseDir ? resolve(rootDir, openapiConfig.baseDir) : rootDir;
38
+ const outPath = resolve(base, openapiConfig.output ?? 'openapi.yaml');
39
+ const content = generateOpenApi({ contractRoots, opRoots, config: openapiConfig, securitySchemes });
40
+ ctx.emitFile(outPath, content);
41
+ },
42
+ };
43
+ }