@technomoron/mail-magic 1.0.9 → 1.0.11

package/src/models/txmail.ts

@@ -1,206 +0,0 @@
-import path from 'path';
-
-import { Sequelize, Model, DataTypes } from 'sequelize';
-import { z } from 'zod';
-
-import { StoredFile } from '../types.js';
-import { user_and_domain, normalizeSlug } from '../util.js';
-
-export const api_txmail_schema = z.object({
-	template_id: z.number().int().nonnegative(),
-	user_id: z.number().int().nonnegative(),
-	domain_id: z.number().int().nonnegative(),
-	name: z.string().min(1),
-	locale: z.string().default(''),
-	template: z.string().default(''),
-	filename: z.string().default(''),
-	sender: z.string().min(1),
-	subject: z.string(),
-	slug: z.string().default(''),
-	files: z
-		.array(
-			z.object({
-				filename: z.string(),
-				path: z.string(),
-				cid: z.string().optional()
-			})
-		)
-		.default([])
-});
-
-export type api_txmail_type = z.infer<typeof api_txmail_schema>;
-export class api_txmail extends Model {
-	declare template_id: number;
-	declare user_id: number;
-	declare domain_id: number;
-	declare name: string;
-	declare locale: string;
-	declare template: string;
-	declare filename: string;
-	declare sender: string;
-	declare subject: string;
-	declare slug: string;
-	declare files: StoredFile[];
-}
-
-function assertSafeRelativePath(filename: string, label: string): string {
-	const normalized = path.normalize(filename);
-	if (path.isAbsolute(normalized)) {
-		throw new Error(`${label} path must be relative`);
-	}
-	if (normalized.split(path.sep).includes('..')) {
-		throw new Error(`${label} path cannot include '..' segments`);
-	}
-	return normalized;
-}
-
-export async function upsert_txmail(record: api_txmail_type): Promise<api_txmail> {
-	const { user, domain } = await user_and_domain(record.domain_id);
-
-	const idname = normalizeSlug(user.idname);
-	const dname = normalizeSlug(domain.name);
-	const name = normalizeSlug(record.name);
-	const locale = normalizeSlug(record.locale || domain.locale || user.locale || '');
-
-	if (!record.slug) {
-		record.slug = `${idname}-${dname}${locale ? '-' + locale : ''}-${name}`;
-	}
-
-	if (!record.filename) {
-		const parts = [dname, 'tx-template'];
-		if (locale) parts.push(locale);
-		parts.push(name);
-		record.filename = path.join(...parts);
-	} else {
-		record.filename = path.join(dname, 'tx-template', record.filename);
-	}
-	if (!record.filename.endsWith('.njk')) {
-		record.filename += '.njk';
-	}
-	record.filename = assertSafeRelativePath(record.filename, 'Template filename');
-
-	const [instance] = await api_txmail.upsert(record);
-	return instance;
-}
-
-export async function init_api_txmail(api_db: Sequelize): Promise<typeof api_txmail> {
-	api_txmail.init(
-		{
-			template_id: {
-				type: DataTypes.INTEGER,
-				autoIncrement: true,
-				allowNull: false,
-				primaryKey: true
-			},
-			user_id: {
-				type: DataTypes.INTEGER,
-				allowNull: false,
-				unique: false,
-				references: {
-					model: 'user',
-					key: 'user_id'
-				},
-				onDelete: 'CASCADE',
-				onUpdate: 'CASCADE'
-			},
-			domain_id: {
-				type: DataTypes.INTEGER,
-				allowNull: false,
-				unique: false,
-				references: {
-					model: 'domain',
-					key: 'domain_id'
-				},
-				onDelete: 'CASCADE',
-				onUpdate: 'CASCADE'
-			},
-			name: {
-				type: DataTypes.STRING,
-				allowNull: false,
-				unique: false
-			},
-			locale: {
-				type: DataTypes.STRING,
-				allowNull: false,
-				defaultValue: '',
-				unique: false
-			},
-			template: {
-				type: DataTypes.TEXT,
-				allowNull: false,
-				defaultValue: ''
-			},
-			filename: {
-				type: DataTypes.STRING,
-				allowNull: false,
-				defaultValue: ''
-			},
-			sender: {
-				type: DataTypes.STRING,
-				allowNull: false
-			},
-			subject: {
-				type: DataTypes.STRING,
-				allowNull: false,
-				defaultValue: ''
-			},
-			slug: {
-				type: DataTypes.STRING,
-				allowNull: false,
-				defaultValue: ''
-			},
-			part: {
-				type: DataTypes.BOOLEAN,
-				allowNull: false,
-				defaultValue: false
-			},
-			files: {
-				type: DataTypes.TEXT,
-				allowNull: false,
-				defaultValue: '[]',
-				get() {
-					const raw = this.getDataValue('files') as string | null;
-					return raw ? (JSON.parse(raw) as StoredFile[]) : [];
-				},
-				set(value: StoredFile[] | null | undefined) {
-					this.setDataValue('files', JSON.stringify(value ?? []));
-				}
-			}
-		},
-		{
-			sequelize: api_db,
-			tableName: 'txmail',
-			charset: 'utf8mb4',
-			collate: 'utf8mb4_unicode_ci',
-			indexes: [
-				{
-					unique: true,
-					fields: ['user_id', 'domain_id', 'locale', 'name']
-				}
-			]
-		}
-	);
-
-	api_txmail.addHook('beforeValidate', async (template: api_txmail) => {
-		const { user, domain } = await user_and_domain(template.domain_id);
-
-		const dname = normalizeSlug(domain.name);
-		const name = normalizeSlug(template.name);
-		const locale = normalizeSlug(template.locale || domain.locale || user.locale || '');
-
-		template.slug ||= `${normalizeSlug(user.idname)}-${dname}${locale ? '-' + locale : ''}-${name}`;
-
-		if (!template.filename) {
-			const parts = [dname, 'tx-template'];
-			if (locale) parts.push(locale);
-			parts.push(name);
-			template.filename = parts.join('/');
-		}
-		if (!template.filename.endsWith('.njk')) {
-			template.filename += '.njk';
-		}
-		template.filename = assertSafeRelativePath(template.filename, 'Template filename');
-	});
-
-	return api_txmail;
-}

