@naturalcycles/mysql-lib 3.14.6 → 3.14.7

package/dist/mysql.db.d.ts

@@ -1,10 +1,10 @@
 import { DBPatch, BaseCommonDB, CommonDB, CommonDBCreateOptions, CommonDBOptions, CommonDBSaveOptions, DBQuery, RunQueryResult, CommonDBSupport, CommonDBType } from '@naturalcycles/db-lib';
-import { AnyPartialObjectWithId, CommonLogger, JsonSchemaObject, JsonSchemaRootObject, PartialObjectWithId, Saved } from '@naturalcycles/js-lib';
+import { CommonLogger, JsonSchemaObject, JsonSchemaRootObject, ObjectWithId } from '@naturalcycles/js-lib';
 import { ReadableTyped } from '@naturalcycles/nodejs-lib';
 import { Connection, Pool, PoolConfig, PoolConnection, QueryOptions } from 'mysql';
 export interface MysqlDBOptions extends CommonDBOptions {
 }
-export interface MysqlDBSaveOptions<ROW extends PartialObjectWithId = AnyPartialObjectWithId> extends CommonDBSaveOptions<ROW> {
+export interface MysqlDBSaveOptions<ROW extends ObjectWithId> extends CommonDBSaveOptions<ROW> {
 }
 /**
  * @default false / undefined
@@ -42,22 +42,22 @@ export declare class MysqlDB extends BaseCommonDB implements CommonDB {
      * Be careful to manage this connection yourself (open, release, etc).
      */
     createSingleConnection(): Promise<Connection>;
-    getByIds<ROW extends PartialObjectWithId>(table: string, ids: string[], opt?: MysqlDBOptions): Promise<Saved<ROW>[]>;
-    runQuery<ROW extends PartialObjectWithId>(q: DBQuery<ROW>, _opt?: MysqlDBOptions): Promise<RunQueryResult<Saved<ROW>>>;
+    getByIds<ROW extends ObjectWithId>(table: string, ids: string[], opt?: MysqlDBOptions): Promise<ROW[]>;
+    runQuery<ROW extends ObjectWithId>(q: DBQuery<ROW>, _opt?: MysqlDBOptions): Promise<RunQueryResult<ROW>>;
     runSQL<RESULT>(q: QueryOptions): Promise<RESULT>;
     /**
      * Allows to run semicolon-separated "SQL file".
      * E.g "ddl reset script".
      */
     runSQLString(s: string): Promise<void>;
-    runQueryCount<ROW extends PartialObjectWithId>(q: DBQuery<ROW>, _opt?: CommonDBOptions): Promise<number>;
-    streamQuery<ROW extends PartialObjectWithId>(q: DBQuery<ROW>, _opt?: MysqlDBOptions): ReadableTyped<Saved<ROW>>;
-    saveBatch<ROW extends PartialObjectWithId>(table: string, rowsInput: ROW[], opt?: MysqlDBSaveOptions<ROW>): Promise<void>;
+    runQueryCount<ROW extends ObjectWithId>(q: DBQuery<ROW>, _opt?: CommonDBOptions): Promise<number>;
+    streamQuery<ROW extends ObjectWithId>(q: DBQuery<ROW>, _opt?: MysqlDBOptions): ReadableTyped<ROW>;
+    saveBatch<ROW extends ObjectWithId>(table: string, rowsInput: ROW[], opt?: MysqlDBSaveOptions<ROW>): Promise<void>;
     /**
      * Limitation: always returns [], regardless of which rows are actually deleted
      */
     deleteByIds(table: string, ids: string[], _opt?: MysqlDBOptions): Promise<number>;
-    deleteByQuery<ROW extends PartialObjectWithId>(q: DBQuery<ROW>, _opt?: CommonDBOptions): Promise<number>;
+    deleteByQuery<ROW extends ObjectWithId>(q: DBQuery<ROW>, _opt?: CommonDBOptions): Promise<number>;
     /**
      * Use with caution!
      */
@@ -65,8 +65,8 @@ export declare class MysqlDB extends BaseCommonDB implements CommonDB {
     /**
      * dropIfExists=true needed as a safety check
      */
-    createTable<ROW extends PartialObjectWithId>(table: string, schema: JsonSchemaObject<ROW>, opt?: CommonDBCreateOptions): Promise<void>;
+    createTable<ROW extends ObjectWithId>(table: string, schema: JsonSchemaObject<ROW>, opt?: CommonDBCreateOptions): Promise<void>;
     getTables(): Promise<string[]>;
-    getTableSchema<ROW extends PartialObjectWithId>(table: string): Promise<JsonSchemaRootObject<ROW>>;
-    updateByQuery<ROW extends PartialObjectWithId>(q: DBQuery<ROW>, patch: DBPatch<ROW>): Promise<number>;
+    getTableSchema<ROW extends ObjectWithId>(table: string): Promise<JsonSchemaRootObject<ROW>>;
+    updateByQuery<ROW extends ObjectWithId>(q: DBQuery<ROW>, patch: DBPatch<ROW>): Promise<number>;
 }

package/package.json

@@ -36,7 +36,7 @@
   "engines": {
     "node": ">=16.15.0"
   },
-  "version": "3.14.6",
+  "version": "3.14.7",
   "description": "MySQL client implementing CommonDB interface",
   "keywords": [
     "mysql",

package/src/mysql.db.ts

@@ -20,13 +20,11 @@ import {
   _mapValues,
   _Memo,
   _omit,
-  AnyPartialObjectWithId,
   CommonLogger,
   commonLoggerPrefix,
   JsonSchemaObject,
   JsonSchemaRootObject,
-  PartialObjectWithId,
-  Saved,
+  ObjectWithId,
 } from '@naturalcycles/js-lib'
 import { ReadableTyped, white } from '@naturalcycles/nodejs-lib'
 import {
@@ -48,8 +46,7 @@ import {
 } from './schema/mysql.schema.util'
 
 export interface MysqlDBOptions extends CommonDBOptions {}
-export interface MysqlDBSaveOptions<ROW extends PartialObjectWithId = AnyPartialObjectWithId>
-  extends CommonDBSaveOptions<ROW> {}
+export interface MysqlDBSaveOptions<ROW extends ObjectWithId> extends CommonDBSaveOptions<ROW> {}
 
 /**
  * @default false / undefined
@@ -196,11 +193,11 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
   }
 
   // GET
-  override async getByIds<ROW extends PartialObjectWithId>(
+  override async getByIds<ROW extends ObjectWithId>(
     table: string,
     ids: string[],
     opt: MysqlDBOptions = {},
-  ): Promise<Saved<ROW>[]> {
+  ): Promise<ROW[]> {
     if (!ids.length) return []
     const q = new DBQuery<ROW>(table).filterEq('id', ids)
     const { rows } = await this.runQuery(q, opt)
@@ -208,10 +205,10 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
   }
 
   // QUERY
-  override async runQuery<ROW extends PartialObjectWithId>(
+  override async runQuery<ROW extends ObjectWithId>(
     q: DBQuery<ROW>,
     _opt: MysqlDBOptions = {},
-  ): Promise<RunQueryResult<Saved<ROW>>> {
+  ): Promise<RunQueryResult<ROW>> {
     const sql = dbQueryToSQLSelect(q)
     if (!sql) {
       return {
@@ -261,7 +258,7 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
     }
   }
 
-  override async runQueryCount<ROW extends PartialObjectWithId>(
+  override async runQueryCount<ROW extends ObjectWithId>(
     q: DBQuery<ROW>,
     _opt?: CommonDBOptions,
   ): Promise<number> {
@@ -269,10 +266,10 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
     return (rows[0] as any)._count
   }
 
-  override streamQuery<ROW extends PartialObjectWithId>(
+  override streamQuery<ROW extends ObjectWithId>(
     q: DBQuery<ROW>,
     _opt: MysqlDBOptions = {},
-  ): ReadableTyped<Saved<ROW>> {
+  ): ReadableTyped<ROW> {
     const sql = dbQueryToSQLSelect(q)
     if (!sql) {
       return Readable.from([])
@@ -295,7 +292,7 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
   }
 
   // SAVE
-  override async saveBatch<ROW extends PartialObjectWithId>(
+  override async saveBatch<ROW extends ObjectWithId>(
     table: string,
     rowsInput: ROW[],
     opt: MysqlDBSaveOptions<ROW> = {},
@@ -373,7 +370,7 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
     return affectedRows
   }
 
-  override async deleteByQuery<ROW extends PartialObjectWithId>(
+  override async deleteByQuery<ROW extends ObjectWithId>(
     q: DBQuery<ROW>,
     _opt?: CommonDBOptions,
   ): Promise<number> {
@@ -393,7 +390,7 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
   /**
    * dropIfExists=true needed as a safety check
    */
-  override async createTable<ROW extends PartialObjectWithId>(
+  override async createTable<ROW extends ObjectWithId>(
     table: string,
     schema: JsonSchemaObject<ROW>,
     opt: CommonDBCreateOptions = {},
@@ -410,7 +407,7 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
       .filter(Boolean)
   }
 
-  override async getTableSchema<ROW extends PartialObjectWithId>(
+  override async getTableSchema<ROW extends ObjectWithId>(
     table: string,
   ): Promise<JsonSchemaRootObject<ROW>> {
     const stats = await this.runSQL<MySQLTableStats[]>({
@@ -420,7 +417,7 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
     return mysqlTableStatsToJsonSchemaField<ROW>(table, stats, this.cfg.logger)
   }
 
-  override async updateByQuery<ROW extends PartialObjectWithId>(
+  override async updateByQuery<ROW extends ObjectWithId>(
     q: DBQuery<ROW>,
     patch: DBPatch<ROW>,
   ): Promise<number> {

package/src/query.util.ts

@@ -1,5 +1,5 @@
 import { DBQuery, DBQueryFilterOperator } from '@naturalcycles/db-lib'
-import { _hb, CommonLogger } from '@naturalcycles/js-lib'
+import { _hb, AnyObjectWithId, CommonLogger } from '@naturalcycles/js-lib'
 import { white, yellow } from '@naturalcycles/nodejs-lib'
 import { QueryOptions } from 'mysql'
 import * as mysql from 'mysql'
@@ -160,7 +160,7 @@ export function dbQueryToSQLUpdate(q: DBQuery<any>, record: Record<any, any>): s
   return mysql.format(tokens.join(' '), Object.values(record))
 }
 
-function selectTokens(q: DBQuery): string[] {
+function selectTokens(q: DBQuery<any>): string[] {
   let fields = ['*']
 
   if (q._selectedFieldNames) {
@@ -192,7 +192,7 @@ function offsetLimitTokens(q: DBQuery<any>): string[] {
   return tokens
 }
 
-function groupOrderTokens(q: DBQuery): string[] {
+function groupOrderTokens(q: DBQuery<AnyObjectWithId>): string[] {
   const t: string[] = []
 
   if (q._groupByFieldNames?.length) {
@@ -216,7 +216,7 @@ const OP_MAP: Partial<Record<DBQueryFilterOperator, string>> = {
 /**
  * Returns `null` for "guaranteed 0 rows" cases.
  */
-function getWhereTokens(q: DBQuery): string[] | null {
+function getWhereTokens(q: DBQuery<any>): string[] | null {
   if (!q._filters.length) return []
 
   let returnNull = false