next-openapi-gen 0.0.2 → 0.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "next-openapi-gen",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "Automatically generate OpenAPI documentation for Next.js API",
   "type": "module",
   "main": "dist/index.js",

package/dist/app/api-docs/page.js

@@ -1,11 +0,0 @@
-import "swagger-ui-react/swagger-ui.css";
-import dynamic from "next/dynamic";
-const SwaggerUI = dynamic(() => import("swagger-ui-react"), {
-    ssr: false,
-    loading: () => <p>Loading Component...</p>,
-});
-export default async function ApiDocsPage() {
-    return (<section>
-      <SwaggerUI url="/swagger.json"/>
-    </section>);
-}

package/dist/init.js

@@ -1,30 +0,0 @@
-import path from "path";
-import fse from "fs-extra";
-import ora from "ora";
-// Definicja szablonu dla pliku OpenAPI
-const openApiTemplate = {
-    openapi: "3.0.0",
-    info: {
-        title: "API Documentation",
-        version: "1.0.0",
-        description: "This is the OpenAPI specification for your project.",
-    },
-    servers: [
-        {
-            url: "http://localhost:3000",
-            description: "Local development server",
-        },
-    ],
-    paths: {},
-};
-export const init = async () => {
-    const spinner = ora("Initializing project with OpenAPI template...\n").start();
-    try {
-        const outputPath = path.join(process.cwd(), "next.openapi.json");
-        await fse.writeJson(outputPath, openApiTemplate, { spaces: 2 });
-        spinner.succeed(`OpenAPI template created successfully at ${outputPath}`);
-    }
-    catch (error) {
-        spinner.fail(`Failed to initialize project: ${error.message}`);
-    }
-};

package/dist/lib/generate-openapi-spec.js

@@ -1,95 +0,0 @@
-// import path from "path";
-// import fs from "fs-extra";
-// // Definicja typu dla konfiguracji OpenAPI
-// interface OpenApiConfig {
-//   openapi: string;
-//   info: {
-//     title: string;
-//     description: string;
-//     version: string;
-//   };
-//   servers: { url: string; description: string }[];
-//   paths: Record<string, any>;
-//   components: {
-//     schemas: Record<string, any>;
-//   };
-// }
-// // Domyślne opcje OpenAPI
-// const defaultOpenApiConfig: OpenApiConfig = {
-//   openapi: "3.0.0",
-//   info: {
-//     title: "Next.js API",
-//     description: "This is the API documentation for the Next.js application.",
-//     version: "1.0.0",
-//   },
-//   servers: [
-//     {
-//       url: "http://localhost:3000",
-//       description: "Local server",
-//     },
-//   ],
-//   paths: {},
-//   components: {
-//     schemas: {},
-//   },
-// };
-// export function generateOpenApiSpec(): void {
-//   const projectRoot = process.cwd();
-//   // Ścieżki do API, schematów i modeli
-//   const apiDir = path.join(projectRoot, "pages/api");
-//   const schemaDir = path.join(projectRoot, "schemas");
-//   const modelsDir = path.join(projectRoot, "models");
-//   // Generowanie pliku next.openapi.json
-//   const openApiPath = path.join(projectRoot, "next.openapi.json");
-//   // Generowanie paths i schemas na podstawie plików z katalogów
-//   const openApiSpec: OpenApiConfig = {
-//     ...defaultOpenApiConfig,
-//     paths: generatePathsFromApiDir(apiDir),
-//     components: {
-//       schemas: generateSchemasFromDir(schemaDir),
-//     },
-//   };
-//   // Zapisanie pliku next.openapi.json
-//   fs.writeJsonSync(openApiPath, openApiSpec, { spaces: 2 });
-//   console.log(`OpenAPI spec generated at: ${openApiPath}`);
-// }
-// // Funkcja generująca ścieżki na podstawie katalogu API
-// function generatePathsFromApiDir(apiDir: string): Record<string, any> {
-//   const paths: Record<string, any> = {};
-//   if (fs.existsSync(apiDir)) {
-//     const files = fs.readdirSync(apiDir);
-//     files.forEach((file) => {
-//       const filePath = path.join(apiDir, file);
-//       if (fs.statSync(filePath).isFile() && file.endsWith(".ts")) {
-//         const route = `/api/${file.replace(".ts", "")}`;
-//         paths[route] = {
-//           get: {
-//             summary: `Get ${route}`,
-//             responses: {
-//               200: {
-//                 description: "Successful response",
-//               },
-//             },
-//           },
-//         };
-//       }
-//     });
-//   }
-//   return paths;
-// }
-// // Funkcja generująca schematy na podstawie katalogu schematów
-// function generateSchemasFromDir(schemaDir: string): Record<string, any> {
-//   const schemas: Record<string, any> = {};
-//   if (fs.existsSync(schemaDir)) {
-//     const files = fs.readdirSync(schemaDir);
-//     files.forEach((file) => {
-//       const schemaPath = path.join(schemaDir, file);
-//       if (fs.statSync(schemaPath).isFile() && file.endsWith(".json")) {
-//         const schema = fs.readJsonSync(schemaPath);
-//         const schemaName = file.replace(".json", "");
-//         schemas[schemaName] = schema;
-//       }
-//     });
-//   }
-//   return schemas;
-// }

