@dudousxd/nestjs-codegen 0.28.0 → 0.29.1

package/dist/index.d.cts

@@ -378,18 +378,29 @@ declare const DEFAULT_SANDBOX_KIT_OUTPUT = ".genui/sandbox-kit.json";
 interface WriteSandboxKitDocsOptions {
     root: string;
     output: string;
-    entry?: string;
-    include?: string | readonly string[];
-    css?: string | readonly string[];
+    components?: string | readonly string[];
+    styles?: string | readonly string[];
+    wrapper?: string;
+    stylesDocs?: string;
     tsconfig?: string;
 }
+/** The same options as the agent's Vite plugin (`@dudousxd/nestjs-agent/vite`). */
 interface GenuiSandboxKitOptions {
-    /** A module whose exports are the kit (e.g. `src/genui/kit.ts`). */
-    entry?: string;
-    /** A glob (or several) whose files' exports are the kit (e.g. `web/components/ui/*.tsx`). */
-    include?: string | readonly string[];
-    /** Stylesheet glob(s) whose custom properties become the sandbox theme. */
-    css?: string | readonly string[];
+    /**
+     * Modules whose exports are the kit's React components: files, globs, directories or packages
+     * (`web/components/ui`, `src/genui/kit.ts`, `@mui/material`). Default: the first shadcn
+     * `components/ui` dir found.
+     */
+    components?: string | readonly string[];
+    /**
+     * The app's style entry files (plain CSS, Sass, a Tailwind stylesheet…): what the model is told
+     * about the styles (Tailwind tokens, or the CSS class vocabulary) and the theme's variables.
+     */
+    styles?: string | readonly string[];
+    /** A module whose default export wraps the model's App (theme providers). */
+    wrapper?: string;
+    /** Guidance on the styles for the model: a markdown file, or the text itself. */
+    stylesDocs?: string;
     /** The tsconfig the component prop types are read through. */
     tsconfig?: string;
     /**
@@ -408,15 +419,17 @@ interface GenuiSandboxKitOptions {
 }
 /**
  * Writes the generative-UI **sandbox kit docs** — the app's design-system components (shadcn
- * `components/ui` by default) with the props read from their TypeScript types — to
+ * `components/ui` by default) with the props read from their TypeScript types, and what its
+ * `styles` are (Tailwind tokens, or a CSS class vocabulary, and the theme's variables) — to
  * `.genui/sandbox-kit.json`, where the `@dudousxd/nestjs-agent` server reads them.
  *
  * Runs on every generate pass (one-shot CLI, `--watch`, and the Nest module's watcher). The
  * descriptor lives outside `outDir`, so it is written by the generator itself, not through
- * `emitFiles`; the kit files, stylesheets and the descriptor are tracked as inputs, so editing
- * a component regenerates in watch mode and a deleted descriptor is rewritten.
+ * `emitFiles`; the kit files, the stylesheets (and what they import) and the descriptor are
+ * tracked as inputs, so editing a component or a stylesheet regenerates in watch mode and a
+ * deleted descriptor is rewritten.
  *
- * Needs the optional peer `@dudousxd/nestjs-agent-core` (>=0.52.0) unless `generate` is given.
+ * Needs the optional peer `@dudousxd/nestjs-agent-core` (>=0.53.0) unless `generate` is given.
  */
 declare function genuiSandboxKit(options?: GenuiSandboxKitOptions): CodegenExtension;
 
@@ -435,6 +448,6 @@ interface FastDiscoveryOptions {
 }
 declare function discoverContractsFast(opts: FastDiscoveryOptions): Promise<RouteDescriptor[]>;
 
-declare const VERSION = "0.28.0";
+declare const VERSION = "0.29.1";
 
 export { type ChainModuleRendererOptions, CodegenError, type CodegenManifest, ConfigError, DEFAULT_SANDBOX_KIT_OUTPUT, DriftGuardError, type EntryPoint, type FastDiscoveryOptions, type GenuiSandboxKitOptions, type JsonSchema, type MocksEmitOptions, type OpenApiDocument, type OpenApiEmitOptions, type OpenApiInfo, RenderContext, RenderedModule, ResolvedConfig, RouteDescriptor, SchemaModule, SchemaNode, type TsTypeContext, UserConfig, VERSION, ValidationAdapter, type WatchOptions, type Watcher, type WriteSandboxKitDocsOptions, acquireLock, buildMocksFile, buildOpenApiSpec, createChainModuleRenderer, defineConfig, discoverContractsFast, emitApi, emitForms, emitMocks, emitOpenApi, emitRoutes, extractSchemaFromDto, generate, genuiSandboxKit, loadConfig, renderTsType, resolveConfig, schemaModuleToJsonSchema, schemaNodeToJsonSchema, toObjectKey, typeNameFor, watch };

package/dist/index.d.ts

@@ -378,18 +378,29 @@ declare const DEFAULT_SANDBOX_KIT_OUTPUT = ".genui/sandbox-kit.json";
 interface WriteSandboxKitDocsOptions {
     root: string;
     output: string;
-    entry?: string;
-    include?: string | readonly string[];
-    css?: string | readonly string[];
+    components?: string | readonly string[];
+    styles?: string | readonly string[];
+    wrapper?: string;
+    stylesDocs?: string;
     tsconfig?: string;
 }
+/** The same options as the agent's Vite plugin (`@dudousxd/nestjs-agent/vite`). */
 interface GenuiSandboxKitOptions {
-    /** A module whose exports are the kit (e.g. `src/genui/kit.ts`). */
-    entry?: string;
-    /** A glob (or several) whose files' exports are the kit (e.g. `web/components/ui/*.tsx`). */
-    include?: string | readonly string[];
-    /** Stylesheet glob(s) whose custom properties become the sandbox theme. */
-    css?: string | readonly string[];
+    /**
+     * Modules whose exports are the kit's React components: files, globs, directories or packages
+     * (`web/components/ui`, `src/genui/kit.ts`, `@mui/material`). Default: the first shadcn
+     * `components/ui` dir found.
+     */
+    components?: string | readonly string[];
+    /**
+     * The app's style entry files (plain CSS, Sass, a Tailwind stylesheet…): what the model is told
+     * about the styles (Tailwind tokens, or the CSS class vocabulary) and the theme's variables.
+     */
+    styles?: string | readonly string[];
+    /** A module whose default export wraps the model's App (theme providers). */
+    wrapper?: string;
+    /** Guidance on the styles for the model: a markdown file, or the text itself. */
+    stylesDocs?: string;
     /** The tsconfig the component prop types are read through. */
     tsconfig?: string;
     /**
@@ -408,15 +419,17 @@ interface GenuiSandboxKitOptions {
 }
 /**
  * Writes the generative-UI **sandbox kit docs** — the app's design-system components (shadcn
- * `components/ui` by default) with the props read from their TypeScript types — to
+ * `components/ui` by default) with the props read from their TypeScript types, and what its
+ * `styles` are (Tailwind tokens, or a CSS class vocabulary, and the theme's variables) — to
  * `.genui/sandbox-kit.json`, where the `@dudousxd/nestjs-agent` server reads them.
  *
  * Runs on every generate pass (one-shot CLI, `--watch`, and the Nest module's watcher). The
  * descriptor lives outside `outDir`, so it is written by the generator itself, not through
- * `emitFiles`; the kit files, stylesheets and the descriptor are tracked as inputs, so editing
- * a component regenerates in watch mode and a deleted descriptor is rewritten.
+ * `emitFiles`; the kit files, the stylesheets (and what they import) and the descriptor are
+ * tracked as inputs, so editing a component or a stylesheet regenerates in watch mode and a
+ * deleted descriptor is rewritten.
  *
- * Needs the optional peer `@dudousxd/nestjs-agent-core` (>=0.52.0) unless `generate` is given.
+ * Needs the optional peer `@dudousxd/nestjs-agent-core` (>=0.53.0) unless `generate` is given.
  */
 declare function genuiSandboxKit(options?: GenuiSandboxKitOptions): CodegenExtension;
 
@@ -435,6 +448,6 @@ interface FastDiscoveryOptions {
 }
 declare function discoverContractsFast(opts: FastDiscoveryOptions): Promise<RouteDescriptor[]>;
 
-declare const VERSION = "0.28.0";
+declare const VERSION = "0.29.1";
 
 export { type ChainModuleRendererOptions, CodegenError, type CodegenManifest, ConfigError, DEFAULT_SANDBOX_KIT_OUTPUT, DriftGuardError, type EntryPoint, type FastDiscoveryOptions, type GenuiSandboxKitOptions, type JsonSchema, type MocksEmitOptions, type OpenApiDocument, type OpenApiEmitOptions, type OpenApiInfo, RenderContext, RenderedModule, ResolvedConfig, RouteDescriptor, SchemaModule, SchemaNode, type TsTypeContext, UserConfig, VERSION, ValidationAdapter, type WatchOptions, type Watcher, type WriteSandboxKitDocsOptions, acquireLock, buildMocksFile, buildOpenApiSpec, createChainModuleRenderer, defineConfig, discoverContractsFast, emitApi, emitForms, emitMocks, emitOpenApi, emitRoutes, extractSchemaFromDto, generate, genuiSandboxKit, loadConfig, renderTsType, resolveConfig, schemaModuleToJsonSchema, schemaNodeToJsonSchema, toObjectKey, typeNameFor, watch };