@egi/smart-db 2.3.2 → 2.3.4

package/{src/smart-db-interfaces.ts → smart-db-interfaces.d.ts}

@@ -1,26 +1,22 @@
-import {AbstractModel} from "./models/abstract-model";
-import {SmartDbDictionary} from "./models/smart-db-dictionary";
-import {SmartDbVersionViewModel} from "./models/smart-db-version-view-model";
-import {SmartDbSqlBuildData} from "./smart-db-sql-build-data";
-
+import { AbstractModel } from "./models/abstract-model";
+import { SmartDbDictionary } from "./models/smart-db-dictionary";
+import { SmartDbVersionViewModel } from "./models/smart-db-version-view-model";
+import { SmartDbSqlBuildData } from "./smart-db-sql-build-data";
 export interface SmartDbOptions {
     module: string;
     sqlFilesDirectory: string;
     smartDbDictionary?: typeof SmartDbDictionary | any[];
     skipAutoUpgrade?: boolean;
 }
-
 export interface SmartDbRunResult {
     lastId: number;
     changes: number;
     affected: number;
 }
-
 export interface SmartDbTableInfo {
     name: string;
     fields: SmartDbFieldDescription[];
 }
-
 export interface SmartDbFieldDescription {
     cid?: string | number;
     name: string;
@@ -30,19 +26,18 @@ export interface SmartDbFieldDescription {
     defaultValue?: number | string | boolean;
     isPk?: boolean;
 }
-
 export interface SmartDbSqlComparison {
-    compare: string | SqlFieldDescriptor,
+    compare: string | SqlFieldDescriptor;
     with: string | SqlFieldDescriptor;
     operation?: SqlOperationType;
 }
-
-export type SqlValueType = string | number | boolean | Date;
-
-export enum FieldNamingStyle { Database, TypeScript, All}
-
-export type GenericModelData = Record<string, SqlValueType>;
-
+export declare type SqlValueType = string | number | boolean | Date;
+export declare enum FieldNamingStyle {
+    Database = 0,
+    TypeScript = 1,
+    All = 2
+}
+export declare type GenericModelData = Record<string, SqlValueType>;
 export interface AttributeInfo {
     attribute: string;
     type: string;
@@ -52,42 +47,34 @@ export interface AttributeInfo {
     alternative?: boolean;
     typeScriptStyle?: boolean;
 }
-
 export interface ModelAttributeMap {
     [key: string]: AttributeInfo;
 }
-
 export interface AbstractModelGlobals<T extends AbstractModel<T, D>, D extends GenericModelData> {
     attributeMap: ModelAttributeMap;
     getTableName: () => string;
     from: (other: T | D) => T;
 }
-
 export interface SqlWhere {
     or?: SqlWhere | SqlWhere[];
     and?: SqlWhere | SqlWhere[];
     expression?: SmartDbSqlComparison[];
-
     [key: string]: SqlValueType | SqlValueType[] | SqlOperation | SqlWhere | SqlWhere[] | SmartDbSqlComparison[];
 }
-
-export type SqlUpdateValues = Record<string, SqlValueType>;
-export type SqlOrderBy = string | string[];
-type SqlGroupBy = string | string[];
-
+export declare type SqlUpdateValues = Record<string, SqlValueType>;
+export declare type SqlOrderBy = string | string[];
+declare type SqlGroupBy = string | string[];
 export interface SqlLimit {
     offset?: number;
     limit?: number;
 }
-
 export interface SectionDescription<T extends AbstractModel<T, D>, D extends GenericModelData> {
-    model: (new() => T) | string;
+    model: (new () => T) | string;
     where?: SqlWhere;
     fields?: string | SqlFieldDescriptor | (string | SqlFieldDescriptor)[] | null;
     groupBy?: SqlGroupBy;
     limit?: SqlLimit;
 }
-
 export interface SmartDbSqlOptions<T extends AbstractModel<T, D>, D extends GenericModelData> {
     firstOnly?: boolean;
     where?: SqlWhere;
@@ -103,116 +90,81 @@ export interface SmartDbSqlOptions<T extends AbstractModel<T, D>, D extends Gene
     minus?: SectionDescription<T, D> | SectionDescription<T, D>[];
     intersect?: SectionDescription<T, D> | SectionDescription<T, D>[];
 }
-
-export enum SqlOperationType {
-// noinspection JSUnusedGlobalSymbols,LocalVariableNamingConventionJS
-    // eslint-disable-next-line no-shadow
-    GT = ">", GE = ">=", LT = "<", LE = "<=", EQ = "=", NE = "!=",
-    // eslint-disable-next-line no-shadow
-    IN = "IN", LIKE = "LIKE", NOT_LIKE = "NOT LIKE",
-    // eslint-disable-next-line no-shadow
-    IS_NULL = "IS NULL", IS_NOT_NULL = "IS NOT NULL",
-    // eslint-disable-next-line no-shadow
+export declare enum SqlOperationType {
+    GT = ">",
+    GE = ">=",
+    LT = "<",
+    LE = "<=",
+    EQ = "=",
+    NE = "!=",
+    IN = "IN",
+    LIKE = "LIKE",
+    NOT_LIKE = "NOT LIKE",
+    IS_NULL = "IS NULL",
+    IS_NOT_NULL = "IS NOT NULL",
     LITERAL = "LITERAL",
     VALUE = "VALUE"
 }
-
-export enum SqlFieldOperationType {
+export declare enum SqlFieldOperationType {
     VALUE = "VALUE",
     FIELD = "FIELD",
     COUNT = "COUNT",
     COALESCE = "COALESCE"
 }
-
 export interface SqlFieldDescriptor {
-    operation: SqlFieldOperationType,
-    value: SqlFieldDescriptor | SqlValueType | (SqlFieldDescriptor | SqlValueType)[],
-    alias?: string,
+    operation: SqlFieldOperationType;
+    value: SqlFieldDescriptor | SqlValueType | (SqlFieldDescriptor | SqlValueType)[];
+    alias?: string;
     literal?: boolean;
 }
-
 export interface SqlOperation {
     operation: SqlOperationType;
     value: SqlValueType | SqlValueType[];
     key?: string;
     literalOperation?: SqlOperationType;
 }
-
 export interface KeyValueList {
     [key: string]: SqlValueType;
 }
-
 export interface IndexedGenericModelData<T extends AbstractModel<T, D>, D extends GenericModelData> {
     [key: string]: T | GenericModelData;
 }
-
 export interface SmartDbSqlBuildDataResults {
     sql: string;
     values: SqlValueType[];
 }
-
 export interface SmartDbApi {
     initDb(appOptions: SmartDbOptions): Promise<SmartDbVersionViewModel[]>;
-
     exists<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), type?: "view" | "table" | "index", indexTableName?: string): Promise<boolean>;
-
     existsSync<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), type?: "view" | "table" | "index", indexTableName?: string): boolean;
-
     get<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), options: SmartDbSqlOptions<T, D>): Promise<(T | D)[] | T | D | SqlValueType | IndexedGenericModelData<T, D> | string | string[]>;
