@shipworthy/openapi-transformer 0.0.1 → 1.0.0
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/README.md +19 -3
- package/dist/case.d.ts +15 -0
- package/dist/case.js +153 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +1 -0
- package/dist/transformers/3.1/callbacks.d.ts +463 -465
- package/dist/transformers/3.1/callbacks.js +4 -4
- package/dist/transformers/3.1/content.js +4 -4
- package/dist/transformers/3.1/examples.d.ts +181 -183
- package/dist/transformers/3.1/examples.js +4 -4
- package/dist/transformers/3.1/extensions.d.ts +1 -1
- package/dist/transformers/3.1/extensions.js +2 -1
- package/dist/transformers/3.1/headers.d.ts +37 -39
- package/dist/transformers/3.1/headers.js +3 -3
- package/dist/transformers/3.1/index.d.ts +3700 -3712
- package/dist/transformers/3.1/index.js +2 -2
- package/dist/transformers/3.1/operation.d.ts +12 -8
- package/dist/transformers/3.1/operation.js +1 -2
- package/dist/transformers/3.1/parameters.d.ts +212 -214
- package/dist/transformers/3.1/parameters.js +2 -2
- package/dist/transformers/3.1/paths.d.ts +979 -977
- package/dist/transformers/3.1/paths.js +5 -4
- package/dist/transformers/3.1/pointer.js +5 -5
- package/dist/transformers/3.1/request.d.ts +176 -178
- package/dist/transformers/3.1/request.js +3 -3
- package/dist/transformers/3.1/responses.d.ts +134 -138
- package/dist/transformers/3.1/responses.js +5 -5
- package/dist/transformers/3.1/securities.d.ts +108 -110
- package/dist/transformers/3.1/securities.js +4 -4
- package/dist/transformers/3.1/servers.d.ts +14 -18
- package/dist/transformers/3.1/servers.js +2 -2
- package/package.json +6 -9
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { OpenApiPathItem } from "@shipworthy/openapi-parser/schemas/3.1";
|
|
2
|
-
import { Array, Effect, Predicate } from "effect";
|
|
2
|
+
import { Array, Effect, Predicate, Record, String } from "effect";
|
|
3
3
|
import { transformOperation } from "./operation.js";
|
|
4
4
|
import { child, resolve } from "./pointer.js";
|
|
5
5
|
import { readExtensions } from "./extensions.js";
|
|
@@ -8,7 +8,8 @@ import { transformParameterList } from "./parameters.js";
|
|
|
8
8
|
import { transformServerList } from "./servers.js";
|
|
9
9
|
export const transformPathItem = Effect.fnUntraced(function* (ctx, key, value, at, includeCallbacks) {
|
|
10
10
|
const expand = value.$ref !== undefined &&
|
|
11
|
-
(
|
|
11
|
+
(String.startsWith("#/paths/")(value.$ref) ||
|
|
12
|
+
Array.some(Record.keys(value), (key) => key !== "$ref"));
|
|
12
13
|
const { value: item, id, reference, } = yield* resolve(ctx.document, OpenApiPathItem, value, at, expand);
|
|
13
14
|
const servers = yield* transformServerList(item.servers, child(id, "servers"));
|
|
14
15
|
const parameters = yield* transformParameterList(ctx.document, item.parameters, child(id, "parameters"));
|
|
@@ -25,8 +26,8 @@ export const transformPathItem = Effect.fnUntraced(function* (ctx, key, value, a
|
|
|
25
26
|
};
|
|
26
27
|
});
|
|
27
28
|
export const transformPathItemMap = Effect.fnUntraced(function* (ctx, value, at, skipExtensions, includeCallbacks = true) {
|
|
28
|
-
const entries =
|
|
29
|
-
return
|
|
29
|
+
const entries = Array.filter(Record.toEntries(value ?? {}), ([key]) => !skipExtensions || !String.startsWith("x-")(key));
|
|
30
|
+
return Record.fromEntries(yield* Effect.forEach(entries, Effect.fnUntraced(function* ([key, entry]) {
|
|
30
31
|
return [
|
|
31
32
|
key,
|
|
32
33
|
yield* transformPathItem(ctx, key, entry, child(at, key), includeCallbacks),
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { OpenApiReference } from "@shipworthy/openapi-parser/schemas/3.1";
|
|
2
|
-
import { Effect, JsonPointer, Predicate, Schema, SchemaIssue } from "effect";
|
|
2
|
+
import { Array, Effect, JsonPointer, pipe, Predicate, Record, Schema, SchemaIssue, String, } from "effect";
|
|
3
3
|
const isReference = Schema.is(OpenApiReference);
|
|
4
4
|
/** parseUriFragment rejects unencoded spaces. OpenAPI path refs may contain them. */
|
|
5
5
|
function tokens(ref) {
|
|
@@ -8,9 +8,9 @@ function tokens(ref) {
|
|
|
8
8
|
return parsed;
|
|
9
9
|
if (ref === "#")
|
|
10
10
|
return [];
|
|
11
|
-
if (!
|
|
11
|
+
if (!String.startsWith("#/")(ref))
|
|
12
12
|
return undefined;
|
|
13
|
-
return ref.slice(2).split("/").map(JsonPointer.unescapeToken);
|
|
13
|
+
return pipe(ref, String.slice(2), String.split("/"), Array.map((token) => JsonPointer.unescapeToken(token)));
|
|
14
14
|
}
|
|
15
15
|
function pointer(document, ref) {
|
|
16
16
|
const path = tokens(ref);
|
|
@@ -20,7 +20,7 @@ function pointer(document, ref) {
|
|
|
20
20
|
for (const key of path) {
|
|
21
21
|
if (Array.isArray(node))
|
|
22
22
|
node = node[Number(key)];
|
|
23
|
-
else if (Predicate.isObject(node) &&
|
|
23
|
+
else if (Predicate.isObject(node) && Record.has(node, key))
|
|
24
24
|
node = node[key];
|
|
25
25
|
else
|
|
26
26
|
return undefined;
|
|
@@ -29,7 +29,7 @@ function pointer(document, ref) {
|
|
|
29
29
|
}
|
|
30
30
|
/** Append JSON Pointer segments to a pointer. */
|
|
31
31
|
export function child(at, ...segments) {
|
|
32
|
-
return
|
|
32
|
+
return Array.reduce(segments, at, (path, segment) => `${path}/${JsonPointer.escapeToken(`${segment}`)}`);
|
|
33
33
|
}
|
|
34
34
|
/** Follow references and check their target against the expected specification object. */
|
|
35
35
|
export const resolve = Effect.fnUntraced(function* (document, schema, value, at, mergeSiblings = false) {
|