package/src/models/user.ts

@@ -1,79 +0,0 @@
-import { Sequelize, Model, DataTypes } from 'sequelize';
-import { z } from 'zod';
-
-export const api_user_schema = z.object({
-	user_id: z.number().int().nonnegative(),
-	idname: z.string().min(1),
-	token: z.string().min(1),
-	name: z.string().min(1),
-	email: z.string().email(),
-	domain: z.number().int().nonnegative().nullable().optional(),
-	locale: z.string().default('')
-});
-
-export type api_user_type = z.infer<typeof api_user_schema>;
-export class api_user extends Model {
-	declare user_id: number;
-	declare idname: string;
-	declare token: string;
-	declare name: string;
-	declare email: string;
-	declare domain: number;
-	declare locale: string;
-}
-
-export async function init_api_user(api_db: Sequelize): Promise<typeof api_user> {
-	await api_user.init(
-		{
-			user_id: {
-				type: DataTypes.INTEGER,
-				autoIncrement: true,
-				allowNull: false,
-				primaryKey: true
-			},
-			idname: {
-				type: DataTypes.STRING,
-				allowNull: false,
-				defaultValue: ''
-			},
-			token: {
-				type: DataTypes.STRING,
-				allowNull: false,
-				defaultValue: ''
-			},
-			name: {
-				type: DataTypes.STRING,
-				allowNull: false,
-				defaultValue: ''
-			},
-			email: {
-				type: DataTypes.STRING,
-				allowNull: false,
-				defaultValue: ''
-			},
-			domain: {
-				type: DataTypes.INTEGER,
-				allowNull: true,
-				references: {
-					model: 'domain',
-					key: 'domain_id'
-				},
-				onDelete: 'SET NULL',
-				onUpdate: 'CASCADE',
-				defaultValue: null
-			},
-			locale: {
-				type: DataTypes.STRING,
-				allowNull: false,
-				defaultValue: ''
-			}
-		},
-		{
-			sequelize: api_db,
-			tableName: 'user',
-			charset: 'utf8mb4',
-			collate: 'utf8mb4_unicode_ci'
-		}
-	);
-	return api_user;
-}