-
     getSync<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), options: SmartDbSqlOptions<T, D>): (T | D)[] | T | D | IndexedGenericModelData<T, D> | SqlValueType | string[] | false;
-
     getFirst<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), where?: SqlWhere, fields?: string | string[] | null, orderBy?: SqlOrderBy): Promise<T>;
-
     getFirstSync<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), where?: SqlWhere, fields?: string | string[] | null, orderBy?: SqlOrderBy): T | false;
-
     getAll<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), where?: SqlWhere, fields?: string | string[] | null, orderBy?: SqlOrderBy, limit?: SqlLimit): Promise<T[]>;
-
     getAllSync<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), where?: SqlWhere, fields?: string | string[] | null, orderBy?: SqlOrderBy, limit?: SqlLimit): T[] | false;
-
     delete<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), where?: SqlWhere): Promise<number>;
-
     deleteSync<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), where?: SqlWhere): number | false;
-
     update<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), values: SqlUpdateValues | T, where?: SqlWhere): Promise<number>;
-
     updateSync<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), values: SqlUpdateValues | T, where?: SqlWhere): number | false;
-
     insert<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), values: SqlUpdateValues | T): Promise<number>;
-
     insertSync<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), values: SqlUpdateValues | T): number | false;
-
     exec(script: string): Promise<void>;
-
     execSync(script: string): SmartDbDatabase | false;
-
     getLastError(): any;
-
     getLastBuildData(): SmartDbSqlBuildData;
-
     getDbQuote(): string;
-
     getTableInfo(table: string): Promise<SmartDbTableInfo>;
-
     toDate(d: Date | number | string): Date | null;
-
     getDbConnector(): string | SmartDbConnector;
-
     toDbTimestamp(d: Date | number): string;
-
     toDbDate(d: Date | number): string;
-
     hasConcurrentTransactions(): boolean;
-
     closeSync(): boolean;
-
     close(): Promise<void>;
 }
-
 export interface SmartDbDatabase {
-    // empty placeholder interface
 }
-
 export interface SmartDbConnector {
-    // empty placeholder interface
-}
+}
+export {};

package/smart-db-interfaces.js

@@ -0,0 +1 @@
+export var FieldNamingStyle;!function(e){e[e.Database=0]="Database",e[e.TypeScript=1]="TypeScript",e[e.All=2]="All"}(FieldNamingStyle||(FieldNamingStyle={}));export var SqlOperationType;!function(e){e.GT=">",e.GE=">=",e.LT="<",e.LE="<=",e.EQ="=",e.NE="!=",e.IN="IN",e.LIKE="LIKE",e.NOT_LIKE="NOT LIKE",e.IS_NULL="IS NULL",e.IS_NOT_NULL="IS NOT NULL",e.LITERAL="LITERAL",e.VALUE="VALUE"}(SqlOperationType||(SqlOperationType={}));export var SqlFieldOperationType;!function(e){e.VALUE="VALUE",e.FIELD="FIELD",e.COUNT="COUNT",e.COALESCE="COALESCE"}(SqlFieldOperationType||(SqlFieldOperationType={}));

package/smart-db-log.d.ts

