@happyvertical/smrt-core 0.30.0

package/dist/schema/generator.d.ts

@@ -0,0 +1,176 @@
+import { FieldDefinition, ManifestSchema, SmartObjectDefinition, SmartObjectManifest } from '../scanner/types.js';
+import { DatabaseEngine } from './ddl/types.js';
+import { SchemaDefinition } from './types.js';
+type SchemaGeneratorConfig = {
+    conflictColumns?: string[];
+    idType?: 'uuid' | 'text';
+    registry?: {
+        getConfig?(className: string): {
+            idType?: 'uuid' | 'text';
+        };
+        getDescendants(baseClassName: string): string[];
+        getAllFields(className: string): Promise<Map<string, any>>;
+        getSTIBase?(className: string): string | null;
+    };
+};
+export declare class SchemaGenerator {
+    /**
+     * Generate schema definition from SMRT object definition
+     */
+    generateSchema(objectDef: SmartObjectDefinition): SchemaDefinition;
+    /**
+     * Convert field type to SQL data type
+     */
+    private mapFieldTypeToSQL;
+    private getIdColumnType;
+    private getRelationshipColumnType;
+    private getReferenceKind;
+    private shouldEmitDefault;
+    private getRegistryTargetIdColumnType;
+    private reconcileRegistryForeignKeyColumnTypes;
+    /**
+     * Generate column definitions
+     */
+    private generateColumns;
+    /**
+     * Generate index definitions
+     */
+    private generateIndexes;
+    /**
+     * Generate trigger definitions for automatic timestamp updates
+     */
+    private generateTriggers;
+    /**
+     * Extract foreign key definitions
+     */
+    private extractForeignKeys;
+    /**
+     * Extract schema dependencies from foreign keys and inheritance
+     */
+    private extractDependencies;
+    /**
+     * Generate version hash for schema
+     */
+    private generateVersion;
+    /**
+     * Get table name from object definition
+     */
+    private getTableName;
+    /**
+     * Convert class name to table name (camelCase to snake_case, pluralized)
+     */
+    private classNameToTableName;
+    /**
+     * Extract package name from file path
+     */
+    private extractPackageName;
+    /**
+     * Generate schema definition from ObjectRegistry fields (runtime)
+     *
+     * This method builds a SchemaDefinition from ObjectRegistry cached fields,
+     * enabling schema generation from decorated classes at runtime.
+     *
+     * @param className - Class name to look up in ObjectRegistry
+     * @param tableName - Table name (from SMRT_TABLE_NAME or derived)
+     * @param fields - Map of Field definitions from ObjectRegistry
+     * @returns Schema definition object
+     */
+    generateSchemaFromRegistry(className: string, tableName: string, fields: Map<string, any>, config?: SchemaGeneratorConfig): SchemaDefinition;
+    /**
+     * Generate STI (Single Table Inheritance) schema from ObjectRegistry fields
+     *
+     * Creates a shared table for an inheritance hierarchy with:
+     * - _meta_type: Discriminator column to identify class type
+     * - _meta_data: JSON column for flexible field storage
+     * - Union of all FK columns from descendants (all nullable)
+     * - Partial indexes for FK columns (filtered by _meta_type)
+     *
+     * @param baseClassName - Base class name for the STI hierarchy
+     * @param tableName - Shared table name (from base class)
+     * @param fields - Map of Field definitions from base class
+     * @returns Schema definition object for STI table
+     * @example
+     * ```typescript
+     * @smrt({ tableStrategy: 'sti' })
+     * class Event extends SmrtObject {
+     *   title: string = '';
+     * }
+     *
+     * @smrt()
+     * class Meeting extends Event {
+     *   roomId = foreignKey(Room);
+     * }
+     *
+     * // Generates single table 'events' with:
+     * // - title (from Event)
+     * // - room_id (from Meeting, nullable)
+     * // - _meta_type TEXT NOT NULL (discriminator)
+     * // - _meta_data JSON (flexible storage)
+     * ```
+     */
+    generateSTISchemaFromRegistry(baseClassName: string, tableName: string, _fields: Map<string, any>, config?: SchemaGeneratorConfig): Promise<SchemaDefinition>;
+    /**
+     * Generate STI schema from manifest data (build-time, no runtime registry)
+     *
+     * This method generates STI schema purely from manifest data, without depending
+     * on ObjectRegistry. This enables pre-generating schemas at build time for
+     * efficient external package consumption.
+     *
+     * @param baseClassName - Base class name for the STI hierarchy
+     * @param tableName - Shared table name (from base class)
+     * @param baseFields - Fields from the base class
+     * @param manifest - Full manifest containing all objects
+     * @returns ManifestSchema for storage in manifest.json
+     */
+    generateSTISchemaFromManifest(baseClassName: string, tableName: string, _baseFields: Record<string, FieldDefinition>, manifest: SmartObjectManifest, config?: SchemaGeneratorConfig): ManifestSchema;
+    /**
+     * Generate CTI (Class Table Inheritance) schema from manifest data
+     *
+     * @param className - Class name
+     * @param tableName - Table name
+     * @param fields - Fields from the class
+     * @returns ManifestSchema for storage in manifest.json
+     */
+    generateCTISchemaFromManifest(className: string, tableName: string, fields: Record<string, FieldDefinition>, config?: SchemaGeneratorConfig): ManifestSchema;
+    /**
+     * Find all descendants of a class in the manifest
+     *
+     * Note: Manifest keys are now qualified names (@pkg:ClassName) but `extends` field
+     * stores simple PascalCase class names. We need to handle both qualified and simple
+     * name lookups.
+     *
+     * Issue #713: Updated to handle qualified names in manifest keys
+     */
+    private findDescendantsInManifest;
+    /**
+     * Convert ManifestColumnDefinition to ColumnDefinition
+     */
+    private convertManifestColumnsToSchemaColumns;
+    /**
+     * Convert camelCase to snake_case
+     */
+    private toSnakeCase;
+    /**
+     * Generate SQL CREATE TABLE statement from schema definition
+     *
+     * This is the single source of truth for SQL generation, consolidating
+     * logic that was previously duplicated across multiple code paths.
+     *
+     * @param schema - Schema definition object
+     * @returns SQL CREATE TABLE statement with indexes
+     */
+    generateSQL(schema: SchemaDefinition, engine?: DatabaseEngine): string;
+    /**
+     * Format default value for SQL
+     *
+     * SQLite doesn't support CAST expressions in DEFAULT values (only literal values are allowed).
+     * This method generates DEFAULT values that work with both SQLite and DuckDB.
+     *
+     * @param value - Default value
+     * @param type - Column SQL type
+     * @returns Formatted SQL default value expression
+     */
+    private formatDefaultValue;
+}
+export {};
+//# sourceMappingURL=generator.d.ts.map

