mutano 3.0.1 → 3.0.3

package/README.md

@@ -2,7 +2,8 @@
 
 Convert database schemas to TypeScript types, Zod schemas, or Kysely definitions.
 
-**Supports:** MySQL, PostgreSQL, SQLite, Prisma • **Features:** Views, Magic Comments, Type Overrides, Multiple Outputs
+- **Supports:** MySQL, PostgreSQL, SQLite, Prisma 
+- **Features:** Views, Magic Comments, Type Overrides, Multiple Outputs
 
 ## Installation
 
@@ -51,15 +52,6 @@ await generate({
 })
 ```
 
-## Database Support
-
-| Database | Connection | Views | Magic Comments |
-|----------|------------|-------|----------------|
-| **MySQL** | Host/Port | ✅ | ✅ |
-| **PostgreSQL** | Host/Port | ✅ | ✅ |
-| **SQLite** | File Path | ✅ | ❌ |
-| **Prisma** | Schema File | ✅ | ❌ |
-
 ## Output Examples
 
 **Zod Schema:**
@@ -177,11 +169,11 @@ export type UserUpdate = Updateable<UserTable>;
 | `includeViews` | Process database views |
 | `camelCase` | Convert to camelCase |
 | `dryRun` | Return content without writing files |
-| `magicComments` | Enable @zod/@ts/@kysely comments |
+| `magicComments` | Enable @zod/@ts/@kysely comments (Obs.: no SQLite support) |
 
 ## Magic Comments
 
-Override types for specific columns using database comments (MySQL/PostgreSQL only):
+Override types for specific columns using database comments:
 
 ```sql
 CREATE TABLE `user` (

package/dist/main.d.ts

@@ -1,58 +1,41 @@
-export declare const extractTypeExpression: (comment: string, prefix: string) => string;
-export declare const extractTSExpression: (comment: string) => string;
-export declare const extractKyselyExpression: (comment: string) => string;
-export declare const extractZodExpression: (comment: string) => string;
-export declare function getType(op: 'table' | 'insertable' | 'updateable' | 'selectable', desc: Desc, config: Config, destination: Destination, tableName?: string): string;
-export interface GenerateContentParams {
-    table: string;
-    describes: Desc[];
-    config: Config;
-    destination: Destination;
-    isCamelCase: boolean;
-    enumDeclarations: Record<string, string[]>;
-    defaultZodHeader: (version: 3 | 4) => string;
-}
-export declare function generateContent({ table, describes, config, destination, isCamelCase, enumDeclarations, defaultZodHeader, }: GenerateContentParams): string;
-export declare const defaultKyselyHeader = "import { ColumnType, Selectable, Insertable, Updateable } from 'kysely';\n\n";
-export declare const defaultZodHeader: (version: 3 | 4) => string;
-export declare function generate(config: Config): Promise<Record<string, string>>;
-type MySQLValidTypes = 'date' | 'datetime' | 'timestamp' | 'time' | 'year' | 'char' | 'varchar' | 'tinytext' | 'text' | 'mediumtext' | 'longtext' | 'json' | 'decimal' | 'tinyint' | 'smallint' | 'mediumint' | 'int' | 'bigint' | 'float' | 'double' | 'enum';
-type PostgresValidTypes = 'date' | 'timestamp' | 'timestamptz' | 'timestamp without time zone' | 'timestamp with time zone' | 'time' | 'timetz' | 'interval' | 'character' | 'varchar' | 'character varying' | 'text' | 'json' | 'jsonb' | 'uuid' | 'name' | 'citext' | 'numeric' | 'decimal' | 'smallint' | 'integer' | 'bigint' | 'real' | 'double precision' | 'serial' | 'bigserial' | 'boolean' | 'bool' | 'USER-DEFINED';
-type SQLiteValidTypes = 'datetime' | 'text' | 'character' | 'varchar' | 'varying character' | 'nchar' | 'native character' | 'nvarchar' | 'clob' | 'json' | 'int' | 'integer' | 'tinyint' | 'smallint' | 'mediumint' | 'bigint' | 'unsigned big int' | 'int2' | 'int8' | 'real' | 'double' | 'double precision' | 'float' | 'numeric' | 'decimal' | 'boolean';
-type PrismaValidTypes = 'DateTime' | 'String' | 'Decimal' | 'BigInt' | 'Bytes' | 'Json' | 'Int' | 'Float' | 'Boolean' | 'Enum';
-export interface Desc {
+/**
+ * Core types and interfaces for Mutano
+ */
+interface Desc {
     Field: string;
     Default: string | null;
-    EnumOptions?: string[];
     Extra: string;
+    Null: string;
     Type: string;
-    Null: 'YES' | 'NO';
     Comment: string;
+    EnumOptions?: string[];
 }
-export type Destination = {
+type Destination = {
     type: 'zod';
-    version?: 3 | 4;
-    header?: string;
     useDateType?: boolean;
     useTrim?: boolean;
     nullish?: boolean;
     requiredString?: boolean;
+    version?: 3 | 4;
+    header?: string;
     folder?: string;
     suffix?: string;
 } | {
     type: 'ts';
-    header?: string;
-    enumType?: 'enum' | 'union';
+    enumType?: 'union' | 'enum';
     modelType?: 'interface' | 'type';
+    header?: string;
     folder?: string;
     suffix?: string;
 } | {
     type: 'kysely';
-    header?: string;
     schemaName?: string;
+    header?: string;
+    folder?: string;
+    suffix?: string;
     outFile?: string;
 };
-export interface Config {
+interface Config {
     origin: {
         type: 'prisma';
         path: string;
@@ -91,10 +74,97 @@ export interface Config {
     };
     destinations: Destination[];
     tables?: string[];
+    views?: string[];
     ignore?: string[];
+    ignoreViews?: string[];
     camelCase?: boolean;
     silent?: boolean;
     dryRun?: boolean;
     magicComments?: boolean;
+    includeViews?: boolean;
+}
+interface GenerateContentParams {
+    table: string;
+    describes: Desc[];
+    config: Config;
+    destination: Destination;
+    isCamelCase: boolean;
+    enumDeclarations: Record<string, string[]>;
+    defaultZodHeader: (version: 3 | 4) => string;
+}
+interface GenerateViewContentParams {
+    view: string;
+    describes: Desc[];
+    config: Config;
+    destination: Destination;
+    isCamelCase: boolean;
+    enumDeclarations: Record<string, string[]>;
+    defaultZodHeader: (version: 3 | 4) => string;
 }
-export {};
+type MySQLValidTypes = 'tinyint' | 'smallint' | 'mediumint' | 'int' | 'bigint' | 'decimal' | 'float' | 'double' | 'bit' | 'char' | 'varchar' | 'binary' | 'varbinary' | 'tinyblob' | 'blob' | 'mediumblob' | 'longblob' | 'tinytext' | 'text' | 'mediumtext' | 'longtext' | 'enum' | 'set' | 'date' | 'time' | 'datetime' | 'timestamp' | 'year' | 'json';
+type PostgresValidTypes = 'smallint' | 'integer' | 'bigint' | 'decimal' | 'numeric' | 'real' | 'double precision' | 'smallserial' | 'serial' | 'bigserial' | 'money' | 'character varying' | 'varchar' | 'character' | 'char' | 'text' | 'bytea' | 'timestamp' | 'timestamp with time zone' | 'timestamp without time zone' | 'date' | 'time' | 'time with time zone' | 'time without time zone' | 'interval' | 'boolean' | 'enum' | 'point' | 'line' | 'lseg' | 'box' | 'path' | 'polygon' | 'circle' | 'cidr' | 'inet' | 'macaddr' | 'bit' | 'bit varying' | 'uuid' | 'xml' | 'json' | 'jsonb' | 'int4range' | 'int8range' | 'numrange' | 'tsrange' | 'tstzrange' | 'daterange' | 'name' | 'citext';
+type SQLiteValidTypes = 'integer' | 'real' | 'text' | 'blob' | 'numeric' | 'boolean' | 'date' | 'datetime' | 'character' | 'varchar' | 'varying character' | 'nchar' | 'native character' | 'nvarchar' | 'clob' | 'double' | 'double precision' | 'float' | 'int' | 'int2' | 'int8' | 'bigint' | 'unsigned big int' | 'mediumint' | 'tinyint' | 'smallint' | 'decimal' | 'json';
+type PrismaValidTypes = 'String' | 'Boolean' | 'Int' | 'BigInt' | 'Float' | 'Decimal' | 'DateTime' | 'Json' | 'Bytes' | 'Unsupported';
+
+/**
+ * Constants and default headers for code generation
+ */
+declare const defaultKyselyHeader = "import { Generated, Insertable, Selectable, Updateable, ColumnType } from 'kysely';\n\n";
+declare const defaultZodHeader: (version: 3 | 4) => string;
+
+/**
+ * Utilities for parsing magic comments (@zod, @ts, @kysely)
+ */
+/**
+ * Extract type expression from a comment with a given prefix
+ * Handles nested parentheses, brackets, and braces
+ */
+declare const extractTypeExpression: (comment: string, prefix: string) => string | null;
+/**
+ * Extract TypeScript type expression from @ts() comment
+ */
+declare const extractTSExpression: (comment: string) => string | null;
+/**
+ * Extract Kysely type expression from @kysely() comment
+ */
+declare const extractKyselyExpression: (comment: string) => string | null;
+/**
+ * Extract Zod type expression from @zod() comment
+ */
+declare const extractZodExpression: (comment: string) => string | null;
+
+/**
+ * Content generation for tables and views
+ */
+
+/**
+ * Generate content for database views (read-only)
+ */
+declare function generateViewContent({ view, describes, config, destination, isCamelCase, enumDeclarations: _enumDeclarations, defaultZodHeader, }: GenerateViewContentParams): string;
+/**
+ * Generate content for database tables
+ */
+declare function generateContent({ table, describes, config, destination, isCamelCase, enumDeclarations: _enumDeclarations, defaultZodHeader, }: GenerateContentParams): string;
+
+/**
+ * Core type generation logic
+ */
+
+type OperationType = 'table' | 'insertable' | 'updateable' | 'selectable';
+/**
+ * Generate the appropriate type for a database field
+ */
+declare function getType(op: OperationType, desc: Desc, config: Config, destination: Destination): string;
+
+/**
+ * Mutano - Database schema to TypeScript/Zod/Kysely converter
+ * Refactored for better maintainability and modularity
+ */
+
+/**
+ * Main generate function - orchestrates the entire schema generation process
+ */
+declare function generate(config: Config): Promise<Record<string, string>>;
+
+export { defaultKyselyHeader, defaultZodHeader, extractKyselyExpression, extractTSExpression, extractTypeExpression, extractZodExpression, generate, generateContent, generateViewContent, getType };
+export type { Config, Desc, Destination };