@egi/smart-db 2.6.5 → 3.0.4

package/smart-db-globals.js

@@ -1 +1 @@
-import _ from"lodash";import{SqlFieldOperationType,SqlOperationType}from"./smart-db-interfaces";export const OP=(e,t,o,p)=>o?{operation:e,value:t,key:o,literalOperation:p}:{operation:e,value:t};export const VALUE=(e,t,o)=>({operation:SqlFieldOperationType.VALUE,value:e,alias:t,literal:o});export const FIELD=(e,t)=>({operation:SqlFieldOperationType.FIELD,value:e,alias:t});export const COUNT=(e,t)=>({operation:SqlFieldOperationType.COUNT,value:e,alias:t});export const COALESCE=(e,t)=>({operation:SqlFieldOperationType.COALESCE,value:e,alias:t});export const NVL=(e,t)=>COALESCE(e,t);export const LITERAL=(e,t,o)=>OP(SqlOperationType.LITERAL,t,e,o||SqlOperationType.EQ);export const GT=e=>OP(SqlOperationType.GT,e);export const GE=e=>OP(SqlOperationType.GE,e);export const LT=e=>OP(SqlOperationType.LT,e);export const LE=e=>OP(SqlOperationType.LE,e);export const EQ=e=>OP(SqlOperationType.EQ,e);export const NE=e=>OP(SqlOperationType.NE,e);export const IN=e=>OP(SqlOperationType.IN,e);export const NOT_IN=e=>OP(SqlOperationType.NOT_IN,e);export const IS_NULL=()=>OP(SqlOperationType.IS_NULL);export const IS_NOT_NULL=()=>OP(SqlOperationType.IS_NOT_NULL);export const LIKE=e=>OP(SqlOperationType.LIKE,e);export const NOT_LIKE=e=>OP(SqlOperationType.NOT_LIKE,e);export const SmartDbDateRegexp=/^(\d{4}-[01]\d-[0-3]\d [0-2]\d:[0-5]\d:[0-5]\d)(Z| GMT| GMT[-+]\d{1,2})?$/;export const SmartDbTimestampRegexp=/^(\d{4}-[01]\d-[0-3]\d [0-2]\d:[0-5]\d:[0-5]\d\.\d{3})(Z| GMT| GMT[-+]\d{1,2})?$/;export function toSmartDbDate(e){let t;return e&&(_.isNumber(e)&&(e=new Date(e)),t=e.toISOString().substr(0,19).replace("T"," ")),t}export function toSmartDbTimestamp(e){let t;return e&&(_.isNumber(e)&&(e=new Date(e)),t=e.toISOString().substr(0,23).replace("T"," ")),t}export function smartDbToDate(e){let t=null;return _.isDate(e)?t=e:(_.isNumber(e)||_.isString(e)&&(e.match(SmartDbDateRegexp)||e.match(SmartDbTimestampRegexp)))&&(t=new Date(e)),t}
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.validDateTimeFormats=exports.SmartDbTimestampRegexp=exports.SmartDbDateRegexp=exports.NOT_LIKE=exports.LIKE=exports.IS_NOT_NULL=exports.IS_NULL=exports.NOT_IN=exports.IN=exports.NE=exports.EQ=exports.LE=exports.LT=exports.GE=exports.BETWEEN=exports.GT=exports.LITERAL=exports.NVL=exports.COALESCE=exports.AVG=exports.SUM=exports.MIN=exports.MAX=exports.COUNT_FIELD=exports.COUNT=exports.FIELD=exports.VALUE=exports.OP=void 0,exports.toSmartDbDate=toSmartDbDate,exports.toSmartDbTimestamp=toSmartDbTimestamp,exports.toSmartZoneTimestamp=toSmartZoneTimestamp,exports.smartDbToDate=smartDbToDate,exports.smartDbToDateTime=smartDbToDateTime;var smart_db_interfaces_1=require("./smart-db-interfaces"),luxon_1=require("luxon"),OP=function(e,t,r){return r?{operation:e,value:t,literalOperation:r}:{operation:e,value:t}};exports.OP=OP;var VALUE=function(e,t,r){return{operation:smart_db_interfaces_1.SqlFieldOperationType.VALUE,value:e,alias:t,literal:r}};exports.VALUE=VALUE;var FIELD=function(e,t){return{operation:smart_db_interfaces_1.SqlFieldOperationType.FIELD,value:e,alias:t}};exports.FIELD=FIELD;var COUNT=function(e,t){return{operation:smart_db_interfaces_1.SqlFieldOperationType.COUNT,value:e,alias:t}};exports.COUNT=COUNT;var COUNT_FIELD=function(e,t){return{operation:smart_db_interfaces_1.SqlFieldOperationType.COUNT_FIELD,value:e,alias:t}};exports.COUNT_FIELD=COUNT_FIELD;var MAX=function(e,t){return{operation:smart_db_interfaces_1.SqlFieldOperationType.MAX,value:e,alias:t}};exports.MAX=MAX;var MIN=function(e,t){return{operation:smart_db_interfaces_1.SqlFieldOperationType.MIN,value:e,alias:t}};exports.MIN=MIN;var SUM=function(e,t){return{operation:smart_db_interfaces_1.SqlFieldOperationType.SUM,value:e,alias:t}};exports.SUM=SUM;var AVG=function(e,t){return{operation:smart_db_interfaces_1.SqlFieldOperationType.AVG,value:e,alias:t}};exports.AVG=AVG;var COALESCE=function(e,t){return{operation:smart_db_interfaces_1.SqlFieldOperationType.COALESCE,value:e,alias:t}};exports.COALESCE=COALESCE;var NVL=function(e,t){return(0,exports.COALESCE)(e,t)};exports.NVL=NVL;var LITERAL=function(e,t){return(0,exports.OP)(smart_db_interfaces_1.SqlOperationType.LITERAL,e,t)};exports.LITERAL=LITERAL;var GT=function(e){return(0,exports.OP)(smart_db_interfaces_1.SqlOperationType.GT,e)};exports.GT=GT;var BETWEEN=function(e,t){return(0,exports.OP)(smart_db_interfaces_1.SqlOperationType.BETWEEN,[e,t])};exports.BETWEEN=BETWEEN;var GE=function(e){return(0,exports.OP)(smart_db_interfaces_1.SqlOperationType.GE,e)};exports.GE=GE;var LT=function(e){return(0,exports.OP)(smart_db_interfaces_1.SqlOperationType.LT,e)};exports.LT=LT;var LE=function(e){return(0,exports.OP)(smart_db_interfaces_1.SqlOperationType.LE,e)};exports.LE=LE;var EQ=function(e){return(0,exports.OP)(smart_db_interfaces_1.SqlOperationType.EQ,e)};exports.EQ=EQ;var NE=function(e){return(0,exports.OP)(smart_db_interfaces_1.SqlOperationType.NE,e)};exports.NE=NE;var IN=function(e){return(0,exports.OP)(smart_db_interfaces_1.SqlOperationType.IN,e)};exports.IN=IN;var NOT_IN=function(e){return(0,exports.OP)(smart_db_interfaces_1.SqlOperationType.NOT_IN,e)};exports.NOT_IN=NOT_IN;var IS_NULL=function(){return(0,exports.OP)(smart_db_interfaces_1.SqlOperationType.IS_NULL)};exports.IS_NULL=IS_NULL;var IS_NOT_NULL=function(){return(0,exports.OP)(smart_db_interfaces_1.SqlOperationType.IS_NOT_NULL)};exports.IS_NOT_NULL=IS_NOT_NULL;var LIKE=function(e){return(0,exports.OP)(smart_db_interfaces_1.SqlOperationType.LIKE,e)};exports.LIKE=LIKE;var NOT_LIKE=function(e){return(0,exports.OP)(smart_db_interfaces_1.SqlOperationType.NOT_LIKE,e)};function toSmartDbDate(e,t,r){if(!e)throw"no date given to toSmartDbDate()";var o=void 0;return o="number"==typeof e?luxon_1.DateTime.fromMillis(e,{zone:t}):e instanceof Date?luxon_1.DateTime.fromJSDate(e,{zone:t}):e,t&&r?"UTC"==t.toUpperCase()||"GMT"==t.toUpperCase()?o.toFormat("yyyy-MM-dd HH:mm:ss")+"Z":o.toFormat("yyyy-MM-dd HH:mm:ssZZ"):o.toFormat("yyyy-MM-dd HH:mm:ss")}function toSmartDbTimestamp(e,t){var r=smartDbToDateTime(null!=e?e:new Date);return t?r.setZone(t).toFormat("yyyy-MM-dd HH:mm:ss.uZZ").replace("+00:00","Z"):r.toFormat("yyyy-MM-dd HH:mm:ss.u")}function toSmartZoneTimestamp(e,t,r){var o=null;if(e){var a=void 0;a="number"==typeof e?luxon_1.DateTime.fromMillis(e,{zone:t}):e instanceof Date?luxon_1.DateTime.fromJSDate(e,{zone:t}):e.setZone(t),o=r?a.toFormat("yyyy-MM-dd HH:mm:ss.u"):a.toFormat("yyyy-MM-dd HH:mm:ss.uZZ").replace("+00:00","Z")}return o}function smartDbToDate(e,t){var r=smartDbToDateTime(e,t);return r&&r.isValid?r.toJSDate():null}function smartDbToDateTime(e,t){var r=null;if(e)if("number"==typeof e)r=luxon_1.DateTime.fromMillis(e,{zone:t});else if("string"==typeof e){var o=exports.validDateTimeFormats.find(function(t){return luxon_1.DateTime.fromFormat(e,t).isValid});o&&(r=luxon_1.DateTime.fromFormat(e,o,{zone:t}))}else r=e instanceof Date?luxon_1.DateTime.fromJSDate(e,{zone:t}):e.setZone(t);return r}exports.NOT_LIKE=NOT_LIKE,exports.SmartDbDateRegexp=/^(\d{4}-[01]\d-[0-3]\d [0-2]\d:[0-5]\d:[0-5]\d)(Z|[+-]\d\d:\d\d)?$/,exports.SmartDbTimestampRegexp=/^(\d{4}-[01]\d-[0-3]\d [0-2]\d:[0-5]\d:[0-5]\d\.\d{3})(Z|[+-]\d\d:\d\d)?$/,exports.validDateTimeFormats=["yyyy-MM-dd","yyyy-MM-ddZZ","yyyy-MM-dd HH:mm:ss","yyyy-MM-dd HH:mm:ssZZ","yyyy-MM-dd HH:mm:ss.u","yyyy-MM-dd HH:mm:ss.uZZ","yyyy-MM-dd'T'HH:mm:ss","yyyy-MM-dd'T'HH:mm:ssZZ","yyyy-MM-dd'T'HH:mm:ss.u","yyyy-MM-dd'T'HH:mm:ss.uZZ"];

