@dudousxd/nestjs-codegen 0.4.1 → 0.5.0

package/dist/extension/index.d.cts

@@ -1,2 +1,2 @@
-export { l as ApiClientLayer, m as ApiHeaderContribution, n as ApiModuleDeps, C as CodegenExtension, o as EmittedFile, E as ExtensionContext, L as LeafModel, p as RequestModel, q as RequestShape, s as defineExtension, t as requestShape } from '../index-DA4uySjo.cjs';
+export { l as ApiClientLayer, m as ApiHeaderContribution, n as ApiModuleDeps, C as CodegenExtension, o as EmittedFile, E as ExtensionContext, L as LeafModel, p as RequestModel, q as RequestShape, s as defineExtension, t as requestShape } from '../index-B0mS84Jj.cjs';
 import 'ts-morph';

package/dist/extension/index.d.ts

@@ -1,2 +1,2 @@
-export { l as ApiClientLayer, m as ApiHeaderContribution, n as ApiModuleDeps, C as CodegenExtension, o as EmittedFile, E as ExtensionContext, L as LeafModel, p as RequestModel, q as RequestShape, s as defineExtension, t as requestShape } from '../index-DA4uySjo.js';
+export { l as ApiClientLayer, m as ApiHeaderContribution, n as ApiModuleDeps, C as CodegenExtension, o as EmittedFile, E as ExtensionContext, L as LeafModel, p as RequestModel, q as RequestShape, s as defineExtension, t as requestShape } from '../index-B0mS84Jj.js';
 import 'ts-morph';

package/dist/{index-DA4uySjo.d.cts → index-B0mS84Jj.d.cts}

