nestjs-openapi 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Eliya Cohen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,96 @@
+# nestjs-openapi
+
+Static OpenAPI generation for NestJS. Analyzes TypeScript source directly—no build step, no app bootstrap.
+
+[![npm version](https://img.shields.io/npm/v/nestjs-openapi)](https://www.npmjs.com/package/nestjs-openapi)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+
+## Why static analysis?
+
+|  | Runtime (`@nestjs/swagger`) | Static (`nestjs-openapi`) |
+|---|---|---|
+| Requires runtime execution | Yes | No |
+| Requires app bootstrap | Yes | No |
+| Preserves generics/unions | No | Yes |
+
+## Who is this for?
+
+- Teams who want accurate OpenAPI from TypeScript types without runtime metadata
+- CI/CD pipelines that should not boot the app or require infrastructure
+- Projects that want OpenAPI as a build artifact or committed output
+
+## Compatibility
+
+- NestJS 10 or 11 (decorator-based controllers)
+- TypeScript 5+
+- Node 20+
+
+## Limitations
+
+- Dynamic route registration at runtime is not supported
+- Response shortcut decorators like `@ApiOkResponse()` are not read
+- Controller versioning via `@Controller({ path, version })` is not supported
+
+## Quick start
+
+```bash
+pnpm add -D nestjs-openapi
+```
+
+Create `openapi.config.ts`:
+
+```typescript
+import { defineConfig } from 'nestjs-openapi';
+
+export default defineConfig({
+  output: 'openapi.json',
+  files: {
+    entry: 'src/app.module.ts',
+  },
+  openapi: {
+    info: { title: 'My API', version: '1.0.0' },
+  },
+});
+```
+
+Generate:
+
+```bash
+npx nestjs-openapi generate
+```
+
+## Migration from @nestjs/swagger
+
+1. Keep your controllers and route decorators as-is.
+2. Move `DocumentBuilder` config into `openapi.config.ts`.
+3. Replace response shortcuts with `@ApiResponse({ status: ... })`.
+4. (Optional) Use `OpenApiModule` to serve the generated spec at runtime.
+
+See the full guide in the docs.
+
+## Documentation
+
+Full documentation: **[nestjs-openapi.dev](https://nestjs-openapi.dev)**
+
+- [Configuration](https://nestjs-openapi.dev/docs/guides/configuration)
+- [Security schemes](https://nestjs-openapi.dev/docs/guides/security)
+- [Validation extraction](https://nestjs-openapi.dev/docs/guides/validation)
+- [Serving specs at runtime](https://nestjs-openapi.dev/docs/guides/serving)
+- [Migration guide](https://nestjs-openapi.dev/docs/recipes/migration)
+- [CI/CD recipe](https://nestjs-openapi.dev/docs/recipes/ci-cd)
+- [FAQ](https://nestjs-openapi.dev/docs/faq)
+- [Decorator support](https://nestjs-openapi.dev/docs/guides/decorators)
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## Sponsors
+
+<a href="https://github.com/sponsors/Newbie012">
+  <img src="https://cdn.jsdelivr.net/gh/newbie012/sponsors/sponsors.svg">
+</a>
+
+## License
+
+[MIT](LICENSE)

package/dist/cli.d.mts

@@ -0,0 +1 @@
+

package/dist/cli.d.ts

@@ -0,0 +1 @@
+

package/dist/cli.mjs

@@ -0,0 +1,139 @@
+#!/usr/bin/env node
+import 'tsx';
+import { g as generate, e as formatValidationResult } from './shared/nestjs-openapi.DlNMM8Zq.mjs';
+import minimist from 'minimist';
+import { relative } from 'node:path';
+import { createRequire } from 'node:module';
+import 'effect';
+import 'node:fs';
+import 'ts-morph';
+import 'glob';
+import 'js-yaml';
+import './shared/nestjs-openapi.B1bBy_tG.mjs';
+import 'ts-json-schema-generator';
+import 'node:crypto';
+import 'node:url';
+import 'child_process';
+
+const require = createRequire(import.meta.url);
+const pkg = require("../package.json");
+const VERSION = pkg.version;
+const HELP_TEXT = `
+nestjs-openapi - Generate OpenAPI specs from NestJS applications
+
+Usage:
+  nestjs-openapi generate -c <config-path>    Generate OpenAPI specification
+  nestjs-openapi --help                       Show this help message
+  nestjs-openapi --version                    Show version
+
+Options:
+  -c, --config <path>     Path to configuration file (required)
+  -f, --format <format>   Output format: json or yaml (overrides config)
+  -q, --quiet             Suppress output (only show errors)
+  -d, --debug             Enable debug output (verbose logging, full stack traces)
+  -h, --help              Show this help message
+  -v, --version           Show version
+
+Examples:
+  nestjs-openapi generate -c openapi.config.ts
+  nestjs-openapi generate -c openapi.config.ts --format yaml
+  nestjs-openapi generate -c openapi.config.ts --debug
+`.trim();
+const formatDuration = (ms) => {
+  if (ms < 1e3) return `${ms}ms`;
+  return `${(ms / 1e3).toFixed(1)}s`;
+};
+const success = (message) => {
+  console.log(`\x1B[32m\u2713\x1B[0m ${message}`);
+};
+const warning = (message) => {
+  console.log(`\x1B[33m\u26A0\x1B[0m ${message}`);
+};
+const error = (message) => {
+  console.error(`\x1B[31m\u2717\x1B[0m ${message}`);
+};
+const main = async () => {
+  const args = minimist(process.argv.slice(2), {
+    string: ["c", "config", "f", "format"],
+    boolean: ["quiet", "q", "debug", "d", "help", "h", "version", "v"],
+    alias: {
+      c: "config",
+      f: "format",
+      q: "quiet",
+      d: "debug",
+      h: "help",
+      v: "version"
+    }
+  });
+  if (args.help || args.h) {
+    console.log(HELP_TEXT);
+    process.exit(0);
+  }
+  if (args.version || args.v) {
+    console.log(VERSION);
+    process.exit(0);
+  }
+  const command = args._[0];
+  if (!command) {
+    console.log(HELP_TEXT);
+    process.exit(0);
+  }
+  if (command !== "generate") {
+    error(`Unknown command: ${command}`);
+    console.log('\nRun "nestjs-openapi --help" for usage information.');
+    process.exit(1);
+  }
+  const configPath = args.config || args.c;
+  const format = args.format || args.f;
+  const quiet = args.quiet || args.q;
+  const debug = args.debug || args.d;
+  if (!configPath) {
+    error("Config path is required. Use -c or --config to specify the path.");
+    console.log("\nExample: nestjs-openapi generate -c openapi.config.ts");
+    process.exit(1);
+  }
+  if (format && format !== "json" && format !== "yaml") {
+    error(`Invalid format: ${format}. Must be 'json' or 'yaml'.`);
+    process.exit(1);
+  }
+  const startTime = performance.now();
+  try {
+    const result = await generate(configPath, {
+      format,
+      debug
+    });
+    const duration = performance.now() - startTime;
+    if (!quiet) {
+      const relativePath = relative(process.cwd(), result.outputPath);
+      success(
+        `Generated ${relativePath} (${formatDuration(Math.round(duration))})`
+      );
+      console.log(
+        `  ${result.pathCount} paths, ${result.operationCount} operations`
+      );
+      if (!result.validation.valid) {
+        console.log("");
+        warning(`Spec has broken references`);
+        console.log(`  ${formatValidationResult(result.validation)}`);
+      }
+    }
+    process.exit(0);
+  } catch (err) {
+    const duration = performance.now() - startTime;
+    const message = err instanceof Error ? err.message : String(err);
+    error(`Generation failed (${formatDuration(Math.round(duration))})`);
+    console.error(`  ${message}`);
+    if (debug && err instanceof Error && err.stack) {
+      console.error("\nStack trace:");
+      console.error(err.stack);
+      if (err.cause) {
+        console.error("\nCause:", err.cause);
+      }
+    }
+    process.exit(1);
+  }
+};
+main().catch((err) => {
+  console.error("Unexpected error:", err);
+  process.exit(1);
+});