nestjs-openapi 0.1.3 → 0.2.0

package/dist/index.mjs

@@ -1,18 +1,19 @@
-export { c as categorizeBrokenRefs, d as defineConfig, f as findConfigFile, e as formatValidationResult, g as generate, b as loadAndResolveConfig, a as loadConfig, l as loadConfigFromFile, r as resolveConfig, v as validateSpec } from './shared/nestjs-openapi.D2c4bMP5.mjs';
+import { S as SpecFileNotFoundError, a as SpecFileReadError, b as SpecFileParseError } from './shared/nestjs-openapi.P9V98nna.mjs';
+export { c as ConfigLoadError, C as ConfigNotFoundError, ae as ConfigService, e as ConfigValidationError, D as DtoGlobResolutionError, E as EntryNotFoundError, I as InvalidMethodError, B as MethodExtractionService, M as MissingGenericSchemaTempFileCleanupError, f as MissingGenericSchemaTempFileWriteError, n as ModuleTraversalService, ad as OutputService, P as ProjectInitError, i as ProjectService, j as ProjectServiceLive, h as PublicApiError, a0 as SchemaGenerationError, a1 as SchemaService, ac as ValidationService, a9 as applyConstraintsToSchema, av as categorizeBrokenRefs, d as defineConfig, a7 as extractClassConstraints, a5 as extractClassValidationInfo, a6 as extractClassValidationInfoEffect, a2 as extractPropertyConstraints, a4 as extractPropertyValidationInfo, V as filterInternalSchemas, W as filterInternalSchemasEffect, Q as filterSchemas, R as filterSchemasEffect, af as findConfigFile, aw as formatValidationResult, g as generate, _ as generateSchemas, $ as generateSchemasFromFiles, ak as generatorServicesLayer, l as getAllControllers, am as getArrayInitializer, z as getControllerMethodInfos, A as getControllerMethodInfosEffect, p as getControllerName, o as getControllerPrefix, t as getControllerTags, s as getDecoratorName, u as getHttpDecorator, r as getHttpMethods, x as getMethodInfo, y as getMethodInfoEffect, aq as getModuleDecoratorArg, at as getModuleMetadata, k as getModules, a8 as getRequiredProperties, an as getStringLiteralValue, ao as getSymbolFromIdentifier, v as isHttpDecorator, q as isHttpMethod, ap as isModuleClass, a3 as isPropertyOptional, aj as loadAndResolveConfig, ah as loadConfig, ag as loadConfigFromFile, m as makeProjectContext, N as mergeGeneratedSchemas, O as mergeGeneratedSchemasEffect, K as mergeSchemas, L as mergeSchemasEffect, aa as mergeValidationConstraints, ab as mergeValidationConstraintsEffect, w as normalizePath, T as normalizeSchemas, U as normalizeSchemasEffect, X as normalizeStructureRefs, Y as normalizeStructureRefsEffect, as as resolveArrayOfClasses, ar as resolveClassFromExpression, al as resolveClassFromSymbol, ai as resolveConfig, Z as toPascalCase, F as transformMethod, G as transformMethodEffect, H as transformMethods, J as transformMethodsEffect, au as validateSpec } from './shared/nestjs-openapi.P9V98nna.mjs';
 import { readFileSync } from 'node:fs';
+import { fail } from 'node:assert';
 import { resolve } from 'node:path';
 import { Module } from '@nestjs/common';
