rawsql-ts 0.11.14-beta → 0.11.16-beta

package/dist/src/transformers/CTEQueryDecomposer.d.ts

@@ -0,0 +1,213 @@
+import { SimpleSelectQuery } from "../models/SimpleSelectQuery";
+import { SqlFormatterOptions } from "./SqlFormatter";
+/**
+ * Interface representing a decomposed CTE with executable query
+ * @public
+ */
+export interface DecomposedCTE {
+    /** Name of the CTE */
+    name: string;
+    /** Executable SQL query for this CTE (includes dependencies) */
+    query: string;
+    /** Array of CTE names that this CTE depends on */
+    dependencies: string[];
+    /** Array of CTE names that depend on this CTE */
+    dependents: string[];
+    /** Whether this CTE is recursive */
+    isRecursive: boolean;
+}
+/**
+ * Options for CTEQueryDecomposer extending SqlFormatterOptions
+ * @public
+ */
+export interface CTEDecomposerOptions extends SqlFormatterOptions {
+    /** Whether to add comments to decomposed queries showing metadata and dependencies */
+    addComments?: boolean;
+}
+/**
+ * Decomposes complex CTEs into executable standalone queries
+ *
+ * This class analyzes Common Table Expressions and generates executable standalone queries
+ * for each CTE, making complex CTE debugging easier. It supports:
+ * - Recursive CTE detection and handling
+ * - Dependency analysis (dependencies and dependents for each CTE)
+ * - Configurable SQL formatter options (MySQL, PostgreSQL, custom styles)
+ * - Optional comment generation showing CTE metadata and relationships
+ * - Comprehensive error handling for circular dependencies
+ *
+ * @example
+ * ```typescript
+ * const decomposer = new CTEQueryDecomposer({
+ *   preset: 'postgres',
+ *   addComments: true,
+ *   keywordCase: 'upper'
+ * });
+ *
+ * const query = `
+ *   with users_data as (select * from users),
+ *        active_users as (select * from users_data where active = true)
+ *   select * from active_users
+ * `;
+ *
+ * const decomposed = decomposer.decompose(SelectQueryParser.parse(query));
+ * // Returns array of DecomposedCTE objects with executable queries
+ * ```
+ *
+ * @public
+ */
+export declare class CTEQueryDecomposer {
+    private static readonly ERROR_MESSAGES;
+    private static readonly COMMENT_TEXTS;
+    private readonly dependencyAnalyzer;
+    private readonly cteCollector;
+    private readonly formatter;
+    private readonly options;
+    /**
+     * Creates a new CTEQueryDecomposer instance
+     * @param options - Configuration options extending SqlFormatterOptions
+     */
+    constructor(options?: CTEDecomposerOptions);
+    /**
+     * Decomposes CTEs in a query into executable standalone queries
+     *
+     * This method analyzes the query structure to:
+     * 1. Collect all CTEs and analyze their dependencies
+     * 2. Detect recursive CTEs and handle them separately
+     * 3. Generate executable queries for each CTE including required dependencies
+     * 4. Add optional comments with metadata (if addComments option is enabled)
+     * 5. Format output according to specified formatter options
+     *
+     * @param query - The SimpleSelectQuery containing CTEs to decompose
+     * @returns Array of decomposed CTEs with executable queries, dependencies, and metadata
+     * @throws Error if circular dependencies are detected in non-recursive CTEs
+     *
+     * @example
+     * ```typescript
+     * const query = SelectQueryParser.parse(`
+     *   with base as (select * from users),
+     *        filtered as (select * from base where active = true)
+     *   select * from filtered
+     * `);
+     *
+     * const result = decomposer.decompose(query);
+     * // Returns:
+     * // [
+     * //   { name: 'base', query: 'select * from users', dependencies: [], ... },
+     * //   { name: 'filtered', query: 'with base as (...) select * from base where active = true', dependencies: ['base'], ... }
+     * // ]
+     * ```
+     */
+    decompose(query: SimpleSelectQuery): DecomposedCTE[];
+    /**
+     * Synchronizes edited CTEs back into a unified query and re-decomposes them
+     *
+     * This method resolves inconsistencies between edited CTEs by:
+     * 1. Composing the edited CTEs into a unified query
+     * 2. Parsing the unified query to ensure consistency
+     * 3. Re-decomposing the synchronized query
+     *
+     * This is useful when CTEs have been edited independently and may have
+     * inconsistencies that need to be resolved through a unified composition.
+     *
+     * @param editedCTEs - Array of edited CTEs that may have inconsistencies
+     * @param rootQuery - The main query that uses the CTEs
+     * @returns Array of re-decomposed CTEs with resolved inconsistencies
+     * @throws Error if the composed query cannot be parsed or contains errors
+     *
+     * @example
+     * ```typescript
+     * // After editing CTEs independently, synchronize them
+     * const editedCTEs = [
+     *   { name: 'users_data', query: 'select * from users where active = true' },
+     *   { name: 'active_users', query: 'select * from users_data where id >= 1000' }
+     * ];
+     *
+     * const synchronized = decomposer.synchronize(editedCTEs, 'select count(*) from active_users');
+     * // Returns re-decomposed CTEs with resolved dependencies
+     * ```
+     */
+    synchronize(editedCTEs: Array<{
+        name: string;
+        query: string;
+    }>, rootQuery: string): DecomposedCTE[];
+    /**
+     * Validates circular dependencies for non-recursive CTEs
+     * @param hasRecursiveCTEs Whether the query contains recursive CTEs
+     * @throws Error if circular dependencies exist in non-recursive CTEs
+     */
+    private validateCircularDependencies;
+    /**
+     * Processes CTE nodes and generates decomposed CTEs
+     * @param query Original query
+     * @param nodes CTE dependency nodes
+     * @param recursiveCTEs List of recursive CTE names
+     * @returns Array of decomposed CTEs
+     */
+    private processCTENodes;
+    /**
+     * Creates a decomposed CTE for recursive CTEs
+     */
+    private createRecursiveCTE;
+    /**
+     * Creates a decomposed CTE for standard (non-recursive) CTEs
+     */
+    private createStandardCTE;
+    /**
+     * Builds an executable query for a CTE by including its dependencies
+     */
+    private buildExecutableQuery;
+    /**
+     * Collects all required CTEs for a target CTE in dependency order
+     */
+    private collectRequiredCTEs;
+    /**
+     * Builds WITH clause from required CTEs
+     */
+    private buildWithClause;
+    /**
+     * Finds recursive CTEs in the query
+     * @param query The query to analyze
+     * @param ctes All CTEs in the query
+     * @returns Array of recursive CTE names
+     */
+    private findRecursiveCTEs;
+    /**
+     * Checks if a WITH clause is recursive
+     * @param query The query to check
+     * @returns true if the query contains WITH RECURSIVE
+     */
+    private isRecursiveWithClause;
+    /**
+     * Adds comments to the query if addComments option is enabled
+     * @param query The query string to add comments to
+     * @param cteName The name of the CTE
+     * @param dependencies Array of dependency names
+     * @param dependents Array of dependent names
+     * @param isRecursive Whether this is a recursive CTE
+     * @returns Query with comments added if enabled, otherwise original query
+     */
+    private addCommentsToQuery;
+    /**
+     * Generates comment lines for a CTE
+     * @param cteName The name of the CTE
+     * @param dependencies Array of dependency names
+     * @param dependents Array of dependent names
+     * @param isRecursive Whether this is a recursive CTE
+     * @returns Array of comment strings
+     */
+    private generateComments;
+    /**
+     * Adds text comments as SQL comments when AST parsing fails
+     * @param query Original query
+     * @param cteName The name of the CTE
+     * @param dependencies Array of dependency names
+     * @param dependents Array of dependent names
+     * @param isRecursive Whether this is a recursive CTE
+     * @returns Query with text comments prepended
+     */
+    private addTextCommentsToQuery;
+    /**
+     * Extracts the name from a CommonTable
+     */
+    private getCTEName;
+}

