@dudousxd/nestjs-codegen 0.2.0

package/dist/index.d.cts

@@ -0,0 +1,128 @@
+import { U as UserConfig, R as ResolvedConfig, a as RouteDescriptor, V as ValidationAdapter, S as SchemaModule, b as ResolvedFormsConfig, C as CodegenExtension, E as ExtensionContext } from './index-BwIRjOQA.cjs';
+export { A as AdapterUsage, c as ContractDescriptor, d as ContractSource, e as ControllerRef, N as NumberCheck, f as RenderContext, g as RenderedModule, h as SchemaNode, i as ScopeConfig, j as StringCheck, T as TypeRef, k as ValidationOption, r as resolveAdapter } from './index-BwIRjOQA.cjs';
+import { ClassDeclaration, SourceFile, Project } from 'ts-morph';
+
+declare function defineConfig(c: UserConfig): UserConfig;
+
+/**
+ * Resolve a {@link UserConfig} (e.g. `NestjsCodegenModule.forRoot()` options) into a
+ * fully-defaulted {@link ResolvedConfig} — without reading a config file. Used by the
+ * Nest module and any programmatic caller that already holds the config in memory.
+ *
+ * @param userConfig the raw user config (forRoot options minus module-only fields)
+ * @param cwd project root used to resolve globs / outDir. Defaults to `process.cwd()`.
+ */
+declare function resolveConfig(userConfig: UserConfig, cwd?: string): ResolvedConfig;
+declare function loadConfig(cwd?: string): Promise<ResolvedConfig>;
+
+declare class ConfigError extends Error {
+    constructor(message: string, options?: ErrorOptions);
+}
+declare class CodegenError extends Error {
+    constructor(message: string, options?: ErrorOptions);
+}
+
+/**
+ * Run one full codegen pass: discover pages, emit pages.d.ts, components.json, index.d.ts.
+ * Route discovery is deliberately skipped — it requires spawning a Nest app and is
+ * not appropriate for the hot path of a file watcher.
+ *
+ * Optionally accepts pre-discovered routes (e.g. from a full generate + route-discovery pass).
+ * When routes are present, emits routes.ts.
+ * When routes with contracts are present, also emits api.ts.
+ */
+declare function generate(config: ResolvedConfig, inputRoutes?: RouteDescriptor[]): Promise<void>;
+
+interface Watcher {
+    close(): Promise<void>;
+}
+/**
+ * Start two chokidar watchers:
+ *
+ * 1. **Pages watcher** (`config.pages.glob`, 150 ms debounce) — runs `generate(config)` on
+ *    any page file change, regenerating `pages.d.ts` and the cache manifest.
+ *
+ * 2. **Contracts watcher** (`config.contracts.glob`, configurable debounce — default 500 ms) —
+ *    re-runs static AST route discovery via ts-morph, then re-emits `routes.ts` and (when
+ *    contracts are present) `api.ts` + `index.d.ts`.
+ *
+ * Both watchers share a single lock file in `config.codegen.outDir`. If another live process
+ * already holds the lock, logs a warning and returns a no-op watcher.
+ */
+declare function watch(config: ResolvedConfig, onChange?: () => void): Promise<Watcher>;
+
+/**
+ * Try to acquire an exclusive lock for a watcher in `outDir`.
+ *
+ * Uses O_CREAT | O_EXCL (via 'wx' flag) for atomic file creation to prevent
+ * TOCTOU race conditions between concurrent processes.
+ *
+ * Returns `{ release }` on success.
+ * Returns `null` if another live process already holds the lock.
+ */
+declare function acquireLock(outDir: string): Promise<{
+    release: () => Promise<void>;
+} | null>;
+
+declare const zodAdapter: ValidationAdapter;
+
+/**
+ * Pure-AST translation of class-validator-decorated DTO classes into the neutral
+ * {@link SchemaModule} IR. Reads decorator names + literal args via ts-morph — it
+ * never imports class-validator at runtime. A `ValidationAdapter` renders the IR.
+ *
+ * This is the structural successor of `dto-to-zod.ts`: same control flow,
+ * recursion guard, and warnings, but it emits `SchemaNode` values instead of zod
+ * text. The zod adapter reproduces the previous output byte-for-byte.
+ */
+
+declare function extractSchemaFromDto(classDecl: ClassDeclaration, sourceFile: SourceFile, project: Project): SchemaModule;
+
+/**
+ * Emits `forms.ts` into `outDir` — re-exported (Path A) or inlined/synthesized
+ * (Path A inline / Path B) zod schemas per validatable route, plus a
+ * `formSchemas` name→schema map.
+ *
+ * Returns `true` when a `forms.ts` was written (drives the index export).
+ */
+declare function emitForms(routes: RouteDescriptor[], outDir: string, config?: ResolvedFormsConfig, adapter?: ValidationAdapter): Promise<boolean>;
+
+/**
+ * Emits `api.ts` into `outDir` for all routes that carry a `.contract`.
+ *
+ * By default each leaf is a bare typed-fetch callable. Registered extensions shape the
+ * output: an `apiClientLayer` (e.g. `@dudousxd/nestjs-codegen-tanstack`) turns leaves into
+ * handles; an `apiTransport` changes how requests are issued; `apiMembers` add handle
+ * members; `apiHeader` contributes top-level imports/statements.
+ */
+interface ApiEmitOptions {
+    fetcherImportPath?: string;
+    /** Registered extensions. Their api.ts hooks (transport/layer/members/header) are applied. */
+    extensions?: CodegenExtension[];
+    /** Shared extension context (from `generate()`). When omitted, a minimal one is built from routes. */
+    ctx?: ExtensionContext;
+}
+declare function emitApi(routes: RouteDescriptor[], outDir: string, opts?: ApiEmitOptions): Promise<void>;
+
+/**
+ * Emits `routes.ts` into `outDir` with:
+ * - A `ROUTES` constant mapping name → path
+ * - A `RouteName` union type of all route names
+ * - A `RouteParams<K>` mapped type using template-literal `infer` to extract `:param` segments
+ * - A runtime `route(name, params?)` helper that interpolates path params
+ */
+declare function emitRoutes(routes: RouteDescriptor[], outDir: string): Promise<void>;
+
+interface FastDiscoveryOptions {
+    /** Absolute path to the project root. */
+    cwd: string;
+    /** Controllers glob, e.g. 'src/**\/*.controller.ts' */
+    glob: string;
+    /** Optional tsconfig.json path; default 'tsconfig.json' in cwd */
+    tsconfig?: string;
+}
+declare function discoverContractsFast(opts: FastDiscoveryOptions): Promise<RouteDescriptor[]>;
+
+declare const VERSION = "0.2.0";
+
+export { CodegenError, ConfigError, type FastDiscoveryOptions, ResolvedConfig, RouteDescriptor, SchemaModule, UserConfig, VERSION, ValidationAdapter, type Watcher, acquireLock, defineConfig, discoverContractsFast, emitApi, emitForms, emitRoutes, extractSchemaFromDto, generate, loadConfig, resolveConfig, watch, zodAdapter };

