pqb 0.40.2 → 0.40.4

package/dist/index.d.ts

@@ -6567,7 +6567,7 @@ declare class QueryUpsertOrCreate {
      *
      * ```ts
      * await User.selectAll()
-     *   .find({ email: 'some@email.com' })
+     *   .findBy({ email: 'some@email.com' })
      *   .upsert({
      *     data: {
      *       // update record's name
@@ -6581,7 +6581,7 @@ declare class QueryUpsertOrCreate {
      *
      * // the same as above but using `update` and `create`
      * await User.selectAll()
-     *   .find({ email: 'some@email.com' })
+     *   .findBy({ email: 'some@email.com' })
      *   .upsert({
      *     update: {
      *       name: 'updated user',
@@ -6598,7 +6598,7 @@ declare class QueryUpsertOrCreate {
      *
      * ```ts
      * await User.selectAll()
-     *   .find({ email: 'some@email.com' })
+     *   .findBy({ email: 'some@email.com' })
      *   .upsert({
      *     update: {
      *       name: 'updated user',
@@ -6611,7 +6611,7 @@ declare class QueryUpsertOrCreate {
      *
      * // the same as above using `data`
      * await User.selectAll()
-     *   .find({ email: 'some@email.com' })
+     *   .findBy({ email: 'some@email.com' })
      *   .upsert({
      *     data: {
      *       name: 'updated user',
@@ -6628,7 +6628,7 @@ declare class QueryUpsertOrCreate {
      *
      * ```ts
      * const user = await User.selectAll()
-     *   .find({ email: 'some@email.com' })
+     *   .findBy({ email: 'some@email.com' })
      *   .upsert({
      *     data: {
      *       name: 'updated user',
@@ -6661,17 +6661,19 @@ declare class QueryUpsertOrCreate {
      * By default, it is not returning columns, place `get`, `select`, or `selectAll` before `orCreate` to specify returning columns.
      *
      * ```ts
-     * const user = await User.selectAll().find({ email: 'some@email.com' }).orCreate({
-     *   email: 'some@email.com',
-     *   name: 'created user',
-     * });
+     * const user = await User.selectAll()
+     *   .findBy({ email: 'some@email.com' })
+     *   .orCreate({
+     *     email: 'some@email.com',
+     *     name: 'created user',
+     *   });
      * ```
      *
      * The data may be returned from a function, it won't be called if the record was found:
      *
      * ```ts
      * const user = await User.selectAll()
-     *   .find({ email: 'some@email.com' })
+     *   .findBy({ email: 'some@email.com' })
      *   .orCreate(() => ({
      *     email: 'some@email.com',
      *     name: 'created user',
@@ -6748,11 +6750,11 @@ declare class QueryMap {
     /**
      * Use `map` to transform individual records of a query result.
      *
-     * It accepts a single record and should return a single transformed record.
+     * Use `map` to transform individual records of a query result. If the query returns multiple, `map` function going to transform records one by one.
      *
-     * For transforming the whole result of a query, consider using [transform](#transform) instead.
+     * For an optional query result (`findOptional`, `getOptional`, etc.), `map` is **not** called for empty results.
      *
-     * The [hooks](/guide/hooks) that are going to run after the query will receive the query result **before** transformation.
+     * For transforming the result of a query as a whole, consider using {@link Query.transform} instead.
      *
      * ```ts
      * // add a `titleLength` to every post
@@ -6785,10 +6787,18 @@ declare class QueryMap {
      *
      * @param fn - function to transform an individual record
      */
-    map<T extends Query, Result extends RecordUnknown>(this: T, fn: (input: T['returnType'] extends undefined | 'all' ? T['then'] extends QueryThen<(infer Data)[]> ? Data : never : T['then'] extends QueryThen<infer Data> ? Data : never) => Result): {
+    map<T extends Query, Result>(this: T, fn: (input: T['returnType'] extends undefined | 'all' | 'pluck' ? T['then'] extends QueryThen<(infer Data)[]> ? Data : never : T['then'] extends QueryThen<infer Data | undefined> ? Data : never) => Result): Result extends RecordUnknown ? {
         [K in keyof T]: K extends 'result' ? {
             [K in keyof Result]: QueryColumn<Result[K]>;
         } : K extends 'then' ? QueryThen<T['returnType'] extends undefined | 'all' ? Result[] : Result> : T[K];
+    } : {
+        [K in keyof T]: K extends 'returnType' ? T['returnType'] extends undefined | 'all' | 'pluck' ? 'pluck' : T['returnType'] extends 'one' ? 'value' : 'valueOrThrow' : K extends 'result' ? T['returnType'] extends undefined | 'all' | 'pluck' ? {
+            pluck: QueryColumn<Result>;
+        } : T['returnType'] extends 'one' | 'value' ? {
+            value: QueryColumn<Result | undefined>;
+        } : {
+            value: QueryColumn<Result>;
+        } : K extends 'then' ? QueryThen<T['returnType'] extends undefined | 'all' | 'pluck' ? Result[] : Result> : T[K];
     };
 }
 

package/dist/index.js

@@ -6383,7 +6383,9 @@ const makeColumnsByType = (schema) => {
     jsonb: schema.json,
     smallserial: t.smallSerial,
     serial: t.serial,
-    bigserial: t.bigSerial
+    bigserial: t.bigSerial,
+    // requires citext extension
+    citext: t.citext
   };
 };
 
@@ -11159,7 +11161,7 @@ class QueryUpsertOrCreate {
    *
    * ```ts
    * await User.selectAll()
-   *   .find({ email: 'some@email.com' })
+   *   .findBy({ email: 'some@email.com' })
    *   .upsert({
    *     data: {
    *       // update record's name
@@ -11173,7 +11175,7 @@ class QueryUpsertOrCreate {
    *
    * // the same as above but using `update` and `create`
    * await User.selectAll()
-   *   .find({ email: 'some@email.com' })
+   *   .findBy({ email: 'some@email.com' })
    *   .upsert({
    *     update: {
    *       name: 'updated user',
@@ -11190,7 +11192,7 @@ class QueryUpsertOrCreate {
    *
    * ```ts
    * await User.selectAll()
-   *   .find({ email: 'some@email.com' })
+   *   .findBy({ email: 'some@email.com' })
    *   .upsert({
    *     update: {
    *       name: 'updated user',
@@ -11203,7 +11205,7 @@ class QueryUpsertOrCreate {
    *
    * // the same as above using `data`
    * await User.selectAll()
-   *   .find({ email: 'some@email.com' })
+   *   .findBy({ email: 'some@email.com' })
    *   .upsert({
    *     data: {
    *       name: 'updated user',
@@ -11220,7 +11222,7 @@ class QueryUpsertOrCreate {
    *
    * ```ts
    * const user = await User.selectAll()
-   *   .find({ email: 'some@email.com' })
+   *   .findBy({ email: 'some@email.com' })
    *   .upsert({
    *     data: {
    *       name: 'updated user',
@@ -11260,17 +11262,19 @@ class QueryUpsertOrCreate {
    * By default, it is not returning columns, place `get`, `select`, or `selectAll` before `orCreate` to specify returning columns.
    *
    * ```ts
-   * const user = await User.selectAll().find({ email: 'some@email.com' }).orCreate({
-   *   email: 'some@email.com',
-   *   name: 'created user',
-   * });
+   * const user = await User.selectAll()
+   *   .findBy({ email: 'some@email.com' })
+   *   .orCreate({
+   *     email: 'some@email.com',
+   *     name: 'created user',
+   *   });
    * ```
    *
    * The data may be returned from a function, it won't be called if the record was found:
    *
    * ```ts
    * const user = await User.selectAll()
-   *   .find({ email: 'some@email.com' })
+   *   .findBy({ email: 'some@email.com' })
    *   .orCreate(() => ({
    *     email: 'some@email.com',
    *     name: 'created user',
@@ -11371,11 +11375,11 @@ class QueryMap {
   /**
    * Use `map` to transform individual records of a query result.
    *
-   * It accepts a single record and should return a single transformed record.
+   * Use `map` to transform individual records of a query result. If the query returns multiple, `map` function going to transform records one by one.
    *
-   * For transforming the whole result of a query, consider using [transform](#transform) instead.
+   * For an optional query result (`findOptional`, `getOptional`, etc.), `map` is **not** called for empty results.
    *
-   * The [hooks](/guide/hooks) that are going to run after the query will receive the query result **before** transformation.
+   * For transforming the result of a query as a whole, consider using {@link Query.transform} instead.
    *
    * ```ts
    * // add a `titleLength` to every post