@elysiajs/openapi 1.3.6 → 1.3.8

package/dist/cjs/gen/index.js

@@ -29,31 +29,34 @@ var import_os = require("os");
 var import_path = require("path");
 var import_child_process = require("child_process");
 var matchRoute = /: Elysia<(.*)>/gs;
-var matchStatus = /(\d{3}):/gs;
+var matchStatus = /(\d{3}):/g;
 var wrapStatusInQuote = (value) => value.replace(matchStatus, '"$1":');
-var exec = (command, cwd) => (0, import_child_process.spawnSync)(command, {
-  shell: true,
-  cwd,
-  stdio: "inherit"
-});
 var fromTypes = (targetFilePath, {
   tsconfigPath = "tsconfig.json",
   instanceName,
   projectRoot = process.cwd(),
-  overrideOutputPath
+  overrideOutputPath,
+  debug = false
 } = {}) => () => {
-  if (!targetFilePath.endsWith(".ts") && !targetFilePath.endsWith(".tsx"))
-    throw new Error("Only .ts files are supported");
   const tmpRoot = (0, import_path.join)((0, import_os.tmpdir)(), ".ElysiaAutoOpenAPI");
-  if ((0, import_fs.existsSync)(tmpRoot))
-    (0, import_fs.rmSync)(tmpRoot, { recursive: true, force: true });
-  (0, import_fs.mkdirSync)(tmpRoot, { recursive: true });
-  const extendsRef = (0, import_fs.existsSync)((0, import_path.join)(projectRoot, "tsconfig.json")) ? `"extends": "${(0, import_path.join)(projectRoot, "tsconfig.json")}",` : "";
-  if (!(0, import_path.join)(projectRoot, targetFilePath))
-    throw new Error("Target file does not exist");
-  (0, import_fs.writeFileSync)(
-    (0, import_path.join)(tmpRoot, tsconfigPath),
-    `{
+  try {
+    if (!targetFilePath.endsWith(".ts") && !targetFilePath.endsWith(".tsx"))
+      throw new Error("Only .ts files are supported");
+    if (targetFilePath.startsWith("./"))
+      targetFilePath = targetFilePath.slice(2);
+    const src = targetFilePath.startsWith("/") ? targetFilePath : (0, import_path.join)(projectRoot, targetFilePath);
+    if (!(0, import_fs.existsSync)(src))
+      throw new Error(
+        `Couldn't find "${targetFilePath}" from ${projectRoot}`
+      );
+    if ((0, import_fs.existsSync)(tmpRoot))
+      (0, import_fs.rmSync)(tmpRoot, { recursive: true, force: true });
+    (0, import_fs.mkdirSync)(tmpRoot, { recursive: true });
+    const tsconfig = tsconfigPath.startsWith("/") ? tsconfigPath : (0, import_path.join)(projectRoot, tsconfigPath);
+    const extendsRef = (0, import_fs.existsSync)(tsconfig) ? `"extends": "${(0, import_path.join)(projectRoot, "tsconfig.json")}",` : "";
+    (0, import_fs.writeFileSync)(
+      (0, import_path.join)(tmpRoot, "tsconfig.json"),
+      `{
 			${extendsRef}
 			"compilerOptions": {
 				"lib": ["ESNext"],
@@ -66,20 +69,34 @@ var fromTypes = (targetFilePath, {
 				"skipDefaultLibCheck": true,
 				"outDir": "./dist"
 			},
-			"include": ["${(0, import_path.join)(projectRoot, targetFilePath)}"]
+			"include": ["${src}"]
 		}`
-  );
-  exec(`tsc`, tmpRoot);
-  try {
+    );
+    (0, import_child_process.spawnSync)(`tsc`, {
+      shell: true,
+      cwd: tmpRoot,
+      stdio: debug ? "inherit" : void 0
+    });
     const fileName = targetFilePath.replace(/.tsx$/, ".ts").replace(/.ts$/, ".d.ts");
-    let targetFile = overrideOutputPath?.(tmpRoot) ?? (0, import_path.join)(tmpRoot, "dist", fileName);
-    {
-      const _targetFile = (0, import_path.join)(
-        tmpRoot,
-        "dist",
-        fileName.slice(fileName.indexOf("/") + 1)
+    const targetFile = (overrideOutputPath ? typeof overrideOutputPath === "string" ? overrideOutputPath.startsWith("/") ? overrideOutputPath : (0, import_path.join)(tmpRoot, "dist", overrideOutputPath) : overrideOutputPath(tmpRoot) : void 0) ?? (0, import_path.join)(tmpRoot, "dist", fileName);
+    if (!(0, import_fs.existsSync)(targetFile)) {
+      (0, import_fs.rmSync)((0, import_path.join)(tmpRoot, "tsconfig.json"));
+      console.warn(
+        "[@elysiajs/openapi/gen] Failed to generate OpenAPI schema"
       );
-      if ((0, import_fs.existsSync)(_targetFile)) targetFile = _targetFile;
+      console.warn("Couldn't find generated declaration file");
+      if ((0, import_fs.existsSync)((0, import_path.join)(tmpRoot, "dist"))) {
+        const tempFiles = (0, import_fs.readdirSync)((0, import_path.join)(tmpRoot, "dist"), {
+          recursive: true
+        }).filter((x) => x.toString().endsWith(".d.ts")).map((x) => `- ${x}`).join("\n");
+        if (tempFiles) {
+          console.warn(
+            "You can override with `overrideOutputPath` with one of the following:"
+          );
+          console.warn(tempFiles);
+        }
+      }
+      return;
     }
     const declaration = (0, import_fs.readFileSync)(targetFile, "utf8");
     if ((0, import_fs.existsSync)(tmpRoot))
@@ -89,18 +106,22 @@ var fromTypes = (targetFilePath, {
     )?.[0];
     if (!instance) return;
     for (let i = 0; i < 3; i++)
-      instance = instance.slice(instance.indexOf("}, {", 3));
-    const routesString = wrapStatusInQuote(instance).slice(
-      3,
-      instance.indexOf("}, {", 3)
-    ) + "}\n}\n";
+      instance = instance.slice(
+        instance.indexOf(
+          "}, {",
+          // remove just `}, `, leaving `{`
+          3
+        )
+      );
+    const routesString = wrapStatusInQuote(
+      // Intentionally not adding "}"
+      // to avoid mismatched bracket in loop below
+      instance.slice(3, instance.indexOf("}, {", 4))
+    );
     const routes = {};
     for (const route of routesString.slice(1).split("} & {")) {
-      let schema = (0, import_typemap.TypeBox)(`{${route}}}`);
-      if (schema.type !== "object") {
-        schema = (0, import_typemap.TypeBox)(`{${route}}`);
-        if (schema.type !== "object") continue;
-      }
+      let schema = (0, import_typemap.TypeBox)(`{${route}}`);
+      if (schema.type !== "object") continue;
       const paths = [];
       while (true) {
         const keys = Object.keys(schema.properties);
@@ -128,6 +149,9 @@ var fromTypes = (targetFilePath, {
     );
     console.warn(error);
     return;
+  } finally {
+    if (!debug && (0, import_fs.existsSync)(tmpRoot))
+      (0, import_fs.rmSync)(tmpRoot, { recursive: true, force: true });
   }
 };
 // Annotate the CommonJS export names for ESM import in node:

package/dist/cjs/index.js

@@ -347,6 +347,7 @@ function toOpenAPISchema(app, exclude, references) {
     const hooks = route.hooks ?? {};
     if (references)
       for (const reference of references) {
+        if (!reference) continue;
         const refer = reference[route.path]?.[method] ?? reference[getLoosePath(route.path)]?.[method];
         if (!refer) continue;
         if (!hooks.body && isValidSchema(refer.body))

package/dist/cjs/openapi.js

@@ -89,6 +89,7 @@ function toOpenAPISchema(app, exclude, references) {
     const hooks = route.hooks ?? {};
     if (references)
       for (const reference of references) {
+        if (!reference) continue;
         const refer = reference[route.path]?.[method] ?? reference[getLoosePath(route.path)]?.[method];
         if (!refer) continue;
         if (!hooks.body && isValidSchema(refer.body))

package/dist/gen/index.d.ts

@@ -24,7 +24,13 @@ interface OpenAPIGeneratorOptions {
      * Under any circumstance, that Elysia failed to find a correct schema,
      * Put your own schema in this path
      */
-    overrideOutputPath?(tempDir: string): string;
+    overrideOutputPath?: string | ((tempDir: string) => string);
+    /**
+     * don't remove temporary files
+     * for debugging purpose
+     * @default false
+     */
+    debug?: boolean;
 }
 /**
  * Auto generate OpenAPI schema from Elysia instance
@@ -39,5 +45,5 @@ export declare const fromTypes: (
  *
  * The path must export an Elysia instance
  */
-targetFilePath: string, { tsconfigPath, instanceName, projectRoot, overrideOutputPath }?: OpenAPIGeneratorOptions) => () => AdditionalReference | undefined;
+targetFilePath: string, { tsconfigPath, instanceName, projectRoot, overrideOutputPath, debug }?: OpenAPIGeneratorOptions) => () => AdditionalReference | undefined;
 export {};

package/dist/gen/index.mjs

@@ -4,38 +4,42 @@ import {
   mkdirSync,
   writeFileSync,
   rmSync,
-  existsSync
+  existsSync,
+  readdirSync
 } from "fs";
 import { TypeBox } from "@sinclair/typemap";
 import { tmpdir } from "os";
 import { join } from "path";
 import { spawnSync } from "child_process";
 var matchRoute = /: Elysia<(.*)>/gs;
-var matchStatus = /(\d{3}):/gs;
+var matchStatus = /(\d{3}):/g;
 var wrapStatusInQuote = (value) => value.replace(matchStatus, '"$1":');
-var exec = (command, cwd) => spawnSync(command, {
-  shell: true,
-  cwd,
-  stdio: "inherit"
-});
 var fromTypes = (targetFilePath, {
   tsconfigPath = "tsconfig.json",
   instanceName,
   projectRoot = process.cwd(),
-  overrideOutputPath
+  overrideOutputPath,
+  debug = false
 } = {}) => () => {
-  if (!targetFilePath.endsWith(".ts") && !targetFilePath.endsWith(".tsx"))
-    throw new Error("Only .ts files are supported");
   const tmpRoot = join(tmpdir(), ".ElysiaAutoOpenAPI");
-  if (existsSync(tmpRoot))
-    rmSync(tmpRoot, { recursive: true, force: true });
-  mkdirSync(tmpRoot, { recursive: true });
-  const extendsRef = existsSync(join(projectRoot, "tsconfig.json")) ? `"extends": "${join(projectRoot, "tsconfig.json")}",` : "";
-  if (!join(projectRoot, targetFilePath))
-    throw new Error("Target file does not exist");
-  writeFileSync(
-    join(tmpRoot, tsconfigPath),
-    `{
+  try {
+    if (!targetFilePath.endsWith(".ts") && !targetFilePath.endsWith(".tsx"))
+      throw new Error("Only .ts files are supported");
+    if (targetFilePath.startsWith("./"))
+      targetFilePath = targetFilePath.slice(2);
+    const src = targetFilePath.startsWith("/") ? targetFilePath : join(projectRoot, targetFilePath);
+    if (!existsSync(src))
+      throw new Error(
+        `Couldn't find "${targetFilePath}" from ${projectRoot}`
+      );
+    if (existsSync(tmpRoot))
+      rmSync(tmpRoot, { recursive: true, force: true });
+    mkdirSync(tmpRoot, { recursive: true });
+    const tsconfig = tsconfigPath.startsWith("/") ? tsconfigPath : join(projectRoot, tsconfigPath);
+    const extendsRef = existsSync(tsconfig) ? `"extends": "${join(projectRoot, "tsconfig.json")}",` : "";
+    writeFileSync(
+      join(tmpRoot, "tsconfig.json"),
+      `{
 			${extendsRef}
 			"compilerOptions": {
 				"lib": ["ESNext"],
@@ -48,20 +52,34 @@ var fromTypes = (targetFilePath, {
 				"skipDefaultLibCheck": true,
 				"outDir": "./dist"
 			},
-			"include": ["${join(projectRoot, targetFilePath)}"]
+			"include": ["${src}"]
 		}`
-  );
-  exec(`tsc`, tmpRoot);
-  try {
+    );
+    spawnSync(`tsc`, {
+      shell: true,
+      cwd: tmpRoot,
+      stdio: debug ? "inherit" : void 0
+    });
     const fileName = targetFilePath.replace(/.tsx$/, ".ts").replace(/.ts$/, ".d.ts");
-    let targetFile = overrideOutputPath?.(tmpRoot) ?? join(tmpRoot, "dist", fileName);
-    {
-      const _targetFile = join(
-        tmpRoot,
-        "dist",
-        fileName.slice(fileName.indexOf("/") + 1)
+    const targetFile = (overrideOutputPath ? typeof overrideOutputPath === "string" ? overrideOutputPath.startsWith("/") ? overrideOutputPath : join(tmpRoot, "dist", overrideOutputPath) : overrideOutputPath(tmpRoot) : void 0) ?? join(tmpRoot, "dist", fileName);
+    if (!existsSync(targetFile)) {
+      rmSync(join(tmpRoot, "tsconfig.json"));
+      console.warn(
+        "[@elysiajs/openapi/gen] Failed to generate OpenAPI schema"
       );
-      if (existsSync(_targetFile)) targetFile = _targetFile;
+      console.warn("Couldn't find generated declaration file");
+      if (existsSync(join(tmpRoot, "dist"))) {
+        const tempFiles = readdirSync(join(tmpRoot, "dist"), {
+          recursive: true
+        }).filter((x) => x.toString().endsWith(".d.ts")).map((x) => `- ${x}`).join("\n");
+        if (tempFiles) {
+          console.warn(
+            "You can override with `overrideOutputPath` with one of the following:"
+          );
+          console.warn(tempFiles);
+        }
+      }
+      return;
     }
     const declaration = readFileSync(targetFile, "utf8");
     if (existsSync(tmpRoot))
@@ -71,18 +89,22 @@ var fromTypes = (targetFilePath, {
     )?.[0];
     if (!instance) return;
     for (let i = 0; i < 3; i++)
-      instance = instance.slice(instance.indexOf("}, {", 3));
-    const routesString = wrapStatusInQuote(instance).slice(
-      3,
-      instance.indexOf("}, {", 3)
-    ) + "}\n}\n";
+      instance = instance.slice(
+        instance.indexOf(
+          "}, {",
+          // remove just `}, `, leaving `{`
+          3
+        )
+      );
+    const routesString = wrapStatusInQuote(
+      // Intentionally not adding "}"
+      // to avoid mismatched bracket in loop below
+      instance.slice(3, instance.indexOf("}, {", 4))
+    );
     const routes = {};
     for (const route of routesString.slice(1).split("} & {")) {
-      let schema = TypeBox(`{${route}}}`);
-      if (schema.type !== "object") {
-        schema = TypeBox(`{${route}}`);
-        if (schema.type !== "object") continue;
-      }
+      let schema = TypeBox(`{${route}}`);
+      if (schema.type !== "object") continue;
       const paths = [];
       while (true) {
         const keys = Object.keys(schema.properties);
@@ -110,6 +132,9 @@ var fromTypes = (targetFilePath, {
     );
     console.warn(error);
     return;
+  } finally {
+    if (!debug && existsSync(tmpRoot))
+      rmSync(tmpRoot, { recursive: true, force: true });
   }
 };
 export {

package/dist/index.mjs

@@ -320,6 +320,7 @@ function toOpenAPISchema(app, exclude, references) {
     const hooks = route.hooks ?? {};
     if (references)
       for (const reference of references) {
+        if (!reference) continue;
         const refer = reference[route.path]?.[method] ?? reference[getLoosePath(route.path)]?.[method];
         if (!refer) continue;
         if (!hooks.body && isValidSchema(refer.body))

package/dist/openapi.mjs

@@ -61,6 +61,7 @@ function toOpenAPISchema(app, exclude, references) {
     const hooks = route.hooks ?? {};
     if (references)
       for (const reference of references) {
+        if (!reference) continue;
         const refer = reference[route.path]?.[method] ?? reference[getLoosePath(route.path)]?.[method];
         if (!refer) continue;
         if (!hooks.body && isValidSchema(refer.body))

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@elysiajs/openapi",
-    "version": "1.3.6",
+    "version": "1.3.8",
     "description": "Plugin for Elysia to auto-generate API documentation",
     "author": {
         "name": "saltyAom",