nodecommons-esm-models 0.0.2

package/dist/classes/commons-first-class.d.mts

@@ -0,0 +1,42 @@
+import { TPropertyObject } from 'tscommons-esm-core';
+import { ICommonsFirstClass } from 'tscommons-esm-models';
+import { CommonsDatabaseIndexKey, CommonsDatabaseParam, CommonsDatabaseTypeSerialId, CommonsDatabaseUniqueKey, CommonsSqlDatabaseService, ECommonsDatabaseOrderBy, ICommonsCredentials, TCommonsDatabaseDbValues, TCommonsDatabaseParams, TCommonsDatabaseTypes, TCommonsDatabaseValues } from 'nodecommons-esm-database';
+import { TCommonsModelForeignKeys } from '../types/tcommons-model-foreign-keys.mjs';
+import { CommonsModel } from './commons-model.mjs';
+export type TInternalFirstClassModelParamId = {
+    id: CommonsDatabaseParam<number, number>;
+};
+export type TInternalFirstClassModelTypeId = {
+    id: CommonsDatabaseTypeSerialId;
+};
+export type TInternalFirstClassModelValueId = Pick<ICommonsFirstClass, 'id'>;
+export type TInternalFirstClassModelDbValueId = TInternalFirstClassModelValueId;
+export type TInternalFirstClassExcludeId<T extends TPropertyObject> = Omit<T, 'id'> & {
+    id?: never;
+};
+export type TInternalFirstClassModelParams<ModelParamsT extends TCommonsDatabaseParams> = Omit<ModelParamsT, 'id'> & TInternalFirstClassModelParamId;
+export type TInternalFirstClassModelTypes<ModelTypesT extends TCommonsDatabaseTypes> = Omit<ModelTypesT, 'id'> & TInternalFirstClassModelTypeId;
+export type TInternalFirstClassModelValues<ModelValuesT extends TCommonsDatabaseValues> = Omit<ModelValuesT, 'id'> & TInternalFirstClassModelValueId;
+export type TInternalFirstClassModelDbValues<ModelDbValuesT extends TCommonsDatabaseDbValues> = Omit<ModelDbValuesT, 'id'> & TInternalFirstClassModelDbValueId;
+export declare class CommonsFirstClass<ModelI extends ICommonsFirstClass, ModelParamsT extends TInternalFirstClassExcludeId<TCommonsDatabaseParams>, ModelTypesT extends TInternalFirstClassExcludeId<TCommonsDatabaseTypes>, ModelDbValuesT extends TInternalFirstClassExcludeId<TCommonsDatabaseDbValues>> extends CommonsModel<ModelI, TInternalFirstClassModelParams<ModelParamsT>, TInternalFirstClassModelTypes<ModelTypesT>, TInternalFirstClassModelDbValues<ModelDbValuesT>> {
+    constructor(database: CommonsSqlDatabaseService<ICommonsCredentials>, tableName: string, structure: ModelTypesT, foreignKeys?: TCommonsModelForeignKeys, uniqueKeys?: CommonsDatabaseUniqueKey[], indexKeys?: CommonsDatabaseIndexKey[]);
+    static get idField(): string;
+    get idField(): string;
+    protected preprepare(): void;
+    protected internalFirstClassGetById(id: number): Promise<ModelI | undefined>;
+    getById(id: number): Promise<ModelI | undefined>;
+    refresh(object: TInternalFirstClassModelValueId): Promise<ModelI>;
+    bulkGetByIds(ids: number[], orderBy?: {
+        [field: string]: ECommonsDatabaseOrderBy;
+    }): Promise<ModelI[]>;
+    searchIdsForNonencryptedFields(value: string, fields: string[]): Promise<number[]>;
+    searchIdsForEncryptedFields(value: string, fields: string[]): Promise<number[]>;
+    searchFields(value: string, fields: string[], orderBy?: {
+        [field: string]: ECommonsDatabaseOrderBy;
+    }): Promise<ModelI[]>;
+    insert(_values: Partial<ModelI>): Promise<void>;
+    insertFirstClass(values: TInternalFirstClassExcludeId<Partial<ModelI>>): Promise<ModelI>;
+    delete(object: ModelI): Promise<void>;
+    update(object: Partial<ModelI> & TInternalFirstClassModelValueId): Promise<void>;
+    defragment(): Promise<void>;
+}

package/dist/classes/commons-first-class.mjs