package/smart-db-interfaces.d.ts

@@ -1,35 +1,129 @@
+import { Observable } from "rxjs";
 import { AbstractModel } from "./models/abstract-model";
+import { SmartDbVersionViewModel } from "./models/smart-db-version-view-model";
 import { SmartDbDictionary } from "./models/smart-db-dictionary";
-export interface SmartDbOptions {
-    module: string;
-    sqlFilesDirectory: string;
-    smartDbDictionary?: typeof SmartDbDictionary | any[];
+import { SmartDb } from "./smart-db";
+import { SmartLog, SmartLogOptions } from "@egi/smart-log";
+import { SmartDbSqlBuildData } from "./smart-db-sql-build-data";
+import { SmartError } from "./smart-error";
+import { SmartDbDateTimeMode, SmartToolOptions } from "./smart-tools";
+/**
+ * Lifecycle states of a {@link SmartDb} database connection.
+ * - `INIT` — object created, connection not yet attempted.
+ * - `PREPARING` — driver is establishing the connection.
+ * - `CONNECTED` — connection established; schema upgrades may still be running.
+ * - `READY` — fully initialized and ready for queries.
+ * - `CLOSED` — connection has been closed.
+ * - `ERROR` — initialization or connection failed; check {@link SmartDb.lastError}.
+ */
+export declare enum SmartDbReadyState {
+    INIT = 0,
+    PREPARING = 1,
+    CONNECTED = 2,
+    READY = 3,
+    CLOSED = 4,
+    ERROR = 5
+}
+export interface ModelClass<T> {
+    attributeMap: ModelAttributeMap;
+    new (): T;
+    getClassName(): string;
+    getTableName(): string;
+    getPkSequenceName(): string;
+    getPrimaryKey(): string;
+    from(other: any): any;
+    getPrimaryKeyName(): string;
+}
+export interface DbDictionaryEntry {
+    cls: ModelClass<any>;
+}
+/** Configuration options passed to the {@link SmartDb} constructor. */
+export interface SmartDbOptions<T extends SmartDb<T>> extends SmartToolOptions {
+    /** When `true`, skip schema upgrades and only establish the connection (sets state to READY after CONNECTED). */
+    connectOnly?: boolean;
+    /** When `true`, do not call {@link SmartDb.initDb} from the constructor. Call it manually later. */
+    delayInit?: boolean;
+    /** When `true`, persists log entries to the `smart_db_log` database table once it exists. */
+    dbLogging?: boolean;
+    /** Logging configuration (log level, format, etc.). */
+    logOptions?: SmartLogOptions;
+    /**
+     * One or more module names to initialize via the upgrade manager.
+     * Each module must have a corresponding `${module}-init.sql` file in the SQL assets directory.
+     */
+    module?: string | string[];
+    /** When `true`, LIKE patterns with `%` or `_` emit an explicit `ESCAPE '\\'` clause (needed for Oracle). */
+    needsExplicitEscape?: boolean;
+    /**
+     * Callback invoked once the database reaches READY state (or ERROR).
+     * Receives the database instance and an error object if initialization failed.
+     */
+    onReady?: (db: T, error?: any) => void;
+    /** When `true`, suppress all log output (sets log level to Fatal). */
+    silent?: boolean;
+    /** When `true`, skip automatic schema upgrades during {@link SmartDb.initDb}. */
     skipAutoUpgrade?: boolean;
+    /** One or more dictionary classes providing default data for lookup tables. */
+    smartDbDictionary?: typeof SmartDbDictionary | (typeof SmartDbDictionary)[];
+    /** Directory path where SQL upgrade script files are located. Defaults to the built-in assets directory. */
+    sqlFilesDirectory?: string;
 }
+/** Result returned by INSERT/UPDATE/DELETE statement execution. */
 export interface SmartDbRunResult {
-    lastId: number;
-    changes: number;
+    /** Number of rows affected by the statement (alias for `changes` on some drivers). */
     affected: number;
+    /** Number of rows changed by the statement. */
+    changes: number;
+    /** Auto-generated primary key of the last inserted row (0 for UPDATE/DELETE). */
+    lastId: number;
 }
+/** Metadata about a database table returned by {@link SmartDb.getTableInfo}. */
 export interface SmartDbTableInfo {
-    name: string;
+    /** Descriptions of each column in the table. */
     fields: SmartDbFieldDescription[];
+    /** The table name as it appears in the database. */
+    name: string;
+    /** For Oracle: the sequence name used to generate PK values, if any. */
+    pkSequenceName?: string;
 }
+/** Metadata about a single column in a database table. */
 export interface SmartDbFieldDescription {
+    /** Column index (used by SQLite). */
     cid?: string | number;
-    name: string;
-    type: string;
-    virtual?: boolean;
-    notNull?: boolean;
+    /** Full database type string including precision/scale, e.g. `"VARCHAR2(100)"`. */
+    dbFullType: string;
+    /** Base database type, e.g. `"VARCHAR2"`, `"INTEGER"`, `"DATE"`. */
+    dbType: string;
+    /** Default value for the column, if any. */
     defaultValue?: number | string | boolean;
+    /** `true` if this column is (part of) the primary key. */
     isPk?: boolean;
+    /** Column name as it appears in the database. */
+    name: string;
+    /** `true` if the column has a NOT NULL constraint. */
+    notNull?: boolean;
+    /** `true` if this is a virtual/computed column. */
+    virtual?: boolean;
 }
+/** Describes a field-to-field or field-to-value comparison used inside a {@link SqlWhere} `expression` clause. */
 export interface SmartDbSqlComparison {
+    /** The left-hand side of the comparison: a column name or a {@link SqlFieldDescriptor}. */
     compare: string | SqlFieldDescriptor;
-    with: string | SqlFieldDescriptor;
+    /** The comparison operator. Defaults to `EQ` (`=`) when omitted. */
     operation?: SqlOperationType;
+    /** The right-hand side: a scalar value or a {@link SqlFieldDescriptor}. */
+    with: SqlValueType | SqlFieldDescriptor;
 }
-export declare type SqlValueType = string | number | boolean | Date;
+/** Scalar value types accepted as SQL parameter values. */
+export type SqlValueType = string | number | boolean | Date | null;
+/** Names of value types accepted as SQL parameter values. */
+export type SqlValueTypes = "string" | "number" | "boolean" | "Date" | "any" | "clob" | "SqlValueType";
+/**
+ * Controls how column names are styled in query results.
+ * - `Database` — original column names as returned by the database (e.g. `CREATED_AT`).
+ * - `TypeScript` — camelCase aliases defined in the model's attribute map (e.g. `createdAt`).
+ * - `All` — both styles are included in the result objects.
+ */
 export declare enum FieldNamingStyle {
     Database = 0,
     TypeScript = 1,
@@ -39,58 +133,143 @@ export interface GenericModelData {
     [key: string]: any;
 }
 export interface AttributeInfo {
-    attribute: string;
-    type: string;
     alias?: string;
-    physical?: boolean;
-    virtual?: boolean;
     alternative?: boolean;
+    attribute: string;
+    dbFullType?: string;
+    dbType?: string;
+    physical?: boolean;
+    type: SqlValueTypes;
     typeScriptStyle?: boolean;
+    virtual?: boolean;
+}
+export interface ModelDbOptions {
+    dateTimeMode?: SmartDbDateTimeMode;
+    useNativeDate?: boolean;
+}
+export interface MakeDbValueOptions extends ModelDbOptions {
+    dbFullType?: string;
 }
 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;
+    getTableName: () => string;
 }
+/**
+ * Recursive WHERE clause builder.
+ *
+ * Each key in the object is interpreted as a column name whose value must match,
+ * unless it is one of the reserved keys below:
+ *
+ * - `and` — sub-clause(s) joined with `AND`.
+ * - `or` — sub-clause(s) joined with `OR`.
+ * - `expression` — array of {@link SmartDbSqlComparison} for field-to-field comparisons.
+ *
+ * Plain key/value pairs generate equality conditions (or `LIKE` when the value contains `%`/`_`).
+ * Pass a {@link SqlOperation} object as the value for other operators (GT, IN, IS NULL, etc.).
+ * Pass an array as the value to generate an `IN (...)` condition automatically.
+ * Pass `null` as the value to generate an `IS NULL` condition.
+ *
+ * @example
+ * ```ts
+ * // WHERE status = 'active' AND age >= 18
+ * const where: SqlWhere = {
+ *   status: 'active',
+ *   age: { operation: SqlOperationType.GE, value: 18 }
+ * };
+ * ```
+ */
 export interface SqlWhere {
-    or?: SqlWhere | SqlWhere[];
     and?: SqlWhere | SqlWhere[];
     expression?: SmartDbSqlComparison[];
+    or?: SqlWhere | SqlWhere[];
     [key: string]: SqlValueType | SqlValueType[] | SqlOperation | SqlWhere | SqlWhere[] | SmartDbSqlComparison[];
 }
-export declare type SqlUpdateValues = GenericModelData;
-export declare type SqlOrderBy = string | string[];
-declare type SqlGroupBy = string | string[];
+/** A plain object of `{columnName: value}` pairs used for INSERT and UPDATE values. */
+export type SqlUpdateValues = GenericModelData;
+/**
+ * ORDER BY specification. A single field name, optionally suffixed with `ASC` or `DESC`,
+ * or an array of such strings for multi-column ordering.
+ * @example `"name DESC"` or `["lastName ASC", "firstName ASC"]`
+ */
+export type SqlOrderBy = string | string[];
+type SqlGroupBy = string | string[];
+/** LIMIT and OFFSET values for paginating query results. */
 export interface SqlLimit {
-    offset?: number;
+    /** Maximum number of rows to return. */
     limit?: number;
+    /** Number of rows to skip before returning results. */
+    offset?: number;
 }
+/**
+ * Describes one section of a UNION / INTERSECT / MINUS set operation.
+ * Used in the `union`, `intersect`, and `minus` arrays of {@link SmartDbSqlOptions}.
+ */
 export interface SectionDescription<T extends AbstractModel<T, D>, D extends GenericModelData> {
-    model: (new () => T) | string;
-    where?: SqlWhere;
+    /** Fields to SELECT in this section. */
     fields?: string | SqlFieldDescriptor | (string | SqlFieldDescriptor)[] | null;
+    /** GROUP BY clause for this section. */
     groupBy?: SqlGroupBy;
+    /** LIMIT/OFFSET for this section. */
     limit?: SqlLimit;
+    /** The model class or table name for this section. */
+    model: ModelClass<T> | string;
+    /** WHERE clause for this section. */
+    where?: SqlWhere;
 }
+/**
+ * Full set of options for {@link SmartDb.get} and related query methods.
+ *
+ * @typeParam T - The model class (extends {@link AbstractModel}).
+ * @typeParam D - The plain data interface for the model.
+ */
 export interface SmartDbSqlOptions<T extends AbstractModel<T, D>, D extends GenericModelData> {
-    firstOnly?: boolean;
-    where?: SqlWhere;
-    fields?: string | SqlFieldDescriptor | (string | SqlFieldDescriptor)[] | null;
-    orderBy?: SqlOrderBy;
-    groupBy?: SqlGroupBy;
-    limit?: SqlLimit;
+    /**
+     * When `true`, a multi-column result row is collapsed into a single value
+     * (useful when SELECTing a single aggregate column).
+     */
+    collapseRow?: boolean;
+    /** When `true`, wraps the field list in `COUNT(...)` and returns a numeric count. */
     count?: boolean;
+    /** When `true`, adds `DISTINCT` to the SELECT clause. */
     distinct?: boolean;
-    collapseRow?: boolean;
+    /**
+     * Fields to SELECT. Accepts a comma-separated string, a single field name,
+     * a {@link SqlFieldDescriptor}, or an array of field names/descriptors.
+     * Pass `null` or omit to select all columns (`*`).
+     */
+    fields?: string | SqlFieldDescriptor | (string | SqlFieldDescriptor)[] | null;
+    /** When `true`, returns only the first result row instead of an array. */
+    firstOnly?: boolean;
+    /** GROUP BY clause: a field name or array of field names. */
+    groupBy?: SqlGroupBy;
+    /** HAVING clause applied after GROUP BY. Uses the same {@link SqlWhere} syntax. */
+    having?: SqlWhere;
+    /** SQLite `INDEXED BY` hint to force use of a specific index. */
     indexedBy?: string;
-    union?: SectionDescription<T, D> | SectionDescription<T, D>[];
-    minus?: SectionDescription<T, D> | SectionDescription<T, D>[];
+    /** One or more INTERSECT sections to append to the query. */
     intersect?: SectionDescription<T, D> | SectionDescription<T, D>[];
+    /** LIMIT and OFFSET for pagination. */
+    limit?: SqlLimit;
+    /** One or more MINUS (EXCEPT) sections to append to the query. */
+    minus?: SectionDescription<T, D> | SectionDescription<T, D>[];
+    /** ORDER BY clause: a field name (optionally with `ASC`/`DESC`) or array of field names. */
+    orderBy?: SqlOrderBy;
+    /** Controls whether results use database column names or camelCase TypeScript aliases. */
     style?: FieldNamingStyle;
+    /** One or more UNION sections to append to the query. */
+    union?: SectionDescription<T, D> | SectionDescription<T, D>[];
+    /** WHERE clause to filter results. */
+    where?: SqlWhere;
 }
+/**
+ * SQL comparison operators used in {@link SqlOperation} and {@link SmartDbSqlComparison}.
+ * Use the helper functions from `smart-db-globals` (e.g. `OP()`, `IN()`, `LITERAL()`)
+ * to construct {@link SqlOperation} objects rather than building them manually.
+ */
 export declare enum SqlOperationType {
     GT = ">",
     GE = ">=",
@@ -105,25 +284,58 @@ export declare enum SqlOperationType {
     IS_NULL = "IS NULL",
     IS_NOT_NULL = "IS NOT NULL",
     LITERAL = "LITERAL",
+    BETWEEN = "BETWEEN",
     VALUE = "VALUE"
 }
+/**
+ * Aggregate/field operations used in {@link SqlFieldDescriptor} for SELECT field expressions.
+ * Use the helper functions `COUNT()`, `SUM()`, `AVG()`, `MIN()`, `MAX()`, `FIELD()`, `VALUE()`
+ * from `smart-db-globals` to create descriptors.
+ */
 export declare enum SqlFieldOperationType {
     VALUE = "VALUE",
     FIELD = "FIELD",
     COUNT = "COUNT",
+    MIN = "MIN",
+    MAX = "MAX",
+    AVG = "AVG",
+    SUM = "SUM",
+    COUNT_FIELD = "COUNT_FIELD",
     COALESCE = "COALESCE"
 }
+/**
+ * Describes a SELECT field expression such as an aggregate function or aliased column.
+ * Construct instances using the helper functions exported from `smart-db-globals`:
+ * `COUNT()`, `SUM()`, `AVG()`, `MIN()`, `MAX()`, `FIELD()`, `VALUE()`.
+ */
 export interface SqlFieldDescriptor {
-    operation: SqlFieldOperationType;
-    value: SqlFieldDescriptor | SqlValueType | (SqlFieldDescriptor | SqlValueType)[];
+    /** Optional SQL alias (`AS alias`) for the expression. */
     alias?: string;
+    /** When `true`, the `value` is emitted verbatim into SQL without quoting or translation. */
     literal?: boolean;
+    /** The aggregate or field operation to apply. */
+    operation: SqlFieldOperationType;
+    /** The operand(s) for the operation: a field name, scalar value, or nested descriptor. */
+    value: SqlFieldDescriptor | SqlValueType | (SqlFieldDescriptor | SqlValueType)[];
 }
+/**
+ * A WHERE condition with an explicit operator.
+ * Used as the value for a column key in a {@link SqlWhere} object.
+ * Prefer the helper functions `OP()`, `IN()`, `NE()`, `LITERAL()` from `smart-db-globals`.
+ *
+ * @example
+ * ```ts
+ * // WHERE age BETWEEN 18 AND 65
+ * const where: SqlWhere = { age: { operation: SqlOperationType.BETWEEN, value: [18, 65] } };
+ * ```
+ */
 export interface SqlOperation {
+    /** For LITERAL operations: the operator to use before the literal value. Defaults to `EQ`. */
+    literalOperation?: SqlOperationType;
+    /** The comparison operator. */
     operation: SqlOperationType;
+    /** The value(s) to compare against. Use an array for IN/NOT_IN and BETWEEN. */
     value: SqlValueType | SqlValueType[];
-    key?: string;
-    literalOperation?: SqlOperationType;
 }
 export interface KeyValueList {
     [key: string]: SqlValueType;
@@ -135,8 +347,86 @@ export interface SmartDbSqlBuildDataResults {
     sql: string;
     values: SqlValueType[];
 }
-export interface SmartDbDatabase {
-}
 export interface SmartDbConnector {
 }
+/**
+ * Public interface of {@link SmartDb}.
+ * Describes all methods and properties available to consumers of any SmartDB driver.
+ */
+export interface SmartDbInterface {
+    /** `true` when SQL statements are being written to the database log table. */
+    readonly dbLogging: boolean;
+    /** `true` when the database connection has been established (CONNECTED or later). */
+    readonly isConnected: boolean;
+    /** `true` when the database is fully initialized and ready for queries. */
+    readonly isReady: boolean;
+    /** The last error that occurred during initialization or query execution. */
+    lastError: SmartError;
+    /** Observable that emits every time the ready-state changes. */
+    readonly onReady: Observable<SmartDbReadyState>;
+    /** Current lifecycle state of the database connection. */
+    readonly readyState: SmartDbReadyState;
+    /** `true` when the driver supports synchronous calls (SQLite only). */
+    readonly supportSyncCalls: boolean;
+    /** Active date/time conversion mode for this connection. */
+    readonly dateTimeMode: SmartDbDateTimeMode;
+    /** Returns a string identifying the database type, e.g. `"sqlite"`, `"mysql"`, `"oracle"`. */
+    getDatabaseType(): string;
+    /** Returns metadata about the columns of a database table. */
+    getTableInfo(table: string): Promise<SmartDbTableInfo>;
+    /** Returns the raw underlying driver connection object. */
+    getDb(): any;
+    /** Returns the current SmartDb options. */
+    getOptions(): SmartDbOptions<any>;
+    /** Resolves when the database reaches `targetState` (defaults to READY). */
+    databaseReady(targetState?: SmartDbReadyState): Promise<SmartDbReadyState>;
+    /** Runs schema upgrade scripts and marks the database as READY. */
+    initDb(): Promise<SmartDbVersionViewModel[]>;
+    /** Closes the connection asynchronously. */
+    close(): Promise<boolean>;
+    /** Closes the connection synchronously. */
+    closeSync(): boolean;
+    commit(): Promise<void>;
+    commitSync(): void;
+    rollback(): Promise<void>;
+    rollbackSync(): void;
+    hasTransaction(): boolean;
+    hasConcurrentTransactions(): boolean;
+    get<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | ModelClass<T>, options: SmartDbSqlOptions<T, D>): Promise<(T | D)[] | T | D | SqlValueType | IndexedGenericModelData<T, D> | string | string[] | false>;
+    /** Returns the first matching model instance. Alias for `get()` with `firstOnly: true`. */
+    async<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | ModelClass<T>, options: SmartDbSqlOptions<T, D>): Promise<T>;
+    getFirst<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | ModelClass<T>, where?: SqlWhere, fields?: SqlFieldDescriptor | string | (SqlFieldDescriptor | string)[] | null, orderBy?: SqlOrderBy): Promise<T>;
+    getAll<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | ModelClass<T>, where?: SqlWhere, fields?: string | string[] | null, orderBy?: SqlOrderBy, limit?: SqlLimit): Promise<T[]>;
+    getAllWithOptions<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | ModelClass<T>, options: SmartDbSqlOptions<T, D>): Promise<T[]>;
+    insert<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | ModelClass<T>, values: SqlUpdateValues | T): Promise<number>;
+    update<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | ModelClass<T>, values: SqlUpdateValues | T, where?: SqlWhere): Promise<number>;
+    delete<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | ModelClass<T>, where?: SqlWhere): Promise<number>;
+    exists<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | ModelClass<T>, type?: "view" | "table" | "index", indexTableName?: string): Promise<boolean>;
+    getSync<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | ModelClass<T>, options: SmartDbSqlOptions<T, D>): (T | D)[] | T | D | SqlValueType | IndexedGenericModelData<T, D> | string | string[] | false;
+    getFirstSync<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | ModelClass<T>, where?: SqlWhere, fields?: SqlFieldDescriptor | string | (SqlFieldDescriptor | string)[] | null, orderBy?: SqlOrderBy): T | false;
+    getFirstWithOptionsSync<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | ModelClass<T>, options: SmartDbSqlOptions<T, D>): T | false;
+    getAllSync<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | ModelClass<T>, where?: SqlWhere, fields?: string | string[] | null, orderBy?: SqlOrderBy, limit?: SqlLimit): T[] | false;
+    getAllWithOptionsSync<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | ModelClass<T>, options: SmartDbSqlOptions<T, D>): T[] | false;
+    insertSync<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | ModelClass<T>, values: SqlUpdateValues | T): number | false;
+    updateSync<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | ModelClass<T>, values: SqlUpdateValues | T, where?: SqlWhere): number | false;
+    deleteSync<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | ModelClass<T>, where?: SqlWhere): number | false;
+    existsSync<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | ModelClass<T>, type?: "view" | "table" | "index", indexTableName?: string): boolean;
+    exec(script: string, params?: SqlValueType[]): Promise<void>;
+    execSync(script: string, params?: SqlValueType[]): boolean;
+    execScript(script: string, ignoreDropError?: boolean): Promise<void>;
+    execScriptSync(script: string): void;
+    query(script: string, params?: SqlValueType[]): Promise<GenericModelData[]>;
+    querySync(script: string, params?: SqlValueType[]): GenericModelData[];
+    buildSelectStatement<T extends AbstractModel<T, D>, D extends GenericModelData>(modelClass: string | ModelClass<T>, options: SmartDbSqlOptions<T, D>): SmartDbSqlBuildData;
+    getDbConnector(): string | SmartDbConnector;
+    getDbQuote(): string;
+    getLastBuildData<T extends AbstractModel<T, D>, D extends GenericModelData>(): SmartDbSqlBuildData;
+    getLastError(): SmartError;
+    getLogger(): SmartLog;
+    getModuleVersions(): SmartDbVersionViewModel[];
+    makeDbValue(value: SqlValueType, options?: MakeDbValueOptions): SqlValueType;
+    toDate(d: Date | number | string): Date | null;
+    toDbDate(d: Date | number): string;
+    toDbTimestamp(d: Date | number): string;
+}
 export {};