package/src/server.ts

@@ -1,27 +0,0 @@
-import { ApiServerConf, ApiServer } from '@technomoron/api-server-base';
-
-import { api_user } from './models/user.js';
-import { mailStore } from './store/store.js';
-
-export class mailApiServer extends ApiServer {
-	storage: mailStore;
-
-	constructor(
-		config: Partial<ApiServerConf>,
-		private store: mailStore
-	) {
-		super(config);
-		this.storage = store;
-	}
-
-	override async getApiKey<ApiKey>(token: string): Promise<ApiKey | null> {
-		this.storage.print_debug(`Looking up api key ${token}`);
-		const user = await api_user.findOne({ where: { token: token } });
-		if (!user) {
-			this.storage.print_debug(`Unable to find user for token ${token}`);
-			return null;
-		} else {
-			return { uid: user.user_id } as ApiKey;
-		}
-	}
-}

package/src/store/envloader.ts

@@ -1,109 +0,0 @@
-import { defineEnvOptions } from '@technomoron/env-loader';
-
-export const envOptions = defineEnvOptions({
-	NODE_ENV: {
-		description: 'Specifies the environment in which the app is running',
-		options: ['development', 'production', 'staging'],
-		default: 'development'
-	},
-	API_PORT: {
-		description: 'Defines the port on which the app listens. Default 3780',
-		default: '3776',
-		type: 'number'
-	},
-	API_HOST: {
-		description: 'Sets the local IP address for the API to listen at',
-		default: '0.0.0.0'
-	},
-	DB_AUTO_RELOAD: {
-		description: 'Reload init-data.db automatically on change',
-		type: 'boolean',
-		default: true
-	},
-	DB_FORCE_SYNC: {
-		description: 'Whether to force sync on table definitions (ALTER TABLE)',
-		type: 'boolean',
-		default: false
-	},
-	API_URL: {
-		description: 'Sets the public URL for the API (i.e. https://ml.example.com:3790)',
-		default: 'http://localhost:3776'
-	},
-	SWAGGER_ENABLED: {
-		description: 'Enable the Swagger/OpenAPI endpoint',
-		type: 'boolean',
-		default: false
-	},
-	SWAGGER_PATH: {
-		description: 'Path to expose the Swagger/OpenAPI spec (default: /api/swagger when enabled)',
-		default: ''
-	},
-	ASSET_ROUTE: {
-		description: 'Route prefix exposed for config assets',
-		default: '/asset'
-	},
-	CONFIG_PATH: {
-		description: 'Path to directory where config files are located',
-		default: './data/'
-	},
-	DB_USER: {
-		description: 'Database username for API database'
-	},
-	DB_PASS: {
-		description: 'Password for API database'
-	},
-	DB_NAME: {
-		description: 'Name of API database. Filename for sqlite3, database name for others',
-		default: 'maildata'
-	},
-	DB_HOST: {
-		description: 'Host of API database',
-		default: 'localhost'
-	},
-	DB_TYPE: {
-		description: 'Database type of WP database',
-		options: ['sqlite'],
-		default: 'sqlite'
-	},
-	DB_LOG: {
-		description: 'Log SQL statements',
-		default: 'false',
-		type: 'boolean'
-	},
-	DEBUG: {
-		description: 'Enable debug output, including nodemailer and API',
-		default: false,
-		type: 'boolean'
-	},
-	SMTP_HOST: {
-		description: 'Hostname of SMTP sending host',
-		default: 'localhost'
-	},
-	SMTP_PORT: {
-		description: 'SMTP host server port',
-		default: 587,
-		type: 'number'
-	},
-	SMTP_SECURE: {
-		description: 'Use secure connection to SMTP host (SSL/TSL)',
-		default: false,
-		type: 'boolean'
-	},
-	SMTP_TLS_REJECT: {
-		description: 'Reject bad cert/TLS connection to SMTP host',
-		default: false,
-		type: 'boolean'
-	},
-	SMTP_USER: {
-		description: 'Username for SMTP host',
-		default: ''
-	},
-	SMTP_PASSWORD: {
-		description: 'Password for SMTP host',
-		default: ''
-	},
-	UPLOAD_PATH: {
-		description: 'Path for attached files. Use {domain} to scope per domain.',
-		default: './{domain}/uploads'
-	}
-});

