rawsql-ts 0.10.3-beta → 0.10.5-beta

package/dist/esm/transformers/SqlSortInjector.js

@@ -0,0 +1,146 @@
+import { SimpleSelectQuery } from "../models/SelectQuery";
+import { SelectableColumnCollector } from "./SelectableColumnCollector";
+import { OrderByClause, OrderByItem, SortDirection, NullsSortDirection } from "../models/Clause";
+import { SelectQueryParser } from "../parsers/SelectQueryParser";
+/**
+ * SqlSortInjector injects sort conditions into a SelectQuery model,
+ * creating ORDER BY clauses based on provided sort conditions.
+ */
+export class SqlSortInjector {
+    constructor(tableColumnResolver) {
+        this.tableColumnResolver = tableColumnResolver;
+    }
+    /**
+     * Removes ORDER BY clause from the given query.
+     * @param query The SelectQuery to modify
+     * @returns The modified SimpleSelectQuery with ORDER BY clause removed
+     */
+    static removeOrderBy(query) {
+        // Convert string query to SimpleSelectQuery using SelectQueryParser if needed
+        if (typeof query === 'string') {
+            query = SelectQueryParser.parse(query);
+        }
+        // Check if query is SimpleSelectQuery
+        if (!(query instanceof SimpleSelectQuery)) {
+            throw new Error('Complex queries are not supported for ORDER BY removal');
+        }
+        // Create a new query without ORDER BY clause
+        return new SimpleSelectQuery({
+            withClause: query.withClause,
+            selectClause: query.selectClause,
+            fromClause: query.fromClause,
+            whereClause: query.whereClause,
+            groupByClause: query.groupByClause,
+            havingClause: query.havingClause,
+            orderByClause: null, // Remove ORDER BY
+            windowClause: query.windowClause,
+            limitClause: query.limitClause,
+            offsetClause: query.offsetClause,
+            fetchClause: query.fetchClause,
+            forClause: query.forClause,
+        });
+    }
+    /**
+     * Injects sort conditions as ORDER BY clauses into the given query model.
+     * Appends to existing ORDER BY clause if present.
+     * @param query The SelectQuery to modify
+     * @param sortConditions A record of column names and sort conditions
+     * @returns The modified SimpleSelectQuery
+     */
+    inject(query, sortConditions) {
+        // Convert string query to SimpleSelectQuery using SelectQueryParser if needed
+        if (typeof query === 'string') {
+            query = SelectQueryParser.parse(query);
+        }
+        // Check if query is SimpleSelectQuery
+        if (!(query instanceof SimpleSelectQuery)) {
+            throw new Error('Complex queries are not supported for sorting');
+        }
+        // Collect available columns from the current query only (no upstream search)
+        const collector = new SelectableColumnCollector(this.tableColumnResolver);
+        const availableColumns = collector.collect(query);
+        // Validate that all specified columns exist
+        for (const columnName of Object.keys(sortConditions)) {
+            const columnEntry = availableColumns.find(item => item.name === columnName);
+            if (!columnEntry) {
+                throw new Error(`Column or alias '${columnName}' not found in current query`);
+            }
+        }
+        // Build new ORDER BY items
+        const newOrderByItems = [];
+        for (const [columnName, condition] of Object.entries(sortConditions)) {
+            const columnEntry = availableColumns.find(item => item.name === columnName);
+            if (!columnEntry)
+                continue; // Should not happen due to validation above
+            const columnRef = columnEntry.value;
+            // Validate condition
+            this.validateSortCondition(columnName, condition);
+            // Determine sort direction
+            let sortDirection;
+            if (condition.desc) {
+                sortDirection = SortDirection.Descending;
+            }
+            else {
+                sortDirection = SortDirection.Ascending; // Default to ASC
+            }
+            // Determine nulls position
+            let nullsPosition = null;
+            if (condition.nullsFirst) {
+                nullsPosition = NullsSortDirection.First;
+            }
+            else if (condition.nullsLast) {
+                nullsPosition = NullsSortDirection.Last;
+            }
+            // Create OrderByItem
+            const orderByItem = new OrderByItem(columnRef, sortDirection, nullsPosition);
+            newOrderByItems.push(orderByItem);
+        }
+        // Combine with existing ORDER BY clause if present
+        let finalOrderByItems = [];
+        if (query.orderByClause) {
+            // Append to existing ORDER BY
+            finalOrderByItems = [...query.orderByClause.order, ...newOrderByItems];
+        }
+        else {
+            // Create new ORDER BY
+            finalOrderByItems = newOrderByItems;
+        }
+        // Create new OrderByClause
+        const newOrderByClause = finalOrderByItems.length > 0
+            ? new OrderByClause(finalOrderByItems)
+            : null;
+        // Create new query with updated ORDER BY clause
+        return new SimpleSelectQuery({
+            withClause: query.withClause,
+            selectClause: query.selectClause,
+            fromClause: query.fromClause,
+            whereClause: query.whereClause,
+            groupByClause: query.groupByClause,
+            havingClause: query.havingClause,
+            orderByClause: newOrderByClause,
+            windowClause: query.windowClause,
+            limitClause: query.limitClause,
+            offsetClause: query.offsetClause,
+            fetchClause: query.fetchClause,
+            forClause: query.forClause,
+        });
+    }
+    /**
+     * Validates sort condition for a column
+     */
+    validateSortCondition(columnName, condition) {
+        // Check for conflicting sort directions
+        if (condition.asc && condition.desc) {
+            throw new Error(`Conflicting sort directions for column '${columnName}': both asc and desc specified`);
+        }
+        // Check for conflicting nulls positions
+        if (condition.nullsFirst && condition.nullsLast) {
+            throw new Error(`Conflicting nulls positions for column '${columnName}': both nullsFirst and nullsLast specified`);
+        }
+        // Check if at least one option is specified
+        if (!condition.asc && !condition.desc && !condition.nullsFirst && !condition.nullsLast) {
+            throw new Error(`Empty sort condition for column '${columnName}': at least one sort option must be specified`);
+        }
+    }
+}
+//# sourceMappingURL=SqlSortInjector.js.map

