sedentary 0.0.54 → 0.1.0

package/README.md

@@ -1,8 +1,8 @@
 # sedentary
 
 [![Build Status][travis-badge]][travis-url]
-[![Code Climate][code-badge]][code-url]
-[![Test Coverage][cover-badge]][code-url]
+[![Code Quality][qlty-badge]][qlty-url]
+[![Test Coverage][cover-badge]][qlty-url]
 
 [![NPM version][npm-badge]][npm-url]
 [![NPM downloads][npm-downloads-badge]][npm-url]
@@ -13,27 +13,27 @@
 [![Dependents][deps-badge]][npm-url]
 [![Donate][donate-badge]][donate-url]
 
-[code-badge]: https://codeclimate.com/github/iccicci/sedentary/badges/gpa.svg
-[code-url]: https://codeclimate.com/github/iccicci/sedentary
-[cover-badge]: https://codeclimate.com/github/iccicci/sedentary/badges/coverage.svg
-[deps-badge]: https://badgen.net/npm/dependents/sedentary?icon=npm&cache=300
+[cover-badge]: https://qlty.sh/gh/iccicci/projects/sedentary/coverage.svg
+[qlty-badge]: https://qlty.sh/gh/iccicci/projects/sedentary/maintainability.svg
+[qlty-url]: https://qlty.sh/gh/iccicci/projects/sedentary
+[deps-badge]: https://img.shields.io/librariesio/dependents/npm/sedentary?logo=npm
 [doc-badge]: https://readthedocs.org/projects/sedentary/badge/?version=latest
 [doc-url]: https://sedentary.readthedocs.io/
-[donate-badge]: https://badgen.net/badge/donate/bitcoin?icon=bitcoin&cache=300
+[donate-badge]: https://img.shields.io/static/v1?label=donate&message=bitcoin&color=blue&logo=bitcoin
 [donate-url]: https://blockchain.info/address/1Md9WFAHrXTb3yPBwQWmUfv2RmzrtbHioB
 [github-url]: https://github.com/iccicci/sedentary
-[npm-downloads-badge]: https://badgen.net/npm/dw/sedentary?icon=npm&cache=300
-[npm-badge]: https://badgen.net/npm/v/sedentary?color=green&icon=npm&cache=300
+[npm-downloads-badge]: https://img.shields.io/npm/dw/sedentary?logo=npm
+[npm-badge]: https://img.shields.io/npm/v/sedentary?color=green&logo=npm
 [npm-url]: https://www.npmjs.com/package/sedentary
-[stars-badge]: https://badgen.net/github/stars/iccicci/sedentary?icon=github&cache=300
-[travis-badge]: https://badgen.net/travis/iccicci/sedentary?icon=travis&cache=300
+[stars-badge]: https://img.shields.io/github/stars/iccicci/sedentary?logo=github&style=flat&color=green
+[travis-badge]: https://img.shields.io/travis/com/iccicci/sedentary?logo=travis
 [travis-url]: https://app.travis-ci.com/github/iccicci/sedentary
-[types-badge]: https://badgen.net/npm/types/sedentary?color=green&icon=typescript&cache=300
-
-# under development
+[types-badge]: https://img.shields.io/static/v1?label=types&message=included&color=green&logo=typescript
 
 # Description
 
