@naturalcycles/db-lib 8.28.2 → 8.32.0

package/dist/commondao/common.dao.d.ts

@@ -39,6 +39,7 @@ export declare class CommonDao<BM extends Partial<ObjectWithId>, DBM extends Obj
      */
     query(table?: string): RunnableDBQuery<BM, DBM, TM>;
     runQuery(q: DBQuery<DBM>, opt?: CommonDaoOptions): Promise<Saved<BM>[]>;
+    runQuerySingleColumn<T = any>(q: DBQuery<DBM>, opt?: CommonDaoOptions): Promise<T[]>;
     /**
      * Convenience method that runs multiple queries in parallel and then merges their results together.
      * Does deduplication by id.

package/dist/commondao/common.dao.js

@@ -25,7 +25,8 @@ class CommonDao {
             // otherwise to log Operations
             // e.g in Dev (local machine), Test - it will log operations (useful for debugging)
             logLevel: isGAE || isCI ? common_dao_model_1.CommonDaoLogLevel.NONE : common_dao_model_1.CommonDaoLogLevel.OPERATIONS,
-            createdUpdated: true,
+            created: true,
+            updated: true,
             logger: console,
             ...cfg,
             hooks: {
@@ -184,6 +185,12 @@ class CommonDao {
         const { rows } = await this.runQueryExtended(q, opt);
         return rows;
     }
+    async runQuerySingleColumn(q, opt) {
+        (0, js_lib_1._assert)(q._selectedFieldNames?.length === 1, `runQuerySingleColumn requires exactly 1 column to be selected: ${q.pretty()}`);
+        const col = q._selectedFieldNames[0];
+        const { rows } = await this.runQueryExtended(q, opt);
+        return rows.map(r => r[col]);
+    }
     /**
      * Convenience method that runs multiple queries in parallel and then merges their results together.
      * Does deduplication by id.
@@ -399,9 +406,13 @@ class CommonDao {
     assignIdCreatedUpdated(obj, opt = {}) {
         const now = Math.floor(Date.now() / 1000);
         obj.id = obj.id || this.cfg.hooks.createId(obj);
-        if (this.cfg.createdUpdated) {
+        if (this.cfg.created) {
             Object.assign(obj, {
                 created: obj.created || obj.updated || now,
+            });
+        }
+        if (this.cfg.updated) {
+            Object.assign(obj, {
                 updated: opt.preserveUpdatedCreated && obj.updated ? obj.updated : now,
             });
         }

package/dist/commondao/common.dao.model.d.ts

@@ -76,10 +76,15 @@ export interface CommonDaoCfg<BM extends Partial<ObjectWithId>, DBM extends Obje
     logStarted?: boolean;
     hooks?: Partial<CommonDaoHooks<BM, DBM, TM>>;
     /**
-     * @default true
-     * Set to false to disable created/updated fields management.
+     * Defaults to true
+     * Set to false to disable `created` field management.
      */
-    createdUpdated?: boolean;
+    created?: boolean;
+    /**
+     * Defaults to true
+     * Set to false to disable `updated` field management.
+     */
+    updated?: boolean;
     /**
      * Default is false.
      * If true - will run `_filterNullishValues` inside `validateAndConvert` function

package/dist/kv/commonKeyValueDao.d.ts

@@ -33,6 +33,7 @@ export declare class CommonKeyValueDao<T> {
     createTable(opt?: CommonDBCreateOptions): Promise<void>;
     create(input?: Partial<T>): T;
     getById(id?: string): Promise<T | null>;
+    requireById(id: string): Promise<T>;
     getByIdOrEmpty(id: string, part?: Partial<T>): Promise<T>;
     patch(id: string, patch: Partial<T>): Promise<T>;
     getByIds(ids: string[]): Promise<KeyValueTuple<string, T>[]>;

package/dist/kv/commonKeyValueDao.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommonKeyValueDao = void 0;
 const js_lib_1 = require("@naturalcycles/js-lib");
 const nodejs_lib_1 = require("@naturalcycles/nodejs-lib");
+const cnst_1 = require("../cnst");
 // todo: logging
 // todo: readonly
 class CommonKeyValueDao {
@@ -26,6 +27,18 @@ class CommonKeyValueDao {
         const [r] = await this.getByIds([id]);
         return r?.[1] || null;
     }
+    async requireById(id) {
+        const [r] = await this.getByIds([id]);
+        if (!r) {
+            const { table } = this.cfg;
+            throw new js_lib_1.AppError(`DB row required, but not found: ${table}.${id}`, {
+                code: cnst_1.DBLibError.DB_ROW_REQUIRED,
+                table,
+                id,
+            });
+        }
+        return r[1];
+    }
     async getByIdOrEmpty(id, part = {}) {
         const [r] = await this.getByIds([id]);
         if (r)

package/dist/query/dbQuery.d.ts

@@ -64,12 +64,16 @@ export declare class DBQuery<ROW extends ObjectWithId = AnyObjectWithId> {
      * In undefined - all fields (*) will be returned.
      */
     _selectedFieldNames?: (keyof ROW)[];