@@ -0,0 +1,58 @@
+import { SmartDbApi } from "./smart-db-interfaces";
+export declare const SmartDbLogLocation: {
+    Frontend: string;
+    Backend: string;
+    Database: string;
+    UpgradeManager: string;
+    Other: string;
+};
+export declare type SmartDbLogLocationType = typeof SmartDbLogLocation;
+export declare type SmartDbLogLocationKey = keyof SmartDbLogLocationType;
+export declare type SmartDbLogLocationValue = SmartDbLogLocationType[keyof SmartDbLogLocationType];
+export declare const SeverityCode: {
+    readonly Fatal: "F";
+    readonly Error: "E";
+    readonly Warning: "W";
+    readonly Info: "I";
+    readonly Debug: "D";
+    readonly Local: "L";
+};
+export declare type SeverityCodeType = typeof SeverityCode;
+export declare type SeverityCodeKey = keyof SeverityCodeType;
+export declare type SeverityCodeValue = SeverityCodeType[keyof SeverityCodeType];
+export declare const SeverityLevel: {
+    readonly None: 0;
+    readonly Fatal: 1;
+    readonly Error: 2;
+    readonly Warning: 3;
+    readonly Info: 4;
+    readonly Debug: 5;
+    readonly All: 9;
+};
+export declare type SeverityLevelType = typeof SeverityLevel;
+export declare type SeverityLevelKey = keyof SeverityLevelType;
+export declare type SeverityLevelValue = SeverityLevelType[keyof SeverityLevelType];
+export declare class SmartDbLog {
+    private db;
+    private dbLogLevel;
+    private consoleLogLevel;
+    private userId;
+    private dbLogging;
+    private isLogging;
+    constructor(db?: SmartDbApi);
+    getConsoleLogLevel(): SeverityLevelValue;
+    setConsoleLogLevel(consoleLogLevel: SeverityLevelValue): void;
+    getDbLogLevel(): SeverityLevelValue;
+    setDbLogLevel(dbLogLevel: SeverityLevelValue): void;
+    setDb(db: SmartDbApi): void;
+    setUserId(userId: string | number): void;
+    setDbLogging(dbLogging: boolean): void;
+    getDbLogging(): boolean;
+    logFatal(type: SmartDbLogLocationValue, location: string, message: string | Error, data?: any): void;
+    logError(type: SmartDbLogLocationValue, location: string, message: string | Error, data?: any): void;
+    logWarning(type: SmartDbLogLocationValue, location: string, message: string | Error, data?: any): void;
+    logInfo(type: SmartDbLogLocationValue, location: string, message: string | Error, data?: any): void;
+    logDebug(type: SmartDbLogLocationValue, location: string, message: string | Error, data?: any): void;
+    writeLog(type: SmartDbLogLocationValue, location: string, severity: SeverityCodeValue, message: string | Error, data: unknown, timestamp?: Date | string | number): void;
+}
+export declare const smartDbLog: SmartDbLog;

package/smart-db-log.js

@@ -0,0 +1 @@
+import _ from"lodash";import{SmartDbLogModel}from"./models/smart-db-log-model";import{SmartDbDateRegexp,SmartDbTimestampRegexp,toSmartDbTimestamp}from"./smart-db-globals";export const SmartDbLogLocation={Frontend:"frontend",Backend:"backend",Database:"database",UpgradeManager:"upgrade-manager",Other:"other"};export const SeverityCode={Fatal:"F",Error:"E",Warning:"W",Info:"I",Debug:"D",Local:"L"};export const SeverityLevel={None:0,Fatal:1,Error:2,Warning:3,Info:4,Debug:5,All:9};export class SmartDbLog{constructor(e){this.userId=null,this.dbLogging=!0,this.isLogging=!1,this.db=e,this.dbLogLevel=SeverityLevel.Info,this.consoleLogLevel=SeverityLevel.Info}getConsoleLogLevel(){return this.consoleLogLevel}setConsoleLogLevel(e){this.consoleLogLevel=e}getDbLogLevel(){return this.dbLogLevel}setDbLogLevel(e){this.dbLogLevel=e}setDb(e){this.db=e,this.db?this.db.exists(SmartDbLogModel).then(e=>{this.dbLogging=e}).catch(e=>{throw e}):this.dbLogging=!1}setUserId(e){this.userId=e}setDbLogging(e){this.dbLogging=e}getDbLogging(){return this.dbLogging}logFatal(e,t,o,r){this.writeLog(e,t,SeverityCode.Fatal,o,r)}logError(e,t,o,r){this.writeLog(e,t,SeverityCode.Error,o,r)}logWarning(e,t,o,r){this.writeLog(e,t,SeverityCode.Warning,o,r)}logInfo(e,t,o,r){this.writeLog(e,t,SeverityCode.Info,o,r)}logDebug(e,t,o,r){this.writeLog(e,t,SeverityCode.Debug,o,r)}writeLog(e,t,o,r,i,s){try{if(this.isLogging)console.error("recursive logging error:",e,t,o,r,i);else{this.isLogging=!0;let a,g,n=SeverityLevel.None;switch(o){case SeverityCode.Fatal:a=console.error,n=SeverityLevel.Fatal;break;case SeverityCode.Error:a=console.error,n=SeverityLevel.Error;break;case SeverityCode.Warning:a=console.warn,n=SeverityLevel.Warning;break;case SeverityCode.Info:a=console.info,n=SeverityLevel.Info;break;case SeverityCode.Debug:a=console.debug,n=SeverityLevel.Debug}if(_.isString(s)){const e=s.match(SmartDbTimestampRegexp),t=e&&s.match(SmartDbDateRegexp);g=e?e[1]:t?t[1]+".000":toSmartDbTimestamp(new Date)}else g=_.isDate(s)?toSmartDbTimestamp(s):_.isNumber(s)?toSmartDbTimestamp(new Date(s)):toSmartDbTimestamp(new Date);if(_.isObjectLike(r))if(r instanceof Error)i||(i=r),r=r.message;else try{r=JSON.stringify(r)}catch(e){r=r.toString()}else"boolean"==typeof r&&(r=r?"<true>":"<false>");if(i){if(i instanceof Error)i=i.stack;else if(_.isObject(i))try{i=JSON.stringify(i)}catch(e){i=i.toString(),this.db&&this.dbLogLevel>=n&&console.error("unable to stringify log data",i)}else i.toString?i=i.toString():(i=null,this.db&&this.dbLogLevel>=n&&console.error("unable to store log data",i));i&&(r+=` (${i})`)}if(this.consoleLogLevel>=n){const s=e.substr(0,1).toUpperCase();if(e==SmartDbLogLocation.Database&&this.db&&a(`${o}-${s}-${g}: last statement:`,this.db.getLastBuildData()),a(`${o}-${s}-${g}: ${r}`),this.dbLogging)try{e==SmartDbLogLocation.Database&&(i||(i=JSON.stringify(this.db.getLastBuildData()))),this.db.insertSync(SmartDbLogModel,{severity:o,type:e,location:t,info:r||"<empty>",data:i,user:this.userId,timestamp:new Date(g)})}catch(e){console.error(`F-B-${g}: unable to write the log statement below to database`,e,e.code,e.name,e.message);try{a(`F-B-${g}: last statement:`,this.db.getLastBuildData())}catch{a(`F-B-${g}: last statement not available`)}}}}this.isLogging=!1}catch(e){this.isLogging=!1,console.error("fatal logging error",e)}}}export const smartDbLog=new SmartDbLog;

