@warlock.js/cascade 1.0.0

package/esm/model/model.d.ts

@@ -0,0 +1,323 @@
+import { ObjectId } from "mongodb";
+import { RelationshipModel } from "./relationships";
+import { CastType, Casts, CustomCasts, Document } from "./types";
+export type Schema<ModelSchema = Document> = ModelSchema & {
+    _id?: ObjectId;
+    id?: number;
+    createdAt?: Date;
+    updatedAt?: Date;
+};
+type ModelSchema = Schema;
+type ModelDocument = Document;
+export declare class Model extends RelationshipModel {
+    /**
+     * Model Initial Document data
+     */
+    initialData: Partial<ModelSchema>;
+    /**
+     * Model Document data
+     */
+    data: ModelSchema;
+    /**
+     * Define Default value data that will be merged with the models' data
+     * on the create process
+     */
+    defaultValue: Partial<ModelSchema>;
+    /**
+     * A flag to determine if the model is being restored
+     */
+    protected isRestored: boolean;
+    /**
+     * Model casts types
+     */
+    protected casts: Casts;
+    /**
+     * Set custom casts that will be used to cast the model's data are not related to the current value of the collection's column
+     *
+     * For example: `name` is not a column in the given data, but it will be concatenation of `firstName` and `lastName`
+     */
+    protected customCasts: CustomCasts<string>;
+    /**
+     * Guarded fields
+     */
+    guarded: (keyof ModelDocument)[];
+    /**
+     * Fillable fields
+     */
+    filled: (keyof ModelDocument)[];
+    /**
+     * Embedded columns
+     */
+    embedded: (keyof ModelSchema)[];
+    /**
+     * Embed all columns except the given columns
+     */
+    embedAllExcept: (keyof ModelDocument)[];
+    /**
+     * Embed all columns except timestamps and created|updated|deleted by columns
+     */
+    embedAllExceptTimestampsAndUserColumns: boolean;
+    /**
+     * Created at column
+     */
+    createdAtColumn: string;
+    /**
+     * Updated at column
+     */
+    updatedAtColumn: string;
+    /**
+     * Deleted at column
+     */
+    deletedAtColumn: string;
+    /**
+     * Created by column
+     */
+    createdByColumn: string;
+    /**
+     * Updated by column
+     */
+    updatedByColumn: string;
+    /**
+     * Deleted by column
+     */
+    deletedByColumn: string;
+    /**
+     * Date format
+     */
+    dateFormat: string;
+    /**
+     * A flag to determine if the id is auto generated not added manually
+     */
+    protected autoGeneratedId: boolean;
+    /**
+     * Is active column
+     */
+    protected isActiveColumn: string;
+    /**
+     * Original data
+     */
+    originalData: ModelSchema;
+    /**
+     * Constructor
+     */
+    constructor(originalData?: Partial<ModelSchema>);
+    /**
+     * Get save columns which are the casts keys
+     */
+    get castColumns(): string[];
+    /**
+     * Get value from original data
+     */
+    original(key: string, defaultValue?: any): any;
+    /**
+     * Get all data except the guarded fields
+     */
+    get publicData(): any;
+    /**
+     * Get guarded data
+     */
+    get guardedData(): any;
+    /**
+     * Get the model's id
+     */
+    get id(): number;
+    /**
+     * Check if current user is active
+     */
+    get isActive(): boolean;
+    /**
+     * Get mongodb id
+     */
+    get _id(): ObjectId;
+    /**
+     * Mark the current model as being restored
+     */
+    markAsRestored(): void;
+    /**
+     * Set a column in the model data
+     */
+    set(column: keyof ModelSchema, value: any): this;
+    /**
+     * Increment the given column by the given value
+     */
+    increment(column: keyof ModelSchema, value?: number): this;
+    /**
+     * Decrement the given column by the given value
+     */
+    decrement(column: keyof ModelSchema, value?: number): this;
+    /**
+     * Get initial value of the given column
+     */
+    getInitial(column: keyof ModelSchema, defaultValue?: any): any;
+    /**
+     * Get value of the given column
+     */
+    get<ValueType = any>(column: keyof ModelSchema, defaultValue?: any): ValueType;
+    /**
+     * Return the value of the given column as a string
+     */
+    string(column: keyof ModelSchema, defaultValue?: any): string;
+    /**
+     * Return the value of the given column as an integer
+     */
+    int(column: keyof ModelSchema, defaultValue?: any): number;
+    /**
+     * Return the value of the given column as a float
+     */
+    float(column: keyof ModelSchema, defaultValue?: any): number;
+    /**
+     * Return the value of the given column as a number
+     */
+    number(column: keyof ModelSchema, defaultValue?: any): number;
+    /**
+     * Return the value of the given column as a boolean
+     */
+    bool(column: keyof ModelSchema, defaultValue?: any): boolean;
+    /**
+     * Determine whether the given column exists in the document
+     */
+    has(column: keyof ModelSchema): boolean;
+    /**
+     * Get all columns except the given ones
+     */
+    except(columns: (keyof ModelSchema)[]): Document;
+    /**
+     * Get only the given columns
+     */
+    only(columns: (keyof ModelSchema)[]): Document;
+    /**
+     * Get only id
+     */
+    get onlyId(): Document;
+    /**
+     * Unset or remove the given columns from the data
+     */
+    unset(...columns: (keyof ModelSchema)[]): this;
+    /**
+     * Replace the entire document data with the given new data
+     */
+    replaceWith(data: ModelSchema): this;
+    /**
+     * Merge the given documents to current document
+     */
+    merge(data: Document): this;
+    /**
+     * Push the given values to the given column
+     * If the given column does not exists, it will be created
+     * If the given value exists but not an array it will be ignored
+     */
+    push(column: keyof ModelSchema, ...values: any[]): this;
+    /**
+     * Push the given values to the given column only if not exists
+     */
+    pushOnce(column: keyof ModelSchema, ...values: any[]): this;
+    /**
+     * Add the given values to the beginning of the given column
+     * If the given column does not exists, it will be created
+     * If the given value exists but not an array it will be ignored
+     */
+    unshift(column: keyof ModelSchema, ...values: any[]): this;
+    /**
+     * Add the given values to the beginning of the given column only if not exists
+     */
+    unshiftOnce(column: keyof ModelSchema, ...values: any[]): this;
+    /**
+     * Perform saving operation either by updating or creating a new record in database
+     */
+    save(mergedData?: Omit<ModelSchema, "id" | "_id">, { triggerEvents, cast, forceUpdate, }?: {
+        triggerEvents?: boolean;
+        cast?: boolean;
+        forceUpdate?: boolean;
+    }): Promise<this>;
+    /**
+     * Generate and return next id
+     */
+    generateNextId(): Promise<number>;
+    /**
+     * Perform saving but without any events triggers
+     */
+    silentSaving(mergedData?: Omit<ModelSchema, "id" | "_id">, options?: {
+        cast?: boolean;
+    }): Promise<this>;
+    /**
+     * Determine whether the model should be updated or not
+     */
+    protected shouldUpdate(originalData: ModelSchema, data: ModelSchema): boolean;
+    /**
+     * Triggered before saving the model either by creating or updating
+     */
+    protected onSaving(): Promise<void>;
+    /**
+     * Triggered after saving the model either by creating or updating
+     */
+    protected onSaved(): Promise<void>;
+    /**
+     * Triggered before creating the model
+     */
+    protected onCreating(): Promise<void>;
+    /**
+     * Triggered after creating the model
+     */
+    protected onCreated(): Promise<void>;
+    /**
+     * Triggered before updating the model
+     */
+    protected onUpdating(): Promise<void>;
+    /**
+     * Triggered after updating the model
+     */
+    protected onUpdated(): Promise<void>;
+    /**
+     * Triggered before deleting the model
+     */
+    protected onDeleting(): Promise<void>;
+    /**
+     * Triggered after deleting the model
+     */
+    protected onDeleted(): Promise<void>;
+    /**
+     * Cast data before saving
+     */
+    protected castData(forceUpdate?: boolean): Promise<void>;
+    /**
+     * Return only the given columns to be used in output
+     */
+    outputOnly(columns: string[]): this;
+    /**
+     * Return all columns except the given columns to be used in output
+     */
+    outputExcept(columns: string[]): this;
+    /**
+     * Cast the given value based on the given cast type
+     */
+    protected castValue(value: any, castType: CastType): any;
+    /**
+     * Check for default values
+     */
+    protected checkDefaultValues(): void;
+    /**
+     * Destroy the model and delete it from database collection
+     */
+    destroy(): Promise<void>;
+    /**
+     * Determine if the given column is dirty column
+     *
+     * Dirty columns are columns that their values have been changed from the original data
+     */
+    isDirty(column?: string): boolean;
+    /**
+     * Check if current model is a new model
+     */
+    isNewModel(): boolean;
+    /**
+     * Get embedded data
+     */
+    get embeddedData(): any;
+    /**
+     * Clone the model
+     */
+    clone(data?: Document): this;
+}
+export type ModelType = typeof Model;
+export {};
+//# sourceMappingURL=model.d.ts.map