package/src/commands/generate-openapi-spec.ts

@@ -1,201 +0,0 @@
-import { parse } from "@babel/parser";
-import traverse from "@babel/traverse";
-import * as t from "@babel/types";
-import fs from "fs";
-import path from "path";
-import ora from "ora";
-
-const apiDir = path.resolve("./src/app/api");
-const schemaDir = path.resolve("./src/types/schemas");
-const swaggerPaths = {};
-
-function extractSchemaFromZod(schemaNode) {
-  const properties = {};
-  schemaNode.arguments.forEach((arg) => {
-    if (t.isObjectExpression(arg)) {
-      arg.properties.forEach((prop) => {
-        if (t.isObjectProperty(prop) && t.isIdentifier(prop.key)) {
-          // @ts-ignore
-          const type = prop.value.callee.property.name;
-          properties[prop.key.name] = { type };
-        }
-      });
-    }
-  });
-  return { type: "object", properties };
-}
-
-function findSchemaDefinition(schemaName) {
-  let schemaNode = null;
-
-  function processSchemaFile(filePath) {
-    const content = fs.readFileSync(filePath, "utf-8");
-    const ast = parse(content, {
-      sourceType: "module",
-      plugins: ["typescript"],
-    });
-
-    traverse.default(ast, {
-      VariableDeclarator(path) {
-        if (t.isIdentifier(path.node.id, { name: schemaName })) {
-          if (t.isCallExpression(path.node.init)) {
-            schemaNode = path.node.init;
-          }
-        }
-      },
-    });
-  }
-
-  function scanSchemaDir(dir) {
-    const files = fs.readdirSync(dir);
-    files.forEach((file) => {
-      const filePath = path.join(dir, file);
-      const stat = fs.statSync(filePath);
-      if (stat.isDirectory()) {
-        scanSchemaDir(filePath);
-      } else if (file.endsWith(".ts")) {
-        processSchemaFile(filePath);
-      }
-    });
-  }
-
-  scanSchemaDir(schemaDir);
-  return schemaNode;
-}
-
-function processFile(filePath) {
-  const content = fs.readFileSync(filePath, "utf-8");
-  const ast = parse(content, { sourceType: "module", plugins: ["typescript"] });
-
-  traverse.default(ast, {
-    ExportNamedDeclaration(path) {
-      const declaration = path.node.declaration;
-
-      if (t.isVariableDeclaration(declaration)) {
-        declaration.declarations.forEach((decl) => {
-          if (t.isVariableDeclarator(decl) && t.isIdentifier(decl.id)) {
-            const varName = decl.id.name;
-            let schema = {};
-            let options: any = {};
-
-            if (
-              varName === "POST" ||
-              varName === "GET" ||
-              varName === "PUT" ||
-              varName === "PATCH" ||
-              varName === "DELETE"
-            ) {
-              const handler = decl.init;
-
-              // Handle schema definition
-              if (
-                fs.existsSync(schemaDir) &&
-                t.isCallExpression(handler) &&
-                t.isIdentifier(handler.callee, { name: "withAPI" })
-              ) {
-                const [schemaIdentifier] = handler.arguments;
-
-                if (t.isIdentifier(schemaIdentifier)) {
-                  const schemaNode = findSchemaDefinition(
-                    schemaIdentifier.name
-                  );
-
-                  const optionsNode = schemaNode.arguments[0];
-
-                  if (schemaNode) {
-                    // @TODO: add z.array tracking
-                    if (t.isObjectExpression(optionsNode)) {
-                      schema = extractSchemaFromZod(schemaNode);
-
-                      options = optionsNode.properties.reduce((acc, prop) => {
-                        if (
-                          t.isObjectProperty(prop) &&
-                          t.isIdentifier(prop.key)
-                        ) {
-                          // @ts-ignore
-                          acc[prop.key.name] = prop.value.callee.property.name;
-                        }
-                        return acc;
-                      }, {});
-                    }
-                  }
-                }
-              }
-
-              const method = varName.toLowerCase();
-              const routePath = filePath
-                .replace(apiDir, "")
-                .replace("route.ts", "")
-                .replaceAll("\\", "/")
-                .replace(/\/$/, "");
-
-              const rootPath = routePath.split("/")[1];
-
-              if (!swaggerPaths[routePath]) {
-                swaggerPaths[routePath] = {};
-              }
-
-              swaggerPaths[routePath][method] = {
-                operationId: options.opId,
-                description: options.desc,
-                tags: [rootPath],
-                requestBody: {
-                  content: {
-                    "application/json": {
-                      schema,
-                    },
-                  },
-                },
-                responses: {
-                  200: {
-                    description: "Successful response",
-                    content: {
-                      "application/json": {
-                        schema: options.res,
-                      },
-                    },
-                  },
-                  400: {
-                    description: "Validation error",
-                  },
-                  500: {
-                    description: "Server error",
-                  },
-                },
-              };
-            }
-          }
-        });
-      }
-    },
-  });
-}
-
-function scanDir(dir) {
-  const files = fs.readdirSync(dir);
-  files.forEach((file) => {
-    const filePath = path.join(dir, file);
-    const stat = fs.statSync(filePath);
-    if (stat.isDirectory()) {
-      scanDir(filePath);
-    } else if (file.endsWith(".ts")) {
-      processFile(filePath);
-    }
-  });
-}
-
-export async function generateOpenapiSpec() {
-  const spinner = ora("Generating openapi specification...\n").start();
-
-  scanDir(apiDir);
-
-  const openapiPath = path.resolve("./next.openapi.json");
-  const openapiSpec = JSON.parse(fs.readFileSync(openapiPath, "utf-8"));
-
-  openapiSpec.paths = swaggerPaths;
-
-  const outputPath = path.resolve(openapiSpec.outputPath);
-  fs.writeFileSync(outputPath, JSON.stringify(openapiSpec, null, 2));
-
-  spinner.succeed(`Swagger spec generated at ${outputPath}`);
-}

