@contractkit/plugin-openapi 0.8.1 → 0.8.2
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.
- package/.turbo/turbo-build$colon$ci.log +19 -35
- package/.turbo/turbo-test$colon$ci.log +25 -105
- package/CHANGELOG.md +7 -0
- package/coverage/clover.xml +4 -4
- package/coverage/coverage-final.json +2 -2
- package/coverage/index.html +1 -1
- package/coverage/src/codegen-openapi.ts.html +1 -1
- package/coverage/src/index.html +1 -1
- package/coverage/tests/helpers.ts.html +1 -1
- package/coverage/tests/index.html +1 -1
- package/package.json +2 -2
- package/.turbo/turbo-build.log +0 -15
- package/.turbo/turbo-test.log +0 -14
- package/dist/src/codegen-openapi.d.ts +0 -38
- package/dist/src/codegen-openapi.d.ts.map +0 -1
- package/dist/src/index.d.ts +0 -4
- package/dist/src/index.d.ts.map +0 -1
- package/dist/tests/codegen-openapi.test.d.ts +0 -2
- package/dist/tests/codegen-openapi.test.d.ts.map +0 -1
- package/dist/tests/helpers.d.ts +0 -31
- package/dist/tests/helpers.d.ts.map +0 -1
package/coverage/index.html
CHANGED
|
@@ -116,7 +116,7 @@
|
|
|
116
116
|
<div class='footer quiet pad2 space-top1 center small'>
|
|
117
117
|
Code coverage generated by
|
|
118
118
|
<a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
|
|
119
|
-
at 2026-
|
|
119
|
+
at 2026-05-01T17:30:36.095Z
|
|
120
120
|
</div>
|
|
121
121
|
<script src="prettify.js"></script>
|
|
122
122
|
<script>
|
|
@@ -2293,7 +2293,7 @@ function yamlKey(key: string): string {
|
|
|
2293
2293
|
<div class='footer quiet pad2 space-top1 center small'>
|
|
2294
2294
|
Code coverage generated by
|
|
2295
2295
|
<a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
|
|
2296
|
-
at 2026-
|
|
2296
|
+
at 2026-05-01T17:30:36.095Z
|
|
2297
2297
|
</div>
|
|
2298
2298
|
<script src="../prettify.js"></script>
|
|
2299
2299
|
<script>
|
package/coverage/src/index.html
CHANGED
|
@@ -101,7 +101,7 @@
|
|
|
101
101
|
<div class='footer quiet pad2 space-top1 center small'>
|
|
102
102
|
Code coverage generated by
|
|
103
103
|
<a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
|
|
104
|
-
at 2026-
|
|
104
|
+
at 2026-05-01T17:30:36.095Z
|
|
105
105
|
</div>
|
|
106
106
|
<script src="../prettify.js"></script>
|
|
107
107
|
<script>
|
|
@@ -601,7 +601,7 @@ export function opRoot(routes: OpRouteNode[], file = 'users.op', meta: Record<
|
|
|
601
601
|
<div class='footer quiet pad2 space-top1 center small'>
|
|
602
602
|
Code coverage generated by
|
|
603
603
|
<a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
|
|
604
|
-
at 2026-
|
|
604
|
+
at 2026-05-01T17:30:36.095Z
|
|
605
605
|
</div>
|
|
606
606
|
<script src="../prettify.js"></script>
|
|
607
607
|
<script>
|
|
@@ -101,7 +101,7 @@
|
|
|
101
101
|
<div class='footer quiet pad2 space-top1 center small'>
|
|
102
102
|
Code coverage generated by
|
|
103
103
|
<a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
|
|
104
|
-
at 2026-
|
|
104
|
+
at 2026-05-01T17:30:36.095Z
|
|
105
105
|
</div>
|
|
106
106
|
<script src="../prettify.js"></script>
|
|
107
107
|
<script>
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@contractkit/plugin-openapi",
|
|
3
|
-
"version": "0.8.
|
|
3
|
+
"version": "0.8.2",
|
|
4
4
|
"description": "ContractKit built-in plugin: OpenAPI 3.0 YAML generation",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "Marooned Software",
|
|
@@ -26,7 +26,7 @@
|
|
|
26
26
|
".": "./dist/index.js"
|
|
27
27
|
},
|
|
28
28
|
"dependencies": {
|
|
29
|
-
"@contractkit/core": "0.
|
|
29
|
+
"@contractkit/core": "0.12.0"
|
|
30
30
|
},
|
|
31
31
|
"devDependencies": {
|
|
32
32
|
"@repo/config-eslint": "0.3.1",
|
package/.turbo/turbo-build.log
DELETED
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
> @contractkit/plugin-openapi@0.8.0 build /Users/robert/projects/contractkit/packages/plugin-openapi
|
|
3
|
-
> tsup src/index.ts --format esm --sourcemap --dts && tsc --emitDeclarationOnly --declaration
|
|
4
|
-
|
|
5
|
-
CLI Building entry: src/index.ts
|
|
6
|
-
CLI Using tsconfig: tsconfig.json
|
|
7
|
-
CLI tsup v8.5.1
|
|
8
|
-
CLI Target: esnext
|
|
9
|
-
ESM Build start
|
|
10
|
-
ESM dist/index.js 19.85 KB
|
|
11
|
-
ESM dist/index.js.map 44.92 KB
|
|
12
|
-
ESM ⚡️ Build success in 60ms
|
|
13
|
-
DTS Build start
|
|
14
|
-
DTS ⚡️ Build success in 671ms
|
|
15
|
-
DTS dist/index.d.ts 1.33 KB
|
package/.turbo/turbo-test.log
DELETED
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
> @contractkit/plugin-openapi@0.8.0 test /Users/robert/projects/contractkit/packages/plugin-openapi
|
|
3
|
-
> vitest run
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
[1m[30m[46m RUN [49m[39m[22m [36mv4.1.5 [39m[90m/Users/robert/projects/contractkit/packages/plugin-openapi[39m
|
|
7
|
-
|
|
8
|
-
[32m✓[39m tests/codegen-openapi.test.ts [2m([22m[2m53 tests[22m[2m)[22m[32m 11[2mms[22m[39m
|
|
9
|
-
|
|
10
|
-
[2m Test Files [22m [1m[32m1 passed[39m[22m[90m (1)[39m
|
|
11
|
-
[2m Tests [22m [1m[32m53 passed[39m[22m[90m (53)[39m
|
|
12
|
-
[2m Start at [22m 08:51:33
|
|
13
|
-
[2m Duration [22m 418ms[2m (transform 180ms, setup 0ms, import 274ms, tests 11ms, environment 0ms)[22m
|
|
14
|
-
|
|
@@ -1,38 +0,0 @@
|
|
|
1
|
-
import type { ContractRootNode, OpRootNode } from '@maroonedsoftware/contractkit';
|
|
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
|
-
export interface OpenApiCodegenContext {
|
|
26
|
-
contractRoots: ContractRootNode[];
|
|
27
|
-
opRoots: OpRootNode[];
|
|
28
|
-
config: OpenApiConfig;
|
|
29
|
-
/** Named OpenAPI security scheme definitions to include in components.securitySchemes */
|
|
30
|
-
securitySchemes?: Record<string, OpenApiSecurityScheme>;
|
|
31
|
-
}
|
|
32
|
-
export declare function generateOpenApi(ctx: OpenApiCodegenContext): string;
|
|
33
|
-
/**
|
|
34
|
-
* Minimal YAML serializer sufficient for OpenAPI documents.
|
|
35
|
-
* Avoids external dependency while producing clean, readable output.
|
|
36
|
-
*/
|
|
37
|
-
export declare function toYaml(value: unknown, indent?: number): string;
|
|
38
|
-
//# sourceMappingURL=codegen-openapi.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"codegen-openapi.d.ts","sourceRoot":"","sources":["../../src/codegen-openapi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,UAAU,EAAqF,MAAM,+BAA+B,CAAC;AAErK,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;CACzC;AAwFD,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,CA+ElE;AAuWD;;;GAGG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,SAAI,GAAG,MAAM,CA+DzD"}
|
package/dist/src/index.d.ts
DELETED
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
import type { OpenApiConfig, OpenApiSecurityScheme } from './codegen-openapi.js';
|
|
2
|
-
import type { ContractKitPlugin } from '@maroonedsoftware/contractkit';
|
|
3
|
-
export declare function createOpenApiPlugin(openapiConfig: OpenApiConfig, rootDir: string, securitySchemes?: Record<string, OpenApiSecurityScheme>): ContractKitPlugin;
|
|
4
|
-
//# sourceMappingURL=index.d.ts.map
|
package/dist/src/index.d.ts.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AACjF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAEvE,wBAAgB,mBAAmB,CAC/B,aAAa,EAAE,aAAa,EAC5B,OAAO,EAAE,MAAM,EACf,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,GACxD,iBAAiB,CAWnB"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"codegen-openapi.test.d.ts","sourceRoot":"","sources":["../../tests/codegen-openapi.test.ts"],"names":[],"mappings":""}
|
package/dist/tests/helpers.d.ts
DELETED
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
import type { ContractRootNode, ModelNode, FieldNode, ContractTypeNode, ScalarTypeNode, ArrayTypeNode, TupleTypeNode, RecordTypeNode, EnumTypeNode, LiteralTypeNode, UnionTypeNode, ModelRefTypeNode, InlineObjectTypeNode, LazyTypeNode, SourceLocation, OpRootNode, OpRouteNode, OpOperationNode, OpParamNode, OpRequestNode, OpResponseNode, HttpMethod, ParamSource, RouteModifier } from '@maroonedsoftware/contractkit';
|
|
2
|
-
export declare function loc(line?: number, file?: string): SourceLocation;
|
|
3
|
-
export declare function scalarType(name: ScalarTypeNode['name'], mods?: Partial<ScalarTypeNode>): ScalarTypeNode;
|
|
4
|
-
export declare function arrayType(item: ContractTypeNode, mods?: {
|
|
5
|
-
min?: number;
|
|
6
|
-
max?: number;
|
|
7
|
-
}): ArrayTypeNode;
|
|
8
|
-
export declare function tupleType(...items: ContractTypeNode[]): TupleTypeNode;
|
|
9
|
-
export declare function recordType(key: ContractTypeNode, value: ContractTypeNode): RecordTypeNode;
|
|
10
|
-
export declare function enumType(...values: string[]): EnumTypeNode;
|
|
11
|
-
export declare function literalType(value: string | number | boolean): LiteralTypeNode;
|
|
12
|
-
export declare function unionType(...members: ContractTypeNode[]): UnionTypeNode;
|
|
13
|
-
export declare function refType(name: string): ModelRefTypeNode;
|
|
14
|
-
export declare function inlineObjectType(fields: FieldNode[]): InlineObjectTypeNode;
|
|
15
|
-
export declare function lazyType(inner: ContractTypeNode): LazyTypeNode;
|
|
16
|
-
export declare function field(name: string, type: ContractTypeNode, overrides?: Partial<FieldNode>): FieldNode;
|
|
17
|
-
export declare function model(name: string, fields: FieldNode[], overrides?: Partial<ModelNode>): ModelNode;
|
|
18
|
-
export declare function contractRoot(models: ModelNode[], file?: string): ContractRootNode;
|
|
19
|
-
export declare function opParam(name: string, type: ContractTypeNode): OpParamNode;
|
|
20
|
-
export declare function paramNodes(nodes: OpParamNode[]): ParamSource;
|
|
21
|
-
export declare function paramRef(name: string): ParamSource;
|
|
22
|
-
export declare function paramType(node: ContractTypeNode): ParamSource;
|
|
23
|
-
export declare function opRequest(bodyType: string | ContractTypeNode, contentType?: OpRequestNode['contentType']): OpRequestNode;
|
|
24
|
-
export declare function opResponse(statusCode: number, bodyType?: string | ContractTypeNode, contentType?: 'application/json'): OpResponseNode;
|
|
25
|
-
export declare function opOperation(method: HttpMethod, overrides?: Partial<OpOperationNode> & {
|
|
26
|
-
query?: unknown;
|
|
27
|
-
headers?: unknown;
|
|
28
|
-
}): OpOperationNode;
|
|
29
|
-
export declare function opRoute(path: string, operations: OpOperationNode[], params?: ParamSource | OpParamNode[] | string, modifiers?: RouteModifier[]): OpRouteNode;
|
|
30
|
-
export declare function opRoot(routes: OpRouteNode[], file?: string, meta?: Record<string, string>): OpRootNode;
|
|
31
|
-
//# sourceMappingURL=helpers.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../tests/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACR,gBAAgB,EAChB,SAAS,EACT,SAAS,EACT,gBAAgB,EAChB,cAAc,EACd,aAAa,EACb,aAAa,EACb,cAAc,EACd,YAAY,EACZ,eAAe,EACf,aAAa,EACb,gBAAgB,EAChB,oBAAoB,EACpB,YAAY,EACZ,cAAc,EACd,UAAU,EACV,WAAW,EACX,eAAe,EACf,WAAW,EACX,aAAa,EACb,cAAc,EACd,UAAU,EACV,WAAW,EACX,aAAa,EAChB,MAAM,+BAA+B,CAAC;AAIvC,wBAAgB,GAAG,CAAC,IAAI,SAAI,EAAE,IAAI,SAAa,GAAG,cAAc,CAE/D;AAED,wBAAgB,UAAU,CAAC,IAAI,EAAE,cAAc,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,cAAc,CAEvG;AAED,wBAAgB,SAAS,CAAC,IAAI,EAAE,gBAAgB,EAAE,IAAI,CAAC,EAAE;IAAE,GAAG,CAAC,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,aAAa,CAEtG;AAED,wBAAgB,SAAS,CAAC,GAAG,KAAK,EAAE,gBAAgB,EAAE,GAAG,aAAa,CAErE;AAED,wBAAgB,UAAU,CAAC,GAAG,EAAE,gBAAgB,EAAE,KAAK,EAAE,gBAAgB,GAAG,cAAc,CAEzF;AAED,wBAAgB,QAAQ,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,YAAY,CAE1D;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,eAAe,CAE7E;AAED,wBAAgB,SAAS,CAAC,GAAG,OAAO,EAAE,gBAAgB,EAAE,GAAG,aAAa,CAEvE;AAED,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,gBAAgB,CAEtD;AAED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,SAAS,EAAE,GAAG,oBAAoB,CAE1E;AAED,wBAAgB,QAAQ,CAAC,KAAK,EAAE,gBAAgB,GAAG,YAAY,CAE9D;AAED,wBAAgB,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,SAAS,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,GAAG,SAAS,CAUrG;AAED,wBAAgB,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,SAAS,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,GAAG,SAAS,CAQlG;AAED,wBAAgB,YAAY,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,IAAI,SAAa,GAAG,gBAAgB,CAErF;AAED,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,GAAG,WAAW,CAEzE;AAED,wBAAgB,UAAU,CAAC,KAAK,EAAE,WAAW,EAAE,GAAG,WAAW,CAE5D;AAED,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,CAElD;AAED,wBAAgB,SAAS,CAAC,IAAI,EAAE,gBAAgB,GAAG,WAAW,CAE7D;AAED,wBAAgB,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,gBAAgB,EAAE,WAAW,GAAE,aAAa,CAAC,aAAa,CAAsB,GAAG,aAAa,CAG5I;AAED,wBAAgB,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,gBAAgB,EAAE,WAAW,CAAC,EAAE,kBAAkB,GAAG,cAAc,CAGrI;AAoBD,wBAAgB,WAAW,CAAC,MAAM,EAAE,UAAU,EAAE,SAAS,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,GAAG;IAAE,KAAK,CAAC,EAAE,OAAO,CAAC;IAAC,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,eAAe,CAU9I;AAED,wBAAgB,OAAO,CACnB,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,eAAe,EAAE,EAC7B,MAAM,CAAC,EAAE,WAAW,GAAG,WAAW,EAAE,GAAG,MAAM,EAC7C,SAAS,CAAC,EAAE,aAAa,EAAE,GAC5B,WAAW,CAGb;AAED,wBAAgB,MAAM,CAAC,MAAM,EAAE,WAAW,EAAE,EAAE,IAAI,SAAa,EAAE,IAAI,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,GAAG,UAAU,CAE9G"}
|