next-openapi-gen 0.10.5 → 1.0.1

package/package.json

@@ -1,79 +1,103 @@
-{
-  "name": "next-openapi-gen",
-  "version": "0.10.5",
-  "description": "Automatically generate OpenAPI 3.0 documentation from Next.js projects, with support for Zod schemas and TypeScript types.",
-  "type": "module",
-  "main": "dist/index.js",
-  "module": "dist/index.mjs",
-  "typings": "dist/index.d.ts",
-  "bin": {
-    "next-openapi-gen": "./dist/index.js"
-  },
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "clean": "rm -rf dist",
-    "build": "npm run clean && tsc",
-    "prepare": "npm run build",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "test:ui": "vitest --ui",
-    "test:coverage": "vitest run --coverage",
-    "release": "np --no-cleanup --no-tests",
-    "version": "conventional-changelog -p angular -i CHANGELOG.md -s -n .changelogrc.cjs && git add CHANGELOG.md"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+ssh://git@github.com/tazo90/next-openapi-gen.git"
-  },
-  "keywords": [
-    "nextjs",
-    "openapi",
-    "swagger",
-    "typescript",
-    "zod",
-    "api-docs",
-    "api",
-    "docs",
-    "react",
-    "scalar",
-    "redoc",
-    "drizzle"
-  ],
-  "publishConfig": {
-    "access": "public"
-  },
-  "author": "Mariusz Winnik",
-  "license": "MIT",
-  "engines": {
-    "node": ">=18.0.0"
-  },
-  "dependencies": {
-    "@babel/parser": "^7.28.3",
-    "@babel/traverse": "^7.28.3",
-    "@babel/types": "^7.28.2",
-    "commander": "^14.0.0",
-    "fs-extra": "^11.3.1",
-    "js-yaml": "^4.1.0",
-    "ora": "^8.2.0"
-  },
-  "devDependencies": {
-    "@types/js-yaml": "^4.0.9",
-    "@types/node": "^24.3.0",
-    "@vitest/ui": "^3.2.4",
-    "conventional-changelog-cli": "^5.0.0",
-    "np": "^10.2.0",
-    "typescript": "^5.9.2",
-    "vitest": "^3.2.4"
-  },
-  "np": {
-    "yarn": false,
-    "anyBranch": false,
-    "branch": "main",
-    "cleanup": false,
-    "tests": false,
-    "2fa": false,
-    "releaseDraft": false
-  }
-}
+{
+  "name": "next-openapi-gen",
+  "version": "1.0.1",
+  "description": "Automatically generate OpenAPI 3.0, 3.1, and 3.2 documentation from Next.js projects, with support for Zod schemas, TypeScript types, and reusable OpenAPI fragments.",
+  "keywords": [
+    "api",
+    "api-docs",
+    "docs",
+    "drizzle",
+    "nextjs",
+    "openapi",
+    "react",
+    "redoc",
+    "scalar",
+    "swagger",
+    "typescript",
+    "zod"
+  ],
+  "license": "MIT",
+  "author": "Mariusz Winnik",
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/tazo90/next-openapi-gen.git"
+  },
+  "bin": {
+    "next-openapi-gen": "./dist/cli.js",
+    "openapi-gen": "./dist/cli.js"
+  },
+  "files": [
+    "dist",
+    "templates",
+    "README.md"
+  ],
+  "type": "module",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "typings": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./next": {
+      "types": "./dist/next/index.d.ts",
+      "default": "./dist/next/index.js"
+    },
+    "./react-router": {
+      "types": "./dist/react-router/index.d.ts",
+      "default": "./dist/react-router/index.js"
+    },
+    "./vite": {
+      "types": "./dist/vite/index.d.ts",
+      "default": "./dist/vite/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@babel/parser": "^7.29.2",
+    "@babel/traverse": "^7.29.0",
+    "@babel/types": "^7.29.0",
+    "commander": "^14.0.3",
+    "fs-extra": "^11.3.4",
+    "js-yaml": "^4.1.1",
+    "ora": "^9.3.0",
+    "typescript": "^5.9.3"
+  },
+  "devDependencies": {
+    "@types/node": "^25.5.0",
+    "conventional-changelog-cli": "^5.0.0",
+    "np": "^11.0.2",
+    "oxfmt": "^0.42.0",
+    "oxlint": "^1.57.0",
+    "tsup": "^8.5.1"
+  },
+  "engines": {
+    "node": ">=24.0.0"
+  },
+  "np": {
+    "packageManager": "pnpm",
+    "anyBranch": false,
+    "branch": "main",
+    "cleanup": false,
+    "tests": false,
+    "2fa": false,
+    "releaseDraft": false
+  },
+  "scripts": {
+    "check": "pnpm format:check && pnpm lint",
+    "clean": "rm -rf dist coverage templates tsconfig.tsbuildinfo",
+    "build": "pnpm clean && tsup --config tsup.config.ts && cp -R ../openapi-init/templates ./templates",
+    "format": "oxfmt --config ../oxfmt-config/oxfmt.json --ignore-path ../../.gitignore .",
+    "format:check": "oxfmt --config ../oxfmt-config/oxfmt.json --ignore-path ../../.gitignore --check .",
+    "lint": "oxlint --config ../oxlint-config/base.json . --ignore-path ../../.gitignore --deny-warnings",
+    "lint:fix": "oxlint --config ../oxlint-config/base.json . --ignore-path ../../.gitignore --fix --deny-warnings",
+    "test": "pnpm --dir ../.. test:unit && pnpm --dir ../.. test:integration",
+    "test:coverage": "pnpm --dir ../.. test:coverage:next-openapi-gen",
+    "release": "np --no-cleanup --no-tests --no-publish",
+    "version": "conventional-changelog -p angular -i ../../CHANGELOG.md -s -n ../../.changelogrc.cjs && git add ../../CHANGELOG.md"
+  }
+}