package/src/commands/init.ts

@@ -1,110 +0,0 @@
-import path from "path";
-import fse from "fs-extra";
-import fs from "fs";
-import ora from "ora";
-import { exec } from "child_process";
-import util from "util";
-
-const execPromise = util.promisify(exec);
-
-const spinner = ora("Initializing project with OpenAPI template...\n");
-
-const openApiTemplate = {
-  openapi: "3.0.0",
-  info: {
-    title: "API Documentation",
-    version: "1.0.0",
-    description: "This is the OpenAPI specification for your project.",
-  },
-  servers: [
-    {
-      url: "http://localhost:3000",
-      description: "Local development server",
-    },
-  ],
-  paths: {},
-  apiPath: "./src/app/api",
-  docsUrl: "api-docs",
-  ui: "swagger",
-  outputPath: "./public/swagger.json",
-};
-
-const getPackageManager = async () => {
-  if (fs.existsSync(path.join(process.cwd(), "yarn.lock"))) {
-    return "yarn";
-  }
-  if (fs.existsSync(path.join(process.cwd(), "pnpm-lock.yaml"))) {
-    return "pnpm";
-  }
-  return "npm";
-};
-
-async function createDocsPage() {
-  const paths = ["app", "api-docs"];
-  const srcPath = path.join(process.cwd(), "src");
-
-  if (fs.existsSync(srcPath)) {
-    paths.unshift("src");
-  }
-
-  const docsDir = path.join(process.cwd(), ...paths);
-  await fs.promises.mkdir(docsDir, { recursive: true });
-
-  const swaggerComponent = `
-import "swagger-ui-react/swagger-ui.css";
-
-import dynamic from "next/dynamic";
-
-const SwaggerUI = dynamic(() => import("swagger-ui-react"), {
-  ssr: false,
-  loading: () => <p>Loading Component...</p>,
-});
-
-export default async function ApiDocsPage() {
-  return (
-    <section>
-      <SwaggerUI url="/swagger.json" />
-    </section>
-  );
-}
-`;
-
-  const componentPath = path.join(docsDir, "page.tsx");
-  await fs.promises.writeFile(componentPath, swaggerComponent.trim());
-  spinner.succeed(`Created ${paths.join("/")}/page.tsx for Swagger UI.`);
-}
-
-async function installSwagger() {
-  const packageManager = await getPackageManager();
-  const installCmd = `${packageManager} ${
-    packageManager === "npm" ? "install" : "add"
-  }`;
-
-  spinner.succeed("Installing swagger-ui-react...");
-  const resp = await execPromise(`${installCmd} swagger-ui-react`);
-  spinner.succeed("Successfully installed swagger-ui-react.");
-}
-
-function extendOpenApiTemplate(spec, options) {
-  spec.ui = options.ui ?? spec.ui;
-  spec.docsUrl = options.docsUrl ?? spec.docsUrl;
-}
-
-export async function init(ui: string, docsUrl: string) {
-  spinner.start();
-
-  try {
-    const outputPath = path.join(process.cwd(), "next.openapi.json");
-    extendOpenApiTemplate(openApiTemplate, { docsUrl, ui });
-
-    await fse.writeJson(outputPath, openApiTemplate, { spaces: 2 });
-    spinner.succeed(`Created OpenAPI template in next.openapi.json`);
-
-    if (ui === "swagger") {
-      createDocsPage();
-      installSwagger();
-    }
-  } catch (error) {
-    spinner.fail(`Failed to initialize project: ${error.message}`);
-  }
-}