+This package contains the base logic and types for the Sedentary ORM. **It must not be used directly** because it does not implement any DB engine; use a dedicated extension such as [sedentary-pg](https://www.npmjs.com/package/sedentary-pg) instead.
+
 An ORM which automatically syncs the DB schema on models change, no migrations between versions are required.
 
 This package is designed **to make easy the process of applying changes to the database after model definition
@@ -46,19 +46,19 @@ changes to the models (or the database schema). This package tries to solve thes
 # Usage
 
 ```javascript
-import { Sedentary } from "sedentary";
+import { SedentaryPG } from "sedentary-pg";
 
-const db = new Sedentary("file.db");
+const db = new SedentaryPG({ database: "db", user: "user", password: "pass" });
 
-class Items extends db.model("Item", {
-  num: db.INT,
-  str: db.VarChar(30)
+const Items = db.model("Item", {
+  num: db.Int(),
+  str: db.VarChar({ size: 30 })
 });
 
 (async function () {
   await db.connect();
 
-  const item = Items.create();
+  const item = new Items();
 
   item.num = 0;
   item.str = "0";
@@ -71,6 +71,22 @@ class Items extends db.model("Item", {
 })();
 ```
 
+With TypeScript the instance can be typed using `Entry<typeof Model>`:
+
+```typescript
+import { Entry, SedentaryPG } from "sedentary-pg";
+
+const db = new SedentaryPG({ database: "db", user: "user", password: "pass" });
+
+const Items = db.model("Item", { num: db.Int(), str: db.VarChar({ size: 30 }) });
+type Item = Entry<typeof Items>;
+
+const item: Item = new Items();
+
+item.num = 0;
+item.str = "0";
+```
+
 # Installation
 
 With [npm](https://www.npmjs.com/package/sedentary):
@@ -85,9 +101,9 @@ $ npm install --save sedentary
 
 A _DB engine dedicated extension_ must be used:
 
-- MySQL: planned
-- PostgreSQL: [sedentary-pg](https://github.com/iccicci/sedentary-pg#readme)
-- SQLite: planned
+- MySQL: in todo, not yet planned
+- PostgreSQL: [sedentary-pg](https://www.npmjs.com/package/sedentary-pg)
+- SQLite: in todo, not yet planned
 
 # Documentation
 
@@ -97,13 +113,13 @@ The full documentation is on [sedentary.readthedocs.io](https://sedentary.readth
 
 Requires:
 
-- Node.js: **v14**
-- TypeScript: **v4.6** (or none if used in a JavaScript project).
+- Node.js: **v20**
+- TypeScript: **v5.7** (or none if used in a JavaScript project).
 
 The package is tested under [all Node.js versions](https://app.travis-ci.com/github/iccicci/sedentary)
 currently supported accordingly to [Node.js Release](https://github.com/nodejs/Release#readme).
 
-To work with the package under Windows, be sure to configure `bash.exe` as your _script-shell_.
+To work with the package under Windows, `bash.exe` can be configured as the _script-shell_.
 
 ```
 > npm config set script-shell bash.exe
@@ -115,9 +131,12 @@ To work with the package under Windows, be sure to configure `bash.exe` as your
 
 # Bugs
 
-Do not hesitate to report any bug or inconsistency [@github](https://github.com/iccicci/sedentary/issues).
+Bugs and inconsistencies can be reported [@github](https://github.com/iccicci/sedentary/issues).
 
 # Donating
 
-If you find useful this package, please consider the opportunity to donate some satoshis to this bitcoin address:
+Satoshis can be donated to this bitcoin address if the package is found useful:
+
+<!-- cSpell: disable -->
+
 **1Md9WFAHrXTb3yPBwQWmUfv2RmzrtbHioB**

package/package.json

@@ -7,28 +7,23 @@
   ],
   "description": "The ORM which never needs to migrate",
   "engines": {
-    "node": ">=18.0"
+    "node": ">=20.19"
   },
   "funding": {
     "url": "https://blockchain.info/address/1Md9WFAHrXTb3yPBwQWmUfv2RmzrtbHioB"
   },
-  "homepage": "https://github.com/iccicci/sedentary/packages/sedentary#readme",
+  "homepage": "https://github.com/iccicci/sedentary/tree/master/packages/sedentary#readme",
   "keywords": [
     "DB",
     "ORM",
     "database",
     "migration",
-    "mysql",
-    "postgresql",
-    "sqlite"
+    "postgresql"
   ],
   "license": "MIT",
   "main": "./dist/cjs/index.js",
   "module": "./dist/es/index.js",
   "name": "sedentary",
-  "optionalDependencies": {
-    "fsevents": "^2.3.3"
-  },
   "readmeFilename": "README.md",
   "repository": {
     "type": "git",
@@ -36,12 +31,8 @@
   },
   "scripts": {
     "build": "make build",
-    "coverage": "jest --coverage --no-cache --runInBand",
     "deploy": "make deploy",
-    "precoverage": "make pretest",
-    "preinstall": "if [ -f Makefile ] ; then make ; fi",
-    "pretest": "make pretest",
-    "test": "jest --no-cache --runInBand"
+    "preinstall": "if [ -f Makefile ] ; then make ; fi"
   },
   "tsd": {
     "compilerOptions": {
@@ -61,5 +52,5 @@
     }
   },
   "types": "./dist/types/index.d.ts",
-  "version": "0.0.54"
+  "version": "0.1.0"
 }

package/dist/cjs/db.js

@@ -1,179 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.deepDiff = exports.deepCopy = exports.Transaction = exports.DB = exports.Table = exports.Attribute = exports.Type = exports.EntryBase = exports.transaction = exports.size = exports.loaded = exports.base = exports.actions = void 0;
-exports.actions = Symbol("actions");
-exports.base = Symbol("base");
-exports.loaded = Symbol("loaded");
-exports.size = Symbol("size");
-exports.transaction = Symbol("transaction");
-class EntryBase {
-    constructor(from) {
-        if (from === "load")
-            this.preLoad();
-        else {
-            if (from)
-                Object.assign(this, from);
-            this.construct();
-        }
-    }
-    construct() { }
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    postCommit(actions) { }
-    postLoad() { }
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    postRemove(deletedRecords) { }
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    postSave(savedRecords) { }
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    preCommit(actions) { }
-    preLoad() { }
-    preRemove() { }
-    preSave() { }
-    async remove() {
-        return false;
-    }
-    async save() {
-        return false;
-    }
-}
-exports.EntryBase = EntryBase;
-class Type {
-    constructor(from) {
-        Object.assign(this, from);
-    }
-}
-exports.Type = Type;
-class Attribute extends Type {
-    constructor(from) {
-        super(from);
-    }
-}
-exports.Attribute = Attribute;
-function autoImplement() {
-    return class {
-        constructor(defaults) {
-            Object.assign(this, defaults);
-        }
-    };
-}
-class Table extends autoImplement() {
-    findAttribute(name) {
-        return this.attributes.filter(_ => _.attributeName === name)[0];
-    }
-    findField(name) {
-        return this.attributes.filter(_ => _.fieldName === name)[0];
-    }
-}
-exports.Table = Table;
-class DB {
-    constructor(log) {
-        this.tables = [];
-        this.sync = true;
-        this.log = log;
-    }
-    findTable(name) {
-        return this.tables.filter(_ => _.tableName === name)[0];
-    }
-    indexesEq(a, b) {
-        if (a.fields.length !== b.fields.length)
-            return false;
-        for (const i in a.fields)
-            if (a.fields[i] !== b.fields[i])
-                return false;
-        if (a.type !== b.type)
-            return false;
-        if (a.unique !== b.unique)
-            return false;
-        return true;
-    }
-    async syncDataBase() {
-        for (const table of this.tables) {
-            this.sync = table.sync;
-            await this.syncTable(table);
-            const indexes = await this.dropConstraints(table);
-            await this.dropIndexes(table, indexes);
-            await this.dropFields(table);
-            await this.syncFields(table);
-            await this.syncSequence(table);
-            await this.syncConstraints(table);
-            await this.syncIndexes(table);
-        }
-    }
-    syncLog(message) {
-        this.log(this.sync ? message : "NOT SYNCING: " + message);
-    }
-}
-exports.DB = DB;
-class Transaction {
-    constructor(log) {
-        this.entries = [];
-        this.log = log;
-    }
-    addEntry(entry) {
-        Object.defineProperty(entry, exports.transaction, { configurable: true, value: this });
-        this.entries.push(entry);
-    }
-    clean() {
-        const { entries } = this;
-        for (const entry of entries) {
-            Object.defineProperty(entry, exports.actions, { configurable: true, value: undefined });
-            Object.defineProperty(entry, exports.transaction, { configurable: true, value: undefined });
-        }
-        this.entries = [];
-    }
-    async commit() {
-        const { entries } = this;
-        for (const entry of entries)
-            if (entry[exports.actions])
-                entry.postCommit(entry[exports.actions]);
-        this.clean();
-    }
-    preCommit() {
-        const { entries } = this;
-        for (const entry of entries)
-            if (entry[exports.actions])
-                entry.preCommit(entry[exports.actions]);
-    }
-    async rollback() {
-        this.clean();
-    }
-}
-exports.Transaction = Transaction;
-const sortedEntries = (obj) => Object.entries(obj).sort((entryA, entryB) => (entryA[0] > entryB[0] ? -1 : 1));
-function deepCopy(o) {
-    if (!o || typeof o !== "object")
-        return o;
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    const [ret, entries] = o instanceof Array ? [new Array(o.length), o.entries()] : [{}, Object.entries(o)];
-    for (const [k, v] of entries)
-        ret[k] = deepCopy(v);
-    return ret;
-}
-exports.deepCopy = deepCopy;
-function deepDiff(a, b) {
-    if (typeof a !== "object")
-        return a !== b;
-    if (typeof b !== "object")
-        return true;
-    if (a === null)
-        return b !== null;
-    if (b === null)
-        return true;
-    if (a instanceof Array) {
-        if (!(b instanceof Array))
-            return true;
-        for (const [i, value] of a.entries())
-            if (deepDiff(value, b[i]))
-                return true;
-        return false;
-    }
-    const entriesA = sortedEntries(a);
-    const entriesB = sortedEntries(b);
-    if (entriesA.length !== entriesB.length)
-        return true;
-    for (const [i, [key, value]] of entriesA.entries())
-        if (key !== entriesB[i][0] || deepDiff(value, entriesB[i][1]))
-            return true;
-    return false;
-}
-exports.deepDiff = deepDiff;