@spinajs/orm 1.2.26 → 1.2.33

package/lib/orm/src/interfaces.js

@@ -0,0 +1,186 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SetValueConverter = exports.DatetimeValueConverter = exports.ValueConverter = exports.GroupByQueryCompiler = exports.OrderByQueryCompiler = exports.ColumnQueryCompiler = exports.TableQueryCompiler = exports.OnDuplicateQueryCompiler = exports.InsertQueryCompiler = exports.UpdateQueryCompiler = exports.DeleteQueryCompiler = exports.ForeignKeyQueryCompiler = exports.IndexQueryCompiler = exports.JoinQueryCompiler = exports.SelectQueryCompiler = exports.RecursiveQueryCompiler = exports.OrmMigration = exports.RelationType = exports.MigrationTransactionMode = exports.ReferentialAction = exports.InsertBehaviour = exports.QueryContext = void 0;
+const di_1 = require("@spinajs/di");
+const exceptions_1 = require("@spinajs/exceptions");
+var QueryContext;
+(function (QueryContext) {
+    QueryContext[QueryContext["Insert"] = 0] = "Insert";
+    QueryContext[QueryContext["Select"] = 1] = "Select";
+    QueryContext[QueryContext["Update"] = 2] = "Update";
+    QueryContext[QueryContext["Delete"] = 3] = "Delete";
+    QueryContext[QueryContext["Schema"] = 4] = "Schema";
+    QueryContext[QueryContext["Transaction"] = 5] = "Transaction";
+})(QueryContext = exports.QueryContext || (exports.QueryContext = {}));
+var InsertBehaviour;
+(function (InsertBehaviour) {
+    /**
+     * On duplicate entry ignore & fetch only model primary key
+     */
+    InsertBehaviour[InsertBehaviour["OnDuplicateIgnore"] = 0] = "OnDuplicateIgnore";
+    /**
+     * On duplicate update entry ( when unique constraint is hit update db from model data)
+     */
+    InsertBehaviour[InsertBehaviour["OnDuplicateUpdate"] = 1] = "OnDuplicateUpdate";
+    /**
+     * Throw error if model hits constraint ( primary or unique keys )
+     */
+    InsertBehaviour[InsertBehaviour["None"] = 2] = "None";
+})(InsertBehaviour = exports.InsertBehaviour || (exports.InsertBehaviour = {}));
+/**
+ * Foreign key referential actions
+ */
+var ReferentialAction;
+(function (ReferentialAction) {
+    ReferentialAction["Cascade"] = "CASCADE";
+    ReferentialAction["SetNull"] = "SET NULL";
+    ReferentialAction["Restrict"] = "RESTRICT";
+    ReferentialAction["NoAction"] = "NO ACTION";
+    ReferentialAction["SetDefault"] = "SET DEFAULT";
+})(ReferentialAction = exports.ReferentialAction || (exports.ReferentialAction = {}));
+/**
+ * Transaction mode when migration DB
+ */
+var MigrationTransactionMode;
+(function (MigrationTransactionMode) {
+    /**
+     * Migration is run whithout transaction
+     */
+    MigrationTransactionMode[MigrationTransactionMode["None"] = 0] = "None";
+    /**
+     * On transaction for one migration - every migration has its own
+     */
+    MigrationTransactionMode[MigrationTransactionMode["PerMigration"] = 1] = "PerMigration";
+})(MigrationTransactionMode = exports.MigrationTransactionMode || (exports.MigrationTransactionMode = {}));
+var RelationType;
+(function (RelationType) {
+    RelationType[RelationType["One"] = 0] = "One";
+    RelationType[RelationType["Many"] = 1] = "Many";
+    RelationType[RelationType["ManyToMany"] = 2] = "ManyToMany";
+})(RelationType = exports.RelationType || (exports.RelationType = {}));
+let OrmMigration = class OrmMigration {
+};
+OrmMigration = __decorate([
+    (0, di_1.NewInstance)()
+], OrmMigration);
+exports.OrmMigration = OrmMigration;
+/**
+ *  Definitions of query compiler are needed for DI resolving
+ * ==========================================================
+ */
+let RecursiveQueryCompiler = class RecursiveQueryCompiler {
+};
+RecursiveQueryCompiler = __decorate([
+    (0, di_1.NewInstance)()
+], RecursiveQueryCompiler);
+exports.RecursiveQueryCompiler = RecursiveQueryCompiler;
+let SelectQueryCompiler = class SelectQueryCompiler {
+};
+SelectQueryCompiler = __decorate([
+    (0, di_1.NewInstance)()
+], SelectQueryCompiler);
+exports.SelectQueryCompiler = SelectQueryCompiler;
+let JoinQueryCompiler = class JoinQueryCompiler {
+};
+JoinQueryCompiler = __decorate([
+    (0, di_1.NewInstance)()
+], JoinQueryCompiler);
+exports.JoinQueryCompiler = JoinQueryCompiler;
+let IndexQueryCompiler = class IndexQueryCompiler {
+};
+IndexQueryCompiler = __decorate([
+    (0, di_1.NewInstance)()
+], IndexQueryCompiler);
+exports.IndexQueryCompiler = IndexQueryCompiler;
+let ForeignKeyQueryCompiler = class ForeignKeyQueryCompiler {
+};
+ForeignKeyQueryCompiler = __decorate([
+    (0, di_1.NewInstance)()
+], ForeignKeyQueryCompiler);
+exports.ForeignKeyQueryCompiler = ForeignKeyQueryCompiler;
+let DeleteQueryCompiler = class DeleteQueryCompiler {
+};
+DeleteQueryCompiler = __decorate([
+    (0, di_1.NewInstance)()
+], DeleteQueryCompiler);
+exports.DeleteQueryCompiler = DeleteQueryCompiler;
+let UpdateQueryCompiler = class UpdateQueryCompiler {
+};
+UpdateQueryCompiler = __decorate([
+    (0, di_1.NewInstance)()
+], UpdateQueryCompiler);
+exports.UpdateQueryCompiler = UpdateQueryCompiler;
+let InsertQueryCompiler = class InsertQueryCompiler {
+};
+InsertQueryCompiler = __decorate([
+    (0, di_1.NewInstance)()
+], InsertQueryCompiler);
+exports.InsertQueryCompiler = InsertQueryCompiler;
+let OnDuplicateQueryCompiler = class OnDuplicateQueryCompiler {
+};
+OnDuplicateQueryCompiler = __decorate([
+    (0, di_1.NewInstance)()
+], OnDuplicateQueryCompiler);
+exports.OnDuplicateQueryCompiler = OnDuplicateQueryCompiler;
+let TableQueryCompiler = class TableQueryCompiler {
+};
+TableQueryCompiler = __decorate([
+    (0, di_1.NewInstance)()
+], TableQueryCompiler);
+exports.TableQueryCompiler = TableQueryCompiler;
+let ColumnQueryCompiler = class ColumnQueryCompiler {
+};
+ColumnQueryCompiler = __decorate([
+    (0, di_1.NewInstance)()
+], ColumnQueryCompiler);
+exports.ColumnQueryCompiler = ColumnQueryCompiler;
+let OrderByQueryCompiler = class OrderByQueryCompiler {
+};
+OrderByQueryCompiler = __decorate([
+    (0, di_1.NewInstance)()
+], OrderByQueryCompiler);
+exports.OrderByQueryCompiler = OrderByQueryCompiler;
+let GroupByQueryCompiler = class GroupByQueryCompiler {
+};
+GroupByQueryCompiler = __decorate([
+    (0, di_1.NewInstance)()
+], GroupByQueryCompiler);
+exports.GroupByQueryCompiler = GroupByQueryCompiler;
+class ValueConverter {
+    /**
+     * Converts value to database type
+     *
+     * @param value - value to convert
+     */
+    toDB(_value) {
+        throw new exceptions_1.MethodNotImplemented();
+    }
+    /**
+     * Converts value from database type eg. mysql timestamp to DateTime
+     *
+     * @param value - value to convert
+     */
+    fromDB(_value) {
+        throw new exceptions_1.MethodNotImplemented();
+    }
+}
+exports.ValueConverter = ValueConverter;
+/**
+ * Converter for DATETIME field (eg. mysql datetime)
+ */
+class DatetimeValueConverter extends ValueConverter {
+}
+exports.DatetimeValueConverter = DatetimeValueConverter;
+/**
+ * Converter for set field (eg. mysql SET)
+ */
+class SetValueConverter extends ValueConverter {
+}
+exports.SetValueConverter = SetValueConverter;
+//# sourceMappingURL=interfaces.js.map