@@ -0,0 +1,262 @@
+import { commonsTypeHasProperty, commonsTypeHasPropertyObject, commonsTypeHasPropertyString, commonsObjectMapObject, commonsArrayChunk, commonsArrayUnique } from 'tscommons-esm-core';
+import { CommonsDatabaseParam, CommonsDatabaseTypeEncrypted, CommonsDatabaseTypeSerialId, CommonsDatabaseTypeString, CommonsDatabaseTypeText, ECommonsDatabaseEngine, ECommonsDatabaseTypeNull, fromECommonsDatabaseOrderBy } from 'nodecommons-esm-database';
+import { CommonsModel } from './commons-model.mjs';
+export class CommonsFirstClass extends CommonsModel {
+    constructor(database, tableName, structure, foreignKeys = {}, uniqueKeys = [], indexKeys = []) {
+        super(database, tableName, {
+            ...structure,
+            id: new CommonsDatabaseTypeSerialId()
+        }, foreignKeys, uniqueKeys, indexKeys);
+        // No harm to do this after to check
+        if (structure.id !== undefined)
+            throw new Error('The id field is implicit for FirstClass models and should not be explicitly stated in the structure');
+    }
+    static get idField() {
+        return 'id';
+    }
+    get idField() {
+        return CommonsFirstClass.idField;
+    }
+    //-------------------------------------------------------------------------
+    preprepare() {
+        super.preprepare();
+        this.database.preprepare(`MODELS_FIRSTCLASS__${this.name}__GET_BY_ID`, `
+					SELECT ${this.fields}
+					FROM ${this.model(this)}
+					WHERE ${this.modelField(this, this.idField)} = :id
+				`, {
+            id: this.structure.id
+        }, this.structure);
+        const results = {
+            id: this.structure.id
+        };
+        this.database.preprepare(`MODELS_FIRSTCLASS__${this.name}__LIST_ALL_IDS`, `
+					SELECT ${this.modelField(this, this.idField)}
+					FROM ${this.model(this)}
+				`, undefined, results);
+        switch (this.database.engine) {
+            case ECommonsDatabaseEngine.MYSQL:
+                this.database.preprepare(`MODELS_FIRSTCLASS__${this.name}__DEFRAGMENT`, `
+							UPDATE ${this.model(this)}
+							SET ${this.modelField(this, this.idField)} = :newid
+							WHERE ${this.modelField(this, this.idField)} = :oldid
+							LIMIT 1
+						`, {
+                    newid: this.structure.id,
+                    oldid: this.structure.id
+                });
+                break;
+            case ECommonsDatabaseEngine.POSTGRES:
+            case ECommonsDatabaseEngine.SQLITE:
+                this.database.preprepare(`MODELS_FIRSTCLASS__${this.name}__DEFRAGMENT`, `
+							UPDATE ${this.model(this)}
+							SET ${this.database.delimit(this.idField)} = :newid
+							WHERE ${this.modelField(this, this.idField)} = :oldid
+						`, {
+                    newid: this.structure.id,
+                    oldid: this.structure.id
+                });
+                break;
+            default:
+                throw new Error('Database type is not supported');
+        }
+    }
+    //-------------------------------------------------------------------------
+    async internalFirstClassGetById(id) {
+        return await this.database.executeParamsSingle(`MODELS_FIRSTCLASS__${this.name}__GET_BY_ID`, {
+            id: id
+        });
+    }
+    async getById(id) {
+        CommonsModel.assertId(id);
+        return await this.internalFirstClassGetById(id);
+    }
+    async refresh(object) {
+        CommonsModel.assertIdObject(object, this.idField);
+        const refreshed = await this.internalFirstClassGetById(object.id);
+        if (refreshed === undefined)
+            throw new Error('Refreshed object no longer exists');
+        return refreshed;
+    }
+    async bulkGetByIds(ids, orderBy) {
+        if (ids.length === 0)
+            return [];
+        if (ids.length > 255) {
+            const slice = ids.slice(0, 255);
+            const remainder = ids.slice(255);
+            return [
+                ...(await this.bulkGetByIds(slice, orderBy)),
+                ...(await this.bulkGetByIds(remainder, orderBy))
+            ];
+        }
+        for (const id of ids)
+            CommonsModel.assertId(id);
+        const idsString = ids
+            .map((id) => id.toString())
+            .join(',');
+        const query = [
+            `SELECT ${this.fields}`,
+            `FROM ${this.model(this)}`,
+            `WHERE ${this.modelField(this, this.idField)} IN (${idsString})`
+        ];
+        if (orderBy) {
+            const orderByClauses = [];
+            for (const field of Object.keys(orderBy)) {
+                const direction = orderBy[field];
+                orderByClauses.push(`${this.modelField(this, field)} ${fromECommonsDatabaseOrderBy(direction)}`);
+            }
+            if (orderByClauses.length > 0)
+                query.push(`ORDER BY ${orderByClauses.join(',')}`);
+        }
+        return await this.database.queryParams(query.join(' '), undefined, this.structure);
+    }
+    //-------------------------------------------------------------------------
+    async searchIdsForNonencryptedFields(value, fields) {
+        if (fields.length === 0)
+            return [];
+        const conditions = [];
+        for (const field of fields) {
+            if (!commonsTypeHasPropertyObject(this.structure, field))
+                throw new Error(`Unknown field to perform non encrypted search on: ${field}`);
+            if (this.structure[field] instanceof CommonsDatabaseTypeEncrypted)
+                throw new Error(`Attempting to search on an encrypted field: ${field}`);
+            if (!(this.structure[field] instanceof CommonsDatabaseTypeString || this.structure[field] instanceof CommonsDatabaseTypeText))
+                throw new Error(`Attempting to search on a non-string/text field: ${field}`);
+            conditions.push(`${this.modelField(this, field)} LIKE :valuea`);
+            conditions.push(`${this.modelField(this, field)} LIKE :valueb`);
+            conditions.push(`${this.modelField(this, field)} LIKE :valuec`);
+            conditions.push(`${this.modelField(this, field)} LIKE :valued`);
+        }
+        return await this.database.queryParamsList(`
+					SELECT ${this.idField}
+					FROM ${this.model(this)}
+					WHERE ${conditions.join(' OR ')}
+				`, {
+            valuea: new CommonsDatabaseParam(value, new CommonsDatabaseTypeString(255, ECommonsDatabaseTypeNull.NOT_NULL)),
+            valueb: new CommonsDatabaseParam(`${value}%`, new CommonsDatabaseTypeString(255, ECommonsDatabaseTypeNull.NOT_NULL)),
+            valuec: new CommonsDatabaseParam(`%${value}`, new CommonsDatabaseTypeString(255, ECommonsDatabaseTypeNull.NOT_NULL)),
+            valued: new CommonsDatabaseParam(`%${value}%`, new CommonsDatabaseTypeString(255, ECommonsDatabaseTypeNull.NOT_NULL))
+        }, this.idField, this.structure.id);
+    }
+    async searchIdsForEncryptedFields(value, fields) {
+        if (fields.length === 0)
+            return [];
+        const resultTypes = {
+            id: this.structure.id
+        };
+        const fieldnames = [];
+        for (const field of fields) {
+            if (!commonsTypeHasPropertyObject(this.structure, field))
+                throw new Error(`Unknown field to perform non encrypted search on: ${field}`);
+            if (!(this.structure[field] instanceof CommonsDatabaseTypeEncrypted))
+                throw new Error(`Attempting to search on a non-encrypted field: ${field}`);
+            resultTypes[field] = this.structure[field];
+            fieldnames.push(this.modelField(this, field));
+        }
+        resultTypes.id = this.structure.id;
+        const allIds = await this.database.executeParamsList(`MODELS_FIRSTCLASS__${this.name}__LIST_ALL_IDS`);
+        if (allIds.length === 0)
+            return [];
+        const chunks = commonsArrayChunk(allIds, 500);
+        const matches = [];
+        for (const ids of chunks) {
+            if (ids.length === 0)
+                continue;
+            const result = await this.database.queryParams(`
+						SELECT ${this.modelField(this, this.idField)}, ${fieldnames.join(',')},
+						FROM ${this.model(this)}
+						WHERE ${this.modelField(this, this.idField)} IN (${ids.join(',')})
+					`, undefined, resultTypes);
+            for (const row of result) {
+                for (const field of fields) {
+                    if (!commonsTypeHasPropertyString(row, field))
+                        continue;
+                    const s = row[field];
+                    if (!s.toLowerCase().includes(value.toLowerCase()))
+                        continue;
+                    matches.push(row.id);
+                }
+            }
+        }
+        return commonsArrayUnique(matches);
+    }
+    async searchFields(value, fields, orderBy) {
+        const encrypted = [];
+        const regular = [];
+        for (const field of fields) {
+            if (!commonsTypeHasPropertyObject(this.structure, field))
+                throw new Error(`Unknown field to perform search on: ${field}`);
+            if (this.structure[field] instanceof CommonsDatabaseTypeEncrypted) {
+                encrypted.push(field);
+            }
+            else {
+                regular.push(field);
+            }
+        }
+        const ids = [
+            ...(await this.searchIdsForEncryptedFields(value, encrypted)),
+            ...(await this.searchIdsForNonencryptedFields(value, regular))
+        ];
+        return await this.bulkGetByIds(commonsArrayUnique(ids), orderBy);
+    }
+    //-------------------------------------------------------------------------
+    insert(_values) {
+        throw new Error('Do not call insert directly, use insertFirstClass instead');
+    }
+    async insertFirstClass(values) {
+        if (commonsTypeHasProperty(values, this.idField))
+            throw new Error('ID fields should not be specified explicitly for FirstClass models');
+        const params = commonsObjectMapObject(values, (value, field) => {
+            if (!commonsTypeHasProperty(this.structure, field))
+                throw new Error(`Parameter variable is missing in the model structure: ${field}`);
+            return new CommonsDatabaseParam(value, this.structure[field]);
+        });
+        const isTransactionOwner = await this.database.transactionClaim();
+        try {
+            const id = await this.database.insertRow(this.name, params, this.idField);
+            if (id === undefined)
+                throw new Error(`There was an error inserting the data into table: ${this.name}`);
+            CommonsModel.assertId(id);
+            const object = await this.internalFirstClassGetById(id);
+            if (object === undefined)
+                throw new Error('Data was not actually inserted into the table');
+            CommonsModel.assertIdObject(object, this.idField);
+            if (isTransactionOwner)
+                await this.database.transactionCommit();
+            return object;
+        }
+        catch (e) {
+            if (isTransactionOwner)
+                await this.database.transactionRollback();
+            console.error(e);
+            throw e;
+        }
+    }
+    async delete(object) {
+        CommonsModel.assertIdObject(object, this.idField);
+        const conditions = {
+            id: new CommonsDatabaseParam(object.id, this.structure.id)
+        };
+        await this.database.deleteRowsByConditions(this.name, conditions, true);
+    }
+    async update(object) {
+        CommonsModel.assertIdObject(object, this.idField);
+        const values = {};
+        for (const field of Object.keys(object)) {
+            if (field === this.idField)
+                continue;
+            if (!Object.keys(this.structure).includes(field))
+                throw new Error(`Parameter variable is missing in the model structure: ${field}`);
+            values[field] = new CommonsDatabaseParam(object[field], this.structure[field]);
+        }
+        const conditions = {
+            id: new CommonsDatabaseParam(object.id, this.structure.id)
+        };
+        await this.database.updateRowsByConditions(this.name, values, conditions, true);
+    }
+    //-------------------------------------------------------------------------
+    async defragment() {
+        // not implemented yet
+    }
+}
+//# sourceMappingURL=commons-first-class.mjs.map