package/dist/schema/generator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generator.d.ts","sourceRoot":"","sources":["../../src/schema/generator.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EACV,eAAe,EAGf,cAAc,EACd,qBAAqB,EACrB,mBAAmB,EACpB,MAAM,qBAAqB,CAAC;AAG7B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAMrD,OAAO,KAAK,EAIV,gBAAgB,EAGjB,MAAM,YAAY,CAAC;AAEpB,KAAK,qBAAqB,GAAG;IAC3B,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACzB,QAAQ,CAAC,EAAE;QACT,SAAS,CAAC,CAAC,SAAS,EAAE,MAAM,GAAG;YAAE,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAC5D,cAAc,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QAChD,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;QAC3D,UAAU,CAAC,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;KAC/C,CAAC;CACH,CAAC;AAEF,qBAAa,eAAe;IAC1B;;OAEG;IACH,cAAc,CAAC,SAAS,EAAE,qBAAqB,GAAG,gBAAgB;IAyBlE;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAuBzB,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,yBAAyB;IAejC,OAAO,CAAC,gBAAgB;IAqBxB,OAAO,CAAC,iBAAiB;IAQzB,OAAO,CAAC,6BAA6B;IA4BrC,OAAO,CAAC,sCAAsC;IAgC9C;;OAEG;IACH,OAAO,CAAC,eAAe;IAyGvB;;OAEG;IACH,OAAO,CAAC,eAAe;IAwCvB;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAexB;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAoB1B;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAuB3B;;OAEG;IACH,OAAO,CAAC,eAAe;IASvB;;OAEG;IACH,OAAO,CAAC,YAAY;IAIpB;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAI5B;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAK1B;;;;;;;;;;OAUG;IACH,0BAA0B,CACxB,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,EACxB,MAAM,CAAC,EAAE,qBAAqB,GAC7B,gBAAgB;IA8PnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,6BAA6B,CACjC,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,EACzB,MAAM,CAAC,EAAE,qBAAqB,GAC7B,OAAO,CAAC,gBAAgB,CAAC;IAsR5B;;;;;;;;;;;;OAYG;IACH,6BAA6B,CAC3B,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,EAC5C,QAAQ,EAAE,mBAAmB,EAC7B,MAAM,CAAC,EAAE,qBAAqB,GAC7B,cAAc;IA2NjB;;;;;;;OAOG;IACH,6BAA6B,CAC3B,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,EACvC,MAAM,CAAC,EAAE,qBAAqB,GAC7B,cAAc;IA6IjB;;;;;;;;OAQG;IACH,OAAO,CAAC,yBAAyB;IAyCjC;;OAEG;IACH,OAAO,CAAC,qCAAqC;IAmB7C;;OAEG;IACH,OAAO,CAAC,WAAW;IAOnB;;;;;;;;OAQG;IACH,WAAW,CAAC,MAAM,EAAE,gBAAgB,EAAE,MAAM,CAAC,EAAE,cAAc,GAAG,MAAM;IA0CtE;;;;;;;;;OASG;IACH,OAAO,CAAC,kBAAkB;CAW3B"}