package/lib/orm/src/interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../../src/interfaces.ts"],"names":[],"mappings":";;;;;;;;;AAMA,oCAAuD;AAEvD,oDAA2D;AAE3D,IAAY,YAOX;AAPD,WAAY,YAAY;IACtB,mDAAM,CAAA;IACN,mDAAM,CAAA;IACN,mDAAM,CAAA;IACN,mDAAM,CAAA;IACN,mDAAM,CAAA;IACN,6DAAW,CAAA;AACb,CAAC,EAPW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAOvB;AAED,IAAY,eAeX;AAfD,WAAY,eAAe;IACzB;;OAEG;IACH,+EAAiB,CAAA;IAEjB;;OAEG;IACH,+EAAiB,CAAA;IAEjB;;OAEG;IACH,qDAAI,CAAA;AACN,CAAC,EAfW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAe1B;AAED;;GAEG;AACH,IAAY,iBAMX;AAND,WAAY,iBAAiB;IAC3B,wCAAmB,CAAA;IACnB,yCAAoB,CAAA;IACpB,0CAAqB,CAAA;IACrB,2CAAsB,CAAA;IACtB,+CAA0B,CAAA;AAC5B,CAAC,EANW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAM5B;AAED;;GAEG;AACH,IAAY,wBAUX;AAVD,WAAY,wBAAwB;IAClC;;OAEG;IACH,uEAAI,CAAA;IAEJ;;OAEG;IACH,uFAAY,CAAA;AACd,CAAC,EAVW,wBAAwB,GAAxB,gCAAwB,KAAxB,gCAAwB,QAUnC;AA6KD,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,6CAAG,CAAA;IACH,+CAAI,CAAA;IACJ,2DAAU,CAAA;AACZ,CAAC,EAJW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAIvB;AAqLD,IAAsB,YAAY,GAAlC,MAAsB,YAAY;CAajC,CAAA;AAbqB,YAAY;IADjC,IAAA,gBAAW,GAAE;GACQ,YAAY,CAajC;AAbqB,oCAAY;AAgOlC;;;GAGG;AAEH,IAAsB,sBAAsB,GAA5C,MAAsB,sBAAsB;CAE3C,CAAA;AAFqB,sBAAsB;IAD3C,IAAA,gBAAW,GAAE;GACQ,sBAAsB,CAE3C;AAFqB,wDAAsB;AAI5C,IAAsB,mBAAmB,GAAzC,MAAsB,mBAAmB;CAExC,CAAA;AAFqB,mBAAmB;IADxC,IAAA,gBAAW,GAAE;GACQ,mBAAmB,CAExC;AAFqB,kDAAmB;AAKzC,IAAsB,iBAAiB,GAAvC,MAAsB,iBAAiB;CAEtC,CAAA;AAFqB,iBAAiB;IADtC,IAAA,gBAAW,GAAE;GACQ,iBAAiB,CAEtC;AAFqB,8CAAiB;AAKvC,IAAsB,kBAAkB,GAAxC,MAAsB,kBAAkB;CAEvC,CAAA;AAFqB,kBAAkB;IADvC,IAAA,gBAAW,GAAE;GACQ,kBAAkB,CAEvC;AAFqB,gDAAkB;AAKxC,IAAsB,uBAAuB,GAA7C,MAAsB,uBAAuB;CAE5C,CAAA;AAFqB,uBAAuB;IAD5C,IAAA,gBAAW,GAAE;GACQ,uBAAuB,CAE5C;AAFqB,0DAAuB;AAK7C,IAAsB,mBAAmB,GAAzC,MAAsB,mBAAmB;CAExC,CAAA;AAFqB,mBAAmB;IADxC,IAAA,gBAAW,GAAE;GACQ,mBAAmB,CAExC;AAFqB,kDAAmB;AAKzC,IAAsB,mBAAmB,GAAzC,MAAsB,mBAAmB;CAExC,CAAA;AAFqB,mBAAmB;IADxC,IAAA,gBAAW,GAAE;GACQ,mBAAmB,CAExC;AAFqB,kDAAmB;AAKzC,IAAsB,mBAAmB,GAAzC,MAAsB,mBAAmB;CAExC,CAAA;AAFqB,mBAAmB;IADxC,IAAA,gBAAW,GAAE;GACQ,mBAAmB,CAExC;AAFqB,kDAAmB;AAKzC,IAAsB,wBAAwB,GAA9C,MAAsB,wBAAwB;CAE7C,CAAA;AAFqB,wBAAwB;IAD7C,IAAA,gBAAW,GAAE;GACQ,wBAAwB,CAE7C;AAFqB,4DAAwB;AAK9C,IAAsB,kBAAkB,GAAxC,MAAsB,kBAAkB;CAEvC,CAAA;AAFqB,kBAAkB;IADvC,IAAA,gBAAW,GAAE;GACQ,kBAAkB,CAEvC;AAFqB,gDAAkB;AAKxC,IAAsB,mBAAmB,GAAzC,MAAsB,mBAAmB;CAExC,CAAA;AAFqB,mBAAmB;IADxC,IAAA,gBAAW,GAAE;GACQ,mBAAmB,CAExC;AAFqB,kDAAmB;AAKzC,IAAsB,oBAAoB,GAA1C,MAAsB,oBAAoB;CAEzC,CAAA;AAFqB,oBAAoB;IADzC,IAAA,gBAAW,GAAE;GACQ,oBAAoB,CAEzC;AAFqB,oDAAoB;AAK1C,IAAsB,oBAAoB,GAA1C,MAAsB,oBAAoB;CAEzC,CAAA;AAFqB,oBAAoB;IADzC,IAAA,gBAAW,GAAE;GACQ,oBAAoB,CAEzC;AAFqB,oDAAoB;AAsC1C,MAAa,cAAc;IACzB;;;;OAIG;IACI,IAAI,CAAC,MAAW;QACrB,MAAM,IAAI,iCAAoB,EAAE,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,MAAW;QACvB,MAAM,IAAI,iCAAoB,EAAE,CAAC;IACnC,CAAC;CACF;AAlBD,wCAkBC;AAED;;GAEG;AACH,MAAa,sBAAuB,SAAQ,cAAc;CAAG;AAA7D,wDAA6D;AAE7D;;GAEG;AACH,MAAa,iBAAkB,SAAQ,cAAc;CAAG;AAAxD,8CAAwD"}