package/{dist/components/rapidoc.js → templates/init/ui/nextjs/rapidoc.tsx}

@@ -1,21 +1,17 @@
-export const rapidocDeps = ["rapidoc"];
-export const rapidocDevDeps = [];
-export function RapidocUI(outputFile) {
-    return `
-"use client";
-
-import "rapidoc";
-
-export default function ApiDocsPage() {
-  return (
-    <section style={{ height: "100vh" }}>
-      <rapi-doc
-        spec-url="${outputFile}"
-        render-style="read"
-        style={{ height: "100vh", width: "100%" }}
-      ></rapi-doc>
-    </section>
-  );
-}
-`;
+"use client";
+
+import "rapidoc";
+
+const RapiDoc = "rapi-doc" as any;
+
+export default function ApiDocsPage() {
+  return (
+    <section style={{ height: "100vh" }}>
+      <RapiDoc
+        spec-url="/__NEXT_OPENAPI_GEN_OUTPUT_FILE__"
+        render-style="read"
+        style={{ height: "100vh", width: "100%" }}
+      ></RapiDoc>
+    </section>
+  );
 }

package/templates/init/ui/nextjs/redoc.tsx

@@ -0,0 +1,11 @@
+"use client";
+
+import { RedocStandalone } from "redoc";
+
+export default function ApiDocsPage() {
+  return (
+    <section>
+      <RedocStandalone specUrl="/__NEXT_OPENAPI_GEN_OUTPUT_FILE__" />
+    </section>
+  );
+}

package/{dist/components/scalar.js → templates/init/ui/nextjs/scalar.tsx}

@@ -1,22 +1,16 @@
-export const scalarDeps = ["@scalar/api-reference-react", "ajv"];
-export const scalarDevDeps = [];
-export function ScalarUI(outputFile) {
-    return `
-"use client";
-
-import { ApiReferenceReact } from "@scalar/api-reference-react";
-
-import "@scalar/api-reference-react/style.css";
-
-export default function ApiDocsPage() {
-  return (
-    <ApiReferenceReact
-      configuration={{
-        _integration: "nextjs",
-        url: "/${outputFile}",
-      }}
-    />
-  );
-}
-`;
+"use client";
+
+import { ApiReferenceReact } from "@scalar/api-reference-react";
+
+import "@scalar/api-reference-react/style.css";
+
+export default function ApiDocsPage() {
+  return (
+    <ApiReferenceReact
+      configuration={{
+        _integration: "nextjs",
+        url: "/__NEXT_OPENAPI_GEN_OUTPUT_FILE__",
+      }}
+    />
+  );
 }

package/{dist/components/stoplight.js → templates/init/ui/nextjs/stoplight.tsx}

@@ -1,18 +1,12 @@
-export const stoplightDeps = ["@stoplight/elements"];
-export const stoplightDevDeps = [];
-export function StoplightUI(outputFile) {
-    return `
-"use client";
-
-import { API } from "@stoplight/elements";
-import "@stoplight/elements/styles.min.css";
-
-export default function ApiDocsPage() {
-  return (
-    <section style={{ height: "100vh" }}>
-      <API apiDescriptionUrl="${outputFile}" />
-    </section>
-  );
-}
-`;
+"use client";
+
+import { API } from "@stoplight/elements";
+import "@stoplight/elements/styles.min.css";
+
+export default function ApiDocsPage() {
+  return (
+    <section style={{ height: "100vh" }}>
+      <API apiDescriptionUrl="/__NEXT_OPENAPI_GEN_OUTPUT_FILE__" />
+    </section>
+  );
 }

package/templates/init/ui/nextjs/swagger.tsx

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

package/templates/init/ui/reactrouter/rapidoc.tsx

@@ -0,0 +1,15 @@
+import "rapidoc";
+
+const RapiDoc = "rapi-doc" as any;
+
+export default function ApiDocsPage() {
+  return (
+    <section style={{ height: "100vh" }}>
+      <RapiDoc
+        spec-url="/__NEXT_OPENAPI_GEN_OUTPUT_FILE__"
+        render-style="read"
+        style={{ height: "100vh", width: "100%" }}
+      ></RapiDoc>
+    </section>
+  );
+}

package/templates/init/ui/reactrouter/redoc.tsx

@@ -0,0 +1,9 @@
+import { RedocStandalone } from "redoc";
+
+export default function ApiDocsPage() {
+  return (
+    <section>
+      <RedocStandalone specUrl="/__NEXT_OPENAPI_GEN_OUTPUT_FILE__" />
+    </section>
+  );
+}

package/templates/init/ui/reactrouter/scalar.tsx

@@ -0,0 +1,14 @@
+import { ApiReferenceReact } from "@scalar/api-reference-react";
+
+import "@scalar/api-reference-react/style.css";
+
+export default function ApiDocsPage() {
+  return (
+    <ApiReferenceReact
+      configuration={{
+        _integration: "react",
+        url: "/__NEXT_OPENAPI_GEN_OUTPUT_FILE__",
+      }}
+    />
+  );
+}

package/templates/init/ui/reactrouter/stoplight.tsx

@@ -0,0 +1,10 @@
+import { API } from "@stoplight/elements";
+import "@stoplight/elements/styles.min.css";
+
+export default function ApiDocsPage() {
+  return (
+    <section style={{ height: "100vh" }}>
+      <API apiDescriptionUrl="/__NEXT_OPENAPI_GEN_OUTPUT_FILE__" />
+    </section>
+  );
+}

package/templates/init/ui/reactrouter/swagger.tsx

@@ -0,0 +1,11 @@
+import "swagger-ui-react/swagger-ui.css";
+
+import SwaggerUI from "swagger-ui-react";
+
+export default function ApiDocsPage() {
+  return (
+    <section>
+      <SwaggerUI url="/__NEXT_OPENAPI_GEN_OUTPUT_FILE__" />
+    </section>
+  );
+}

package/templates/init/ui/tanstack/rapidoc.tsx

@@ -0,0 +1,21 @@
+import { createFileRoute } from "@tanstack/react-router";
+
+import "rapidoc";
+
+const RapiDoc = "rapi-doc" as any;
+
+export const Route = createFileRoute("__NEXT_OPENAPI_GEN_ROUTE_PATH__")({
+  component: ApiDocsPage,
+});
+
+function ApiDocsPage() {
+  return (
+    <section style={{ height: "100vh" }}>
+      <RapiDoc
+        spec-url="/__NEXT_OPENAPI_GEN_OUTPUT_FILE__"
+        render-style="read"
+        style={{ height: "100vh", width: "100%" }}
+      ></RapiDoc>
+    </section>
+  );
+}

package/templates/init/ui/tanstack/redoc.tsx

@@ -0,0 +1,14 @@
+import { createFileRoute } from "@tanstack/react-router";
+import { RedocStandalone } from "redoc";
+
+export const Route = createFileRoute("__NEXT_OPENAPI_GEN_ROUTE_PATH__")({
+  component: ApiDocsPage,
+});
+
+function ApiDocsPage() {
+  return (
+    <section>
+      <RedocStandalone specUrl="/__NEXT_OPENAPI_GEN_OUTPUT_FILE__" />
+    </section>
+  );
+}

package/templates/init/ui/tanstack/scalar.tsx

@@ -0,0 +1,19 @@
+import { createFileRoute } from "@tanstack/react-router";
+import { ApiReferenceReact } from "@scalar/api-reference-react";
+
+import "@scalar/api-reference-react/style.css";
+
+export const Route = createFileRoute("__NEXT_OPENAPI_GEN_ROUTE_PATH__")({
+  component: ApiDocsPage,
+});
+
+function ApiDocsPage() {
+  return (
+    <ApiReferenceReact
+      configuration={{
+        _integration: "react",
+        url: "/__NEXT_OPENAPI_GEN_OUTPUT_FILE__",
+      }}
+    />
+  );
+}

package/templates/init/ui/tanstack/stoplight.tsx

@@ -0,0 +1,15 @@
+import { createFileRoute } from "@tanstack/react-router";
+import { API } from "@stoplight/elements";
+import "@stoplight/elements/styles.min.css";
+
+export const Route = createFileRoute("__NEXT_OPENAPI_GEN_ROUTE_PATH__")({
+  component: ApiDocsPage,
+});
+
+function ApiDocsPage() {
+  return (
+    <section style={{ height: "100vh" }}>
+      <API apiDescriptionUrl="/__NEXT_OPENAPI_GEN_OUTPUT_FILE__" />
+    </section>
+  );
+}

package/templates/init/ui/tanstack/swagger.tsx

@@ -0,0 +1,16 @@
+import "swagger-ui-react/swagger-ui.css";
+
+import { createFileRoute } from "@tanstack/react-router";
+import SwaggerUI from "swagger-ui-react";
+
+export const Route = createFileRoute("__NEXT_OPENAPI_GEN_ROUTE_PATH__")({
+  component: ApiDocsPage,
+});
+
+function ApiDocsPage() {
+  return (
+    <section>
+      <SwaggerUI url="/__NEXT_OPENAPI_GEN_OUTPUT_FILE__" />
+    </section>
+  );
+}

package/templates/init/ui/template-types.d.ts

@@ -0,0 +1,9 @@
+declare const React: unknown;
+
+declare module "@scalar/api-reference-react" {
+  export const ApiReferenceReact: (props: any) => any;
+}
+
+declare module "redoc" {
+  export const RedocStandalone: (props: any) => any;
+}

package/dist/commands/generate.js

@@ -1,24 +0,0 @@
-import fs from "fs";
-import fse from "fs-extra";
-import path from "path";
-import ora from "ora";
-import { OpenApiGenerator } from "../lib/openapi-generator.js";
-export async function generate(options) {
-    const { template } = options;
-    const spinner = ora("Generating OpenAPI specification...\n").start();
-    const generator = new OpenApiGenerator({
-        templatePath: template,
-    });
-    const config = generator.getConfig();
-    // Create api dir if not exists
-    const apiDir = path.resolve(config.apiDir);
-    await fse.ensureDir(apiDir);
-    // Use user-defined output directory
-    const outputDir = path.resolve(config.outputDir);
-    await fse.ensureDir(outputDir);
-    const apiDocs = generator.generate();
-    // Write api docs
-    const outputFile = path.join(outputDir, config.outputFile);
-    fs.writeFileSync(outputFile, JSON.stringify(apiDocs, null, 2));
-    spinner.succeed(`OpenAPI specification generated at ${outputFile}`);
-}