-export { generateAsync, generate as generateEffect } from './internal.mjs';
-import { P as ProjectInitError, E as EntryNotFoundError } from './shared/nestjs-openapi.DRcy130f.mjs';
-export { a as ConfigLoadError, C as ConfigNotFoundError, b as ConfigValidationError, I as InvalidMethodError, c as getAllControllers, q as getArrayInitializer, o as getControllerMethodInfos, e as getControllerName, d as getControllerPrefix, j as getControllerTags, h as getDecoratorName, k as getHttpDecorator, f as getHttpMethods, m as getMethodInfo, w as getModuleDecoratorArg, z as getModuleMetadata, g as getModules, s as getStringLiteralValue, u as getSymbolFromIdentifier, l as isHttpDecorator, i as isHttpMethod, v as isModuleClass, n as normalizePath, y as resolveArrayOfClasses, x as resolveClassFromExpression, r as resolveClassFromSymbol, t as transformMethod, p as transformMethods } from './shared/nestjs-openapi.DRcy130f.mjs';
-import { Context, Effect, Layer } from 'effect';
-import { Project } from 'ts-morph';
+import { Effect, Exit, Cause, Option } from 'effect';
+export { generateAsync, generate as generateEffect, generateFromConfigAsync, generateFromConfigEffect, generatePathsAsync, generatePathsEffect } from './internal.mjs';
 import 'node:crypto';
+import 'ts-morph';
 import 'glob';
-import 'js-yaml';
-import 'ts-json-schema-generator';
 import 'node:url';
+import 'node:module';
 import 'child_process';
+import 'js-yaml';
+import 'ts-json-schema-generator';
 
 var __create = Object.create;
 var __defProp = Object.defineProperty;
