pqb 0.19.0 → 0.19.1

package/dist/index.mjs

@@ -9325,6 +9325,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 +10018,8 @@ applyMixins(QueryMethods, [
   MergeQueryMethods,
   RawSqlMethods,
   CopyMethods,
-  TransformMethods
+  TransformMethods,
+  ScopeMethods
 ]);
 
 var __defProp = Object.defineProperty;
@@ -10004,10 +10062,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 +10170,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 +10333,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];
   }