package/dist/esm/transformers/SqlSortInjector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SqlSortInjector.js","sourceRoot":"","sources":["../../../src/transformers/SqlSortInjector.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AACvE,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AACxE,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAEjG,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAEjE;;;GAGG;AACH,MAAM,OAAO,eAAe;IAGxB,YAAY,mBAAqD;QAC7D,IAAI,CAAC,mBAAmB,GAAG,mBAAmB,CAAC;IACnD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,aAAa,CAAC,KAAiC;QACzD,8EAA8E;QAC9E,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC5B,KAAK,GAAG,iBAAiB,CAAC,KAAK,CAAC,KAAK,CAAsB,CAAC;QAChE,CAAC;QAED,sCAAsC;QACtC,IAAI,CAAC,CAAC,KAAK,YAAY,iBAAiB,CAAC,EAAE,CAAC;YACxC,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;QAC9E,CAAC;QAED,6CAA6C;QAC7C,OAAO,IAAI,iBAAiB,CAAC;YACzB,UAAU,EAAE,KAAK,CAAC,UAAU;YAC5B,YAAY,EAAE,KAAK,CAAC,YAAY;YAChC,UAAU,EAAE,KAAK,CAAC,UAAU;YAC5B,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,aAAa,EAAE,KAAK,CAAC,aAAa;YAClC,YAAY,EAAE,KAAK,CAAC,YAAY;YAChC,aAAa,EAAE,IAAI,EAAE,kBAAkB;YACvC,YAAY,EAAE,KAAK,CAAC,YAAY;YAChC,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,YAAY,EAAE,KAAK,CAAC,YAAY;YAChC,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,SAAS,EAAE,KAAK,CAAC,SAAS;SAC7B,CAAC,CAAC;IACP,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CACT,KAAiC,EACjC,cAA8B;QAE9B,8EAA8E;QAC9E,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC5B,KAAK,GAAG,iBAAiB,CAAC,KAAK,CAAC,KAAK,CAAsB,CAAC;QAChE,CAAC;QAED,sCAAsC;QACtC,IAAI,CAAC,CAAC,KAAK,YAAY,iBAAiB,CAAC,EAAE,CAAC;YACxC,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;QACrE,CAAC;QAED,6EAA6E;QAC7E,MAAM,SAAS,GAAG,IAAI,yBAAyB,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAC1E,MAAM,gBAAgB,GAAG,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAElD,4CAA4C;QAC5C,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC;YACnD,MAAM,WAAW,GAAG,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC;YAC5E,IAAI,CAAC,WAAW,EAAE,CAAC;gBACf,MAAM,IAAI,KAAK,CAAC,oBAAoB,UAAU,8BAA8B,CAAC,CAAC;YAClF,CAAC;QACL,CAAC;QAED,2BAA2B;QAC3B,MAAM,eAAe,GAAkB,EAAE,CAAC;QAE1C,KAAK,MAAM,CAAC,UAAU,EAAE,SAAS,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC;YACnE,MAAM,WAAW,GAAG,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC;YAC5E,IAAI,CAAC,WAAW;gBAAE,SAAS,CAAC,4CAA4C;YAExE,MAAM,SAAS,GAAG,WAAW,CAAC,KAAK,CAAC;YAEpC,qBAAqB;YACrB,IAAI,CAAC,qBAAqB,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;YAElD,2BAA2B;YAC3B,IAAI,aAA4B,CAAC;YACjC,IAAI,SAAS,CAAC,IAAI,EAAE,CAAC;gBACjB,aAAa,GAAG,aAAa,CAAC,UAAU,CAAC;YAC7C,CAAC;iBAAM,CAAC;gBACJ,aAAa,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC,iBAAiB;YAC9D,CAAC;YAED,2BAA2B;YAC3B,IAAI,aAAa,GAA8B,IAAI,CAAC;YACpD,IAAI,SAAS,CAAC,UAAU,EAAE,CAAC;gBACvB,aAAa,GAAG,kBAAkB,CAAC,KAAK,CAAC;YAC7C,CAAC;iBAAM,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC;gBAC7B,aAAa,GAAG,kBAAkB,CAAC,IAAI,CAAC;YAC5C,CAAC;YAED,qBAAqB;YACrB,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,SAAS,EAAE,aAAa,EAAE,aAAa,CAAC,CAAC;YAC7E,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACtC,CAAC;QAED,mDAAmD;QACnD,IAAI,iBAAiB,GAAqC,EAAE,CAAC;QAE7D,IAAI,KAAK,CAAC,aAAa,EAAE,CAAC;YACtB,8BAA8B;YAC9B,iBAAiB,GAAG,CAAC,GAAG,KAAK,CAAC,aAAa,CAAC,KAAK,EAAE,GAAG,eAAe,CAAC,CAAC;QAC3E,CAAC;aAAM,CAAC;YACJ,sBAAsB;YACtB,iBAAiB,GAAG,eAAe,CAAC;QACxC,CAAC;QAED,2BAA2B;QAC3B,MAAM,gBAAgB,GAAG,iBAAiB,CAAC,MAAM,GAAG,CAAC;YACjD,CAAC,CAAC,IAAI,aAAa,CAAC,iBAAiB,CAAC;YACtC,CAAC,CAAC,IAAI,CAAC;QAEX,gDAAgD;QAChD,OAAO,IAAI,iBAAiB,CAAC;YACzB,UAAU,EAAE,KAAK,CAAC,UAAU;YAC5B,YAAY,EAAE,KAAK,CAAC,YAAY;YAChC,UAAU,EAAE,KAAK,CAAC,UAAU;YAC5B,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,aAAa,EAAE,KAAK,CAAC,aAAa;YAClC,YAAY,EAAE,KAAK,CAAC,YAAY;YAChC,aAAa,EAAE,gBAAgB;YAC/B,YAAY,EAAE,KAAK,CAAC,YAAY;YAChC,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,YAAY,EAAE,KAAK,CAAC,YAAY;YAChC,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,SAAS,EAAE,KAAK,CAAC,SAAS;SAC7B,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACK,qBAAqB,CAAC,UAAkB,EAAE,SAAwB;QACtE,wCAAwC;QACxC,IAAI,SAAS,CAAC,GAAG,IAAI,SAAS,CAAC,IAAI,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,2CAA2C,UAAU,gCAAgC,CAAC,CAAC;QAC3G,CAAC;QAED,wCAAwC;QACxC,IAAI,SAAS,CAAC,UAAU,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC;YAC9C,MAAM,IAAI,KAAK,CAAC,2CAA2C,UAAU,4CAA4C,CAAC,CAAC;QACvH,CAAC;QAED,4CAA4C;QAC5C,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,UAAU,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC;YACrF,MAAM,IAAI,KAAK,CAAC,oCAAoC,UAAU,+CAA+C,CAAC,CAAC;QACnH,CAAC;IACL,CAAC;CACJ"}