+    _groupByFieldNames?: (keyof ROW)[];
+    _distinct: boolean;
     filter(name: keyof ROW, op: DBQueryFilterOperator, val: any): this;
     filterEq(name: keyof ROW, val: any): this;
     limit(limit: number): this;
     offset(offset: number): this;
     order(name: keyof ROW, descending?: boolean): this;
     select(fieldNames: (keyof ROW)[]): this;
+    groupBy(fieldNames: (keyof ROW)[]): this;
+    distinct(distinct?: boolean): this;
     startCursor(startCursor?: string): this;
     endCursor(endCursor?: string): this;
     clone(): DBQuery<ROW>;
@@ -86,6 +90,7 @@ export declare class RunnableDBQuery<BM extends Partial<ObjectWithId>, DBM exten
      */
     constructor(dao: CommonDao<BM, DBM, TM>, table?: string);
     runQuery(opt?: CommonDaoOptions): Promise<Saved<BM>[]>;
+    runQuerySingleColumn<T = any>(opt?: CommonDaoOptions): Promise<T[]>;
     runQueryAsDBM(opt?: CommonDaoOptions): Promise<DBM[]>;
     runQueryAsTM(opt?: CommonDaoOptions): Promise<TM[]>;
     runQueryExtended(opt?: CommonDaoOptions): Promise<RunQueryResult<Saved<BM>>>;

package/dist/query/dbQuery.js

