@contractkit/openapi-to-ck 0.7.7 → 0.7.8
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 +6 -6
- package/.turbo/turbo-test$colon$ci.log +13 -13
- package/CHANGELOG.md +33 -0
- package/coverage/clover.xml +12 -18
- package/coverage/coverage-final.json +2 -2
- package/coverage/index.html +14 -14
- package/coverage/src/ast-to-ck.ts.html +8 -8
- package/coverage/src/circular-refs.ts.html +1 -1
- package/coverage/src/convert.ts.html +1 -1
- package/coverage/src/index.html +17 -17
- package/coverage/src/normalize.ts.html +1 -1
- package/coverage/src/paths-to-ast.ts.html +11 -47
- package/coverage/src/schema-to-ast.ts.html +1 -1
- package/coverage/src/tag-splitter.ts.html +1 -1
- package/coverage/src/warnings.ts.html +1 -1
- package/coverage/tests/helpers.ts.html +1 -1
- package/coverage/tests/index.html +1 -1
- package/dist/{chunk-YP7FWA4H.js → chunk-T2G2WRZ2.js} +6 -19
- package/dist/chunk-T2G2WRZ2.js.map +1 -0
- package/dist/index.js +1 -1
- package/dist/plugin.js +1 -1
- package/package.json +2 -2
- package/src/ast-to-ck.ts +5 -5
- package/src/paths-to-ast.ts +3 -15
- package/tests/ast-to-ck.test.ts +3 -3
- package/dist/chunk-YP7FWA4H.js.map +0 -1
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
|
|
2
|
-
> @contractkit/openapi-to-ck@0.7.
|
|
2
|
+
> @contractkit/openapi-to-ck@0.7.8 build:ci /home/runner/work/ContractKit/ContractKit/packages/openapi-to-ck
|
|
3
3
|
> eslint --max-warnings=0 && pnpm run build
|
|
4
4
|
|
|
5
5
|
|
|
6
|
-
> @contractkit/openapi-to-ck@0.7.
|
|
6
|
+
> @contractkit/openapi-to-ck@0.7.8 build /home/runner/work/ContractKit/ContractKit/packages/openapi-to-ck
|
|
7
7
|
> tsup src/index.ts src/plugin.ts --format esm --sourcemap --dts && tsc --emitDeclarationOnly --declaration
|
|
8
8
|
|
|
9
9
|
[34mCLI[39m Building entry: src/index.ts, src/plugin.ts
|
|
@@ -13,12 +13,12 @@
|
|
|
13
13
|
[34mESM[39m Build start
|
|
14
14
|
[32mESM[39m [1mdist/index.js [22m[32m498.00 B[39m
|
|
15
15
|
[32mESM[39m [1mdist/plugin.js [22m[32m2.51 KB[39m
|
|
16
|
-
[32mESM[39m [1mdist/chunk-
|
|
16
|
+
[32mESM[39m [1mdist/chunk-T2G2WRZ2.js [22m[32m50.36 KB[39m
|
|
17
17
|
[32mESM[39m [1mdist/index.js.map [22m[32m71.00 B[39m
|
|
18
18
|
[32mESM[39m [1mdist/plugin.js.map [22m[32m4.95 KB[39m
|
|
19
|
-
[32mESM[39m [1mdist/chunk-
|
|
20
|
-
[32mESM[39m ⚡️ Build success in
|
|
19
|
+
[32mESM[39m [1mdist/chunk-T2G2WRZ2.js.map [22m[32m116.56 KB[39m
|
|
20
|
+
[32mESM[39m ⚡️ Build success in 191ms
|
|
21
21
|
[34mDTS[39m Build start
|
|
22
|
-
[32mDTS[39m ⚡️ Build success in
|
|
22
|
+
[32mDTS[39m ⚡️ Build success in 6387ms
|
|
23
23
|
[32mDTS[39m [1mdist/index.d.ts [22m[32m8.29 KB[39m
|
|
24
24
|
[32mDTS[39m [1mdist/plugin.d.ts [22m[32m128.00 B[39m
|
|
@@ -1,34 +1,34 @@
|
|
|
1
1
|
|
|
2
|
-
> @contractkit/openapi-to-ck@0.7.
|
|
2
|
+
> @contractkit/openapi-to-ck@0.7.8 test:ci /home/runner/work/ContractKit/ContractKit/packages/openapi-to-ck
|
|
3
3
|
> vitest run --coverage
|
|
4
4
|
|
|
5
5
|
|
|
6
6
|
[1m[30m[46m RUN [49m[39m[22m [36mv4.1.5 [39m[90m/home/runner/work/ContractKit/ContractKit/packages/openapi-to-ck[39m
|
|
7
7
|
[2mCoverage enabled with [22m[33mv8[39m
|
|
8
8
|
|
|
9
|
-
[32m✓[39m tests/ast-to-ck.test.ts [2m([22m[2m35 tests[22m[2m)[22m[32m
|
|
10
|
-
[32m✓[39m tests/schema-to-ast.test.ts [2m([22m[2m36 tests[22m[2m)[22m[32m
|
|
11
|
-
[32m✓[39m tests/normalize.test.ts [2m([22m[2m6 tests[22m[2m)[22m[32m
|
|
12
|
-
[32m✓[39m tests/tag-splitter.test.ts [2m([22m[2m5 tests[22m[2m)[22m[32m
|
|
13
|
-
[32m✓[39m tests/circular-refs.test.ts [2m([22m[2m8 tests[22m[2m)[22m[32m
|
|
14
|
-
[32m✓[39m tests/convert.test.ts [2m([22m[2m16 tests[22m[2m)[22m[32m
|
|
9
|
+
[32m✓[39m tests/ast-to-ck.test.ts [2m([22m[2m35 tests[22m[2m)[22m[32m 79[2mms[22m[39m
|
|
10
|
+
[32m✓[39m tests/schema-to-ast.test.ts [2m([22m[2m36 tests[22m[2m)[22m[32m 44[2mms[22m[39m
|
|
11
|
+
[32m✓[39m tests/normalize.test.ts [2m([22m[2m6 tests[22m[2m)[22m[32m 91[2mms[22m[39m
|
|
12
|
+
[32m✓[39m tests/tag-splitter.test.ts [2m([22m[2m5 tests[22m[2m)[22m[32m 94[2mms[22m[39m
|
|
13
|
+
[32m✓[39m tests/circular-refs.test.ts [2m([22m[2m8 tests[22m[2m)[22m[32m 24[2mms[22m[39m
|
|
14
|
+
[32m✓[39m tests/convert.test.ts [2m([22m[2m16 tests[22m[2m)[22m[32m 142[2mms[22m[39m
|
|
15
15
|
|
|
16
16
|
[2m Test Files [22m [1m[32m6 passed[39m[22m[90m (6)[39m
|
|
17
17
|
[2m Tests [22m [1m[32m106 passed[39m[22m[90m (106)[39m
|
|
18
|
-
[2m Start at [22m
|
|
19
|
-
[2m Duration [22m
|
|
18
|
+
[2m Start at [22m 13:02:53
|
|
19
|
+
[2m Duration [22m 4.97s[2m (transform 2.41s, setup 0ms, import 5.49s, tests 474ms, environment 1ms)[22m
|
|
20
20
|
|
|
21
21
|
[34m % [39m[2mCoverage report from [22m[33mv8[39m
|
|
22
22
|
-------------------|---------|----------|---------|---------|-------------------------------------------------------------
|
|
23
23
|
File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s
|
|
24
24
|
-------------------|---------|----------|---------|---------|-------------------------------------------------------------
|
|
25
|
-
All files |
|
|
26
|
-
src | 80.
|
|
27
|
-
ast-to-ck.ts | 90.65 |
|
|
25
|
+
All files | 81.01 | 70.41 | 94.69 | 83.55 |
|
|
26
|
+
src | 80.79 | 70.7 | 93.47 | 83.18 |
|
|
27
|
+
ast-to-ck.ts | 90.65 | 82.7 | 100 | 91.91 | 82-91,168,263,295-296,311,344-345,355,415
|
|
28
28
|
circular-refs.ts | 100 | 90 | 100 | 100 | 20-23
|
|
29
29
|
convert.ts | 77.19 | 87.5 | 80 | 77.77 | 83-98,112-117
|
|
30
30
|
normalize.ts | 62.96 | 56.6 | 80 | 63.33 | 79,121-163,237-255,270-271,280-309,346,350,358
|
|
31
|
-
paths-to-ast.ts |
|
|
31
|
+
paths-to-ast.ts | 85.03 | 65.71 | 100 | 89.56 | 100,125,130,140-141,149,192,206,247,277,283,320
|
|
32
32
|
schema-to-ast.ts | 84.69 | 75 | 95.65 | 87.65 | 128-129,151,159,173,196-197,205-206,311-314,353-360,396-404
|
|
33
33
|
tag-splitter.ts | 70 | 57.14 | 81.81 | 76.47 | 63-71,137-138,141-146,162-163,171-178
|
|
34
34
|
warnings.ts | 100 | 100 | 100 | 100 |
|
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,38 @@
|
|
|
1
1
|
# @contractkit/openapi-to-ck
|
|
2
2
|
|
|
3
|
+
## 0.7.8
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 79af33b: **Breaking:** Replace the `roles` field in `security: { ... }` blocks with `requireMfa: boolean`.
|
|
8
|
+
|
|
9
|
+
The `security` declaration on operations, routes, and the file-level `options { security: { ... } }` block no longer accepts a `roles:` line. The new field is `requireMfa: true | false`. Existing `.ck` files that use `roles:` will fail to parse.
|
|
10
|
+
|
|
11
|
+
```ck
|
|
12
|
+
# Before
|
|
13
|
+
security: {
|
|
14
|
+
roles: admin editor
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
# After
|
|
18
|
+
security: {
|
|
19
|
+
requireMfa: true
|
|
20
|
+
}
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
**`@contractkit/core`** — `SecurityFields` interface drops `roles` / `rolesDescription` and adds `requireMfa` / `requireMfaDescription`. The grammar's `SecurityRolesLine` is replaced by `SecurityRequireMfaLine` (`requireMfaKw ":" booleanLit`). `security: none` continues to work.
|
|
24
|
+
|
|
25
|
+
**`@contractkit/plugin-typescript`** — Generated Koa routers now emit `requireSecurity({ requireMfa: <bool> })` when `requireMfa` is set, and bare `requireSecurity()` for unannotated routes (previously `requireSecurity({ roles: [...] })` / `requireSecurity({ })`). The generated code matches the updated serverkit `SecurityOptions = { requireMfa: boolean }` signature; consumers must upgrade serverkit alongside.
|
|
26
|
+
|
|
27
|
+
**`@contractkit/prettier-plugin`** — Formats `requireMfa: true|false` lines inside security blocks. Files containing `roles:` will no longer round-trip and will surface as parse errors.
|
|
28
|
+
|
|
29
|
+
**`@contractkit/plugin-markdown`** — The "Security: authenticated" admonition now shows `requireMfa: <bool>` instead of `roles: <list>`.
|
|
30
|
+
|
|
31
|
+
**`@contractkit/openapi-to-ck`** — `convertSecurity` no longer extracts OpenAPI scopes into a `roles` list (those don't map onto MFA semantics). Any non-empty OpenAPI `security` requirement now collapses to `security: {}` (authenticated, no MFA flag).
|
|
32
|
+
|
|
33
|
+
- Updated dependencies [79af33b]
|
|
34
|
+
- @contractkit/core@0.17.0
|
|
35
|
+
|
|
3
36
|
## 0.7.7
|
|
4
37
|
|
|
5
38
|
### Patch Changes
|
package/coverage/clover.xml
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
<?xml version="1.0" encoding="UTF-8"?>
|
|
2
|
-
<coverage generated="
|
|
3
|
-
<project timestamp="
|
|
4
|
-
<metrics statements="
|
|
2
|
+
<coverage generated="1778245378830" clover="3.2.0">
|
|
3
|
+
<project timestamp="1778245378831" name="All files">
|
|
4
|
+
<metrics statements="833" coveredstatements="696" conditionals="747" coveredconditionals="526" methods="113" coveredmethods="107" elements="1693" coveredelements="1329" complexity="0" loc="833" ncloc="833" packages="2" files="9" classes="9"/>
|
|
5
5
|
<package name="src">
|
|
6
|
-
<metrics statements="
|
|
6
|
+
<metrics statements="803" coveredstatements="668" conditionals="727" coveredconditionals="514" methods="92" coveredmethods="86"/>
|
|
7
7
|
<file name="ast-to-ck.ts" path="/home/runner/work/ContractKit/ContractKit/packages/openapi-to-ck/src/ast-to-ck.ts">
|
|
8
|
-
<metrics statements="198" coveredstatements="182" conditionals="
|
|
8
|
+
<metrics statements="198" coveredstatements="182" conditionals="185" coveredconditionals="153" methods="18" coveredmethods="18"/>
|
|
9
9
|
<line num="17" count="2" type="stmt"/>
|
|
10
10
|
<line num="27" count="47" type="cond" truecount="1" falsecount="0"/>
|
|
11
11
|
<line num="28" count="47" type="stmt"/>
|
|
@@ -37,7 +37,7 @@
|
|
|
37
37
|
<line num="83" count="0" type="cond" truecount="0" falsecount="2"/>
|
|
38
38
|
<line num="84" count="0" type="stmt"/>
|
|
39
39
|
<line num="86" count="0" type="stmt"/>
|
|
40
|
-
<line num="87" count="0" type="cond" truecount="0" falsecount="
|
|
40
|
+
<line num="87" count="0" type="cond" truecount="0" falsecount="2"/>
|
|
41
41
|
<line num="88" count="0" type="stmt"/>
|
|
42
42
|
<line num="91" count="0" type="stmt"/>
|
|
43
43
|
<line num="94" count="11" type="stmt"/>
|
|
@@ -198,7 +198,7 @@
|
|
|
198
198
|
<line num="404" count="11" type="stmt"/>
|
|
199
199
|
<line num="405" count="11" type="stmt"/>
|
|
200
200
|
<line num="408" count="1" type="stmt"/>
|
|
201
|
-
<line num="409" count="1" type="cond" truecount="
|
|
201
|
+
<line num="409" count="1" type="cond" truecount="1" falsecount="1"/>
|
|
202
202
|
<line num="410" count="1" type="cond" truecount="3" falsecount="1"/>
|
|
203
203
|
<line num="411" count="1" type="stmt"/>
|
|
204
204
|
<line num="412" count="1" type="stmt"/>
|
|
@@ -452,7 +452,7 @@
|
|
|
452
452
|
<line num="358" count="0" type="stmt"/>
|
|
453
453
|
</file>
|
|
454
454
|
<file name="paths-to-ast.ts" path="/home/runner/work/ContractKit/ContractKit/packages/openapi-to-ck/src/paths-to-ast.ts">
|
|
455
|
-
<metrics statements="
|
|
455
|
+
<metrics statements="115" coveredstatements="103" conditionals="105" coveredconditionals="69" methods="16" coveredmethods="16"/>
|
|
456
456
|
<line num="25" count="1" type="stmt"/>
|
|
457
457
|
<line num="26" count="1" type="stmt"/>
|
|
458
458
|
<line num="46" count="16" type="stmt"/>
|
|
@@ -564,16 +564,10 @@
|
|
|
564
564
|
<line num="314" count="10" type="cond" truecount="1" falsecount="1"/>
|
|
565
565
|
<line num="315" count="10" type="stmt"/>
|
|
566
566
|
<line num="320" count="0" type="stmt"/>
|
|
567
|
-
<line num="
|
|
568
|
-
<line num="
|
|
569
|
-
<line num="
|
|
570
|
-
<line num="
|
|
571
|
-
<line num="328" count="0" type="stmt"/>
|
|
572
|
-
<line num="332" count="0" type="stmt"/>
|
|
573
|
-
<line num="338" count="88" type="stmt"/>
|
|
574
|
-
<line num="350" count="53" type="stmt"/>
|
|
575
|
-
<line num="354" count="53" type="stmt"/>
|
|
576
|
-
<line num="359" count="88" type="stmt"/>
|
|
567
|
+
<line num="326" count="88" type="stmt"/>
|
|
568
|
+
<line num="338" count="53" type="stmt"/>
|
|
569
|
+
<line num="342" count="53" type="stmt"/>
|
|
570
|
+
<line num="347" count="88" type="stmt"/>
|
|
577
571
|
</file>
|
|
578
572
|
<file name="schema-to-ast.ts" path="/home/runner/work/ContractKit/ContractKit/packages/openapi-to-ck/src/schema-to-ast.ts">
|
|
579
573
|
<metrics statements="162" coveredstatements="142" conditionals="164" coveredconditionals="123" methods="23" coveredmethods="22"/>
|