package/smart-db-interfaces.js

@@ -1 +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.NOT_IN="NOT 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={}));
+"use strict";var SmartDbReadyState,FieldNamingStyle,SqlOperationType,SqlFieldOperationType;Object.defineProperty(exports,"__esModule",{value:!0}),exports.SqlFieldOperationType=exports.SqlOperationType=exports.FieldNamingStyle=exports.SmartDbReadyState=void 0,function(e){e[e.INIT=0]="INIT",e[e.PREPARING=1]="PREPARING",e[e.CONNECTED=2]="CONNECTED",e[e.READY=3]="READY",e[e.CLOSED=4]="CLOSED",e[e.ERROR=5]="ERROR"}(SmartDbReadyState||(exports.SmartDbReadyState=SmartDbReadyState={})),function(e){e[e.Database=0]="Database",e[e.TypeScript=1]="TypeScript",e[e.All=2]="All"}(FieldNamingStyle||(exports.FieldNamingStyle=FieldNamingStyle={})),function(e){e.GT=">",e.GE=">=",e.LT="<",e.LE="<=",e.EQ="=",e.NE="!=",e.IN="IN",e.NOT_IN="NOT 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.BETWEEN="BETWEEN",e.VALUE="VALUE"}(SqlOperationType||(exports.SqlOperationType=SqlOperationType={})),function(e){e.VALUE="VALUE",e.FIELD="FIELD",e.COUNT="COUNT",e.MIN="MIN",e.MAX="MAX",e.AVG="AVG",e.SUM="SUM",e.COUNT_FIELD="COUNT_FIELD",e.COALESCE="COALESCE"}(SqlFieldOperationType||(exports.SqlFieldOperationType=SqlFieldOperationType={}));

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

@@ -1,8 +1,17 @@
 import { SmartDbSqlBuildDataResults, SqlValueType } from "./smart-db-interfaces";
+export declare enum SmartDbSqlBuildDataType {
+    Select = 0,
+    Insert = 1,
+    Update = 2,
+    Delete = 3,
+    Other = 4
+}
 export declare class SmartDbSqlBuildData {
+    modelName: string;
     sql: string;
+    type: SmartDbSqlBuildDataType;
     values: SqlValueType[];
-    constructor(sql?: string, values?: SqlValueType[]);
+    constructor(sql?: string, modelName?: string, values?: SqlValueType[]);
     append(data: SmartDbSqlBuildData): void;
     toString(): string;
     results(): SmartDbSqlBuildDataResults;

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

@@ -1 +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}}}
+"use strict";var SmartDbSqlBuildDataType,__read=this&&this.__read||function(t,e){var r="function"==typeof Symbol&&t[Symbol.iterator];if(!r)return t;var a,l,i=r.call(t),s=[];try{for(;(void 0===e||e-- >0)&&!(a=i.next()).done;)s.push(a.value)}catch(t){l={error:t}}finally{try{a&&!a.done&&(r=i.return)&&r.call(i)}finally{if(l)throw l.error}}return s},__spreadArray=this&&this.__spreadArray||function(t,e,r){if(r||2===arguments.length)for(var a,l=0,i=e.length;l<i;l++)!a&&l in e||(a||(a=Array.prototype.slice.call(e,0,l)),a[l]=e[l]);return t.concat(a||Array.prototype.slice.call(e))};Object.defineProperty(exports,"__esModule",{value:!0}),exports.SmartDbSqlBuildData=exports.SmartDbSqlBuildDataType=void 0,function(t){t[t.Select=0]="Select",t[t.Insert=1]="Insert",t[t.Update=2]="Update",t[t.Delete=3]="Delete",t[t.Other=4]="Other"}(SmartDbSqlBuildDataType||(exports.SmartDbSqlBuildDataType=SmartDbSqlBuildDataType={}));var SmartDbSqlBuildData=function(){function t(t,e,r){switch(this.sql=null!=t?t:"",this.sql.substring(0,6)){case"SELECT":this.type=SmartDbSqlBuildDataType.Select;break;case"INSERT":this.type=SmartDbSqlBuildDataType.Insert;break;case"UPDATE":this.type=SmartDbSqlBuildDataType.Update;break;case"DELETE":this.type=SmartDbSqlBuildDataType.Delete;break;default:this.type=SmartDbSqlBuildDataType.Other}this.values=r||[],this.modelName=e}return t.prototype.append=function(t){this.sql=this.sql.trim()+" "+t.sql.trim(),this.values=__spreadArray(__spreadArray([],__read(this.values),!1),__read(t.values),!1)},t.prototype.toString=function(){return this.sql+" <= ("+this.values.join(", ")+")"},t.prototype.results=function(){return{sql:this.sql,values:this.values}},t}();exports.SmartDbSqlBuildData=SmartDbSqlBuildData;

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

