sedentary-pg 0.0.42 → 0.0.45

package/README.md

@@ -42,7 +42,7 @@ const db = new SedentaryPG(/* PG connection */);
 
 class Items extends db.model("Item", {
   num: db.INT,
-  str: db.VARCHAR(30)
+  str: db.VarChar(30)
 });
 
 (async function () {
@@ -91,9 +91,9 @@ To work with the package under Windows, be sure to configure `bash.exe` as your
 > npm config set script-shell bash.exe
 ```
 
-# Licence
+# License
 
-[MIT Licence](https://github.com/iccicci/sedentary-pg/blob/master/LICENSE)
+[MIT License](https://github.com/iccicci/sedentary-pg/blob/master/LICENSE)
 
 # Bugs
 

package/dist/cjs/index.js

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

package/dist/cjs/pgdb.js

@@ -12,17 +12,27 @@ const needDrop = [
     ["DATETIME", "int2"],
     ["DATETIME", "int4"],
     ["DATETIME", "int8"],
+    ["DATETIME", "numeric"],
+    ["INT", "json"],
     ["INT", "timestamptz"],
-    ["INT8", "timestamptz"]
+    ["INT8", "json"],
+    ["INT8", "timestamptz"],
+    ["JSON", "int2"],
+    ["JSON", "int4"],
+    ["JSON", "int8"],
+    ["JSON", "numeric"],
+    ["NUMBER", "json"],
+    ["NUMBER", "timestamptz"]
 ];
 const needUsing = [
     ["BOOLEAN", "varchar"],
     ["DATETIME", "varchar"],
     ["INT", "varchar"],
     ["INT8", "varchar"],
+    ["JSON", "varchar"],
     ["NUMBER", "varchar"]
 ];
-const types = { bool: "BOOL", int2: "SMALLINT", int4: "INTEGER", int8: "BIGINT", numeric: "NUMERIC", timestamptz: "DATETIME", varchar: "VARCHAR" };
+const types = { bool: "BOOL", int2: "SMALLINT", int4: "INTEGER", int8: "BIGINT", json: "JSON", numeric: "NUMERIC", timestamptz: "DATETIME", varchar: "VARCHAR" };
 const actions = { cascade: "c", "no action": "a", restrict: "r", "set default": "d", "set null": "n" };
 function parseInt8(value) {
     return BigInt(value);
@@ -63,16 +73,31 @@ class PGDB extends sedentary_1.DB {
         await ret._client.query("BEGIN");
         return ret;
     }
+    cancel(tableName) {
+        return async (where, tx) => {
+            const client = tx ? tx._client : await this.pool.connect();
+            let rowCount = 0;
+            try {
+                const query = `DELETE FROM ${tableName}${where ? ` WHERE ${where}` : ""}`;
+                this.log(query);
+                ({ rowCount } = await client.query(query));
+            }
+            finally {
+                if (!tx)
+                    client.release();
+            }
+            return rowCount;
+        };
+    }
     async client() {
         return await this.pool.connect();
     }
     escape(value) {
         if (value === null || value === undefined)
             throw new Error("SedentaryPG: Can't escape null nor undefined values; use the 'IS NULL' operator instead");
-        const type = typeof value;
-        if (type === "number" || type === "boolean")
+        if (typeof value === "boolean" || typeof value === "number")
             return value.toString();
-        if (type === "string")
+        if (typeof value === "string")
             return (0, pg_format_1.default)("%L", value);
         //if(value instanceof Date)
         return (0, pg_format_1.default)("%L", value).replace(/\.\d\d\d\+/, "+");
@@ -132,13 +157,13 @@ class PGDB extends sedentary_1.DB {
     remove(tableName, pk) {
         // eslint-disable-next-line @typescript-eslint/no-this-alias
         const self = this;
-        const pkAttrnName = pk.attributeName;
+        const pkAttrName = pk.attributeName;
         const pkFldName = pk.fieldName;
         return async function () {
             const client = this.tx ? this.tx._client : await self.pool.connect();
             let removed = false;
             try {
-                const query = `DELETE FROM ${tableName} WHERE ${pkFldName} = ${self.escape(this[pkAttrnName])}`;
+                const query = `DELETE FROM ${tableName} WHERE ${pkFldName} = ${self.escape(this[pkAttrName])}`;
                 self.log(query);
                 removed = (await client.query(query)).rowCount === 1;
             }
@@ -152,7 +177,7 @@ class PGDB extends sedentary_1.DB {
     save(tableName, attributes, pk) {
         // eslint-disable-next-line @typescript-eslint/no-this-alias
         const self = this;
-        const pkAttrnName = pk.attributeName;
+        const pkAttrName = pk.attributeName;
         const pkFldName = pk.fieldName;
         return async function () {
             const client = this.tx ? this.tx._client : await self.pool.connect();
@@ -167,7 +192,7 @@ class PGDB extends sedentary_1.DB {
                             actions.push(`${attributes[attribute]} = ${self.escape(value)}`);
                     }
                     if (actions.length) {
-                        const query = `UPDATE ${tableName} SET ${actions.join(", ")} WHERE ${pkFldName} = ${self.escape(this[pkAttrnName])}`;
+                        const query = `UPDATE ${tableName} SET ${actions.join(", ")} WHERE ${pkFldName} = ${self.escape(this[pkAttrName])}`;
                         self.log(query);
                         self.fill(attributes, (await client.query(query + " RETURNING *")).rows[0], this);
                         changed = true;
@@ -234,26 +259,26 @@ class PGDB extends sedentary_1.DB {
     }
     async dropIndexes(table, constraintIndexes) {
         const { indexes, oid } = table;
-        const iobject = {};
+        const iObject = {};
         const res = await this._client.query("SELECT amname, attname, indexrelid, indisunique, relname FROM pg_class, pg_index, pg_attribute, pg_am WHERE indrelid = $1 AND indexrelid = pg_class.oid AND attrelid = pg_class.oid AND relam = pg_am.oid ORDER BY attnum", [oid]);
         for (const row of res.rows) {
             const { amname, attname, indexrelid, indisunique, relname } = row;
             if (!constraintIndexes.includes(indexrelid)) {
-                if (iobject[relname])
-                    iobject[relname].fields.push(attname);
+                if (iObject[relname])
+                    iObject[relname].fields.push(attname);
                 else
-                    iobject[relname] = { fields: [attname], indexName: relname, type: amname, unique: indisunique };
+                    iObject[relname] = { fields: [attname], indexName: relname, type: amname, unique: indisunique };
             }
         }
         this.indexes = [];
         for (const index of indexes) {
             const { indexName } = index;
-            if (iobject[indexName] && this.indexesEq(index, iobject[indexName])) {
+            if (iObject[indexName] && this.indexesEq(index, iObject[indexName])) {
                 this.indexes.push(indexName);
-                delete iobject[indexName];
+                delete iObject[indexName];
             }
         }
-        for (const index of Object.keys(iobject).sort()) {
+        for (const index of Object.keys(iObject).sort()) {
             const statement = `DROP INDEX ${index}`;
             this.syncLog(statement);
             if (this.sync)
@@ -306,13 +331,15 @@ class PGDB extends sedentary_1.DB {
                 return ["BOOL", "BOOL"];
             case "DATETIME":
                 return ["DATETIME", "TIMESTAMP (3) WITH TIME ZONE"];
-            case "NUMBER":
-                return ["NUMERIC", "NUMERIC"];
             case "INT":
                 ret = size === 2 ? "SMALLINT" : "INTEGER";
                 return [ret, ret];
             case "INT8":
                 return ["BIGINT", "BIGINT"];
+            case "JSON":
+                return ["JSON", "JSON"];
+            case "NUMBER":
+                return ["NUMERIC", "NUMERIC"];
             case "VARCHAR":
                 return ["VARCHAR", "VARCHAR" + (size ? `(${size})` : "")];
         }
@@ -368,7 +395,7 @@ class PGDB extends sedentary_1.DB {
             else {
                 const { adsrc, attnotnull, atttypmod, typname } = res.rows[0];
                 if (types[typname] !== base || (base === "VARCHAR" && (size ? size + 4 !== atttypmod : atttypmod !== -1))) {
-                    if (needDrop.filter(([type, name]) => attribute.type === type && typname === name).length) {
+                    if (needDrop.some(([type, name]) => attribute.type === type && typname === name)) {
                         await this.dropField(tableName, fieldName);
                         await addField();
                         await setDefault(false);
@@ -376,7 +403,7 @@ class PGDB extends sedentary_1.DB {
                     else {
                         if (adsrc)
                             dropDefault();
-                        const using = needUsing.filter(([type, name]) => attribute.type === type && typname === name).length ? " USING " + fieldName + "::" + type : "";
+                        const using = needUsing.some(([type, name]) => attribute.type === type && typname === name) ? " USING " + fieldName + "::" + type : "";
                         const statement = `ALTER TABLE ${tableName} ALTER COLUMN ${fieldName} TYPE ${type}${using}`;
                         this.syncLog(statement);
                         if (this.sync)

package/dist/es/index.js

@@ -9,17 +9,16 @@ export class SedentaryPG extends Sedentary {
             throw new Error("SedentaryPG.constructor: 'connection' argument: Wrong type, expected 'Object'");
         this.db = new PGDB(connection, this.log);
     }
-    FKEY(attribute, options) {
+    FKey(attribute, options) {
         const { attributeName, modelName, unique } = attribute;
         if (!unique)
-            throw new Error(`Sedentary.FKEY: '${modelName}' model: '${attributeName}' attribute: is not unique: can't be used as FKEY target`);
-        return super.FKEY(attribute, options);
+            throw new Error(`SedentaryPG.FKey: '${modelName}' model: '${attributeName}' attribute: is not unique: can't be used as FKey target`);
+        return super.FKey(attribute, options);
     }
-    async begin() {
+    begin() {
         return this.db.begin();
     }
-    async client() {
+    client() {
         return this.db.client();
     }
 }
-export const Package = SedentaryPG;

package/dist/es/pgdb.js

@@ -6,17 +6,27 @@ const needDrop = [
     ["DATETIME", "int2"],
     ["DATETIME", "int4"],
     ["DATETIME", "int8"],
+    ["DATETIME", "numeric"],
+    ["INT", "json"],
     ["INT", "timestamptz"],
-    ["INT8", "timestamptz"]
+    ["INT8", "json"],
+    ["INT8", "timestamptz"],
+    ["JSON", "int2"],
+    ["JSON", "int4"],
+    ["JSON", "int8"],
+    ["JSON", "numeric"],
+    ["NUMBER", "json"],
+    ["NUMBER", "timestamptz"]
 ];
 const needUsing = [
     ["BOOLEAN", "varchar"],
     ["DATETIME", "varchar"],
     ["INT", "varchar"],
     ["INT8", "varchar"],
+    ["JSON", "varchar"],
     ["NUMBER", "varchar"]
 ];
-const types = { bool: "BOOL", int2: "SMALLINT", int4: "INTEGER", int8: "BIGINT", numeric: "NUMERIC", timestamptz: "DATETIME", varchar: "VARCHAR" };
+const types = { bool: "BOOL", int2: "SMALLINT", int4: "INTEGER", int8: "BIGINT", json: "JSON", numeric: "NUMERIC", timestamptz: "DATETIME", varchar: "VARCHAR" };
 const actions = { cascade: "c", "no action": "a", restrict: "r", "set default": "d", "set null": "n" };
 function parseInt8(value) {
     return BigInt(value);
@@ -58,16 +68,31 @@ export class PGDB extends DB {
         await ret._client.query("BEGIN");
         return ret;
     }
+    cancel(tableName) {
+        return async (where, tx) => {
+            const client = tx ? tx._client : await this.pool.connect();
+            let rowCount = 0;
+            try {
+                const query = `DELETE FROM ${tableName}${where ? ` WHERE ${where}` : ""}`;
+                this.log(query);
+                ({ rowCount } = await client.query(query));
+            }
+            finally {
+                if (!tx)
+                    client.release();
+            }
+            return rowCount;
+        };
+    }
     async client() {
         return await this.pool.connect();
     }
     escape(value) {
         if (value === null || value === undefined)
             throw new Error("SedentaryPG: Can't escape null nor undefined values; use the 'IS NULL' operator instead");
-        const type = typeof value;
-        if (type === "number" || type === "boolean")
+        if (typeof value === "boolean" || typeof value === "number")
             return value.toString();
-        if (type === "string")
+        if (typeof value === "string")
             return format("%L", value);
         //if(value instanceof Date)
         return format("%L", value).replace(/\.\d\d\d\+/, "+");
@@ -127,13 +152,13 @@ export class PGDB extends DB {
     remove(tableName, pk) {
         // eslint-disable-next-line @typescript-eslint/no-this-alias
         const self = this;
-        const pkAttrnName = pk.attributeName;
+        const pkAttrName = pk.attributeName;
         const pkFldName = pk.fieldName;
         return async function () {
             const client = this.tx ? this.tx._client : await self.pool.connect();
             let removed = false;
             try {
-                const query = `DELETE FROM ${tableName} WHERE ${pkFldName} = ${self.escape(this[pkAttrnName])}`;
+                const query = `DELETE FROM ${tableName} WHERE ${pkFldName} = ${self.escape(this[pkAttrName])}`;
                 self.log(query);
                 removed = (await client.query(query)).rowCount === 1;
             }
@@ -147,7 +172,7 @@ export class PGDB extends DB {
     save(tableName, attributes, pk) {
         // eslint-disable-next-line @typescript-eslint/no-this-alias
         const self = this;
-        const pkAttrnName = pk.attributeName;
+        const pkAttrName = pk.attributeName;
         const pkFldName = pk.fieldName;
         return async function () {
             const client = this.tx ? this.tx._client : await self.pool.connect();
@@ -162,7 +187,7 @@ export class PGDB extends DB {
                             actions.push(`${attributes[attribute]} = ${self.escape(value)}`);
                     }
                     if (actions.length) {
-                        const query = `UPDATE ${tableName} SET ${actions.join(", ")} WHERE ${pkFldName} = ${self.escape(this[pkAttrnName])}`;
+                        const query = `UPDATE ${tableName} SET ${actions.join(", ")} WHERE ${pkFldName} = ${self.escape(this[pkAttrName])}`;
                         self.log(query);
                         self.fill(attributes, (await client.query(query + " RETURNING *")).rows[0], this);
                         changed = true;
@@ -229,26 +254,26 @@ export class PGDB extends DB {
     }
     async dropIndexes(table, constraintIndexes) {
         const { indexes, oid } = table;
-        const iobject = {};
+        const iObject = {};
         const res = await this._client.query("SELECT amname, attname, indexrelid, indisunique, relname FROM pg_class, pg_index, pg_attribute, pg_am WHERE indrelid = $1 AND indexrelid = pg_class.oid AND attrelid = pg_class.oid AND relam = pg_am.oid ORDER BY attnum", [oid]);
         for (const row of res.rows) {
             const { amname, attname, indexrelid, indisunique, relname } = row;
             if (!constraintIndexes.includes(indexrelid)) {
-                if (iobject[relname])
-                    iobject[relname].fields.push(attname);
+                if (iObject[relname])
+                    iObject[relname].fields.push(attname);
                 else
-                    iobject[relname] = { fields: [attname], indexName: relname, type: amname, unique: indisunique };
+                    iObject[relname] = { fields: [attname], indexName: relname, type: amname, unique: indisunique };
             }
         }
         this.indexes = [];
         for (const index of indexes) {
             const { indexName } = index;
-            if (iobject[indexName] && this.indexesEq(index, iobject[indexName])) {
+            if (iObject[indexName] && this.indexesEq(index, iObject[indexName])) {
                 this.indexes.push(indexName);
-                delete iobject[indexName];
+                delete iObject[indexName];
             }
         }
-        for (const index of Object.keys(iobject).sort()) {
+        for (const index of Object.keys(iObject).sort()) {
             const statement = `DROP INDEX ${index}`;
             this.syncLog(statement);
             if (this.sync)
@@ -301,13 +326,15 @@ export class PGDB extends DB {
                 return ["BOOL", "BOOL"];
             case "DATETIME":
                 return ["DATETIME", "TIMESTAMP (3) WITH TIME ZONE"];
-            case "NUMBER":
-                return ["NUMERIC", "NUMERIC"];
             case "INT":
                 ret = size === 2 ? "SMALLINT" : "INTEGER";
                 return [ret, ret];
             case "INT8":
                 return ["BIGINT", "BIGINT"];
+            case "JSON":
+                return ["JSON", "JSON"];
+            case "NUMBER":
+                return ["NUMERIC", "NUMERIC"];
             case "VARCHAR":
                 return ["VARCHAR", "VARCHAR" + (size ? `(${size})` : "")];
         }
@@ -363,7 +390,7 @@ export class PGDB extends DB {
             else {
                 const { adsrc, attnotnull, atttypmod, typname } = res.rows[0];
                 if (types[typname] !== base || (base === "VARCHAR" && (size ? size + 4 !== atttypmod : atttypmod !== -1))) {
-                    if (needDrop.filter(([type, name]) => attribute.type === type && typname === name).length) {
+                    if (needDrop.some(([type, name]) => attribute.type === type && typname === name)) {
                         await this.dropField(tableName, fieldName);
                         await addField();
                         await setDefault(false);
@@ -371,7 +398,7 @@ export class PGDB extends DB {
                     else {
                         if (adsrc)
                             dropDefault();
-                        const using = needUsing.filter(([type, name]) => attribute.type === type && typname === name).length ? " USING " + fieldName + "::" + type : "";
+                        const using = needUsing.some(([type, name]) => attribute.type === type && typname === name) ? " USING " + fieldName + "::" + type : "";
                         const statement = `ALTER TABLE ${tableName} ALTER COLUMN ${fieldName} TYPE ${type}${using}`;
                         this.syncLog(statement);
                         if (this.sync)

package/dist/types/index.d.ts

@@ -1,12 +1,11 @@
-import { Attribute, EntryBase, ForeignKeyOptions, Natural, Sedentary, SedentaryOptions, Type } from "sedentary";
+import { Attribute, EntryBase, ForeignKeyOptions, Sedentary, SedentaryOptions, Type } from "sedentary";
 import { PoolConfig } from "pg";
 import { PGDB, TransactionPG } from "./pgdb";
 export { Entry, EntryBase, SedentaryOptions, Type } from "sedentary";
 export { TransactionPG } from "./pgdb";
 export declare class SedentaryPG extends Sedentary<PGDB, TransactionPG> {
     constructor(connection: PoolConfig, options?: SedentaryOptions);
-    FKEY<N extends Natural, E extends EntryBase>(attribute: Attribute<N, E>, options?: ForeignKeyOptions): Type<N, E>;
+    FKey<T, E extends EntryBase>(attribute: Attribute<T, E>, options?: ForeignKeyOptions): Type<T, E>;
     begin(): Promise<TransactionPG>;
     client(): Promise<import("pg").PoolClient>;
 }
-export declare const Package: typeof SedentaryPG;

package/dist/types/pgdb.d.ts

@@ -1,5 +1,5 @@
 import { PoolClient, PoolConfig } from "pg";
-import { Attribute, DB, EntryBase, Natural, Table, Transaction } from "sedentary";
+import { Attribute, DB, EntryBase, Table, Transaction } from "sedentary";
 export declare class PGDB extends DB<TransactionPG> {
     private _client;
     private indexes;
@@ -10,16 +10,17 @@ export declare class PGDB extends DB<TransactionPG> {
     constructor(connection: PoolConfig, log: (message: string) => void);
     connect(): Promise<void>;
     end(): Promise<void>;
-    defaultNeq(src: string, value: Natural): boolean;
+    defaultNeq(src: string, value: unknown): boolean;
     begin(): Promise<TransactionPG>;
+    cancel(tableName: string): (where: string, tx?: Transaction) => Promise<number>;
     client(): Promise<PoolClient>;
-    escape(value: Natural): string;
-    fill(attributes: Record<string, string>, row: Record<string, Natural>, entry: Record<string, Natural>): void;
-    load(tableName: string, attributes: Record<string, string>, pk: Attribute<Natural, unknown>, model: new (from: "load") => EntryBase, table: Table): (where: string, order?: string | string[], limit?: number, tx?: Transaction) => Promise<EntryBase[]>;
-    remove(tableName: string, pk: Attribute<Natural, unknown>): (this: Record<string, Natural> & {
+    escape(value: unknown): string;
+    fill(attributes: Record<string, string>, row: Record<string, unknown>, entry: Record<string, unknown>): void;
+    load(tableName: string, attributes: Record<string, string>, pk: Attribute<unknown, unknown>, model: new (from: "load") => EntryBase, table: Table): (where: string, order?: string | string[], limit?: number, tx?: Transaction) => Promise<EntryBase[]>;
+    remove(tableName: string, pk: Attribute<unknown, unknown>): (this: Record<string, unknown> & {
         tx?: TransactionPG;
     }) => Promise<boolean>;
-    save(tableName: string, attributes: Record<string, string>, pk: Attribute<Natural, unknown>): (this: Record<string, Natural> & {
+    save(tableName: string, attributes: Record<string, string>, pk: Attribute<unknown, unknown>): (this: Record<string, unknown> & {
         loaded?: Record<string, unknown>;
         tx?: TransactionPG;
     }) => Promise<boolean>;
@@ -29,7 +30,7 @@ export declare class PGDB extends DB<TransactionPG> {
     dropIndexes(table: Table, constraintIndexes: number[]): Promise<void>;
     syncConstraints(table: Table): Promise<void>;
     syncDataBase(): Promise<void>;
-    fieldType(attribute: Attribute<Natural, unknown>): string[];
+    fieldType(attribute: Attribute<unknown, unknown>): string[];
     syncFields(table: Table): Promise<void>;
     syncIndexes(table: Table): Promise<void>;
     syncSequence(table: Table): Promise<void>;

package/package.json

@@ -9,7 +9,7 @@
     "@types/pg": "8.6.5",
     "pg": "8.7.3",
     "pg-format": "1.0.4",
-    "sedentary": "0.0.42"
+    "sedentary": "0.0.45"
   },
   "description": "The ORM which never needs to migrate - PostgreSQL",
   "engines": {
@@ -39,13 +39,13 @@
   "repository": "https://github.com/iccicci/sedentary",
   "scripts": {
     "build": "make build",
-    "coverage": "jest --coverage --runInBand",
-    "deploy": "npm_config_registry=\"registry.npmjs.org\" npm publish",
+    "coverage": "jest --coverage --no-cache --runInBand",
+    "deploy": "make deploy",
     "precoverage": "make pretest",
     "preinstall": "if [ -f Makefile ] ; then make ; fi",
     "pretest": "make pretest",
-    "test": "jest --runInBand"
+    "test": "jest --no-cache --runInBand"
   },
   "types": "./dist/types/index.d.ts",
-  "version": "0.0.42"
+  "version": "0.0.45"
 }