@fnlb-project/database 1.0.82 → 1.0.84

package/dist/index.d.ts

@@ -1,5 +1,7 @@
 // Generated by dts-bundle-generator v9.5.1
 
+import { GenericErrorSender } from '@fnlb-project/shared/errors';
+import { CategoryConfigSupportedPlatforms, CommunityListingKind, CommunityListingStatus, Locales } from '@fnlb-project/shared/types';
 import { ConnectOptions, HydratedDocument, Model, Schema, connection } from 'mongoose';
 
 export declare class DatabaseClient {
@@ -8,63 +10,6 @@ export declare class DatabaseClient {
 	connect(options?: ConnectOptions): Promise<void>;
 	private connectWithRetry;
 }
-declare enum GeneralErrorCodes {
-	GenericUnknown = "net.fnlb.errors.generic.unknown",
-	GenericInternalError = "net.fnlb.errors.generic.internal_error",
-	GenericValidationFailed = "net.fnlb.errors.generic.validation_failed",
-	GenericParseFailed = "net.fnlb.errors.generic.parse_failed",
-	GenericNotFound = "net.fnlb.errors.generic.not_found",
-	GenericAlreadyExists = "net.fnlb.errors.generic.already_exists",
-	CommonInvalidRequest = "net.fnlb.errors.common.invalid_request",
-	CommonUnableToProcessRequest = "net.fnlb.errors.common.unable_to_process_request",
-	CommonInvalidFieldsLength = "net.fnlb.errors.common.invalid_body_fields_length",
-	CommonRateLimitExceeded = "net.fnlb.errors.common.rate_limit_exceeded",
-	CommonLimitExceeded = "net.fnlb.errors.common.limit_exceeded",
-	CommonUnableToSaveToDatabase = "net.fnlb.errors.common.unable_to_save_to_database",
-	CommonUpdateRequired = "net.fnlb.errors.common.update_required",
-	CommonMaintenanceMode = "net.fnlb.errors.common.maintenance_mode",
-	AuthInvalidToken = "net.fnlb.errors.auth.invalid_token",
-	AuthInvalidAPIToken = "net.fnlb.errors.auth.invalid_api_token",
-	AuthManagedAuthRefused = "net.fnlb.errors.auth.managed_auth_refused",
-	AuthInvalidCaptchaToken = "net.fnlb.errors.auth.invalid_captcha_token",
-	AuthUnauthorized = "net.fnlb.errors.auth.unauthorized",
-	AuthForbidden = "net.fnlb.errors.auth.forbidden",
-	AuthUserBanned = "net.fnlb.errors.auth.user_banned",
-	Oauth2InvalidCode = "net.fnlb.errors.oauth2.invalid_code",
-	Oauth2InvalidScope = "net.fnlb.errors.oauth2.invalid_scope",
-	Oauth2TokenInvalid = "net.fnlb.errors.oauth2.token_invalid",
-	Oauth2UnableToFetchUser = "net.fnlb.errors.oauth2.unable_to_fetch_user",
-	Oauth2UnableToFetchConnections = "net.fnlb.errors.oauth2.unable_to_fetch_connections",
-	Oauth2UserWithoutConnection = "net.fnlb.errors.oauth2.user_without_connection",
-	Oauth2ConnectionNotVerified = "net.fnlb.errors.oauth2.connection_not_verified",
-	ReleaseNotFound = "net.fnlb.errors.release.no_release_found",
-	ReleaseVersionAlreadyExists = "net.fnlb.errors.release.version_already_exists",
-	ReleaseHashMismatch = "net.fnlb.errors.release.hash_mismatch",
-	MfaNotEnabled = "net.fnlb.errors.mfa.not_enabled",
-	MfaAlreadyEnabled = "net.fnlb.errors.mfa.already_enabled",
-	MfaChallengeExpired = "net.fnlb.errors.mfa.challenge_expired",
-	MfaSetupExpired = "net.fnlb.errors.mfa.setup_expired"
-}
-declare enum InputErrorCodes {
-	LoginInvalidCredentials = "net.fnlb.errors.login.invalid_credentials",
-	LoginInvalidEmail = "net.fnlb.errors.login.invalid_email",
-	LoginInvalidOrUsedEmail = "net.fnlb.errors.login.invalid_or_used_email",
-	AuthPasswordConfirmationInvalid = "net.fnlb.errors.auth.invalid_password_confirmation",
-	MfaInvalidCode = "net.fnlb.errors.mfa.invalid_code",
-	MfaRequired = "net.fnlb.errors.mfa.required"
-}
-export type ErrorCodes = GeneralErrorCodes | InputErrorCodes;
-declare enum ErrorInputTypes {
-	Username = "username",
-	Email = "email",
-	Password = "password",
-	Shared = "shared",
-	MfaCode = "mfaCode"
-}
-export type ErrorSenderErrors = GeneralErrorCodes | GeneralErrorCodes[] | InputErrorCodes | InputErrorCodes[] | ErrorCodes | ErrorCodes[];
-declare abstract class GenericErrorSender {
-	abstract sendError(code: number, errors: ErrorSenderErrors, input?: ErrorInputTypes): unknown;
-}
 export declare class DatabaseErrorHandler {
 	static handleError(err: any, errorSender: GenericErrorSender): unknown;
 }
@@ -230,55 +175,6 @@ export declare const BotModel: import("mongoose").Model<{
 } & {
 	__v: number;
 }>>;
-declare enum CategoryConfigSupportedPlatforms {
-	Win = "WIN",
-	Mac = "MAC",
-	Psn = "PSN",
-	Xbl = "XBL",
-	Swt = "SWT",
-	Swt2 = "SWT2",
-	Ios = "IOS",
-	And = "AND",
-	Ps5 = "PS5",
-	Xsx = "XSX"
-}
-declare enum CommunityListingKind {
-	Bot = "bot",
-	Preset = "preset",
-	Category = "category",
-	Event = "event",
-	CustomCommand = "custom_command",
-	Scheduled = "scheduled"
-}
-declare enum CommunityListingStatus {
-	Pending = "pending",
-	Published = "published",
-	Rejected = "rejected",
-	Unlisted = "unlisted"
-}
-declare enum Locales {
-	Default = "en",
-	EnUS = "en-US",
-	Es = "es",
-	Es419 = "es-419",
-	Ar = "ar",
-	De = "de",
-	Fr = "fr",
-	He = "he",
-	Id = "id",
-	It = "it",
-	Ja = "ja",
-	Ko = "ko",
-	Pl = "pl",
-	Pt = "pt",
-	PtBR = "pt-BR",
-	Ru = "ru",
-	Th = "th",
-	Tr = "tr",
-	Vi = "vi",
-	Zh = "zh",
-	ZhHant = "zh-Hant"
-}
 export declare const CategoryModel: import("mongoose").Model<{
 	owner: import("mongoose").Types.ObjectId;
 	name: string;
@@ -3703,9 +3599,12 @@ export interface IUser {
 	username: string;
 	avatar?: string;
 	email: string;
+	/** Encrypted personal email kept for account recovery when `email` is a staff @fnlb.net address. */
+	recoveryEmail?: string;
 	password: string;
 	apiToken: string;
 	flags?: number;
+	vipExpiresAt?: Date;
 	connections?: {
 		discord?: {
 			id?: string;
@@ -3735,6 +3634,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 +3660,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 +3675,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,