rawsql-ts 0.9.0-beta → 0.10.1-beta

package/dist/utils/SchemaManager.d.ts

@@ -0,0 +1,132 @@
+/**
+ * Schema Manager for rawsql-ts
+ * Provides unified schema definition and automatic conversion to various formats
+ * Eliminates code duplication and provides type-safe schema management
+ */
+import type { JsonMapping } from '../transformers/PostgresJsonQueryBuilder';
+/**
+ * Database column metadata for schema mapping
+ */
+export interface ColumnDefinition {
+    /** Column name in database */
+    name: string;
+    /** Primary key indicator - used for UPDATE/DELETE query WHERE conditions */
+    isPrimaryKey?: boolean;
+    /** Foreign key reference */
+    foreignKey?: {
+        table: string;
+        column: string;
+    };
+    /** Alias for JSON output (useful for avoiding conflicts) */
+    jsonAlias?: string;
+}
+/**
+ * Table relationship definition
+ */
+export interface RelationshipDefinition {
+    /** Type of relationship */
+    type: 'object' | 'array';
+    /** Target table name */
+    table: string;
+    /** Property name in JSON output */
+    propertyName: string;
+    /** Optional: Override target table's primary key */
+    targetKey?: string;
+}
+/**
+ * Complete table schema definition that users write
+ */
+export interface TableDefinition {
+    /** Table name in database */
+    name: string;
+    /** Human-readable entity name */
+    displayName?: string;
+    /** Column definitions */
+    columns: Record<string, ColumnDefinition>;
+    /** Relationships with other tables */
+    relationships?: RelationshipDefinition[];
+}
+/**
+ * Schema registry containing all table definitions
+ */
+export interface SchemaRegistry {
+    [tableName: string]: TableDefinition;
+}
+/**
+ * Central schema management utility for rawsql-ts
+ * Converts user-defined schemas to various internal formats
+ */
+export declare class SchemaManager {
+    private schemas;
+    constructor(schemas: SchemaRegistry);
+    /**
+     * Validate schema definitions for consistency
+     * Ensures each table has a primary key (required for UPDATE/DELETE operations)
+     * and validates relationship references
+     */
+    private validateSchemas;
+    /**
+     * Get table column names for SqlParamInjector TableColumnResolver
+     * @param tableName Name of the table
+     * @returns Array of column names
+     */
+    getTableColumns(tableName: string): string[];
+    /**
+     * Create TableColumnResolver function for SqlParamInjector
+     * @returns Function compatible with SqlParamInjector
+     */
+    createTableColumnResolver(): (tableName: string) => string[];
+    /**
+     * Generate JSON mapping configuration for PostgresJsonQueryBuilder
+     * @param rootTableName Root table for the JSON structure
+     * @returns JSON mapping configuration
+     */
+    createJsonMapping(rootTableName: string): JsonMapping;
+    /**
+     * Get all table names in the schema
+     * @returns Array of table names
+     */
+    getTableNames(): string[];
+    /**
+     * Get table definition by name
+     * @param tableName Name of the table
+     * @returns Table definition or undefined
+     */
+    getTable(tableName: string): TableDefinition | undefined;
+    /**
+     * Get primary key column name for a table
+     * Used by QueryBuilder.buildUpdateQuery for WHERE clause conditions
+     * @param tableName Name of the table
+     * @returns Primary key column name or undefined
+     */
+    getPrimaryKey(tableName: string): string | undefined;
+    /**
+     * Get foreign key relationships for a table
+     * @param tableName Name of the table
+     * @returns Array of foreign key relationships
+     */
+    getForeignKeys(tableName: string): Array<{
+        column: string;
+        referencedTable: string;
+        referencedColumn: string;
+    }>;
+}
+/**
+ * Create a SchemaManager instance from schema definitions
+ * @param schemas Schema registry object
+ * @returns SchemaManager instance
+ */
+export declare function createSchemaManager(schemas: SchemaRegistry): SchemaManager;
+/**
+ * Create TableColumnResolver function from schema definitions
+ * @param schemas Schema registry object
+ * @returns TableColumnResolver function for SqlParamInjector
+ */
+export declare function createTableColumnResolver(schemas: SchemaRegistry): (tableName: string) => string[];
+/**
+ * Create JSON mapping from schema definitions
+ * @param schemas Schema registry object
+ * @param rootTableName Root table name
+ * @returns JSON mapping for PostgresJsonQueryBuilder
+ */
+export declare function createJsonMappingFromSchema(schemas: SchemaRegistry, rootTableName: string): JsonMapping;

package/dist/utils/SchemaManager.js

