pqb 0.19.0 → 0.20.0

package/dist/index.mjs

@@ -1032,38 +1032,40 @@ const windowToSql = (ctx, data, window, quotedAs) => {
 };
 
 const pushWhereStatementSql = (ctx, table, query, quotedAs) => {
-  const res = whereToSql(ctx, table, query, quotedAs, false);
+  const res = whereToSql(ctx, table, query, quotedAs);
   if (res) {
     ctx.sql.push("WHERE", res);
   }
 };
-const pushWhereToSql = (sql, ctx, table, query, quotedAs, not) => {
-  const res = whereToSql(ctx, table, query, quotedAs, not);
+const pushWhereToSql = (sql, ctx, table, query, quotedAs, parens) => {
+  const res = whereToSql(ctx, table, query, quotedAs, parens);
   if (res) {
     sql.push(res);
   }
 };
-const whereToSql = (ctx, table, query, quotedAs, not) => {
+const whereToSql = (ctx, table, query, quotedAs, parens) => {
   var _a;
+  let sql;
   if (query.or) {
     const ors = ((_a = query.and) == null ? void 0 : _a.length) ? [query.and, ...query.or] : query.or;
-    return ors.map((and) => processAnds(and, ctx, table, query, quotedAs, not)).join(" OR ");
+    sql = ors.map((and) => processAnds(and, ctx, table, query, quotedAs)).join(" OR ");
   } else if (query.and) {
-    return processAnds(query.and, ctx, table, query, quotedAs, not);
+    sql = processAnds(query.and, ctx, table, query, quotedAs);
   } else {
-    return void 0;
+    return;
   }
+  return parens ? `(${sql})` : sql;
 };
-const processAnds = (and, ctx, table, query, quotedAs, not) => {
+const processAnds = (and, ctx, table, query, quotedAs, parens) => {
   const ands = [];
   for (const data of and) {
-    processWhere(ands, ctx, table, query, data, quotedAs, not);
+    processWhere(ands, ctx, table, query, data, quotedAs);
   }
-  return ands.join(" AND ");
+  const sql = ands.join(" AND ");
+  return parens && ands.length > 1 ? `(${sql})` : sql;
 };
-const processWhere = (ands, ctx, table, query, data, quotedAs, not) => {
+const processWhere = (ands, ctx, table, query, data, quotedAs) => {
   var _a, _b;
-  const prefix = not ? "NOT " : "";
   if (typeof data === "function") {
     const qb = Object.create(table);
     qb.q = getClonedQueryData(query);
@@ -1074,9 +1076,9 @@ const processWhere = (ands, ctx, table, query, data, quotedAs, not) => {
     if (!(res instanceof Expression) && res.q.expr) {
       const q = "relationConfig" in res ? res.relationConfig.joinQuery(res, table) : res.clone();
       q.q.select = [expr];
-      ands.push(`${prefix}(${makeSQL(q, ctx).text})`);
+      ands.push(`(${makeSQL(q, ctx).text})`);
     } else {
-      pushWhereToSql(ands, ctx, res, res.q, quotedAs, not);
+      pushWhereToSql(ands, ctx, res, res.q, quotedAs, true);
     }
     return;
   }
@@ -1089,12 +1091,12 @@ const processWhere = (ands, ctx, table, query, data, quotedAs, not) => {
       query2.table && `"${query2.table}"`
     );
     if (sql) {
-      ands.push(`${prefix}(${sql})`);
+      ands.push(`(${sql})`);
     }
     return;
   }
   if (isExpression(data)) {
-    ands.push(`${prefix}(${data.toSQL(ctx, quotedAs)})`);
+    ands.push(`(${data.toSQL(ctx, quotedAs)})`);
     return;
   }
   for (const key in data) {
@@ -1103,15 +1105,15 @@ const processWhere = (ands, ctx, table, query, data, quotedAs, not) => {
       continue;
     if (key === "AND") {
       const arr = toArray(value);
-      ands.push(processAnds(arr, ctx, table, query, quotedAs, not));
+      ands.push(processAnds(arr, ctx, table, query, quotedAs));
     } else if (key === "OR") {
       const arr = value.map(toArray);
       ands.push(
-        arr.map((and) => processAnds(and, ctx, table, query, quotedAs, not)).join(" OR ")
+        arr.map((and) => processAnds(and, ctx, table, query, quotedAs)).join(" OR ")
       );
     } else if (key === "NOT") {
       const arr = toArray(value);
-      ands.push(processAnds(arr, ctx, table, query, quotedAs, !not));
+      ands.push(`NOT ${processAnds(arr, ctx, table, query, quotedAs, true)}`);
     } else if (key === "ON") {
       if (Array.isArray(value)) {
         const item = value;
@@ -1132,7 +1134,7 @@ const processWhere = (ands, ctx, table, query, data, quotedAs, not) => {
         );
         const rightPath = item[3];
         ands.push(
-          `${prefix}jsonb_path_query_first(${leftColumn}, ${addValue(
+          `jsonb_path_query_first(${leftColumn}, ${addValue(
             ctx.values,
             leftPath
           )}) = jsonb_path_query_first(${rightColumn}, ${addValue(
@@ -1172,11 +1174,11 @@ const processWhere = (ands, ctx, table, query, data, quotedAs, not) => {
             `"${joinTo}"`
           );
         }
-        ands.push(`${prefix}${leftColumn} ${op} ${rightColumn}`);
+        ands.push(`${leftColumn} ${op} ${rightColumn}`);
       }
     } else if (key === "IN") {
       toArray(value).forEach((item) => {
-        pushIn(ctx, query, ands, prefix, quotedAs, item);
+        pushIn(ctx, query, ands, quotedAs, item);
       });
     } else if (key === "EXISTS") {
       const joinItems = Array.isArray(value[0]) ? value : [value];
@@ -1188,17 +1190,15 @@ const processWhere = (ands, ctx, table, query, data, quotedAs, not) => {
           args,
           quotedAs
         );
-        ands.push(
-          `${prefix}EXISTS (SELECT 1 FROM ${target} WHERE ${conditions})`
-        );
+        ands.push(`EXISTS (SELECT 1 FROM ${target} WHERE ${conditions})`);
       }
     } else if (key === "SEARCH") {
       const search = value;
-      ands.push(`${prefix}${search.vectorSQL} @@ "${search.as}"`);
+      ands.push(`${search.vectorSQL} @@ "${search.as}"`);
     } else if (typeof value === "object" && value && !(value instanceof Date)) {
       if (isExpression(value)) {
         ands.push(
-          `${prefix}${columnToSql(
+          `${columnToSql(
             ctx,
             query,
             query.shape,
@@ -1227,9 +1227,7 @@ const processWhere = (ands, ctx, table, query, data, quotedAs, not) => {
           }
         }
         if (value instanceof ctx.queryBuilder.constructor) {
-          ands.push(
-            `${prefix}${quotedColumn} = (${value.toSQL(ctx).text})`
-          );
+          ands.push(`${quotedColumn} = (${value.toSQL(ctx).text})`);
         } else {
           for (const op in value) {
             const operator = column.operators[op];
@@ -1239,7 +1237,7 @@ const processWhere = (ands, ctx, table, query, data, quotedAs, not) => {
             if (value[op] === void 0)
               continue;
             ands.push(
-              `${prefix}${operator._op(
+              `${operator._op(
                 quotedColumn,
                 value[op],
                 ctx,
@@ -1251,7 +1249,7 @@ const processWhere = (ands, ctx, table, query, data, quotedAs, not) => {
       }
     } else {
       ands.push(
-        `${prefix}${columnToSql(ctx, query, query.shape, key, quotedAs)} ${value === null ? "IS NULL" : `= ${addValue(ctx.values, value)}`}`
+        `${columnToSql(ctx, query, query.shape, key, quotedAs)} ${value === null ? "IS NULL" : `= ${addValue(ctx.values, value)}`}`
       );
     }
   }
@@ -1259,7 +1257,7 @@ const processWhere = (ands, ctx, table, query, data, quotedAs, not) => {
 const getJoinItemSource = (joinItem) => {
   return typeof joinItem === "string" ? joinItem : getQueryAs(joinItem);
 };
-const pushIn = (ctx, query, ands, prefix, quotedAs, arg) => {
+const pushIn = (ctx, query, ands, quotedAs, arg) => {
   const multiple = arg.columns.length > 1;
   let value;
   if (Array.isArray(arg.values)) {
@@ -1274,9 +1272,7 @@ const pushIn = (ctx, query, ands, prefix, quotedAs, arg) => {
     value = `(${sql.text})`;
   }
   const columnsSql = arg.columns.map((column) => columnToSql(ctx, query, query.shape, column, quotedAs)).join(", ");
-  ands.push(
-    `${prefix}${multiple ? `(${columnsSql})` : columnsSql} IN ${value}`
-  );
+  ands.push(`${multiple ? `(${columnsSql})` : columnsSql} IN ${value}`);
 };
 
 var __defProp$e = Object.defineProperty;
@@ -6524,7 +6520,6 @@ const addOrNot = (q, args) => {
   );
 };
 const addWhereIn = (q, and, arg, values, not) => {
-  const op = not ? "notIn" : "in";
   let item;
   if (values) {
     if (Array.isArray(arg)) {
@@ -6534,17 +6529,17 @@ const addWhereIn = (q, and, arg, values, not) => {
           values
         }
       };
-      if (not)
-        item = { NOT: item };
     } else {
-      item = { [arg]: { [op]: values } };
+      item = { [arg]: { in: values } };
     }
   } else {
     item = {};
     for (const key in arg) {
-      item[key] = { [op]: arg[key] };
+      item[key] = { in: arg[key] };
     }
   }
+  if (not)
+    item = { NOT: item };
   if (and) {
     pushQueryValue(q, "and", item);
   } else {
@@ -9325,6 +9320,63 @@ const noneMethods = {
   catch: () => new Promise(noop)
 };
 
+class ScopeMethods {
+  /**
+   * See {@link ScopeMethods}
+   *
+   * Use the `scope` method to apply a pre-defined scope.
+   *
+   * ```ts
+   * // use the `active` scope that is defined in the table:
+   * await db.some.scope('active');
+   * ```
+   *
+   * @param scope - name of the scope to apply
+   */
+  scope(scope) {
+    var _a;
+    const q = this.clone();
+    if (!((_a = q.q.scopes) == null ? void 0 : _a[scope])) {
+      const s = this.internal.scopes[scope];
+      if (s.and)
+        pushQueryArray(q, "and", s.and);
+      if (s.or)
+        pushQueryArray(q, "or", s.or);
+      setQueryObjectValue(q, "scopes", scope, s);
+    }
+    return q;
+  }
+  /**
+   * See {@link ScopeMethods}
+   *
+   * Remove conditions that were added by the scope from the query.
+   *
+   * ```ts
+   * // SomeTable has a default scope, ignore it for this query:
+   * await db.some.unScope('default');
+   * ```
+   *
+   * @param scope - name of the scope to remove from the query
+   */
+  unScope(scope) {
+    var _a;
+    const q = this.clone();
+    const data = q.q;
+    const s = (_a = q.q.scopes) == null ? void 0 : _a[scope];
+    if (s) {
+      const { and, or } = s;
+      if (and) {
+        data.and = data.and.filter((x) => !and.includes(x));
+      }
+      if (or) {
+        data.or = data.or.filter((x) => !or.includes(x));
+      }
+      delete q.q.scopes[scope];
+    }
+    return q;
+  }
+}
+
 class ColumnRefExpression extends Expression {
   constructor(_type, name) {
     super();
@@ -9961,7 +10013,8 @@ applyMixins(QueryMethods, [
   MergeQueryMethods,
   RawSqlMethods,
   CopyMethods,
-  TransformMethods
+  TransformMethods,
+  ScopeMethods
 ]);
 
 var __defProp = Object.defineProperty;
@@ -10004,10 +10057,12 @@ class Db {
     this.shape = shape;
     this.columnTypes = columnTypes2;
     var _a, _b;
-    const tableData = getTableData();
     const self = this;
+    const scopes = options.scopes ? {} : emptyObject;
+    const tableData = getTableData();
     this.internal = __spreadProps(__spreadValues({}, tableData), {
-      transactionStorage
+      transactionStorage,
+      scopes
     });
     this.baseQuery = this;
     const logger = options.logger || console;
@@ -10110,6 +10165,21 @@ class Db {
         super(self, message);
       }
     };
+    if (options.scopes) {
+      for (const key in options.scopes) {
+        const q = options.scopes[key](this).q;
+        const s = {};
+        if (q.and)
+          s.and = q.and;
+        if (q.or)
+          s.or = q.or;
+        scopes[key] = s;
+      }
+      if (scopes.default) {
+        Object.assign(this.q, scopes.default);
+        this.q.scopes = { default: scopes.default };
+      }
+    }
   }
   [inspect.custom]() {
     return `QueryObject<${this.table}>`;
@@ -10258,21 +10328,19 @@ const createDb = (_a) => {
     commonOptions
   );
   qb.queryBuilder = qb;
-  const db = Object.assign(
-    (table, shape, options2) => {
-      return new Db(
-        adapter,
-        qb,
-        table,
-        typeof shape === "function" ? getColumnTypes(ct, shape, nowSQL, options2 == null ? void 0 : options2.language) : shape,
-        ct,
-        transactionStorage,
-        __spreadValues(__spreadValues({}, commonOptions), options2)
-      );
-    },
+  const tableConstructor = (table, shape, options2) => new Db(
+    adapter,
     qb,
-    { adapter, close: () => adapter.close() }
+    table,
+    typeof shape === "function" ? getColumnTypes(ct, shape, nowSQL, options2 == null ? void 0 : options2.language) : shape,
+    ct,
+    transactionStorage,
+    __spreadValues(__spreadValues({}, commonOptions), options2)
   );
+  const db = Object.assign(tableConstructor, qb, {
+    adapter,
+    close: () => adapter.close()
+  });
   for (const name of Object.getOwnPropertyNames(Db.prototype)) {
     db[name] = Db.prototype[name];
   }