sql-love 1.1.1 → 1.1.4

package/dist/index.d.ts

@@ -69,17 +69,17 @@ export declare class SelectBuilder {
 	 * The LIMIT to use
 	 * @private
 	 */
-	_limit: number;
+	_limit?: number;
 	/**
 	 * The OFFSET to use
 	 * @private
 	 */
-	_offset: number;
+	_offset?: number;
 	/**
 	 * The page used to construct an OFFSET based on the LIMIT
 	 * @private
 	 */
-	_page: number;
+	_page?: number;
 	/**
 	 * Select constructor
 	 * @param [sql]  A base SQL query to parse
@@ -359,13 +359,16 @@ export declare class SelectBuilder {
 	 */
 	orderBy(column: string, direction?: "ASC" | "DESC"): this;
 	/**
-	 * Sort by the given column, with a map of columns to translate
-	 * @param fieldName  The file name such as 'created_at' or '-created_at' for descending
-	 * @param [mapNames]  Column names to translate from field to column expression
+	 * Sort by the given field, with a map of allowed fields to column expressions.
+	 * Only field names present in mapNames are allowed; anything else emits a
+	 * console.warn and adds no ORDER BY clause. This prevents SQL injection when
+	 * fieldName comes from user input.
+	 * @param fieldName  The field name such as 'created' or '-created' for descending
+	 * @param mapNames  Allowed field names mapped to column expressions
 	 * @param [modifier]  Additional clause to append such as 'NULLS LAST' or 'COLLATE "en_US"'
 	 * @example
-	 *   query.sortField('-modified_at'); // ORDER BY modified_at DESC
 	 *   query.sortField('-created', {'created': 'created_at'}); // ORDER BY created_at DESC
+	 *   query.sortField('-foo', {'created': 'created_at'}); // console.warn; no ORDER BY added
 	 *   query.sortField('-created', {
 	 *     'created': 'created_at NULLS LAST',
 	 *     '-created': 'created_at DESC NULLS LAST'
@@ -374,7 +377,7 @@ export declare class SelectBuilder {
 	 *     'name': 'name COLLATE "jp_JP"'
 	 *   }); // ORDER BY name COLLATE "jp_JP" DESC
 	 */
-	sortField(fieldName: string, mapNames?: Record<string, string>, modifier?: string): this;
+	sortField(fieldName: any, mapNames?: Record<string, string>, modifier?: string): this;
 	/**
 	 * Check to see if the given string is 0 or all digits not starting with 0
 	 * @param string  The input string
@@ -428,7 +431,7 @@ export declare class Parser {
 	 */
 	_extractSubQueries(sql: string): {
 		sql: string;
-		subQueries: {};
+		subQueries: Record<string, string>;
 	};
 	/**
 	 * Inject column subQueries back into this object
@@ -704,10 +707,10 @@ export declare function runPrismaWithCount<T extends Array<Record<string, any>>
 	records: T;
 	total: number;
 	pagination: {
-		page: number;
-		prevPage: number;
-		nextPage: number;
-		perPage: number;
+		page: number | null;
+		prevPage: number | null;
+		nextPage: number | null;
+		perPage: number | null;
 		numPages: number;
 		total: number;
 		isFirst: boolean;