@dudousxd/nestjs-codegen 0.4.0 → 0.5.0

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import { U as UserConfig, R as ResolvedConfig, a as RouteDescriptor, S as SchemaNode, b as SchemaModule, c as ResolvedFormsConfig, V as ValidationAdapter, C as CodegenExtension, E as ExtensionContext } from './index-DA4uySjo.cjs';
-export { A as AdapterUsage, d as ContractDescriptor, e as ContractSource, f as ControllerRef, N as NumberCheck, g as RenderContext, h as RenderedModule, i as ScopeConfig, j as StringCheck, T as TypeRef, k as ValidationOption, r as resolveAdapter } from './index-DA4uySjo.cjs';
+import { U as UserConfig, R as ResolvedConfig, a as RouteDescriptor, S as SchemaNode, b as SchemaModule, c as ResolvedFormsConfig, V as ValidationAdapter, C as CodegenExtension, E as ExtensionContext } from './index-B0mS84Jj.cjs';
+export { A as AdapterUsage, d as ContractDescriptor, e as ContractSource, f as ControllerRef, N as NumberCheck, g as RenderContext, h as RenderedModule, i as ScopeConfig, j as StringCheck, T as TypeRef, k as ValidationOption, r as resolveAdapter } from './index-B0mS84Jj.cjs';
 import { ClassDeclaration, SourceFile, Project } from 'ts-morph';
 
 declare function defineConfig(c: UserConfig): UserConfig;