package/smart-db-sql-build-data.d.ts

@@ -0,0 +1,9 @@
+import { SmartDbSqlBuildDataResults, SqlValueType } from "./smart-db-interfaces";
+export declare class SmartDbSqlBuildData {
+    sql: string;
+    values: SqlValueType[];
+    constructor(sql?: string, values?: SqlValueType[]);
+    append(data: SmartDbSqlBuildData): void;
+    toString(): string;
+    results(): SmartDbSqlBuildDataResults;
+}

package/smart-db-sql-build-data.js

@@ -0,0 +1 @@
+import _ from"lodash";export class SmartDbSqlBuildData{constructor(s,t){this.sql=s||"",this.values=t||[]}append(s){this.sql=this.sql.trim()+" "+s.sql.trim(),this.values=_.concat(this.values,s.values)}toString(){return this.sql+" <= ("+this.values.join(", ")+")"}results(){return{sql:this.sql,values:this.values}}}

package/smart-db-upgrade-manager.d.ts

@@ -0,0 +1,13 @@
+import { SmartDbVersionViewModel } from "./models/smart-db-version-view-model";
+import { SmartDb } from "./smart-db";
+import { SmartDbOptions } from "./smart-db-interfaces";
+export declare class SmartDbUpgradeManager {
+    private db;
+    private log;
+    constructor(db: SmartDb);
+    hasDatabaseModule(module: string): Promise<boolean>;
+    prepareDatabase(options: SmartDbOptions): Promise<SmartDbVersionViewModel>;
+    private executeSqlScript;
+    private upgradeDatabase;
+    private executeScriptSequentially;
+}

package/smart-db-upgrade-manager.js

@@ -0,0 +1 @@
+import*as fs from"fs";import _ from"lodash";import{SmartDbVersionViewModel}from"./models/smart-db-version-view-model";import{SmartDbLogLocation}from"./smart-db-log";export class SmartDbUpgradeManager{constructor(e){this.db=e,this.log=e.getLogger()}hasDatabaseModule(e){return new Promise((t,a)=>{this.db.exists(SmartDbVersionViewModel).then(o=>{o?this.db.getFirst(SmartDbVersionViewModel,{module:e}).then(e=>{t(!!e)}).catch(e=>{a(e)}):t(!1)}).catch(e=>{a(e)})})}prepareDatabase(e){return new Promise((t,a)=>{try{const o=fs.existsSync(e.sqlFilesDirectory)&&fs.statSync(e.sqlFilesDirectory);if(o&&o.isDirectory()){const o=e.sqlFilesDirectory+`/${e.module}-init.sql`;fs.existsSync(o)?this.hasDatabaseModule(e.module).then(r=>{r?(this.log.logInfo(SmartDbLogLocation.UpgradeManager,"prepareDatabase",`database module '${e.module}' exists`),this.upgradeDatabase(e).then(a=>{this.log.logInfo(SmartDbLogLocation.UpgradeManager,"prepareDatabase",`connected to module '${e.module}' version ${a.versionString}`),t(a)}).catch(e=>{a(e)})):(this.log.setDbLogging(!1),this.log.logInfo(SmartDbLogLocation.UpgradeManager,"prepareDatabase",`database '${e.module}' doesn't exists - begin creation`),this.executeSqlScript(o).then(()=>{this.log.setDbLogging(!0),this.log.logInfo(SmartDbLogLocation.UpgradeManager,"prepareDatabase","database module creation complete"),this.hasDatabaseModule(e.module).then(o=>{o?(this.log.logInfo(SmartDbLogLocation.UpgradeManager,"prepareDatabase","successfully initialized database for new module "+e.module),this.upgradeDatabase(e).then(a=>{this.log.logInfo(SmartDbLogLocation.UpgradeManager,"prepareDatabase",`connected to module '${e.module}' version ${a.versionString}`),t(a)}).catch(e=>{a(e)})):a("error running database initialization script")}).catch(e=>{a(e)})}).catch(e=>{a(e)}))}).catch(e=>{a(e)}):a(`missing mandatory '${e.module}-init.sql' file in ${o}`)}else a(`option 'sqlFilesDirectory' (${e.sqlFilesDirectory}) must point to an existing directory (absolute or relative to ${fs.realpathSync(".")})`)}catch(e){a(e)}})}executeSqlScript(e){const t=fs.readFileSync(e,"utf8");return this.db.exec(t)}upgradeDatabase(e){return new Promise((t,a)=>{this.db.getFirst(SmartDbVersionViewModel,{module:e.module}).then(o=>{o?fs.readdir(e.sqlFilesDirectory,(r,s)=>{if(r)a("unable to read database files from "+e.sqlFilesDirectory);else{let r=[];s.forEach(t=>{const a=new RegExp(`^${e.module}-update.([0-9]{3})\\..*\\.sql$`),s=t.match(a);if(s){parseInt(s[1],10)>o.sequence&&r.push(t)}}),r=_.sortBy(r),this.executeScriptSequentially(r,e).then(()=>{this.db.getFirst(SmartDbVersionViewModel,{module:e.module},"*","sequence DESC").then(e=>{e?t(SmartDbVersionViewModel.from(e)):a("unable to determine final smart db version")}).catch(e=>{a(e)})}).catch(e=>{a(e)})}}):a(`missing version entry for module ${e.module} - add the mandatory insert into smart_db_version statement to your database creation script!`)}).catch(e=>{a(e)})})}executeScriptSequentially(e,t){return new Promise(async(a,o)=>{e&&e.length>0?(this.log.logInfo(SmartDbLogLocation.UpgradeManager,"upgradeDatabase",`execute update script '${e[0]}' for module ${t.module}`),await this.executeSqlScript(`${t.sqlFilesDirectory}/${e[0]}`).then(()=>{this.log.logInfo(SmartDbLogLocation.UpgradeManager,"upgradeDatabase",`successfully executed update script '${e[0]}' for module ${t.module}`),1==e.length&&a(!0)}).catch(e=>{o(e)}),e.length>1&&this.executeScriptSequentially(e.splice(1),t).then(e=>{a(e)}).catch(e=>{o(e)})):a(!0)})}}