@@ -30,6 +30,7 @@ class DBQuery {
         this._limitValue = 0; // 0 means "no limit"
         this._offsetValue = 0; // 0 means "no offset"
         this._orders = [];
+        this._distinct = false;
     }
     /**
      * Convenience method.
@@ -67,6 +68,14 @@ class DBQuery {
         this._selectedFieldNames = fieldNames;
         return this;
     }
+    groupBy(fieldNames) {
+        this._groupByFieldNames = fieldNames;
+        return this;
+    }
+    distinct(distinct = true) {
+        this._distinct = distinct;
+        return this;
+    }
     startCursor(startCursor) {
         this._startCursor = startCursor;
         return this;
@@ -82,6 +91,8 @@ class DBQuery {
             _offsetValue: this._offsetValue,
             _orders: [...this._orders],
             _selectedFieldNames: this._selectedFieldNames && [...this._selectedFieldNames],
+            _groupByFieldNames: this._groupByFieldNames && [...this._groupByFieldNames],
+            _distinct: this._distinct,
             _startCursor: this._startCursor,
             _endCursor: this._endCursor,
         });
@@ -95,9 +106,12 @@ class DBQuery {
         //   tokens.push(`"${this.name}"`)
         // }
         if (this._selectedFieldNames) {
-            tokens.push(`select(${this._selectedFieldNames.join(',')})`);
+            tokens.push(`select${this._distinct ? ' distinct' : ''}(${this._selectedFieldNames.join(',')})`);
         }
         tokens.push(...this._filters.map(f => `${f.name}${f.op}${f.val}`), ...this._orders.map(o => `order by ${o.name}${o.descending ? ' desc' : ''}`));
+        if (this._groupByFieldNames) {
+            tokens.push(`groupBy(${this._groupByFieldNames.join(',')})`);
+        }
         if (this._offsetValue) {
             tokens.push(`offset ${this._offsetValue}`);
         }
@@ -128,6 +142,9 @@ class RunnableDBQuery extends DBQuery {
     async runQuery(opt) {
         return await this.dao.runQuery(this, opt);
     }
+    async runQuerySingleColumn(opt) {
+        return await this.dao.runQuerySingleColumn(this, opt);
+    }
     async runQueryAsDBM(opt) {
         return await this.dao.runQueryAsDBM(this, opt);
     }

package/dist/testing/test.model.d.ts

@@ -17,7 +17,7 @@ export interface TestItemTM {
 export declare const testItemBMSchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<TestItemBM, TestItemBM>;
 export declare const testItemDBMSchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<TestItemDBM, TestItemDBM>;
 export declare const testItemTMSchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<TestItemTM, TestItemTM>;
-export declare const testItemBMJsonSchema: import("@naturalcycles/js-lib/dist/json-schema/jsonSchemaBuilder").JsonSchemaObjectBuilder<TestItemBM & Partial<import("@naturalcycles/js-lib").SavedDBEntity>>;
+export declare const testItemBMJsonSchema: import("@naturalcycles/js-lib/dist/json-schema/jsonSchemaBuilder").JsonSchemaObjectBuilder<TestItemBM & Partial<import("@naturalcycles/js-lib").SavedDBEntity<string>>>;
 export declare const testItemDBMJsonSchema: import("@naturalcycles/js-lib/dist/json-schema/jsonSchemaBuilder").JsonSchemaObjectBuilder<TestItemDBM>;
 export declare function createTestItemDBM(num?: number): TestItemDBM;
 export declare function createTestItemBM(num?: number): Saved<TestItemBM>;

package/dist/validation/index.d.ts

@@ -1,8 +1,8 @@
 import { CommonDBOptions, CommonDBSaveOptions } from '../db.model';
 import { DBQuery, DBQueryFilter, DBQueryOrder } from '../query/dbQuery';
 export declare const commonDBOptionsSchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<CommonDBOptions, CommonDBOptions>;
-export declare const commonDBSaveOptionsSchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<CommonDBSaveOptions<import("@naturalcycles/js-lib").AnyObjectWithId>, CommonDBSaveOptions<import("@naturalcycles/js-lib").AnyObjectWithId>>;
+export declare const commonDBSaveOptionsSchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<CommonDBSaveOptions<import("@naturalcycles/js-lib").AnyObjectWithId<string>>, CommonDBSaveOptions<import("@naturalcycles/js-lib").AnyObjectWithId<string>>>;
 export declare const dbQueryFilterOperatorSchema: import("@naturalcycles/nodejs-lib/dist/validation/joi/string.extensions").ExtendedStringSchema;
-export declare const dbQueryFilterSchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<DBQueryFilter<import("@naturalcycles/js-lib").AnyObjectWithId>, DBQueryFilter<import("@naturalcycles/js-lib").AnyObjectWithId>>;
-export declare const dbQueryOrderSchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<DBQueryOrder<import("@naturalcycles/js-lib").AnyObjectWithId>, DBQueryOrder<import("@naturalcycles/js-lib").AnyObjectWithId>>;
+export declare const dbQueryFilterSchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<DBQueryFilter<import("@naturalcycles/js-lib").AnyObjectWithId<string>>, DBQueryFilter<import("@naturalcycles/js-lib").AnyObjectWithId<string>>>;
+export declare const dbQueryOrderSchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<DBQueryOrder<import("@naturalcycles/js-lib").AnyObjectWithId<string>>, DBQueryOrder<import("@naturalcycles/js-lib").AnyObjectWithId<string>>>;
 export declare const dbQuerySchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<DBQuery<any>, DBQuery<any>>;

package/package.json

@@ -43,7 +43,7 @@
   "engines": {
     "node": ">=14.15"
   },
-  "version": "8.28.2",
+  "version": "8.32.0",
   "description": "Lowest Common Denominator API to supported Databases",
   "keywords": [
     "db",

package/src/commondao/common.dao.model.ts

@@ -102,10 +102,16 @@ export interface CommonDaoCfg<
   hooks?: Partial<CommonDaoHooks<BM, DBM, TM>>
 
   /**
-   * @default true
-   * Set to false to disable created/updated fields management.
+   * Defaults to true
+   * Set to false to disable `created` field management.
    */
