@oino-ts/db 0.0.18 → 0.1.0

package/dist/cjs/index.js

@@ -1,21 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OINODB_EMPTY_ROWS = exports.OINODB_EMPTY_ROW = exports.OINODbSwagger = exports.OINODbFactory = exports.OINODbConfig = exports.OINODbSqlBooleanOperation = exports.OINODbSqlLimit = exports.OINODbSqlComparison = exports.OINODbSqlOrder = exports.OINODbSqlFilter = exports.OINODbMemoryDataSet = exports.OINODbDataSet = exports.OINODb = exports.OINODatetimeDataField = exports.OINOBlobDataField = exports.OINOStringDataField = exports.OINONumberDataField = exports.OINOBooleanDataField = exports.OINODbDataField = exports.OINODbModelSet = exports.OINODbDataModel = exports.OINODbApi = exports.OINODbHtmlTemplate = exports.OINODbApiResult = exports.OINOHtmlTemplate = exports.OINOHttpResult = exports.OINOResult = exports.OINOConsoleLog = exports.OINOLogLevel = exports.OINOLog = exports.OINOBenchmark = exports.OINOStr = exports.OINO_DEBUG_PREFIX = exports.OINO_INFO_PREFIX = exports.OINO_WARNING_PREFIX = exports.OINO_ERROR_PREFIX = exports.OINOContentType = void 0;
-const types_1 = require("@oino-ts/types");
-Object.defineProperty(exports, "OINOContentType", { enumerable: true, get: function () { return types_1.OINOContentType; } });
-var types_2 = require("@oino-ts/types");
-Object.defineProperty(exports, "OINO_ERROR_PREFIX", { enumerable: true, get: function () { return types_2.OINO_ERROR_PREFIX; } });
-Object.defineProperty(exports, "OINO_WARNING_PREFIX", { enumerable: true, get: function () { return types_2.OINO_WARNING_PREFIX; } });
-Object.defineProperty(exports, "OINO_INFO_PREFIX", { enumerable: true, get: function () { return types_2.OINO_INFO_PREFIX; } });
-Object.defineProperty(exports, "OINO_DEBUG_PREFIX", { enumerable: true, get: function () { return types_2.OINO_DEBUG_PREFIX; } });
-Object.defineProperty(exports, "OINOStr", { enumerable: true, get: function () { return types_2.OINOStr; } });
-Object.defineProperty(exports, "OINOBenchmark", { enumerable: true, get: function () { return types_2.OINOBenchmark; } });
-Object.defineProperty(exports, "OINOLog", { enumerable: true, get: function () { return types_2.OINOLog; } });
-Object.defineProperty(exports, "OINOLogLevel", { enumerable: true, get: function () { return types_2.OINOLogLevel; } });
-Object.defineProperty(exports, "OINOConsoleLog", { enumerable: true, get: function () { return types_2.OINOConsoleLog; } });
-Object.defineProperty(exports, "OINOResult", { enumerable: true, get: function () { return types_2.OINOResult; } });
-Object.defineProperty(exports, "OINOHttpResult", { enumerable: true, get: function () { return types_2.OINOHttpResult; } });
-Object.defineProperty(exports, "OINOHtmlTemplate", { enumerable: true, get: function () { return types_2.OINOHtmlTemplate; } });
+exports.OINODB_EMPTY_ROWS = exports.OINODB_EMPTY_ROW = exports.OINODbParser = exports.OINODbSwagger = exports.OINODbFactory = exports.OINODbConfig = exports.OINODbSqlBooleanOperation = exports.OINODbSqlLimit = exports.OINODbSqlComparison = exports.OINODbSqlOrder = exports.OINODbSqlFilter = exports.OINODb = exports.OINODbMemoryDataSet = exports.OINODbDataSet = exports.OINODatetimeDataField = exports.OINOBlobDataField = exports.OINOStringDataField = exports.OINONumberDataField = exports.OINOBooleanDataField = exports.OINODbDataField = exports.OINODbModelSet = exports.OINODbDataModel = exports.OINODbApi = exports.OINODbHtmlTemplate = exports.OINODbApiResult = exports.OINOHtmlTemplate = exports.OINOHttpResult = exports.OINOResult = exports.OINOConsoleLog = exports.OINOLogLevel = exports.OINOLog = exports.OINOBenchmark = exports.OINOStr = exports.OINO_DEBUG_PREFIX = exports.OINO_INFO_PREFIX = exports.OINO_WARNING_PREFIX = exports.OINO_ERROR_PREFIX = exports.OINOContentType = void 0;
+const common_1 = require("@oino-ts/common");
+Object.defineProperty(exports, "OINOContentType", { enumerable: true, get: function () { return common_1.OINOContentType; } });
+var common_2 = require("@oino-ts/common");
+Object.defineProperty(exports, "OINO_ERROR_PREFIX", { enumerable: true, get: function () { return common_2.OINO_ERROR_PREFIX; } });
+Object.defineProperty(exports, "OINO_WARNING_PREFIX", { enumerable: true, get: function () { return common_2.OINO_WARNING_PREFIX; } });
+Object.defineProperty(exports, "OINO_INFO_PREFIX", { enumerable: true, get: function () { return common_2.OINO_INFO_PREFIX; } });
+Object.defineProperty(exports, "OINO_DEBUG_PREFIX", { enumerable: true, get: function () { return common_2.OINO_DEBUG_PREFIX; } });
+Object.defineProperty(exports, "OINOStr", { enumerable: true, get: function () { return common_2.OINOStr; } });
+Object.defineProperty(exports, "OINOBenchmark", { enumerable: true, get: function () { return common_2.OINOBenchmark; } });
+Object.defineProperty(exports, "OINOLog", { enumerable: true, get: function () { return common_2.OINOLog; } });
+Object.defineProperty(exports, "OINOLogLevel", { enumerable: true, get: function () { return common_2.OINOLogLevel; } });
+Object.defineProperty(exports, "OINOConsoleLog", { enumerable: true, get: function () { return common_2.OINOConsoleLog; } });
+Object.defineProperty(exports, "OINOResult", { enumerable: true, get: function () { return common_2.OINOResult; } });
+Object.defineProperty(exports, "OINOHttpResult", { enumerable: true, get: function () { return common_2.OINOHttpResult; } });
+Object.defineProperty(exports, "OINOHtmlTemplate", { enumerable: true, get: function () { return common_2.OINOHtmlTemplate; } });
 var OINODbApi_js_1 = require("./OINODbApi.js");
 Object.defineProperty(exports, "OINODbApiResult", { enumerable: true, get: function () { return OINODbApi_js_1.OINODbApiResult; } });
 Object.defineProperty(exports, "OINODbHtmlTemplate", { enumerable: true, get: function () { return OINODbApi_js_1.OINODbHtmlTemplate; } });