package/dist/src/transformers/CTEQueryDecomposer.js

@@ -0,0 +1,369 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CTEQueryDecomposer = void 0;
+const CTEDependencyAnalyzer_1 = require("./CTEDependencyAnalyzer");
+const CTECollector_1 = require("./CTECollector");
+const SqlFormatter_1 = require("./SqlFormatter");
+const CommentEditor_1 = require("../utils/CommentEditor");
+const SelectQueryParser_1 = require("../parsers/SelectQueryParser");
+const CTEComposer_1 = require("./CTEComposer");
+/**
+ * Decomposes complex CTEs into executable standalone queries
+ *
+ * This class analyzes Common Table Expressions and generates executable standalone queries
+ * for each CTE, making complex CTE debugging easier. It supports:
+ * - Recursive CTE detection and handling
+ * - Dependency analysis (dependencies and dependents for each CTE)
+ * - Configurable SQL formatter options (MySQL, PostgreSQL, custom styles)
+ * - Optional comment generation showing CTE metadata and relationships
+ * - Comprehensive error handling for circular dependencies
+ *
+ * @example
+ * ```typescript
+ * const decomposer = new CTEQueryDecomposer({
+ *   preset: 'postgres',
+ *   addComments: true,
+ *   keywordCase: 'upper'
+ * });
+ *
+ * const query = `
+ *   with users_data as (select * from users),
+ *        active_users as (select * from users_data where active = true)
+ *   select * from active_users
+ * `;
+ *
+ * const decomposed = decomposer.decompose(SelectQueryParser.parse(query));
+ * // Returns array of DecomposedCTE objects with executable queries
+ * ```
+ *
+ * @public
+ */
+class CTEQueryDecomposer {
+    /**
+     * Creates a new CTEQueryDecomposer instance
+     * @param options - Configuration options extending SqlFormatterOptions
+     */
+    constructor(options = {}) {
+        this.options = options;
+        this.dependencyAnalyzer = new CTEDependencyAnalyzer_1.CTEDependencyAnalyzer();
+        this.cteCollector = new CTECollector_1.CTECollector();
+        this.formatter = new SqlFormatter_1.SqlFormatter(options);
+    }
+    /**
+     * Decomposes CTEs in a query into executable standalone queries
+     *
+     * This method analyzes the query structure to:
+     * 1. Collect all CTEs and analyze their dependencies
+     * 2. Detect recursive CTEs and handle them separately
+     * 3. Generate executable queries for each CTE including required dependencies
+     * 4. Add optional comments with metadata (if addComments option is enabled)
+     * 5. Format output according to specified formatter options
+     *
+     * @param query - The SimpleSelectQuery containing CTEs to decompose
+     * @returns Array of decomposed CTEs with executable queries, dependencies, and metadata
+     * @throws Error if circular dependencies are detected in non-recursive CTEs
+     *
+     * @example
+     * ```typescript
+     * const query = SelectQueryParser.parse(`
+     *   with base as (select * from users),
+     *        filtered as (select * from base where active = true)
+     *   select * from filtered
+     * `);
+     *
+     * const result = decomposer.decompose(query);
+     * // Returns:
+     * // [
+     * //   { name: 'base', query: 'select * from users', dependencies: [], ... },
+     * //   { name: 'filtered', query: 'with base as (...) select * from base where active = true', dependencies: ['base'], ... }
+     * // ]
+     * ```
+     */
+    decompose(query) {
+        const ctes = this.cteCollector.collect(query);
+        if (ctes.length === 0) {
+            return [];
+        }
+        const recursiveCTEs = this.findRecursiveCTEs(query, ctes);
+        const dependencyGraph = this.dependencyAnalyzer.analyzeDependencies(query);
+        this.validateCircularDependencies(recursiveCTEs.length > 0);
+        return this.processCTENodes(query, dependencyGraph.nodes, recursiveCTEs);
+    }
+    /**
+     * Synchronizes edited CTEs back into a unified query and re-decomposes them
+     *
+     * This method resolves inconsistencies between edited CTEs by:
+     * 1. Composing the edited CTEs into a unified query
+     * 2. Parsing the unified query to ensure consistency
+     * 3. Re-decomposing the synchronized query
+     *
+     * This is useful when CTEs have been edited independently and may have
+     * inconsistencies that need to be resolved through a unified composition.
+     *
+     * @param editedCTEs - Array of edited CTEs that may have inconsistencies
+     * @param rootQuery - The main query that uses the CTEs
+     * @returns Array of re-decomposed CTEs with resolved inconsistencies
+     * @throws Error if the composed query cannot be parsed or contains errors
+     *
+     * @example
+     * ```typescript
+     * // After editing CTEs independently, synchronize them
+     * const editedCTEs = [
+     *   { name: 'users_data', query: 'select * from users where active = true' },
+     *   { name: 'active_users', query: 'select * from users_data where id >= 1000' }
+     * ];
+     *
+     * const synchronized = decomposer.synchronize(editedCTEs, 'select count(*) from active_users');
+     * // Returns re-decomposed CTEs with resolved dependencies
+     * ```
+     */
+    synchronize(editedCTEs, rootQuery) {
+        if (editedCTEs.length === 0) {
+            return [];
+        }
+        // Use CTEComposer to create a unified query, sharing formatter options
+        const composerOptions = {
+            ...this.options,
+            // Remove decomposer-specific options
+            addComments: undefined
+        };
+        const composer = new CTEComposer_1.CTEComposer(composerOptions);
+        const unifiedQuery = composer.compose(editedCTEs, rootQuery);
+        // Parse the unified query
+        const parsedQuery = SelectQueryParser_1.SelectQueryParser.parse(unifiedQuery);
+        // Re-decompose the synchronized query
+        return this.decompose(parsedQuery);
+    }
+    /**
+     * Validates circular dependencies for non-recursive CTEs
+     * @param hasRecursiveCTEs Whether the query contains recursive CTEs
+     * @throws Error if circular dependencies exist in non-recursive CTEs
+     */
+    validateCircularDependencies(hasRecursiveCTEs) {
+        if (this.dependencyAnalyzer.hasCircularDependency() && !hasRecursiveCTEs) {
+            throw new Error(CTEQueryDecomposer.ERROR_MESSAGES.CIRCULAR_REFERENCE);
+        }
+    }
+    /**
+     * Processes CTE nodes and generates decomposed CTEs
+     * @param query Original query
+     * @param nodes CTE dependency nodes
+     * @param recursiveCTEs List of recursive CTE names
+     * @returns Array of decomposed CTEs
+     */
+    processCTENodes(query, nodes, recursiveCTEs) {
+        const result = [];
+        for (const node of nodes) {
+            const isRecursive = recursiveCTEs.includes(node.name);
+            if (isRecursive) {
+                result.push(this.createRecursiveCTE(node, query));
+            }
+            else {
+                result.push(this.createStandardCTE(node, nodes));
+            }
+        }
+        return result;
+    }
+    /**
+     * Creates a decomposed CTE for recursive CTEs
+     */
+    createRecursiveCTE(node, query) {
+        const formattedQuery = this.formatter.format(query).formattedSql;
+        const finalQuery = this.addCommentsToQuery(formattedQuery, node.name, [], [], true);
+        return {
+            name: node.name,
+            query: finalQuery,
+            dependencies: [],
+            dependents: [],
+            isRecursive: true
+        };
+    }
+    /**
+     * Creates a decomposed CTE for standard (non-recursive) CTEs
+     */
+    createStandardCTE(node, allNodes) {
+        const query = this.buildExecutableQuery(node, allNodes);
+        const finalQuery = this.addCommentsToQuery(query, node.name, node.dependencies, node.dependents, false);
+        return {
+            name: node.name,
+            query: finalQuery,
+            dependencies: [...node.dependencies],
+            dependents: [...node.dependents],
+            isRecursive: false
+        };
+    }
+    /**
+     * Builds an executable query for a CTE by including its dependencies
+     */
+    buildExecutableQuery(targetNode, allNodes) {
+        const requiredCTEs = this.collectRequiredCTEs(targetNode, allNodes);
+        if (requiredCTEs.length === 0) {
+            // No dependencies, just return the CTE's query
+            return this.formatter.format(targetNode.cte.query).formattedSql;
+        }
+        // Build WITH clause with required CTEs
+        const withClause = this.buildWithClause(requiredCTEs);
+        const mainQuery = this.formatter.format(targetNode.cte.query).formattedSql;
+        return `${withClause} ${mainQuery}`;
+    }
+    /**
+     * Collects all required CTEs for a target CTE in dependency order
+     */
+    collectRequiredCTEs(targetNode, allNodes) {
+        const visited = new Set();
+        const result = [];
+        const nodeMap = new Map();
+        // Build node lookup map
+        for (const node of allNodes) {
+            nodeMap.set(node.name, node);
+        }
+        const collectDependencies = (nodeName) => {
+            if (visited.has(nodeName))
+                return;
+            visited.add(nodeName);
+            const node = nodeMap.get(nodeName);
+            if (!node)
+                return;
+            // First collect all dependencies
+            for (const depName of node.dependencies) {
+                collectDependencies(depName);
+            }
+            // Then add this node (ensuring dependencies come first)
+            if (nodeName !== targetNode.name) {
+                result.push(node);
+            }
+        };
+        // Collect dependencies for the target node
+        for (const depName of targetNode.dependencies) {
+            collectDependencies(depName);
+        }
+        return result;
+    }
+    /**
+     * Builds WITH clause from required CTEs
+     */
+    buildWithClause(requiredCTEs) {
+        if (requiredCTEs.length === 0)
+            return "";
+        const cteDefinitions = requiredCTEs.map(node => {
+            const cteName = node.name;
+            const cteQuery = this.formatter.format(node.cte.query).formattedSql;
+            return `${cteName} as (${cteQuery})`;
+        });
+        return `with ${cteDefinitions.join(", ")}`;
+    }
+    /**
+     * Finds recursive CTEs in the query
+     * @param query The query to analyze
+     * @param ctes All CTEs in the query
+     * @returns Array of recursive CTE names
+     */
+    findRecursiveCTEs(query, ctes) {
+        if (!query.withClause || !this.isRecursiveWithClause(query)) {
+            return [];
+        }
+        // For now, assume all CTEs in a RECURSIVE WITH are recursive
+        // This is a simplification - in reality, only some CTEs might be recursive
+        return ctes.map(cte => this.getCTEName(cte));
+    }
+    /**
+     * Checks if a WITH clause is recursive
+     * @param query The query to check
+     * @returns true if the query contains WITH RECURSIVE
+     */
+    isRecursiveWithClause(query) {
+        const queryText = this.formatter.format(query).formattedSql.toLowerCase();
+        return queryText.includes('with recursive');
+    }
+    /**
+     * Adds comments to the query if addComments option is enabled
+     * @param query The query string to add comments to
+     * @param cteName The name of the CTE
+     * @param dependencies Array of dependency names
+     * @param dependents Array of dependent names
+     * @param isRecursive Whether this is a recursive CTE
+     * @returns Query with comments added if enabled, otherwise original query
+     */
+    addCommentsToQuery(query, cteName, dependencies, dependents, isRecursive) {
+        if (this.options.addComments !== true) {
+            return query;
+        }
+        try {
+            // Parse the query to add comments to its AST
+            const parsedQuery = SelectQueryParser_1.SelectQueryParser.parse(query);
+            // Generate comment lines
+            const comments = this.generateComments(cteName, dependencies, dependents, isRecursive);
+            // Add comments to the root query (this should place them at the beginning)
+            comments.forEach(comment => {
+                CommentEditor_1.CommentEditor.addComment(parsedQuery, comment);
+            });
+            // Format with comment export enabled
+            const formatterWithComments = new SqlFormatter_1.SqlFormatter({
+                ...this.options,
+                exportComment: true
+            });
+            return formatterWithComments.format(parsedQuery).formattedSql;
+        }
+        catch (error) {
+            // If parsing fails, return original query with simple text comments
+            console.warn(`${CTEQueryDecomposer.ERROR_MESSAGES.PARSING_FAILED}: ${error}`);
+            return this.addTextCommentsToQuery(query, cteName, dependencies, dependents, isRecursive);
+        }
+    }
+    /**
+     * Generates comment lines for a CTE
+     * @param cteName The name of the CTE
+     * @param dependencies Array of dependency names
+     * @param dependents Array of dependent names
+     * @param isRecursive Whether this is a recursive CTE
+     * @returns Array of comment strings
+     */
+    generateComments(cteName, dependencies, dependents, isRecursive) {
+        const { AUTO_GENERATED, ORIGINAL_CTE, DEPENDENCIES, DEPENDENTS, RECURSIVE_TYPE, NONE } = CTEQueryDecomposer.COMMENT_TEXTS;
+        const comments = [];
+        comments.push(AUTO_GENERATED);
+        comments.push(`${ORIGINAL_CTE} ${cteName}`);
+        if (isRecursive) {
+            comments.push(RECURSIVE_TYPE);
+        }
+        const depsText = dependencies.length > 0 ? dependencies.join(", ") : NONE;
+        comments.push(`${DEPENDENCIES} ${depsText}`);
+        const dependentsText = dependents.length > 0 ? dependents.join(", ") : NONE;
+        comments.push(`${DEPENDENTS} ${dependentsText}`);
+        return comments;
+    }
+    /**
+     * Adds text comments as SQL comments when AST parsing fails
+     * @param query Original query
+     * @param cteName The name of the CTE
+     * @param dependencies Array of dependency names
+     * @param dependents Array of dependent names
+     * @param isRecursive Whether this is a recursive CTE
+     * @returns Query with text comments prepended
+     */
+    addTextCommentsToQuery(query, cteName, dependencies, dependents, isRecursive) {
+        const comments = this.generateComments(cteName, dependencies, dependents, isRecursive);
+        const commentLines = comments.map(comment => `-- ${comment}`).join('\n');
+        return `${commentLines}\n${query}`;
+    }
+    /**
+     * Extracts the name from a CommonTable
+     */
+    getCTEName(cte) {
+        return cte.aliasExpression.table.name;
+    }
+}
+exports.CTEQueryDecomposer = CTEQueryDecomposer;
+CTEQueryDecomposer.ERROR_MESSAGES = {
+    CIRCULAR_REFERENCE: "Circular reference detected in non-recursive CTEs",
+    PARSING_FAILED: "Failed to parse query for comment injection"
+};
+CTEQueryDecomposer.COMMENT_TEXTS = {
+    AUTO_GENERATED: "Auto-generated by CTE decomposer",
+    ORIGINAL_CTE: "Original CTE:",
+    DEPENDENCIES: "Dependencies:",
+    DEPENDENTS: "Dependents:",
+    RECURSIVE_TYPE: "Type: Recursive CTE",
+    NONE: "none"
+};
+//# sourceMappingURL=CTEQueryDecomposer.js.map