@@ -93,22 +94,29 @@ function generateSwaggerUiHtml(title, jsonPath) {
 </body>
 </html>`;
 }
-function loadSpecFile(filePath) {
-  try {
+const loadSpecFileEffect = Effect.fn("OpenApiModule.loadSpecFile")(
+  function* (filePath) {
     const resolvedPath = resolve(process.cwd(), filePath);
-    const content = readFileSync(resolvedPath, "utf-8");
-    return JSON.parse(content);
-  } catch (error) {
-    if (error instanceof Error) {
-      if ("code" in error && error.code === "ENOENT") {
-        throw new Error(
-          `OpenAPI spec file not found: ${filePath}. Make sure to run 'nestjs-openapi generate' first.`
-        );
-      }
-      throw new Error(`Failed to load OpenAPI spec: ${error.message}`);
-    }
-    throw error;
+    const content = yield* Effect.try({
+      try: () => readFileSync(resolvedPath, "utf-8"),
+      catch: (cause) => cause && typeof cause === "object" && "code" in cause && cause.code === "ENOENT" ? SpecFileNotFoundError.create(filePath) : SpecFileReadError.create(filePath, cause)
+    });
+    return yield* Effect.try({
+      try: () => JSON.parse(content),
+      catch: (cause) => SpecFileParseError.create(filePath, cause)
+    });
+  }
+);
+function loadSpecFile(filePath) {
+  const exit = Effect.runSyncExit(loadSpecFileEffect(filePath));
+  if (Exit.isSuccess(exit)) {
+    return exit.value;
+  }
+  const failure = Cause.failureOption(exit.cause);
+  if (Option.isSome(failure)) {
+    fail(failure.value);
   }
+  fail(Cause.pretty(exit.cause));
 }
 function resolveOptions(options) {
   let swaggerEnabled = false;
@@ -232,66 +240,4 @@ function createOpenApiControllers(options, spec) {
   return controllers;
 }
 
-class ProjectService extends Context.Tag("ProjectService")() {
-}
-const initProject = Effect.fn("ProjectService.initProject")(function* (options) {
-  return yield* Effect.try({
-    try: () => new Project({
-      tsConfigFilePath: options.tsconfig,
-      skipAddingFilesFromTsConfig: true
-    }),
-    catch: (error) => ProjectInitError.create(options.tsconfig, error)
-  });
-});
-const addSourceFiles = Effect.fn("ProjectService.addSourceFiles")(function* (project, entry) {
-  return yield* Effect.try({
-    try: () => {
-      project.addSourceFilesAtPaths(entry);
-      project.resolveSourceFileDependencies();
-    },
-    catch: (error) => new ProjectInitError({
-      tsconfig: "",
-      message: `Failed to add source files: ${entry}`,
-      cause: error
-    })
-  });
-});
-const getEntrySourceFile = Effect.fn("ProjectService.getEntrySourceFile")(
-  function* (project, entry) {
-    const sourceFile = project.getSourceFile(entry);
-    if (!sourceFile) {
-      return yield* EntryNotFoundError.fileNotFound(entry);
-    }
-    return sourceFile;
-  }
-);
-const getEntryClass = Effect.fn("ProjectService.getEntryClass")(function* (sourceFile, entry, className = "AppModule") {
-  const entryClass = sourceFile.getClass(className);
-  if (!entryClass) {
-    return yield* EntryNotFoundError.classNotFound(entry, className);
-  }
-  return entryClass;
-});
-const makeProjectContext = Effect.fn(
-  "ProjectService.makeProjectContext"
-)(function* (options) {
-  yield* Effect.logDebug("Initializing project").pipe(
-    Effect.annotateLogs({ entry: options.entry })
-  );
-  const project = yield* initProject(options);
-  yield* addSourceFiles(project, options.entry);
-  const entrySourceFile = yield* getEntrySourceFile(project, options.entry);
-  const entryClass = yield* getEntryClass(entrySourceFile, options.entry);
-  yield* Effect.logDebug("Project initialized successfully");
-  return {
-    project,
-    entrySourceFile,
-    entryClass
-  };
-});
-const ProjectServiceLive = (options) => Layer.effect(
-  ProjectService,
-  makeProjectContext(options).pipe(Effect.map((context) => ({ context })))
-);
-
-export { EntryNotFoundError, OPENAPI_MODULE_OPTIONS, OPENAPI_SPEC, OpenApiModule, ProjectInitError, ProjectService, ProjectServiceLive, generateSwaggerUiHtml, loadSpecFile, makeProjectContext, resolveOptions };
+export { OPENAPI_MODULE_OPTIONS, OPENAPI_SPEC, OpenApiModule, SpecFileNotFoundError, SpecFileParseError, SpecFileReadError, generateSwaggerUiHtml, loadSpecFile, loadSpecFileEffect, resolveOptions };

package/dist/internal.d.mts

@@ -1,2 +1,3 @@
+export { E as GenerateOptions, x as generate, y as generateAsync, D as generateFromConfigAsync, B as generateFromConfigEffect, A as generatePathsAsync, z as generatePathsEffect } from './shared/nestjs-openapi.D0Osp4GW.mjs';
 import 'effect';
-export { G as GenerateOptions, g as generate, d as generateAsync } from './shared/nestjs-openapi.t3iwzrrT.mjs';
+import 'ts-morph';

package/dist/internal.d.ts

@@ -1,2 +1,3 @@
+export { E as GenerateOptions, x as generate, y as generateAsync, D as generateFromConfigAsync, B as generateFromConfigEffect, A as generatePathsAsync, z as generatePathsEffect } from './shared/nestjs-openapi.D0Osp4GW.js';
 import 'effect';
-export { G as GenerateOptions, g as generate, d as generateAsync } from './shared/nestjs-openapi.t3iwzrrT.js';
+import 'ts-morph';

package/dist/internal.mjs

@@ -1,53 +1,60 @@
 import { Effect } from 'effect';
-import { Project } from 'ts-morph';
-import { E as EntryNotFoundError, g as getModules, o as getControllerMethodInfos, p as transformMethods } from './shared/nestjs-openapi.DRcy130f.mjs';
+import { i as ProjectService, n as ModuleTraversalService, B as MethodExtractionService, J as transformMethodsEffect, ax as generateEffect, ay as runProjectApiPromise, ak as generatorServicesLayer, az as runtimeLayerFor, aA as runGeneratorApiPromise } from './shared/nestjs-openapi.P9V98nna.mjs';
+import 'node:fs';
+import 'node:path';
+import 'node:crypto';
+import 'ts-morph';
+import 'glob';
+import 'node:url';
+import 'node:module';
+import 'child_process';
+import 'js-yaml';
+import 'ts-json-schema-generator';
 
-const generate = (options) => Effect.gen(function* () {
-  yield* Effect.logInfo("Starting OpenAPI generation").pipe(
-    Effect.annotateLogs({ entry: options.entry })
-  );
-  const project = new Project({
-    tsConfigFilePath: options.tsconfig,
-    skipAddingFilesFromTsConfig: true
-  });
-  project.addSourceFilesAtPaths(options.entry);
-  project.resolveSourceFileDependencies();
-  const entrySourceFile = project.getSourceFile(options.entry);
-  if (!entrySourceFile) {
-    return yield* EntryNotFoundError.fileNotFound(options.entry);
-  }
-  const entryClass = entrySourceFile.getClass("AppModule");
-  if (!entryClass) {
-    return yield* EntryNotFoundError.classNotFound(
-      options.entry,
-      "AppModule"
+const generatePathsEffect = Effect.fn("Internal.generatePathsEffect")(
+  function* (options) {
+    yield* Effect.logInfo("Starting OpenAPI generation").pipe(
+      Effect.annotateLogs({ entry: options.entry })
+    );
+    const { entryClass } = yield* ProjectService.makeProjectContext(options);
+    const modules = yield* ModuleTraversalService.getModules(entryClass);
+    const methodInfos = yield* Effect.forEach(
+      modules.flatMap((mod) => mod.controllers),
+      (controller) => MethodExtractionService.getControllerMethodInfos(controller),
+      { concurrency: "unbounded" }
+    );
+    const flatMethodInfos = methodInfos.flat();
+    yield* Effect.logInfo("Collected method infos").pipe(
+      Effect.annotateLogs({
+        modules: modules.length,
+        methods: flatMethodInfos.length
+      })
+    );
+    const paths = yield* transformMethodsEffect(flatMethodInfos);
+    yield* Effect.logInfo("OpenAPI generation complete").pipe(
+      Effect.annotateLogs({ paths: Object.keys(paths).length })
     );
+    return paths;
   }
-  const modules = yield* getModules(entryClass);
-  const methodInfos = modules.flatMap(
-    (mod) => mod.controllers.flatMap(
-      (controller) => getControllerMethodInfos(controller)
+);
+const generateFromConfigEffect = generateEffect;
+const generatePathsAsync = async (options) => {
+  const program = generatePathsEffect(options);
+  return runProjectApiPromise(program.pipe(Effect.provide(generatorServicesLayer)));
+};
+const generateFromConfigAsync = async (configPath, overrides) => {
+  const program = generateFromConfigEffect(configPath, overrides).pipe(
+    Effect.provide(generatorServicesLayer),
+    Effect.provide(
+      runtimeLayerFor(
+        overrides?.debug ?? false,
+        overrides?.telemetry
+      )
     )
   );
-  yield* Effect.logInfo("Collected method infos").pipe(
-    Effect.annotateLogs({
-      modules: modules.length,
-      methods: methodInfos.length
-    })
-  );
-  const paths = transformMethods(methodInfos);
-  yield* Effect.logInfo("OpenAPI generation complete").pipe(
-    Effect.annotateLogs({
-      paths: Object.keys(paths).length
-    })
-  );
-  return paths;
-});
-const generateAsync = async (options) => {
-  const program = generate(options).pipe(
-    Effect.mapError((error) => new Error(error.message))
-  );
-  return Effect.runPromise(program);
+  return runGeneratorApiPromise(program);
 };
+const generate = generatePathsEffect;
+const generateAsync = generatePathsAsync;
 
-export { generate, generateAsync };
+export { generate, generateAsync, generateFromConfigAsync, generateFromConfigEffect, generatePathsAsync, generatePathsEffect };