@@ -32,10 +32,9 @@ Object.defineProperty(exports, "OINOStringDataField", { enumerable: true, get: f
 Object.defineProperty(exports, "OINOBlobDataField", { enumerable: true, get: function () { return OINODbDataField_js_1.OINOBlobDataField; } });
 Object.defineProperty(exports, "OINODatetimeDataField", { enumerable: true, get: function () { return OINODbDataField_js_1.OINODatetimeDataField; } });
 var OINODb_js_1 = require("./OINODb.js");
+Object.defineProperty(exports, "OINODbDataSet", { enumerable: true, get: function () { return OINODb_js_1.OINODbDataSet; } });
+Object.defineProperty(exports, "OINODbMemoryDataSet", { enumerable: true, get: function () { return OINODb_js_1.OINODbMemoryDataSet; } });
 Object.defineProperty(exports, "OINODb", { enumerable: true, get: function () { return OINODb_js_1.OINODb; } });
-var OINODbDataSet_js_1 = require("./OINODbDataSet.js");
-Object.defineProperty(exports, "OINODbDataSet", { enumerable: true, get: function () { return OINODbDataSet_js_1.OINODbDataSet; } });
-Object.defineProperty(exports, "OINODbMemoryDataSet", { enumerable: true, get: function () { return OINODbDataSet_js_1.OINODbMemoryDataSet; } });
 var OINODbSqlParams_js_1 = require("./OINODbSqlParams.js");
 Object.defineProperty(exports, "OINODbSqlFilter", { enumerable: true, get: function () { return OINODbSqlParams_js_1.OINODbSqlFilter; } });
 Object.defineProperty(exports, "OINODbSqlOrder", { enumerable: true, get: function () { return OINODbSqlParams_js_1.OINODbSqlOrder; } });
@@ -48,6 +47,8 @@ var OINODbFactory_js_1 = require("./OINODbFactory.js");
 Object.defineProperty(exports, "OINODbFactory", { enumerable: true, get: function () { return OINODbFactory_js_1.OINODbFactory; } });
 var OINODbSwagger_js_1 = require("./OINODbSwagger.js");
 Object.defineProperty(exports, "OINODbSwagger", { enumerable: true, get: function () { return OINODbSwagger_js_1.OINODbSwagger; } });
+var OINODbParser_js_1 = require("./OINODbParser.js");
+Object.defineProperty(exports, "OINODbParser", { enumerable: true, get: function () { return OINODbParser_js_1.OINODbParser; } });
 /** Empty row instance */
 exports.OINODB_EMPTY_ROW = [];
 /** Empty row array instance */

package/dist/esm/OINODb.js

@@ -3,6 +3,7 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
+import { OINO_ERROR_PREFIX, OINODB_EMPTY_ROW } from "./index.js";
 /**
  * Base class for database abstraction, implementing methods for connecting, making queries and parsing/formatting data
  * between SQL and serialization formats.
@@ -47,3 +48,131 @@ export class OINODb {
         return result;
     }
 }
+/**
+ * Base class for SQL results that can be asynchronously iterated (but
+ * not necessarity rewinded). Idea is to handle database specific mechanisms
+ * for returning and formatting conventions in the database specific
+ * implementation. Data might be in memory or streamed in chunks and
+ * `OINODbDataSet` will serve it out consistently.
+ *
+ */
+export class OINODbDataSet {
+    _data;
+    /** Error messages */
+    messages;
+    /**
+     * Constructor for `OINODbDataSet`.
+     *
+     * @param data internal database specific data type (constructor will throw if invalid)
+     * @param messages error messages from SQL-query
+     *
+     */
+    constructor(data, messages = []) {
+        this._data = data;
+        this.messages = messages;
+    }
+    /**
+     * Checks if the messages contain errors.
+     *
+     */
+    hasErrors() {
+        for (let i = 0; i < this.messages.length; i++) {
+            if (this.messages[i].startsWith(OINO_ERROR_PREFIX)) {
+                return true;
+            }
+        }
+        return false;
+    }
+    /**
+     * Checks if the messages contain errors.
+     *
+     */
+    getFirstError() {
+        for (let i = 0; i < this.messages.length; i++) {
+            if (this.messages[i].startsWith(OINO_ERROR_PREFIX)) {
+                return this.messages[i];
+            }
+        }
+        return "";
+    }
+}
+/**
+ * Generic in memory implementation of a data set where data is an array of rows. Used
+ * by BunSqlite and automated testing. Can be rewinded.
+ *
+ */
+export class OINODbMemoryDataSet extends OINODbDataSet {
+    _rows;
+    _currentRow;
+    _eof;
+    /**
+     * Constructor of `OINODbMemoryDataSet`.
+     *
+     * @param data data as OINODataRow[] (constructor will throw if invalid)
+     * @param errors error messages from SQL-query
+     *
+     */
+    constructor(data, errors = []) {
+        super(data, errors);
+        if ((data == null) || !(Array.isArray(data))) {
+            throw new Error(OINO_ERROR_PREFIX + ": Data needs to be compatible with OINORow[]!"); // TODO: maybe check all rows
+        }
+        this._rows = data;
+        if (this.isEmpty()) {
+            this._currentRow = -1;
+            this._eof = true;
+        }
+        else {
+            this._currentRow = 0;
+            this._eof = false;
+        }
+    }
+    /**
+     * Is data set empty.
+     *
+     */
+    isEmpty() {
+        return (this._rows.length == 0);
+    }
+    /**
+     * Is there no more content, i.e. either dataset is empty or we have moved beyond last line
+     *
+     */
+    isEof() {
+        return (this._eof);
+    }
+    /**
+     * Attempts to moves dataset to the next row, possibly waiting for more data to become available. Returns !isEof().
+     *
+     */
+    async next() {
+        if (this._currentRow < this._rows.length - 1) {
+            this._currentRow = this._currentRow + 1;
+        }
+        else {
+            this._eof = true;
+        }
+        return Promise.resolve(!this._eof);
+    }
+    /**
+     * Gets current row of data.
+     *
+     */
+    getRow() {
+        if ((this._currentRow >= 0) && (this._currentRow < this._rows.length)) {
+            return this._rows[this._currentRow];
+        }
+        else {
+            return OINODB_EMPTY_ROW;
+        }
+    }
+    /**
+     * Rewinds data set to the first row, returns !isEof().
+     *
+     */
+    first() {
+        this._currentRow = 0;
+        this._eof = this._rows.length == 0;
+        return !this._eof;
+    }
+}

package/dist/esm/OINODbApi.js

@@ -3,10 +3,9 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
-import { OINODbDataModel, OINOStringDataField, OINO_ERROR_PREFIX, OINODbModelSet, OINOBenchmark, OINODbConfig, OINOHtmlTemplate, OINONumberDataField } from "./index.js";
-import { OINOResult } from "@oino-ts/types";
+import { OINODbDataModel, OINOStringDataField, OINO_ERROR_PREFIX, OINODbModelSet, OINOBenchmark, OINODbConfig, OINOHtmlTemplate, OINONumberDataField, OINODbParser } from "./index.js";
+import { OINOResult } from "@oino-ts/common";
 import { OINOHashid } from "@oino-ts/hashid";
-import { OINOParser } from "@oino-ts/types";
 const API_EMPTY_PARAMS = { sqlParams: {} };
 /**
  * OINO API request result object with returned data and/or http status code/message and
@@ -291,7 +290,7 @@ export class OINODbApi {
                     rows = body;
                 }
                 else {
-                    rows = OINOParser.createRows(this.datamodel, body, params);
+                    rows = OINODbParser.createRows(this.datamodel, body, params);
                 }
             }
             catch (e) {