package/dist/index.d.ts

@@ -0,0 +1,128 @@
+import { U as UserConfig, R as ResolvedConfig, a as RouteDescriptor, V as ValidationAdapter, S as SchemaModule, b as ResolvedFormsConfig, C as CodegenExtension, E as ExtensionContext } from './index-BwIRjOQA.js';
+export { A as AdapterUsage, c as ContractDescriptor, d as ContractSource, e as ControllerRef, N as NumberCheck, f as RenderContext, g as RenderedModule, h as SchemaNode, i as ScopeConfig, j as StringCheck, T as TypeRef, k as ValidationOption, r as resolveAdapter } from './index-BwIRjOQA.js';
+import { ClassDeclaration, SourceFile, Project } from 'ts-morph';
+
+declare function defineConfig(c: UserConfig): UserConfig;
+
+/**
+ * Resolve a {@link UserConfig} (e.g. `NestjsCodegenModule.forRoot()` options) into a
+ * fully-defaulted {@link ResolvedConfig} — without reading a config file. Used by the
+ * Nest module and any programmatic caller that already holds the config in memory.
+ *
+ * @param userConfig the raw user config (forRoot options minus module-only fields)
+ * @param cwd project root used to resolve globs / outDir. Defaults to `process.cwd()`.
+ */
+declare function resolveConfig(userConfig: UserConfig, cwd?: string): ResolvedConfig;
+declare function loadConfig(cwd?: string): Promise<ResolvedConfig>;
+
+declare class ConfigError extends Error {
+    constructor(message: string, options?: ErrorOptions);
+}
+declare class CodegenError extends Error {
+    constructor(message: string, options?: ErrorOptions);
+}
+
+/**
+ * Run one full codegen pass: discover pages, emit pages.d.ts, components.json, index.d.ts.
+ * Route discovery is deliberately skipped — it requires spawning a Nest app and is
+ * not appropriate for the hot path of a file watcher.
+ *
+ * Optionally accepts pre-discovered routes (e.g. from a full generate + route-discovery pass).
+ * When routes are present, emits routes.ts.
+ * When routes with contracts are present, also emits api.ts.
+ */
+declare function generate(config: ResolvedConfig, inputRoutes?: RouteDescriptor[]): Promise<void>;
+
+interface Watcher {
+    close(): Promise<void>;
+}
+/**
+ * Start two chokidar watchers:
+ *
+ * 1. **Pages watcher** (`config.pages.glob`, 150 ms debounce) — runs `generate(config)` on
+ *    any page file change, regenerating `pages.d.ts` and the cache manifest.
+ *
+ * 2. **Contracts watcher** (`config.contracts.glob`, configurable debounce — default 500 ms) —
+ *    re-runs static AST route discovery via ts-morph, then re-emits `routes.ts` and (when
+ *    contracts are present) `api.ts` + `index.d.ts`.
+ *
+ * Both watchers share a single lock file in `config.codegen.outDir`. If another live process
+ * already holds the lock, logs a warning and returns a no-op watcher.
+ */
+declare function watch(config: ResolvedConfig, onChange?: () => void): Promise<Watcher>;
+
+/**
+ * Try to acquire an exclusive lock for a watcher in `outDir`.
+ *
+ * Uses O_CREAT | O_EXCL (via 'wx' flag) for atomic file creation to prevent
+ * TOCTOU race conditions between concurrent processes.
+ *
+ * Returns `{ release }` on success.
+ * Returns `null` if another live process already holds the lock.
+ */
+declare function acquireLock(outDir: string): Promise<{
+    release: () => Promise<void>;
+} | null>;
+
+declare const zodAdapter: ValidationAdapter;
+
+/**
+ * Pure-AST translation of class-validator-decorated DTO classes into the neutral
+ * {@link SchemaModule} IR. Reads decorator names + literal args via ts-morph — it
+ * never imports class-validator at runtime. A `ValidationAdapter` renders the IR.
+ *
+ * This is the structural successor of `dto-to-zod.ts`: same control flow,
+ * recursion guard, and warnings, but it emits `SchemaNode` values instead of zod
+ * text. The zod adapter reproduces the previous output byte-for-byte.
+ */
+
+declare function extractSchemaFromDto(classDecl: ClassDeclaration, sourceFile: SourceFile, project: Project): SchemaModule;
+
+/**
+ * Emits `forms.ts` into `outDir` — re-exported (Path A) or inlined/synthesized
+ * (Path A inline / Path B) zod schemas per validatable route, plus a
+ * `formSchemas` name→schema map.
+ *
+ * Returns `true` when a `forms.ts` was written (drives the index export).
+ */
+declare function emitForms(routes: RouteDescriptor[], outDir: string, config?: ResolvedFormsConfig, adapter?: ValidationAdapter): Promise<boolean>;
+
+/**
+ * Emits `api.ts` into `outDir` for all routes that carry a `.contract`.
+ *
+ * By default each leaf is a bare typed-fetch callable. Registered extensions shape the
+ * output: an `apiClientLayer` (e.g. `@dudousxd/nestjs-codegen-tanstack`) turns leaves into
+ * handles; an `apiTransport` changes how requests are issued; `apiMembers` add handle
+ * members; `apiHeader` contributes top-level imports/statements.
+ */
+interface ApiEmitOptions {
+    fetcherImportPath?: string;
+    /** Registered extensions. Their api.ts hooks (transport/layer/members/header) are applied. */
+    extensions?: CodegenExtension[];
+    /** Shared extension context (from `generate()`). When omitted, a minimal one is built from routes. */
+    ctx?: ExtensionContext;
+}
+declare function emitApi(routes: RouteDescriptor[], outDir: string, opts?: ApiEmitOptions): Promise<void>;
+
+/**
+ * Emits `routes.ts` into `outDir` with:
+ * - A `ROUTES` constant mapping name → path
+ * - A `RouteName` union type of all route names
+ * - A `RouteParams<K>` mapped type using template-literal `infer` to extract `:param` segments
+ * - A runtime `route(name, params?)` helper that interpolates path params
+ */
+declare function emitRoutes(routes: RouteDescriptor[], outDir: string): Promise<void>;
+
+interface FastDiscoveryOptions {
+    /** Absolute path to the project root. */
+    cwd: string;
+    /** Controllers glob, e.g. 'src/**\/*.controller.ts' */
+    glob: string;
+    /** Optional tsconfig.json path; default 'tsconfig.json' in cwd */
+    tsconfig?: string;
+}
+declare function discoverContractsFast(opts: FastDiscoveryOptions): Promise<RouteDescriptor[]>;
+
+declare const VERSION = "0.2.0";
+
+export { CodegenError, ConfigError, type FastDiscoveryOptions, ResolvedConfig, RouteDescriptor, SchemaModule, UserConfig, VERSION, ValidationAdapter, type Watcher, acquireLock, defineConfig, discoverContractsFast, emitApi, emitForms, emitRoutes, extractSchemaFromDto, generate, loadConfig, resolveConfig, watch, zodAdapter };