@1szx1/vite-plugin-swagger2ts 1.3.10 → 1.3.12

package/dist/index.cjs

@@ -14,6 +14,13 @@ function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'defau
 const fetch__default = /*#__PURE__*/_interopDefaultCompat(fetch);
 const chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
 
+const pluginName = "vite-plugin-swagger2ts";
+const CODE_PREFIX = `/* eslint-disable */
+/* prettier-ignore */
+// @ts-nocheck
+// noinspection JSUnusedGlobalSymbols
+// Generated by ${pluginName}
+`;
 function loadConfig() {
   return unconfig.loadConfig({
     sources: [
@@ -35,7 +42,7 @@ async function resolveOptions(userOptions) {
     const { output } = item;
     const root = process.cwd();
     const outputFile = output ? output?.endsWith(".ts") ? output : output + ".ts" : "./src/swagger.ts";
-    return Object.assign({ output: path.resolve(root, outputFile) }, item);
+    return { ...item, output: path.resolve(root, outputFile) };
   });
 }
 async function fetchUrl(url) {
@@ -75,6 +82,7 @@ function getRefName($ref, prefix = "") {
   return getSchemaName(prefix) + getSchemaName($ref || "");
 }
 
+const METHODS = ["get", "put", "post", "delete", "options", "head", "patch", "trace"];
 function generateDocs(input, { docsName, baseUrl, formatSchema }) {
   function getRefObject(ref) {
     return ref.split("/").slice(1).reduce((obj, item) => {
@@ -85,7 +93,7 @@ function generateDocs(input, { docsName, baseUrl, formatSchema }) {
     const pathValue = value;
     const parametersExtended = pathValue.parameters;
     const result = Object.entries(pathValue).map(([method, options]) => {
-      if (!["get", "put", "post", "delete", "options", "head", "patch", "trace"].includes(method)) {
+      if (!METHODS.includes(method)) {
         return;
       }
       let allParameters = [...parametersExtended || [], ...options.parameters || []].map((item) => {
@@ -214,6 +222,21 @@ ${title ? ` * @title ${title}
 ` : `${key}${isRequired === false ? "?" : ""}: ${result};
 `}`;
 }
+function generatorMethodType(intersection) {
+  const paramKeys = ["body", "query", "path"];
+  const genTypeCode = (method, key) => {
+    const paths = `keyof FilterOptional<${intersection}, { ${method}: { param: { ${key}: any } } }`;
+    return `export type ${toPascalCase(method)}${toPascalCase(key)}<T extends ${paths}>> = ${intersection}[T]['${method}']['param']['${key}'];`;
+  };
+  return METHODS.reduce((total, method) => {
+    const responseCode = `export type ${toPascalCase(method)}${toPascalCase("response")}<T extends keyof ${intersection}> = ${intersection}[T]['${method}']['response'];`;
+    const code = paramKeys.reduce((total1, key) => `${total1}
+${genTypeCode(method, key)}`, responseCode);
+    return `${total}${total && `
+
+`}${code}`;
+  }, "");
+}
 function getPathsName(docsName) {
   return `Paths${getRefName(docsName)}`;
 }
@@ -231,7 +254,9 @@ async function loadSwaggerSource(options) {
       else
         throw new Error(JSON.stringify(docs));
     }
-    return generateDocs(docs, { docsName, baseUrl: docs.basePath ?? "", formatSchema });
+    const res = generateDocs(docs, { docsName, baseUrl: docs.basePath ?? "", formatSchema });
+    console.log(chalk__default.green(`[${pluginName}]: ${docsName} success`));
+    return res;
   }
   async function genResourcesCode(source) {
     const { url, name } = source;
@@ -240,60 +265,87 @@ async function loadSwaggerSource(options) {
       const code2 = await genInterface(docs, name);
       return code2;
     } catch (error) {
-      console.log(chalk__default.yellow(`[vite-plugin-swagger2ts]: ${name} error;`) + error.message);
+      console.log(chalk__default.yellow(`[${pluginName}]: ${name} error;`) + error.message);
       return "";
     }
   }
   async function getSources() {
-    let sources2 = void 0;
-    let interfaces2 = [];
+    const sources2 = [];
+    const interfaces2 = [];
     if (typeof swaggerUrl === "string") {
       const resources = await fetchUrl(`${swaggerUrl}/swagger-resources;`).catch((error) => error);
       if (Array.isArray(resources)) {
-        sources2 = resources;
-        interfaces2.push(...await Promise.all(sources2.map(genResourcesCode)));
+        sources2.push(...resources);
+        interfaces2.push(...await Promise.all(resources.map(genResourcesCode)));
       } else {
-        console.log(chalk__default.yellow(`[vite-plugin-swagger2ts]: resources error`) + JSON.stringify(resources));
+        console.log(chalk__default.yellow(`[${pluginName}]: resources error`) + JSON.stringify(resources));
       }
     }
     if (typeof jsonUrl === "string") {
       const swaggerJson = await fetchUrl(jsonUrl);
-      if (!swaggerJson.info)
-        return console.log(chalk__default.yellow(`[vite-plugin-swagger2ts]: jsonUrl error;`) + JSON.stringify(swaggerJson));
-      interfaces2.push(await genInterface(swaggerJson, getApiName(swaggerJson)));
+      if (swaggerJson.info) {
+        const name = getApiName(swaggerJson);
+        interfaces2.push(await genInterface(swaggerJson, name));
+        sources2.push({ name });
+      } else {
+        console.log(chalk__default.yellow(`[${pluginName}]: jsonUrl error;`) + JSON.stringify(swaggerJson));
+      }
     }
     if (typeof jsonPath === "string") {
       const _jsonPath = path.resolve(process.cwd(), jsonPath);
       const swaggerJson = JSON.parse(fs.readFileSync(_jsonPath, { encoding: "utf-8" }));
-      interfaces2.push(await genInterface(swaggerJson, getApiName(swaggerJson)));
+      const name = getApiName(swaggerJson);
+      interfaces2.push(await genInterface(swaggerJson, name));
+      sources2.push({ name });
     }
     return { sources: sources2, interfaces: interfaces2 };
   }
-  const { sources, interfaces } = await getSources() || {};
-  if (!interfaces?.length)
+  const { sources, interfaces } = await getSources();
+  if (!interfaces.length)
     return;
-  const prefix = `/* eslint-disable */
-/* prettier-ignore */
-// @ts-nocheck
-// noinspection JSUnusedGlobalSymbols
-// Generated by vite-plugin-swagger2ts`;
   const code = interfaces.reduce((a, b) => a + b, "");
-  const suffix = sources ? interfaces.reduce((a, b, index) => {
+  const suffix = interfaces.reduce((a, b, index) => {
     if (b) {
       a += !a ? `export type ${getPathsName("_Intersection")} = ` : `&`;
-      a += `${getPathsName(sources[index].name)}`;
+      const { name } = sources[index];
+      a += name ? getPathsName(name) : "any";
     }
     return a;
-  }, "") : "";
+  }, "");
   const outputFile = path.resolve(process.cwd(), output);
-  fs.writeFileSync(outputFile, prefix + code + suffix);
+  fs.writeFileSync(outputFile, CODE_PREFIX + code + suffix);
+  return { sources, interfaces };
+}
+function loadGlobTypes({ glob, output }) {
+  if (!glob)
+    return;
+  const outputFile = path.resolve(process.cwd(), glob.output || "auto-types.d.ts");
+  const importPath = path.relative(outputFile, output).replaceAll("\\", "/").replace(/^\.\.\//, "./");
+  const intersection = getPathsName("_Intersection");
+  const code = `${CODE_PREFIX}import { ${intersection} } from '${importPath}'
+
+type FilterOptional<Source, Condition> = Pick<
+  Source,
+  {
+    [K in keyof Source]: Source[K] extends Condition ? K : never;
+  }[keyof Source]
+>
+
+declare global {
+  export namespace ${glob.namespace} {
+    ${generatorMethodType(intersection)}
+  }
+}`;
+  fs.writeFileSync(outputFile, code);
 }
 function swagger2TsPlugin(userOptions) {
-  resolveOptions(userOptions).then((options) => {
-    Promise.all(options.map(loadSwaggerSource));
-  });
+  (async () => {
+    const options = await resolveOptions(userOptions);
+    await Promise.all(options.map(loadSwaggerSource));
+    options.forEach(loadGlobTypes);
+  })();
   return {
-    name: "vite-plugin-swagger2ts",
+    name: `${pluginName}`,
     enforce: "pre",
     apply: "serve"
   };

package/dist/index.d.cts

@@ -18,6 +18,10 @@ interface Options {
     output?: string;
     formatDocs?: (docs: SwaggerDoc | OpenAPIObject) => typeof docs;
     formatSchema?: FormatSchema;
+    glob?: {
+        namespace: string;
+        output?: string;
+    };
 }
 type UserOptions = Options | {
     sources: Options[];

package/dist/index.d.mts

@@ -18,6 +18,10 @@ interface Options {
     output?: string;
     formatDocs?: (docs: SwaggerDoc | OpenAPIObject) => typeof docs;
     formatSchema?: FormatSchema;
+    glob?: {
+        namespace: string;
+        output?: string;
+    };
 }
 type UserOptions = Options | {
     sources: Options[];

package/dist/index.d.ts

@@ -18,6 +18,10 @@ interface Options {
     output?: string;
     formatDocs?: (docs: SwaggerDoc | OpenAPIObject) => typeof docs;
     formatSchema?: FormatSchema;
+    glob?: {
+        namespace: string;
+        output?: string;
+    };
 }
 type UserOptions = Options | {
     sources: Options[];

package/dist/index.mjs

@@ -1,10 +1,17 @@
 import { writeFileSync, readFileSync } from 'fs';
-import { resolve } from 'path';
+import { resolve, relative } from 'path';
 import { convertObj } from 'swagger2openapi';
 import fetch from 'cross-fetch';
 import { loadConfig as loadConfig$1 } from 'unconfig';
 import chalk from 'chalk';
 
+const pluginName = "vite-plugin-swagger2ts";
+const CODE_PREFIX = `/* eslint-disable */
+/* prettier-ignore */
+// @ts-nocheck
+// noinspection JSUnusedGlobalSymbols
+// Generated by ${pluginName}
+`;
 function loadConfig() {
   return loadConfig$1({
     sources: [
@@ -26,7 +33,7 @@ async function resolveOptions(userOptions) {
     const { output } = item;
     const root = process.cwd();
     const outputFile = output ? output?.endsWith(".ts") ? output : output + ".ts" : "./src/swagger.ts";
-    return Object.assign({ output: resolve(root, outputFile) }, item);
+    return { ...item, output: resolve(root, outputFile) };
   });
 }
 async function fetchUrl(url) {
@@ -66,6 +73,7 @@ function getRefName($ref, prefix = "") {
   return getSchemaName(prefix) + getSchemaName($ref || "");
 }
 
+const METHODS = ["get", "put", "post", "delete", "options", "head", "patch", "trace"];
 function generateDocs(input, { docsName, baseUrl, formatSchema }) {
   function getRefObject(ref) {
     return ref.split("/").slice(1).reduce((obj, item) => {
@@ -76,7 +84,7 @@ function generateDocs(input, { docsName, baseUrl, formatSchema }) {
     const pathValue = value;
     const parametersExtended = pathValue.parameters;
     const result = Object.entries(pathValue).map(([method, options]) => {
-      if (!["get", "put", "post", "delete", "options", "head", "patch", "trace"].includes(method)) {
+      if (!METHODS.includes(method)) {
         return;
       }
       let allParameters = [...parametersExtended || [], ...options.parameters || []].map((item) => {
@@ -205,6 +213,21 @@ ${title ? ` * @title ${title}
 ` : `${key}${isRequired === false ? "?" : ""}: ${result};
 `}`;
 }
+function generatorMethodType(intersection) {
+  const paramKeys = ["body", "query", "path"];
+  const genTypeCode = (method, key) => {
+    const paths = `keyof FilterOptional<${intersection}, { ${method}: { param: { ${key}: any } } }`;
+    return `export type ${toPascalCase(method)}${toPascalCase(key)}<T extends ${paths}>> = ${intersection}[T]['${method}']['param']['${key}'];`;
+  };
+  return METHODS.reduce((total, method) => {
+    const responseCode = `export type ${toPascalCase(method)}${toPascalCase("response")}<T extends keyof ${intersection}> = ${intersection}[T]['${method}']['response'];`;
+    const code = paramKeys.reduce((total1, key) => `${total1}
+${genTypeCode(method, key)}`, responseCode);
+    return `${total}${total && `
+
+`}${code}`;
+  }, "");
+}
 function getPathsName(docsName) {
   return `Paths${getRefName(docsName)}`;
 }
@@ -222,7 +245,9 @@ async function loadSwaggerSource(options) {
       else
         throw new Error(JSON.stringify(docs));
     }
-    return generateDocs(docs, { docsName, baseUrl: docs.basePath ?? "", formatSchema });
+    const res = generateDocs(docs, { docsName, baseUrl: docs.basePath ?? "", formatSchema });
+    console.log(chalk.green(`[${pluginName}]: ${docsName} success`));
+    return res;
   }
   async function genResourcesCode(source) {
     const { url, name } = source;
@@ -231,60 +256,87 @@ async function loadSwaggerSource(options) {
       const code2 = await genInterface(docs, name);
       return code2;
     } catch (error) {
-      console.log(chalk.yellow(`[vite-plugin-swagger2ts]: ${name} error;`) + error.message);
+      console.log(chalk.yellow(`[${pluginName}]: ${name} error;`) + error.message);
       return "";
     }
   }
   async function getSources() {
-    let sources2 = void 0;
-    let interfaces2 = [];
+    const sources2 = [];
+    const interfaces2 = [];
     if (typeof swaggerUrl === "string") {
       const resources = await fetchUrl(`${swaggerUrl}/swagger-resources;`).catch((error) => error);
       if (Array.isArray(resources)) {
-        sources2 = resources;
-        interfaces2.push(...await Promise.all(sources2.map(genResourcesCode)));
+        sources2.push(...resources);
+        interfaces2.push(...await Promise.all(resources.map(genResourcesCode)));
       } else {
-        console.log(chalk.yellow(`[vite-plugin-swagger2ts]: resources error`) + JSON.stringify(resources));
+        console.log(chalk.yellow(`[${pluginName}]: resources error`) + JSON.stringify(resources));
       }
     }
     if (typeof jsonUrl === "string") {
       const swaggerJson = await fetchUrl(jsonUrl);
-      if (!swaggerJson.info)
-        return console.log(chalk.yellow(`[vite-plugin-swagger2ts]: jsonUrl error;`) + JSON.stringify(swaggerJson));
-      interfaces2.push(await genInterface(swaggerJson, getApiName(swaggerJson)));
+      if (swaggerJson.info) {
+        const name = getApiName(swaggerJson);
+        interfaces2.push(await genInterface(swaggerJson, name));
+        sources2.push({ name });
+      } else {
+        console.log(chalk.yellow(`[${pluginName}]: jsonUrl error;`) + JSON.stringify(swaggerJson));
+      }
     }
     if (typeof jsonPath === "string") {
       const _jsonPath = resolve(process.cwd(), jsonPath);
       const swaggerJson = JSON.parse(readFileSync(_jsonPath, { encoding: "utf-8" }));
-      interfaces2.push(await genInterface(swaggerJson, getApiName(swaggerJson)));
+      const name = getApiName(swaggerJson);
+      interfaces2.push(await genInterface(swaggerJson, name));
+      sources2.push({ name });
     }
     return { sources: sources2, interfaces: interfaces2 };
   }
-  const { sources, interfaces } = await getSources() || {};
-  if (!interfaces?.length)
+  const { sources, interfaces } = await getSources();
+  if (!interfaces.length)
     return;
-  const prefix = `/* eslint-disable */
-/* prettier-ignore */
-// @ts-nocheck
-// noinspection JSUnusedGlobalSymbols
-// Generated by vite-plugin-swagger2ts`;
   const code = interfaces.reduce((a, b) => a + b, "");
-  const suffix = sources ? interfaces.reduce((a, b, index) => {
+  const suffix = interfaces.reduce((a, b, index) => {
     if (b) {
       a += !a ? `export type ${getPathsName("_Intersection")} = ` : `&`;
-      a += `${getPathsName(sources[index].name)}`;
+      const { name } = sources[index];
+      a += name ? getPathsName(name) : "any";
     }
     return a;
-  }, "") : "";
+  }, "");
   const outputFile = resolve(process.cwd(), output);
-  writeFileSync(outputFile, prefix + code + suffix);
+  writeFileSync(outputFile, CODE_PREFIX + code + suffix);
+  return { sources, interfaces };
+}
+function loadGlobTypes({ glob, output }) {
+  if (!glob)
+    return;
+  const outputFile = resolve(process.cwd(), glob.output || "auto-types.d.ts");
+  const importPath = relative(outputFile, output).replaceAll("\\", "/").replace(/^\.\.\//, "./");
+  const intersection = getPathsName("_Intersection");
+  const code = `${CODE_PREFIX}import { ${intersection} } from '${importPath}'
+
+type FilterOptional<Source, Condition> = Pick<
+  Source,
+  {
+    [K in keyof Source]: Source[K] extends Condition ? K : never;
+  }[keyof Source]
+>
+
+declare global {
+  export namespace ${glob.namespace} {
+    ${generatorMethodType(intersection)}
+  }
+}`;
+  writeFileSync(outputFile, code);
 }
 function swagger2TsPlugin(userOptions) {
-  resolveOptions(userOptions).then((options) => {
-    Promise.all(options.map(loadSwaggerSource));
-  });
+  (async () => {
+    const options = await resolveOptions(userOptions);
+    await Promise.all(options.map(loadSwaggerSource));
+    options.forEach(loadGlobTypes);
+  })();
   return {
-    name: "vite-plugin-swagger2ts",
+    name: `${pluginName}`,
     enforce: "pre",
     apply: "serve"
   };

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@1szx1/vite-plugin-swagger2ts",
     "description": "forked from https://github.com/morelearn1990/vite-plugin-swagger2ts",
-    "version": "1.3.10",
+    "version": "1.3.12",
     "license": "MIT",
     "author": "1SZX1 <2414126198@qq.com>",
     "repository": {