@@ -0,0 +1,201 @@
+"use strict";
+/**
+ * Schema Manager for rawsql-ts
+ * Provides unified schema definition and automatic conversion to various formats
+ * Eliminates code duplication and provides type-safe schema management
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SchemaManager = void 0;
+exports.createSchemaManager = createSchemaManager;
+exports.createTableColumnResolver = createTableColumnResolver;
+exports.createJsonMappingFromSchema = createJsonMappingFromSchema;
+// === Schema Manager Class ===
+/**
+ * Central schema management utility for rawsql-ts
+ * Converts user-defined schemas to various internal formats
+ */
+class SchemaManager {
+    constructor(schemas) {
+        this.schemas = schemas;
+        this.validateSchemas();
+    }
+    /**
+     * Validate schema definitions for consistency
+     * Ensures each table has a primary key (required for UPDATE/DELETE operations)
+     * and validates relationship references
+     */
+    validateSchemas() {
+        const tableNames = Object.keys(this.schemas);
+        const errors = [];
+        // Validate each table
+        Object.entries(this.schemas).forEach(([tableName, table]) => {
+            var _a;
+            // Check primary key exists (required for UPDATE/DELETE WHERE conditions)
+            const primaryKeys = Object.entries(table.columns)
+                .filter(([_, col]) => col.isPrimaryKey)
+                .map(([name, _]) => name);
+            if (primaryKeys.length === 0) {
+                errors.push(`Table '${tableName}' has no primary key defined`);
+            }
+            // Validate foreign key references
+            (_a = table.relationships) === null || _a === void 0 ? void 0 : _a.forEach(rel => {
+                if (!tableNames.includes(rel.table)) {
+                    errors.push(`Table '${tableName}' references unknown table '${rel.table}' in relationship`);
+                }
+            });
+        });
+        if (errors.length > 0) {
+            throw new Error(`Schema validation failed:\\n${errors.join('\\n')}`);
+        }
+    }
+    /**
+     * Get table column names for SqlParamInjector TableColumnResolver
+     * @param tableName Name of the table
+     * @returns Array of column names
+     */
+    getTableColumns(tableName) {
+        const table = this.schemas[tableName];
+        if (!table) {
+            return [];
+        }
+        return Object.keys(table.columns);
+    }
+    /**
+     * Create TableColumnResolver function for SqlParamInjector
+     * @returns Function compatible with SqlParamInjector
+     */
+    createTableColumnResolver() {
+        return (tableName) => this.getTableColumns(tableName);
+    }
+    /**
+     * Generate JSON mapping configuration for PostgresJsonQueryBuilder
+     * @param rootTableName Root table for the JSON structure
+     * @returns JSON mapping configuration
+     */
+    createJsonMapping(rootTableName) {
+        var _a;
+        const rootTable = this.schemas[rootTableName];
+        if (!rootTable) {
+            throw new Error(`Table '${rootTableName}' not found in schema registry`);
+        }
+        // Build root entity columns mapping
+        const rootColumns = {};
+        Object.entries(rootTable.columns).forEach(([columnName, column]) => {
+            rootColumns[columnName] = column.jsonAlias || column.name;
+        });
+        // Build nested entities from relationships
+        const nestedEntities = [];
+        (_a = rootTable.relationships) === null || _a === void 0 ? void 0 : _a.forEach(rel => {
+            const relatedTable = this.schemas[rel.table];
+            if (!relatedTable) {
+                throw new Error(`Related table '${rel.table}' not found in schema registry`);
+            }
+            // Build columns mapping for related table
+            const relatedColumns = {};
+            Object.entries(relatedTable.columns).forEach(([columnName, column]) => {
+                relatedColumns[columnName] = column.jsonAlias || column.name;
+            });
+            // Determine relationship type for JSON builder
+            const relationshipType = rel.type;
+            nestedEntities.push({
+                id: rel.propertyName,
+                name: relatedTable.displayName || rel.table,
+                parentId: rootTableName,
+                propertyName: rel.propertyName,
+                relationshipType: relationshipType,
+                columns: relatedColumns
+            });
+        });
+        return {
+            rootName: rootTableName,
+            rootEntity: {
+                id: rootTableName,
+                name: rootTable.displayName || rootTableName,
+                columns: rootColumns
+            },
+            nestedEntities,
+            useJsonb: true,
+            resultFormat: "single"
+        };
+    }
+    /**
+     * Get all table names in the schema
+     * @returns Array of table names
+     */
+    getTableNames() {
+        return Object.keys(this.schemas);
+    }
+    /**
+     * Get table definition by name
+     * @param tableName Name of the table
+     * @returns Table definition or undefined
+     */
+    getTable(tableName) {
+        return this.schemas[tableName];
+    }
+    /**
+     * Get primary key column name for a table
+     * Used by QueryBuilder.buildUpdateQuery for WHERE clause conditions
+     * @param tableName Name of the table
+     * @returns Primary key column name or undefined
+     */
+    getPrimaryKey(tableName) {
+        const table = this.schemas[tableName];
+        if (!table)
+            return undefined;
+        const primaryKeyEntry = Object.entries(table.columns)
+            .find(([_, col]) => col.isPrimaryKey);
+        return primaryKeyEntry ? primaryKeyEntry[0] : undefined;
+    }
+    /**
+     * Get foreign key relationships for a table
+     * @param tableName Name of the table
+     * @returns Array of foreign key relationships
+     */
+    getForeignKeys(tableName) {
+        const table = this.schemas[tableName];
+        if (!table)
+            return [];
+        const foreignKeys = [];
+        Object.entries(table.columns).forEach(([columnName, column]) => {
+            if (column.foreignKey) {
+                foreignKeys.push({
+                    column: columnName,
+                    referencedTable: column.foreignKey.table,
+                    referencedColumn: column.foreignKey.column
+                });
+            }
+        });
+        return foreignKeys;
+    }
+}
+exports.SchemaManager = SchemaManager;
+// === Convenience Functions ===
+/**
+ * Create a SchemaManager instance from schema definitions
+ * @param schemas Schema registry object
+ * @returns SchemaManager instance
+ */
+function createSchemaManager(schemas) {
+    return new SchemaManager(schemas);
+}
+/**
+ * Create TableColumnResolver function from schema definitions
+ * @param schemas Schema registry object
+ * @returns TableColumnResolver function for SqlParamInjector
+ */
+function createTableColumnResolver(schemas) {
+    const manager = new SchemaManager(schemas);
+    return manager.createTableColumnResolver();
+}
+/**
+ * Create JSON mapping from schema definitions
+ * @param schemas Schema registry object
+ * @param rootTableName Root table name
+ * @returns JSON mapping for PostgresJsonQueryBuilder
+ */
+function createJsonMappingFromSchema(schemas, rootTableName) {
+    const manager = new SchemaManager(schemas);
+    return manager.createJsonMapping(rootTableName);
+}
+//# sourceMappingURL=SchemaManager.js.map

