sql-love 0.9.5 → 0.9.6

package/CHANGELOG.md

@@ -1,10 +1,11 @@
 ## Change Log
 
-### v0.9.5 - 5 Dec 2023
+### v0.9.6 - 5 Dec 2023
 
 - Utility functions (extractGrouped, extractIndexed, getPagination, runPrisma, runMysql)
 - Added `SelectBuilder.setDefaultEngine(engine)`
 - More documentation
+- Fix `.sortField()` logic
 
 ### v0.9.4 - 30 Nov 2023
 

package/README.md

@@ -1,12 +1,12 @@
-<img alt="SQL Love Logo" src="https://github.com/kensnyder/sql-love/raw/main/assets/sql-love-logo.png?v=0.9.5" width="250" height="208" />
+<img alt="SQL Love Logo" src="https://github.com/kensnyder/sql-love/raw/main/assets/sql-love-logo.png?v=0.9.6" width="250" height="208" />
 
 # sql-love
 
-[![NPM Link](https://badgen.net/npm/v/sql-love?v=0.9.5)](https://npmjs.com/package/sql-love)
-[![Dependencies](https://badgen.net/static/dependencies/0/green?v=0.9.5)](https://npmjs.com/package/sql-love)
-[![Build Status](https://github.com/kensnyder/sql-love/actions/workflows/node.js.yml/badge.svg?v=0.9.5)](https://github.com/kensnyder/sql-love/actions)
-[![Code Coverage](https://codecov.io/gh/kensnyder/sql-love/branch/main/graph/badge.svg?v=0.9.5)](https://codecov.io/gh/kensnyder/sql-love)
-[![ISC License](https://badgen.net/static/license/ISC/green?v=0.9.5)](https://opensource.org/licenses/ISC)
+[![NPM Link](https://badgen.net/npm/v/sql-love?v=0.9.6)](https://npmjs.com/package/sql-love)
+[![Dependencies](https://badgen.net/static/dependencies/0/green?v=0.9.6)](https://npmjs.com/package/sql-love)
+[![Build Status](https://github.com/kensnyder/sql-love/actions/workflows/node.js.yml/badge.svg?v=0.9.6)](https://github.com/kensnyder/sql-love/actions)
+[![Code Coverage](https://codecov.io/gh/kensnyder/sql-love/branch/main/graph/badge.svg?v=0.9.6)](https://codecov.io/gh/kensnyder/sql-love)
+[![ISC License](https://badgen.net/static/license/ISC/green?v=0.9.6)](https://opensource.org/licenses/ISC)
 
 Classes for parsing and building SQL select queries in Node
 

package/dist/src/SelectBuilder/SelectBuilder.d.ts

@@ -342,13 +342,13 @@ export default class SelectBuilder {
     orderBy(column: string, direction?: 'ASC' | 'DESC'): this;
     /**
      * Sort by the given column, with a map of columns to translate
-     * @param column  The column name such as "created_at" or "-created_at" for descending
-     * @param [mapNames]  Column names to translate from one name to another
+     * @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
      * @example
      *   query.sortField('-modified_at'); // ORDER BY modified_at DESC
-     *   query.sortField('created_at', {'created_at': 'created'}); // ORDER BY created
+     *   query.sortField('-created', {'created': 'created_at'}); // ORDER BY created_at DESC
      */
-    sortField(column: string, mapNames?: Record<string, string>): this;
+    sortField(fieldName: string, mapNames?: Record<string, string>): this;
     /**
      * Check to see if the given string is 0 or all digits not starting with 0
      * @param string  The input string

package/dist/src/SelectBuilder/SelectBuilder.js

@@ -716,16 +716,20 @@ export default class SelectBuilder {
     }
     /**
      * Sort by the given column, with a map of columns to translate
-     * @param column  The column name such as "created_at" or "-created_at" for descending
-     * @param [mapNames]  Column names to translate from one name to another
+     * @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
      * @example
      *   query.sortField('-modified_at'); // ORDER BY modified_at DESC
-     *   query.sortField('created_at', {'created_at': 'created'}); // ORDER BY created
+     *   query.sortField('-created', {'created': 'created_at'}); // ORDER BY created_at DESC
      */
-    sortField(column, mapNames = {}) {
-        column.replace(/^-(.+)/, '$1 DESC');
-        column = mapNames[column] || column;
-        this.orderBy(column);
+    sortField(fieldName, mapNames = {}) {
+        let direction = 'ASC';
+        if (fieldName.startsWith('-')) {
+            direction = 'DESC';
+            fieldName = fieldName.slice(1);
+        }
+        const column = mapNames[fieldName] || fieldName;
+        this.orderBy(column, direction);
         return this;
     }
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sql-love",
-  "version": "0.9.5",
+  "version": "0.9.6",
   "description": "Build SQL queries with JavaScript",
   "main": "dist/index.js",
   "type": "module",

package/src/SelectBuilder/SelectBuilder.spec.ts

@@ -450,7 +450,7 @@ describe('sortField()', () => {
     const query = new SelectBuilder('SELECT * FROM posts');
     query.sortField('posts.created_at');
     const { sql, bindings } = query.compile();
-    expect(trim(sql)).toBe('SELECT * FROM posts ORDER BY posts.created_at');
+    expect(trim(sql)).toBe('SELECT * FROM posts ORDER BY posts.created_at ASC');
     expect(bindings).toEqual([]);
   });
   it('should handle minus signs', () => {
@@ -464,12 +464,12 @@ describe('sortField()', () => {
   });
   it('should handle mapping', () => {
     const query = new SelectBuilder('SELECT * FROM posts');
-    query.sortField('created_at', {
+    query.sortField('-created_at', {
       created_at: 'posts.created_timestamp',
     });
     const { sql, bindings } = query.compile();
     expect(trim(sql)).toBe(
-      'SELECT * FROM posts ORDER BY posts.created_timestamp'
+      'SELECT * FROM posts ORDER BY posts.created_timestamp DESC'
     );
     expect(bindings).toEqual([]);
   });

package/src/SelectBuilder/SelectBuilder.ts

@@ -809,16 +809,20 @@ export default class SelectBuilder {
 
   /**
    * Sort by the given column, with a map of columns to translate
-   * @param column  The column name such as "created_at" or "-created_at" for descending
-   * @param [mapNames]  Column names to translate from one name to another
+   * @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
    * @example
    *   query.sortField('-modified_at'); // ORDER BY modified_at DESC
-   *   query.sortField('created_at', {'created_at': 'created'}); // ORDER BY created
+   *   query.sortField('-created', {'created': 'created_at'}); // ORDER BY created_at DESC
    */
-  sortField(column: string, mapNames: Record<string, string> = {}) {
-    column.replace(/^-(.+)/, '$1 DESC');
-    column = mapNames[column] || column;
-    this.orderBy(column);
+  sortField(fieldName: string, mapNames: Record<string, string> = {}) {
+    let direction = 'ASC' as 'ASC' | 'DESC';
+    if (fieldName.startsWith('-')) {
+      direction = 'DESC';
+      fieldName = fieldName.slice(1);
+    }
+    const column = mapNames[fieldName] || fieldName;
+    this.orderBy(column, direction);
     return this;
   }