pqb 0.37.0 → 0.38.0

package/dist/index.d.ts

@@ -1501,6 +1501,9 @@ interface JsonPathQuery {
      *
      * Optionally takes `vars` and `silent` parameters, see [Postgres docs](https://www.postgresql.org/docs/current/functions-json.html) for details.
      *
+     * The `type` option sets the output type when selecting a value,
+     * also it makes specific operators available in `where`, so that you can apply `contains` if the type is text, and `gt` if the type is numeric.
+     *
      * ```ts
      * // query a single value from a JSON data,
      * // because of the provided type, string JSON value will be parsed to a Date object.
@@ -1531,6 +1534,14 @@ interface JsonPathQuery {
      *   name: (q) =>
      *     q.get('data').jsonPathQueryFirst('$.name', { type: (t) => t.string() }),
      * });
+     *
+     * // filtering records to contain 'word' in the json property "name"
+     * await db.table.where((q) =>
+     *   q
+     *     .get('data')
+     *     .jsonPathQueryFirst('$.name', { type: (t) => t.string() })
+     *     .contains('word'),
+     * );
      * ```
      *
      * @param path - JSON path
@@ -1813,9 +1824,9 @@ type WhereArg<T extends PickQueryMetaRelations> = {
  * ```
  */
 type WhereQueryBuilder<T extends PickQueryRelations> = EmptyObject extends T['relations'] ? {
-    [K in keyof T]: K extends keyof QueryBase | keyof Where | keyof ExpressionMethods | 'sql' | 'get' | 'ref' ? T[K] : never;
+    [K in keyof T]: K extends keyof QueryBase | keyof Where | keyof ExpressionMethods | 'sql' | 'get' | 'ref' | 'columnTypes' ? T[K] : never;
 } : {
-    [K in keyof T]: K extends keyof T['relations'] ? T['relations'][K] : K extends keyof QueryBase | keyof Where | keyof ExpressionMethods | 'sql' | 'get' | 'ref' ? T[K] : never;
+    [K in keyof T]: K extends keyof T['relations'] ? T['relations'][K] : K extends keyof QueryBase | keyof Where | keyof ExpressionMethods | 'sql' | 'get' | 'ref' | 'columnTypes' ? T[K] : never;
 };
 type WhereArgs<T extends PickQueryMetaRelations> = WhereArg<T>[];
 type WhereNotArgs<T extends PickQueryMetaRelations> = [WhereArg<T>];

package/dist/index.js

@@ -935,6 +935,22 @@ const quoteValue$1 = (arg, ctx, quotedAs, jsonArray) => {
   }
   return orchidCore.addValue(ctx.values, arg);
 };
+const quoteLikeValue = (arg, ctx, quotedAs, jsonArray) => {
+  if (arg && typeof arg === "object") {
+    if (!jsonArray && Array.isArray(arg)) {
+      return `(${arg.map((value) => orchidCore.addValue(ctx.values, value)).join(", ")})`;
+    }
+    if (orchidCore.isExpression(arg)) {
+      return arg.toSQL(ctx, quotedAs);
+    }
+    if ("toSQL" in arg) {
+      return `replace(replace((${getSqlText(
+        arg.toSQL({ values: ctx.values })
+      )}), '%', '\\\\%'), '_', '\\\\_')`;
+    }
+  }
+  return orchidCore.addValue(ctx.values, arg.replace(/[%_]/g, "\\$&"));
+};
 const base = {
   equals: make(
     (key, value, ctx, quotedAs) => value === null ? `${key} IS NULL` : `${key} = ${quoteValue$1(value, ctx, quotedAs)}`
@@ -980,22 +996,22 @@ const numeric = __spreadProps$9(__spreadValues$j({}, base), {
 });
 const text = __spreadProps$9(__spreadValues$j({}, base), {
   contains: make(
-    (key, value, ctx, quotedAs) => `${key} ILIKE '%' || ${quoteValue$1(value, ctx, quotedAs)} || '%'`
+    (key, value, ctx, quotedAs) => `${key} ILIKE '%' || ${quoteLikeValue(value, ctx, quotedAs)} || '%'`
   ),
   containsSensitive: make(
-    (key, value, ctx, quotedAs) => `${key} LIKE '%' || ${quoteValue$1(value, ctx, quotedAs)} || '%'`
+    (key, value, ctx, quotedAs) => `${key} LIKE '%' || ${quoteLikeValue(value, ctx, quotedAs)} || '%'`
   ),
   startsWith: make(
-    (key, value, ctx, quotedAs) => `${key} ILIKE ${quoteValue$1(value, ctx, quotedAs)} || '%'`
+    (key, value, ctx, quotedAs) => `${key} ILIKE ${quoteLikeValue(value, ctx, quotedAs)} || '%'`
   ),
   startsWithSensitive: make(
-    (key, value, ctx, quotedAs) => `${key} LIKE ${quoteValue$1(value, ctx, quotedAs)} || '%'`
+    (key, value, ctx, quotedAs) => `${key} LIKE ${quoteLikeValue(value, ctx, quotedAs)} || '%'`
   ),
   endsWith: make(
-    (key, value, ctx, quotedAs) => `${key} ILIKE '%' || ${quoteValue$1(value, ctx, quotedAs)}`
+    (key, value, ctx, quotedAs) => `${key} ILIKE '%' || ${quoteLikeValue(value, ctx, quotedAs)}`
   ),
   endsWithSensitive: make(
-    (key, value, ctx, quotedAs) => `${key} LIKE '%' || ${quoteValue$1(value, ctx, quotedAs)}`
+    (key, value, ctx, quotedAs) => `${key} LIKE '%' || ${quoteLikeValue(value, ctx, quotedAs)}`
   )
 });
 const encodeJsonPath = (ctx, path) => orchidCore.addValue(ctx.values, `{${Array.isArray(path) ? path.join(", ") : path}}`);
@@ -1009,9 +1025,10 @@ const json = __spreadProps$9(__spreadValues$j({}, base), {
         this.q.parsers[orchidCore.getValueKey] = void 0;
       }
       if (options == null ? void 0 : options.type) {
-        const parse = options.type(this.columnTypes).parseFn;
-        if (parse)
-          ((_e = (_d = this.q).parsers) != null ? _e : _d.parsers = {})[orchidCore.getValueKey] = parse;
+        const type = options.type(this.columnTypes);
+        if (type.parseFn)
+          ((_e = (_d = this.q).parsers) != null ? _e : _d.parsers = {})[orchidCore.getValueKey] = type.parseFn;
+        return setQueryOperators(this, type.operators);
       }
       return this;
     },