package/src/store/store.ts

@@ -1,195 +0,0 @@
-import fs from 'fs';
-import path from 'path';
-
-import { EnvLoader, envConfig } from '@technomoron/env-loader';
-import { createTransport, Transporter } from 'nodemailer';
-import { Sequelize } from 'sequelize';
-
-import { connect_api_db } from '../models/db.js';
-import { importData } from '../models/init.js';
-
-import { envOptions } from './envloader.js';
-
-import type SMTPTransport from 'nodemailer/lib/smtp-transport';
-
-interface api_key {
-	keyid: string;
-	uid: number;
-	domain: number;
-}
-
-type UploadedFile = {
-	path: string;
-	filename?: string;
-	destination?: string;
-};
-
-function create_mail_transport(env: envConfig<typeof envOptions>): Transporter {
-	const args: SMTPTransport.Options = {
-		host: env.SMTP_HOST,
-		port: env.SMTP_PORT,
-		secure: env.SMTP_SECURE,
-		tls: {
-			rejectUnauthorized: env.SMTP_TLS_REJECT
-		},
-		requireTLS: true,
-		logger: env.DEBUG,
-		debug: env.DEBUG
-	};
-	const user = env.SMTP_USER;
-	const pass = env.SMTP_PASSWORD;
-	if (user && pass) {
-		args.auth = { user, pass };
-	}
-	// console.log(JSON.stringify(args, undefined, 2));
-
-	const mailer: Transporter = createTransport({
-		...args
-	});
-	if (!mailer) {
-		throw new Error('Unable to create mailer');
-	}
-	return mailer;
-}
-
-export interface ImailStore {
-	env: envConfig<typeof envOptions>;
-	transport?: Transporter<SMTPTransport.SentMessageInfo>;
-	keys: Record<string, api_key>;
-	configpath: string;
-	deflocale?: string;
-	uploadTemplate?: string;
-	uploadStagingPath?: string;
-}
-
-export class mailStore implements ImailStore {
-	env!: envConfig<typeof envOptions>;
-	transport?: Transporter<SMTPTransport.SentMessageInfo>;
-	api_db: Sequelize | null = null;
-	keys: Record<string, api_key> = {};
-	configpath = '';
-	deflocale?: string;
-	uploadTemplate?: string;
-	uploadStagingPath?: string;
-
-	print_debug(msg: string) {
-		if (this.env.DEBUG) {
-			console.log(msg);
-		}
-	}
-
-	config_filename(name: string): string {
-		return path.resolve(path.join(this.configpath, name));
-	}
-
-	resolveUploadPath(domainName?: string): string {
-		const raw = this.env.UPLOAD_PATH ?? '';
-		const hasDomainToken = raw.includes('{domain}');
-		const expanded = hasDomainToken && domainName ? raw.replaceAll('{domain}', domainName) : raw;
-		if (!expanded) {
-			return '';
-		}
-		if (path.isAbsolute(expanded)) {
-			return expanded;
-		}
-		const base = hasDomainToken ? this.configpath : process.cwd();
-		return path.resolve(base, expanded);
-	}
-
-	getUploadStagingPath(): string {
-		if (!this.env.UPLOAD_PATH) {
-			return '';
-		}
-		if (this.uploadTemplate) {
-			return this.uploadStagingPath || path.resolve(this.configpath, '_uploads');
-		}
-		return this.resolveUploadPath();
-	}
-
-	async relocateUploads(domainName: string | null, files: UploadedFile[]): Promise<void> {
-		if (!this.uploadTemplate || !domainName || !files?.length) {
-			return;
-		}
-		const targetDir = this.resolveUploadPath(domainName);
-		if (!targetDir) {
-			return;
-		}
-		await fs.promises.mkdir(targetDir, { recursive: true });
-		await Promise.all(
-			files.map(async (file) => {
-				if (!file?.path) {
-					return;
-				}
-				const basename = path.basename(file.path);
-				const destination = path.join(targetDir, basename);
-				if (destination === file.path) {
-					return;
-				}
-				try {
-					await fs.promises.rename(file.path, destination);
-				} catch {
-					await fs.promises.copyFile(file.path, destination);
-					await fs.promises.unlink(file.path);
-				}
-				file.path = destination;
-				if (file.destination !== undefined) {
-					file.destination = targetDir;
-				}
-			})
-		);
-	}
-
-	private async load_api_keys(cfgpath: string): Promise<Record<string, api_key>> {
-		const keyfile = path.resolve(cfgpath, 'api-keys.json');
-		if (fs.existsSync(keyfile)) {
-			const raw = fs.readFileSync(keyfile, 'utf-8');
-			const jsonData = JSON.parse(raw) as Record<string, api_key>;
-			this.print_debug(`API Key Database loaded from ${keyfile}`);
-			return jsonData;
-		}
-		this.print_debug(`No api-keys.json file found: tried ${keyfile}`);
-		return {};
-	}
-
-	async init(): Promise<this> {
-		const env = (this.env = await EnvLoader.createConfigProxy(envOptions, { debug: true }));
-		EnvLoader.genTemplate(envOptions, '.env-dist');
-		const p = env.CONFIG_PATH;
-		this.configpath = path.isAbsolute(p) ? p : path.resolve(process.cwd(), p);
-		console.log(`Config path is ${this.configpath}`);
-
-		if (env.UPLOAD_PATH && env.UPLOAD_PATH.includes('{domain}')) {
-			this.uploadTemplate = env.UPLOAD_PATH;
-			this.uploadStagingPath = path.resolve(this.configpath, '_uploads');
-			try {
-				fs.mkdirSync(this.uploadStagingPath, { recursive: true });
-			} catch (err) {
-				this.print_debug(`Unable to create upload staging path: ${err}`);
-			}
-		}
-
-		// this.keys = await this.load_api_keys(this.configpath);
-
-		this.transport = await create_mail_transport(env);
-
-		this.api_db = await connect_api_db(this);
-
-		if (this.env.DB_AUTO_RELOAD) {
-			this.print_debug('Enabling auto reload of init-data.json');
-			fs.watchFile(this.config_filename('init-data.json'), { interval: 2000 }, () => {
-				this.print_debug('Config file changed, reloading...');
-				try {
-					importData(this);
-				} catch (err) {
-					this.print_debug(`Failed to reload config: ${err}`);
-				}
-			});
-		}
-
-		return this;
-	}
-
-	public get_api_key(key: string): api_key | null {
-		return this.keys[key] || null;
-	}
-}

package/src/types.ts

@@ -1,39 +0,0 @@
-import { ApiRequest } from '@technomoron/api-server-base';
-
-import { api_domain } from './models/domain.js';
-import { api_user } from './models/user.js';
-
-export interface mailApiKey {
-	uid: number;
-}
-
-export interface mailApiRequest extends ApiRequest {
-	user?: api_user;
-	domain?: api_domain;
-	locale?: string;
-}
-
-export interface formType {
-	rcpt: string;
-	sender: string;
-	subject: string;
-	template: string;
-}
-
-export interface StoredFile {
-	filename: string;
-	path: string;
-	cid?: string;
-}
-
-export interface RequestMeta {
-	client_ip: string;
-	received_at: string;
-	ip_chain: string[];
-}
-
-export interface UploadedFile {
-	originalname: string;
-	path: string;
-	fieldname: string;
-}