nhb-express/templates/drizzle/src/app/types/interfaces.ts

Minimal Express + TypeScript scaffolder with modular structure and flexible stack choices.

import type { TEmail, TStatusCode, TUserRole } from '@/types';
import type { Router } from 'express';
import type { JwtPayload } from 'jsonwebtoken';
import type { StrictObject } from 'nhb-toolbox/object/types';
import type { LooseLiteral } from 'nhb-toolbox/utils/types';
import type Mail from 'nodemailer/lib/mailer';

export interface DrizzleErrorCause extends StrictObject, Error {
	severity_local: LooseLiteral<'ERROR'>;
	severity: LooseLiteral<'ERROR'>;
	code: `${number}`;
	detail: string;
	schema_name: LooseLiteral<'public'>;
	table_name: string;
	constraint_name: string;
	file: string;
	line: `${number}`;
	routine: string;
}

export interface IParserError {
	expose: boolean;
	statusCode: number;
	status: number;
	body: string;
	type: LooseLiteral<'entity.parse.failed'>;
}

export interface IErrorSource {
	path: string | number;
	message: string;
}

export interface IErrorResponse {
	statusCode: TStatusCode;
	name: string;
	errorSource: IErrorSource[];
	stack?: string;
}

export interface IRoute {
	path: string;
	route: Router;
}

export interface DecodedUser extends JwtPayload {
	email: TEmail;
	role: TUserRole;
}

export interface EmailOptions extends Omit<Mail.Options, 'from' | 'to'> {
	to: TEmail;
}

export interface DestroyResponse extends Record<string, unknown> {
	result: LooseLiteral<'ok' | 'not found' | 'error'>;
}