@adaptivestone/framework 5.0.0-beta.4 → 5.0.0-beta.40

package/dist/models/User.d.ts

@@ -0,0 +1,656 @@
+import type { TFunction } from 'i18next';
+import type { Schema } from 'mongoose';
+import type { ExtractProperty, GetModelTypeFromClass, GetModelTypeLiteFromSchema } from '../modules/BaseModel.ts';
+import { BaseModel } from '../modules/BaseModel.ts';
+export type UserModelLite = GetModelTypeLiteFromSchema<typeof User.modelSchema, ExtractProperty<typeof User, 'schemaOptions'>>;
+export type TUser = GetModelTypeFromClass<typeof User>;
+declare class User extends BaseModel {
+    static initHooks(schema: Schema): void;
+    static get modelSchema(): {
+        readonly avatar: {
+            readonly type: StringConstructor;
+            readonly maxlength: 255;
+        };
+        readonly name: {
+            readonly first: {
+                readonly type: StringConstructor;
+                readonly maxlength: 255;
+            };
+            readonly last: {
+                readonly type: StringConstructor;
+                readonly maxlength: 255;
+            };
+            readonly nick: {
+                readonly minlength: 3;
+                readonly maxlength: 255;
+                readonly type: StringConstructor;
+                readonly index: {
+                    readonly unique: true;
+                    readonly partialFilterExpression: {
+                        readonly 'name.nick': {
+                            readonly $type: "string";
+                        };
+                    };
+                };
+            };
+        };
+        readonly password: StringConstructor;
+        readonly email: {
+            readonly type: StringConstructor;
+            readonly maxlength: 255;
+            readonly index: {
+                readonly unique: true;
+                readonly partialFilterExpression: {
+                    readonly email: {
+                        readonly $type: "string";
+                    };
+                };
+            };
+        };
+        readonly sessionTokens: readonly [{
+            readonly token: StringConstructor;
+            readonly valid: DateConstructor;
+        }];
+        readonly verificationTokens: readonly [{
+            readonly until: DateConstructor;
+            readonly token: StringConstructor;
+        }];
+        readonly passwordRecoveryTokens: readonly [{
+            readonly until: DateConstructor;
+            readonly token: StringConstructor;
+        }];
+        readonly permissions: readonly [StringConstructor];
+        readonly roles: readonly [StringConstructor];
+        readonly isVerified: {
+            readonly type: BooleanConstructor;
+            readonly default: false;
+        };
+        readonly locale: {
+            readonly type: StringConstructor;
+            readonly default: "en";
+        };
+        readonly languages: readonly [StringConstructor];
+    };
+    static get modelStatics(): {
+        /**
+         * Get user by email and password
+         * @param {string} email
+         * @param {string} password
+         * @returns {Promise<InstanceType<UserModelLite> | false>}
+         */
+        readonly getUserByEmailAndPassword: <T extends UserModelLite>(this: T, email: string, password: string) => Promise<false | InstanceType<T>>;
+        /**
+         * Get user by token
+         * @param {string}
+         * @returns {Promise<InstanceType<UserModelLite> | false>}
+         */
+        readonly getUserByToken: (this: UserModelLite, token: string) => Promise<false | (import("mongoose").Document<unknown, {}, {
+            isVerified: boolean;
+            locale: string;
+            name?: {
+                first?: string | null | undefined;
+                last?: string | null | undefined;
+                nick?: string | null | undefined;
+            } | null | undefined;
+            createdAt?: NativeDate | null | undefined;
+            updatedAt?: NativeDate | null | undefined;
+            avatar?: string | null | undefined;
+            password?: string | null | undefined;
+            email?: string | null | undefined;
+            sessionTokens?: {
+                token?: string | null | undefined;
+                valid?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            verificationTokens?: {
+                token?: string | null | undefined;
+                until?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            passwordRecoveryTokens?: {
+                token?: string | null | undefined;
+                until?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            permissions?: string[] | null | undefined;
+            roles?: string[] | null | undefined;
+            languages?: string[] | null | undefined;
+        }, {}, {}> & {
+            isVerified: boolean;
+            locale: string;
+            name?: {
+                first?: string | null | undefined;
+                last?: string | null | undefined;
+                nick?: string | null | undefined;
+            } | null | undefined;
+            createdAt?: NativeDate | null | undefined;
+            updatedAt?: NativeDate | null | undefined;
+            avatar?: string | null | undefined;
+            password?: string | null | undefined;
+            email?: string | null | undefined;
+            sessionTokens?: {
+                token?: string | null | undefined;
+                valid?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            verificationTokens?: {
+                token?: string | null | undefined;
+                until?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            passwordRecoveryTokens?: {
+                token?: string | null | undefined;
+                until?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            permissions?: string[] | null | undefined;
+            roles?: string[] | null | undefined;
+            languages?: string[] | null | undefined;
+        } & {
+            _id: import("mongoose").Types.ObjectId;
+        } & {
+            __v: number;
+        })>;
+        /**
+         * Get user by email
+         * @param {string}
+         * @returns {Promise<InstanceType<UserModelLite> | false>}
+         */
+        readonly getUserByEmail: (this: UserModelLite, email: string) => Promise<false | (import("mongoose").Document<unknown, {}, {
+            isVerified: boolean;
+            locale: string;
+            name?: {
+                first?: string | null | undefined;
+                last?: string | null | undefined;
+                nick?: string | null | undefined;
+            } | null | undefined;
+            createdAt?: NativeDate | null | undefined;
+            updatedAt?: NativeDate | null | undefined;
+            avatar?: string | null | undefined;
+            password?: string | null | undefined;
+            email?: string | null | undefined;
+            sessionTokens?: {
+                token?: string | null | undefined;
+                valid?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            verificationTokens?: {
+                token?: string | null | undefined;
+                until?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            passwordRecoveryTokens?: {
+                token?: string | null | undefined;
+                until?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            permissions?: string[] | null | undefined;
+            roles?: string[] | null | undefined;
+            languages?: string[] | null | undefined;
+        }, {}, {}> & {
+            isVerified: boolean;
+            locale: string;
+            name?: {
+                first?: string | null | undefined;
+                last?: string | null | undefined;
+                nick?: string | null | undefined;
+            } | null | undefined;
+            createdAt?: NativeDate | null | undefined;
+            updatedAt?: NativeDate | null | undefined;
+            avatar?: string | null | undefined;
+            password?: string | null | undefined;
+            email?: string | null | undefined;
+            sessionTokens?: {
+                token?: string | null | undefined;
+                valid?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            verificationTokens?: {
+                token?: string | null | undefined;
+                until?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            passwordRecoveryTokens?: {
+                token?: string | null | undefined;
+                until?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            permissions?: string[] | null | undefined;
+            roles?: string[] | null | undefined;
+            languages?: string[] | null | undefined;
+        } & {
+            _id: import("mongoose").Types.ObjectId;
+        } & {
+            __v: number;
+        })>;
+        /**
+         * Get user by password recovery token
+         * @param {string} passwordRecoveryToken
+         * @returns {Promise<InstanceType<UserModelLite> | false>}
+         */
+        readonly getUserByPasswordRecoveryToken: (this: UserModelLite, passwordRecoveryToken: string) => Promise<import("mongoose").Document<unknown, {}, {
+            isVerified: boolean;
+            locale: string;
+            name?: {
+                first?: string | null | undefined;
+                last?: string | null | undefined;
+                nick?: string | null | undefined;
+            } | null | undefined;
+            createdAt?: NativeDate | null | undefined;
+            updatedAt?: NativeDate | null | undefined;
+            avatar?: string | null | undefined;
+            password?: string | null | undefined;
+            email?: string | null | undefined;
+            sessionTokens?: {
+                token?: string | null | undefined;
+                valid?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            verificationTokens?: {
+                token?: string | null | undefined;
+                until?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            passwordRecoveryTokens?: {
+                token?: string | null | undefined;
+                until?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            permissions?: string[] | null | undefined;
+            roles?: string[] | null | undefined;
+            languages?: string[] | null | undefined;
+        }, {}, {}> & {
+            isVerified: boolean;
+            locale: string;
+            name?: {
+                first?: string | null | undefined;
+                last?: string | null | undefined;
+                nick?: string | null | undefined;
+            } | null | undefined;
+            createdAt?: NativeDate | null | undefined;
+            updatedAt?: NativeDate | null | undefined;
+            avatar?: string | null | undefined;
+            password?: string | null | undefined;
+            email?: string | null | undefined;
+            sessionTokens?: {
+                token?: string | null | undefined;
+                valid?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            verificationTokens?: {
+                token?: string | null | undefined;
+                until?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            passwordRecoveryTokens?: {
+                token?: string | null | undefined;
+                until?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            permissions?: string[] | null | undefined;
+            roles?: string[] | null | undefined;
+            languages?: string[] | null | undefined;
+        } & {
+            _id: import("mongoose").Types.ObjectId;
+        } & {
+            __v: number;
+        }>;
+        /**
+         * Get user by verification token
+         * @param {string} verificationToken
+         * @returns {Promise<InstanceType<UserModelLite> | false>}
+         */
+        readonly getUserByVerificationToken: (this: UserModelLite, verificationToken: string) => Promise<import("mongoose").Document<unknown, {}, {
+            isVerified: boolean;
+            locale: string;
+            name?: {
+                first?: string | null | undefined;
+                last?: string | null | undefined;
+                nick?: string | null | undefined;
+            } | null | undefined;
+            createdAt?: NativeDate | null | undefined;
+            updatedAt?: NativeDate | null | undefined;
+            avatar?: string | null | undefined;
+            password?: string | null | undefined;
+            email?: string | null | undefined;
+            sessionTokens?: {
+                token?: string | null | undefined;
+                valid?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            verificationTokens?: {
+                token?: string | null | undefined;
+                until?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            passwordRecoveryTokens?: {
+                token?: string | null | undefined;
+                until?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            permissions?: string[] | null | undefined;
+            roles?: string[] | null | undefined;
+            languages?: string[] | null | undefined;
+        }, {}, {}> & {
+            isVerified: boolean;
+            locale: string;
+            name?: {
+                first?: string | null | undefined;
+                last?: string | null | undefined;
+                nick?: string | null | undefined;
+            } | null | undefined;
+            createdAt?: NativeDate | null | undefined;
+            updatedAt?: NativeDate | null | undefined;
+            avatar?: string | null | undefined;
+            password?: string | null | undefined;
+            email?: string | null | undefined;
+            sessionTokens?: {
+                token?: string | null | undefined;
+                valid?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            verificationTokens?: {
+                token?: string | null | undefined;
+                until?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            passwordRecoveryTokens?: {
+                token?: string | null | undefined;
+                until?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            permissions?: string[] | null | undefined;
+            roles?: string[] | null | undefined;
+            languages?: string[] | null | undefined;
+        } & {
+            _id: import("mongoose").Types.ObjectId;
+        } & {
+            __v: number;
+        }>;
+    };
+    static get modelInstanceMethods(): {
+        /**
+         * Generate token for user
+         * @returns {Object}
+         */
+        readonly generateToken: (this: import("mongoose").Document<unknown, {}, {
+            isVerified: boolean;
+            locale: string;
+            name?: {
+                first?: string | null | undefined;
+                last?: string | null | undefined;
+                nick?: string | null | undefined;
+            } | null | undefined;
+            createdAt?: NativeDate | null | undefined;
+            updatedAt?: NativeDate | null | undefined;
+            avatar?: string | null | undefined;
+            password?: string | null | undefined;
+            email?: string | null | undefined;
+            sessionTokens?: {
+                token?: string | null | undefined;
+                valid?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            verificationTokens?: {
+                token?: string | null | undefined;
+                until?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            passwordRecoveryTokens?: {
+                token?: string | null | undefined;
+                until?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            permissions?: string[] | null | undefined;
+            roles?: string[] | null | undefined;
+            languages?: string[] | null | undefined;
+        }, {}, {}> & {
+            isVerified: boolean;
+            locale: string;
+            name?: {
+                first?: string | null | undefined;
+                last?: string | null | undefined;
+                nick?: string | null | undefined;
+            } | null | undefined;
+            createdAt?: NativeDate | null | undefined;
+            updatedAt?: NativeDate | null | undefined;
+            avatar?: string | null | undefined;
+            password?: string | null | undefined;
+            email?: string | null | undefined;
+            sessionTokens?: {
+                token?: string | null | undefined;
+                valid?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            verificationTokens?: {
+                token?: string | null | undefined;
+                until?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            passwordRecoveryTokens?: {
+                token?: string | null | undefined;
+                until?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            permissions?: string[] | null | undefined;
+            roles?: string[] | null | undefined;
+            languages?: string[] | null | undefined;
+        } & {
+            _id: import("mongoose").Types.ObjectId;
+        } & {
+            __v: number;
+        }) => Promise<{
+            token: string;
+            valid: Date;
+        }>;
+        /**
+         * Send password recovery email
+         * @param {Object}
+         * @param {TFunction}
+         * @param {string} i18n.language
+         * @returns {Promise<boolean>}
+         */
+        readonly sendPasswordRecoveryEmail: (this: import("mongoose").Document<unknown, {}, {
+            isVerified: boolean;
+            locale: string;
+            name?: {
+                first?: string | null | undefined;
+                last?: string | null | undefined;
+                nick?: string | null | undefined;
+            } | null | undefined;
+            createdAt?: NativeDate | null | undefined;
+            updatedAt?: NativeDate | null | undefined;
+            avatar?: string | null | undefined;
+            password?: string | null | undefined;
+            email?: string | null | undefined;
+            sessionTokens?: {
+                token?: string | null | undefined;
+                valid?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            verificationTokens?: {
+                token?: string | null | undefined;
+                until?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            passwordRecoveryTokens?: {
+                token?: string | null | undefined;
+                until?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            permissions?: string[] | null | undefined;
+            roles?: string[] | null | undefined;
+            languages?: string[] | null | undefined;
+        }, {}, {}> & {
+            isVerified: boolean;
+            locale: string;
+            name?: {
+                first?: string | null | undefined;
+                last?: string | null | undefined;
+                nick?: string | null | undefined;
+            } | null | undefined;
+            createdAt?: NativeDate | null | undefined;
+            updatedAt?: NativeDate | null | undefined;
+            avatar?: string | null | undefined;
+            password?: string | null | undefined;
+            email?: string | null | undefined;
+            sessionTokens?: {
+                token?: string | null | undefined;
+                valid?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            verificationTokens?: {
+                token?: string | null | undefined;
+                until?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            passwordRecoveryTokens?: {
+                token?: string | null | undefined;
+                until?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            permissions?: string[] | null | undefined;
+            roles?: string[] | null | undefined;
+            languages?: string[] | null | undefined;
+        } & {
+            _id: import("mongoose").Types.ObjectId;
+        } & {
+            __v: number;
+        }, i18n: {
+            t: TFunction;
+            language: string;
+        }) => Promise<any>;
+        /**
+         * Send verification email
+         * @param {Object}
+         * @param {TFunction} i18n.t
+         * @param {string} i18n.language
+         * @returns {Promise<boolean>}
+         */
+        readonly sendVerificationEmail: (this: import("mongoose").Document<unknown, {}, {
+            isVerified: boolean;
+            locale: string;
+            name?: {
+                first?: string | null | undefined;
+                last?: string | null | undefined;
+                nick?: string | null | undefined;
+            } | null | undefined;
+            createdAt?: NativeDate | null | undefined;
+            updatedAt?: NativeDate | null | undefined;
+            avatar?: string | null | undefined;
+            password?: string | null | undefined;
+            email?: string | null | undefined;
+            sessionTokens?: {
+                token?: string | null | undefined;
+                valid?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            verificationTokens?: {
+                token?: string | null | undefined;
+                until?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            passwordRecoveryTokens?: {
+                token?: string | null | undefined;
+                until?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            permissions?: string[] | null | undefined;
+            roles?: string[] | null | undefined;
+            languages?: string[] | null | undefined;
+        }, {}, {}> & {
+            isVerified: boolean;
+            locale: string;
+            name?: {
+                first?: string | null | undefined;
+                last?: string | null | undefined;
+                nick?: string | null | undefined;
+            } | null | undefined;
+            createdAt?: NativeDate | null | undefined;
+            updatedAt?: NativeDate | null | undefined;
+            avatar?: string | null | undefined;
+            password?: string | null | undefined;
+            email?: string | null | undefined;
+            sessionTokens?: {
+                token?: string | null | undefined;
+                valid?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            verificationTokens?: {
+                token?: string | null | undefined;
+                until?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            passwordRecoveryTokens?: {
+                token?: string | null | undefined;
+                until?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            permissions?: string[] | null | undefined;
+            roles?: string[] | null | undefined;
+            languages?: string[] | null | undefined;
+        } & {
+            _id: import("mongoose").Types.ObjectId;
+        } & {
+            __v: number;
+        }, i18n: {
+            t: TFunction;
+            language: string;
+        }) => Promise<any>; /**
+         * Get public user data
+         * @returns {Object}
+         */
+        readonly getPublic: (this: import("mongoose").Document<unknown, {}, {
+            isVerified: boolean;
+            locale: string;
+            name?: {
+                first?: string | null | undefined;
+                last?: string | null | undefined;
+                nick?: string | null | undefined;
+            } | null | undefined;
+            createdAt?: NativeDate | null | undefined;
+            updatedAt?: NativeDate | null | undefined;
+            avatar?: string | null | undefined;
+            password?: string | null | undefined;
+            email?: string | null | undefined;
+            sessionTokens?: {
+                token?: string | null | undefined;
+                valid?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            verificationTokens?: {
+                token?: string | null | undefined;
+                until?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            passwordRecoveryTokens?: {
+                token?: string | null | undefined;
+                until?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            permissions?: string[] | null | undefined;
+            roles?: string[] | null | undefined;
+            languages?: string[] | null | undefined;
+        }, {}, {}> & {
+            isVerified: boolean;
+            locale: string;
+            name?: {
+                first?: string | null | undefined;
+                last?: string | null | undefined;
+                nick?: string | null | undefined;
+            } | null | undefined;
+            createdAt?: NativeDate | null | undefined;
+            updatedAt?: NativeDate | null | undefined;
+            avatar?: string | null | undefined;
+            password?: string | null | undefined;
+            email?: string | null | undefined;
+            sessionTokens?: {
+                token?: string | null | undefined;
+                valid?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            verificationTokens?: {
+                token?: string | null | undefined;
+                until?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            passwordRecoveryTokens?: {
+                token?: string | null | undefined;
+                until?: NativeDate | null | undefined;
+            }[] | null | undefined;
+            permissions?: string[] | null | undefined;
+            roles?: string[] | null | undefined;
+            languages?: string[] | null | undefined;
+        } & {
+            _id: import("mongoose").Types.ObjectId;
+        } & {
+            __v: number;
+        }) => {
+            avatar: string | null | undefined;
+            name: {
+                first?: string | null | undefined;
+                last?: string | null | undefined;
+                nick?: string | null | undefined;
+            } | null | undefined;
+            email: string | null | undefined;
+            id: any;
+            isVerified: boolean;
+            permissions: string[] | null | undefined;
+            locale: string;
+        };
+    };
+}
+export declare const userHelpers: {
+    /**
+     * Generate user verification token
+     * @param {InstanceType<UserModelLite>} userMongoose
+     * @returns {Promise<{ token: string; until: number }>}
+     */
+    generateUserVerificationToken: (userMongoose: InstanceType<UserModelLite>) => Promise<{
+        token: string;
+        until: number;
+    }>;
+    /**
+     * Get user by id
+     * @param {string}
+     * @returns {Promise<InstanceType<UserModelLite> | false>}
+     */
+    generateUserPasswordRecoveryToken: (userMongoose: InstanceType<UserModelLite>) => Promise<{
+        token: string;
+        until: number;
+    }>;
+};
+export default User;