toiljs 0.0.104 → 0.0.106

package/build/compiler/auth-emails.js

@@ -0,0 +1,165 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import pc from 'picocolors';
+import { createServer } from 'vite';
+import { RESERVED_AUTH_EMAIL_NAMES, renderEmailFile, toPascal } from './emails.js';
+import { createViteConfig } from './vite.js';
+function globalsDir(root) {
+    const inApp = path.join(root, 'node_modules', 'toiljs', 'server', 'globals');
+    if (fs.existsSync(inApp))
+        return inApp;
+    const pkgDir = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../..');
+    return path.join(pkgDir, 'server', 'globals');
+}
+const SPECS = {
+    AuthConfirm: {
+        fn: 'confirm',
+        token: 'link',
+        purpose: 'verify',
+        subjectFromArg: false,
+        defaultSubject: 'Confirm your account',
+        defaultText: 'Confirm your account by opening this link:\n{{link}}\n',
+        defaultHtml: '<p>Confirm your account by clicking the link below:</p>' +
+            '<p><a href="{{link}}">Confirm my account</a></p>' +
+            '<p>Or paste this into your browser:<br>{{link}}</p>',
+    },
+    AuthReset: {
+        fn: 'reset',
+        token: 'link',
+        purpose: 'reset',
+        subjectFromArg: false,
+        defaultSubject: 'Reset your password',
+        defaultText: 'Reset your password by opening this link:\n{{link}}\n',
+        defaultHtml: '<p>We received a request to reset your password. Click the link below:</p>' +
+            '<p><a href="{{link}}">Reset my password</a></p>' +
+            '<p>If you did not request this, you can ignore this email.</p>' +
+            '<p>Or paste this into your browser:<br>{{link}}</p>',
+    },
+    Auth2fa: {
+        fn: 'twofa',
+        token: 'code',
+        purpose: '2fa',
+        subjectFromArg: true,
+        defaultSubject: '',
+        defaultText: 'Your verification code is {{code}}.\n' +
+            'It expires in a few minutes. If you did not request it, ignore this email.\n',
+        defaultHtml: '<p>Your verification code is:</p>' +
+            '<p style="font-size:28px;font-weight:bold;letter-spacing:4px">{{code}}</p>' +
+            '<p>It expires in a few minutes. If you did not request it, ignore this email.</p>',
+    },
+};
+const AUTH_NAMES = Object.keys(SPECS);
+const GENERATED_BASENAME = '_auth_emails.ts';
+function warn(msg) {
+    process.stderr.write(`  toil: auth emails ${msg}\n`);
+}
+function asLit(s) {
+    return JSON.stringify(s);
+}
+function reservedFilesIn(emailsDir) {
+    const out = new Map();
+    if (!fs.existsSync(emailsDir))
+        return out;
+    for (const f of fs.readdirSync(emailsDir).sort()) {
+        if (!/\.(tsx|jsx)$/.test(f))
+            continue;
+        const name = toPascal(f.replace(/\.(tsx|jsx)$/, ''));
+        if (RESERVED_AUTH_EMAIL_NAMES.has(name) && !out.has(name))
+            out.set(name, f);
+    }
+    return out;
+}
+function effectiveFromOverride(name, spec, r) {
+    if (!r.tokens.includes(spec.token))
+        warn(`override emails/${name} never uses the {${spec.token}} prop, so the ` +
+            `${spec.token === 'link' ? 'link' : 'code'} will be missing from the email.`);
+    for (const t of r.tokens)
+        if (t !== spec.token)
+            warn(`override emails/${name} uses {${t}}, which auth does not provide ` +
+                `(only {${spec.token}}); it will render empty.`);
+    const subject = spec.subjectFromArg || r.subject === name ? spec.defaultSubject : r.subject;
+    return { subject, text: r.text, html: r.html };
+}
+function emitFn(spec, eff) {
+    const subjectExpr = spec.subjectFromArg ? 'subject' : asLit(eff.subject);
+    const sig = spec.fn === 'twofa'
+        ? 'twofa(to: string, code: string, subject: string): void'
+        : `${spec.fn}(to: string, ${spec.token}: string): void`;
+    return [
+        `  export function ${sig} {`,
+        `    const T: string = ${asLit(eff.text)};`,
+        `    const H: string = ${asLit(eff.html)};`,
+        `    const v = new Map<string, string>();`,
+        `    v.set(${asLit(spec.token)}, ${spec.token});`,
+        `    new EmailTemplate(${subjectExpr}, T, H).sendDetached(to, v, ${asLit(spec.purpose)});`,
+        `  }`,
+    ];
+}
+function moduleSource(parts) {
+    const out = [
+        '// GENERATED by toiljs from the built-in auth email templates -- DO NOT EDIT.',
+        '// Override any of these by adding emails/auth-confirm.tsx, emails/auth-reset.tsx,',
+        '// or emails/auth-2fa.tsx (see docs/auth/emails.md). `EmailTemplate` is a toiljs',
+        '// global (server/globals/email.ts); the detached send keeps auth constant-time.',
+        '',
+        'export namespace AuthEmail {',
+    ];
+    for (const name of AUTH_NAMES)
+        out.push(...emitFn(SPECS[name], parts[name]));
+    out.push('}');
+    return out.join('\n') + '\n';
+}
+export async function renderAuthEmails(cfg, authOn) {
+    const generatedPath = path.join(globalsDir(cfg.root), GENERATED_BASENAME);
+    if (!authOn) {
+        if (fs.existsSync(generatedPath))
+            fs.rmSync(generatedPath);
+        return;
+    }
+    const emailsDir = path.join(cfg.root, 'emails');
+    const overrides = reservedFilesIn(emailsDir);
+    const parts = {};
+    for (const name of AUTH_NAMES) {
+        const spec = SPECS[name];
+        parts[name] = { subject: spec.defaultSubject, text: spec.defaultText, html: spec.defaultHtml };
+    }
+    if (overrides.size > 0) {
+        const { renderToStaticMarkup } = await import('react-dom/server');
+        const server = await createServer({
+            ...(await createViteConfig(cfg)),
+            server: { middlewareMode: true, hmr: false },
+            appType: 'custom',
+            logLevel: 'silent',
+        });
+        try {
+            for (const [name, file] of overrides) {
+                try {
+                    const r = await renderEmailFile(server, emailsDir, file, renderToStaticMarkup);
+                    if (r)
+                        parts[name] = effectiveFromOverride(name, SPECS[name], r);
+                    else
+                        warn(`skipped ${file} (no default-exported component)`);
+                }
+                catch (err) {
+                    warn(`skipped ${file} (${err instanceof Error ? err.message : String(err)})`);
+                }
+            }
+        }
+        finally {
+            await server.close();
+        }
+    }
+    const next = moduleSource(parts);
+    const prev = fs.existsSync(generatedPath) ? fs.readFileSync(generatedPath, 'utf8') : null;
+    if (prev === next)
+        return;
+    fs.mkdirSync(path.dirname(generatedPath), { recursive: true });
+    fs.writeFileSync(generatedPath, next);
+    if (overrides.size > 0)
+        process.stdout.write(pc.green('  ✓ ') +
+            pc.dim(`auth emails: overrode ${[...overrides.keys()].map((n) => SPECS[n].fn).join(', ')}`) +
+            '\n');
+}
+export const AUTH_EMAILS_GENERATED_BASENAME = GENERATED_BASENAME;
+export const __test = { moduleSource, effectiveFromOverride, SPECS };

