@visulima/api-platform 1.0.1 → 1.0.3
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/CHANGELOG.md +29 -0
- package/README.md +2 -2
- package/bin/index.js +46 -0
- package/dist/{chunk-XXZ56SKG.mjs → chunk-2M45MXC2.mjs} +1 -2
- package/dist/chunk-2M45MXC2.mjs.map +1 -0
- package/dist/chunk-3Y3YBDRS.mjs +284 -0
- package/dist/chunk-3Y3YBDRS.mjs.map +1 -0
- package/dist/chunk-NY75KGAH.js +284 -0
- package/dist/chunk-NY75KGAH.js.map +1 -0
- package/dist/{chunk-AJKZCWFG.js → chunk-S46GRBOS.js} +1 -2
- package/dist/chunk-S46GRBOS.js.map +1 -0
- package/dist/index-server.d.ts +2 -0
- package/dist/index-server.js +9 -10
- package/dist/index-server.js.map +1 -1
- package/dist/index-server.mjs +7 -8
- package/dist/index-server.mjs.map +1 -1
- package/dist/next/cli/index.js +8 -8
- package/dist/next/cli/index.js.map +1 -1
- package/dist/next/cli/index.mjs +8 -8
- package/dist/next/cli/index.mjs.map +1 -1
- package/dist/next/index-browser.js +2 -2
- package/dist/next/index-browser.mjs +1 -1
- package/dist/next/index-server.d.ts +9 -5
- package/dist/next/index-server.js +4 -4
- package/dist/next/index-server.mjs +2 -2
- package/next/cli/package.json +12 -3
- package/next/package.json +9 -0
- package/package.json +20 -20
- package/recipes/api/swagger.ts +12 -0
- package/recipes/pages/redoc-ui.tsx +5 -0
- package/recipes/pages/swagger-ui.tsx +5 -0
- package/dist/chunk-2LATTLUM.mjs +0 -166
- package/dist/chunk-2LATTLUM.mjs.map +0 -1
- package/dist/chunk-AJKZCWFG.js.map +0 -1
- package/dist/chunk-S7GUPAL4.js +0 -166
- package/dist/chunk-S7GUPAL4.js.map +0 -1
- package/dist/chunk-XXZ56SKG.mjs.map +0 -1
- package/src/connect/create-node-router.ts +0 -44
- package/src/connect/handler.ts +0 -46
- package/src/connect/middleware/cors-middleware.ts +0 -10
- package/src/connect/middleware/http-header-normalizer.ts +0 -93
- package/src/connect/middleware/rate-limiter-middleware.ts +0 -43
- package/src/connect/middleware/serializers-middleware.ts +0 -121
- package/src/connect/serializers/types.d.ts +0 -1
- package/src/connect/serializers/xml.ts +0 -13
- package/src/connect/serializers/yaml.ts +0 -7
- package/src/error-handler/jsonapi-error-handler.ts +0 -46
- package/src/error-handler/problem-error-handler.ts +0 -44
- package/src/error-handler/types.d.ts +0 -14
- package/src/error-handler/utils.ts +0 -39
- package/src/index-browser.tsx +0 -1
- package/src/index-server.ts +0 -75
- package/src/next/cli/index.ts +0 -2
- package/src/next/cli/list/api-route-file-parser.ts +0 -74
- package/src/next/cli/list/collect-api-route-files.ts +0 -42
- package/src/next/cli/list/list-command.ts +0 -105
- package/src/next/cli/list/routes-render.ts +0 -62
- package/src/next/cli/list/types.d.ts +0 -1
- package/src/next/index-browser.tsx +0 -3
- package/src/next/index-server.ts +0 -6
- package/src/next/routes/api/swagger.ts +0 -23
- package/src/next/routes/pages/swagger/get-static-properties-swagger.ts +0 -32
- package/src/next/routes/pages/swagger/redoc.tsx +0 -35
- package/src/next/routes/pages/swagger/swagger.tsx +0 -44
- package/src/next/webpack/with-open-api.ts +0 -63
- package/src/swagger/extend-swagger-spec.ts +0 -167
- package/src/swagger/swagger-handler.ts +0 -83
- package/src/utils.ts +0 -37
- package/src/zod/date-in-schema.ts +0 -57
- package/src/zod/date-out-schema.ts +0 -41
- package/src/zod/index.ts +0 -9
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,32 @@
|
|
|
1
|
+
## @visulima/api-platform [1.0.3](https://github.com/visulima/visulima/compare/@visulima/api-platform@1.0.2...@visulima/api-platform@1.0.3) (2022-12-01)
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
### Bug Fixes
|
|
5
|
+
|
|
6
|
+
* extended swagger generation for example and fixed typings ([#41](https://github.com/visulima/visulima/issues/41)) ([a16f49b](https://github.com/visulima/visulima/commit/a16f49b70f78763a63525e0d328bd2a597b183f7))
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
### Dependencies
|
|
11
|
+
|
|
12
|
+
* **@visulima/connect:** upgraded to 1.3.1
|
|
13
|
+
* **@visulima/jsdoc-open-api:** upgraded to 1.2.1
|
|
14
|
+
* **@visulima/crud:** upgraded to 1.0.2
|
|
15
|
+
* **@visulima/readdir:** upgraded to 1.3.1
|
|
16
|
+
|
|
17
|
+
## @visulima/api-platform [1.0.2](https://github.com/visulima/visulima/compare/@visulima/api-platform@1.0.1...@visulima/api-platform@1.0.2) (2022-11-16)
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
### Bug Fixes
|
|
21
|
+
|
|
22
|
+
* fixed wrong image and url for the npm version ([297c187](https://github.com/visulima/visulima/commit/297c187d07ca7fb82d25fd46defe4f320c514de9))
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
### Dependencies
|
|
27
|
+
|
|
28
|
+
* **@visulima/crud:** upgraded to 1.0.1
|
|
29
|
+
|
|
1
30
|
## @visulima/api-platform [1.0.1](https://github.com/visulima/visulima/compare/@visulima/api-platform@1.0.0...@visulima/api-platform@1.0.1) (2022-11-15)
|
|
2
31
|
|
|
3
32
|
|
package/README.md
CHANGED
|
@@ -132,6 +132,6 @@ The visulima api-platform is open-sourced software licensed under the [MIT][lice
|
|
|
132
132
|
[typescript-url]: "typescript"
|
|
133
133
|
[license-image]: https://img.shields.io/npm/l/@visulima/api-platform?color=blueviolet&style=for-the-badge
|
|
134
134
|
[license-url]: LICENSE.md "license"
|
|
135
|
-
[npm-image]: https://img.shields.io/npm/v/@visulima/api-platform/
|
|
136
|
-
[npm-url]: https://www.npmjs.com/package/@visulima/api-platform/v/
|
|
135
|
+
[npm-image]: https://img.shields.io/npm/v/@visulima/api-platform/latest.svg?style=for-the-badge&logo=npm
|
|
136
|
+
[npm-url]: https://www.npmjs.com/package/@visulima/api-platform/v/latest "npm"
|
|
137
137
|
|
package/bin/index.js
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
// eslint-disable-next-line unicorn/prefer-module,import/no-extraneous-dependencies
|
|
2
|
+
const { Command } = require("commander");
|
|
3
|
+
// eslint-disable-next-line unicorn/prefer-module
|
|
4
|
+
const { exit } = require("node:process");
|
|
5
|
+
|
|
6
|
+
// eslint-disable-next-line unicorn/prefer-module
|
|
7
|
+
const { listCommand } = require("../dist/next/cli");
|
|
8
|
+
|
|
9
|
+
// eslint-disable-next-line unicorn/prefer-module,no-underscore-dangle
|
|
10
|
+
const package_ = require("../package.json");
|
|
11
|
+
|
|
12
|
+
const program = new Command();
|
|
13
|
+
|
|
14
|
+
program.name("@visulima/api-platform").description("CLI for the visulima api-platform").version(package_.version);
|
|
15
|
+
|
|
16
|
+
program
|
|
17
|
+
.command("list")
|
|
18
|
+
.description("List all available API routes")
|
|
19
|
+
.option("-p, --path [path]", "...", "")
|
|
20
|
+
.option("--group [type]", "Groups routes. Supported: path, tag")
|
|
21
|
+
.option("--include-path [path]", "Includes only routes which contain a given path element. (comma-separated values)")
|
|
22
|
+
.option("--exclude-path [path]", "Excludes routes which contain a given path element. (comma-separated values)")
|
|
23
|
+
.option("-v, --verbose", "Verbose output.")
|
|
24
|
+
.action((options) => {
|
|
25
|
+
try {
|
|
26
|
+
listCommand(options.path, {
|
|
27
|
+
verbose: options.verbose,
|
|
28
|
+
group: options.group,
|
|
29
|
+
includePaths: options.includePath,
|
|
30
|
+
excludePaths: options.excludePaths,
|
|
31
|
+
});
|
|
32
|
+
} catch (error) {
|
|
33
|
+
// eslint-disable-next-line no-console
|
|
34
|
+
console.error(error);
|
|
35
|
+
exit(1);
|
|
36
|
+
}
|
|
37
|
+
});
|
|
38
|
+
|
|
39
|
+
// eslint-disable-next-line no-undef
|
|
40
|
+
program.parse(process.argv);
|
|
41
|
+
|
|
42
|
+
// eslint-disable-next-line no-undef
|
|
43
|
+
if (process.argv.slice(2).length === 0) {
|
|
44
|
+
program.help();
|
|
45
|
+
exit(1);
|
|
46
|
+
}
|
|
@@ -17,7 +17,6 @@ import dynamic from "next/dynamic";
|
|
|
17
17
|
import Head2 from "next/head";
|
|
18
18
|
import React2 from "react";
|
|
19
19
|
var SwaggerUI = dynamic(import("swagger-ui-react"), { ssr: false });
|
|
20
|
-
dynamic(import("swagger-ui-react/swagger-ui.css"), { ssr: false });
|
|
21
20
|
var SwaggerApiDocument = (name, swagger = {}) => ({ swaggerData }) => /* @__PURE__ */ React2.createElement(React2.Fragment, null, /* @__PURE__ */ React2.createElement(Head2, null, /* @__PURE__ */ React2.createElement("title", null, name), /* @__PURE__ */ React2.createElement("style", null, `
|
|
22
21
|
body {
|
|
23
22
|
background: #fafafa !important;
|
|
@@ -49,4 +48,4 @@ export {
|
|
|
49
48
|
swagger_default,
|
|
50
49
|
get_static_properties_swagger_default
|
|
51
50
|
};
|
|
52
|
-
//# sourceMappingURL=chunk-
|
|
51
|
+
//# sourceMappingURL=chunk-2M45MXC2.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/next/routes/pages/swagger/redoc.tsx","../src/next/routes/pages/swagger/swagger.tsx","../src/next/routes/pages/swagger/get-static-properties-swagger.ts"],"sourcesContent":["// eslint-disable-next-line import/no-extraneous-dependencies\nimport type { InferGetStaticPropsType, NextPage } from \"next\";\n// eslint-disable-next-line import/no-extraneous-dependencies\nimport Head from \"next/head\";\nimport React from \"react\";\n// eslint-disable-next-line import/no-extraneous-dependencies\nimport type { RedocStandaloneProps } from \"redoc\";\n// eslint-disable-next-line import/no-extraneous-dependencies\nimport { RedocStandalone } from \"redoc\";\n\nimport getStaticProps from \"./get-static-properties-swagger\";\n\n// eslint-disable-next-line max-len\nconst RedocApiDocument: (\n name: string,\n swagger?: Exclude<RedocStandaloneProps, \"spec\">,\n // eslint-disable-next-line max-len,unicorn/no-useless-undefined\n) => NextPage<InferGetStaticPropsType<typeof getStaticProps>> = (name, swagger = {}) => ({ swaggerData }: InferGetStaticPropsType<typeof getStaticProps>) => (\n <>\n <Head>\n <title>{name}</title>\n <style>\n {`\nbody {\n background: #fafafa !important;\n}\n`}\n </style>\n </Head>\n {/* eslint-disable-next-line react/jsx-props-no-spreading */}\n <RedocStandalone {...swagger} spec={swaggerData} />\n </>\n);\n\nexport default RedocApiDocument;\n","import type { InferGetStaticPropsType, NextPage } from \"next\";\n// eslint-disable-next-line import/no-extraneous-dependencies\nimport dynamic from \"next/dynamic\";\n// eslint-disable-next-line import/no-extraneous-dependencies\nimport Head from \"next/head\";\n// eslint-disable-next-line import/no-extraneous-dependencies\nimport React from \"react\";\nimport type { SwaggerUIProps } from \"swagger-ui-react\";\n\nimport getStaticProps from \"./get-static-properties-swagger\";\n// eslint-disable-next-line import/no-extraneous-dependencies\nconst SwaggerUI = dynamic(import(\"swagger-ui-react\"), { ssr: false });\n\n// eslint-disable-next-line max-len\nconst SwaggerApiDocument: (\n name: string,\n swagger?: Exclude<SwaggerUIProps, \"spec\">,\n // eslint-disable-next-line max-len,unicorn/no-useless-undefined\n) => NextPage<InferGetStaticPropsType<typeof getStaticProps>> = (name, swagger = {}) => ({ swaggerData }: InferGetStaticPropsType<typeof getStaticProps>) => (\n <>\n <Head>\n <title>{name}</title>\n <style>\n {`\nbody {\n background: #fafafa !important;\n}\n`}\n </style>\n </Head>\n {/* eslint-disable-next-line react/jsx-props-no-spreading */}\n <SwaggerUI {...swagger} spec={swaggerData} />\n </>\n);\n\nexport default SwaggerApiDocument;\n","// eslint-disable-next-line unicorn/prevent-abbreviations\nimport debug from \"debug\";\nimport type { GetStaticProps } from \"next\";\nimport type { OpenAPIV3 } from \"openapi-types\";\n\n// eslint-disable-next-line testing-library/no-debugging-utils\nconst swaggerDebug = debug(\"visulima:api-platform:swagger:get-static-properties-swagger\");\n\n// eslint-disable-next-line unicorn/consistent-function-scoping\nconst getStaticProps: (\n swaggerUrl: string,\n) => GetStaticProps = (swaggerUrl) => async (): Promise<{\n props: {\n swaggerUrl: string;\n swaggerData: OpenAPIV3.Document;\n };\n}> => {\n // eslint-disable-next-line compat/compat\n const response = await fetch(swaggerUrl);\n const swaggerData = await response.json();\n\n swaggerDebug(swaggerData);\n\n return {\n props: {\n swaggerUrl,\n swaggerData: JSON.parse(JSON.stringify(swaggerData)),\n },\n };\n};\n\nexport default getStaticProps;\n"],"mappings":";AAGA,OAAO,UAAU;AACjB,OAAO,WAAW;AAIlB,SAAS,uBAAuB;AAKhC,IAAM,mBAI0D,CAAC,MAAM,UAAU,CAAC,MAAM,CAAC,EAAE,YAAY,MAC3F,0DACI,oCAAC,YACG,oCAAC,eAAO,IAAK,GACb,oCAAC,eACI;AAAA;AAAA;AAAA;AAAA,CAKL,CACJ,GAEA,oCAAC;AAAA,EAAiB,GAAG;AAAA,EAAS,MAAM;AAAA,CAAa,CACrD;AAGZ,IAAO,gBAAQ;;;AChCf,OAAO,aAAa;AAEpB,OAAOA,WAAU;AAEjB,OAAOC,YAAW;AAKlB,IAAM,YAAY,QAAQ,OAAO,qBAAqB,EAAE,KAAK,MAAM,CAAC;AAGpE,IAAM,qBAI0D,CAAC,MAAM,UAAU,CAAC,MAAM,CAAC,EAAE,YAAY,MAC3F,gBAAAA,OAAA,cAAAA,OAAA,gBACI,gBAAAA,OAAA,cAACD,OAAA,MACG,gBAAAC,OAAA,cAAC,eAAO,IAAK,GACb,gBAAAA,OAAA,cAAC,eACI;AAAA;AAAA;AAAA;AAAA,CAKL,CACJ,GAEA,gBAAAA,OAAA,cAAC;AAAA,EAAW,GAAG;AAAA,EAAS,MAAM;AAAA,CAAa,CAC/C;AAGZ,IAAO,kBAAQ;;;AClCf,OAAO,WAAW;AAKlB,IAAM,eAAe,MAAM,6DAA6D;AAGxF,IAAM,iBAEgB,CAAC,eAAe,YAKhC;AAEF,QAAM,WAAW,MAAM,MAAM,UAAU;AACvC,QAAM,cAAc,MAAM,SAAS,KAAK;AAExC,eAAa,WAAW;AAExB,SAAO;AAAA,IACH,OAAO;AAAA,MACH;AAAA,MACA,aAAa,KAAK,MAAM,KAAK,UAAU,WAAW,CAAC;AAAA,IACvD;AAAA,EACJ;AACJ;AAEA,IAAO,wCAAQ;","names":["Head","React"]}
|
|
@@ -0,0 +1,284 @@
|
|
|
1
|
+
// src/swagger/swagger-handler.ts
|
|
2
|
+
import { modelsToOpenApi } from "@visulima/crud";
|
|
3
|
+
import debug from "debug";
|
|
4
|
+
import merge from "lodash.merge";
|
|
5
|
+
import { existsSync, readFileSync } from "fs";
|
|
6
|
+
import path from "path";
|
|
7
|
+
|
|
8
|
+
// src/connect/serializers/yaml.ts
|
|
9
|
+
import { stringify } from "yaml";
|
|
10
|
+
var yamlTransformer = (data) => stringify(data, { indent: 2 });
|
|
11
|
+
var yaml_default = yamlTransformer;
|
|
12
|
+
|
|
13
|
+
// src/swagger/extend-swagger-spec.ts
|
|
14
|
+
import { header as headerCase } from "case";
|
|
15
|
+
import { toXML } from "jstoxml";
|
|
16
|
+
import { stringify as stringify2 } from "yaml";
|
|
17
|
+
var jsonMediaType = "application/json";
|
|
18
|
+
var prepareStatusContent = (methodSpec, status, mediaType) => {
|
|
19
|
+
var _a, _b, _c, _d, _e;
|
|
20
|
+
if (((_b = (_a = methodSpec == null ? void 0 : methodSpec.responses) == null ? void 0 : _a[status]) == null ? void 0 : _b.content) === void 0) {
|
|
21
|
+
methodSpec.responses[status].content = {};
|
|
22
|
+
}
|
|
23
|
+
if (((_e = (_d = (_c = methodSpec == null ? void 0 : methodSpec.responses) == null ? void 0 : _c[status]) == null ? void 0 : _d.content) == null ? void 0 : _e[mediaType]) === void 0) {
|
|
24
|
+
methodSpec.responses[status].content[mediaType] = {};
|
|
25
|
+
}
|
|
26
|
+
};
|
|
27
|
+
var extendComponentSchemas = (spec, schemaName, schema) => {
|
|
28
|
+
if (typeof spec.components !== "object") {
|
|
29
|
+
spec.components = {};
|
|
30
|
+
}
|
|
31
|
+
if (typeof spec.components.schemas !== "object") {
|
|
32
|
+
spec.components.schemas = {};
|
|
33
|
+
}
|
|
34
|
+
if (spec.components.schemas[schemaName] === void 0) {
|
|
35
|
+
spec.components.schemas[schemaName] = schema;
|
|
36
|
+
}
|
|
37
|
+
};
|
|
38
|
+
var extendResponseSchema = (methodSpec, status, mediaType, schemaName, schemaIsArray) => {
|
|
39
|
+
var _a, _b, _c, _d;
|
|
40
|
+
prepareStatusContent(methodSpec, status, mediaType);
|
|
41
|
+
if (((_d = (_c = (_b = (_a = methodSpec == null ? void 0 : methodSpec.responses) == null ? void 0 : _a[status]) == null ? void 0 : _b.content) == null ? void 0 : _c[mediaType]) == null ? void 0 : _d.schema) === void 0) {
|
|
42
|
+
methodSpec.responses[status].content[mediaType].schema = {};
|
|
43
|
+
}
|
|
44
|
+
methodSpec.responses[status].content[mediaType].schema = schemaIsArray ? {
|
|
45
|
+
type: "array",
|
|
46
|
+
items: {
|
|
47
|
+
$ref: `#/components/schemas/${schemaName}`
|
|
48
|
+
}
|
|
49
|
+
} : {
|
|
50
|
+
$ref: `#/components/schemas/${schemaName}`
|
|
51
|
+
};
|
|
52
|
+
};
|
|
53
|
+
var extendSwaggerWithMediaTypeSchema = (methodSpec, responseSpec, allowedMediaTypes, pathKey, spec, status) => {
|
|
54
|
+
let example;
|
|
55
|
+
let examples;
|
|
56
|
+
Object.entries(responseSpec.content).forEach(([mediaName, contentSpec]) => {
|
|
57
|
+
if (typeof contentSpec.schema === "object") {
|
|
58
|
+
const { schema } = contentSpec;
|
|
59
|
+
if (mediaName === jsonMediaType && contentSpec.examples !== void 0) {
|
|
60
|
+
examples = contentSpec.examples;
|
|
61
|
+
} else if (mediaName === jsonMediaType && contentSpec.example !== void 0) {
|
|
62
|
+
example = contentSpec.example;
|
|
63
|
+
}
|
|
64
|
+
const schemaIsArray = schema.type === "array";
|
|
65
|
+
Object.entries(allowedMediaTypes || {}).forEach(([mediaType, allowed]) => {
|
|
66
|
+
if (!allowed) {
|
|
67
|
+
return;
|
|
68
|
+
}
|
|
69
|
+
let schemaName;
|
|
70
|
+
if (schema.$ref === void 0) {
|
|
71
|
+
schemaName = `${headerCase(pathKey.trim().replace("/", ""))}${mediaType === "application/ld+json" ? ".jsonld" : ""}`;
|
|
72
|
+
extendComponentSchemas(spec, schemaName, schema);
|
|
73
|
+
} else {
|
|
74
|
+
schemaName = schema.$ref.replace("#/components/schemas/", "");
|
|
75
|
+
}
|
|
76
|
+
extendResponseSchema(methodSpec, status, mediaType, schemaName, schemaIsArray);
|
|
77
|
+
});
|
|
78
|
+
}
|
|
79
|
+
});
|
|
80
|
+
return { examples, example };
|
|
81
|
+
};
|
|
82
|
+
var extendSwaggerWithMediaTypeExample = (methodSpec, responseSpec, status, allowedMediaTypes, transformers, example) => {
|
|
83
|
+
Object.keys(responseSpec.content).forEach((mediaName) => {
|
|
84
|
+
if (mediaName === jsonMediaType) {
|
|
85
|
+
return;
|
|
86
|
+
}
|
|
87
|
+
Object.entries(allowedMediaTypes || {}).forEach(([mediaType, allowed]) => {
|
|
88
|
+
var _a, _b, _c, _d;
|
|
89
|
+
if (!allowed) {
|
|
90
|
+
return;
|
|
91
|
+
}
|
|
92
|
+
prepareStatusContent(methodSpec, status, mediaType);
|
|
93
|
+
if (((_d = (_c = (_b = (_a = methodSpec == null ? void 0 : methodSpec.responses) == null ? void 0 : _a[status]) == null ? void 0 : _b.content) == null ? void 0 : _c[mediaType]) == null ? void 0 : _d.example) === void 0) {
|
|
94
|
+
methodSpec.responses[status].content[mediaType].example = {};
|
|
95
|
+
}
|
|
96
|
+
let transformed = false;
|
|
97
|
+
transformers.forEach(({ regex, transformer }) => {
|
|
98
|
+
if (!transformed && regex.test(mediaType)) {
|
|
99
|
+
methodSpec.responses[status].content[mediaType].example = transformer(example);
|
|
100
|
+
transformed = true;
|
|
101
|
+
}
|
|
102
|
+
});
|
|
103
|
+
if (!transformed) {
|
|
104
|
+
methodSpec.responses[status].content[mediaType].example = example;
|
|
105
|
+
}
|
|
106
|
+
});
|
|
107
|
+
});
|
|
108
|
+
};
|
|
109
|
+
var extendComponentExamples = (spec, exampleName, examples) => {
|
|
110
|
+
if (typeof spec.components !== "object") {
|
|
111
|
+
spec.components = {};
|
|
112
|
+
}
|
|
113
|
+
if (typeof spec.components.examples !== "object") {
|
|
114
|
+
spec.components.examples = {};
|
|
115
|
+
}
|
|
116
|
+
if (spec.components.examples[exampleName] === void 0 && examples[exampleName] !== void 0) {
|
|
117
|
+
spec.components.examples[exampleName] = examples[exampleName];
|
|
118
|
+
}
|
|
119
|
+
};
|
|
120
|
+
var prepareResponseExamples = (spec, methodSpec, status, mediaType, transformers, examples) => {
|
|
121
|
+
var _a, _b, _c, _d;
|
|
122
|
+
prepareStatusContent(methodSpec, status, mediaType);
|
|
123
|
+
if (((_d = (_c = (_b = (_a = methodSpec == null ? void 0 : methodSpec.responses) == null ? void 0 : _a[status]) == null ? void 0 : _b.content) == null ? void 0 : _c[mediaType]) == null ? void 0 : _d.examples) === void 0) {
|
|
124
|
+
methodSpec.responses[status].content[mediaType].examples = {};
|
|
125
|
+
}
|
|
126
|
+
const transformedExamples = {};
|
|
127
|
+
Object.entries(examples).forEach(([exampleName, example]) => {
|
|
128
|
+
var _a2, _b2;
|
|
129
|
+
let transformed = false;
|
|
130
|
+
transformers.forEach(({ regex, transformer }) => {
|
|
131
|
+
var _a3, _b3, _c2, _d2, _e, _f;
|
|
132
|
+
if (!transformed && regex.test(mediaType)) {
|
|
133
|
+
let data = "";
|
|
134
|
+
if (((_b3 = (_a3 = spec.components) == null ? void 0 : _a3.examples) == null ? void 0 : _b3[exampleName]) !== void 0) {
|
|
135
|
+
data = ((_d2 = (_c2 = spec.components) == null ? void 0 : _c2.examples) == null ? void 0 : _d2[exampleName]).value;
|
|
136
|
+
} else if (example) {
|
|
137
|
+
data = ((_f = (_e = spec.components) == null ? void 0 : _e.examples) == null ? void 0 : _f[example.$ref.replace("#/components/examples/", "")]).value;
|
|
138
|
+
} else if (typeof (example == null ? void 0 : example.value) === "string") {
|
|
139
|
+
data = example.value;
|
|
140
|
+
}
|
|
141
|
+
transformedExamples[exampleName] = {
|
|
142
|
+
value: transformer(data)
|
|
143
|
+
};
|
|
144
|
+
transformed = true;
|
|
145
|
+
}
|
|
146
|
+
});
|
|
147
|
+
if (!transformed) {
|
|
148
|
+
transformedExamples[exampleName] = ((_b2 = (_a2 = spec.components) == null ? void 0 : _a2.examples) == null ? void 0 : _b2[exampleName]) === void 0 ? example : {
|
|
149
|
+
$ref: `#/components/examples/${exampleName}`
|
|
150
|
+
};
|
|
151
|
+
}
|
|
152
|
+
});
|
|
153
|
+
methodSpec.responses[status].content[mediaType].examples = transformedExamples;
|
|
154
|
+
};
|
|
155
|
+
var extendSwaggerWithMediaTypeExamples = (spec, methodSpec, status, responseSpec, allowedMediaTypes, pathKey, transformers, examples) => {
|
|
156
|
+
const examplesName = `${headerCase(pathKey.trim().replace("/", ""))}`;
|
|
157
|
+
Object.keys(responseSpec.content).forEach((mediaName) => {
|
|
158
|
+
if (mediaName === jsonMediaType) {
|
|
159
|
+
return;
|
|
160
|
+
}
|
|
161
|
+
Object.entries(allowedMediaTypes || {}).forEach(([mediaType, allowed]) => {
|
|
162
|
+
if (!allowed) {
|
|
163
|
+
return;
|
|
164
|
+
}
|
|
165
|
+
extendComponentExamples(spec, examplesName, examples);
|
|
166
|
+
prepareResponseExamples(spec, methodSpec, status, mediaType, transformers, examples);
|
|
167
|
+
});
|
|
168
|
+
});
|
|
169
|
+
};
|
|
170
|
+
function extendSwaggerSpec(spec, allowedMediaTypes, transformers = [
|
|
171
|
+
{
|
|
172
|
+
regex: /xml/,
|
|
173
|
+
transformer: (value) => toXML(value, {
|
|
174
|
+
header: true,
|
|
175
|
+
indent: " "
|
|
176
|
+
})
|
|
177
|
+
},
|
|
178
|
+
{
|
|
179
|
+
regex: /yaml|yml/,
|
|
180
|
+
transformer: (value) => stringify2(value, { indent: 2 })
|
|
181
|
+
}
|
|
182
|
+
]) {
|
|
183
|
+
if (typeof spec === "object" && typeof spec.paths === "object") {
|
|
184
|
+
Object.entries(spec.paths).forEach(([pathKey, pathSpec]) => {
|
|
185
|
+
Object.values(pathSpec).forEach((methodSpec) => {
|
|
186
|
+
if (typeof methodSpec.responses === "object") {
|
|
187
|
+
Object.entries(methodSpec.responses).forEach(([status, responseSpec]) => {
|
|
188
|
+
if (typeof responseSpec.content === "object") {
|
|
189
|
+
const { examples, example } = extendSwaggerWithMediaTypeSchema(
|
|
190
|
+
methodSpec,
|
|
191
|
+
responseSpec,
|
|
192
|
+
allowedMediaTypes,
|
|
193
|
+
pathKey,
|
|
194
|
+
spec,
|
|
195
|
+
status
|
|
196
|
+
);
|
|
197
|
+
if (example !== void 0) {
|
|
198
|
+
extendSwaggerWithMediaTypeExample(
|
|
199
|
+
methodSpec,
|
|
200
|
+
responseSpec,
|
|
201
|
+
status,
|
|
202
|
+
allowedMediaTypes,
|
|
203
|
+
transformers,
|
|
204
|
+
example
|
|
205
|
+
);
|
|
206
|
+
} else if (examples !== void 0) {
|
|
207
|
+
extendSwaggerWithMediaTypeExamples(
|
|
208
|
+
spec,
|
|
209
|
+
methodSpec,
|
|
210
|
+
status,
|
|
211
|
+
responseSpec,
|
|
212
|
+
allowedMediaTypes,
|
|
213
|
+
pathKey,
|
|
214
|
+
transformers,
|
|
215
|
+
examples
|
|
216
|
+
);
|
|
217
|
+
}
|
|
218
|
+
}
|
|
219
|
+
});
|
|
220
|
+
}
|
|
221
|
+
});
|
|
222
|
+
});
|
|
223
|
+
}
|
|
224
|
+
return spec;
|
|
225
|
+
}
|
|
226
|
+
|
|
227
|
+
// src/swagger/swagger-handler.ts
|
|
228
|
+
var swaggerCrudDebug = debug("visulima:api-platform:swagger:crud:get-static-properties-swagger");
|
|
229
|
+
var swaggerHandler = (options = {}) => {
|
|
230
|
+
const {
|
|
231
|
+
allowedMediaTypes = {
|
|
232
|
+
"application/json": true
|
|
233
|
+
},
|
|
234
|
+
swaggerFilePath,
|
|
235
|
+
crud,
|
|
236
|
+
specs
|
|
237
|
+
} = options;
|
|
238
|
+
return async (request, response) => {
|
|
239
|
+
const swaggerPath = path.join(process.cwd(), swaggerFilePath || "swagger/swagger.json");
|
|
240
|
+
if (!existsSync(swaggerPath)) {
|
|
241
|
+
throw new Error(`Swagger file not found at ${swaggerPath}. Did you change the output path in "withOpenApi" inside the next.config.js file?`);
|
|
242
|
+
}
|
|
243
|
+
const fileContents = readFileSync(swaggerPath, "utf8");
|
|
244
|
+
let spec = extendSwaggerSpec(JSON.parse(fileContents), allowedMediaTypes);
|
|
245
|
+
let crudSwagger = {};
|
|
246
|
+
if (crud !== void 0) {
|
|
247
|
+
try {
|
|
248
|
+
const modelsOpenApi = await modelsToOpenApi(crud);
|
|
249
|
+
crudSwagger = {
|
|
250
|
+
components: { schemas: modelsOpenApi.schemas, examples: modelsOpenApi.examples },
|
|
251
|
+
tags: modelsOpenApi.tags,
|
|
252
|
+
paths: modelsOpenApi.paths
|
|
253
|
+
};
|
|
254
|
+
crudSwagger = extendSwaggerSpec(crudSwagger, allowedMediaTypes);
|
|
255
|
+
swaggerCrudDebug(JSON.stringify(crudSwagger, null, 2));
|
|
256
|
+
spec = merge(spec, crudSwagger);
|
|
257
|
+
} catch (error) {
|
|
258
|
+
console.log(error);
|
|
259
|
+
throw new Error("Please install @visulima/crud to use the crud swagger generator.");
|
|
260
|
+
}
|
|
261
|
+
}
|
|
262
|
+
if (Array.isArray(specs)) {
|
|
263
|
+
specs.forEach((value) => {
|
|
264
|
+
spec = merge(spec, extendSwaggerSpec(value, allowedMediaTypes));
|
|
265
|
+
});
|
|
266
|
+
}
|
|
267
|
+
if (typeof request.headers.accept === "string" && /yaml|yml/.test(request.headers.accept)) {
|
|
268
|
+
response.statusCode = 200;
|
|
269
|
+
response.setHeader("Content-Type", request.headers.accept);
|
|
270
|
+
response.end(yaml_default(spec));
|
|
271
|
+
} else {
|
|
272
|
+
response.statusCode = 200;
|
|
273
|
+
response.setHeader("Content-Type", "application/json");
|
|
274
|
+
response.end(JSON.stringify(spec, null, 2));
|
|
275
|
+
}
|
|
276
|
+
};
|
|
277
|
+
};
|
|
278
|
+
var swagger_handler_default = swaggerHandler;
|
|
279
|
+
|
|
280
|
+
export {
|
|
281
|
+
yaml_default,
|
|
282
|
+
swagger_handler_default
|
|
283
|
+
};
|
|
284
|
+
//# sourceMappingURL=chunk-3Y3YBDRS.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/swagger/swagger-handler.ts","../src/connect/serializers/yaml.ts","../src/swagger/extend-swagger-spec.ts"],"sourcesContent":["// eslint-disable-next-line unicorn/prevent-abbreviations,import/no-extraneous-dependencies\nimport type { ModelsToOpenApiParameters, SwaggerModelsConfig } from \"@visulima/crud\";\n// eslint-disable-next-line unicorn/prevent-abbreviations,import/no-extraneous-dependencies\nimport { modelsToOpenApi } from \"@visulima/crud\";\nimport debug from \"debug\";\nimport merge from \"lodash.merge\";\nimport { existsSync, readFileSync } from \"node:fs\";\nimport type { IncomingMessage, ServerResponse } from \"node:http\";\nimport path from \"node:path\";\nimport type { OpenAPIV3 } from \"openapi-types\";\n\nimport yamlTransformer from \"../connect/serializers/yaml\";\nimport extendSwaggerSpec from \"./extend-swagger-spec\";\n\n// eslint-disable-next-line testing-library/no-debugging-utils\nconst swaggerCrudDebug = debug(\"visulima:api-platform:swagger:crud:get-static-properties-swagger\");\n\nconst swaggerHandler = (\n options: Partial<{\n allowedMediaTypes: { [key: string]: boolean };\n swaggerFilePath: string;\n crud: Exclude<ModelsToOpenApiParameters, \"swagger\"> & {\n swagger?: {\n models?: SwaggerModelsConfig<string>;\n };\n };\n specs?: Partial<OpenAPIV3.Document>[];\n }> = {},\n) => {\n const {\n allowedMediaTypes = {\n \"application/json\": true,\n },\n swaggerFilePath,\n crud,\n specs,\n } = options;\n\n return async <Request extends IncomingMessage, Response extends ServerResponse>(request: Request, response: Response) => {\n const swaggerPath = path.join(process.cwd(), swaggerFilePath || \"swagger/swagger.json\");\n\n if (!existsSync(swaggerPath)) {\n throw new Error(`Swagger file not found at ${swaggerPath}. Did you change the output path in \"withOpenApi\" inside the next.config.js file?`);\n }\n\n const fileContents = readFileSync(swaggerPath, \"utf8\");\n\n let spec = extendSwaggerSpec(JSON.parse(fileContents) as OpenAPIV3.Document, allowedMediaTypes) as OpenAPIV3.Document;\n let crudSwagger: Partial<OpenAPIV3.Document> = {};\n\n if (crud !== undefined) {\n try {\n const modelsOpenApi = await modelsToOpenApi(crud);\n\n crudSwagger = {\n components: { schemas: modelsOpenApi.schemas, examples: modelsOpenApi.examples },\n tags: modelsOpenApi.tags as OpenAPIV3.TagObject[],\n paths: modelsOpenApi.paths,\n };\n\n crudSwagger = extendSwaggerSpec(crudSwagger, allowedMediaTypes);\n\n swaggerCrudDebug(JSON.stringify(crudSwagger, null, 2));\n\n spec = merge(spec, crudSwagger);\n } catch (error) {\n // eslint-disable-next-line no-console\n console.log(error);\n\n throw new Error(\"Please install @visulima/crud to use the crud swagger generator.\");\n }\n }\n\n if (Array.isArray(specs)) {\n specs.forEach((value) => {\n spec = merge(spec, extendSwaggerSpec(value, allowedMediaTypes));\n });\n }\n\n if (typeof request.headers.accept === \"string\" && /yaml|yml/.test(request.headers.accept)) {\n response.statusCode = 200;\n response.setHeader(\"Content-Type\", request.headers.accept);\n response.end(yamlTransformer(spec));\n } else {\n response.statusCode = 200;\n response.setHeader(\"Content-Type\", \"application/json\");\n response.end(JSON.stringify(spec, null, 2));\n }\n };\n};\n\nexport default swaggerHandler;\n","import { stringify } from \"yaml\";\n\nimport type { Serializer } from \"./types\";\n\nconst yamlTransformer: Serializer = (data) => stringify(data, { indent: 2 });\n\nexport default yamlTransformer;\n","/* eslint-disable no-param-reassign */\nimport { header as headerCase } from \"case\";\nimport { toXML } from \"jstoxml\";\nimport type { OpenAPIV3 } from \"openapi-types\";\nimport { stringify } from \"yaml\";\n\ntype Transformers = { regex: RegExp; transformer: (data: any) => string }[];\n\nconst jsonMediaType = \"application/json\";\n\nconst prepareStatusContent = (methodSpec: OpenAPIV3.OperationObject<{}>, status: string, mediaType: string) => {\n if (((methodSpec?.responses as unknown as OpenAPIV3.ResponsesObject)?.[status] as OpenAPIV3.ResponseObject)?.content === undefined) {\n ((methodSpec.responses as unknown as OpenAPIV3.ResponsesObject)[status] as OpenAPIV3.ResponseObject).content = {};\n }\n\n if (((methodSpec?.responses as unknown as OpenAPIV3.ResponsesObject)?.[status] as OpenAPIV3.ResponseObject)?.content?.[mediaType] === undefined) {\n (\n ((methodSpec.responses as unknown as OpenAPIV3.ResponsesObject)[status] as OpenAPIV3.ResponseObject).content as {\n [key: string]: OpenAPIV3.MediaTypeObject;\n }\n )[mediaType] = {} as OpenAPIV3.MediaTypeObject;\n }\n};\n\nconst extendComponentSchemas = (spec: Partial<OpenAPIV3.Document>, schemaName: string, schema: OpenAPIV3.SchemaObject) => {\n if (typeof spec.components !== \"object\") {\n spec.components = {};\n }\n\n if (typeof spec.components.schemas !== \"object\") {\n spec.components.schemas = {};\n }\n\n if (spec.components.schemas[schemaName] === undefined) {\n spec.components.schemas[schemaName] = schema;\n }\n};\n\nconst extendResponseSchema = (methodSpec: OpenAPIV3.OperationObject, status: string, mediaType: string, schemaName: string, schemaIsArray: boolean) => {\n prepareStatusContent(methodSpec, status, mediaType);\n\n if (((methodSpec?.responses as unknown as OpenAPIV3.ResponsesObject)?.[status] as OpenAPIV3.ResponseObject)?.content?.[mediaType]?.schema === undefined) {\n (\n (\n ((methodSpec.responses as unknown as OpenAPIV3.ResponsesObject)[status] as OpenAPIV3.ResponseObject).content as {\n [key: string]: OpenAPIV3.MediaTypeObject;\n }\n )[mediaType] as OpenAPIV3.MediaTypeObject\n ).schema = {} as OpenAPIV3.SchemaObject;\n }\n\n (\n (\n ((methodSpec.responses as unknown as OpenAPIV3.ResponsesObject)[status] as OpenAPIV3.ResponseObject).content as {\n [key: string]: OpenAPIV3.MediaTypeObject;\n }\n )[mediaType] as OpenAPIV3.MediaTypeObject\n ).schema = schemaIsArray\n ? {\n type: \"array\",\n items: {\n $ref: `#/components/schemas/${schemaName}`,\n },\n }\n : {\n $ref: `#/components/schemas/${schemaName}`,\n };\n};\n\nconst extendSwaggerWithMediaTypeSchema = (\n methodSpec: OpenAPIV3.OperationObject,\n responseSpec: OpenAPIV3.ResponseObject,\n allowedMediaTypes: { [p: string]: boolean } | undefined,\n pathKey: string,\n spec: Partial<OpenAPIV3.Document>,\n status: string,\n): {\n example?: any;\n examples?: {\n [media: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.ExampleObject;\n };\n} => {\n let example: any | undefined;\n let examples:\n | {\n [media: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.ExampleObject;\n }\n | undefined;\n\n // eslint-disable-next-line radar/cognitive-complexity\n Object.entries(responseSpec.content as object).forEach(([mediaName, contentSpec]) => {\n if (typeof contentSpec.schema === \"object\") {\n const { schema } = contentSpec;\n\n if (mediaName === jsonMediaType && contentSpec.examples !== undefined) {\n examples = contentSpec.examples;\n } else if (mediaName === jsonMediaType && contentSpec.example !== undefined) {\n example = contentSpec.example;\n }\n\n const schemaIsArray = (schema as OpenAPIV3.SchemaObject).type === \"array\";\n\n Object.entries(allowedMediaTypes || {}).forEach(([mediaType, allowed]) => {\n if (!allowed) {\n return;\n }\n\n let schemaName: string;\n\n if ((schema as OpenAPIV3.ReferenceObject).$ref === undefined) {\n // eslint-disable-next-line max-len\n schemaName = `${headerCase(pathKey.trim().replace(\"/\", \"\"))}${mediaType === \"application/ld+json\" ? \".jsonld\" : \"\"}`;\n\n extendComponentSchemas(spec as OpenAPIV3.Document, schemaName, schema as OpenAPIV3.SchemaObject);\n } else {\n // eslint-disable-next-line max-len\n schemaName = (schema as OpenAPIV3.ReferenceObject).$ref.replace(\"#/components/schemas/\", \"\");\n }\n\n extendResponseSchema(methodSpec, status, mediaType, schemaName, schemaIsArray);\n });\n }\n });\n\n return { examples, example };\n};\n\nconst extendSwaggerWithMediaTypeExample = (\n methodSpec: OpenAPIV3.OperationObject,\n responseSpec: OpenAPIV3.ResponseObject,\n status: string,\n allowedMediaTypes: { [p: string]: boolean } | undefined,\n transformers: Transformers,\n example: any,\n) => {\n Object.keys(responseSpec.content as object).forEach((mediaName) => {\n if (mediaName === jsonMediaType) {\n return;\n }\n\n Object.entries(allowedMediaTypes || {}).forEach(([mediaType, allowed]) => {\n if (!allowed) {\n return;\n }\n\n prepareStatusContent(methodSpec, status, mediaType);\n\n if (\n ((methodSpec?.responses as unknown as OpenAPIV3.ResponsesObject)?.[status] as OpenAPIV3.ResponseObject)?.content?.[mediaType]?.example\n === undefined\n ) {\n (\n (\n ((methodSpec.responses as unknown as OpenAPIV3.ResponsesObject)[status] as OpenAPIV3.ResponseObject).content as {\n [key: string]: OpenAPIV3.MediaTypeObject;\n }\n )[mediaType] as OpenAPIV3.MediaTypeObject\n ).example = {};\n }\n\n let transformed = false;\n\n transformers.forEach(({ regex, transformer }) => {\n if (!transformed && regex.test(mediaType)) {\n (\n (\n ((methodSpec.responses as unknown as OpenAPIV3.ResponsesObject)[status] as OpenAPIV3.ResponseObject).content as {\n [key: string]: OpenAPIV3.MediaTypeObject;\n }\n )[mediaType] as OpenAPIV3.MediaTypeObject\n ).example = transformer(example);\n\n transformed = true;\n }\n });\n\n if (!transformed) {\n (\n (\n ((methodSpec.responses as unknown as OpenAPIV3.ResponsesObject)[status] as OpenAPIV3.ResponseObject).content as {\n [key: string]: OpenAPIV3.MediaTypeObject;\n }\n )[mediaType] as OpenAPIV3.MediaTypeObject\n ).example = example;\n }\n });\n });\n};\n\nconst extendComponentExamples = (\n spec: Partial<OpenAPIV3.Document>,\n exampleName: string,\n examples: {\n [media: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.ExampleObject;\n },\n) => {\n if (typeof spec.components !== \"object\") {\n spec.components = {};\n }\n\n if (typeof spec.components.examples !== \"object\") {\n spec.components.examples = {};\n }\n\n if (spec.components.examples[exampleName] === undefined && examples[exampleName] !== undefined) {\n spec.components.examples[exampleName] = examples[exampleName] as OpenAPIV3.ExampleObject;\n }\n};\n\nconst prepareResponseExamples = (\n spec: Partial<OpenAPIV3.Document>,\n methodSpec: OpenAPIV3.OperationObject,\n status: string,\n mediaType: string,\n transformers: Transformers,\n examples: {\n [media: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.ExampleObject;\n },\n // eslint-disable-next-line radar/cognitive-complexity\n) => {\n prepareStatusContent(methodSpec, status, mediaType);\n\n if (((methodSpec?.responses as unknown as OpenAPIV3.ResponsesObject)?.[status] as OpenAPIV3.ResponseObject)?.content?.[mediaType]?.examples === undefined) {\n (\n (\n ((methodSpec.responses as unknown as OpenAPIV3.ResponsesObject)[status] as OpenAPIV3.ResponseObject).content as {\n [key: string]: OpenAPIV3.MediaTypeObject;\n }\n )[mediaType] as OpenAPIV3.MediaTypeObject\n ).examples = {};\n }\n\n const transformedExamples: {\n [media: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.ExampleObject;\n } = {};\n\n Object.entries(examples).forEach(([exampleName, example]) => {\n let transformed = false;\n\n transformers.forEach(({ regex, transformer }) => {\n if (!transformed && regex.test(mediaType)) {\n let data: any = \"\";\n\n if ((spec.components?.examples?.[exampleName] as OpenAPIV3.ExampleObject) !== undefined) {\n data = (spec.components?.examples?.[exampleName] as OpenAPIV3.ExampleObject).value;\n } else if (example as OpenAPIV3.ReferenceObject) {\n data = (\n spec.components?.examples?.[\n (example as OpenAPIV3.ReferenceObject).$ref.replace(\"#/components/examples/\", \"\")\n ] as OpenAPIV3.ExampleObject\n ).value;\n } else if (typeof (example as OpenAPIV3.ExampleObject)?.value === \"string\") {\n data = (example as OpenAPIV3.ExampleObject).value;\n }\n\n transformedExamples[exampleName] = {\n value: transformer(data),\n };\n\n transformed = true;\n }\n });\n\n if (!transformed) {\n transformedExamples[exampleName] = spec.components?.examples?.[exampleName] === undefined\n ? example\n : {\n $ref: `#/components/examples/${exampleName}`,\n };\n }\n });\n\n (\n (\n ((methodSpec.responses as unknown as OpenAPIV3.ResponsesObject)[status] as OpenAPIV3.ResponseObject).content as {\n [key: string]: OpenAPIV3.MediaTypeObject;\n }\n )[mediaType] as OpenAPIV3.MediaTypeObject\n ).examples = transformedExamples;\n};\n\nconst extendSwaggerWithMediaTypeExamples = (\n spec: Partial<OpenAPIV3.Document>,\n methodSpec: OpenAPIV3.OperationObject,\n status: string,\n responseSpec: OpenAPIV3.ResponseObject,\n allowedMediaTypes: { [p: string]: boolean } | undefined,\n pathKey: string,\n transformers: Transformers,\n examples: {\n [media: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.ExampleObject;\n },\n) => {\n const examplesName = `${headerCase(pathKey.trim().replace(\"/\", \"\"))}`;\n\n Object.keys(responseSpec.content as object).forEach((mediaName) => {\n if (mediaName === jsonMediaType) {\n return;\n }\n\n Object.entries(allowedMediaTypes || {}).forEach(([mediaType, allowed]) => {\n if (!allowed) {\n return;\n }\n\n extendComponentExamples(spec, examplesName, examples);\n\n prepareResponseExamples(spec, methodSpec, status, mediaType, transformers, examples);\n });\n });\n};\n\n// eslint-disable-next-line radar/cognitive-complexity\nexport default function extendSwaggerSpec(\n spec: Partial<OpenAPIV3.Document>,\n allowedMediaTypes?: { [key: string]: boolean },\n transformers: Transformers = [\n {\n regex: /xml/,\n transformer: (value) => toXML(value, {\n header: true,\n indent: \" \",\n }),\n },\n {\n regex: /yaml|yml/,\n transformer: (value) => stringify(value, { indent: 2 }),\n },\n ],\n): Partial<OpenAPIV3.Document> {\n if (typeof spec === \"object\" && typeof spec.paths === \"object\") {\n Object.entries(spec.paths).forEach(([pathKey, pathSpec]) => {\n Object.values(pathSpec as OpenAPIV3.PathsObject & OpenAPIV3.OperationObject).forEach((methodSpec) => {\n if (typeof (methodSpec as OpenAPIV3.OperationObject).responses === \"object\") {\n Object.entries((methodSpec as OpenAPIV3.OperationObject).responses).forEach(([status, responseSpec]) => {\n if (typeof (responseSpec as OpenAPIV3.ResponseObject).content === \"object\") {\n const { examples, example } = extendSwaggerWithMediaTypeSchema(\n methodSpec as OpenAPIV3.OperationObject,\n responseSpec as OpenAPIV3.ResponseObject,\n allowedMediaTypes,\n pathKey,\n spec,\n status,\n );\n\n if (example !== undefined) {\n extendSwaggerWithMediaTypeExample(\n methodSpec as OpenAPIV3.OperationObject,\n responseSpec as OpenAPIV3.ResponseObject,\n status,\n allowedMediaTypes,\n transformers,\n example,\n );\n } else if (examples !== undefined) {\n extendSwaggerWithMediaTypeExamples(\n spec,\n methodSpec as OpenAPIV3.OperationObject,\n status,\n responseSpec as OpenAPIV3.ResponseObject,\n allowedMediaTypes,\n pathKey,\n transformers,\n examples,\n );\n }\n }\n });\n }\n });\n });\n }\n\n return spec;\n}\n\n/* eslint-enable no-param-reassign */\n"],"mappings":";AAGA,SAAS,uBAAuB;AAChC,OAAO,WAAW;AAClB,OAAO,WAAW;AAClB,SAAS,YAAY,oBAAoB;AAEzC,OAAO,UAAU;;;ACRjB,SAAS,iBAAiB;AAI1B,IAAM,kBAA8B,CAAC,SAAS,UAAU,MAAM,EAAE,QAAQ,EAAE,CAAC;AAE3E,IAAO,eAAQ;;;ACLf,SAAS,UAAU,kBAAkB;AACrC,SAAS,aAAa;AAEtB,SAAS,aAAAA,kBAAiB;AAI1B,IAAM,gBAAgB;AAEtB,IAAM,uBAAuB,CAAC,YAA2C,QAAgB,cAAsB;AAV/G;AAWI,QAAM,oDAAY,cAAZ,mBAAiE,YAAjE,mBAAuG,aAAY,QAAW;AAChI,IAAE,WAAW,UAAmD,QAAqC,UAAU,CAAC;AAAA,EACpH;AAEA,QAAM,0DAAY,cAAZ,mBAAiE,YAAjE,mBAAuG,YAAvG,mBAAiH,gBAAe,QAAW;AAC7I,IACM,WAAW,UAAmD,QAAqC,QAGvG,aAAa,CAAC;AAAA,EACpB;AACJ;AAEA,IAAM,yBAAyB,CAAC,MAAmC,YAAoB,WAAmC;AACtH,MAAI,OAAO,KAAK,eAAe,UAAU;AACrC,SAAK,aAAa,CAAC;AAAA,EACvB;AAEA,MAAI,OAAO,KAAK,WAAW,YAAY,UAAU;AAC7C,SAAK,WAAW,UAAU,CAAC;AAAA,EAC/B;AAEA,MAAI,KAAK,WAAW,QAAQ,gBAAgB,QAAW;AACnD,SAAK,WAAW,QAAQ,cAAc;AAAA,EAC1C;AACJ;AAEA,IAAM,uBAAuB,CAAC,YAAuC,QAAgB,WAAmB,YAAoB,kBAA2B;AAtCvJ;AAuCI,uBAAqB,YAAY,QAAQ,SAAS;AAElD,QAAM,gEAAY,cAAZ,mBAAiE,YAAjE,mBAAuG,YAAvG,mBAAiH,eAAjH,mBAA6H,YAAW,QAAW;AACrJ,IAEU,WAAW,UAAmD,QAAqC,QAGvG,WACJ,SAAS,CAAC;AAAA,EAChB;AAEA,EAEU,WAAW,UAAmD,QAAqC,QAGvG,WACJ,SAAS,gBACL;AAAA,IACE,MAAM;AAAA,IACN,OAAO;AAAA,MACH,MAAM,wBAAwB;AAAA,IAClC;AAAA,EACJ,IACE;AAAA,IACE,MAAM,wBAAwB;AAAA,EAClC;AACR;AAEA,IAAM,mCAAmC,CACrC,YACA,cACA,mBACA,SACA,MACA,WAMC;AACD,MAAI;AACJ,MAAI;AAOJ,SAAO,QAAQ,aAAa,OAAiB,EAAE,QAAQ,CAAC,CAAC,WAAW,WAAW,MAAM;AACjF,QAAI,OAAO,YAAY,WAAW,UAAU;AACxC,YAAM,EAAE,OAAO,IAAI;AAEnB,UAAI,cAAc,iBAAiB,YAAY,aAAa,QAAW;AACnE,mBAAW,YAAY;AAAA,MAC3B,WAAW,cAAc,iBAAiB,YAAY,YAAY,QAAW;AACzE,kBAAU,YAAY;AAAA,MAC1B;AAEA,YAAM,gBAAiB,OAAkC,SAAS;AAElE,aAAO,QAAQ,qBAAqB,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,WAAW,OAAO,MAAM;AACtE,YAAI,CAAC,SAAS;AACV;AAAA,QACJ;AAEA,YAAI;AAEJ,YAAK,OAAqC,SAAS,QAAW;AAE1D,uBAAa,GAAG,WAAW,QAAQ,KAAK,EAAE,QAAQ,KAAK,EAAE,CAAC,IAAI,cAAc,wBAAwB,YAAY;AAEhH,iCAAuB,MAA4B,YAAY,MAAgC;AAAA,QACnG,OAAO;AAEH,uBAAc,OAAqC,KAAK,QAAQ,yBAAyB,EAAE;AAAA,QAC/F;AAEA,6BAAqB,YAAY,QAAQ,WAAW,YAAY,aAAa;AAAA,MACjF,CAAC;AAAA,IACL;AAAA,EACJ,CAAC;AAED,SAAO,EAAE,UAAU,QAAQ;AAC/B;AAEA,IAAM,oCAAoC,CACtC,YACA,cACA,QACA,mBACA,cACA,YACC;AACD,SAAO,KAAK,aAAa,OAAiB,EAAE,QAAQ,CAAC,cAAc;AAC/D,QAAI,cAAc,eAAe;AAC7B;AAAA,IACJ;AAEA,WAAO,QAAQ,qBAAqB,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,WAAW,OAAO,MAAM;AA5IlF;AA6IY,UAAI,CAAC,SAAS;AACV;AAAA,MACJ;AAEA,2BAAqB,YAAY,QAAQ,SAAS;AAElD,YACM,gEAAY,cAAZ,mBAAiE,YAAjE,mBAAuG,YAAvG,mBAAiH,eAAjH,mBAA6H,aAC3H,QACN;AACE,QAEU,WAAW,UAAmD,QAAqC,QAGvG,WACJ,UAAU,CAAC;AAAA,MACjB;AAEA,UAAI,cAAc;AAElB,mBAAa,QAAQ,CAAC,EAAE,OAAO,YAAY,MAAM;AAC7C,YAAI,CAAC,eAAe,MAAM,KAAK,SAAS,GAAG;AACvC,UAEU,WAAW,UAAmD,QAAqC,QAGvG,WACJ,UAAU,YAAY,OAAO;AAE/B,wBAAc;AAAA,QAClB;AAAA,MACJ,CAAC;AAED,UAAI,CAAC,aAAa;AACd,QAEU,WAAW,UAAmD,QAAqC,QAGvG,WACJ,UAAU;AAAA,MAChB;AAAA,IACJ,CAAC;AAAA,EACL,CAAC;AACL;AAEA,IAAM,0BAA0B,CAC5B,MACA,aACA,aAGC;AACD,MAAI,OAAO,KAAK,eAAe,UAAU;AACrC,SAAK,aAAa,CAAC;AAAA,EACvB;AAEA,MAAI,OAAO,KAAK,WAAW,aAAa,UAAU;AAC9C,SAAK,WAAW,WAAW,CAAC;AAAA,EAChC;AAEA,MAAI,KAAK,WAAW,SAAS,iBAAiB,UAAa,SAAS,iBAAiB,QAAW;AAC5F,SAAK,WAAW,SAAS,eAAe,SAAS;AAAA,EACrD;AACJ;AAEA,IAAM,0BAA0B,CAC5B,MACA,YACA,QACA,WACA,cACA,aAIC;AA3NL;AA4NI,uBAAqB,YAAY,QAAQ,SAAS;AAElD,QAAM,gEAAY,cAAZ,mBAAiE,YAAjE,mBAAuG,YAAvG,mBAAiH,eAAjH,mBAA6H,cAAa,QAAW;AACvJ,IAEU,WAAW,UAAmD,QAAqC,QAGvG,WACJ,WAAW,CAAC;AAAA,EAClB;AAEA,QAAM,sBAEF,CAAC;AAEL,SAAO,QAAQ,QAAQ,EAAE,QAAQ,CAAC,CAAC,aAAa,OAAO,MAAM;AA5OjE,QAAAC,KAAAC;AA6OQ,QAAI,cAAc;AAElB,iBAAa,QAAQ,CAAC,EAAE,OAAO,YAAY,MAAM;AA/OzD,UAAAD,KAAAC,KAAAC,KAAAC,KAAA;AAgPY,UAAI,CAAC,eAAe,MAAM,KAAK,SAAS,GAAG;AACvC,YAAI,OAAY;AAEhB,cAAKF,OAAAD,MAAA,KAAK,eAAL,gBAAAA,IAAiB,aAAjB,gBAAAC,IAA4B,kBAA6C,QAAW;AACrF,mBAAQE,OAAAD,MAAA,KAAK,eAAL,gBAAAA,IAAiB,aAAjB,gBAAAC,IAA4B,cAAyC;AAAA,QACjF,WAAW,SAAsC;AAC7C,mBACI,gBAAK,eAAL,mBAAiB,aAAjB,mBACK,QAAsC,KAAK,QAAQ,0BAA0B,EAAE,IAEtF;AAAA,QACN,WAAW,QAAQ,mCAAqC,WAAU,UAAU;AACxE,iBAAQ,QAAoC;AAAA,QAChD;AAEA,4BAAoB,eAAe;AAAA,UAC/B,OAAO,YAAY,IAAI;AAAA,QAC3B;AAEA,sBAAc;AAAA,MAClB;AAAA,IACJ,CAAC;AAED,QAAI,CAAC,aAAa;AACd,0BAAoB,iBAAeF,OAAAD,MAAA,KAAK,eAAL,gBAAAA,IAAiB,aAAjB,gBAAAC,IAA4B,kBAAiB,SAC1E,UACA;AAAA,QACE,MAAM,yBAAyB;AAAA,MACnC;AAAA,IACR;AAAA,EACJ,CAAC;AAED,EAEU,WAAW,UAAmD,QAAqC,QAGvG,WACJ,WAAW;AACjB;AAEA,IAAM,qCAAqC,CACvC,MACA,YACA,QACA,cACA,mBACA,SACA,cACA,aAGC;AACD,QAAM,eAAe,GAAG,WAAW,QAAQ,KAAK,EAAE,QAAQ,KAAK,EAAE,CAAC;AAElE,SAAO,KAAK,aAAa,OAAiB,EAAE,QAAQ,CAAC,cAAc;AAC/D,QAAI,cAAc,eAAe;AAC7B;AAAA,IACJ;AAEA,WAAO,QAAQ,qBAAqB,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,WAAW,OAAO,MAAM;AACtE,UAAI,CAAC,SAAS;AACV;AAAA,MACJ;AAEA,8BAAwB,MAAM,cAAc,QAAQ;AAEpD,8BAAwB,MAAM,YAAY,QAAQ,WAAW,cAAc,QAAQ;AAAA,IACvF,CAAC;AAAA,EACL,CAAC;AACL;AAGe,SAAR,kBACH,MACA,mBACA,eAA6B;AAAA,EACzB;AAAA,IACI,OAAO;AAAA,IACP,aAAa,CAAC,UAAU,MAAM,OAAO;AAAA,MACjC,QAAQ;AAAA,MACR,QAAQ;AAAA,IACZ,CAAC;AAAA,EACL;AAAA,EACA;AAAA,IACI,OAAO;AAAA,IACP,aAAa,CAAC,UAAUF,WAAU,OAAO,EAAE,QAAQ,EAAE,CAAC;AAAA,EAC1D;AACJ,GAC2B;AAC3B,MAAI,OAAO,SAAS,YAAY,OAAO,KAAK,UAAU,UAAU;AAC5D,WAAO,QAAQ,KAAK,KAAK,EAAE,QAAQ,CAAC,CAAC,SAAS,QAAQ,MAAM;AACxD,aAAO,OAAO,QAA6D,EAAE,QAAQ,CAAC,eAAe;AACjG,YAAI,OAAQ,WAAyC,cAAc,UAAU;AACzE,iBAAO,QAAS,WAAyC,SAAS,EAAE,QAAQ,CAAC,CAAC,QAAQ,YAAY,MAAM;AACpG,gBAAI,OAAQ,aAA0C,YAAY,UAAU;AACxE,oBAAM,EAAE,UAAU,QAAQ,IAAI;AAAA,gBAC1B;AAAA,gBACA;AAAA,gBACA;AAAA,gBACA;AAAA,gBACA;AAAA,gBACA;AAAA,cACJ;AAEA,kBAAI,YAAY,QAAW;AACvB;AAAA,kBACI;AAAA,kBACA;AAAA,kBACA;AAAA,kBACA;AAAA,kBACA;AAAA,kBACA;AAAA,gBACJ;AAAA,cACJ,WAAW,aAAa,QAAW;AAC/B;AAAA,kBACI;AAAA,kBACA;AAAA,kBACA;AAAA,kBACA;AAAA,kBACA;AAAA,kBACA;AAAA,kBACA;AAAA,kBACA;AAAA,gBACJ;AAAA,cACJ;AAAA,YACJ;AAAA,UACJ,CAAC;AAAA,QACL;AAAA,MACJ,CAAC;AAAA,IACL,CAAC;AAAA,EACL;AAEA,SAAO;AACX;;;AFvWA,IAAM,mBAAmB,MAAM,kEAAkE;AAEjG,IAAM,iBAAiB,CACnB,UASK,CAAC,MACL;AACD,QAAM;AAAA,IACF,oBAAoB;AAAA,MAChB,oBAAoB;AAAA,IACxB;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACJ,IAAI;AAEJ,SAAO,OAAyE,SAAkB,aAAuB;AACrH,UAAM,cAAc,KAAK,KAAK,QAAQ,IAAI,GAAG,mBAAmB,sBAAsB;AAEtF,QAAI,CAAC,WAAW,WAAW,GAAG;AAC1B,YAAM,IAAI,MAAM,6BAA6B,8FAA8F;AAAA,IAC/I;AAEA,UAAM,eAAe,aAAa,aAAa,MAAM;AAErD,QAAI,OAAO,kBAAkB,KAAK,MAAM,YAAY,GAAyB,iBAAiB;AAC9F,QAAI,cAA2C,CAAC;AAEhD,QAAI,SAAS,QAAW;AACpB,UAAI;AACA,cAAM,gBAAgB,MAAM,gBAAgB,IAAI;AAEhD,sBAAc;AAAA,UACV,YAAY,EAAE,SAAS,cAAc,SAAS,UAAU,cAAc,SAAS;AAAA,UAC/E,MAAM,cAAc;AAAA,UACpB,OAAO,cAAc;AAAA,QACzB;AAEA,sBAAc,kBAAkB,aAAa,iBAAiB;AAE9D,yBAAiB,KAAK,UAAU,aAAa,MAAM,CAAC,CAAC;AAErD,eAAO,MAAM,MAAM,WAAW;AAAA,MAClC,SAAS,OAAP;AAEE,gBAAQ,IAAI,KAAK;AAEjB,cAAM,IAAI,MAAM,kEAAkE;AAAA,MACtF;AAAA,IACJ;AAEA,QAAI,MAAM,QAAQ,KAAK,GAAG;AACtB,YAAM,QAAQ,CAAC,UAAU;AACrB,eAAO,MAAM,MAAM,kBAAkB,OAAO,iBAAiB,CAAC;AAAA,MAClE,CAAC;AAAA,IACL;AAEA,QAAI,OAAO,QAAQ,QAAQ,WAAW,YAAY,WAAW,KAAK,QAAQ,QAAQ,MAAM,GAAG;AACvF,eAAS,aAAa;AACtB,eAAS,UAAU,gBAAgB,QAAQ,QAAQ,MAAM;AACzD,eAAS,IAAI,aAAgB,IAAI,CAAC;AAAA,IACtC,OAAO;AACH,eAAS,aAAa;AACtB,eAAS,UAAU,gBAAgB,kBAAkB;AACrD,eAAS,IAAI,KAAK,UAAU,MAAM,MAAM,CAAC,CAAC;AAAA,IAC9C;AAAA,EACJ;AACJ;AAEA,IAAO,0BAAQ;","names":["stringify","_a","_b","_c","_d"]}
|