@@ -73,9 +73,17 @@ type SchemaNode = {
 } | {
     kind: 'literal';
     raw: string;
-} | {
+}
+/**
+ * A union of schemas. When `discriminator` is set (the shared literal property
+ * name, e.g. `'kind'`), this is a *discriminated* union: adapters that support
+ * it emit a fast tagged-union form (zod `discriminatedUnion`, valibot `variant`).
+ * Plain unions leave `discriminator` undefined.
+ */
+ | {
     kind: 'union';
     options: SchemaNode[];
+    discriminator?: string;
 } | {
     kind: 'object';
     fields: Array<{
@@ -259,6 +267,38 @@ interface UserConfig {
         /** Module specifier for the `z` import. Default: `'zod'`. */
         zodImport?: string;
     };
+    /**
+     * OpenAPI 3.1 spec export (`openapi.json`). Opt-in: omit (or `enabled: false`)
+     * to skip. Lowers the discovered routes + validation IR into a valid OpenAPI
+     * 3.1 document for ecosystem interop (consume/publish a spec).
+     */
+    openapi?: {
+        /** Emit `openapi.json`. Default: `false`. */
+        enabled?: boolean;
+        /** Output file name within `outDir`. Default: `'openapi.json'`. */
+        fileName?: string;
+        /** `info.title`. Default: `'NestJS API'`. */
+        title?: string;
+        /** `info.version`. Default: `'1.0.0'`. */
+        version?: string;
+        /** `info.description`. */
+        description?: string;
+    };
+    /**
+     * MSW + faker mock handler generation (`mocks.ts`). Opt-in: omit (or
+     * `enabled: false`) to skip. Generates Mock Service Worker handlers that return
+     * faker-style data matching each route's response schema.
+     */
+    mocks?: {
+        /** Emit `mocks.ts`. Default: `false`. */
+        enabled?: boolean;
+        /** Output file name within `outDir`. Default: `'mocks.ts'`. */
+        fileName?: string;
+        /** Deterministic seed for generated mock data. Default: `1`. */
+        seed?: number;
+        /** Base URL prepended to handler paths. Default: `''` (relative paths). */
+        baseUrl?: string;
+    };
 }
 interface ScopeConfig {
     glob: string;
@@ -288,6 +328,19 @@ interface ResolvedFormsConfig {
     watch: string;
     zodImport: string;
 }
+interface ResolvedOpenApiConfig {
+    enabled: boolean;
+    fileName: string;
+    title: string;
+    version: string;
+    description: string | null;
+}
+interface ResolvedMocksConfig {
+    enabled: boolean;
+    fileName: string;
+    seed: number;
+    baseUrl: string;
+}
 interface ResolvedConfig {
     extensions: CodegenExtension[];
     validation: ValidationAdapter;
@@ -300,6 +353,8 @@ interface ResolvedConfig {
         importPath: string;
     } | null;
     forms: ResolvedFormsConfig;
+    openapi: ResolvedOpenApiConfig;
+    mocks: ResolvedMocksConfig;
 }
 
 interface TypeRef {
@@ -346,9 +401,19 @@ interface ContractSource {
     query: string | null;
     body: string | null;
     response: string;
+    /**
+     * The route's error response body type, as a TS type-source string. Discovered
+     * from a `defineContract({ error })` zod schema, or an `@ApiResponse({ status,
+     * type })` decorator whose `status` is a 4xx/5xx code. Absent/null means the
+     * error body is untyped and resolves to `unknown` in `Route.Error<K>` (never
+     * `never` — an HTTP error always carries some body).
+     */
+    error?: string | null;
     queryRef?: TypeRef | null;
     bodyRef?: TypeRef | null;
     responseRef?: TypeRef | null;
+    /** Importable named ref for the error type (parallel to {@link responseRef}). */
+    errorRef?: TypeRef | null;
     filterFields?: string[] | null;
     filterFieldTypes?: FilterFieldType[] | null;
     filterSource?: 'body' | 'query' | null;
@@ -372,6 +437,23 @@ interface ContractSource {
     bodySchema?: SchemaModule | null;
     /** Neutral validation IR for the query (class-validator DTO only). */
     querySchema?: SchemaModule | null;
+    /**
+     * Neutral validation IR for the success RESPONSE body, when it can be derived
+     * from a class-validator-decorated response DTO. Consumed by the OpenAPI export
+     * (richer `responses` schemas) and the MSW+faker mock generator (schema-shaped
+     * mock data). Optional/additive: when absent the response degrades to the TS
+     * type string (`response`) and mocks fall back to a permissive shape.
+     */
+    responseSchema?: SchemaModule | null;
+    /**
+     * True when the route is a server-sent-events / streaming endpoint: it carries
+     * a `@Sse()` decorator, or its handler returns `Observable<T>` /
+     * `AsyncIterable<T>` / `AsyncGenerator<T>`. When set, `response` (and
+     * `responseRef`) describe the streamed ELEMENT type `T` (NestJS `MessageEvent<T>`
+     * wrappers are unwrapped to `T`), and the client surfaces the route as an
+     * `AsyncIterable<T>` stream rather than a single awaited value.
+     */
+    stream?: boolean;
 }
 interface ContractDescriptor {
     contractSource: ContractSource;

package/dist/{index-DA4uySjo.d.ts → index-B0mS84Jj.d.ts}

@@ -73,9 +73,17 @@ type SchemaNode = {
 } | {
     kind: 'literal';
     raw: string;
-} | {
+}
+/**
+ * A union of schemas. When `discriminator` is set (the shared literal property
+ * name, e.g. `'kind'`), this is a *discriminated* union: adapters that support
+ * it emit a fast tagged-union form (zod `discriminatedUnion`, valibot `variant`).
+ * Plain unions leave `discriminator` undefined.
+ */
+ | {
     kind: 'union';
     options: SchemaNode[];
+    discriminator?: string;
 } | {
     kind: 'object';
     fields: Array<{
@@ -259,6 +267,38 @@ interface UserConfig {
         /** Module specifier for the `z` import. Default: `'zod'`. */
         zodImport?: string;
     };
+    /**
+     * OpenAPI 3.1 spec export (`openapi.json`). Opt-in: omit (or `enabled: false`)
+     * to skip. Lowers the discovered routes + validation IR into a valid OpenAPI
+     * 3.1 document for ecosystem interop (consume/publish a spec).
+     */
+    openapi?: {
+        /** Emit `openapi.json`. Default: `false`. */
+        enabled?: boolean;
+        /** Output file name within `outDir`. Default: `'openapi.json'`. */
+        fileName?: string;
+        /** `info.title`. Default: `'NestJS API'`. */
+        title?: string;
+        /** `info.version`. Default: `'1.0.0'`. */
+        version?: string;
+        /** `info.description`. */
+        description?: string;
+    };
+    /**
+     * MSW + faker mock handler generation (`mocks.ts`). Opt-in: omit (or
+     * `enabled: false`) to skip. Generates Mock Service Worker handlers that return
+     * faker-style data matching each route's response schema.
+     */
+    mocks?: {
+        /** Emit `mocks.ts`. Default: `false`. */
+        enabled?: boolean;
+        /** Output file name within `outDir`. Default: `'mocks.ts'`. */
+        fileName?: string;
+        /** Deterministic seed for generated mock data. Default: `1`. */
+        seed?: number;
+        /** Base URL prepended to handler paths. Default: `''` (relative paths). */
+        baseUrl?: string;
+    };
 }
 interface ScopeConfig {
     glob: string;
@@ -288,6 +328,19 @@ interface ResolvedFormsConfig {
     watch: string;
     zodImport: string;
 }
+interface ResolvedOpenApiConfig {
+    enabled: boolean;
+    fileName: string;
+    title: string;
+    version: string;
+    description: string | null;
+}
+interface ResolvedMocksConfig {
+    enabled: boolean;
+    fileName: string;
+    seed: number;
+    baseUrl: string;
+}
 interface ResolvedConfig {
     extensions: CodegenExtension[];
     validation: ValidationAdapter;
@@ -300,6 +353,8 @@ interface ResolvedConfig {
         importPath: string;
     } | null;
     forms: ResolvedFormsConfig;
+    openapi: ResolvedOpenApiConfig;
+    mocks: ResolvedMocksConfig;
 }
 
 interface TypeRef {
@@ -346,9 +401,19 @@ interface ContractSource {
     query: string | null;
     body: string | null;
     response: string;
+    /**
+     * The route's error response body type, as a TS type-source string. Discovered
+     * from a `defineContract({ error })` zod schema, or an `@ApiResponse({ status,
+     * type })` decorator whose `status` is a 4xx/5xx code. Absent/null means the
+     * error body is untyped and resolves to `unknown` in `Route.Error<K>` (never
+     * `never` — an HTTP error always carries some body).
+     */
+    error?: string | null;
     queryRef?: TypeRef | null;
     bodyRef?: TypeRef | null;
     responseRef?: TypeRef | null;
+    /** Importable named ref for the error type (parallel to {@link responseRef}). */
+    errorRef?: TypeRef | null;
     filterFields?: string[] | null;
     filterFieldTypes?: FilterFieldType[] | null;
     filterSource?: 'body' | 'query' | null;
@@ -372,6 +437,23 @@ interface ContractSource {
     bodySchema?: SchemaModule | null;
     /** Neutral validation IR for the query (class-validator DTO only). */
     querySchema?: SchemaModule | null;
+    /**
+     * Neutral validation IR for the success RESPONSE body, when it can be derived
+     * from a class-validator-decorated response DTO. Consumed by the OpenAPI export
+     * (richer `responses` schemas) and the MSW+faker mock generator (schema-shaped
+     * mock data). Optional/additive: when absent the response degrades to the TS
+     * type string (`response`) and mocks fall back to a permissive shape.
+     */
+    responseSchema?: SchemaModule | null;
+    /**
+     * True when the route is a server-sent-events / streaming endpoint: it carries
+     * a `@Sse()` decorator, or its handler returns `Observable<T>` /
+     * `AsyncIterable<T>` / `AsyncGenerator<T>`. When set, `response` (and
+     * `responseRef`) describe the streamed ELEMENT type `T` (NestJS `MessageEvent<T>`
+     * wrappers are unwrapped to `T`), and the client surfaces the route as an
+     * `AsyncIterable<T>` stream rather than a single awaited value.
+     */
+    stream?: boolean;
 }
 interface ContractDescriptor {
     contractSource: ContractSource;