package/dist/esm/types/index.d.ts

@@ -17,5 +17,7 @@ export * from './transformers/TableSourceCollector';
 export * from './transformers/UpstreamSelectQueryFinder';
 export * from './transformers/SchemaCollector';
 export * from './transformers/SqlParamInjector';
+export * from './transformers/SqlSortInjector';
+export * from './transformers/SqlPaginationInjector';
 export * from './utils/SqlSchemaValidator';
 export * from './utils/SchemaManager';

package/dist/esm/types/transformers/SqlPaginationInjector.d.ts

@@ -0,0 +1,35 @@
+import { SimpleSelectQuery } from "../models/SelectQuery";
+/**
+ * Options for pagination injection
+ */
+export interface PaginationOptions {
+    /** Page number (1-based) */
+    page: number;
+    /** Number of items per page */
+    pageSize: number;
+}
+/**
+ * SqlPaginationInjector injects pagination (LIMIT/OFFSET) into a SelectQuery model,
+ * creating LIMIT and OFFSET clauses based on provided pagination options.
+ */
+export declare class SqlPaginationInjector {
+    /**
+     * Injects pagination as LIMIT/OFFSET clauses into the given query model.
+     * @param query The SelectQuery to modify
+     * @param pagination Pagination options containing page number and page size
+     * @returns The modified SimpleSelectQuery with pagination applied
+     */
+    inject(query: SimpleSelectQuery | string, pagination: PaginationOptions): SimpleSelectQuery;
+    /**
+     * Removes LIMIT and OFFSET clauses from the given query.
+     * @param query The SelectQuery to modify
+     * @returns The modified SimpleSelectQuery with pagination removed
+     */
+    static removePagination(query: SimpleSelectQuery | string): SimpleSelectQuery;
+    /**
+     * Validates pagination options
+     * @param pagination Pagination options to validate
+     * @throws Error if validation fails
+     */
+    private validatePaginationOptions;
+}