package/build/compiler/emails.d.ts

@@ -14,12 +14,14 @@ export interface RenderedEmail {
     tokens: string[];
     purpose: string;
 }
+export declare const RESERVED_AUTH_EMAIL_NAMES: Set<string>;
 declare function tokenProps(seen: Set<string>): Record<string, unknown>;
 declare function htmlToText(html: string): string;
 declare function renderModule(name: string, mod: EmailModule, render: (el: unknown) => string, css?: string): Promise<RenderedEmail | null>;
 export declare function collectModuleCss(server: ViteDevServer, moduleId: string): Promise<string>;
 export declare function renderEmailFile(server: ViteDevServer, emailsDir: string, file: string, render: (el: unknown) => string): Promise<RenderedEmail | null>;
 export declare function toPascal(base: string): string;
+export declare function serverDir(root: string): string;
 declare function renderModuleSource(rendered: RenderedEmail[]): string;
 export declare function renderEmails(cfg: ResolvedToilConfig): Promise<void>;
 export declare const __test: {

package/build/compiler/emails.js

@@ -15,6 +15,7 @@ const REACT_INTERNAL = new Set([
     'constructor',
     'then',
 ]);
+export const RESERVED_AUTH_EMAIL_NAMES = new Set(['AuthConfirm', 'AuthReset', 'Auth2fa']);
 const TOKEN_RE = /\{\{\s*([A-Za-z_$][\w$]*)\s*\}\}/g;
 function extractTokens(s) {
     const out = [];
@@ -133,7 +134,7 @@ export function toPascal(base) {
         .map((p) => p.charAt(0).toUpperCase() + p.slice(1))
         .join('');
 }
-function serverDir(root) {
+export function serverDir(root) {
     try {
         const cfg = JSON.parse(fs.readFileSync(path.join(root, 'toilconfig.json'), 'utf8'));
         const first = Array.isArray(cfg.entries)
@@ -216,6 +217,8 @@ export async function renderEmails(cfg) {
     const rendered = [];
     try {
         for (const file of files) {
+            if (RESERVED_AUTH_EMAIL_NAMES.has(toPascal(path.basename(file).replace(/\.(tsx|jsx)$/, ''))))
+                continue;
             try {
                 const r = await renderEmailFile(server, emailsDir, file, renderToStaticMarkup);
                 if (r)

package/build/compiler/index.js

@@ -8,6 +8,7 @@ import pc from 'picocolors';
 import { build as viteBuild, createServer, mergeConfig } from 'vite';
 import { loadConfig } from './config.js';
 import { renderEmails } from './emails.js';
+import { AUTH_EMAILS_GENERATED_BASENAME, renderAuthEmails } from './auth-emails.js';
 import { generate, TOIL_SERVER_ENV_DTS } from './generate.js';
 import { prerenderStaticParams } from './ssg.js';
 import { extractDevSsrTemplates, extractServerSlots, extractTemplates, } from './template-build.js';
@@ -118,6 +119,13 @@ function serverImportsAuth(root, files) {
     }
     return false;
 }
+function serverAuthEnabled(root, configAuth) {
+    if (configAuth)
+        return true;
+    if (!fs.existsSync(path.join(root, 'toilconfig.json')))
+        return false;
+    return serverImportsAuth(root, serverEntryFiles(root));
+}
 export async function buildServer(root, auth = false) {
     if (!fs.existsSync(path.join(root, 'toilconfig.json')))
         return;
@@ -361,6 +369,7 @@ function watchServer(cfg, watcher) {
         building = true;
         process.stdout.write(pc.dim('  server changed, rebuilding…') + '\n');
         renderEmails(cfg)
+            .then(() => renderAuthEmails(cfg, serverAuthEnabled(root, cfg.auth)))
             .then(() => buildServer(root, cfg.auth))
             .then(() => process.stdout.write(pc.green('  ✓ ') + pc.dim('server rebuilt') + '\n'))
             .catch((e) => process.stdout.write(pc.red(`  ✗ server rebuild failed: ${String(e)}`) + '\n'))
@@ -376,6 +385,7 @@ function watchServer(cfg, watcher) {
     const isServerSource = (file) => file.endsWith('.ts') &&
         !file.endsWith('.d.ts') &&
         path.basename(file) !== '_emails.ts' &&
+        path.basename(file) !== AUTH_EMAILS_GENERATED_BASENAME &&
         dirs.some((dir) => file === dir || file.startsWith(dir + path.sep));
     const isEmailSource = (file) => /\.(tsx|jsx)$/.test(file) && (file === emailsDir || file.startsWith(emailsDir + path.sep));
     watcher.on('error', (err) => {
@@ -552,6 +562,7 @@ export async function dev(opts = {}) {
     if (hasServer)
         process.stdout.write(pc.dim('  building the server (toilscript)…') + '\n');
     await renderEmails(cfg);
+    await renderAuthEmails(cfg, serverAuthEnabled(cfg.root, cfg.auth));
     generate(cfg);
     if (hasServer)
         await extractServerSlots(cfg);
@@ -636,6 +647,7 @@ export async function build(opts = {}) {
     if (hasServer && !opts.serverOnly)
         process.stdout.write(pc.dim('  building the server (toilscript)…') + '\n');
     await renderEmails(cfg);
+    await renderAuthEmails(cfg, serverAuthEnabled(cfg.root, cfg.auth));
     generate(cfg);
     const priorServerSlots = hasServer ? await extractServerSlots(cfg) : new Map();
     await buildServer(cfg.root, cfg.auth);