@gzl10/nexus-backend 0.18.0 → 0.19.1

package/dist/app-error-CKbYJQ9V.d.ts

@@ -0,0 +1,136 @@
+/**
+ * Error codes for i18n-friendly error handling.
+ * Frontend translates these codes to localized messages.
+ *
+ * Format: CATEGORY_ACTION_REASON
+ *
+ * Categories: AUTH, USER, ROLE, VALIDATION, STORAGE, PERMISSION, RESOURCE, SYSTEM
+ */
+declare const ErrorCodes: {
+    readonly AUTH_INVALID_CREDENTIALS: "AUTH_INVALID_CREDENTIALS";
+    readonly AUTH_TOKEN_EXPIRED: "AUTH_TOKEN_EXPIRED";
+    readonly AUTH_TOKEN_INVALID: "AUTH_TOKEN_INVALID";
+    readonly AUTH_TOKEN_REQUIRED: "AUTH_TOKEN_REQUIRED";
+    readonly AUTH_OTP_REQUIRED: "AUTH_OTP_REQUIRED";
+    readonly AUTH_OTP_INVALID: "AUTH_OTP_INVALID";
+    readonly AUTH_REFRESH_TOKEN_REQUIRED: "AUTH_REFRESH_TOKEN_REQUIRED";
+    readonly AUTH_REFRESH_TOKEN_INVALID: "AUTH_REFRESH_TOKEN_INVALID";
+    readonly AUTH_REFRESH_TOKEN_EXPIRED: "AUTH_REFRESH_TOKEN_EXPIRED";
+    readonly AUTH_SESSION_NOT_FOUND: "AUTH_SESSION_NOT_FOUND";
+    readonly AUTH_SESSION_SELF_REVOKE: "AUTH_SESSION_SELF_REVOKE";
+    readonly AUTH_VERIFICATION_CODE_INVALID: "AUTH_VERIFICATION_CODE_INVALID";
+    readonly AUTH_REGISTRATION_DISABLED: "AUTH_REGISTRATION_DISABLED";
+    readonly AUTH_AUTO_CREATE_DISABLED: "AUTH_AUTO_CREATE_DISABLED";
+    readonly USER_NOT_FOUND: "USER_NOT_FOUND";
+    readonly USER_EMAIL_EXISTS: "USER_EMAIL_EXISTS";
+    readonly USER_NOT_AUTHENTICATED: "USER_NOT_AUTHENTICATED";
+    readonly ROLE_NOT_FOUND: "ROLE_NOT_FOUND";
+    readonly ROLE_NAME_EXISTS: "ROLE_NAME_EXISTS";
+    readonly ROLE_SYSTEM_PROTECTED: "ROLE_SYSTEM_PROTECTED";
+    readonly ROLE_HAS_USERS: "ROLE_HAS_USERS";
+    readonly ROLE_DEFAULT_NOT_FOUND: "ROLE_DEFAULT_NOT_FOUND";
+    readonly PERMISSION_DENIED: "PERMISSION_DENIED";
+    readonly VALIDATION_ERROR: "VALIDATION_ERROR";
+    readonly VALIDATION_FIELD_REQUIRED: "VALIDATION_FIELD_REQUIRED";
+    readonly VALIDATION_FIELD_INVALID: "VALIDATION_FIELD_INVALID";
+    readonly VALIDATION_JSON_MALFORMED: "VALIDATION_JSON_MALFORMED";
+    readonly STORAGE_FILE_NOT_FOUND: "STORAGE_FILE_NOT_FOUND";
+    readonly STORAGE_FILE_TOO_LARGE: "STORAGE_FILE_TOO_LARGE";
+    readonly STORAGE_FILE_TYPE_NOT_ALLOWED: "STORAGE_FILE_TYPE_NOT_ALLOWED";
+    readonly STORAGE_PAYLOAD_TOO_LARGE: "STORAGE_PAYLOAD_TOO_LARGE";
+    readonly RESOURCE_NOT_FOUND: "RESOURCE_NOT_FOUND";
+    readonly RESOURCE_CONFLICT: "RESOURCE_CONFLICT";
+    readonly RESOURCE_CREATE_NOT_SUPPORTED: "RESOURCE_CREATE_NOT_SUPPORTED";
+    readonly RESOURCE_UPDATE_NOT_SUPPORTED: "RESOURCE_UPDATE_NOT_SUPPORTED";
+    readonly RESOURCE_DELETE_NOT_SUPPORTED: "RESOURCE_DELETE_NOT_SUPPORTED";
+    readonly MODULE_NOT_FOUND: "MODULE_NOT_FOUND";
+    readonly NOT_FOUND: "NOT_FOUND";
+    readonly AUTH_UNAUTHORIZED: "AUTH_UNAUTHORIZED";
+    readonly DB_CONSTRAINT_UNIQUE: "DB_CONSTRAINT_UNIQUE";
+    readonly DB_CONSTRAINT_FK: "DB_CONSTRAINT_FK";
+    readonly DB_CONNECTION_ERROR: "DB_CONNECTION_ERROR";
+    readonly DATABASE_NOT_READY: "DATABASE_NOT_READY";
+    readonly SYSTEM_INTERNAL_ERROR: "SYSTEM_INTERNAL_ERROR";
+};
+type ErrorCode = typeof ErrorCodes[keyof typeof ErrorCodes];
+
+/**
+ * Parameters for creating an AppError with i18n support
+ */
+interface AppErrorParams {
+    /** Error code for i18n translation (e.g., 'AUTH_INVALID_CREDENTIALS') */
+    code: ErrorCode;
+    /** Fallback message in English (used if frontend doesn't have translation) */
+    message?: string;
+    /** Interpolation values for the translated message (e.g., { resource: 'User' }) */
+    interpolation?: Record<string, string | number>;
+}
+/**
+ * Base application error with i18n support.
+ *
+ * Can be created with:
+ * - String message (legacy, backward compatible)
+ * - AppErrorParams object (new, with code and interpolation)
+ *
+ * @example
+ * // Legacy usage
+ * throw new AppError('Something went wrong', 400)
+ *
+ * // New usage with i18n
+ * throw new AppError({
+ *   code: ErrorCodes.USER_NOT_FOUND,
+ *   message: 'User not found',
+ *   interpolation: { resource: 'User' }
+ * }, 404)
+ */
+declare class AppError extends Error {
+    readonly statusCode: number;
+    readonly code: ErrorCode;
+    readonly interpolation?: Record<string, string | number>;
+    readonly details?: unknown;
+    constructor(params: AppErrorParams | string, statusCode?: number, details?: unknown);
+}
+/**
+ * Resource not found error (404)
+ */
+declare class NotFoundError extends AppError {
+    constructor(resource?: string);
+}
+/**
+ * Authentication required error (401)
+ */
+declare class UnauthorizedError extends AppError {
+    constructor(codeOrMessage?: ErrorCode | string, message?: string);
+}
+/**
+ * Access denied error (403)
+ */
+declare class ForbiddenError extends AppError {
+    constructor(codeOrMessage?: ErrorCode | string, message?: string);
+}
+/**
+ * Resource conflict error (409)
+ */
+declare class ConflictError extends AppError {
+    constructor(codeOrMessage?: ErrorCode | string, message?: string);
+}
+/**
+ * Standard validation error detail
+ */
+interface ValidationDetail {
+    path: string;
+    message: string;
+    /** Error code for i18n translation */
+    code?: string;
+    /** Interpolation values */
+    interpolation?: Record<string, string | number>;
+}
+/**
+ * Validation error with field-level details (400)
+ */
+declare class ValidationError extends AppError {
+    readonly details: ValidationDetail[];
+    constructor(messageOrCode?: string | ErrorCode, details?: ValidationDetail[]);
+}
+
+export { AppError as A, ConflictError as C, ErrorCodes as E, ForbiddenError as F, NotFoundError as N, UnauthorizedError as U, ValidationError as V, type AppErrorParams as a, type ErrorCode as b, type ValidationDetail as c };