package/dist/classes/commons-first-class.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"commons-first-class.mjs","sourceRoot":"","sources":["../../src/classes/commons-first-class.mts"],"names":[],"mappings":"AAAA,OAAO,EACL,sBAAsB,EACtB,4BAA4B,EAC5B,4BAA4B,EAC5B,sBAAsB,EACtB,iBAAiB,EACjB,kBAAkB,EAEnB,MAAM,oBAAoB,CAAC;AAG5B,OAAO,EAEL,oBAAoB,EACpB,4BAA4B,EAE5B,2BAA2B,EAC3B,yBAAyB,EACzB,uBAAuB,EAGvB,sBAAsB,EAEtB,wBAAwB,EACxB,2BAA2B,EAU5B,MAAM,0BAA0B,CAAC;AAIlC,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAmBnD,MAAM,OAAO,iBAKX,SAAQ,YAKT;IACA,YACE,QAAwD,EACxD,SAAiB,EACjB,SAAsB,EACtB,cAAwC,EAAE,EAC1C,aAAyC,EAAE,EAC3C,YAAuC,EAAE;QAE1C,KAAK,CACH,QAAQ,EACR,SAAS,EACT;YACE,GAAG,SAAS;YACZ,EAAE,EAAE,IAAI,2BAA2B,EAAE;SACtC,EACD,WAAW,EACX,UAAU,EACV,SAAS,CACV,CAAC;QAEF,oCAAoC;QACpC,IAAI,SAAS,CAAC,EAAE,KAAK,SAAS;YAAE,MAAM,IAAI,KAAK,CAAC,qGAAqG,CAAC,CAAC;IACxJ,CAAC;IAEM,MAAM,KAAK,OAAO;QACxB,OAAO,IAAI,CAAC;IACb,CAAC;IACD,IAAW,OAAO;QACjB,OAAO,iBAAiB,CAAC,OAAO,CAAC;IAClC,CAAC;IAED,2EAA2E;IAExD,UAAU;QAC5B,KAAK,CAAC,UAAU,EAAE,CAAC;QAEnB,IAAI,CAAC,QAAQ,CAAC,UAAU,CAItB,sBAAsB,IAAI,CAAC,IAAI,aAAa,EAC5C;cACU,IAAI,CAAC,MAAM;YACb,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;aACf,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC;KAC3C,EACD;YACE,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE;SACtB,EACD,IAAI,CAAC,SAAS,CACf,CAAC;QAEF,MAAM,OAAO,GAAmC;YAC9C,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE;SACtB,CAAC;QACF,IAAI,CAAC,QAAQ,CAAC,UAAU,CAItB,sBAAsB,IAAI,CAAC,IAAI,gBAAgB,EAC/C;cACU,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC;YACrC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;KACvB,EACD,SAAS,EACT,OAAO,CACR,CAAC;QAEF,QAAQ,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YAC9B,KAAK,sBAAsB,CAAC,KAAK;gBAChC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAOtB,sBAAsB,IAAI,CAAC,IAAI,cAAc,EAC7C;gBACU,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;aACnB,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC;eACjC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC;;OAE3C,EACD;oBACE,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE;oBACxB,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE;iBACzB,CACF,CAAC;gBACF,MAAM;YACP,KAAK,sBAAsB,CAAC,QAAQ,CAAC;YACrC,KAAK,sBAAsB,CAAC,MAAM;gBACjC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAOtB,sBAAsB,IAAI,CAAC,IAAI,cAAc,EAC7C;gBACU,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;aACnB,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC;eACjC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC;OAC3C,EACD;oBACE,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE;oBACxB,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE;iBACzB,CACF,CAAC;gBACF,MAAM;YACP;gBACC,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACpD,CAAC;IACF,CAAC;IAED,2EAA2E;IAEjE,KAAK,CAAC,yBAAyB,CAAC,EAAU;QACnD,OAAO,MAAM,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAQ5C,sBAAsB,IAAI,CAAC,IAAI,aAAa,EAC5C;YACE,EAAE,EAAE,EAAE;SACP,CACF,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,OAAO,CAAC,EAAU;QAC9B,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QAE1B,OAAO,MAAM,IAAI,CAAC,yBAAyB,CAAC,EAAE,CAAC,CAAC;IACjD,CAAC;IAEM,KAAK,CAAC,OAAO,CAAC,MAAuC;QAC3D,YAAY,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAElD,MAAM,SAAS,GAAqB,MAAM,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QACpF,IAAI,SAAS,KAAK,SAAS;YAAE,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QAElF,OAAO,SAAS,CAAC;IAClB,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,GAAa,EAAE,OAAwD;QAChG,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,EAAE,CAAC;QAChC,IAAI,GAAG,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;YACtB,MAAM,KAAK,GAAa,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;YAC1C,MAAM,SAAS,GAAa,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAE3C,OAAO;gBACL,GAAG,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;gBAC5C,GAAG,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;aACjD,CAAC;QACH,CAAC;QAED,KAAK,MAAM,EAAE,IAAI,GAAG;YAAE,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QAEhD,MAAM,SAAS,GAAG,GAAG;aAClB,GAAG,CAAC,CAAC,EAAU,EAAU,EAAE,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC;aAC1C,IAAI,CAAC,GAAG,CAAC,CAAC;QAEb,MAAM,KAAK,GAAa;YACtB,UAAU,IAAI,CAAC,MAAM,EAAE;YACvB,QAAQ,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;YAC1B,SAAS,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,SAAS,GAAG;SACjE,CAAC;QAEF,IAAI,OAAO,EAAE,CAAC;YACb,MAAM,cAAc,GAAa,EAAE,CAAC;YACpC,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC1C,MAAM,SAAS,GAA4B,OAAO,CAAC,KAAK,CAAC,CAAC;gBAC1D,cAAc,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,2BAA2B,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;YAClG,CAAC;YAED,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC;gBAAE,KAAK,CAAC,IAAI,CAAC,YAAY,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACnF,CAAC;QAED,OAAO,MAAM,IAAI,CAAC,QAAQ,CAAC,WAAW,CAOpC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EACf,SAAS,EACT,IAAI,CAAC,SAAS,CACf,CAAC;IACH,CAAC;IAED,2EAA2E;IAEpE,KAAK,CAAC,8BAA8B,CAAC,KAAa,EAAE,MAAgB;QAC1E,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,EAAE,CAAC;QAEnC,MAAM,UAAU,GAAa,EAAE,CAAC;QAChC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC5B,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC;gBAAE,MAAM,IAAI,KAAK,CAAC,qDAAqD,KAAK,EAAE,CAAC,CAAC;YACxI,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,YAAY,4BAA4B;gBAAE,MAAM,IAAI,KAAK,CAAC,+CAA+C,KAAK,EAAE,CAAC,CAAC;YAC3I,IAAI,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,YAAY,yBAAyB,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,YAAY,uBAAuB,CAAC;gBAAE,MAAM,IAAI,KAAK,CAAC,oDAAoD,KAAK,EAAE,CAAC,CAAC;YAE5M,UAAU,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;YAChE,UAAU,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;YAChE,UAAU,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;YAChE,UAAU,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;QACjE,CAAC;QAED,OAAO,MAAM,IAAI,CAAC,QAAQ,CAAC,eAAe,CAiBxC;cACU,IAAI,CAAC,OAAO;YACd,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;aACf,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC;KAC/B,EACD;YACE,MAAM,EAAE,IAAI,oBAAoB,CAAiB,KAAK,EAAE,IAAI,yBAAyB,CAAC,GAAG,EAAE,wBAAwB,CAAC,QAAQ,CAAC,CAAC;YAC9H,MAAM,EAAE,IAAI,oBAAoB,CAAiB,GAAG,KAAK,GAAG,EAAE,IAAI,yBAAyB,CAAC,GAAG,EAAE,wBAAwB,CAAC,QAAQ,CAAC,CAAC;YACpI,MAAM,EAAE,IAAI,oBAAoB,CAAiB,IAAI,KAAK,EAAE,EAAE,IAAI,yBAAyB,CAAC,GAAG,EAAE,wBAAwB,CAAC,QAAQ,CAAC,CAAC;YACpI,MAAM,EAAE,IAAI,oBAAoB,CAAiB,IAAI,KAAK,GAAG,EAAE,IAAI,yBAAyB,CAAC,GAAG,EAAE,wBAAwB,CAAC,QAAQ,CAAC,CAAC;SACtI,EACD,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,SAAS,CAAC,EAAE,CAClB,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,2BAA2B,CAAC,KAAa,EAAE,MAAgB;QACvE,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,EAAE,CAAC;QAEnC,MAAM,WAAW,GAAyD;YACxE,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE;SACtB,CAAC;QACF,MAAM,UAAU,GAAa,EAAE,CAAC;QAChC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC5B,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC;gBAAE,MAAM,IAAI,KAAK,CAAC,qDAAqD,KAAK,EAAE,CAAC,CAAC;YACxI,IAAI,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,YAAY,4BAA4B,CAAC;gBAAE,MAAM,IAAI,KAAK,CAAC,kDAAkD,KAAK,EAAE,CAAC,CAAC;YAEjJ,WAAW,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;YAC3C,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;QAC/C,CAAC;QAED,WAAW,CAAC,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;QAEnC,MAAM,MAAM,GAAa,MAAM,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAM5D,sBAAsB,IAAI,CAAC,IAAI,gBAAgB,CAAC,CAAC;QACnD,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,EAAE,CAAC;QAEnC,MAAM,MAAM,GAAe,iBAAiB,CAAS,MAAM,EAAE,GAAG,CAAC,CAAC;QAClE,MAAM,OAAO,GAAa,EAAE,CAAC;QAC7B,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;YAC1B,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC;gBAAE,SAAS;YAE/B,MAAM,MAAM,GAA6D,MAAM,IAAI,CAAC,QAAQ,CAAC,WAAW,CAOtG;eACU,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC;aAC9D,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;cACf,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC;MAChE,EACD,SAAS,EACT,WAAW,CACZ,CAAC;YAEF,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;gBAC1B,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;oBAC5B,IAAI,CAAC,4BAA4B,CAAC,GAAG,EAAE,KAAK,CAAC;wBAAE,SAAS;oBACxD,MAAM,CAAC,GAAW,GAAG,CAAC,KAAK,CAAW,CAAC;oBAEvC,IAAI,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;wBAAE,SAAS;oBAE7D,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;gBACtB,CAAC;YACF,CAAC;QACF,CAAC;QAED,OAAO,kBAAkB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,KAAa,EAAE,MAAgB,EAAE,OAAsD;QAChH,MAAM,SAAS,GAAa,EAAE,CAAC;QAC/B,MAAM,OAAO,GAAa,EAAE,CAAC;QAE7B,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC5B,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC;gBAAE,MAAM,IAAI,KAAK,CAAC,uCAAuC,KAAK,EAAE,CAAC,CAAC;YAE1H,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,YAAY,4BAA4B,EAAE,CAAC;gBACnE,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACvB,CAAC;iBAAM,CAAC;gBACP,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACrB,CAAC;QACF,CAAC;QAED,MAAM,GAAG,GAAa;YACpB,GAAG,CAAC,MAAM,IAAI,CAAC,2BAA2B,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;YAC7D,GAAG,CAAC,MAAM,IAAI,CAAC,8BAA8B,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;SAC/D,CAAC;QAEF,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAS,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED,2EAA2E;IAE3D,MAAM,CAAC,OAAwB;QAC9C,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAC;IAC9E,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,MAAqD;QAClF,IAAI,sBAAsB,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAC;QAExI,MAAM,MAAM,GAAiB,sBAAsB,CACjD,MAAM,EACN,CAAC,KAAc,EAAE,KAAa,EAA0C,EAAE;YACzE,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC;gBAAE,MAAM,IAAI,KAAK,CAAC,yDAAyD,KAAK,EAAE,CAAC,CAAC;YACtI,OAAO,IAAI,oBAAoB,CAAmB,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;QACjF,CAAC,CACc,CAAC;QAElB,MAAM,kBAAkB,GAAY,MAAM,IAAI,CAAC,QAAQ,CAAC,gBAAgB,EAAE,CAAC;QAE3E,IAAI,CAAC;YACJ,MAAM,EAAE,GAAgB,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,CAInD,IAAI,CAAC,IAAI,EACT,MAAM,EACN,IAAI,CAAC,OAAO,CACb,CAAC;YAEF,IAAI,EAAE,KAAK,SAAS;gBAAE,MAAM,IAAI,KAAK,CAAC,qDAAqD,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;YAExG,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YAE1B,MAAM,MAAM,GAAqB,MAAM,IAAI,CAAC,yBAAyB,CAAC,EAAE,CAAC,CAAC;YAC1E,IAAI,MAAM,KAAK,SAAS;gBAAE,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;YAE3F,YAAY,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;YAElD,IAAI,kBAAkB;gBAAE,MAAM,IAAI,CAAC,QAAQ,CAAC,iBAAiB,EAAE,CAAC;YAEhE,OAAO,MAAM,CAAC;QACf,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACZ,IAAI,kBAAkB;gBAAE,MAAM,IAAI,CAAC,QAAQ,CAAC,mBAAmB,EAAE,CAAC;YAClE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAEjB,MAAM,CAAC,CAAC;QACT,CAAC;IACF,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,MAAc;QACjC,YAAY,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAElD,MAAM,UAAU,GAAoC;YAClD,EAAE,EAAE,IAAI,oBAAoB,CAAiB,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;SAC3E,CAAC;QAEF,MAAM,IAAI,CAAC,QAAQ,CAAC,sBAAsB,CAGxC,IAAI,CAAC,IAAI,EACT,UAAU,EACV,IAAI,CACL,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,MAAyD;QAC5E,YAAY,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAElD,MAAM,MAAM,GAA2B,EAAE,CAAC;QAE1C,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YACzC,IAAI,KAAK,KAAK,IAAI,CAAC,OAAO;gBAAE,SAAS;YAErC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC;gBAAE,MAAM,IAAI,KAAK,CAAC,yDAAyD,KAAK,EAAE,CAAC,CAAC;YACpI,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,oBAAoB,CAAmB,MAAM,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;QAClG,CAAC;QAED,MAAM,UAAU,GAAoC;YAClD,EAAE,EAAE,IAAI,oBAAoB,CAAiB,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;SAC3E,CAAC;QAEF,MAAM,IAAI,CAAC,QAAQ,CAAC,sBAAsB,CAIxC,IAAI,CAAC,IAAI,EACT,MAAM,EACN,UAAU,EACV,IAAI,CACL,CAAC;IACH,CAAC;IAED,2EAA2E;IAEpE,KAAK,CAAC,UAAU;QACtB,sBAAsB;IACvB,CAAC;CACD"}