-  createdUpdated?: boolean
+  created?: boolean
+
+  /**
+   * Defaults to true
+   * Set to false to disable `updated` field management.
+   */
+  updated?: boolean
 
   /**
    * Default is false.

package/src/commondao/common.dao.ts

@@ -1,4 +1,5 @@
 import {
+  _assert,
   _filterNullishValues,
   _filterUndefinedValues,
   _passthroughPredicate,
@@ -68,7 +69,8 @@ export class CommonDao<
       // otherwise to log Operations
       // e.g in Dev (local machine), Test - it will log operations (useful for debugging)
       logLevel: isGAE || isCI ? CommonDaoLogLevel.NONE : CommonDaoLogLevel.OPERATIONS,
-      createdUpdated: true,
+      created: true,
+      updated: true,
       logger: console,
       ...cfg,
       hooks: {
@@ -262,6 +264,18 @@ export class CommonDao<
     return rows
   }
 
+  async runQuerySingleColumn<T = any>(q: DBQuery<DBM>, opt?: CommonDaoOptions): Promise<T[]> {
+    _assert(
+      q._selectedFieldNames?.length === 1,
+      `runQuerySingleColumn requires exactly 1 column to be selected: ${q.pretty()}`,
+    )
+
+    const col = q._selectedFieldNames[0]!
+
+    const { rows } = await this.runQueryExtended(q, opt)
+    return rows.map(r => r[col as any])
+  }
+
   /**
    * Convenience method that runs multiple queries in parallel and then merges their results together.
    * Does deduplication by id.
@@ -549,9 +563,14 @@ export class CommonDao<
 
     obj.id = obj.id || this.cfg.hooks!.createId!(obj)
 
-    if (this.cfg.createdUpdated) {
+    if (this.cfg.created) {
       Object.assign(obj, {
         created: (obj as any).created || (obj as any).updated || now,
+      })
+    }
+
+    if (this.cfg.updated) {
+      Object.assign(obj, {
         updated: opt.preserveUpdatedCreated && (obj as any).updated ? (obj as any).updated : now,
       })
     }

package/src/kv/commonKeyValueDao.ts

@@ -1,5 +1,6 @@
-import { ErrorMode, KeyValueTuple, pMap } from '@naturalcycles/js-lib'
+import { AppError, ErrorMode, KeyValueTuple, pMap } from '@naturalcycles/js-lib'
 import { ReadableTyped, transformMap } from '@naturalcycles/nodejs-lib'
+import { DBLibError } from '../cnst'
 import { CommonDaoLogLevel } from '../commondao/common.dao.model'
 import { CommonDBCreateOptions } from '../db.model'
 import { CommonKeyValueDB, KeyValueDBTuple } from './commonKeyValueDB'
@@ -58,6 +59,21 @@ export class CommonKeyValueDao<T> {
     return r?.[1] || null
   }
 
+  async requireById(id: string): Promise<T> {
+    const [r] = await this.getByIds([id])
+
+    if (!r) {
+      const { table } = this.cfg
+      throw new AppError(`DB row required, but not found: ${table}.${id}`, {
+        code: DBLibError.DB_ROW_REQUIRED,
+        table,
+        id,
+      })
+    }
+
+    return r[1]
+  }
+
   async getByIdOrEmpty(id: string, part: Partial<T> = {}): Promise<T> {
     const [r] = await this.getByIds([id])
     if (r) return r[1]

package/src/query/dbQuery.ts

@@ -96,6 +96,8 @@ export class DBQuery<ROW extends ObjectWithId = AnyObjectWithId> {
    * In undefined - all fields (*) will be returned.
    */
   _selectedFieldNames?: (keyof ROW)[]
+  _groupByFieldNames?: (keyof ROW)[]
+  _distinct = false
 
   filter(name: keyof ROW, op: DBQueryFilterOperator, val: any): this {
     this._filters.push({ name, op, val })
@@ -130,6 +132,16 @@ export class DBQuery<ROW extends ObjectWithId = AnyObjectWithId> {
     return this
   }
 
+  groupBy(fieldNames: (keyof ROW)[]): this {
+    this._groupByFieldNames = fieldNames
+    return this
+  }
+
+  distinct(distinct = true): this {
+    this._distinct = distinct
+    return this
+  }
+
   startCursor(startCursor?: string): this {
     this._startCursor = startCursor
     return this
@@ -147,6 +159,8 @@ export class DBQuery<ROW extends ObjectWithId = AnyObjectWithId> {
       _offsetValue: this._offsetValue,
       _orders: [...this._orders],
       _selectedFieldNames: this._selectedFieldNames && [...this._selectedFieldNames],
+      _groupByFieldNames: this._groupByFieldNames && [...this._groupByFieldNames],
+      _distinct: this._distinct,
       _startCursor: this._startCursor,
       _endCursor: this._endCursor,
     })
@@ -164,7 +178,9 @@ export class DBQuery<ROW extends ObjectWithId = AnyObjectWithId> {
     // }
 
     if (this._selectedFieldNames) {
-      tokens.push(`select(${this._selectedFieldNames.join(',')})`)
+      tokens.push(
+        `select${this._distinct ? ' distinct' : ''}(${this._selectedFieldNames.join(',')})`,
+      )
     }
 
     tokens.push(
@@ -172,6 +188,10 @@ export class DBQuery<ROW extends ObjectWithId = AnyObjectWithId> {
       ...this._orders.map(o => `order by ${o.name}${o.descending ? ' desc' : ''}`),
     )
 
+    if (this._groupByFieldNames) {
+      tokens.push(`groupBy(${this._groupByFieldNames.join(',')})`)
+    }
+
     if (this._offsetValue) {
       tokens.push(`offset ${this._offsetValue}`)
     }
@@ -211,6 +231,10 @@ export class RunnableDBQuery<
     return await this.dao.runQuery(this, opt)
   }
 
+  async runQuerySingleColumn<T = any>(opt?: CommonDaoOptions): Promise<T[]> {
+    return await this.dao.runQuerySingleColumn<T>(this, opt)
+  }
+
   async runQueryAsDBM(opt?: CommonDaoOptions): Promise<DBM[]> {
     return await this.dao.runQueryAsDBM(this, opt)
   }