package/smart-db.d.ts

@@ -0,0 +1,67 @@
+import { AbstractModel } from "./models/abstract-model";
+import { SmartDbVersionViewModel } from "./models/smart-db-version-view-model";
+import { GenericModelData, IndexedGenericModelData, SmartDbApi, SmartDbConnector, SmartDbDatabase, SmartDbOptions, SmartDbRunResult, SmartDbSqlOptions, SmartDbTableInfo, SqlFieldDescriptor, SqlLimit, SqlOrderBy, SqlUpdateValues, SqlValueType, SqlWhere } from "./smart-db-interfaces";
+import { SmartDbLog } from "./smart-db-log";
+import { SmartDbSqlBuildData } from "./smart-db-sql-build-data";
+export declare abstract class SmartDb implements SmartDbApi {
+    abstract getDatabaseType(): string;
+    abstract hasConcurrentTransactions(): boolean;
+    abstract exists<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), type?: "view" | "table" | "index", indexTableName?: string): Promise<boolean>;
+    abstract existsSync<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), type?: "view" | "table" | "index", indexTableName?: string): boolean;
+    abstract exec(script: string): Promise<void>;
+    abstract execSync(script: string): SmartDbDatabase | false;
+    abstract close(): Promise<void>;
+    abstract closeSync(): boolean;
+    abstract getDbQuote(): string;
+    abstract getTableInfo(table: string): Promise<SmartDbTableInfo>;
+    abstract getDbConnector(): string | SmartDbConnector;
+    protected abstract statementRun(buildData: SmartDbSqlBuildData): Promise<SmartDbRunResult>;
+    protected abstract statementRunSync(buildData: SmartDbSqlBuildData): SmartDbRunResult;
+    protected abstract statementGet(buildData: SmartDbSqlBuildData): Promise<any>;
+    protected abstract statementGetSync(buildData: SmartDbSqlBuildData): any;
+    protected abstract statementGetAll(buildData: SmartDbSqlBuildData): Promise<any[]>;
+    protected abstract statementGetAllSync(buildData: SmartDbSqlBuildData): any[];
+    protected db: SmartDbDatabase;
+    protected dbConnector: SmartDbConnector;
+    protected lastError: Error;
+    protected lastBuildData: SmartDbSqlBuildData;
+    protected smartDbLog: SmartDbLog;
+    private dictionaries;
+    protected constructor(dbConnector: SmartDbConnector);
+    initDb(appOptions: SmartDbOptions): Promise<SmartDbVersionViewModel[]>;
+    getLogger(): SmartDbLog;
+    getDb(): SmartDbDatabase;
+    getLastBuildData(): SmartDbSqlBuildData;
+    get<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), options: SmartDbSqlOptions<T, D>): Promise<(T | D)[] | T | D | SqlValueType | IndexedGenericModelData<T, D> | string | string[]>;
+    getSync<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), options: SmartDbSqlOptions<T, D>): (T | D)[] | T | D | SqlValueType | IndexedGenericModelData<T, D> | string | string[] | false;
+    getFirst<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), where?: SqlWhere, fields?: string | string[] | null, orderBy?: SqlOrderBy): Promise<T>;
+    getFirstSync<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), where?: SqlWhere, fields?: string | string[] | null, orderBy?: SqlOrderBy): T | false;
+    getAll<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), where?: SqlWhere, fields?: string | string[] | null, orderBy?: SqlOrderBy, limit?: SqlLimit): Promise<T[]>;
+    getAllSync<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), where?: SqlWhere, fields?: string | string[] | null, orderBy?: SqlOrderBy, limit?: SqlLimit): T[] | false;
+    delete<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), where?: SqlWhere): Promise<number>;
+    deleteSync<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), where?: SqlWhere): number | false;
+    update<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), values: SqlUpdateValues | T, where?: SqlWhere): Promise<number>;
+    updateSync<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), values: SqlUpdateValues | T, where?: SqlWhere): number | false;
+    insert<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), values: SqlUpdateValues | T): Promise<number>;
+    insertSync<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), values: SqlUpdateValues | T): number | false;
+    getLastError(): Error;
+    buildSelectStatement<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), options: SmartDbSqlOptions<T, D>): SmartDbSqlBuildData;
+    toDate(d: Date | number | string): Date | null;
+    toDbTimestamp(d: Date | number): string;
+    toDbDate(d: Date | number): string;
+    protected buildWhere<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), where: SqlWhere, op?: string): SmartDbSqlBuildData;
+    protected buildDeleteStatement<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), where?: SqlWhere): SmartDbSqlBuildData;
+    protected buildUpdateStatement<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), values: SqlUpdateValues | T, where?: SqlWhere): SmartDbSqlBuildData;
+    protected buildInsertStatement<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), values: SqlUpdateValues | T): SmartDbSqlBuildData;
+    protected prepareFieldValue<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), fieldOperation: SqlFieldDescriptor): string;
+    protected prepareField<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), field: SqlValueType | SqlFieldDescriptor, values?: SqlValueType[]): string;
+    protected buildFieldList<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), fields: (SqlValueType | SqlFieldDescriptor)[]): string[];
+    protected buildSelectSectionStatement<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), options: SmartDbSqlOptions<T, D>): SmartDbSqlBuildData;
+    protected translateFieldName<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | (new () => T), field: string): string;
+    protected makeDbValue(value: SqlValueType): SqlValueType;
+    protected makeArgumentDbValue(value: SqlValueType): SqlValueType;
+    protected saveExecute<T>(fn: () => T): T | false;
+    private prepareResultRow;
+    private prepareResultRows;
+    private getTableName;
+}