package/dist/classes/commons-hierarchy.d.mts

@@ -0,0 +1,41 @@
+import { TPropertyObject } from 'tscommons-esm-core';
+import { ICommonsHierarchy, ICommonsFirstClass, ICommonsOrderable, ECommonsMoveDirection } from 'tscommons-esm-models';
+import { CommonsDatabaseParam, CommonsDatabaseTypeId, TCommonsDatabaseParams, TCommonsDatabaseTypes, TCommonsDatabaseDbValues, CommonsSqlDatabaseService, ICommonsCredentials, CommonsDatabaseUniqueKey, CommonsDatabaseIndexKey } from 'nodecommons-esm-database';
+import { TCommonsModelForeignKeys } from '../types/tcommons-model-foreign-keys.mjs';
+import { CommonsFirstClass, TInternalFirstClassExcludeId } from './commons-first-class.mjs';
+import { CommonsSecondClass } from './commons-second-class.mjs';
+import { TInternalOrderedExcludeId, TInternalOrderedModelDbValues, TInternalOrderedModelParams, TInternalOrderedModelTypes } from './commons-ordered.mjs';
+type TInternalHierarchyModelParamParent = {
+    parent: CommonsDatabaseParam<number, number>;
+};
+type TInternalHierarchyModelTypeParent = {
+    parent: CommonsDatabaseTypeId;
+};
+type TInternalHierarchyModelValueParent = Pick<ICommonsHierarchy<any>, 'parent'>;
+type TInternalHierarchyModelDbValueParent = TInternalHierarchyModelValueParent;
+export type TInternalHierarchyExcludeId<T extends TPropertyObject> = Omit<T, 'parent'> & {
+    parent?: never;
+};
+type TInternalHierarchyModelParams<ModelParamsT extends TCommonsDatabaseParams> = Omit<ModelParamsT, 'ordered' | 'parent'> & TInternalHierarchyModelParamParent;
+type TInternalHierarchyModelTypes<ModelTypesT extends TCommonsDatabaseTypes> = Omit<ModelTypesT, 'ordered' | 'parent'> & TInternalHierarchyModelTypeParent;
+type TInternalHierarchyModelDbValues<ModelDbValuesT extends TCommonsDatabaseDbValues> = Omit<ModelDbValuesT, 'ordered' | 'parent'> & TInternalHierarchyModelDbValueParent;
+export declare class CommonsHierarchy<ModelI extends ICommonsHierarchy<FirstClassI>, ModelParamsT extends TInternalFirstClassExcludeId<TInternalOrderedExcludeId<TInternalHierarchyExcludeId<TCommonsDatabaseParams>>>, ModelTypesT extends TInternalFirstClassExcludeId<TInternalOrderedExcludeId<TInternalHierarchyExcludeId<TCommonsDatabaseTypes>>>, ModelDbValuesT extends TInternalFirstClassExcludeId<TInternalOrderedExcludeId<TInternalHierarchyExcludeId<TCommonsDatabaseDbValues>>>, FirstClassI extends ICommonsFirstClass, FirstClassClassT extends CommonsFirstClass<FirstClassI, TCommonsDatabaseParams, TCommonsDatabaseTypes, TCommonsDatabaseDbValues>> extends CommonsSecondClass<ModelI, TInternalOrderedModelParams<TInternalHierarchyModelParams<ModelParamsT>>, TInternalOrderedModelTypes<TInternalHierarchyModelTypes<ModelTypesT>>, TInternalOrderedModelDbValues<TInternalHierarchyModelDbValues<ModelDbValuesT>>, FirstClassI, FirstClassClassT> implements ICommonsOrderable {
+    constructor(database: CommonsSqlDatabaseService<ICommonsCredentials>, tableName: string, structure: ModelTypesT, firstClass: FirstClassClassT, firstClassField: string, foreignKeys?: TCommonsModelForeignKeys, uniqueKeys?: CommonsDatabaseUniqueKey[], indexKeys?: CommonsDatabaseIndexKey[]);
+    static get orderedField(): string;
+    get orderedField(): string;
+    static get parentField(): string;
+    get parentField(): string;
+    protected defineViews(): void;
+    protected preprepare(): void;
+    getRootByFirstClass(firstClassObject: FirstClassI): Promise<ModelI | undefined>;
+    listChildrenOrderedByFirstClass(firstClassObject: FirstClassI, parent: ModelI): Promise<ModelI[]>;
+    move(object: ModelI, direction: ECommonsMoveDirection): Promise<ModelI>;
+    jump(object: ModelI, destination: FirstClassI): Promise<ModelI>;
+    insertForFirstClass(_firstClassObject: FirstClassI, _values: TInternalOrderedExcludeId<TInternalFirstClassExcludeId<Partial<ModelI>>>): Promise<ModelI>;
+    insertRootForFirstClass(firstClassObject: FirstClassI, values: TInternalHierarchyExcludeId<TInternalOrderedExcludeId<TInternalFirstClassExcludeId<Partial<ModelI>>>>): Promise<ModelI>;
+    insertForFirstClassAndParent(firstClassObject: FirstClassI, parent: ModelI, values: TInternalHierarchyExcludeId<TInternalOrderedExcludeId<TInternalFirstClassExcludeId<Partial<ModelI>>>>): Promise<ModelI>;
+    deleteForFirstClass(_firstClassObject: FirstClassI, _object: ModelI): Promise<void>;
+    deleteRootForFirstClass(firstClassObject: FirstClassI, object: ModelI): Promise<void>;
+    deleteForFirstClassAndParent(firstClassObject: FirstClassI, parent: ModelI, object: ModelI): Promise<void>;
+}
+export {};