@@ -154,6 +154,106 @@ declare function emitApi(routes: RouteDescriptor[], outDir: string, opts?: ApiEm
  */
 declare function emitRoutes(routes: RouteDescriptor[], outDir: string): Promise<void>;
 
+/**
+ * Converts the neutral {@link SchemaNode} / {@link SchemaModule} IR into a
+ * JSON Schema object compatible with the OpenAPI 3.1 schema dialect (which *is*
+ * JSON Schema 2020-12). This is the shared lowering used by both the OpenAPI 3.1
+ * exporter (`emit/emit-openapi.ts`) and the MSW+faker mock generator
+ * (`emit/emit-msw.ts`) — they consume the same JSON Schema so the spec and the
+ * mocks can never disagree about a route's shape.
+ *
+ * Design notes:
+ *  - `enum` literals and `literal.raw` are verbatim TS source texts (quote style
+ *    preserved, produced by ts-morph `getText()`), e.g. `'active'`, `42`, `true`,
+ *    `null`. They are parsed back into real JSON values by {@link parseLiteral}.
+ *  - Named schemas (the `named` map of a `SchemaModule`) are lowered into
+ *    `components/schemas` and referenced via `$ref`, so recursion (`lazyRef`) and
+ *    sharing produce real `$ref` cycles rather than infinite inlining.
+ *  - `optional` only affects an *object field's* membership in `required`; a bare
+ *    optional widens the type with `null` (the closest JSON Schema analog).
+ */
+
+/** A minimal JSON Schema object (OpenAPI 3.1 dialect). Open-ended on purpose. */
+type JsonSchema = {
+    type?: string | string[];
+    format?: string;
+    enum?: unknown[];
+    const?: unknown;
+    items?: JsonSchema;
+    properties?: Record<string, JsonSchema>;
+    required?: string[];
+    additionalProperties?: boolean | JsonSchema;
+    oneOf?: JsonSchema[];
+    anyOf?: JsonSchema[];
+    discriminator?: {
+        propertyName: string;
+    };
+    $ref?: string;
+    description?: string;
+    nullable?: boolean;
+    [key: string]: unknown;
+};
+interface JsonSchemaContext {
+    /** Prefix for `$ref` targets. Default `'#/components/schemas/'`. */
+    refPrefix: string;
+}
+/** Convert a single {@link SchemaNode} to a JSON Schema object. */
+declare function schemaNodeToJsonSchema(node: SchemaNode, ctx?: JsonSchemaContext): JsonSchema;
+/**
+ * Lower an entire {@link SchemaModule} to a `{ root, named }` pair of JSON
+ * Schemas. The `named` map becomes `components/schemas` entries; `root` is the
+ * route-level schema that references them via `$ref`.
+ */
+declare function schemaModuleToJsonSchema(mod: SchemaModule, ctx?: JsonSchemaContext): {
+    root: JsonSchema;
+    named: Record<string, JsonSchema>;
+};
+
+interface OpenApiInfo {
+    title?: string;
+    version?: string;
+    description?: string;
+}
+interface OpenApiEmitOptions {
+    info?: OpenApiInfo;
+    /** Output file name within `outDir`. Default `'openapi.json'`. */
+    fileName?: string;
+}
+interface OpenApiDocument {
+    openapi: '3.1.0';
+    info: {
+        title: string;
+        version: string;
+        description?: string;
+    };
+    paths: Record<string, Record<string, unknown>>;
+    components: {
+        schemas: Record<string, JsonSchema>;
+    };
+}
+/** Build the OpenAPI 3.1 document object from the route set. Pure (no I/O). */
+declare function buildOpenApiSpec(routes: RouteDescriptor[], opts?: OpenApiEmitOptions): OpenApiDocument;
+/** Emit `openapi.json` into `outDir` for all contracted routes. */
+declare function emitOpenApi(routes: RouteDescriptor[], outDir: string, opts?: OpenApiEmitOptions): Promise<void>;
+
+interface MocksEmitOptions {
+    /** Output file name within `outDir`. Default `'mocks.ts'`. */
+    fileName?: string;
+    /** Deterministic seed. Default `1`. */
+    seed?: number;
+    /** Base URL prepended to handler paths. Default `''`. */
+    baseUrl?: string;
+}
+/** Build the `mocks.ts` source text. Pure (no I/O). */
+declare function buildMocksFile(routes: RouteDescriptor[], opts?: MocksEmitOptions): string;
+/** Emit `mocks.ts` into `outDir`. */
+declare function emitMocks(routes: RouteDescriptor[], outDir: string, opts?: MocksEmitOptions): Promise<void>;
+
+/**
+ * Static AST-based contract discovery using ts-morph.
+ * Cold start ~100-500 ms.
+ */
+
 interface FastDiscoveryOptions {
     /** Absolute path to the project root. */
     cwd: string;
@@ -164,6 +264,6 @@ interface FastDiscoveryOptions {
 }
 declare function discoverContractsFast(opts: FastDiscoveryOptions): Promise<RouteDescriptor[]>;
 
-declare const VERSION = "0.4.0";
+declare const VERSION = "0.5.0";
 
-export { CodegenError, ConfigError, type FastDiscoveryOptions, ResolvedConfig, RouteDescriptor, SchemaModule, SchemaNode, type TsTypeContext, UserConfig, VERSION, ValidationAdapter, type Watcher, acquireLock, defineConfig, discoverContractsFast, emitApi, emitForms, emitRoutes, extractSchemaFromDto, generate, loadConfig, renderTsType, resolveConfig, watch };
+export { CodegenError, ConfigError, type FastDiscoveryOptions, type JsonSchema, type MocksEmitOptions, type OpenApiDocument, type OpenApiEmitOptions, type OpenApiInfo, ResolvedConfig, RouteDescriptor, SchemaModule, SchemaNode, type TsTypeContext, UserConfig, VERSION, ValidationAdapter, type Watcher, acquireLock, buildMocksFile, buildOpenApiSpec, defineConfig, discoverContractsFast, emitApi, emitForms, emitMocks, emitOpenApi, emitRoutes, extractSchemaFromDto, generate, loadConfig, renderTsType, resolveConfig, schemaModuleToJsonSchema, schemaNodeToJsonSchema, watch };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { U as UserConfig, R as ResolvedConfig, a as RouteDescriptor, S as SchemaNode, b as SchemaModule, c as ResolvedFormsConfig, V as ValidationAdapter, C as CodegenExtension, E as ExtensionContext } from './index-DA4uySjo.js';
-export { A as AdapterUsage, d as ContractDescriptor, e as ContractSource, f as ControllerRef, N as NumberCheck, g as RenderContext, h as RenderedModule, i as ScopeConfig, j as StringCheck, T as TypeRef, k as ValidationOption, r as resolveAdapter } from './index-DA4uySjo.js';
+import { U as UserConfig, R as ResolvedConfig, a as RouteDescriptor, S as SchemaNode, b as SchemaModule, c as ResolvedFormsConfig, V as ValidationAdapter, C as CodegenExtension, E as ExtensionContext } from './index-B0mS84Jj.js';
+export { A as AdapterUsage, d as ContractDescriptor, e as ContractSource, f as ControllerRef, N as NumberCheck, g as RenderContext, h as RenderedModule, i as ScopeConfig, j as StringCheck, T as TypeRef, k as ValidationOption, r as resolveAdapter } from './index-B0mS84Jj.js';
 import { ClassDeclaration, SourceFile, Project } from 'ts-morph';
 
 declare function defineConfig(c: UserConfig): UserConfig;
@@ -154,6 +154,106 @@ declare function emitApi(routes: RouteDescriptor[], outDir: string, opts?: ApiEm
  */
 declare function emitRoutes(routes: RouteDescriptor[], outDir: string): Promise<void>;
 
+/**
+ * Converts the neutral {@link SchemaNode} / {@link SchemaModule} IR into a
+ * JSON Schema object compatible with the OpenAPI 3.1 schema dialect (which *is*
+ * JSON Schema 2020-12). This is the shared lowering used by both the OpenAPI 3.1
+ * exporter (`emit/emit-openapi.ts`) and the MSW+faker mock generator
+ * (`emit/emit-msw.ts`) — they consume the same JSON Schema so the spec and the
+ * mocks can never disagree about a route's shape.
+ *
+ * Design notes:
+ *  - `enum` literals and `literal.raw` are verbatim TS source texts (quote style
+ *    preserved, produced by ts-morph `getText()`), e.g. `'active'`, `42`, `true`,
+ *    `null`. They are parsed back into real JSON values by {@link parseLiteral}.
+ *  - Named schemas (the `named` map of a `SchemaModule`) are lowered into
+ *    `components/schemas` and referenced via `$ref`, so recursion (`lazyRef`) and
+ *    sharing produce real `$ref` cycles rather than infinite inlining.
+ *  - `optional` only affects an *object field's* membership in `required`; a bare
+ *    optional widens the type with `null` (the closest JSON Schema analog).
+ */
+
+/** A minimal JSON Schema object (OpenAPI 3.1 dialect). Open-ended on purpose. */
+type JsonSchema = {
+    type?: string | string[];
+    format?: string;
+    enum?: unknown[];
+    const?: unknown;
+    items?: JsonSchema;
+    properties?: Record<string, JsonSchema>;
+    required?: string[];
+    additionalProperties?: boolean | JsonSchema;
+    oneOf?: JsonSchema[];
+    anyOf?: JsonSchema[];
+    discriminator?: {
+        propertyName: string;
+    };
+    $ref?: string;
+    description?: string;
+    nullable?: boolean;
+    [key: string]: unknown;
+};
+interface JsonSchemaContext {
+    /** Prefix for `$ref` targets. Default `'#/components/schemas/'`. */
+    refPrefix: string;
+}
+/** Convert a single {@link SchemaNode} to a JSON Schema object. */
+declare function schemaNodeToJsonSchema(node: SchemaNode, ctx?: JsonSchemaContext): JsonSchema;
+/**
+ * Lower an entire {@link SchemaModule} to a `{ root, named }` pair of JSON
+ * Schemas. The `named` map becomes `components/schemas` entries; `root` is the
+ * route-level schema that references them via `$ref`.
+ */
+declare function schemaModuleToJsonSchema(mod: SchemaModule, ctx?: JsonSchemaContext): {
+    root: JsonSchema;
+    named: Record<string, JsonSchema>;
+};
+
+interface OpenApiInfo {
+    title?: string;
+    version?: string;
+    description?: string;
+}
+interface OpenApiEmitOptions {
+    info?: OpenApiInfo;
+    /** Output file name within `outDir`. Default `'openapi.json'`. */
+    fileName?: string;
+}
+interface OpenApiDocument {
+    openapi: '3.1.0';
+    info: {
+        title: string;
+        version: string;
+        description?: string;
+    };
+    paths: Record<string, Record<string, unknown>>;
+    components: {
+        schemas: Record<string, JsonSchema>;
+    };
+}
+/** Build the OpenAPI 3.1 document object from the route set. Pure (no I/O). */
+declare function buildOpenApiSpec(routes: RouteDescriptor[], opts?: OpenApiEmitOptions): OpenApiDocument;
+/** Emit `openapi.json` into `outDir` for all contracted routes. */
+declare function emitOpenApi(routes: RouteDescriptor[], outDir: string, opts?: OpenApiEmitOptions): Promise<void>;
+
+interface MocksEmitOptions {
+    /** Output file name within `outDir`. Default `'mocks.ts'`. */
+    fileName?: string;
+    /** Deterministic seed. Default `1`. */
+    seed?: number;
+    /** Base URL prepended to handler paths. Default `''`. */
+    baseUrl?: string;
+}
+/** Build the `mocks.ts` source text. Pure (no I/O). */
+declare function buildMocksFile(routes: RouteDescriptor[], opts?: MocksEmitOptions): string;
+/** Emit `mocks.ts` into `outDir`. */
+declare function emitMocks(routes: RouteDescriptor[], outDir: string, opts?: MocksEmitOptions): Promise<void>;
+
+/**
+ * Static AST-based contract discovery using ts-morph.
+ * Cold start ~100-500 ms.
+ */
+
 interface FastDiscoveryOptions {
     /** Absolute path to the project root. */
     cwd: string;
@@ -164,6 +264,6 @@ interface FastDiscoveryOptions {
 }
 declare function discoverContractsFast(opts: FastDiscoveryOptions): Promise<RouteDescriptor[]>;
 
-declare const VERSION = "0.4.0";
+declare const VERSION = "0.5.0";
 
-export { CodegenError, ConfigError, type FastDiscoveryOptions, ResolvedConfig, RouteDescriptor, SchemaModule, SchemaNode, type TsTypeContext, UserConfig, VERSION, ValidationAdapter, type Watcher, acquireLock, defineConfig, discoverContractsFast, emitApi, emitForms, emitRoutes, extractSchemaFromDto, generate, loadConfig, renderTsType, resolveConfig, watch };
+export { CodegenError, ConfigError, type FastDiscoveryOptions, type JsonSchema, type MocksEmitOptions, type OpenApiDocument, type OpenApiEmitOptions, type OpenApiInfo, ResolvedConfig, RouteDescriptor, SchemaModule, SchemaNode, type TsTypeContext, UserConfig, VERSION, ValidationAdapter, type Watcher, acquireLock, buildMocksFile, buildOpenApiSpec, defineConfig, discoverContractsFast, emitApi, emitForms, emitMocks, emitOpenApi, emitRoutes, extractSchemaFromDto, generate, loadConfig, renderTsType, resolveConfig, schemaModuleToJsonSchema, schemaNodeToJsonSchema, watch };