package/smart-db.js

@@ -0,0 +1 @@
+import _ from"lodash";import{AbstractModel}from"./models/abstract-model";import{SmartDbDictionary}from"./models/smart-db-dictionary";import{SmartDbLogModel}from"./models/smart-db-log-model";import{IN,smartDbToDate,toSmartDbDate,toSmartDbTimestamp}from"./smart-db-globals";import{FieldNamingStyle,SqlFieldOperationType,SqlOperationType}from"./smart-db-interfaces";import{SmartDbLog,SmartDbLogLocation}from"./smart-db-log";import{SmartDbSqlBuildData}from"./smart-db-sql-build-data";import{SmartDbUpgradeManager}from"./smart-db-upgrade-manager";export class SmartDb{constructor(e){this.dictionaries=[],this.dbConnector=e,this.smartDbLog=new SmartDbLog(this)}initDb(e){return new Promise((t,a)=>{this.dictionaries.push(SmartDbDictionary);const r=new SmartDbUpgradeManager(this);let i;i=import.meta&&import.meta.url?import.meta.url.replace(/file:\/\//,"").replace(/\/[^/]*$/,""):__dirname;const s={module:"smart-db-core",sqlFilesDirectory:i+"/assets/"+this.getDatabaseType()};r.prepareDatabase(s).then(i=>{this.exists(SmartDbLogModel).then(s=>{this.smartDbLog.setDbLogging(s),r.prepareDatabase(e).then(e=>{t([i,e])},e=>{a(e)})})}).catch(e=>{a(e)})})}getLogger(){return this.smartDbLog}getDb(){return this.db}getLastBuildData(){return this.lastBuildData}get(e,t){return new Promise((a,r)=>{t||(t={});const i=this.buildSelectStatement(e,t);t.firstOnly||t.count?this.statementGet(i).then(r=>{a(this.prepareResultRow(e,r,t))}).catch(e=>{r(e)}):this.statementGetAll(i).then(r=>{a(this.prepareResultRows(e,r,t))}).catch(e=>{r(e)})})}getSync(e,t){return this.saveExecute(()=>{t||(t={});const a=this.buildSelectStatement(e,t);let r;if(t.firstOnly||t.count){const i=this.statementGetSync(a);r=this.prepareResultRow(e,i,t)}else{const i=this.statementGetAllSync(a);r=this.prepareResultRows(e,i,t)}return r})}getFirst(e,t,a,r){return this.get(e,{firstOnly:!0,where:t,fields:a,orderBy:r})}getFirstSync(e,t,a,r){return this.getSync(e,{firstOnly:!0,where:t,fields:a,orderBy:r})}getAll(e,t,a,r,i){return this.get(e,{where:t,fields:a,orderBy:r,limit:i})}getAllSync(e,t,a,r,i){return this.getSync(e,{where:t,fields:a,orderBy:r,limit:i})}delete(e,t){return new Promise((a,r)=>{const i=this.buildDeleteStatement(e,t);this.statementRun(i).then(e=>{e?a(e.changes):r(this.getLastError())}).catch(e=>{r(e)})})}deleteSync(e,t){return this.saveExecute(()=>{const a=this.buildDeleteStatement(e,t);return this.statementRunSync(a).changes})}update(e,t,a){return new Promise((r,i)=>{const s=this.buildUpdateStatement(e,t,a);this.statementRun(s).then(e=>{e?r(e.changes):i(this.getLastError())}).catch(e=>{i(e)})})}updateSync(e,t,a){return this.saveExecute(()=>{const r=this.buildUpdateStatement(e,t,a);return this.statementRunSync(r).changes})}insert(e,t){return new Promise((a,r)=>{const i=this.buildInsertStatement(e,t);this.statementRun(i).then(e=>{e?a(e.lastId):r(this.getLastError())}).catch(e=>{r(e)})})}insertSync(e,t){return this.saveExecute(()=>{const a=this.buildInsertStatement(e,t);return this.statementRunSync(a).lastId})}getLastError(){return this.lastError}buildSelectStatement(e,t){t||(t={});const a=this.buildSelectSectionStatement(e,t);if(_.forEach(["union","minus","intersect"],e=>{let r=_.get(t,e);r&&(_.isArray(r)||(r=[r]),_.forEach(r,t=>{const r=this.buildSelectSectionStatement(t.model,t);a.sql+=" "+e.toUpperCase()+" ",a.append(r)}))}),t.orderBy){a.sql+=" ORDER BY ";const r=_.isString(t.orderBy)?t.orderBy.split(/ *, */):t.orderBy;a.sql+=r.map(t=>{let a="";const r=t.match(/^(\w*) (asc|desc)$/i);return r&&(t=r[1],a=r[2].toUpperCase()),t=this.translateFieldName(e,t),a&&(t+=" "+a),t}).join(", ")}return t.limit&&(t.limit.limit&&(a.sql+=" LIMIT "+t.limit.limit.toString()),t.limit.offset&&(a.sql+=" OFFSET "+t.limit.offset.toString())),this.lastBuildData=a,a}toDate(e){return smartDbToDate(e)}toDbTimestamp(e){return toSmartDbTimestamp(e)}toDbDate(e){return toSmartDbDate(e)}buildWhere(e,t,a){const r=new SmartDbSqlBuildData;return t&&_.keys(t).length>0&&(a||(a="AND",r.sql+=" WHERE "),r.sql+=_.map(t,(t,i)=>{const s=i.toUpperCase();if("AND"==s||"OR"==s){let a="";return(_.isArray(t)?t:[t]).forEach((t,i)=>{const l=this.buildWhere(e,t,s);i>0&&(a+=" "+s+" "),a+=l.sql,r.values=_.concat(r.values,l.values)}),a="("+a+")",a}if("EXPRESSION"==s){let i=[];return _.forEach(t,t=>{const a=this.prepareField(e,t.compare,r.values),s=this.prepareField(e,t.with,r.values);let l;l=_.isString(t.operation)&&SqlOperationType[t.operation]?SqlOperationType[t.operation]:t.operation||SqlOperationType.EQ,i.push(`${a} ${l} ${s}`)}),i.join(" "+a+" ")}{let a,s,l=!0;if(_.isArray(t)&&(t=IN(t)),_.isObject(t)){const e=t;switch(_.isString(e.operation)&&SqlOperationType[e.operation]&&(e.operation=SqlOperationType[e.operation]),e.operation){case SqlOperationType.IN:const t=new Array(e.value.length);t.fill("?"),a=SqlOperationType.IN+" ("+t.join(", ")+")",r.values=_.concat(r.values,e.value);break;case SqlOperationType.IS_NULL:case SqlOperationType.IS_NOT_NULL:a=e.operation;break;case SqlOperationType.LITERAL:i=e.key;const s=e.literalOperation||SqlOperationType.EQ;if(s==SqlOperationType.IN){const t=new Array(e.value.length);t.fill("?"),a=SqlOperationType.IN+" ("+t.join(", ")+")",r.values=_.concat(r.values,e.value)}else _.isUndefined(e.value)?a=s:(a=s+" ?",r.values.push(this.makeDbValue(e.value)));l=!1;break;default:a=e.operation+" ?",r.values.push(this.makeDbValue(e.value))}}else null===t?a=SqlOperationType.IS_NULL:void 0===t?(i="1",a="= 1",l=!1):(a=_.isString(t)&&t.match(/[%_]/)?SqlOperationType.LIKE+" ?":SqlOperationType.EQ+" ?",r.values.push(this.makeDbValue(t)));return s=l?this.translateFieldName(e,i)+" "+a:i+" "+a,s}}).join(" "+a+" ")),r}buildDeleteStatement(e,t){const a=this.getTableName(e),r=new SmartDbSqlBuildData("DELETE FROM");return r.sql+=" "+a,t&&r.append(this.buildWhere(e,t)),this.lastBuildData=r,r}buildUpdateStatement(e,t,a){const r=this.getTableName(e),i=new SmartDbSqlBuildData("UPDATE");i.sql+=" "+r+" SET ";const s=[];return t instanceof AbstractModel&&(t=t.getPlainObject(FieldNamingStyle.Database)),_.forOwn(t,(t,a)=>{s.push(this.translateFieldName(e,a)+" = ?"),i.values.push(this.makeDbValue(t))}),i.sql+=s.join(", "),a&&i.append(this.buildWhere(e,a)),this.lastBuildData=i,i}buildInsertStatement(e,t){const a=this.getTableName(e),r=new SmartDbSqlBuildData("INSERT");r.sql+=" INTO "+a;const i=[];t instanceof AbstractModel&&(t=t.getPlainObject(FieldNamingStyle.Database)),_.forOwn(t,(t,a)=>{a=this.translateFieldName(e,a),i.push(a),r.values.push(this.makeDbValue(t))});const s=new Array(i.length);return s.fill("?"),r.sql+=" ("+i.join(", ")+") VALUES ("+s.join(", ")+")",this.lastBuildData=r,r}prepareFieldValue(e,t){let a="<undefined>";switch(t.operation){case SqlFieldOperationType.FIELD:a=this.translateFieldName(e,t.value);break;case SqlFieldOperationType.VALUE:null===t.value?a="NULL":t.literal?a=t.value:_.isString(t.value)?!isNaN(parseFloat(t.value))&&isFinite(t.value)||(a="'"+t.value+"'"):_.isNumber(t.value)?a=t.value.toString():_.isBoolean(t.value)?a=t.value?"1":"0":_.isDate(t.value)?a="'"+t.value.toISOString().substr(0,23).replace("T"," ")+"'":console.error("unhandled field data type",typeof t.value,t.value);break;case SqlFieldOperationType.COUNT:a=_.isArray(t.value)?"COUNT("+t.value.join(",")+")":"COUNT("+(t.value||"")+")";break;case SqlFieldOperationType.COALESCE:const r=_.isArray(t.value)?t.value:[t.value];a="COALESCE("+this.buildFieldList(e,r).join(",")+")"}if(t.alias){const e=this.getDbQuote();a+=` as ${e}${t.alias}${e}`}return a}prepareField(e,t,a){let r;if(null===t)r="NULL";else if(_.isString(t)){const i=t.match(/^'(.*)'$/);i?a?(r="?",a.push(i[1])):r=t:r=this.translateFieldName(e,t)}else t.operation?r=this.prepareFieldValue(e,t):a?(r="?",a.push(t)):r=this.makeArgumentDbValue(t).toString();return r}buildFieldList(e,t){const a=[];return _.forEach(t,t=>{a.push(this.prepareField(e,t))}),a}buildSelectSectionStatement(e,t){const a=this.getTableName(e);let r,i;if(_.isArray(t.fields))r=t.fields;else if(_.isString(t.fields)){const e=t.fields.trim();r=""===e||"*"==e?[]:e.split(/,/)}else r=t.fields&&t.fields.operation?[t.fields]:[];if(r.length>0){i=this.buildFieldList(e,r).join(", ")}else i="*";t.distinct&&(i="DISTINCT "+i),t.count&&(i=`COUNT(${i})`);const s=new SmartDbSqlBuildData(`SELECT ${i} FROM ${a}`);if(t.where&&s.append(this.buildWhere(e,t.where)),t.groupBy){s.sql+=" GROUP BY ";const a=_.isArray(t.groupBy)?t.groupBy:[t.groupBy];s.sql+=a.map(t=>this.translateFieldName(e,t)).join(", ")}return s}translateFieldName(e,t){if(_.isString(e)){const t=e;let a=!1;_.forEach(this.dictionaries,r=>(r.models&&r.models[t]&&(e=r.models[t].cls,a=!0),!a))}if(!_.isString(e)){const a=e.attributeMap[t];if(a)a.alias&&(t=a.alias);else{const a=e.getTableName();this.lastError=new Error(`unknown field '${t}' in table '${a}'`),this.smartDbLog.logError(SmartDbLogLocation.Database,"translateFieldName",this.lastError)}}return t}makeDbValue(e){return _.isBoolean(e)?e=e?1:0:_.isDate(e)&&(e=toSmartDbDate(e)),e}makeArgumentDbValue(e){return _.isBoolean(e)?e=e?1:0:_.isDate(e)?e=`'${toSmartDbDate(e)}'`:_.isString(e)&&(e=`'${e}'`),e}saveExecute(e){let t;try{t=e()}catch(e){this.lastError=e instanceof Error?e:new Error(e||"Unknown error"),this.smartDbLog.logFatal(SmartDbLogLocation.Database,"saveExecute-catch",this.lastError),t=!1}return t}prepareResultRow(e,t,a){let r;if(a.indexedBy&&this.smartDbLog.logWarning(SmartDbLogLocation.Database,"AbstractModel.get","option 'indexedBy' not supported without 'all'"),t)if(a.count)r=parseInt(_.values(t)[0],10);else if(a.collapseRow)r=_.values(t).join(",");else{r=e.from(t)}return r}prepareResultRows(e,t,a){let r;if(a.indexedBy||a.collapseRow||!_.isString(e)){const i=e;r=a.indexedBy?{}:new Array(t.length),_.forEach(t,(e,t)=>{const s=i.from?i.from(e):null;let l=null;if(a.indexedBy&&(l=s?s.getValue(a.indexedBy):e[a.indexedBy]),a.collapseRow){const a=_.values(e).join(",");l?r[l]=a:r[t]=a}else l?r[l]=s||e:r[t]=s||e})}else r=t;return r}getTableName(e){let t;if(_.isString(e)){let a=e;_.forEach(this.dictionaries,e=>(e.models&&e.models[a]&&(t=e.models[a].cls.getTableName()),!t)),t||(t=a)}else{if(!e||!e.getTableName)throw new Error("unknown model: "+e);t=e.getTableName()}return t}}