@sqb/builder 4.23.3 → 4.24.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sqb/builder",
   "description": "Extensible multi-dialect SQL query builder written with TypeScript",
-  "version": "4.23.3",
+  "version": "4.24.1",
   "author": "Panates",
   "license": "Apache-2.0",
   "dependencies": {

package/query/query.d.ts

@@ -4,6 +4,8 @@ import { GenerateOptions, GenerateResult } from '../types.js';
 export declare interface Query extends EventEmitter {
 }
 export declare abstract class Query extends Serializable {
+    protected _comment?: string;
+    protected _commentDialect?: string[];
     protected _params?: Record<string, any>;
     constructor();
     /**
@@ -11,4 +13,5 @@ export declare abstract class Query extends Serializable {
      */
     generate(options?: GenerateOptions): GenerateResult;
     values(obj: any): this;
+    comment(text: string, dialect?: string[]): this;
 }

package/query/query.js

@@ -4,6 +4,8 @@ import merge from 'putil-merge';
 import { Serializable } from '../serializable.js';
 import { SerializeContext } from '../serialize-context.js';
 export class Query extends Serializable {
+    _comment;
+    _commentDialect;
     _params;
     constructor() {
         super();
@@ -13,14 +15,22 @@ export class Query extends Serializable {
      * Generates Sql script
      */
     generate(options) {
-        const ctx = new SerializeContext(options);
+        const ctx = new SerializeContext(this, options);
         if (this._params)
             ctx.params = { ...ctx.params, ...this._params };
         ctx.serializeHooks = this.listeners('serialize');
         /* generate output */
-        const sql = this._serialize(ctx);
+        let sql = this._serialize(ctx);
+        sql = flattenText(sql, { noWrap: !ctx.prettyPrint });
+        if (this._comment &&
+            (!ctx.dialect ||
+                !this._commentDialect ||
+                this._commentDialect.includes(ctx.dialect))) {
+            const lines = '-- ' + this._comment.split('\n').join('\n-- ') + '\n';
+            sql = lines + sql;
+        }
         return {
-            sql: flattenText(sql, { noWrap: !ctx.prettyPrint }),
+            sql,
             params: ctx.preparedParams,
             paramOptions: ctx.paramOptions,
             returningFields: ctx.returningFields,
@@ -32,5 +42,10 @@ export class Query extends Serializable {
         this._params = obj;
         return this;
     }
+    comment(text, dialect) {
+        this._comment = text;
+        this._commentDialect = dialect;
+        return this;
+    }
 }
 merge(Query.prototype, EventEmitter.prototype, { descriptor: true });

package/serialize-context.d.ts

@@ -1,5 +1,7 @@
+import type { Query } from './query/query.js';
 import { DefaultSerializeFunction, GenerateOptions, ParamOptions } from './types.js';
 export declare class SerializeContext implements GenerateOptions {
+    readonly rootQuery: Query;
     readonly reservedWords: string[];
     dialect?: string;
     prettyPrint?: boolean;
@@ -14,7 +16,7 @@ export declare class SerializeContext implements GenerateOptions {
         alias?: string;
     }[];
     strictParamGenId?: number;
-    constructor(opts?: GenerateOptions);
+    constructor(rootQuery: Query, opts?: GenerateOptions);
     /**
      * Performs a fallback mechanism, tries hook functions, extensions than default function to serialize
      */

package/serialize-context.js

@@ -3,6 +3,7 @@ import { SerializerRegistry } from './extensions.js';
 import { Serializable } from './serializable.js';
 import { isLogicalOperator, isQuery, isSerializable } from './typeguards.js';
 export class SerializeContext {
+    rootQuery;
     reservedWords = [
         'schema',
         'table',
@@ -71,7 +72,8 @@ export class SerializeContext {
     preparedParams;
     returningFields;
     strictParamGenId;
-    constructor(opts) {
+    constructor(rootQuery, opts) {
+        this.rootQuery = rootQuery;
         if (opts)
             Object.assign(this, opts);
     }