@naturalcycles/db-lib 8.14.0 → 8.16.2

package/CHANGELOG.md

@@ -1,3 +1,31 @@
+## [8.16.2](https://github.com/NaturalCycles/db-lib/compare/v8.16.1...v8.16.2) (2021-10-04)
+
+
+### Bug Fixes
+
+* unnecessary await ([11282ba](https://github.com/NaturalCycles/db-lib/commit/11282ba44982c174b1b9eeb052c911c30ee22076))
+
+## [8.16.1](https://github.com/NaturalCycles/db-lib/compare/v8.16.0...v8.16.1) (2021-10-04)
+
+
+### Bug Fixes
+
+* use JsonSchemaRootObject type ([f938b62](https://github.com/NaturalCycles/db-lib/commit/f938b624e9fee61732efb4dc2dd53074dc16977b))
+
+# [8.16.0](https://github.com/NaturalCycles/db-lib/compare/v8.15.0...v8.16.0) (2021-10-04)
+
+
+### Features
+
+* getTableSchema to enforce non-optional $id ([a147627](https://github.com/NaturalCycles/db-lib/commit/a147627d18c3323b63de7f617068c9b3e2517c10))
+
+# [8.15.0](https://github.com/NaturalCycles/db-lib/compare/v8.14.0...v8.15.0) (2021-10-04)
+
+
+### Features
+
+* dbTest to ensure `${table}.schema.json` format ([eacf18f](https://github.com/NaturalCycles/db-lib/commit/eacf18fdd7197f18e15af89f19f786556a7d3219))
+
 # [8.14.0](https://github.com/NaturalCycles/db-lib/compare/v8.13.0...v8.14.0) (2021-10-04)
 
 

package/dist/adapter/cachedb/cache.db.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import { Readable } from 'stream';
-import { JsonSchemaObject } from '@naturalcycles/js-lib';
+import { JsonSchemaObject, JsonSchemaRootObject } from '@naturalcycles/js-lib';
 import { IDebugger } from '@naturalcycles/nodejs-lib';
 import { BaseCommonDB } from '../../base.common.db';
 import { CommonDB } from '../../common.db';
@@ -22,7 +22,7 @@ export declare class CacheDB extends BaseCommonDB implements CommonDB {
      * Resets InMemory DB data
      */
     getTables(): Promise<string[]>;
-    getTableSchema<ROW extends ObjectWithId>(table: string): Promise<JsonSchemaObject<ROW>>;
+    getTableSchema<ROW extends ObjectWithId>(table: string): Promise<JsonSchemaRootObject<ROW>>;
     createTable(table: string, schema: JsonSchemaObject, opt?: CacheDBCreateOptions): Promise<void>;
     getByIds<ROW extends ObjectWithId>(table: string, ids: string[], opt?: CacheDBOptions): Promise<ROW[]>;
     deleteByIds(table: string, ids: string[], opt?: CacheDBOptions): Promise<number>;

package/dist/adapter/file/file.db.d.ts

@@ -1,4 +1,4 @@
-import { JsonSchemaObject } from '@naturalcycles/js-lib';
+import { JsonSchemaRootObject } from '@naturalcycles/js-lib';
 import { ReadableTyped } from '@naturalcycles/nodejs-lib';
 import { BaseCommonDB, DBSaveBatchOperation, ObjectWithId } from '../..';
 import { CommonDB } from '../../common.db';
@@ -32,7 +32,7 @@ export declare class FileDB extends BaseCommonDB implements CommonDB {
     streamQuery<ROW extends ObjectWithId>(q: DBQuery<ROW>, opt?: CommonDBStreamOptions): ReadableTyped<ROW>;
     deleteByIds<ROW extends ObjectWithId>(table: string, ids: string[], _opt?: CommonDBOptions): Promise<number>;
     deleteByQuery<ROW extends ObjectWithId>(q: DBQuery<ROW>, _opt?: CommonDBOptions): Promise<number>;
-    getTableSchema<ROW extends ObjectWithId>(table: string): Promise<JsonSchemaObject<ROW>>;
+    getTableSchema<ROW extends ObjectWithId>(table: string): Promise<JsonSchemaRootObject<ROW>>;
     loadFile<ROW extends ObjectWithId>(table: string): Promise<ROW[]>;
     saveFile<ROW extends ObjectWithId>(table: string, _rows: ROW[]): Promise<void>;
     saveFiles(ops: DBSaveBatchOperation[]): Promise<void>;

package/dist/adapter/inmemory/inMemory.db.d.ts

@@ -1,4 +1,4 @@
-import { JsonSchemaObject, StringMap } from '@naturalcycles/js-lib';
+import { JsonSchemaObject, StringMap, JsonSchemaRootObject } from '@naturalcycles/js-lib';
 import { ReadableTyped } from '@naturalcycles/nodejs-lib';
 import { CommonDB, DBTransaction, ObjectWithId } from '../..';
 import { CommonDBCreateOptions, CommonDBOptions, CommonDBSaveOptions, RunQueryResult } from '../../db.model';
@@ -46,7 +46,7 @@ export declare class InMemoryDB implements CommonDB {
      */
     resetCache(_table?: string): Promise<void>;
     getTables(): Promise<string[]>;
-    getTableSchema<ROW extends ObjectWithId>(_table: string): Promise<JsonSchemaObject<ROW>>;
+    getTableSchema<ROW extends ObjectWithId>(_table: string): Promise<JsonSchemaRootObject<ROW>>;
     createTable(_table: string, _schema: JsonSchemaObject, opt?: CommonDBCreateOptions): Promise<void>;
     getByIds<ROW extends ObjectWithId>(_table: string, ids: string[], _opt?: CommonDBOptions): Promise<ROW[]>;
     saveBatch<ROW extends ObjectWithId>(_table: string, rows: ROW[], _opt?: CommonDBSaveOptions): Promise<void>;

package/dist/base.common.db.d.ts

@@ -1,4 +1,4 @@
-import { JsonSchemaObject } from '@naturalcycles/js-lib';
+import { JsonSchemaObject, JsonSchemaRootObject } from '@naturalcycles/js-lib';
 import { ReadableTyped } from '@naturalcycles/nodejs-lib';
 import { CommonDB } from './common.db';
 import { CommonDBSaveOptions, ObjectWithId, RunQueryResult } from './db.model';
@@ -11,7 +11,7 @@ import { DBTransaction } from './transaction/dbTransaction';
 export declare class BaseCommonDB implements CommonDB {
     ping(): Promise<void>;
     getTables(): Promise<string[]>;
-    getTableSchema<ROW extends ObjectWithId>(table: string): Promise<JsonSchemaObject<ROW>>;
+    getTableSchema<ROW extends ObjectWithId>(table: string): Promise<JsonSchemaRootObject<ROW>>;
     createTable(_table: string, _schema: JsonSchemaObject): Promise<void>;
     deleteByIds(_table: string, _ids: string[]): Promise<number>;
     deleteByQuery<ROW extends ObjectWithId>(_q: DBQuery<ROW>): Promise<number>;

package/dist/common.db.d.ts

@@ -1,4 +1,4 @@
-import { JsonSchemaObject } from '@naturalcycles/js-lib';
+import { JsonSchemaObject, JsonSchemaRootObject } from '@naturalcycles/js-lib';
 import { ReadableTyped } from '@naturalcycles/nodejs-lib';
 import { CommonDBCreateOptions, CommonDBOptions, CommonDBSaveOptions, CommonDBStreamOptions, ObjectWithId, RunQueryResult } from './db.model';
 import { DBQuery } from './query/dbQuery';
@@ -15,7 +15,13 @@ export interface CommonDB {
      * Return all tables (table names) available in this DB.
      */
     getTables(): Promise<string[]>;
-    getTableSchema<ROW extends ObjectWithId>(table: string): Promise<JsonSchemaObject<ROW>>;
+    /**
+     * $id of the schema SHOULD be like this:
+     * `${tableName}.schema.json`
+     *
+     * This is important for the code to rely on it, and it's verified by dbTest
+     */
+    getTableSchema<ROW extends ObjectWithId>(table: string): Promise<JsonSchemaRootObject<ROW>>;
     /**
      * Will do like `create table ...` for mysql.
      * Caution! dropIfExists defaults to false. If set to true - will actually DROP the table!

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

@@ -1,4 +1,4 @@
-import { AsyncMapper, JsonSchemaObject } from '@naturalcycles/js-lib';
+import { AsyncMapper, JsonSchemaObject, JsonSchemaRootObject } from '@naturalcycles/js-lib';
 import { AjvSchema, ObjectSchemaTyped, ReadableTyped } from '@naturalcycles/nodejs-lib';
 import { DBModelType, ObjectWithId, RunQueryResult, Saved } from '../db.model';
 import { DBQuery, RunnableDBQuery } from '../query/dbQuery';
@@ -125,7 +125,7 @@ export declare class CommonDao<BM extends Partial<ObjectWithId>, DBM extends Obj
      * Does NOT mutate the object.
      */
     validateAndConvert<IN, OUT = IN>(obj: IN, schema?: ObjectSchemaTyped<IN> | AjvSchema<IN>, modelType?: DBModelType, opt?: CommonDaoOptions): OUT;
-    getTableSchema(): Promise<JsonSchemaObject<DBM>>;
+    getTableSchema(): Promise<JsonSchemaRootObject<DBM>>;
     createTable(schema: JsonSchemaObject<DBM>, opt?: CommonDaoCreateOptions): Promise<void>;
     /**
      * Proxy to this.cfg.db.ping

package/dist/commondao/common.dao.js

@@ -548,7 +548,8 @@ class CommonDao {
         // DBM > BM
         const bm = await this.cfg.hooks.beforeDBMToBM(dbm);
         // Validate/convert BM
-        return await this.validateAndConvert(bm, this.cfg.bmSchema, db_model_1.DBModelType.BM, opt);
+        // eslint-disable-next-line @typescript-eslint/return-await
+        return this.validateAndConvert(bm, this.cfg.bmSchema, db_model_1.DBModelType.BM, opt);
     }
     async dbmsToBM(dbms, opt = {}) {
         return await (0, js_lib_1.pMap)(dbms, async (dbm) => await this.dbmToBM(dbm, opt));
@@ -565,7 +566,8 @@ class CommonDao {
         // BM > DBM
         const dbm = { ...(await this.cfg.hooks.beforeBMToDBM(bm)) };
         // Validate/convert DBM
-        return await this.validateAndConvert(dbm, this.cfg.dbmSchema, db_model_1.DBModelType.DBM, opt);
+        // eslint-disable-next-line @typescript-eslint/return-await
+        return this.validateAndConvert(dbm, this.cfg.dbmSchema, db_model_1.DBModelType.DBM, opt);
     }
     async bmsToDBM(bms, opt = {}) {
         // try/catch?

package/dist/testing/dbTest.js

@@ -130,7 +130,7 @@ function runCommonDBTest(db, features = {}, quirks = {}) {
             await (0, js_lib_1.pMap)(tables, async (table) => {
                 const schema = await db.getTableSchema(table);
                 console.log(schema);
-                expect(schema).toBeDefined();
+                expect(schema.$id).toBe(`${table}.schema.json`);
             });
         }
     });

package/package.json

@@ -42,7 +42,7 @@
   "engines": {
     "node": ">=12.13"
   },
-  "version": "8.14.0",
+  "version": "8.16.2",
   "description": "Lowest Common Denominator API to supported Databases",
   "keywords": [
     "db",

package/src/adapter/cachedb/cache.db.ts

@@ -1,5 +1,5 @@
 import { Readable } from 'stream'
-import { JsonSchemaObject } from '@naturalcycles/js-lib'
+import { JsonSchemaObject, JsonSchemaRootObject } from '@naturalcycles/js-lib'
 import { Debug, IDebugger } from '@naturalcycles/nodejs-lib'
 import { BaseCommonDB } from '../../base.common.db'
 import { CommonDB } from '../../common.db'
@@ -45,7 +45,7 @@ export class CacheDB extends BaseCommonDB implements CommonDB {
 
   override async getTableSchema<ROW extends ObjectWithId>(
     table: string,
-  ): Promise<JsonSchemaObject<ROW>> {
+  ): Promise<JsonSchemaRootObject<ROW>> {
     return await this.cfg.downstreamDB.getTableSchema<ROW>(table)
   }
 

package/src/adapter/file/file.db.ts

@@ -1,6 +1,5 @@
 import {
   generateJsonSchemaFromData,
-  JsonSchemaObject,
   pMap,
   StringMap,
   _by,
@@ -10,6 +9,7 @@ import {
   _sortObjectDeep,
   _stringMapValues,
   _uniq,
+  JsonSchemaRootObject,
 } from '@naturalcycles/js-lib'
 import { Debug, readableCreate, ReadableTyped } from '@naturalcycles/nodejs-lib'
 import { dimGrey } from '@naturalcycles/nodejs-lib/dist/colors'
@@ -213,12 +213,12 @@ export class FileDB extends BaseCommonDB implements CommonDB {
 
   override async getTableSchema<ROW extends ObjectWithId>(
     table: string,
-  ): Promise<JsonSchemaObject<ROW>> {
+  ): Promise<JsonSchemaRootObject<ROW>> {
     const rows = await this.loadFile(table)
     return {
       ...generateJsonSchemaFromData(rows),
       $id: `${table}.schema.json`,
-    } as JsonSchemaObject<ROW>
+    }
   }
 
   // wrapper, to handle logging

package/src/adapter/inmemory/inMemory.db.ts

@@ -8,6 +8,7 @@ import {
   _by,
   _since,
   _sortObjectDeep,
+  JsonSchemaRootObject,
 } from '@naturalcycles/js-lib'
 import {
   bufferReviver,
@@ -111,12 +112,14 @@ export class InMemoryDB implements CommonDB {
     return Object.keys(this.data).filter(t => t.startsWith(this.cfg.tablesPrefix))
   }
 
-  async getTableSchema<ROW extends ObjectWithId>(_table: string): Promise<JsonSchemaObject<ROW>> {
+  async getTableSchema<ROW extends ObjectWithId>(
+    _table: string,
+  ): Promise<JsonSchemaRootObject<ROW>> {
     const table = this.cfg.tablesPrefix + _table
     return {
       ...generateJsonSchemaFromData(Object.values(this.data[table] || {})),
       $id: `${table}.schema.json`,
-    } as JsonSchemaObject<ROW>
+    }
   }
 
   async createTable(

package/src/base.common.db.ts

@@ -1,5 +1,5 @@
 import { Readable } from 'stream'
-import { JsonSchemaObject } from '@naturalcycles/js-lib'
+import { JsonSchemaObject, JsonSchemaRootObject } from '@naturalcycles/js-lib'
 import { ReadableTyped } from '@naturalcycles/nodejs-lib'
 import { CommonDB } from './common.db'
 import { CommonDBSaveOptions, ObjectWithId, RunQueryResult } from './db.model'
@@ -18,7 +18,9 @@ export class BaseCommonDB implements CommonDB {
     return []
   }
 
-  async getTableSchema<ROW extends ObjectWithId>(table: string): Promise<JsonSchemaObject<ROW>> {
+  async getTableSchema<ROW extends ObjectWithId>(
+    table: string,
+  ): Promise<JsonSchemaRootObject<ROW>> {
     return {
       $id: `${table}.schema.json`,
       type: 'object',

package/src/common.db.ts

@@ -1,4 +1,4 @@
-import { JsonSchemaObject } from '@naturalcycles/js-lib'
+import { JsonSchemaObject, JsonSchemaRootObject } from '@naturalcycles/js-lib'
 import { ReadableTyped } from '@naturalcycles/nodejs-lib'
 import {
   CommonDBCreateOptions,
@@ -25,7 +25,13 @@ export interface CommonDB {
    */
   getTables(): Promise<string[]>
 
-  getTableSchema<ROW extends ObjectWithId>(table: string): Promise<JsonSchemaObject<ROW>>
+  /**
+   * $id of the schema SHOULD be like this:
+   * `${tableName}.schema.json`
+   *
+   * This is important for the code to rely on it, and it's verified by dbTest
+   */
+  getTableSchema<ROW extends ObjectWithId>(table: string): Promise<JsonSchemaRootObject<ROW>>
 
   /**
    * Will do like `create table ...` for mysql.

package/src/commondao/common.dao.ts

@@ -8,6 +8,7 @@ import {
   _since,
   _truncate,
   pMap,
+  JsonSchemaRootObject,
 } from '@naturalcycles/js-lib'
 import {
   AjvSchema,
@@ -723,7 +724,8 @@ export class CommonDao<
     const bm = await this.cfg.hooks!.beforeDBMToBM!(dbm)
 
     // Validate/convert BM
-    return await this.validateAndConvert(bm, this.cfg.bmSchema, DBModelType.BM, opt)
+    // eslint-disable-next-line @typescript-eslint/return-await
+    return this.validateAndConvert(bm, this.cfg.bmSchema, DBModelType.BM, opt)
   }
 
   async dbmsToBM(dbms: DBM[], opt: CommonDaoOptions = {}): Promise<Saved<BM>[]> {
@@ -751,7 +753,8 @@ export class CommonDao<
     const dbm = { ...(await this.cfg.hooks!.beforeBMToDBM!(bm)) }
 
     // Validate/convert DBM
-    return await this.validateAndConvert(dbm, this.cfg.dbmSchema, DBModelType.DBM, opt)
+    // eslint-disable-next-line @typescript-eslint/return-await
+    return this.validateAndConvert(dbm, this.cfg.dbmSchema, DBModelType.DBM, opt)
   }
 
   async bmsToDBM(bms: BM[], opt: CommonDaoOptions = {}): Promise<DBM[]> {
@@ -884,7 +887,7 @@ export class CommonDao<
     return convertedValue
   }
 
-  async getTableSchema(): Promise<JsonSchemaObject<DBM>> {
+  async getTableSchema(): Promise<JsonSchemaRootObject<DBM>> {
     return await this.cfg.db.getTableSchema<DBM>(this.cfg.table)
   }
 

package/src/testing/dbTest.ts

@@ -233,7 +233,7 @@ export function runCommonDBTest(
       await pMap(tables, async table => {
         const schema = await db.getTableSchema(table)
         console.log(schema)
-        expect(schema).toBeDefined()
+        expect(schema.$id).toBe(`${table}.schema.json`)
       })
     }
   })