@@ -1,12 +1,14 @@
 import { SmartDbVersionViewModel } from "./models/smart-db-version-view-model";
 import { SmartDb } from "./smart-db";
-import { SmartDbOptions } from "./smart-db-interfaces";
+import { SmartLog } from "@egi/smart-log";
 export declare class SmartDbUpgradeManager {
     private db;
-    private log;
-    constructor(db: SmartDb);
+    private sqlScriptDirectory;
+    constructor(db: SmartDb<any>, sqlScriptDirectory: string);
+    get log(): SmartLog;
+    setSqlScriptDirectory(dir: string): void;
     hasDatabaseModule(module: string): Promise<boolean>;
-    prepareDatabase(options: SmartDbOptions): Promise<SmartDbVersionViewModel>;
+    prepareDatabaseModule(module: string): Promise<SmartDbVersionViewModel>;
     private upgradeDatabase;
     private executeScriptsSequentially;
 }

package/smart-db-upgrade-manager.js

@@ -1 +1 @@
-import*as fs from"fs";import _ from"lodash";import{SmartDbVersionModel}from"./models/smart-db-version-model";import{SmartDbVersionViewModel}from"./models/smart-db-version-view-model";import{SmartErrorLocation}from"./smart-error";export class SmartDbUpgradeManager{constructor(e){this.db=e,this.log=e.getLogger()}hasDatabaseModule(e){return new Promise(((t,r)=>{this.db.exists(SmartDbVersionModel).then((a=>{a?this.db.getFirst(SmartDbVersionModel,{module:e}).then((e=>{t(!!e)})).catch((e=>{r(e)})):t(!1)})).catch((e=>{r(e)}))}))}prepareDatabase(e){return new Promise(((t,r)=>{try{const a=fs.existsSync(e.sqlFilesDirectory)&&fs.statSync(e.sqlFilesDirectory);if(a&&a.isDirectory()){const a=e.sqlFilesDirectory+`/${e.module}-init.sql`;fs.existsSync(a)?this.hasDatabaseModule(e.module).then((o=>{o?(this.log.logInfo(SmartErrorLocation.UpgradeManager,"prepareDatabase",`database module '${e.module}' exists`),this.upgradeDatabase(e).then((r=>{this.log.logInfo(SmartErrorLocation.UpgradeManager,"prepareDatabase",`connected to module '${e.module}' version ${r.versionString}`),t(r)})).catch((e=>{r(e)}))):(this.log.setDbLogging(!1),this.log.logInfo(SmartErrorLocation.UpgradeManager,"prepareDatabase",`database module '${e.module}' doesn't exists - begin creation`),this.db.execScript(a,!0).then((()=>{this.log.setDbLogging(this.db.dbLogging),this.log.logInfo(SmartErrorLocation.UpgradeManager,"prepareDatabase","database module creation complete"),this.hasDatabaseModule(e.module).then((a=>{a?(this.log.logInfo(SmartErrorLocation.UpgradeManager,"prepareDatabase",`successfully initialized database for new module ${e.module}`),this.upgradeDatabase(e).then((r=>{this.log.logInfo(SmartErrorLocation.UpgradeManager,"prepareDatabase",`connected to module '${e.module}' version ${r.versionString}`),t(r)})).catch((e=>{r(e)}))):r("error running database initialization script")})).catch((e=>{r(e)}))})).catch((e=>{r(e)})))})).catch((e=>{r(e)})):r(`missing mandatory '${e.module}-init.sql' file in ${a}`)}else r(`option 'sqlFilesDirectory' (${e.sqlFilesDirectory}) must point to an existing directory (absolute or relative to ${fs.realpathSync(".")})`)}catch(e){r(e)}}))}upgradeDatabase(e){return new Promise(((t,r)=>{this.db.getFirst(SmartDbVersionViewModel,{module:e.module}).then((a=>{a?fs.readdir(e.sqlFilesDirectory,((o,s)=>{if(o)r(`unable to read database files from ${e.sqlFilesDirectory}`);else{let o=[];s.forEach((t=>{const r=new RegExp(`^${e.module}-update.([0-9]{3})\\..*\\.sql$`),s=t.match(r);if(s){parseInt(s[1],10)>a.sequence&&o.push(t)}})),o=_.sortBy(o),this.executeScriptsSequentially(o,e).then((()=>{this.db.getFirst(SmartDbVersionViewModel,{module:e.module},"*","sequence DESC").then((e=>{e?t(SmartDbVersionViewModel.from(e)):r("unable to determine final smart db version")})).catch((e=>{r(e)}))})).catch((e=>{r(e)}))}})):r(`missing version entry for module ${e.module} - add the mandatory insert into smart_db_version statement to your database creation script!`)})).catch((e=>{r(e)}))}))}executeScriptsSequentially(e,t){return new Promise((async(r,a)=>{e&&e.length>0?(this.log.logInfo(SmartErrorLocation.UpgradeManager,"upgradeDatabase",`execute update script '${e[0]}' for module ${t.module}`),await this.db.execScript(`${t.sqlFilesDirectory}/${e[0]}`).then((()=>{this.log.logInfo(SmartErrorLocation.UpgradeManager,"upgradeDatabase",`successfully executed update script '${e[0]}' for module ${t.module}`),1==e.length&&r(!0)})).catch((e=>{a(e)})),e.length>1&&this.executeScriptsSequentially(e.splice(1),t).then((e=>{r(e)})).catch((e=>{a(e)}))):r(!0)}))}}
+"use strict";var __awaiter=this&&this.__awaiter||function(e,t,r,a){return new(r||(r=Promise))(function(n,o){function i(e){try{c(a.next(e))}catch(e){o(e)}}function s(e){try{c(a.throw(e))}catch(e){o(e)}}function c(e){var t;e.done?n(e.value):(t=e.value,t instanceof r?t:new r(function(e){e(t)})).then(i,s)}c((a=a.apply(e,t||[])).next())})},__generator=this&&this.__generator||function(e,t){var r,a,n,o={label:0,sent:function(){if(1&n[0])throw n[1];return n[1]},trys:[],ops:[]},i=Object.create(("function"==typeof Iterator?Iterator:Object).prototype);return i.next=s(0),i.throw=s(1),i.return=s(2),"function"==typeof Symbol&&(i[Symbol.iterator]=function(){return this}),i;function s(s){return function(c){return function(s){if(r)throw new TypeError("Generator is already executing.");for(;i&&(i=0,s[0]&&(o=0)),o;)try{if(r=1,a&&(n=2&s[0]?a.return:s[0]?a.throw||((n=a.return)&&n.call(a),0):a.next)&&!(n=n.call(a,s[1])).done)return n;switch(a=0,n&&(s=[2&s[0],n.value]),s[0]){case 0:case 1:n=s;break;case 4:return o.label++,{value:s[1],done:!1};case 5:o.label++,a=s[1],s=[0];continue;case 7:s=o.ops.pop(),o.trys.pop();continue;default:if(!(n=o.trys,(n=n.length>0&&n[n.length-1])||6!==s[0]&&2!==s[0])){o=0;continue}if(3===s[0]&&(!n||s[1]>n[0]&&s[1]<n[3])){o.label=s[1];break}if(6===s[0]&&o.label<n[1]){o.label=n[1],n=s;break}if(n&&o.label<n[2]){o.label=n[2],o.ops.push(s);break}n[2]&&o.ops.pop(),o.trys.pop();continue}s=t.call(e,o)}catch(e){s=[6,e],a=0}finally{r=n=0}if(5&s[0])throw s[1];return{value:s[0]?s[1]:void 0,done:!0}}([s,c])}}},__values=this&&this.__values||function(e){var t="function"==typeof Symbol&&Symbol.iterator,r=t&&e[t],a=0;if(r)return r.call(e);if(e&&"number"==typeof e.length)return{next:function(){return e&&a>=e.length&&(e=void 0),{value:e&&e[a++],done:!e}}};throw new TypeError(t?"Object is not iterable.":"Symbol.iterator is not defined.")};Object.defineProperty(exports,"__esModule",{value:!0}),exports.SmartDbUpgradeManager=void 0;var fs=require("fs"),smart_db_version_model_1=require("./models/smart-db-version-model"),smart_db_version_view_model_1=require("./models/smart-db-version-view-model"),path=require("node:path"),smart_log_1=require("@egi/smart-log"),SmartDbUpgradeManager=function(){function e(e,t){this.db=e,this.sqlScriptDirectory=t}return Object.defineProperty(e.prototype,"log",{get:function(){return this.db.getLogger()},enumerable:!1,configurable:!0}),e.prototype.setSqlScriptDirectory=function(e){this.sqlScriptDirectory=e},e.prototype.hasDatabaseModule=function(e){return __awaiter(this,void 0,void 0,function(){var t,r;return __generator(this,function(a){switch(a.label){case 0:return[4,this.db.exists(smart_db_version_model_1.SmartDbVersionModel)];case 1:return t=a.sent(),(r=t)?[4,this.db.getFirst(smart_db_version_model_1.SmartDbVersionModel,{module:e})]:[3,3];case 2:r=!!a.sent(),a.label=3;case 3:return[2,r]}})})},e.prototype.prepareDatabaseModule=function(e){return __awaiter(this,void 0,void 0,function(){var t,r,a;return __generator(this,function(n){switch(n.label){case 0:return(r=fs.existsSync(this.sqlScriptDirectory)&&fs.statSync(this.sqlScriptDirectory))&&r.isDirectory()?(a=this.sqlScriptDirectory+"/".concat(e,"-init.sql"),fs.existsSync(a)?(this.log.debug("check module ".concat(e),{type:smart_log_1.SmartLocation.UpgradeManager}),[4,this.hasDatabaseModule(e)]):[3,10]):[3,12];case 1:return n.sent()?(this.log.info("database module '".concat(e,"' exists"),{type:smart_log_1.SmartLocation.UpgradeManager}),[4,this.upgradeDatabase(e)]):[3,3];case 2:case 7:return t=n.sent(),this.log.info("connected to module '".concat(e,"' version ").concat(t.versionString),{type:smart_log_1.SmartLocation.UpgradeManager}),[3,9];case 3:return this.log.setDbWriter(null),this.log.info("database module '".concat(e,"' doesn't exists - begin creation"),{type:smart_log_1.SmartLocation.UpgradeManager}),[4,this.db.execScript(a,!0)];case 4:return n.sent(),this.log.debug("script executed successfully",{type:smart_log_1.SmartLocation.UpgradeManager}),[4,this.db.enableDbLogging()];case 5:return n.sent(),this.log.info("database module creation complete",{type:smart_log_1.SmartLocation.UpgradeManager}),[4,this.hasDatabaseModule(e)];case 6:return n.sent()?(this.log.info("successfully initialized database for new module ".concat(e),{type:smart_log_1.SmartLocation.UpgradeManager}),[4,this.upgradeDatabase(e)]):[3,8];case 8:throw"error running database initialization script - does the initialization script insert version record into table 'smart_db_version'? ";case 9:return[3,11];case 10:throw"missing mandatory '".concat(e,"-init.sql' file in ").concat(a);case 11:return[3,13];case 12:throw"option 'sqlFilesDirectory' (".concat(this.sqlScriptDirectory,") must point to an existing directory for module(s) '").concat(e,"' (absolute or relative to ").concat(fs.realpathSync("."),")");case 13:return[2,t]}})})},e.prototype.upgradeDatabase=function(e){return __awaiter(this,void 0,void 0,function(){var t,r,a,n,o,i=this;return __generator(this,function(s){switch(s.label){case 0:return[4,this.db.getFirst(smart_db_version_view_model_1.SmartDbVersionViewModel,{module:e})];case 1:return(r=s.sent())?(a=fs.readdirSync(this.sqlScriptDirectory),n=[],a.forEach(function(t){var a=new RegExp("^".concat(e,"-update\\.([0-9]{3})(\\..*)?\\.sql$")),o=t.match(a);o&&(parseInt(o[1],10)>r.sequence&&n.push(t))}),n=n.sort().map(function(e){return i.sqlScriptDirectory+"/"+e}),o=!0,n.length>0?(this.log.info("using script directory script '".concat(this.sqlScriptDirectory,"' for module ").concat(e),{type:smart_log_1.SmartLocation.UpgradeManager}),[4,this.executeScriptsSequentially(n,e)]):[3,3]):[3,7];case 2:o=s.sent(),s.label=3;case 3:return o?[4,this.db.getFirst(smart_db_version_view_model_1.SmartDbVersionViewModel,{module:e},"*","sequence DESC")]:[3,5];case 4:if(!(t=s.sent()))throw"unable to determine final smart db version";return[3,6];case 5:throw"upgrade error";case 6:return[3,8];case 7:throw"missing version entry for module ".concat(e," - add the mandatory insert into smart_db_version statement to your database creation script!");case 8:return[2,t]}})})},e.prototype.executeScriptsSequentially=function(e,t){return __awaiter(this,void 0,void 0,function(){var r,a,n,o,i,s,c,l,u;return __generator(this,function(d){switch(d.label){case 0:r=!0,d.label=1;case 1:d.trys.push([1,8,9,10]),a=__values(e),n=a.next(),d.label=2;case 2:if(n.done)return[3,7];o=n.value,i=path.basename(o),d.label=3;case 3:return d.trys.push([3,5,,6]),this.log.info("execute update script '".concat(i,"' for module ").concat(t),{type:smart_log_1.SmartLocation.UpgradeManager}),[4,this.db.execScript(o)];case 4:return d.sent(),this.log.info("successfully executed update script '".concat(i,"' for module ").concat(t),{type:smart_log_1.SmartLocation.UpgradeManager}),[3,6];case 5:return s=d.sent(),this.log.fatal("unable to execute update script '".concat(i,"' for module ").concat(t),{type:smart_log_1.SmartLocation.UpgradeManager,data:s}),r=!1,[3,7];case 6:return n=a.next(),[3,2];case 7:return[3,10];case 8:return c=d.sent(),l={error:c},[3,10];case 9:try{n&&!n.done&&(u=a.return)&&u.call(a)}finally{if(l)throw l.error}return[7];case 10:return[2,r]}})})},e}();exports.SmartDbUpgradeManager=SmartDbUpgradeManager;