package/esm/model/model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../../src/model/model.ts"],"names":[],"mappings":"AAYA,OAAO,EAAoB,QAAQ,EAAE,MAAM,SAAS,CAAC;AAErD,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EACL,QAAQ,EACR,KAAK,EAEL,WAAW,EACX,QAAQ,EAET,MAAM,SAAS,CAAC;AAIjB,MAAM,MAAM,MAAM,CAAC,WAAW,GAAG,QAAQ,IAAI,WAAW,GAAG;IACzD,GAAG,CAAC,EAAE,QAAQ,CAAC;IACf,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,SAAS,CAAC,EAAE,IAAI,CAAC;CAClB,CAAC;AAEF,KAAK,WAAW,GAAG,MAAM,CAAC;AAC1B,KAAK,aAAa,GAAG,QAAQ,CAAC;AAE9B,qBAAa,KAKX,SAAQ,iBAAiB;IAEzB;;OAEG;IACI,WAAW,EAAE,OAAO,CAAC,WAAW,CAAC,CAAM;IAE9C;;OAEG;IACI,IAAI,EAAG,WAAW,CAAC;IAE1B;;;OAGG;IACI,YAAY,EAAE,OAAO,CAAC,WAAW,CAAC,CAAM;IAE/C;;OAEG;IACH,SAAS,CAAC,UAAU,UAAS;IAE7B;;OAEG;IACH,SAAS,CAAC,KAAK,EAAE,KAAK,CAAM;IAE5B;;;;OAIG;IACH,SAAS,CAAC,WAAW,EAAE,WAAW,CAAC,MAAM,CAAC,CAAM;IAEhD;;OAEG;IACI,OAAO,EAAE,CAAC,MAAM,aAAa,CAAC,EAAE,CAAM;IAE7C;;OAEG;IACI,MAAM,EAAE,CAAC,MAAM,aAAa,CAAC,EAAE,CAAM;IAE5C;;OAEG;IACI,QAAQ,EAAE,CAAC,MAAM,WAAW,CAAC,EAAE,CAAM;IAE5C;;OAEG;IACI,cAAc,EAAE,CAAC,MAAM,aAAa,CAAC,EAAE,CAAM;IAEpD;;OAEG;IACI,sCAAsC,UAAS;IAEtD;;OAEG;IACI,eAAe,SAAe;IAErC;;OAEG;IACI,eAAe,SAAe;IAErC;;OAEG;IACI,eAAe,SAAe;IAErC;;OAEG;IACI,eAAe,SAAe;IAErC;;OAEG;IACI,eAAe,SAAe;IAErC;;OAEG;IACI,eAAe,SAAe;IAErC;;OAEG;IACI,UAAU,SAAgB;IAEjC;;OAEG;IACH,SAAS,CAAC,eAAe,UAAS;IAElC;;OAEG;IACH,SAAS,CAAC,cAAc,SAAc;IAEtC;;OAEG;IACI,YAAY,EAAE,WAAW,CAAqB;IAErD;;OAEG;gBACgB,YAAY,GAAE,OAAO,CAAC,WAAW,CAAM;IA8B1D;;OAEG;IACH,IAAW,WAAW,aAErB;IAED;;OAEG;IACI,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,GAAG;IAI/C;;OAEG;IACH,IAAW,UAAU,QAEpB;IAED;;OAEG;IACH,IAAW,WAAW,QAErB;IAED;;OAEG;IACH,IAAW,EAAE,IAAI,MAAM,CAEtB;IAED;;OAEG;IACH,IAAW,QAAQ,YAElB;IAED;;OAEG;IACH,IAAW,GAAG,IAAI,QAAQ,CAEzB;IAED;;OAEG;IACI,cAAc;IAIrB;;OAEG;IACI,GAAG,CAAC,MAAM,EAAE,MAAM,WAAW,EAAE,KAAK,EAAE,GAAG;IAMhD;;OAEG;IACI,SAAS,CAAC,MAAM,EAAE,MAAM,WAAW,EAAE,KAAK,SAAI;IAIrD;;OAEG;IACI,SAAS,CAAC,MAAM,EAAE,MAAM,WAAW,EAAE,KAAK,SAAI;IAIrD;;OAEG;IACI,UAAU,CAAC,MAAM,EAAE,MAAM,WAAW,EAAE,YAAY,CAAC,EAAE,GAAG;IAI/D;;OAEG;IACI,GAAG,CAAC,SAAS,GAAG,GAAG,EACxB,MAAM,EAAE,MAAM,WAAW,EACzB,YAAY,CAAC,EAAE,GAAG,GACjB,SAAS;IAIZ;;OAEG;IACI,MAAM,CAAC,MAAM,EAAE,MAAM,WAAW,EAAE,YAAY,CAAC,EAAE,GAAG;IAI3D;;OAEG;IACI,GAAG,CAAC,MAAM,EAAE,MAAM,WAAW,EAAE,YAAY,CAAC,EAAE,GAAG;IAIxD;;OAEG;IACI,KAAK,CAAC,MAAM,EAAE,MAAM,WAAW,EAAE,YAAY,CAAC,EAAE,GAAG;IAI1D;;OAEG;IACI,MAAM,CAAC,MAAM,EAAE,MAAM,WAAW,EAAE,YAAY,CAAC,EAAE,GAAG;IAI3D;;OAEG;IACI,IAAI,CAAC,MAAM,EAAE,MAAM,WAAW,EAAE,YAAY,CAAC,EAAE,GAAG;IAIzD;;OAEG;IACI,GAAG,CAAC,MAAM,EAAE,MAAM,WAAW;IAIpC;;OAEG;IACI,MAAM,CAAC,OAAO,EAAE,CAAC,MAAM,WAAW,CAAC,EAAE,GAAG,QAAQ;IAIvD;;OAEG;IACI,IAAI,CAAC,OAAO,EAAE,CAAC,MAAM,WAAW,CAAC,EAAE,GAAG,QAAQ;IAIrD;;OAEG;IACH,IAAW,MAAM,aAEhB;IAED;;OAEG;IACI,KAAK,CAAC,GAAG,OAAO,EAAE,CAAC,MAAM,WAAW,CAAC,EAAE;IAM9C;;OAEG;IACI,WAAW,CAAC,IAAI,EAAE,WAAW;IAcpC;;OAEG;IACI,KAAK,CAAC,IAAI,EAAE,QAAQ;IAM3B;;;;OAIG;IACI,IAAI,CAAC,MAAM,EAAE,MAAM,WAAW,EAAE,GAAG,MAAM,EAAE,GAAG,EAAE;IAYvD;;OAEG;IACI,QAAQ,CAAC,MAAM,EAAE,MAAM,WAAW,EAAE,GAAG,MAAM,EAAE,GAAG,EAAE;IAa3D;;;;OAIG;IACI,OAAO,CAAC,MAAM,EAAE,MAAM,WAAW,EAAE,GAAG,MAAM,EAAE,GAAG,EAAE;IAY1D;;OAEG;IACI,WAAW,CAAC,MAAM,EAAE,MAAM,WAAW,EAAE,GAAG,MAAM,EAAE,GAAG,EAAE;IAa9D;;OAEG;IACU,IAAI,CACf,UAAU,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,GAAG,KAAK,CAAC,EAC5C,EACE,aAAoB,EACpB,IAAW,EACX,WAAmB,GACpB,GAAE;QACD,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB,IAAI,CAAC,EAAE,OAAO,CAAC;QACf,WAAW,CAAC,EAAE,OAAO,CAAC;KAClB;IA2LR;;OAEG;IACU,cAAc;IAS3B;;OAEG;IACU,YAAY,CACvB,UAAU,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,GAAG,KAAK,CAAC,EAC5C,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,OAAO,CAAA;KAAE;IAQ9B;;OAEG;IACH,SAAS,CAAC,YAAY,CAAC,YAAY,EAAE,WAAW,EAAE,IAAI,EAAE,WAAW;IAInE;;OAEG;cACa,QAAQ;IAIxB;;OAEG;cACa,OAAO;IAIvB;;OAEG;cACa,UAAU;IAI1B;;OAEG;cACa,SAAS;IAIzB;;OAEG;cACa,UAAU;IAI1B;;OAEG;cACa,SAAS;IAIzB;;OAEG;cACa,UAAU;IAI1B;;OAEG;cACa,SAAS;IAIzB;;OAEG;cACa,QAAQ,CAAC,WAAW,UAAQ;IAkG5C;;OAEG;IACI,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE;IAInC;;OAEG;IACI,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE;IAIrC;;OAEG;IACH,SAAS,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,QAAQ;IAiGlD;;OAEG;IACH,SAAS,CAAC,kBAAkB;IAkB5B;;OAEG;IACU,OAAO;IAqDpB;;;;OAIG;IACI,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM;IAa9B;;OAEG;IACI,UAAU;IAIjB;;OAEG;IACH,IAAW,YAAY,QAiBtB;IAED;;OAEG;IACI,KAAK,CAAC,IAAI,GAAE,QAAoB;CAGxC;AAED,MAAM,MAAM,SAAS,GAAG,OAAO,KAAK,CAAC"}