package/src/index.ts

@@ -1,27 +0,0 @@
-#!/usr/bin/env node
-
-import { Command } from "commander";
-
-import { init } from "./commands/init.js";
-import { generateOpenapiSpec } from "./commands/generate-openapi-spec.js";
-
-const program = new Command();
-
-program
-  .name("next-openapi-gen")
-  .version("0.0.1")
-  .description(
-    "Super fast and easy way to generate OpenAPI documentation for Next.js"
-  );
-
-program
-  .command("init <ui> <docs-url>")
-  .description("Initialize a openapi specification")
-  .action(init);
-
-program
-  .command("generate")
-  .description("Generate a specification based on api routes")
-  .action(generateOpenapiSpec);
-
-program.parse(process.argv);

package/todo.md

@@ -1,12 +0,0 @@
-next-openapi-gen
-next-apidoc-gen
-
-
-OpenAPI generator for Next.js
-
-npx create-email init my-project
-npx create-email generate component
-
-
-node ./dist/index.js init swagger api-docs
-node ./dist/index.js generate

package/tsconfig.json

@@ -1,17 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "esnext",
-    "lib": ["es2022"],
-    // "target": "ESNext",
-    "module": "esnext",
-    "outDir": "./dist",
-    "rootDir": "./src",
-    "esModuleInterop": true,
-    "moduleResolution": "node",
-    "strict": false,
-    "types": ["node"],
-    "skipLibCheck": true
-  },
-  "include": ["src"],
-  "exclude": ["dist", "build", "node_modules"]
-}