@itrocks/mysql-maintainer 0.1.2 → 0.2.0

package/cjs/mysql.d.ts

@@ -1,4 +1,3 @@
-import { KeyOf } from '@itrocks/class-type';
 import { ObjectOrType } from '@itrocks/class-type';
 import { Type } from '@itrocks/class-type';
 import { Mysql as M } from '@itrocks/mysql';
@@ -11,15 +10,15 @@ import { ContextualConnection } from './contextual-connection';
 export declare class Mysql extends M {
     connection?: ContextualConnection;
     connect(): Promise<ContextualConnection>;
-    deleteId<T extends object>(type: ObjectOrType<T>, id: any, property?: KeyOf<Entity<T>>): Promise<void>;
-    deleteRelatedId<T extends Entity>(object: T, property: KeyOf<T>, id: Identifier): Promise<void>;
+    deleteId<T extends object>(type: ObjectOrType<T>, id: any, property?: keyof Entity<T>): Promise<void>;
+    deleteRelatedId<T extends Entity>(object: T, property: keyof T, id: Identifier): Promise<void>;
     insert<T extends object>(object: T): Promise<Entity<T>>;
-    insertRelatedId<T extends Entity>(object: T, property: KeyOf<T>, id: Identifier): Promise<void>;
+    insertRelatedId<T extends Entity>(object: T, property: keyof T, id: Identifier): Promise<void>;
     read<T extends object>(type: Type<T>, id: Identifier): Promise<Entity<T>>;
-    readCollection<T extends object, PT extends object>(object: Entity<T>, property: KeyOf<T>, type?: Type<PT>): Promise<Awaited<PT & {
+    readCollection<T extends object, PT extends object>(object: Entity<T>, property: keyof T, type?: Type<PT>): Promise<Awaited<PT & {
         id: Identifier;
     }>[]>;
-    readCollectionIds<T extends object, PT extends object>(object: Entity<T>, property: KeyOf<T>, type?: Type<PT>): Promise<Identifier[]>;
+    readCollectionIds<T extends object, PT extends object>(object: Entity<T>, property: keyof T, type?: Type<PT>): Promise<Identifier[]>;
     readMultiple<T extends object>(type: Type<T>, ids: Identifier[]): Promise<Entity<T>[]>;
     save<T extends object>(object: MayEntity<T>): Promise<Entity<T>>;
     search<T extends object>(type: Type<T>, search?: SearchType<T>, options?: Options): Promise<Entity<T>[]>;

package/esm/mysql.d.ts

@@ -1,4 +1,3 @@
-import { KeyOf } from '@itrocks/class-type';
 import { ObjectOrType } from '@itrocks/class-type';
 import { Type } from '@itrocks/class-type';
 import { Mysql as M } from '@itrocks/mysql';
@@ -11,15 +10,15 @@ import { ContextualConnection } from './contextual-connection';
 export declare class Mysql extends M {
     connection?: ContextualConnection;
     connect(): Promise<ContextualConnection>;
-    deleteId<T extends object>(type: ObjectOrType<T>, id: any, property?: KeyOf<Entity<T>>): Promise<void>;
-    deleteRelatedId<T extends Entity>(object: T, property: KeyOf<T>, id: Identifier): Promise<void>;
+    deleteId<T extends object>(type: ObjectOrType<T>, id: any, property?: keyof Entity<T>): Promise<void>;
+    deleteRelatedId<T extends Entity>(object: T, property: keyof T, id: Identifier): Promise<void>;
     insert<T extends object>(object: T): Promise<Entity<T>>;
-    insertRelatedId<T extends Entity>(object: T, property: KeyOf<T>, id: Identifier): Promise<void>;
+    insertRelatedId<T extends Entity>(object: T, property: keyof T, id: Identifier): Promise<void>;
     read<T extends object>(type: Type<T>, id: Identifier): Promise<Entity<T>>;
-    readCollection<T extends object, PT extends object>(object: Entity<T>, property: KeyOf<T>, type?: Type<PT>): Promise<Awaited<PT & {
+    readCollection<T extends object, PT extends object>(object: Entity<T>, property: keyof T, type?: Type<PT>): Promise<Awaited<PT & {
         id: Identifier;
     }>[]>;
-    readCollectionIds<T extends object, PT extends object>(object: Entity<T>, property: KeyOf<T>, type?: Type<PT>): Promise<Identifier[]>;
+    readCollectionIds<T extends object, PT extends object>(object: Entity<T>, property: keyof T, type?: Type<PT>): Promise<Identifier[]>;
     readMultiple<T extends object>(type: Type<T>, ids: Identifier[]): Promise<Entity<T>[]>;
     save<T extends object>(object: MayEntity<T>): Promise<Entity<T>>;
     search<T extends object>(type: Type<T>, search?: SearchType<T>, options?: Options): Promise<Entity<T>[]>;

package/package.json

@@ -57,5 +57,5 @@
 		"build:esm": "tsc -p tsconfig.esm.json"
 	},
 	"types": "./esm/mysql-maintainer.d.ts",
-	"version": "0.1.2"
+	"version": "0.2.0"
 }

package/src/contextual-connection.d.ts

@@ -1,11 +0,0 @@
-import { ObjectOrType } from '@itrocks/class-type';
-import { Connection } from 'mariadb';
-import { QueryOptions } from 'mariadb';
-export type Context = ObjectOrType | ObjectOrType[];
-export declare class Contextual implements Partial<Connection> {
-    contexts: Context[];
-    superQuery: <T = any>(sql: string | QueryOptions, values?: any) => Promise<T>;
-    applyTo(connection: ContextualConnection): Promise<ContextualConnection>;
-    query<T = any>(sql: string | QueryOptions, values?: any): Promise<T>;
-}
-export type ContextualConnection = Connection & Contextual;

package/src/contextual-connection.js

@@ -1,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Contextual = void 0;
-const mariadb_1 = require("mariadb");
-const mysql_maintainer_1 = require("./mysql-maintainer");
-const mysql_maintainer_2 = require("./mysql-maintainer");
-const MANAGED_ERROR_CODES = ['ER_BAD_FIELD_ERROR', 'ER_CANNOT_ADD_FOREIGN', 'ER_NO_SUCH_TABLE'];
-class Contextual {
-    contexts = [];
-    superQuery = () => new Promise(() => { });
-    async applyTo(connection) {
-        connection.contexts = [];
-        connection.superQuery = connection.query;
-        connection.query = Contextual.prototype.query;
-        return connection;
-    }
-    async query(sql, values) {
-        try {
-            if (mysql_maintainer_1.DEBUG)
-                console.log(sql, values);
-            return await this.superQuery(sql, values);
-        }
-        catch (error) {
-            if (!(error instanceof mariadb_1.SqlError)
-                || !error.code
-                || !MANAGED_ERROR_CODES.includes(error.code)) {
-                if (mysql_maintainer_1.DEBUG)
-                    console.log('MAINTAINER: throw', error);
-                throw error;
-            }
-            // @ts-ignore query applies to a Connection
-            if (await new mysql_maintainer_2.MysqlMaintainer(this).manageError(error, this.contexts[this.contexts.length - 1], sql, values)) {
-                return this.query(sql, values);
-            }
-            throw error;
-        }
-    }
-}
-exports.Contextual = Contextual;
-//# sourceMappingURL=contextual-connection.js.map

package/src/mysql-maintainer.d.ts

@@ -1,18 +0,0 @@
-import { ObjectOrType } from '@itrocks/class-type';
-import { Type } from '@itrocks/class-type';
-import { Connection } from 'mariadb';
-import { QueryOptions } from 'mariadb';
-import { SqlError } from 'mariadb';
-import { Context } from './contextual-connection';
-export { Mysql } from './mysql';
-export declare const DEBUG = false;
-export declare class MysqlMaintainer {
-    connection: Connection;
-    constructor(connection: Connection);
-    createImplicitTable(type1: ObjectOrType, type2: ObjectOrType): Promise<boolean>;
-    createTable(type: Type): Promise<boolean>;
-    implicitTableName(type1: ObjectOrType, type2: ObjectOrType): string;
-    manageError(error: SqlError, context: Context, sql: string | QueryOptions, values: any[]): Promise<boolean>;
-    updateContextTables(context: Context, tableName?: string): Promise<boolean>;
-    updateTable(type: Type): Promise<boolean>;
-}

package/src/mysql-maintainer.js

@@ -1,105 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MysqlMaintainer = exports.DEBUG = exports.Mysql = void 0;
-const class_type_1 = require("@itrocks/class-type");
-const mysql_1 = require("@itrocks/mysql");
-const mysql_to_schema_1 = require("@itrocks/mysql-to-schema");
-const reflect_to_schema_1 = require("@itrocks/reflect-to-schema");
-const schema_diff_1 = require("@itrocks/schema-diff");
-const schema_diff_mysql_1 = require("@itrocks/schema-diff-mysql");
-const schema_to_mysql_1 = require("@itrocks/schema-to-mysql");
-const store_1 = require("@itrocks/store");
-var mysql_2 = require("./mysql");
-Object.defineProperty(exports, "Mysql", { enumerable: true, get: function () { return mysql_2.Mysql; } });
-exports.DEBUG = false;
-const DELETION = false;
-class MysqlMaintainer {
-    connection;
-    constructor(connection) {
-        this.connection = connection;
-    }
-    async createImplicitTable(type1, type2) {
-        const joinTable = this.implicitTableName(type1, type2);
-        const table1 = (0, store_1.storeOf)(type1);
-        const table2 = (0, store_1.storeOf)(type2);
-        const query = `CREATE TABLE \`${joinTable}\` (
-${table1}_id int unsigned NOT NULL,
-${table2}_id int unsigned NOT NULL,
-PRIMARY KEY (${table1}_id, ${table2}_id),
-CONSTRAINT \`${joinTable}.${table1}_id\` FOREIGN KEY (${table1}_id) REFERENCES \`${table1}\` (id) ON DELETE CASCADE ON UPDATE CASCADE,
-CONSTRAINT \`${joinTable}.${table2}_id\` FOREIGN KEY (${table2}_id) REFERENCES \`${table2}\` (id) ON DELETE CASCADE ON UPDATE CASCADE
-)`;
-        await this.connection.query(query);
-        return true;
-    }
-    async createTable(type) {
-        const tableName = (0, store_1.storeOf)(type);
-        if (!tableName) {
-            throw 'No table name for type';
-        }
-        const tableSchema = new reflect_to_schema_1.ReflectToTable().convert(type);
-        const schemaToMysql = new schema_to_mysql_1.SchemaToMysql();
-        const sql = schemaToMysql.sql(tableSchema);
-        await this.connection.query(sql);
-        return true;
-    }
-    implicitTableName(type1, type2) {
-        const table1 = (0, store_1.storeOf)(type1);
-        const table2 = (0, store_1.storeOf)(type2);
-        if (!table1 || !table2) {
-            throw 'Collection objects are not stored';
-        }
-        return (0, mysql_1.joinTableName)(table1, table2);
-    }
-    async manageError(error, context, sql, values) {
-        if (exports.DEBUG)
-            console.log('MAINTAINER: manageError', error);
-        switch (error.code) {
-            case 'ER_BAD_FIELD_ERROR':
-            case 'ER_CANNOT_ADD_FOREIGN':
-                return await this.updateContextTables(context);
-            case 'ER_NO_SUCH_TABLE':
-                const tableName = /Table '.*?\.(.*?)'/.exec(error.message)?.[1];
-                return this.updateContextTables(context, tableName);
-        }
-        return false;
-    }
-    async updateContextTables(context, tableName) {
-        const contexts = Array.isArray(context) ? context : [context];
-        for (const context of contexts) {
-            const type = (0, class_type_1.typeOf)(context);
-            const tableName = (0, store_1.storeOf)(type);
-            if (!tableName) {
-                throw 'No table name for type';
-            }
-            const exists = (await this.connection.query('SHOW TABLES LIKE ?', tableName));
-            await (exists.length ? this.updateTable(type) : this.createTable(type));
-        }
-        if ((contexts.length === 2) && (this.implicitTableName(contexts[0], contexts[1]) === tableName)) {
-            await this.createImplicitTable(contexts[0], contexts[1]);
-        }
-        return true;
-    }
-    async updateTable(type) {
-        const tableName = (0, store_1.storeOf)(type);
-        if (!tableName) {
-            throw 'No table name for type';
-        }
-        const classTable = new reflect_to_schema_1.ReflectToTable().convert(type);
-        new mysql_to_schema_1.MysqlToTable(this.connection).normalize(classTable);
-        const mysqlTable = await ((new mysql_to_schema_1.MysqlToTable(this.connection)).convert(tableName));
-        const schemaDiff = new schema_diff_1.TableDiff(mysqlTable, classTable);
-        if (!schemaDiff.additions.length
-            && !schemaDiff.changes.length
-            && (!schemaDiff.deletions.length || !DELETION)
-            && !schemaDiff.tableChanges()) {
-            return false;
-        }
-        const schemaDiffMysql = new schema_diff_mysql_1.SchemaDiffMysql();
-        const sql = schemaDiffMysql.sql(schemaDiff, DELETION);
-        await this.connection.query(sql);
-        return true;
-    }
-}
-exports.MysqlMaintainer = MysqlMaintainer;
-//# sourceMappingURL=mysql-maintainer.js.map

package/src/mysql.d.ts

@@ -1,25 +0,0 @@
-import { KeyOf } from '@itrocks/class-type';
-import { ObjectOrType } from '@itrocks/class-type';
-import { Type } from '@itrocks/class-type';
-import { Options } from '@itrocks/storage';
-import { Mysql as M } from '@itrocks/mysql';
-import { Entity } from '@itrocks/storage';
-import { Identifier } from '@itrocks/storage';
-import { SearchType } from '@itrocks/storage';
-import { ContextualConnection } from './contextual-connection';
-export declare class Mysql extends M {
-    connection?: ContextualConnection;
-    connect(): Promise<ContextualConnection>;
-    deleteId<T extends object>(type: ObjectOrType<T>, id: any, property?: KeyOf<Entity<T>>): Promise<void>;
-    deleteRelatedId<T extends Entity>(object: T, property: KeyOf<T>, id: Identifier): Promise<void>;
-    insert<T extends object>(object: T): Promise<Entity<T>>;
-    insertRelatedId<T extends Entity>(object: T, property: KeyOf<T>, id: Identifier): Promise<void>;
-    read<T extends object>(type: Type<T>, id: Identifier): Promise<Entity<T>>;
-    readCollection<T extends object, PT extends object>(object: Entity<T>, property: KeyOf<T>, type?: Type<PT>): Promise<Awaited<PT & {
-        id: Identifier;
-    }>[]>;
-    readCollectionIds<T extends object, PT extends object>(object: Entity<T>, property: KeyOf<T>, type?: Type<PT>): Promise<Identifier[]>;
-    readMultiple<T extends object>(type: Type<T>, ids: Identifier[]): Promise<Entity<T>[]>;
-    search<T extends object>(type: Type<T>, search?: SearchType<T>, options?: Options): Promise<Entity<T>[]>;
-    update<T extends object>(object: Entity<T>): Promise<Entity<T>>;
-}

package/src/mysql.js

@@ -1,85 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Mysql = void 0;
-const mysql_1 = require("@itrocks/mysql");
-const reflect_1 = require("@itrocks/reflect");
-const contextual_connection_1 = require("./contextual-connection");
-class Mysql extends mysql_1.Mysql {
-    async connect() {
-        return contextual_connection_1.Contextual.prototype.applyTo(await super.connect());
-    }
-    async deleteId(type, id, property = 'id') {
-        const contexts = (this.connection ?? await this.connect()).contexts;
-        contexts.push(type);
-        const result = await super.deleteId(type, id, property);
-        contexts.pop();
-        return result;
-    }
-    async deleteRelatedId(object, property, id) {
-        const contexts = (this.connection ?? await this.connect()).contexts;
-        contexts.push(object);
-        const result = await super.deleteRelatedId(object, property, id);
-        contexts.pop();
-        return result;
-    }
-    async insert(object) {
-        const contexts = (this.connection ?? await this.connect()).contexts;
-        contexts.push(object);
-        const result = await super.insert(object);
-        contexts.pop();
-        return result;
-    }
-    async insertRelatedId(object, property, id) {
-        const contexts = (this.connection ?? await this.connect()).contexts;
-        contexts.push(object);
-        const result = await super.insertRelatedId(object, property, id);
-        contexts.pop();
-        return result;
-    }
-    async read(type, id) {
-        const contexts = (this.connection ?? await this.connect()).contexts;
-        contexts.push(type);
-        const result = await super.read(type, id);
-        contexts.pop();
-        return result;
-    }
-    async readCollection(object, property, type) {
-        type ??= new reflect_1.ReflectProperty(object, property).collectionType.elementType.type;
-        const contexts = (this.connection ?? await this.connect()).contexts;
-        contexts.push([object, type]);
-        const result = await super.readCollection(object, property, type);
-        contexts.pop();
-        return result;
-    }
-    async readCollectionIds(object, property, type) {
-        type ??= new reflect_1.ReflectProperty(object, property).collectionType.elementType.type;
-        const contexts = (this.connection ?? await this.connect()).contexts;
-        contexts.push([object, type]);
-        const result = await super.readCollectionIds(object, property, type);
-        contexts.pop();
-        return result;
-    }
-    async readMultiple(type, ids) {
-        const contexts = (this.connection ?? await this.connect()).contexts;
-        contexts.push(type);
-        const result = await super.readMultiple(type, ids);
-        contexts.pop();
-        return result;
-    }
-    async search(type, search = {}, options) {
-        const contexts = (this.connection ?? await this.connect()).contexts;
-        contexts.push(type);
-        const result = await super.search(type, search, options);
-        contexts.pop();
-        return result;
-    }
-    async update(object) {
-        const contexts = (this.connection ?? await this.connect()).contexts;
-        contexts.push(object);
-        const result = await super.update(object);
-        contexts.pop();
-        return result;
-    }
-}
-exports.Mysql = Mysql;
-//# sourceMappingURL=mysql.js.map