@elysiajs/openapi 1.4.9 → 1.4.11

package/README.md

@@ -83,7 +83,7 @@ The endpoint to expose OpenAPI documentation frontend
 
 OpenAPI documentation frontend between:
 - [Scalar](https://github.com/scalar/scalar)
-- [SwaggerUI](https://github.com/openapi-api/openapi-ui)
+- [SwaggerUI](https://github.com/swagger-api/swagger-ui)
 - null: disable frontend
 
 ## references

package/dist/cjs/gen/index.js

@@ -20,10 +20,11 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/gen/index.ts
 var gen_exports = {};
 __export(gen_exports, {
+  declarationToJSONSchema: () => declarationToJSONSchema,
+  extractRootObjects: () => extractRootObjects,
   fromTypes: () => fromTypes
 });
 module.exports = __toCommonJS(gen_exports);
-var import_fs = require("fs");
 
 // node_modules/@sinclair/typebox/build/esm/value/guard/guard.mjs
 function IsObject(value) {
@@ -8309,11 +8310,9 @@ function TypeBox(...args) {
 }
 
 // src/gen/index.ts
-var import_os = require("os");
-var import_path2 = require("path");
-var import_child_process = require("child_process");
 var matchRoute = /: Elysia<(.*)>/gs;
-var matchStatus = /(\d{3}):/g;
+var numberKey = /(\d+):/g;
+var join = (...parts) => parts.join("/").replace(/\/{1,}/g, "/");
 function extractRootObjects(code) {
   const results = [];
   let i = 0;
@@ -8345,42 +8344,90 @@ function extractRootObjects(code) {
   }
   return results;
 }
-var fromTypes = (targetFilePath, {
+function declarationToJSONSchema(declaration) {
+  const routes = {};
+  for (const route of extractRootObjects(
+    declaration.replace(numberKey, '"$1":')
+  )) {
+    let schema = TypeBox(route.replaceAll(/readonly/g, ""));
+    if (schema.type !== "object") continue;
+    const paths = [];
+    while (true) {
+      const keys = Object.keys(schema.properties);
+      if (keys.length !== 1) break;
+      paths.push(keys[0]);
+      schema = schema.properties[keys[0]];
+      if (!schema?.properties) break;
+    }
+    const method = paths.pop();
+    if (!method) continue;
+    const path = "/" + paths.join("/");
+    schema = schema.properties;
+    if (schema?.response?.type === "object") {
+      const responseSchema = {};
+      for (const key in schema.response.properties)
+        responseSchema[key] = schema.response.properties[key];
+      schema.response = responseSchema;
+    }
+    if (!routes[path]) routes[path] = {};
+    routes[path][method.toLowerCase()] = schema;
+  }
+  return routes;
+}
+var fromTypes = (targetFilePath = "src/index.ts", {
   tsconfigPath = "tsconfig.json",
   instanceName,
   projectRoot = process.cwd(),
   overrideOutputPath,
   debug = false,
   compilerOptions,
-  tmpRoot = (0, import_path2.join)((0, import_os.tmpdir)(), ".ElysiaAutoOpenAPI"),
+  tmpRoot,
   silent = false
 } = {}) => () => {
+  if (targetFilePath.trimStart().startsWith("{") && targetFilePath.trimEnd().endsWith("}"))
+    return declarationToJSONSchema(targetFilePath);
+  if (typeof process === "undefined" || typeof process.getBuiltinModule !== "function")
+    throw new Error(
+      "[@elysiajs/openapi/gen] `fromTypes` from file path is only available in Node.js/Bun environment or environments"
+    );
+  const fs = process.getBuiltinModule("fs");
+  if (!fs)
+    throw new Error(
+      "[@elysiajs/openapi/gen] `fromTypes` require `fs` module which is not available in this environment"
+    );
   try {
     if (!targetFilePath.endsWith(".ts") && !targetFilePath.endsWith(".tsx"))
       throw new Error("Only .ts files are supported");
     if (targetFilePath.startsWith("./"))
       targetFilePath = targetFilePath.slice(2);
-    let src = targetFilePath.startsWith("/") ? targetFilePath : (0, import_path2.join)(projectRoot, targetFilePath);
-    if (!(0, import_fs.existsSync)(src))
+    let src = targetFilePath.startsWith("/") ? targetFilePath : join(projectRoot, targetFilePath);
+    if (!fs.existsSync(src))
       throw new Error(
         `Couldn't find "${targetFilePath}" from ${projectRoot}`
       );
     let targetFile;
+    if (!tmpRoot) {
+      const os = process.getBuiltinModule("os");
+      tmpRoot = join(
+        os && typeof os.tmpdir === "function" ? os.tmpdir() : projectRoot,
+        ".ElysiaAutoOpenAPI"
+      );
+    }
     if (targetFilePath.endsWith(".d.ts")) targetFile = targetFilePath;
     else {
-      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_path2.join)(projectRoot, tsconfigPath);
-      let extendsRef = (0, import_fs.existsSync)(tsconfig) ? `"extends": "${(0, import_path2.join)(projectRoot, "tsconfig.json")}",` : "";
-      let distDir = (0, import_path2.join)(tmpRoot, "dist");
+      if (fs.existsSync(tmpRoot))
+        fs.rmSync(tmpRoot, { recursive: true, force: true });
+      fs.mkdirSync(tmpRoot, { recursive: true });
+      const tsconfig = tsconfigPath.startsWith("/") ? tsconfigPath : join(projectRoot, tsconfigPath);
+      let extendsRef = fs.existsSync(tsconfig) ? `"extends": "${join(projectRoot, "tsconfig.json")}",` : "";
+      let distDir = join(tmpRoot, "dist");
       if (typeof process !== "undefined" && process.platform === "win32") {
         extendsRef = extendsRef.replace(/\\/g, "/");
         src = src.replace(/\\/g, "/");
         distDir = distDir.replace(/\\/g, "/");
       }
-      (0, import_fs.writeFileSync)(
-        (0, import_path2.join)(tmpRoot, "tsconfig.json"),
+      fs.writeFileSync(
+        join(tmpRoot, "tsconfig.json"),
         `{
 	${extendsRef}
 	"compilerOptions": ${compilerOptions ? JSON.stringify(compilerOptions) : `{
@@ -8397,36 +8444,46 @@ var fromTypes = (targetFilePath, {
 	"include": ["${src}"]
 }`
       );
-      (0, import_child_process.spawnSync)(`tsc`, {
+      const child_process = process.getBuiltinModule("child_process");
+      if (!child_process)
+        throw new Error(
+          "[@elysiajs/openapi/gen] `fromTypes` declaration generation require `child_process` module which is not available in this environment"
+        );
+      const { spawnSync } = child_process;
+      if (typeof spawnSync !== "function")
+        throw new Error(
+          "[@elysiajs/openapi/gen] `fromTypes` declaration generation require child_process.spawnSync which is not available in this environment"
+        );
+      spawnSync(`tsc`, {
         shell: true,
         cwd: tmpRoot,
         stdio: silent ? void 0 : "inherit"
       });
       const fileName = targetFilePath.replace(/.tsx$/, ".ts").replace(/.ts$/, ".d.ts");
-      targetFile = (overrideOutputPath ? typeof overrideOutputPath === "string" ? overrideOutputPath.startsWith("/") ? overrideOutputPath : (0, import_path2.join)(tmpRoot, "dist", overrideOutputPath) : overrideOutputPath(tmpRoot) : void 0) ?? (0, import_path2.join)(
+      targetFile = (overrideOutputPath ? typeof overrideOutputPath === "string" ? overrideOutputPath.startsWith("/") ? overrideOutputPath : join(tmpRoot, "dist", overrideOutputPath) : overrideOutputPath(tmpRoot) : void 0) ?? join(
         tmpRoot,
         "dist",
         // remove leading like src or something similar
         fileName.slice(fileName.indexOf("/") + 1)
       );
-      let existed = (0, import_fs.existsSync)(targetFile);
+      let existed = fs.existsSync(targetFile);
       if (!existed && !overrideOutputPath) {
-        targetFile = (0, import_path2.join)(
+        targetFile = join(
           tmpRoot,
           "dist",
           // use original file name as-is eg. in monorepo
           fileName
         );
-        existed = (0, import_fs.existsSync)(targetFile);
+        existed = fs.existsSync(targetFile);
       }
       if (!existed) {
-        (0, import_fs.rmSync)((0, import_path2.join)(tmpRoot, "tsconfig.json"));
+        fs.rmSync(join(tmpRoot, "tsconfig.json"));
         console.warn(
           "[@elysiajs/openapi/gen] Failed to generate OpenAPI schema"
         );
         console.warn("Couldn't find generated declaration file");
-        if ((0, import_fs.existsSync)((0, import_path2.join)(tmpRoot, "dist"))) {
-          const tempFiles = (0, import_fs.readdirSync)((0, import_path2.join)(tmpRoot, "dist"), {
+        if (fs.existsSync(join(tmpRoot, "dist"))) {
+          const tempFiles = fs.readdirSync(join(tmpRoot, "dist"), {
             recursive: true
           }).filter((x) => x.toString().endsWith(".d.ts")).map((x) => `- ${x}`).join("\n");
           if (tempFiles) {
@@ -8438,15 +8495,15 @@ var fromTypes = (targetFilePath, {
         } else {
           console.warn(
             "reason: root folder doesn't exists",
-            (0, import_path2.join)(tmpRoot, "dist")
+            join(tmpRoot, "dist")
           );
         }
         return;
       }
     }
-    const declaration = (0, import_fs.readFileSync)(targetFile, "utf8");
-    if (!debug && (0, import_fs.existsSync)(tmpRoot))
-      (0, import_fs.rmSync)(tmpRoot, { recursive: true, force: true });
+    const declaration = fs.readFileSync(targetFile, "utf8");
+    if (!debug && fs.existsSync(tmpRoot))
+      fs.rmSync(tmpRoot, { recursive: true, force: true });
     let instance = declaration.match(
       instanceName ? new RegExp(`${instanceName}: Elysia<(.*)`, "gs") : matchRoute
     )?.[0];
@@ -8459,34 +8516,7 @@ var fromTypes = (targetFilePath, {
           3
         )
       );
-    const routes = {};
-    for (const route of extractRootObjects(
-      instance.slice(2).replace(matchStatus, '"$1":')
-    )) {
-      let schema = TypeBox(route.replaceAll(/readonly/g, ""));
-      if (schema.type !== "object") continue;
-      const paths = [];
-      while (true) {
-        const keys = Object.keys(schema.properties);
-        if (keys.length !== 1) break;
-        paths.push(keys[0]);
-        schema = schema.properties[keys[0]];
-        if (!schema?.properties) break;
-      }
-      const method = paths.pop();
-      if (!method) continue;
-      const path = "/" + paths.join("/");
-      schema = schema.properties;
-      if (schema?.response?.type === "object") {
-        const responseSchema = {};
-        for (const key in schema.response.properties)
-          responseSchema[key] = schema.response.properties[key];
-        schema.response = responseSchema;
-      }
-      if (!routes[path]) routes[path] = {};
-      routes[path][method.toLowerCase()] = schema;
-    }
-    return routes;
+    return declarationToJSONSchema(instance.slice(2));
   } catch (error) {
     console.warn(
       "[@elysiajs/openapi/gen] Failed to generate OpenAPI schema"
@@ -8494,11 +8524,13 @@ var fromTypes = (targetFilePath, {
     console.warn(error);
     return;
   } finally {
-    if (!debug && (0, import_fs.existsSync)(tmpRoot))
-      (0, import_fs.rmSync)(tmpRoot, { recursive: true, force: true });
+    if (!debug && tmpRoot && fs.existsSync(tmpRoot))
+      fs.rmSync(tmpRoot, { recursive: true, force: true });
   }
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  declarationToJSONSchema,
+  extractRootObjects,
   fromTypes
 });

package/dist/cjs/index.d.ts

@@ -5,7 +5,7 @@ import type { ElysiaOpenAPIConfig } from './types';
  *
  * @see https://github.com/elysiajs/elysia-swagger
  */
-export declare const openapi: <const Enabled extends boolean = true, const Path extends string = "/openapi">({ enabled, path, provider, specPath, documentation, exclude, swagger, scalar, references, mapJsonSchema }?: ElysiaOpenAPIConfig<Enabled, Path>) => Elysia<"", {
+export declare const openapi: <const Enabled extends boolean = true, const Path extends string = "/openapi">({ enabled, path, provider, specPath, documentation, exclude, swagger, scalar, references, mapJsonSchema, embedSpec }?: ElysiaOpenAPIConfig<Enabled, Path>) => Elysia<"", {
     decorator: {};
     store: {};
     derive: {};
@@ -33,6 +33,7 @@ export declare const openapi: <const Enabled extends boolean = true, const Path
     standaloneSchema: {};
     response: {};
 }>;
+export { fromTypes } from './gen';
 export { toOpenAPISchema, withHeaders } from './openapi';
 export type { ElysiaOpenAPIConfig };
 export default openapi;