@sqb/sqljs 4.2.1 → 4.5.1

package/README.md

@@ -0,0 +1,67 @@
+
+<p style="text-align:center">
+  <img src="https://user-images.githubusercontent.com/3836517/32965280-1a2b63ce-cbe7-11e7-8ee1-ba47313503c5.png" width="500px" alt="SQB Logo"/>
+</p>
+
+<br>
+  
+[![NPM Version][npm-image]][npm-url]
+[![NPM Downloads][downloads-image]][downloads-url]
+[![Build Status][travis-image]][travis-url]
+[![Test Coverage][coveralls-image]][coveralls-url]
+[![Dependencies][dependencies-image]][dependencies-url]
+[![DevDependencies][devdependencies-image]][devdependencies-url]
+[![Package Quality][quality-image]][quality-url]
+
+
+## About SQB
+
+SQB is an extensible, multi-dialect SQL query builder and Database connection wrapper for NodeJS.
+
+## Main goals
+
+- Single code base for any sql based database
+- Powerful and simplified query coding scheme
+- Fast applications with low memory requirements
+- Let applications work with large data tables efficiently
+- Support latest JavaScript language standards
+- Lightweight and extensible framework. 
+
+
+You can report bugs and discuss features on the [GitHub issues](https://github.com/sqbjs/sqb/issues) page
+
+Thanks to all of the great [contributions](https://github.com/sqbjs/sqb/graphs/contributors) to the project.
+
+You may want to check detailed [DOCUMENTATION](https://sqbjs.github.io/sqb/)
+
+
+## Installation
+
+```bash
+$ npm install @sqb/sqljs --save
+```
+
+## Node Compatibility
+
+  - node >= 16.x
+  
+   
+### License
+SQB is available under [MIT](LICENSE) license.
+
+[npm-image]: https://img.shields.io/npm/v/@sqb/sqljs.svg
+[npm-url]: https://npmjs.org/package/@sqb/sqljs
+[travis-image]: https://img.shields.io/travis/sqbjs/@sqb/sqljs/master.svg
+[travis-url]: https://travis-ci.org/sqbjs/@sqb/sqljs
+[coveralls-image]: https://img.shields.io/coveralls/sqbjs/@sqb/sqljs/master.svg
+[coveralls-url]: https://coveralls.io/r/sqbjs/@sqb/sqljs
+[downloads-image]: https://img.shields.io/npm/dm/@sqb/sqljs.svg
+[downloads-url]: https://npmjs.org/package/@sqb/sqljs
+[gitter-image]: https://badges.gitter.im/sqbjs/@sqb/sqljs.svg
+[gitter-url]: https://gitter.im/sqbjs/@sqb/sqljs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
+[dependencies-image]: https://david-dm.org/sqbjs/@sqb/sqljs/status.svg
+[dependencies-url]:https://david-dm.org/sqbjs/@sqb/sqljs
+[devdependencies-image]: https://david-dm.org/sqbjs/@sqb/sqljs/dev-status.svg
+[devdependencies-url]:https://david-dm.org/sqbjs/@sqb/sqljs?type=dev
+[quality-image]: http://npm.packagequality.com/shield/@sqb/sqljs.png
+[quality-url]: http://packagequality.com/#?package=@sqb/sqljs

package/cjs/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const connect_1 = require("@sqb/connect");
+const sqljs_adapter_js_1 = require("./sqljs-adapter.js");
+(0, connect_1.registerAdapter)(new sqljs_adapter_js_1.SqljsAdapter());

package/cjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/{dist/SqljsAdapter.js → cjs/sqljs-adapter.js}

@@ -7,17 +7,15 @@ const fs_1 = tslib_1.__importDefault(require("fs"));
 const path_1 = tslib_1.__importDefault(require("path"));
 const putil_promisify_1 = tslib_1.__importDefault(require("putil-promisify"));
 const sql_js_1 = tslib_1.__importDefault(require("sql.js"));
-const SqljsConnection_1 = require("./SqljsConnection");
+const sqljs_connection_js_1 = require("./sqljs-connection.js");
 const dbCache = new Map();
 class SqljsAdapter {
-    constructor() {
-        this.driver = 'sqljs';
-        this.dialect = 'sqlite';
-        this.features = {
-            cursor: true,
-            // fetchAsString: [DataType.DATE, DataType.TIMESTAMP, DataType.TIMESTAMPTZ]
-        };
-    }
+    driver = 'sqljs';
+    dialect = 'sqlite';
+    features = {
+        cursor: true,
+        // fetchAsString: [DataType.DATE, DataType.TIMESTAMP, DataType.TIMESTAMPTZ]
+    };
     async connect(config) {
         if (!config.database)
             throw new Error('You must provide sqlite database file for sql.js driver');
@@ -49,7 +47,7 @@ class SqljsAdapter {
             dbCache.set(dbName, intlDb);
         }
         const _intlDb = intlDb;
-        return new SqljsConnection_1.SqljsConnection(_intlDb, () => {
+        return new sqljs_connection_js_1.SqljsConnection(_intlDb, () => {
             if (isMemory)
                 return;
             if (--_intlDb._refCount <= 0) {

package/{dist/SqljsConnection.js → cjs/sqljs-connection.js}

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SqljsConnection = void 0;
-const SqljsCursor_1 = require("./SqljsCursor");
+const sqljs_cursor_js_1 = require("./sqljs-cursor.js");
 class SqljsConnection {
+    _onClose;
+    intlcon;
     constructor(db, _onClose) {
         this._onClose = _onClose;
         this.intlcon = db;
@@ -109,7 +111,7 @@ class SqljsConnection {
                 out.fields = this._convertFields(colNames);
                 const rowType = query.objectRows ? 'object' : 'array';
                 out.rowType = rowType;
-                const cursor = new SqljsCursor_1.SqljsCursor(stmt, { rowType });
+                const cursor = new sqljs_cursor_js_1.SqljsCursor(stmt, { rowType });
                 if (query.cursor) {
                     out.cursor = cursor;
                     stmt = undefined;

package/{dist/SqljsCursor.js → cjs/sqljs-cursor.js}

@@ -2,6 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SqljsCursor = void 0;
 class SqljsCursor {
+    _stmt;
+    _rowType;
     constructor(stmt, opts) {
         this._rowType = opts.rowType;
         this._stmt = stmt;

package/esm/index.js

@@ -0,0 +1,3 @@
+import { registerAdapter } from '@sqb/connect';
+import { SqljsAdapter } from './sqljs-adapter.js';
+registerAdapter(new SqljsAdapter());

package/esm/sqljs-adapter.js

@@ -0,0 +1,63 @@
+import '@sqb/sqlite-dialect';
+import fs from 'fs';
+import path from 'path';
+import promisify from 'putil-promisify';
+import initSqlJs from 'sql.js';
+import { SqljsConnection } from './sqljs-connection.js';
+const dbCache = new Map();
+export class SqljsAdapter {
+    driver = 'sqljs';
+    dialect = 'sqlite';
+    features = {
+        cursor: true,
+        // fetchAsString: [DataType.DATE, DataType.TIMESTAMP, DataType.TIMESTAMPTZ]
+    };
+    async connect(config) {
+        if (!config.database)
+            throw new Error('You must provide sqlite database file for sql.js driver');
+        let dbName = '';
+        let isMemory = false;
+        const m = config.database.match(/^(:memory:)(\w+)?$/);
+        if (m) {
+            isMemory = true;
+            dbName = config.database;
+        }
+        else {
+            dbName = path.resolve(config.database);
+        }
+        let intlDb = dbCache.get(dbName);
+        if (intlDb) {
+            intlDb._refCount++;
+        }
+        else {
+            const SQL = await initSqlJs();
+            if (isMemory) {
+                intlDb = new SQL.Database();
+                intlDb._refCount = 0;
+            }
+            else {
+                const buf = await promisify.fromCallback(cb => fs.readFile(dbName, cb));
+                intlDb = new SQL.Database(buf);
+                intlDb._refCount = 1;
+            }
+            dbCache.set(dbName, intlDb);
+        }
+        const _intlDb = intlDb;
+        return new SqljsConnection(_intlDb, () => {
+            if (isMemory)
+                return;
+            if (--_intlDb._refCount <= 0) {
+                _intlDb.close();
+                dbCache.delete(dbName);
+            }
+        });
+    }
+}
+export async function closeMemoryDatabase(name) {
+    const memoryDbName = name || ':memory:';
+    const memDb = dbCache.get(memoryDbName);
+    if (memDb) {
+        dbCache.delete(memoryDbName);
+        memDb.close();
+    }
+}

package/esm/sqljs-connection.js

@@ -0,0 +1,144 @@
+import { SqljsCursor } from './sqljs-cursor.js';
+export class SqljsConnection {
+    _onClose;
+    intlcon;
+    constructor(db, _onClose) {
+        this._onClose = _onClose;
+        this.intlcon = db;
+    }
+    get sessionId() {
+        return 0;
+    }
+    async close() {
+        if (this.intlcon) {
+            this.intlcon = undefined;
+            await this._onClose();
+        }
+    }
+    async reset() {
+        return this.rollback();
+    }
+    async startTransaction() {
+        assertDefined(this.intlcon);
+        try {
+            this.intlcon.exec('BEGIN TRANSACTION;');
+        }
+        catch (e) {
+            if (e instanceof Error && e.message.match(/within a transaction/))
+                return;
+            throw e;
+        }
+    }
+    async commit() {
+        assertDefined(this.intlcon);
+        try {
+            this.intlcon.exec('COMMIT;');
+        }
+        catch (e) {
+            if (e instanceof Error && e.message.match(/no transaction/))
+                return;
+            throw e;
+        }
+    }
+    async rollback() {
+        assertDefined(this.intlcon);
+        try {
+            this.intlcon.exec('ROLLBACK;');
+        }
+        catch (e) {
+            if (e instanceof Error && e.message.match(/no transaction/))
+                return;
+            throw e;
+        }
+    }
+    async test() {
+        assertDefined(this.intlcon);
+        this.intlcon.exec('select 1');
+    }
+    async execute(query) {
+        assertDefined(this.intlcon);
+        if (!query.autoCommit)
+            await this.startTransaction();
+        const out = {};
+        let params;
+        if (query.params) {
+            const prms = query.params;
+            params = Object.keys(prms).reduce((obj, k) => {
+                obj[':' + k] = prms[k];
+                return obj;
+            }, {});
+        }
+        const m = query.sql.match(/\b(insert into|update|delete from)\b ("?\w+"?)/i);
+        if (m) {
+            const stmt = this.intlcon.prepare(query.sql);
+            stmt.run(params);
+            stmt.free();
+            out.rowsAffected = this.intlcon.getRowsModified();
+            if (query.autoCommit)
+                await this.commit();
+            if (out.rowsAffected === 1 && query.returningFields) {
+                const selectFields = query.returningFields.map(x => x.field + (x.alias ? ' as ' + x.alias : ''));
+                let sql = `select ${selectFields.join(',')} from ${m[2]}\n`;
+                // Emulate insert into ... returning
+                if (m[1].toLowerCase() === 'insert into') {
+                    sql += 'where rowid=last_insert_rowid();';
+                    const r = this.intlcon.exec(sql);
+                    if (r.length) {
+                        out.fields = this._convertFields(r[0].columns);
+                        out.rows = r[0].values;
+                        out.rowType = 'array';
+                    }
+                    return out;
+                }
+                else 
+                // Emulate update ... returning
+                if (m[1].toLowerCase() === 'update') {
+                    const m2 = query.sql.match(/where (.+)/);
+                    query = { ...query };
+                    query.sql = sql + (m2 ? ' where ' + m2[1] : '');
+                }
+                else
+                    return out;
+            }
+        }
+        let stmt = this.intlcon.prepare(query.sql, query.params);
+        try {
+            const colNames = stmt.getColumnNames();
+            if (colNames && colNames.length) {
+                out.fields = this._convertFields(colNames);
+                const rowType = query.objectRows ? 'object' : 'array';
+                out.rowType = rowType;
+                const cursor = new SqljsCursor(stmt, { rowType });
+                if (query.cursor) {
+                    out.cursor = cursor;
+                    stmt = undefined;
+                }
+                else
+                    out.rows = await cursor.fetch(query.fetchRows || 100);
+            }
+            return out;
+        }
+        finally {
+            if (stmt)
+                stmt.free();
+        }
+    }
+    _convertFields(fields) {
+        const result = [];
+        for (let i = 0; i < fields.length; i++) {
+            const v = fields[i];
+            const o = {
+                fieldName: v,
+                dataType: 'any',
+                jsType: 'any',
+                _inf: { name: v }
+            };
+            result.push(o);
+        }
+        return result;
+    }
+}
+function assertDefined(d) {
+    if (d == null)
+        throw new Error("Invalid data");
+}

package/esm/sqljs-cursor.js

@@ -0,0 +1,30 @@
+export class SqljsCursor {
+    _stmt;
+    _rowType;
+    constructor(stmt, opts) {
+        this._rowType = opts.rowType;
+        this._stmt = stmt;
+    }
+    get isClosed() {
+        return !this._stmt;
+    }
+    get rowType() {
+        return this._rowType;
+    }
+    async close() {
+        if (!this._stmt)
+            return;
+        this._stmt.free();
+        this._stmt = undefined;
+    }
+    async fetch(nRows) {
+        if (!this._stmt)
+            return;
+        const stmt = this._stmt;
+        const rows = [];
+        while (nRows-- && stmt.step()) {
+            rows.push(this.rowType === 'object' ? stmt.getAsObject() : stmt.get());
+        }
+        return rows;
+    }
+}

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@sqb/sqljs",
   "description": "SQB serialization extension for sql.js driver",
-  "version": "4.2.1",
+  "version": "4.5.1",
   "author": "Panates",
   "contributors": [
-    "Eray Hanoglu <e.hanoglu@panates.com>"
+    "Eray Hanoglu <e.hanoglu@panates.com>",
+    "Ilker Gurelli <i.gurelli@panates.com>"
   ],
   "license": "Apache-2.0",
   "repository": {
@@ -12,52 +13,66 @@
     "url": "https://github.com/sqbjs/sqb.git",
     "directory": "packages/sqljs"
   },
-  "keywords": [
-    "javascript",
-    "typescript",
-    "sql",
-    "query",
-    "builder",
-    "dialect",
-    "sqlite",
-    "sql.js",
-    "database"
-  ],
+  "scripts": {
+    "compile": "tsc",
+    "prebuild": "npm run lint && npm run clean",
+    "build": "npm run build:cjs && npm run build:esm",
+    "build:cjs": "tsc -b tsconfig-build-cjs.json",
+    "build:esm": "tsc -b tsconfig-build-esm.json",
+    "postbuild": "cp README.md package.json ../../LICENSE ../../build/sqljs && cp ../../package.cjs.json ../../build/sqljs/cjs/package.json",
+    "lint": "eslint .",
+    "test": "jest",
+    "cover": "jest --collect-coverage",
+    "clean": "npm run clean:src | npm run clean:dist | npm run clean:cover",
+    "clean:src": "ts-cleanup -s src --all",
+    "clean:dist": "rimraf ../../build/sqljs",
+    "clean:cover": "rimraf ../../coverage/sqljs"
+  },
   "dependencies": {
     "putil-promisify": "^1.8.5"
   },
   "devDependencies": {
     "@types/sql.js": "^1.4.3",
-    "sql.js": "^1.7.0"
+    "sql.js": "^1.8.0"
   },
   "peerDependencies": {
-    "@sqb/builder": "^4.2.0",
-    "@sqb/connect": "^4.2.0",
-    "@sqb/sqlite-dialect": "^4.2.0",
-    "sql.js": "^1.4.0"
+    "@sqb/builder": "^4.5.0",
+    "@sqb/connect": "^4.5.0",
+    "@sqb/sqlite-dialect": "^4.5.0",
+    "sql.js": "^1.8.0"
   },
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "engines": {
-    "node": ">= 16.0"
+  "type": "module",
+  "main": "cjs/index.js",
+  "module": "esm/index.js",
+  "types": "esm/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./cjs/index.js",
+      "default": "./esm/index.js"
+    },
+    "./cjs": "./cjs/index.js",
+    "./esm": "./esm/index.js"
   },
-  "directories": {
-    "lib": "dist",
-    "test": "test"
+  "engines": {
+    "node": ">=16.0",
+    "npm": ">=7.0.0"
   },
   "files": [
+    "bin/",
+    "cjs/",
+    "esm/",
     "LICENSE",
-    "README",
-    "dist/"
+    "README.md"
   ],
-  "scripts": {
-    "build": "tsc -b tsconfig-build.json",
-    "prebuild": "npm run lint && npm run clean:dist",
-    "postbuild": "copyfiles package.json README.md LICENSE ../../build/sqljs",
-    "clean": "ts-cleanup -s src --all & ts-cleanup -s test",
-    "clean:dist": "rimraf ../../build/sqljs",
-    "compile": "tsc",
-    "lint": "eslint src/** --no-error-on-unmatched-pattern",
-    "test": "TS_NODE_PROJECT='./test/tsconfig.json' mocha -r ts-node/register -r tsconfig-paths/register --reporter spec test/**/*.spec.ts"
-  }
+  "keywords": [
+    "sqb",
+    "sqlite",
+    "sql.js",
+    "sql",
+    "query",
+    "builder",
+    "dialect",
+    "serializer",
+    "database"
+  ]
 }

package/dist/index.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const connect_1 = require("@sqb/connect");
-const SqljsAdapter_1 = require("./SqljsAdapter");
-(0, connect_1.registerAdapter)(new SqljsAdapter_1.SqljsAdapter());