package/dist/esm/types/transformers/SqlParamInjector.d.ts

@@ -19,11 +19,12 @@ export declare class SqlParamInjector {
      */
     inject(query: SimpleSelectQuery | string, state: Record<string, number | string | boolean | Date | null | undefined | Condition>): SelectQuery;
 }
-type Condition = {
+type BaseCondition = {
     '='?: number | string | boolean | Date;
     min?: number | string | Date;
     max?: number | string | Date;
     like?: string;
+    ilike?: string;
     in?: (number | string | Date)[];
     any?: (number | string | Date)[];
     '<'?: number | string | Date;
@@ -33,4 +34,13 @@ type Condition = {
     '<='?: number | string | Date;
     '>='?: number | string | Date;
 };
+type SingleCondition = BaseCondition & {
+    column?: string;
+};
+type LogicalCondition = {
+    column?: string;
+    and?: SingleCondition[];
+    or?: SingleCondition[];
+};
+type Condition = BaseCondition | SingleCondition | LogicalCondition;
 export {};

package/dist/esm/types/transformers/SqlSortInjector.d.ts

@@ -0,0 +1,36 @@
+import { SimpleSelectQuery } from "../models/SelectQuery";
+/**
+ * SqlSortInjector injects sort conditions into a SelectQuery model,
+ * creating ORDER BY clauses based on provided sort conditions.
+ */
+export declare class SqlSortInjector {
+    private tableColumnResolver?;
+    constructor(tableColumnResolver?: (tableName: string) => string[]);
+    /**
+     * Removes ORDER BY clause from the given query.
+     * @param query The SelectQuery to modify
+     * @returns The modified SimpleSelectQuery with ORDER BY clause removed
+     */
+    static removeOrderBy(query: SimpleSelectQuery | string): SimpleSelectQuery;
+    /**
+     * Injects sort conditions as ORDER BY clauses into the given query model.
+     * Appends to existing ORDER BY clause if present.
+     * @param query The SelectQuery to modify
+     * @param sortConditions A record of column names and sort conditions
+     * @returns The modified SimpleSelectQuery
+     */
+    inject(query: SimpleSelectQuery | string, sortConditions: SortConditions): SimpleSelectQuery;
+    /**
+     * Validates sort condition for a column
+     */
+    private validateSortCondition;
+}
+export type SortCondition = {
+    asc?: boolean;
+    desc?: boolean;
+    nullsFirst?: boolean;
+    nullsLast?: boolean;
+};
+export type SortConditions = {
+    [columnName: string]: SortCondition;
+};

package/dist/index.d.ts

@@ -17,5 +17,7 @@ export * from './transformers/TableSourceCollector';
 export * from './transformers/UpstreamSelectQueryFinder';
 export * from './transformers/SchemaCollector';
 export * from './transformers/SqlParamInjector';
+export * from './transformers/SqlSortInjector';
+export * from './transformers/SqlPaginationInjector';
 export * from './utils/SqlSchemaValidator';
 export * from './utils/SchemaManager';

package/dist/index.js

@@ -34,6 +34,8 @@ __exportStar(require("./transformers/TableSourceCollector"), exports);
 __exportStar(require("./transformers/UpstreamSelectQueryFinder"), exports);
 __exportStar(require("./transformers/SchemaCollector"), exports);
 __exportStar(require("./transformers/SqlParamInjector"), exports);
+__exportStar(require("./transformers/SqlSortInjector"), exports);
+__exportStar(require("./transformers/SqlPaginationInjector"), exports);
 __exportStar(require("./utils/SqlSchemaValidator"), exports);
 __exportStar(require("./utils/SchemaManager"), exports);
 // Add more exports here if you want to expose additional public API

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oCAAoC;AACpC,8DAA4C;AAC5C,8DAA4C;AAE5C,6DAA2C;AAC3C,uDAAqC;AACrC,0DAAwC;AACxC,uDAAqC;AAErC,8DAA4C;AAC5C,+DAA6C;AAC7C,2DAAyC;AACzC,8DAA4C;AAC5C,0EAAwD;AACxD,8DAA4C,CAAC,0BAA0B;AACvE,sEAAoD;AACpD,2EAAyD;AACzD,qEAAmD;AACnD,sEAAoD;AACpD,2EAAyD;AACzD,iEAA+C;AAC/C,kEAAgD;AAEhD,6DAA2C;AAC3C,wDAAsC;AACtC,oEAAoE"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oCAAoC;AACpC,8DAA4C;AAC5C,8DAA4C;AAE5C,6DAA2C;AAC3C,uDAAqC;AACrC,0DAAwC;AACxC,uDAAqC;AAErC,8DAA4C;AAC5C,+DAA6C;AAC7C,2DAAyC;AACzC,8DAA4C;AAC5C,0EAAwD;AACxD,8DAA4C,CAAC,0BAA0B;AACvE,sEAAoD;AACpD,2EAAyD;AACzD,qEAAmD;AACnD,sEAAoD;AACpD,2EAAyD;AACzD,iEAA+C;AAC/C,kEAAgD;AAChD,iEAA+C;AAC/C,uEAAqD;AAErD,6DAA2C;AAC3C,wDAAsC;AACtC,oEAAoE"}