sedentary 0.0.23 → 0.0.24

package/db.d.ts

@@ -1,6 +1,6 @@
-export declare type Natural = Date | Record<string, unknown> | boolean | number | string;
+export declare type Natural = Date | Record<string, unknown> | boolean | number | string | null;
 export declare class EntryBase {
-    constructor(from?: Partial<EntryBase> | "load");
+    constructor(from?: Partial<EntryBase>);
     construct(): void;
     postLoad(): void;
     postSave(): void;
@@ -57,7 +57,11 @@ interface ITable {
     autoIncrement: boolean;
     constraints: Constraint[];
     indexes: Index[];
+    model: {
+        load: (where: any, order?: string[], tx?: Transaction) => Promise<EntryBase[]>;
+    };
     parent?: Attribute<Natural, unknown>;
+    pk: Attribute<Natural, unknown>;
     sync: boolean;
     tableName: string;
 }
@@ -78,8 +82,10 @@ export declare abstract class DB {
     protected indexesEq(a: Index, b: Index): boolean;
     syncDataBase(): Promise<void>;
     protected syncLog(message: string): void;
+    begin(): Promise<Transaction>;
     abstract escape(value: Natural): string;
-    abstract save(tableName: string, attributes: Attribute<Natural, unknown>[]): (this: Record<string, Natural>) => Promise<boolean>;
+    abstract load(tableName: string, attributes: Record<string, string>, pk: Attribute<Natural, unknown>, model: new () => EntryBase, table: Table): (where: string, order?: string[], tx?: Transaction) => Promise<EntryBase[]>;
+    abstract save(tableName: string, attributes: Record<string, string>, pk: Attribute<Natural, unknown>): (this: EntryBase & Record<string, Natural>) => Promise<boolean>;
     abstract dropConstraints(table: Table): Promise<number[]>;
     abstract dropFields(table: Table): Promise<void>;
     abstract dropIndexes(table: Table, constraintIndexes: number[]): Promise<void>;
@@ -90,5 +96,10 @@ export declare abstract class DB {
     abstract syncTable(table: Table): Promise<void>;
 }
 export declare class Transaction {
+    private entries;
+    addEntry(entry: EntryBase): void;
+    clean(): void;
+    commit(): Promise<void>;
+    rollback(): Promise<void>;
 }
 export {};

package/db.js

@@ -83,8 +83,29 @@ class DB {
     syncLog(message) {
         this.log(this.sync ? message : "NOT SYNCING: " + message);
     }
+    async begin() {
+        return new Transaction();
+    }
 }
 exports.DB = DB;
 class Transaction {
+    constructor() {
+        this.entries = [];
+    }
+    addEntry(entry) {
+        this.entries.push(entry);
+    }
+    clean() {
+        const { entries } = this;
+        for (const entry of entries)
+            delete entry.tx;
+        this.entries = [];
+    }
+    async commit() {
+        this.clean();
+    }
+    async rollback() {
+        this.clean();
+    }
 }
 exports.Transaction = Transaction;

package/index.d.ts

@@ -1,5 +1,5 @@
-import { Attribute, DB, EntryBase, ForeignKeyOptions, Natural, Type } from "./db";
-export { EntryBase, ForeignKeyActions, ForeignKeyOptions, Natural, Type } from "./db";
+import { Attribute, DB, EntryBase, ForeignKeyOptions, Natural, Transaction, Type } from "./db";
+export { EntryBase, ForeignKeyActions, ForeignKeyOptions, Natural, Transaction, Type } from "./db";
 export declare type TypeDefinition<N extends Natural, E> = (() => Type<N, E>) | Type<N, E>;
 export interface AttributeOptions<N extends Natural, E> {
     defaultValue?: N;
@@ -16,7 +16,7 @@ declare type ForeignKeysAttributes<T, k> = T extends AttributeDefinition<Natural
 declare type ForeignKeys<A extends AttributesDefinition> = {
     [a in keyof A]?: ForeignKeysAttributes<A[a], a>;
 }[keyof A];
-declare type Native__<T> = T extends Type<infer N, unknown> ? N : never;
+declare type Native__<T> = T extends Type<infer N, unknown> ? N | null : never;
 declare type Native_<T> = T extends () => Type<infer N, infer E> ? Native__<Type<N, E>> : Native__<T>;
 declare type Native<T> = T extends AttributeOptions<infer N, infer E> ? Native__<Type<N, E>> : Native_<T>;
 export declare type IndexAttributes = string[] | string;
@@ -39,11 +39,12 @@ export interface ModelOptions extends BaseModelOptions {
     parent?: Attribute<Natural, EntryBase>;
     primaryKey?: string;
 }
-declare type ConditionAttribute<N extends Natural> = N | [">" | "<" | ">=" | "<=" | "<>", N] | ["IN", ...N[]] | ["IS NULL"] | ["LIKE", string];
+declare type ConditionAttribute<N extends Natural> = N | ["=" | ">" | "<" | ">=" | "<=" | "<>", N] | ["IN", N[]] | ["IS NULL"] | ["LIKE", string] | ["NOT"];
 declare type ConditionBase<A extends AttributesDefinition> = string | {
     [a in keyof A]?: ConditionAttribute<Native<A[a]>>;
 };
 declare type Condition<A extends AttributesDefinition> = ConditionBase<A> | ["NOT", Condition<A>] | ["AND", ...Condition<A>[]] | ["OR", ...Condition<A>[]];
+declare type Order<A extends AttributesDefinition> = (keyof A | `-${string & keyof A}`)[];
 declare type UnionToIntersection<U> = (U extends unknown ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
 declare type IsUnion<T> = [T] extends [UnionToIntersection<T>] ? false : true;
 declare type BaseKeyType<B extends boolean> = IsUnion<B> extends true ? number : B extends true ? string : number;
@@ -61,16 +62,19 @@ declare type ModelAttributesIf<A extends AttributesDefinition, T> = keyof A exte
 declare type ModelAttributes<A extends AttributesDefinition, B extends boolean, K extends string, P extends ModelStd> = K extends keyof A ? A : ModelAttributesIf<A, P extends new () => EntryBase ? P["attributes"] : {
     id: Type<BaseKeyType<B>, unknown>;
 }>;
-declare type ModelBase<N extends Natural, A extends AttributesDefinition, EA extends Record<string, Natural | undefined>, EM extends EntryBase, E extends EntryBase> = (new (from?: EA) => E) & Attribute<N, E> & {
+interface ModelLoad<A extends AttributesDefinition, E extends EntryBase> {
     attributes: A;
+    load(where: Condition<A>, order?: Order<A>, tx?: Transaction): Promise<E[]>;
+    load(where: Condition<A>, tx: Transaction): Promise<E[]>;
+}
+declare type ModelBase<N extends Natural, A extends AttributesDefinition, EA extends Record<string, Natural | undefined>, EM extends EntryBase, E extends EntryBase> = (new (from?: EA) => E) & Attribute<N, E> & {
     foreignKeys: Record<string, boolean>;
     methods: EM;
     parent?: ModelStd;
     tableName: string;
-    load: (where?: Condition<A>) => Promise<E[]>;
 } & {
     [a in keyof A]: Attribute<Native<A[a]>, E>;
-};
+} & ModelLoad<A, E>;
 declare type Model<N extends Natural, A extends AttributesDefinition, EM extends EntryBase> = ModelBase<N, A, EntryBaseAttributes<A>, EM, EntryBaseAttributes<A> & EM>;
 declare type ModelStd = Attribute<Natural, EntryBase> & {
     attributes: AttributesDefinition;
@@ -79,9 +83,14 @@ declare type ModelStd = Attribute<Natural, EntryBase> & {
     parent?: ModelStd;
 };
 export declare type Entry<M> = M extends new () => infer E ? E : never;
-export declare type Where<M> = M extends {
-    load: (where: infer T) => void;
+export declare type OrderBy<M> = M extends {
+    load(where: unknown, order?: infer T, tx?: Transaction): void;
+    load(where: unknown, tx?: Transaction): void;
 } ? Exclude<T, undefined> : never;
+export declare type Where<M> = M extends {
+    load(where: infer T, order?: unknown, tx?: Transaction): void;
+    load(where: unknown, tx?: Transaction): void;
+} ? T : never;
 export interface SedentaryOptions {
     autoSync?: boolean;
     log?: ((message: string) => void) | null;
@@ -90,8 +99,8 @@ export interface SedentaryOptions {
 export declare class Sedentary {
     protected autoSync: boolean;
     protected db: DB;
+    protected doSync: boolean;
     protected log: (...data: unknown[]) => void;
-    protected sync: boolean;
     private models;
     constructor(options?: SedentaryOptions);
     DATETIME(): Type<Date, unknown>;
@@ -99,10 +108,14 @@ export declare class Sedentary {
     INT(size?: number): Type<number, unknown>;
     INT8(): Type<string, unknown>;
     VARCHAR(size?: number): Type<string, unknown>;
-    checkDB(): void;
-    checkSize(size: number, message: string): number;
+    private checkDB;
+    private checkOrderBy;
+    private checkSize;
+    private createWhere;
     connect(sync?: boolean): Promise<void>;
+    sync(): Promise<void>;
     end(): Promise<void>;
+    begin(): Promise<Transaction>;
     escape(value: Natural): string;
     model<A extends AttributesDefinition, B extends boolean, K extends string, P extends ModelStd, EM extends EntryMethods<A, P>>(modelName: string, attributes: A, options?: BaseModelOptions & {
         int8id?: B;

package/index.js

@@ -1,18 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Sedentary = exports.Type = exports.EntryBase = void 0;
+exports.Sedentary = exports.Type = exports.Transaction = exports.EntryBase = void 0;
 const db_1 = require("./db");
 var db_2 = require("./db");
 Object.defineProperty(exports, "EntryBase", { enumerable: true, get: function () { return db_2.EntryBase; } });
+Object.defineProperty(exports, "Transaction", { enumerable: true, get: function () { return db_2.Transaction; } });
 Object.defineProperty(exports, "Type", { enumerable: true, get: function () { return db_2.Type; } });
+const operators = ["=", ">", "<", ">=", "<=", "<>", "IN", "IS NULL", "LIKE", "NOT"];
 const allowedOption = ["indexes", "int8id", "parent", "primaryKey", "sync", "tableName"];
 const reservedNames = [
-    ...["attributeName", "attributes", "base", "class", "construct", "constructor", "defaultValue", "entry", "fieldName", "foreignKeys", "load"],
+    ...["attr2field", "attributeName", "attributes", "base", "class", "construct", "constructor", "defaultValue", "entry", "fieldName", "foreignKeys", "load"],
     ...["loaded", "methods", "name", "postLoad", "postSave", "preLoad", "preSave", "primaryKey", "prototype", "save", "size", "tableName", "tx", "type"]
 ];
 class Sedentary {
     constructor(options) {
-        this.sync = true;
+        this.doSync = true;
         this.models = {};
         if (!options)
             options = {};
@@ -32,7 +34,7 @@ class Sedentary {
         this.db = null;
         // eslint-disable-next-line no-console
         this.log = log ? log : log === null ? () => { } : console.log;
-        this.sync = sync;
+        this.doSync = sync;
     }
     DATETIME() {
         return new db_1.Type({ base: Date, type: "DATETIME" });
@@ -60,6 +62,24 @@ class Sedentary {
         if (!this.db)
             throw new Error("Package sedentary can't be used directly. Please check: https://www.npmjs.com/package/sedentary#disclaimer");
     }
+    checkOrderBy(order, attributes, modelName) {
+        if (!order)
+            return true;
+        if (!(order instanceof Array))
+            return false;
+        const provided = {};
+        for (const attribute of order) {
+            if (typeof attribute !== "string")
+                return false;
+            const attributeName = attribute.startsWith("-") ? attribute.substring(1) : attribute;
+            if (!(attributeName in attributes))
+                throw new Error(`${modelName}.load: 'order' argument: '${attributeName}' is not an attribute name`);
+            if (provided[attributeName])
+                throw new Error(`${modelName}.load: 'order' argument: Reused '${attributeName}' attribute`);
+            provided[attributeName] = true;
+        }
+        return true;
+    }
     checkSize(size, message) {
         const str = size.toString();
         const parsed = parseInt(str, 10);
@@ -67,28 +87,103 @@ class Sedentary {
             throw new Error(message);
         return parsed;
     }
+    createWhere(modelName, attributes, where) {
+        if (typeof where === "string")
+            return [where, true, true];
+        if (typeof where !== "object")
+            throw new Error(`${modelName}.load: 'where' argument: Wrong type, expected 'Array', 'Object' or 'string'`);
+        if (!where)
+            return ["", false, false];
+        if (where instanceof Array) {
+            const length = where.length;
+            if (!length)
+                throw new Error(`${modelName}.load: 'where' argument: Empty Array`);
+            if (!["AND", "NOT", "OR"].includes(where[0]))
+                throw new Error(`${modelName}.load: 'where' argument: Wrong logical operator, expected 'AND', 'OR' or 'NOT'`);
+            if (length === 1)
+                return ["", false, false];
+            if (where[0] === "NOT") {
+                if (length > 2)
+                    throw new Error(`${modelName}.load: 'where' argument: 'NOT' operator is unary`);
+                const [res] = this.createWhere(modelName, attributes, where[1]);
+                return [res === "" ? "" : `NOT (${res})`, false, false];
+            }
+            const conditions = where
+                .filter((_, i) => i)
+                .map(_ => this.createWhere(modelName, attributes, _))
+                .filter(([_]) => _);
+            if (conditions.length === 1)
+                return conditions[0];
+            const isOr = where[0] === "OR";
+            return [isOr ? conditions.map(([_, , a]) => (a ? `(${_})` : _)).join(" OR ") : conditions.map(([_, o]) => (o ? `(${_})` : _)).join(" AND "), isOr, false];
+        }
+        const conditions = [];
+        for (const key in where) {
+            const field = attributes[key];
+            if (!field)
+                throw new Error(`${modelName}.load: 'where' argument: Unknown '${key}' attribute`);
+            const value = where[key];
+            if (value instanceof Array) {
+                const operator = value[0];
+                const length = value.length;
+                if (!length)
+                    throw new Error(`${modelName}.load: 'where' argument: Missing arithmetic operator, expected one of: ${operators.map(_ => `'${_}'`).join(", ")}`);
+                if (!operators.includes(operator))
+                    throw new Error(`${modelName}.load: 'where' argument: Wrong arithmetic operator, expected one of: ${operators.map(_ => `'${_}'`).join(", ")}`);
+                if (operator === "IS NULL") {
+                    if (length !== 1)
+                        throw new Error(`${modelName}.load: 'where' argument: 'IS NULL' operator is unary`);
+                    conditions.push(`${field} IS NULL`);
+                }
+                else if (operator === "NOT") {
+                    if (length !== 1)
+                        throw new Error(`${modelName}.load: 'where' argument: 'NOT' operator is unary`);
+                    conditions.push(`NOT ${field}`);
+                }
+                else {
+                    if (length !== 2)
+                        throw new Error(`${modelName}.load: 'where' argument: '${operator}' operator is binary`);
+                    if (operator === "IN") {
+                        if (!(value[1] instanceof Array))
+                            throw new Error(`${modelName}.load: 'where' argument: 'IN' right operand: Wrong type, expected Array`);
+                        conditions.push(`${field} IN (${value[1].map(_ => this.escape(_)).join(", ")})`);
+                    }
+                    else
+                        conditions.push(`${field} ${operator} ${this.escape(value[1])}`);
+                }
+            }
+            else
+                conditions.push(`${field} = ${this.escape(value)}`);
+        }
+        return [conditions.length ? conditions.join(" AND ") : "", false, false];
+    }
     async connect(sync) {
         try {
             this.checkDB();
             this.log("Connecting...");
             await this.db.connect();
             this.log("Connected");
-            if (this.autoSync || sync) {
-                this.log("Syncing...");
-                await this.db.syncDataBase();
-                this.log("Synced");
-            }
+            if (this.autoSync || sync)
+                await this.sync();
         }
         catch (e) {
             this.log("Connecting: " + (e instanceof Error ? e.message : JSON.stringify(e)));
             throw e;
         }
     }
+    async sync() {
+        this.log("Syncing...");
+        await this.db.syncDataBase();
+        this.log("Synced");
+    }
     async end() {
         this.log("Closing connection...");
         await this.db.end();
         this.log("Connection closed");
     }
+    async begin() {
+        return this.db.begin();
+    }
     escape(value) {
         return this.db.escape(value);
     }
@@ -117,13 +212,14 @@ class Sedentary {
         if (options.parent && options.primaryKey)
             throw new Error(`Sedentary.model: '${modelName}' model: 'parent' and 'primaryKey' options conflict each other`);
         let autoIncrement = true;
-        const { indexes, int8id, parent, primaryKey, sync, tableName } = Object.assign({ sync: this.sync, tableName: modelName }, options);
+        const { indexes, int8id, parent, primaryKey, sync, tableName } = Object.assign({ sync: this.doSync, tableName: modelName }, options);
         let aarray = int8id
             ? [new db_1.Attribute(Object.assign(Object.assign({}, this.INT8()), { attributeName: "id", fieldName: "id", modelName, notNull: true, tableName, unique: true }))]
             : [new db_1.Attribute(Object.assign(Object.assign({}, this.INT(4)), { attributeName: "id", fieldName: "id", modelName, notNull: true, tableName, unique: true }))];
         let constraints = [{ attribute: aarray[0], constraintName: `${tableName}_id_unique`, type: "u" }];
         const iarray = [];
-        const pk = aarray[0];
+        let pk = aarray[0];
+        let attr2field = { id: "id" };
         if (!methods)
             methods = {};
         if (!(methods instanceof Object))
@@ -136,6 +232,8 @@ class Sedentary {
         if (primaryKey && !Object.keys(attributes).includes(primaryKey))
             throw new Error(`Sedentary.model: '${modelName}' model: 'primaryKey' option: Attribute '${primaryKey}' does not exists`);
         if (parent || primaryKey) {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            attr2field = parent ? Object.assign({}, parent.attr2field) : {};
             autoIncrement = false;
             aarray = [];
             constraints = [];
@@ -212,7 +310,10 @@ class Sedentary {
             if (defaultValue)
                 notNull = true;
             const attribute = new db_1.Attribute({ attributeName, base, defaultValue, fieldName, foreignKey, modelName, notNull, size, tableName, type, unique });
+            if (primaryKey === attributeName)
+                pk = attribute;
             aarray.push(attribute);
+            attr2field[attributeName] = fieldName;
             if (foreignKey)
                 constraints.push({ attribute, constraintName: `fkey_${fieldName}_${foreignKey.tableName}_${foreignKey.fieldName}`, type: "f" });
             if (unique)
@@ -270,7 +371,6 @@ class Sedentary {
                 iarray.push({ fields: attributes, indexName, type, unique });
             }
         }
-        this.db.tables.push(new db_1.Table({ autoIncrement, constraints, attributes: aarray, indexes: iarray, parent, sync, tableName }));
         this.models[modelName] = true;
         const foreignKeys = aarray
             .filter(_ => _.foreignKey)
@@ -311,27 +411,42 @@ class Sedentary {
                 for (const foreignKey in parent.foreignKeys)
                     if (foreignKey + "Load" === method)
                         throw new Error(`Sedentary.model: '${modelName}' model: '${method}' method: conflicts with an inferred methods of '${parent.modelName}' model`);
-                if (method in parent.methods)
-                    throw new Error(`Sedentary.model: '${modelName}' model: '${method}' method: conflicts with a method of '${parent.modelName}' model`);
             }
             checkParent(parent.parent);
         };
         checkParent(parent);
         const ret = class extends (parent || db_1.EntryBase) {
         };
-        const load = (boh) => new Promise((resolve, reject) => setTimeout(() => {
-            if (boh)
-                return resolve([new ret()]);
-            reject(new Error("boh"));
-        }, 10));
+        const table = new db_1.Table({ autoIncrement, constraints, attributes: aarray, indexes: iarray, model: ret, parent, pk, sync, tableName });
+        this.db.tables.push(table);
+        const load_ = this.db.load(tableName, attr2field, pk, ret, table);
+        const load = async (where, order, tx) => {
+            if (order instanceof db_1.Transaction) {
+                tx = order;
+                order = undefined;
+            }
+            if (!this.checkOrderBy(order, attr2field, modelName))
+                throw new Error(`${modelName}.load: 'order' argument: Wrong type, expected 'string[]'`);
+            const [str] = this.createWhere(modelName, attr2field, where);
+            const ret = await load_(str, order, tx);
+            return ret;
+        };
         Object.defineProperty(load, "name", { value: modelName + ".load" });
         Object.defineProperty(ret, "name", { value: modelName });
         Object.defineProperty(ret, "load", { value: load });
+        Object.defineProperty(ret, "attr2field", { value: attr2field });
         Object.defineProperty(ret, "attributes", { value: attributes });
         Object.defineProperty(ret, "foreignKeys", { value: foreignKeys });
         Object.defineProperty(ret, "methods", { value: methods });
         Object.assign(ret.prototype, methods);
-        ret.prototype.save = this.db.save(tableName, aarray);
+        const save = this.db.save(tableName, attr2field, pk);
+        ret.prototype.save = async function () {
+            this.preSave();
+            const ret = await save.call(this);
+            if (ret)
+                this.postSave();
+            return ret;
+        };
         Object.defineProperty(ret.prototype.save, "name", { value: modelName + ".save" });
         for (const attribute of aarray)
             Object.defineProperty(ret, attribute.attributeName, { value: attribute });

package/package.json

@@ -9,16 +9,16 @@
   "description": "The ORM which never needs to migrate",
   "devDependencies": {
     "@types/mocha": "9.0.0",
-    "@types/node": "17.0.5",
+    "@types/node": "17.0.8",
     "@types/yamljs": "0.2.31",
-    "@typescript-eslint/eslint-plugin": "5.8.1",
-    "@typescript-eslint/parser": "5.8.1",
-    "eslint": "8.5.0",
+    "@typescript-eslint/eslint-plugin": "5.9.0",
+    "@typescript-eslint/parser": "5.9.0",
+    "eslint": "8.6.0",
     "mocha": "9.1.3",
     "nyc": "15.1.0",
     "prettier": "2.5.1",
     "ts-node": "10.4.0",
-    "tsd": "0.19.0",
+    "tsd": "0.19.1",
     "typescript": "4.5.4",
     "yamljs": "0.3.0"
   },
@@ -78,5 +78,5 @@
     }
   },
   "types": "index.d.ts",
-  "version": "0.0.23"
+  "version": "0.0.24"
 }