package/lib/orm/src/model.d.ts

@@ -0,0 +1,135 @@
+import { IModelDescrtiptor, InsertBehaviour } from './interfaces';
+import { WhereFunction } from './types';
+import { RawQuery, UpdateQueryBuilder, SelectQueryBuilder, InsertQueryBuilder } from './builders';
+import { WhereOperators } from './enums';
+export declare function extractModelDescriptor(targetOrForward: any): IModelDescrtiptor;
+export declare class ModelBase {
+    /**
+     * Gets descriptor for this model. It contains information about relations, orm driver, connection properties,
+     * db table attached, column information and others.
+     */
+    get ModelDescriptor(): IModelDescrtiptor;
+    get PrimaryKeyName(): string;
+    get PrimaryKeyValue(): any;
+    set PrimaryKeyValue(newVal: any);
+    /**
+     * Get all data from db
+     */
+    static all<T extends typeof ModelBase>(this: T, _page?: number, _perPage?: number): SelectQueryBuilder<Array<InstanceType<T>>>;
+    /**
+     * Inserts data to DB.
+     *
+     * @param _data - data to insert
+     */
+    static insert<T extends typeof ModelBase>(this: T, _data: InstanceType<T> | Partial<InstanceType<T>> | Array<InstanceType<T>> | Array<Partial<InstanceType<T>>>): Promise<void>;
+    /**
+     * Search entities in db
+     *
+     * @param column - column to search or function
+     * @param operator - boolean operator
+     * @param value - value to compare
+     */
+    static where<T extends typeof ModelBase>(this: T, _column: string | boolean | WhereFunction | RawQuery | object, _operator?: WhereOperators | any, _value?: any): SelectQueryBuilder<Array<InstanceType<T>>>;
+    /**
+     * Updates single or multiple records at once with provided value based on condition
+     *
+     * @param _data - data to set
+     */
+    static update<T extends typeof ModelBase>(this: T, _data: Partial<InstanceType<T>>): UpdateQueryBuilder;
+    /**
+     * Tries to find all models with given primary keys
+     */
+    static find<T extends typeof ModelBase>(this: T, _pks: any[]): Promise<Array<InstanceType<T>>>;
+    /**
+     * Tries to find all models in db. If not all exists, throws exception
+     */
+    static findOrFail<T extends typeof ModelBase>(this: T, _pks: any[]): Promise<Array<InstanceType<T>>>;
+    /**
+     * gets model by specified pk, if not exists, returns null
+     *
+     */
+    static get<T extends typeof ModelBase>(this: T, _pk: any): Promise<Array<InstanceType<T>>>;
+    /**
+     * Finds model by specified pk. If model not exists in db throws exception
+     *
+     */
+    static getOrFail<T extends typeof ModelBase>(this: T, _pk: any): Promise<Array<InstanceType<T>>>;
+    /**
+     *
+     * Checks if model with pk key or unique fields exists and if not creates one AND NOT save in db
+     * NOTE: it checks for unique fields constraint
+     */
+    static getOrNew<T extends typeof ModelBase>(this: T, _pk?: any, _data?: Partial<InstanceType<T>>): Promise<InstanceType<T>>;
+    /**
+     * Creates raw query on this model. used for quering db for partial data or to perform some kind of operations
+     * that dont need full ORM model to involve
+     */
+    static query<T>(this: T): SelectQueryBuilder<T>;
+    /**
+     *
+     * Checks if model with pk key / unique fields exists and if not creates one and saves to db
+     * NOTE: it checks for unique fields too.
+     *
+     * @param data - model width data to check
+     */
+    static getOrCreate<T extends typeof ModelBase>(this: T, _pk: any, _data?: Partial<InstanceType<T>>): Promise<InstanceType<T>>;
+    /**
+     * Creates new model & saves is to db
+     *
+     * @param  data - initial model data
+     */
+    static create<T extends typeof ModelBase>(this: T, _data: Partial<InstanceType<T>>): Promise<InstanceType<T>>;
+    /**
+     * Deletes model from db
+     *
+     * @param pk - primary key
+     */
+    static destroy(_pk?: any | any[]): Promise<void>;
+    constructor(data?: any);
+    /**
+     * Fills model with data. It only fills properties that exists in database
+     *
+     * @param data - data to fill
+     */
+    hydrate(data: Partial<this>): void;
+    /**
+     * Extracts all data from model. It takes only properties that exists in DB
+     */
+    dehydrate(): Partial<this>;
+    /**
+     * deletes enitt from db. If model have SoftDelete decorator, model is marked as deleted
+     */
+    destroy(): Promise<void>;
+    update(): Promise<void>;
+    /**
+     * Save all changes to db. It creates new entry id db or updates existing one if
+     * primary key exists
+     */
+    insert(insertBehaviour?: InsertBehaviour): Promise<void>;
+    /**
+     * Gets model data from database and returns as fresh instance.
+     */
+    fresh(): Promise<this>;
+    /**
+     * sets default values for model. values are taken from DB default column prop
+     */
+    protected setDefaults(): void;
+}
+export declare const MODEL_STATIC_MIXINS: {
+    query(): SelectQueryBuilder;
+    where(column: string | boolean | WhereFunction | RawQuery | {}, operator?: WhereOperators | any, value?: any): SelectQueryBuilder;
+    update<T extends typeof ModelBase>(data: Partial<InstanceType<T>>): UpdateQueryBuilder;
+    all(page: number, perPage: number): SelectQueryBuilder;
+    /**
+     * Try to insert new value
+     */
+    insert<T_1 extends typeof ModelBase>(this: T_1, data: InstanceType<T_1> | Partial<InstanceType<T_1>> | InstanceType<T_1>[] | Partial<InstanceType<T_1>>[]): InsertQueryBuilder;
+    find<T_2 extends typeof ModelBase>(this: T_2, pks: any[]): Promise<InstanceType<T_2>[]>;
+    findOrFail<T_3 extends typeof ModelBase>(this: T_3, pks: any[]): Promise<InstanceType<T_3>[]>;
+    get<T_4 extends typeof ModelBase>(this: T_4, pk: any): Promise<InstanceType<T_4>>;
+    getOrFail<T_5 extends typeof ModelBase>(this: T_5, pk: any): Promise<InstanceType<T_5>>;
+    destroy(pks: any | any[]): Promise<void>;
+    create<T_6 extends typeof ModelBase>(this: T_6, data: Partial<InstanceType<T_6>>): Promise<InstanceType<T_6>>;
+    getOrCreate<T_7 extends typeof ModelBase>(this: T_7, pk: any, data: Partial<InstanceType<T_7>>): Promise<InstanceType<T_7>>;
+    getOrNew<T_8 extends typeof ModelBase>(this: T_8, pk: any, data?: Partial<InstanceType<T_8>>): Promise<InstanceType<T_8>>;
+};