sedentary-pg 0.0.53 → 0.1.0

package/README.md

@@ -1,8 +1,8 @@
 # sedentary-pg
 
 [![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]
@@ -12,20 +12,20 @@
 [![Dependents][deps-badge]][npm-url]
 [![Donate][donate-badge]][donate-url]
 
-[code-badge]: https://codeclimate.com/github/iccicci/sedentary-pg/badges/gpa.svg
-[code-url]: https://codeclimate.com/github/iccicci/sedentary-pg
-[cover-badge]: https://codeclimate.com/github/iccicci/sedentary-pg/badges/coverage.svg
-[deps-badge]: https://badgen.net/npm/dependents/sedentary-pg?icon=npm&cache=300
-[donate-badge]: https://badgen.net/badge/donate/bitcoin?icon=bitcoin&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-pg?logo=npm
+[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-pg
-[npm-downloads-badge]: https://badgen.net/npm/dw/sedentary-pg?icon=npm&cache=300
-[npm-badge]: https://badgen.net/npm/v/sedentary-pg?color=green&icon=npm&cache=300
+[npm-downloads-badge]: https://img.shields.io/npm/dw/sedentary-pg?logo=npm
+[npm-badge]: https://img.shields.io/npm/v/sedentary-pg?color=green&logo=npm
 [npm-url]: https://www.npmjs.com/package/sedentary-pg
-[stars-badge]: https://badgen.net/github/stars/iccicci/sedentary-pg?icon=github&cache=300
-[travis-badge]: https://badgen.net/travis/iccicci/sedentary-pg?icon=travis&cache=300
-[travis-url]: https://app.travis-ci.com/github/iccicci/sedentary-pg
-[types-badge]: https://badgen.net/npm/types/sedentary-pg?color=green&icon=typescript&cache=300
+[stars-badge]: https://img.shields.io/github/stars/iccicci/sedentary-pg?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://img.shields.io/static/v1?label=types&message=included&color=green&logo=typescript
 
 # under development
 
@@ -33,22 +33,24 @@
 
 The **PostgreSQL** specialized package of [Sedentary](https://www.npmjs.com/package/sedentary).
 
+Other DB engines: MySQL and SQLite are in todo but not yet planned.
+
 # Usage
 
 ```javascript
 import { SedentaryPG } from "sedentary-pg";
 
-const db = new SedentaryPG(/* PG connection */);
+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";
@@ -61,6 +63,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-pg):
@@ -77,15 +95,16 @@ 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).
+- PostgreSQL: **v15**
 
-The package is tested under [all version combinations](https://app.travis-ci.com/github/iccicci/sedentary-pg)
+The package is tested under [all version combinations](https://app.travis-ci.com/github/iccicci/sedentary)
 of **Node.js** currently supported accordingly to [Node.js Release](https://github.com/nodejs/Release#readme) and of
 **PostgreSQL** currently supported accordingly to
 [PostgreSQL Versioning](https://www.postgresql.org/support/versioning/).
 
-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
@@ -97,9 +116,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-pg/issues).
+Bugs and inconsistencies can be reported [@github](https://github.com/iccicci/sedentary-pg/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

@@ -6,46 +6,40 @@
     "yossarian <sergiybiluk@gmail.com> (https://github.com/captain-yossarian)"
   ],
   "dependencies": {
-    "@types/pg": "8.6.5",
-    "pg": "8.8.0",
-    "pg-format": "1.0.4",
-    "sedentary": "0.0.53"
+    "@types/pg": "^8.16.0",
+    "pg": "^8.18.0",
+    "pg-format": "^1.0.4",
+    "sedentary": "0.1.0"
   },
   "description": "The ORM which never needs to migrate - PostgreSQL",
   "engines": {
-    "node": ">=14.0"
+    "node": ">=20.19"
   },
   "funding": {
     "url": "https://blockchain.info/address/1Md9WFAHrXTb3yPBwQWmUfv2RmzrtbHioB"
   },
-  "homepage": "https://github.com/iccicci/sedentary/packages/sedentary-pg#readme",
+  "homepage": "https://github.com/iccicci/sedentary/tree/master/packages/sedentary-pg#readme",
   "keywords": [
     "DB",
     "ORM",
     "database",
     "migration",
-    "mysql",
-    "postgresql",
-    "sqlite"
+    "postgresql"
   ],
   "license": "MIT",
   "main": "./dist/cjs/index.js",
   "module": "./dist/es/index.js",
   "name": "sedentary-pg",
-  "optionalDependencies": {
-    "fsevents": "2.3.2"
-  },
   "readmeFilename": "README.md",
-  "repository": "https://github.com/iccicci/sedentary",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/iccicci/sedentary.git"
+  },
   "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"
   },
   "types": "./dist/types/index.d.ts",
-  "version": "0.0.53"
+  "version": "0.1.0"
 }

package/dist/cjs/adsrc.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.adsrc = void 0;
-// cspell: disable-next-line
-function adsrc(version) {
-    // cspell: disable-next-line
-    return version >= 12 ? "pg_get_expr(pg_attrdef.adbin, pg_attrdef.adrelid) AS adsrc" : "adsrc";
-}
-exports.adsrc = adsrc;

package/dist/cjs/index.js

@@ -1,31 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SedentaryPG = exports.Type = exports.EntryBase = exports.TransactionPG = void 0;
-const sedentary_1 = require("sedentary");
-const pgdb_1 = require("./pgdb");
-var pgdb_2 = require("./pgdb");
-Object.defineProperty(exports, "TransactionPG", { enumerable: true, get: function () { return pgdb_2.TransactionPG; } });
-var sedentary_2 = require("sedentary");
-Object.defineProperty(exports, "EntryBase", { enumerable: true, get: function () { return sedentary_2.EntryBase; } });
-Object.defineProperty(exports, "Type", { enumerable: true, get: function () { return sedentary_2.Type; } });
-class SedentaryPG extends sedentary_1.Sedentary {
-    constructor(connection, options) {
-        super(options);
-        if (!(connection instanceof Object))
-            throw new Error("SedentaryPG.constructor: 'connection' argument: Wrong type, expected 'Object'");
-        this.db = new pgdb_1.PGDB(connection, this.log);
-    }
-    FKey(attribute, options) {
-        const { attributeName, modelName, unique } = attribute;
-        if (!unique)
-            throw new Error(`SedentaryPG.FKey: '${modelName}' model: '${attributeName}' attribute: is not unique: can't be used as FKey target`);
-        return super.FKey(attribute, options);
-    }
-    begin() {
-        return this.db.begin();
-    }
-    client() {
-        return this.db.client();
-    }
-}
-exports.SedentaryPG = SedentaryPG;