JSON dialect on columns and sort

Author: cblanquera

packages/inquire/package.json

@@ -69,6 +69,10 @@
       "require": "./cjs/builder/Update.js",
       "import": "./esm/builder/Update.js"
     },
+    "./Json": {
+      "require": "./cjs/dialect/Json.js",
+      "import": "./esm/dialect/Json.js"
+    },
     "./Mysql": {
       "require": "./cjs/dialect/Mysql.js",
       "import": "./esm/dialect/Mysql.js"
@@ -96,6 +100,7 @@
       "Select": [ "./cjs/builder/Select.d.ts" ],
       "Update": [ "./cjs/builder/Update.d.ts" ],
       "Mysql": [ "./cjs/dialect/Mysql.d.ts" ],
+      "Json": [ "./cjs/dialect/Json.d.ts" ],
       "Pgsql": [ "./cjs/dialect/Pgsql.d.ts" ],
       "Sqlite": [ "./cjs/dialect/Sqlite.d.ts" ]
     }

packages/inquire/src/dialect/Json.ts

@@ -0,0 +1,65 @@
+export const pattern = '([a-zA-Z0-9_]+(\\.[a-zA-Z0-9_]+)'
+  + '{0,1}%s[a-zA-Z0-9_]+(%s[a-zA-Z0-9_]+)*)';
+
+export default abstract class JsonTrait {
+  //Recommended quote character
+  public abstract q: string;
+
+  //used for json notation
+  protected _separator: string = '.';
+  protected _splitter: string = ':';
+  //jsonic pattern
+  protected _pattern = pattern
+    .replace('%s', this._splitter)
+    .replace('%s', this._separator);
+  // - ex. data:info.name
+  // - ex. profile.data:info
+  // - ex. profile.data:info.name
+  protected _replace = new RegExp(this._pattern, 'g');
+  protected _jsonic = new RegExp(`^${this._pattern}$`, 'g');
+
+  /**
+   * Returns json separator (.)
+   */
+  public get separator() {
+    return this._separator;
+  }
+
+  /**
+   * Returns json splitter (:)
+   */
+  public get splitter() {
+    return this._splitter;
+  }
+
+  /**
+   * Sets json separator and updates jsonic regex pattern
+   */
+  public set separator(separator: string) {
+    this._separator = separator;
+    this._pattern = pattern
+      .replace('%s', this._splitter)
+      .replace('%s', this._separator);
+  }
+
+  /**
+   * Sets json splitter and updates jsonic regex pattern
+   */
+  public set splitter(splitter: string) {
+    this._splitter = splitter;
+    this._pattern = pattern
+      .replace('%s', this._splitter)
+      .replace('%s', this._separator);
+  }
+  
+  protected _isJsonic(selector: string) {
+    const regexp = new RegExp(`^${this._pattern}$`, 'g');
+    return regexp.test(selector);
+  }
+
+  /**
+   * Replaces JSON selectors in the given clause 
+   * with the corresponding json sql syntax.
+   */
+  protected abstract _jsonReplace(clause: string): string;
+};

packages/inquire/src/dialect/Mysql.ts

@@ -5,6 +5,8 @@ import type Delete from '../builder/Delete.js';
 import type Insert from '../builder/Insert.js';
 import type Select from '../builder/Select.js';
 import type Update from '../builder/Update.js';
+//dialect
+import JsonTrait from './Json.js';
 //common
 import type { 
   Column,
@@ -41,25 +43,12 @@ export const typemap: Record<string, string> = {
   time: 'TIME'
 };
 
-export class MysqlDialect implements Dialect {
+export class MysqlDialect extends JsonTrait implements Dialect {
   //The name of the dialect, used for logging and error messages.
   public readonly name = 'mysql';
   //Recommended quote character
   public readonly q = q;
 
-  //used for json notation
-  public separator: string = '.';
-  public splitter: string = ':';
-  //jsonic pattern
-  // - ex. data:info.name
-  // - ex. profile.data:info
-  // - ex. profile.data:info.name
-  public jsonic = new RegExp(
-    `([a-zA-Z0-9_]+(\\.[a-zA-Z0-9_]+){0,1}\\${this.splitter}`
-    + `[a-zA-Z0-9_]+(\\${this.separator}[a-zA-Z0-9_]+)*)`, 
-    'g'
-  );
-
   /**
    * Converts alter builder to query and values
    */
@@ -489,11 +478,21 @@ export class MysqlDialect implements Dialect {
         ? `${this.q}${selector.name}${this.q}` 
         : '*';
       return selector.table && selector.alias
-        ? `${this.q}${selector.table}${this.q}.${name} AS ${this.q}${selector.alias}${this.q}`
+        ? [ 
+            `${this.q}${selector.table}${this.q}.${name}`, 
+            `${this.q}${selector.alias}${this.q}`
+          ].join(' AS ')
         : selector.table
         ? `${this.q}${selector.table}${this.q}.${name}`
+        : selector.alias && this._isJsonic(selector.name)
+        ? [
+            this._jsonReplace(selector.name),
+            `${this.q}${selector.alias}${this.q}`
+          ].join(' AS ')
         : selector.alias
         ? `${name} AS ${this.q}${selector.alias}${this.q}`
+        : this._isJsonic(selector.name)
+        ? this._jsonReplace(selector.name)
         : name
     });
 
@@ -531,22 +530,15 @@ export class MysqlDialect implements Dialect {
         filters.push(...build.where.map(filter => {
           values.push(...filter.values);
           //then replace with XJsonDialect.parse().extract
-          return filter.clause.replace(this.jsonic, match => {
-            const json = MysqlJsonDialect.parse(
-              match,
-              this.splitter,
-              this.separator
-            );
-            return json ? json.extract : match;
-          });
+          return this._jsonReplace(filter.clause);
         }));
       }
       build.json.forEach(filter => {
         const { query, replace } = filter;
         const json = MysqlJsonDialect.parse(
           filter.selector, 
-          this.splitter, 
-          this.separator
+          this._splitter, 
+          this._separator
         );
         //if invalid JSON selector, skip it
         if (!json) return;
@@ -585,15 +577,8 @@ export class MysqlDialect implements Dialect {
     if (build.sort.length) {
       const sort = build.sort.map(sort => {
         //if the sort column is using the selector ":" notation
-        if (sort.column.name.includes(this.splitter)) {
-          const json = MysqlJsonDialect.parse(
-            sort.column.name, 
-            this.splitter, 
-            this.separator
-          );
-          //if invalid JSON selector, skip it
-          if (!json) return '';
-          return `${json.extract} ${sort.direction.toUpperCase()}`;
+        if (this._isJsonic(sort.column.name)) {
+          return `${this._jsonReplace(sort.column.name)} ${sort.direction.toUpperCase()}`;
         }
         const column = sort.column.table 
           ? `${this.q}${sort.column.table}${this.q}.${this.q}${sort.column.name}${this.q}`
@@ -689,6 +674,22 @@ export class MysqlDialect implements Dialect {
     }
     return { type, length };
   }
+
+  /**
+   * Replaces JSON selectors in the given clause 
+   * with the corresponding json sql syntax.
+   */
+  protected _jsonReplace(clause: string) {
+    const regexp = new RegExp(this._pattern, 'g');
+    return clause.replace(regexp, match => {
+      const json = MysqlJsonDialect.parse(
+        match,
+        this._splitter,
+        this._separator
+      );
+      return json ? json.extract : match;
+    });
+  }
 };
 
 export class MysqlJsonDialect implements JsonDialect {