@fnlb-project/database 1.0.81 → 1.0.83

package/dist/index.d.ts

@@ -3706,6 +3706,7 @@ export interface IUser {
 	password: string;
 	apiToken: string;
 	flags?: number;
+	vipExpiresAt?: Date;
 	connections?: {
 		discord?: {
 			id?: string;
@@ -3735,6 +3736,24 @@ export interface IUser {
 		}[];
 	};
 }
+export type VipGrantResult = {
+	ok: true;
+	permanent: boolean;
+	vipExpiresAt: Date | null;
+	modified: boolean;
+	user: HydratedDocument<IUser>;
+};
+export type VipRevokeResult = {
+	ok: true;
+	modified: boolean;
+	user: HydratedDocument<IUser>;
+};
+export type ExpiredVipUser = {
+	id: string;
+	username: string;
+	email: string;
+	discordId?: string;
+};
 export interface IUserStatics {
 	verifyPassword(password: string, hash: string): Promise<boolean>;
 	findByToken(id: string, auth: string): Promise<HydratedDocument<IUser> | null>;
@@ -3743,6 +3762,10 @@ export interface IUserStatics {
 		user: HydratedDocument<IUser>;
 		app: IUserApplication;
 	} | null>;
+	expireVipIfNeeded(user: HydratedDocument<IUser>): Promise<boolean>;
+	grantVip(userId: string, expiresInDays?: number | null): Promise<VipGrantResult | null>;
+	revokeVip(userId: string): Promise<VipRevokeResult | null>;
+	expireDueVips(limit?: number): Promise<ExpiredVipUser[]>;
 }
 export interface IUserModel extends Model<IUser>, IUserStatics {
 }
@@ -3754,6 +3777,30 @@ export declare enum DatabaseErrors {
 	KeyNotFound = 211,
 	DuplicateKey = 11000
 }
+export type VipGrantUpdate = {
+	$set: {
+		flags: number;
+		vipExpiresAt?: Date;
+	};
+	$unset?: {
+		vipExpiresAt: 1;
+	};
+};
+export type VipClearUpdate = {
+	$set: {
+		flags: number;
+	};
+	$unset: {
+		vipExpiresAt: 1;
+	};
+};
+export declare function buildVipGrantUpdate(currentFlags: number | undefined, currentVipExpiresAt: Date | null | undefined, expiresInDays?: number | null): {
+	update: VipGrantUpdate;
+	vipExpiresAt: Date | null;
+	permanent: boolean;
+};
+export declare function buildVipClearUpdate(currentFlags: number | undefined): VipClearUpdate;
+export declare function shouldExpireVip(flags: number | undefined, vipExpiresAt: Date | null | undefined, now?: number): "none" | "cleanup" | "expire";
 
 export {
 	connection,