package/dist/utils/SchemaManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaManager.js","sourceRoot":"","sources":["../../src/utils/SchemaManager.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;AA0PH,kDAEC;AAOD,8DAGC;AAQD,kEAGC;AAtND,+BAA+B;AAE/B;;;GAGG;AACH,MAAa,aAAa;IAGtB,YAAY,OAAuB;QAC/B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,eAAe,EAAE,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACK,eAAe;QACnB,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7C,MAAM,MAAM,GAAa,EAAE,CAAC;QAE5B,sBAAsB;QACtB,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,EAAE,KAAK,CAAC,EAAE,EAAE;;YACxD,yEAAyE;YACzE,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC;iBAC5C,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC;iBACtC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;YAE9B,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC3B,MAAM,CAAC,IAAI,CAAC,UAAU,SAAS,8BAA8B,CAAC,CAAC;YACnE,CAAC;YAED,kCAAkC;YAClC,MAAA,KAAK,CAAC,aAAa,0CAAE,OAAO,CAAC,GAAG,CAAC,EAAE;gBAC/B,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;oBAClC,MAAM,CAAC,IAAI,CAAC,UAAU,SAAS,+BAA+B,GAAG,CAAC,KAAK,mBAAmB,CAAC,CAAC;gBAChG,CAAC;YACL,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,+BAA+B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACzE,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,eAAe,CAAC,SAAiB;QACpC,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACtC,IAAI,CAAC,KAAK,EAAE,CAAC;YACT,OAAO,EAAE,CAAC;QACd,CAAC;QACD,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC;IAED;;;OAGG;IACI,yBAAyB;QAC5B,OAAO,CAAC,SAAiB,EAAE,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;IAClE,CAAC;IAED;;;;OAIG;IACI,iBAAiB,CAAC,aAAqB;;QAC1C,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAC9C,IAAI,CAAC,SAAS,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,UAAU,aAAa,gCAAgC,CAAC,CAAC;QAC7E,CAAC;QAED,oCAAoC;QACpC,MAAM,WAAW,GAA2B,EAAE,CAAC;QAC/C,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,EAAE,MAAM,CAAC,EAAE,EAAE;YAC/D,WAAW,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC;QAC9D,CAAC,CAAC,CAAC;QAEH,2CAA2C;QAC3C,MAAM,cAAc,GAAkC,EAAE,CAAC;QAEzD,MAAA,SAAS,CAAC,aAAa,0CAAE,OAAO,CAAC,GAAG,CAAC,EAAE;YACnC,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YAC7C,IAAI,CAAC,YAAY,EAAE,CAAC;gBAChB,MAAM,IAAI,KAAK,CAAC,kBAAkB,GAAG,CAAC,KAAK,gCAAgC,CAAC,CAAC;YACjF,CAAC;YAED,0CAA0C;YAC1C,MAAM,cAAc,GAA2B,EAAE,CAAC;YAClD,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,EAAE,MAAM,CAAC,EAAE,EAAE;gBAClE,cAAc,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC;YACjE,CAAC,CAAC,CAAC;YAEH,+CAA+C;YAC/C,MAAM,gBAAgB,GAAG,GAAG,CAAC,IAAI,CAAC;YAElC,cAAc,CAAC,IAAI,CAAC;gBAChB,EAAE,EAAE,GAAG,CAAC,YAAY;gBACpB,IAAI,EAAE,YAAY,CAAC,WAAW,IAAI,GAAG,CAAC,KAAK;gBAC3C,QAAQ,EAAE,aAAa;gBACvB,YAAY,EAAE,GAAG,CAAC,YAAY;gBAC9B,gBAAgB,EAAE,gBAAsC;gBACxD,OAAO,EAAE,cAAc;aAC1B,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,OAAO;YACH,QAAQ,EAAE,aAAa;YACvB,UAAU,EAAE;gBACR,EAAE,EAAE,aAAa;gBACjB,IAAI,EAAE,SAAS,CAAC,WAAW,IAAI,aAAa;gBAC5C,OAAO,EAAE,WAAW;aACvB;YACD,cAAc;YACd,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,QAAiB;SAClC,CAAC;IACN,CAAC;IAED;;;OAGG;IACI,aAAa;QAChB,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACI,QAAQ,CAAC,SAAiB;QAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACI,aAAa,CAAC,SAAiB;QAClC,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACtC,IAAI,CAAC,KAAK;YAAE,OAAO,SAAS,CAAC;QAE7B,MAAM,eAAe,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC;aAChD,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QAE1C,OAAO,eAAe,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC5D,CAAC;IAED;;;;OAIG;IACI,cAAc,CAAC,SAAiB;QACnC,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACtC,IAAI,CAAC,KAAK;YAAE,OAAO,EAAE,CAAC;QAEtB,MAAM,WAAW,GAAiF,EAAE,CAAC;QAErG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,EAAE,MAAM,CAAC,EAAE,EAAE;YAC3D,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;gBACpB,WAAW,CAAC,IAAI,CAAC;oBACb,MAAM,EAAE,UAAU;oBAClB,eAAe,EAAE,MAAM,CAAC,UAAU,CAAC,KAAK;oBACxC,gBAAgB,EAAE,MAAM,CAAC,UAAU,CAAC,MAAM;iBAC7C,CAAC,CAAC;YACP,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,OAAO,WAAW,CAAC;IACvB,CAAC;CACJ;AAhLD,sCAgLC;AAED,gCAAgC;AAEhC;;;;GAIG;AACH,SAAgB,mBAAmB,CAAC,OAAuB;IACvD,OAAO,IAAI,aAAa,CAAC,OAAO,CAAC,CAAC;AACtC,CAAC;AAED;;;;GAIG;AACH,SAAgB,yBAAyB,CAAC,OAAuB;IAC7D,MAAM,OAAO,GAAG,IAAI,aAAa,CAAC,OAAO,CAAC,CAAC;IAC3C,OAAO,OAAO,CAAC,yBAAyB,EAAE,CAAC;AAC/C,CAAC;AAED;;;;;GAKG;AACH,SAAgB,2BAA2B,CAAC,OAAuB,EAAE,aAAqB;IACtF,MAAM,OAAO,GAAG,IAAI,aAAa,CAAC,OAAO,CAAC,CAAC;IAC3C,OAAO,OAAO,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;AACpD,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "rawsql-ts",
-    "version": "0.9.0-beta",
+    "version": "0.10.1-beta",
     "description": "[beta]High-performance SQL parser and AST analyzer written in TypeScript. Provides fast parsing and advanced transformation capabilities.",
     "main": "dist/index.js",
     "module": "dist/esm/index.js",