package/dist/src/transformers/CTEQueryDecomposer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CTEQueryDecomposer.js","sourceRoot":"","sources":["../../../src/transformers/CTEQueryDecomposer.ts"],"names":[],"mappings":";;;AAEA,mEAAyE;AACzE,iDAA8C;AAC9C,iDAAmE;AACnE,0DAAuD;AACvD,oEAAiE;AACjE,+CAA4C;AA4B5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAa,kBAAkB;IAoB3B;;;OAGG;IACH,YAAY,UAAgC,EAAE;QAC1C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,kBAAkB,GAAG,IAAI,6CAAqB,EAAE,CAAC;QACtD,IAAI,CAAC,YAAY,GAAG,IAAI,2BAAY,EAAE,CAAC;QACvC,IAAI,CAAC,SAAS,GAAG,IAAI,2BAAY,CAAC,OAAO,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACI,SAAS,CAAC,KAAwB;QACrC,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC9C,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACpB,OAAO,EAAE,CAAC;QACd,CAAC;QAED,MAAM,aAAa,GAAG,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAC1D,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;QAE3E,IAAI,CAAC,4BAA4B,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAE5D,OAAO,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,eAAe,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACI,WAAW,CAAC,UAAgD,EAAE,SAAiB;QAClF,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC1B,OAAO,EAAE,CAAC;QACd,CAAC;QAED,uEAAuE;QACvE,MAAM,eAAe,GAAG;YACpB,GAAG,IAAI,CAAC,OAAO;YACf,qCAAqC;YACrC,WAAW,EAAE,SAAS;SACzB,CAAC;QACF,MAAM,QAAQ,GAAG,IAAI,yBAAW,CAAC,eAAe,CAAC,CAAC;QAClD,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;QAE7D,0BAA0B;QAC1B,MAAM,WAAW,GAAG,qCAAiB,CAAC,KAAK,CAAC,YAAY,CAAsB,CAAC;QAE/E,sCAAsC;QACtC,OAAO,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;IACvC,CAAC;IAED;;;;OAIG;IACK,4BAA4B,CAAC,gBAAyB;QAC1D,IAAI,IAAI,CAAC,kBAAkB,CAAC,qBAAqB,EAAE,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACvE,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC;QAC1E,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACK,eAAe,CACnB,KAAwB,EACxB,KAAgB,EAChB,aAAuB;QAEvB,MAAM,MAAM,GAAoB,EAAE,CAAC;QAEnC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACvB,MAAM,WAAW,GAAG,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAEtD,IAAI,WAAW,EAAE,CAAC;gBACd,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;YACtD,CAAC;iBAAM,CAAC;gBACJ,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;YACrD,CAAC;QACL,CAAC;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;OAEG;IACK,kBAAkB,CAAC,IAAa,EAAE,KAAwB;QAC9D,MAAM,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC;QACjE,MAAM,UAAU,GAAG,IAAI,CAAC,kBAAkB,CAAC,cAAc,EAAE,IAAI,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;QAEpF,OAAO;YACH,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,KAAK,EAAE,UAAU;YACjB,YAAY,EAAE,EAAE;YAChB,UAAU,EAAE,EAAE;YACd,WAAW,EAAE,IAAI;SACpB,CAAC;IACN,CAAC;IAED;;OAEG;IACK,iBAAiB,CAAC,IAAa,EAAE,QAAmB;QACxD,MAAM,KAAK,GAAG,IAAI,CAAC,oBAAoB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QACxD,MAAM,UAAU,GAAG,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;QAExG,OAAO;YACH,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,KAAK,EAAE,UAAU;YACjB,YAAY,EAAE,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC;YACpC,UAAU,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC;YAChC,WAAW,EAAE,KAAK;SACrB,CAAC;IACN,CAAC;IAED;;OAEG;IACK,oBAAoB,CAAC,UAAmB,EAAE,QAAmB;QACjE,MAAM,YAAY,GAAG,IAAI,CAAC,mBAAmB,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QAEpE,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC5B,+CAA+C;YAC/C,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC;QACpE,CAAC;QAED,uCAAuC;QACvC,MAAM,UAAU,GAAG,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;QACtD,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC;QAE3E,OAAO,GAAG,UAAU,IAAI,SAAS,EAAE,CAAC;IACxC,CAAC;IAED;;OAEG;IACK,mBAAmB,CAAC,UAAmB,EAAE,QAAmB;QAChE,MAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;QAClC,MAAM,MAAM,GAAc,EAAE,CAAC;QAC7B,MAAM,OAAO,GAAG,IAAI,GAAG,EAAmB,CAAC;QAE3C,wBAAwB;QACxB,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE,CAAC;YAC1B,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACjC,CAAC;QAED,MAAM,mBAAmB,GAAG,CAAC,QAAgB,EAAE,EAAE;YAC7C,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC;gBAAE,OAAO;YAClC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YAEtB,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YACnC,IAAI,CAAC,IAAI;gBAAE,OAAO;YAElB,iCAAiC;YACjC,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;gBACtC,mBAAmB,CAAC,OAAO,CAAC,CAAC;YACjC,CAAC;YAED,wDAAwD;YACxD,IAAI,QAAQ,KAAK,UAAU,CAAC,IAAI,EAAE,CAAC;gBAC/B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACtB,CAAC;QACL,CAAC,CAAC;QAEF,2CAA2C;QAC3C,KAAK,MAAM,OAAO,IAAI,UAAU,CAAC,YAAY,EAAE,CAAC;YAC5C,mBAAmB,CAAC,OAAO,CAAC,CAAC;QACjC,CAAC;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;OAEG;IACK,eAAe,CAAC,YAAuB;QAC3C,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,EAAE,CAAC;QAEzC,MAAM,cAAc,GAAG,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;YAC3C,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC;YAC1B,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC;YACpE,OAAO,GAAG,OAAO,QAAQ,QAAQ,GAAG,CAAC;QACzC,CAAC,CAAC,CAAC;QAEH,OAAO,QAAQ,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;IAC/C,CAAC;IAED;;;;;OAKG;IACK,iBAAiB,CAAC,KAAwB,EAAE,IAAmB;QACnE,IAAI,CAAC,KAAK,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1D,OAAO,EAAE,CAAC;QACd,CAAC;QAED,6DAA6D;QAC7D,2EAA2E;QAC3E,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACK,qBAAqB,CAAC,KAAwB;QAClD,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC;QAC1E,OAAO,SAAS,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;;;OAQG;IACK,kBAAkB,CACtB,KAAa,EACb,OAAe,EACf,YAAsB,EACtB,UAAoB,EACpB,WAAoB;QAEpB,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,IAAI,EAAE,CAAC;YACpC,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,IAAI,CAAC;YACD,6CAA6C;YAC7C,MAAM,WAAW,GAAG,qCAAiB,CAAC,KAAK,CAAC,KAAK,CAAsB,CAAC;YAExE,yBAAyB;YACzB,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;YAEvF,2EAA2E;YAC3E,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;gBACvB,6BAAa,CAAC,UAAU,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;YACnD,CAAC,CAAC,CAAC;YAEH,qCAAqC;YACrC,MAAM,qBAAqB,GAAG,IAAI,2BAAY,CAAC;gBAC3C,GAAG,IAAI,CAAC,OAAO;gBACf,aAAa,EAAE,IAAI;aACtB,CAAC,CAAC;YAEH,OAAO,qBAAqB,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,YAAY,CAAC;QAClE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,oEAAoE;YACpE,OAAO,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC,cAAc,CAAC,cAAc,KAAK,KAAK,EAAE,CAAC,CAAC;YAC9E,OAAO,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;QAC9F,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACK,gBAAgB,CACpB,OAAe,EACf,YAAsB,EACtB,UAAoB,EACpB,WAAoB;QAEpB,MAAM,EAAE,cAAc,EAAE,YAAY,EAAE,YAAY,EAAE,UAAU,EAAE,cAAc,EAAE,IAAI,EAAE,GAAG,kBAAkB,CAAC,aAAa,CAAC;QAC1H,MAAM,QAAQ,GAAa,EAAE,CAAC;QAE9B,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC9B,QAAQ,CAAC,IAAI,CAAC,GAAG,YAAY,IAAI,OAAO,EAAE,CAAC,CAAC;QAE5C,IAAI,WAAW,EAAE,CAAC;YACd,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAClC,CAAC;QAED,MAAM,QAAQ,GAAG,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAC1E,QAAQ,CAAC,IAAI,CAAC,GAAG,YAAY,IAAI,QAAQ,EAAE,CAAC,CAAC;QAE7C,MAAM,cAAc,GAAG,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAC5E,QAAQ,CAAC,IAAI,CAAC,GAAG,UAAU,IAAI,cAAc,EAAE,CAAC,CAAC;QAEjD,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED;;;;;;;;OAQG;IACK,sBAAsB,CAC1B,KAAa,EACb,OAAe,EACf,YAAsB,EACtB,UAAoB,EACpB,WAAoB;QAEpB,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;QACvF,MAAM,YAAY,GAAG,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzE,OAAO,GAAG,YAAY,KAAK,KAAK,EAAE,CAAC;IACvC,CAAC;IAED;;OAEG;IACK,UAAU,CAAC,GAAgB;QAC/B,OAAO,GAAG,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC;IAC1C,CAAC;;AA7YL,gDA8YC;AA7Y2B,iCAAc,GAAG;IACrC,kBAAkB,EAAE,mDAAmD;IACvE,cAAc,EAAE,6CAA6C;CACvD,CAAC;AAEa,gCAAa,GAAG;IACpC,cAAc,EAAE,kCAAkC;IAClD,YAAY,EAAE,eAAe;IAC7B,YAAY,EAAE,eAAe;IAC7B,UAAU,EAAE,aAAa;IACzB,cAAc,EAAE,qBAAqB;IACrC,IAAI,EAAE,MAAM;CACN,CAAC"}

package/dist/src/transformers/SqlFormatter.d.ts

@@ -10,33 +10,51 @@ export type PresetName = (typeof VALID_PRESETS)[number];
  * - 'full-oneline': Entire WITH clause is formatted as one line
  */
 export type WithClauseStyle = 'standard' | 'cte-oneline' | 'full-oneline';
+/**
+ * Options for SqlFormatter configuration
+ * @public
+ */
+export interface SqlFormatterOptions {
+    /** Database preset for formatting style ('mysql', 'postgres', 'sqlserver', 'sqlite') */
+    preset?: PresetName;
+    /** Custom identifier escape characters (e.g., {start: '"', end: '"'} for PostgreSQL) */
+    identifierEscape?: {
+        start: string;
+        end: string;
+    };
+    /** Parameter symbol configuration for SQL parameters */
+    parameterSymbol?: string | {
+        start: string;
+        end: string;
+    };
+    /** Style for parameter formatting */
+    parameterStyle?: 'anonymous' | 'indexed' | 'named';
+    /** Number of spaces for indentation */
+    indentSize?: number;
+    /** Character to use for indentation ('space' or 'tab') */
+    indentChar?: IndentCharOption;
+    /** Newline character style */
+    newline?: NewlineOption;
+    /** Case transformation for SQL keywords */
+    keywordCase?: 'none' | 'upper' | 'lower';
+    /** Style for comma line breaks */
+    commaBreak?: CommaBreakStyle;
+    /** Style for AND/OR line breaks */
+    andBreak?: AndBreakStyle;
+    /** Whether to export comments in formatted output */
+    exportComment?: boolean;
+    /** Whether to only export comments from clause-level keywords */
+    strictCommentPlacement?: boolean;
+    /** Formatting style for WITH clauses */
+    withClauseStyle?: WithClauseStyle;
+}
 /**
  * SqlFormatter class combines parsing and printing of SQL queries into a single interface.
  */
 export declare class SqlFormatter {
     private parser;
     private printer;
-    constructor(options?: {
-        preset?: PresetName;
-        identifierEscape?: {
-            start: string;
-            end: string;
-        };
-        parameterSymbol?: string | {
-            start: string;
-            end: string;
-        };
-        parameterStyle?: 'anonymous' | 'indexed' | 'named';
-        indentSize?: number;
-        indentChar?: IndentCharOption;
-        newline?: NewlineOption;
-        keywordCase?: 'none' | 'upper' | 'lower';
-        commaBreak?: CommaBreakStyle;
-        andBreak?: AndBreakStyle;
-        exportComment?: boolean;
-        strictCommentPlacement?: boolean;
-        withClauseStyle?: WithClauseStyle;
-    }); /**
+    constructor(options?: SqlFormatterOptions); /**
      * Formats a SQL query string with the given parameters.
      * @param sqlText The SQL query string to format.
      * @param parameters A dictionary of parameters to replace in the query.

package/dist/src/transformers/SqlFormatter.js.map

@@ -1 +1 @@
-{"version":3,"file":"SqlFormatter.js","sourceRoot":"","sources":["../../../src/transformers/SqlFormatter.ts"],"names":[],"mappings":";;;AAAA,wEAA+F;AAC/F,6CAA0E;AAK1E,4CAA4C;AAC/B,QAAA,aAAa,GAAG,CAAC,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,QAAQ,CAAU,CAAC;AAWnF;;GAEG;AACH,MAAa,YAAY;IAIrB,YAAY,UAcR,EAAE;;QAEF,MAAM,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,6BAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAE1E,IAAI,OAAO,CAAC,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,mBAAmB,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,iCAAiC;QAC3F,CAAC;QAED,MAAM,aAAa,GAAG;YAClB,GAAG,YAAY,EAAE,6BAA6B;YAC9C,gBAAgB,EAAE,MAAA,OAAO,CAAC,gBAAgB,mCAAI,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,gBAAgB;YAC5E,eAAe,EAAE,MAAA,OAAO,CAAC,eAAe,mCAAI,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,eAAe;YACzE,cAAc,EAAE,MAAA,OAAO,CAAC,cAAc,mCAAI,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,cAAc;SACzE,CAAC;QAEF,IAAI,CAAC,MAAM,GAAG,IAAI,yCAAmB,CAAC,aAAa,CAAC,CAAC;QACrD,IAAI,CAAC,OAAO,GAAG,IAAI,uBAAU,CAAC,OAAO,CAAC,CAAC;IAC3C,CAAC,CAAI;;;;;OAKF;IACH,MAAM,CAAC,GAAiB;QACpB,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACjD,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAE/C,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,CAAC;IACpC,CAAC;CACJ;AA/CD,oCA+CC"}
+{"version":3,"file":"SqlFormatter.js","sourceRoot":"","sources":["../../../src/transformers/SqlFormatter.ts"],"names":[],"mappings":";;;AAAA,wEAA+F;AAC/F,6CAA0E;AAK1E,4CAA4C;AAC/B,QAAA,aAAa,GAAG,CAAC,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,QAAQ,CAAU,CAAC;AA4CnF;;GAEG;AACH,MAAa,YAAY;IAIrB,YAAY,UAA+B,EAAE;;QAEzC,MAAM,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,6BAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAE1E,IAAI,OAAO,CAAC,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,mBAAmB,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,iCAAiC;QAC3F,CAAC;QAED,MAAM,aAAa,GAAG;YAClB,GAAG,YAAY,EAAE,6BAA6B;YAC9C,gBAAgB,EAAE,MAAA,OAAO,CAAC,gBAAgB,mCAAI,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,gBAAgB;YAC5E,eAAe,EAAE,MAAA,OAAO,CAAC,eAAe,mCAAI,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,eAAe;YACzE,cAAc,EAAE,MAAA,OAAO,CAAC,cAAc,mCAAI,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,cAAc;SACzE,CAAC;QAEF,IAAI,CAAC,MAAM,GAAG,IAAI,yCAAmB,CAAC,aAAa,CAAC,CAAC;QACrD,IAAI,CAAC,OAAO,GAAG,IAAI,uBAAU,CAAC,OAAO,CAAC,CAAC;IAC3C,CAAC,CAAI;;;;;OAKF;IACH,MAAM,CAAC,GAAiB;QACpB,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACjD,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAE/C,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,CAAC;IACpC,CAAC;CACJ;AAjCD,oCAiCC"}