@protobase/server 0.23.8 → 0.23.10

package/dist/better-auth/auth-mail/account-exists-email.js

@@ -1,10 +1,10 @@
 import { defineEmail } from "../../mail/define-email.js";
-import { AuthEmailLayout, EmailButton, EmailNote } from "./auth-email-layout.js";
+import { EmailButton, EmailLayout, EmailNote } from "../../mail/email-layout.js";
 import { signInPath } from "@protobase/schema";
 import { Text } from "react-email";
 import { jsx, jsxs } from "react/jsx-runtime";
 //#region src/better-auth/auth-mail/account-exists-email.tsx
-const AccountExistsEmail = ({ app }) => /* @__PURE__ */ jsxs(AuthEmailLayout, {
+const AccountExistsEmail = ({ app }) => /* @__PURE__ */ jsxs(EmailLayout, {
 	app,
 	preview: `Sign in to ${app.name} with this address instead`,
 	heading: "You already have an account",

package/dist/better-auth/auth-mail/invitation-email.js

@@ -1,11 +1,11 @@
 import { defineEmail } from "../../mail/define-email.js";
-import { AuthEmailLayout, EmailButton, EmailNote } from "./auth-email-layout.js";
+import { EmailButton, EmailLayout, EmailNote } from "../../mail/email-layout.js";
 import { Text } from "react-email";
 import { jsx, jsxs } from "react/jsx-runtime";
 //#region src/better-auth/auth-mail/invitation-email.tsx
 const InvitationEmail = ({ app, inviter, organization, url, expiresAt }) => {
 	const target = organization ?? app.name;
-	return /* @__PURE__ */ jsxs(AuthEmailLayout, {
+	return /* @__PURE__ */ jsxs(EmailLayout, {
 		app,
 		preview: `${inviter} invites you to join ${target}`,
 		heading: `Join ${target}`,

package/dist/better-auth/auth-mail/reset-password-email.js

@@ -1,9 +1,9 @@
 import { defineEmail } from "../../mail/define-email.js";
-import { AuthEmailLayout, EmailButton, EmailNote } from "./auth-email-layout.js";
+import { EmailButton, EmailLayout, EmailNote } from "../../mail/email-layout.js";
 import { Text } from "react-email";
 import { jsx, jsxs } from "react/jsx-runtime";
 //#region src/better-auth/auth-mail/reset-password-email.tsx
-const ResetPasswordEmail = ({ app, url, lifetime }) => /* @__PURE__ */ jsxs(AuthEmailLayout, {
+const ResetPasswordEmail = ({ app, url, lifetime }) => /* @__PURE__ */ jsxs(EmailLayout, {
 	app,
 	preview: `Choose a new password for ${app.name}`,
 	heading: "Reset your password",

package/dist/better-auth/auth-mail/send-auth-email.js

@@ -1,4 +1,4 @@
-import { mailingApp } from "./mailing-app.js";
+import { mailingApp } from "../../mail/mailing-app.js";
 //#region src/better-auth/auth-mail/send-auth-email.ts
 /**
 * Renders the auth email `name` for `data`, with the app it comes from on the origin of `requestURL` (see `mailingApp`),

package/dist/better-auth/auth-mail/sign-in-code-email.js

@@ -1,9 +1,9 @@
 import { defineEmail } from "../../mail/define-email.js";
-import { AuthEmailLayout, EmailCode, EmailNote } from "./auth-email-layout.js";
+import { EmailCode, EmailLayout, EmailNote } from "../../mail/email-layout.js";
 import { Text } from "react-email";
 import { jsx, jsxs } from "react/jsx-runtime";
 //#region src/better-auth/auth-mail/sign-in-code-email.tsx
-const SignInCodeEmail = ({ app, code, lifetime }) => /* @__PURE__ */ jsxs(AuthEmailLayout, {
+const SignInCodeEmail = ({ app, code, lifetime }) => /* @__PURE__ */ jsxs(EmailLayout, {
 	app,
 	preview: `Your code to sign in to ${app.name}`,
 	heading: "Your sign-in code",

package/dist/better-auth/auth-mail/sign-up-code-email.js

@@ -1,9 +1,9 @@
 import { defineEmail } from "../../mail/define-email.js";
-import { AuthEmailLayout, EmailCode, EmailNote } from "./auth-email-layout.js";
+import { EmailCode, EmailLayout, EmailNote } from "../../mail/email-layout.js";
 import { Text } from "react-email";
 import { jsx, jsxs } from "react/jsx-runtime";
 //#region src/better-auth/auth-mail/sign-up-code-email.tsx
-const SignUpCodeEmail = ({ app, code, lifetime }) => /* @__PURE__ */ jsxs(AuthEmailLayout, {
+const SignUpCodeEmail = ({ app, code, lifetime }) => /* @__PURE__ */ jsxs(EmailLayout, {
 	app,
 	preview: `Your code to create an account with ${app.name}`,
 	heading: "Create your account",

package/dist/better-auth/auth-mail/staff-sign-in-email.js

@@ -1,9 +1,9 @@
 import { defineEmail } from "../../mail/define-email.js";
-import { AuthEmailLayout, EmailNote } from "./auth-email-layout.js";
+import { EmailLayout, EmailNote } from "../../mail/email-layout.js";
 import { Text } from "react-email";
 import { jsx, jsxs } from "react/jsx-runtime";
 //#region src/better-auth/auth-mail/staff-sign-in-email.tsx
-const StaffSignInEmail = ({ app, staff, reason, expiresAt }) => /* @__PURE__ */ jsxs(AuthEmailLayout, {
+const StaffSignInEmail = ({ app, staff, reason, expiresAt }) => /* @__PURE__ */ jsxs(EmailLayout, {
 	app,
 	preview: `${staff} signed in as you to help`,
 	heading: "Staff signed in as you",

package/dist/better-auth/auth-mail/two-factor-code-email.js

@@ -1,9 +1,9 @@
 import { defineEmail } from "../../mail/define-email.js";
-import { AuthEmailLayout, EmailCode, EmailNote } from "./auth-email-layout.js";
+import { EmailCode, EmailLayout, EmailNote } from "../../mail/email-layout.js";
 import { Text } from "react-email";
 import { jsx, jsxs } from "react/jsx-runtime";
 //#region src/better-auth/auth-mail/two-factor-code-email.tsx
-const TwoFactorCodeEmail = ({ app, code, lifetime }) => /* @__PURE__ */ jsxs(AuthEmailLayout, {
+const TwoFactorCodeEmail = ({ app, code, lifetime }) => /* @__PURE__ */ jsxs(EmailLayout, {
 	app,
 	preview: `Your code to finish signing in to ${app.name}`,
 	heading: "Finish signing in",

package/dist/comments/mention-email.js

@@ -1,9 +1,9 @@
 import { defineEmail } from "../mail/define-email.js";
-import { AuthEmailLayout, EmailButton, EmailNote } from "../better-auth/auth-mail/auth-email-layout.js";
+import { EmailButton, EmailLayout, EmailNote } from "../mail/email-layout.js";
 import { Text } from "react-email";
 import { jsx, jsxs } from "react/jsx-runtime";
 //#region src/comments/mention-email.tsx
-const MentionEmail = ({ app, author, record, body, url }) => /* @__PURE__ */ jsxs(AuthEmailLayout, {
+const MentionEmail = ({ app, author, record, body, url }) => /* @__PURE__ */ jsxs(EmailLayout, {
 	app,
 	preview: `${author} mentioned you on ${record}`,
 	heading: `${author} mentioned you`,

package/dist/email.d.ts

@@ -0,0 +1,3 @@
+import { MailingApp } from "./mail/mailing-app.js";
+import { EmailButton, EmailCode, EmailLayout, EmailLayoutProps, EmailNote } from "./mail/email-layout.js";
+export { EmailButton, EmailCode, EmailLayout, type EmailLayoutProps, EmailNote, type MailingApp };

package/dist/email.js

@@ -0,0 +1,2 @@
+import { EmailButton, EmailCode, EmailLayout, EmailNote } from "./mail/email-layout.js";
+export { EmailButton, EmailCode, EmailLayout, EmailNote };

package/dist/jobs/options.js

@@ -21,6 +21,20 @@ const queueOptions = (options) => {
 /** The queue settings `queueOptions` sets, as `getQueue` reads them back, so a changed definition is noticed. */
 const queueSettingsDiffer = (wanted, stored) => Object.keys(wanted).some((key) => key !== "policy" && stored[key] !== wanted[key]);
 /**
+* The pg-boss worker options of a job: one job per fetch, `concurrency` at once. A worker fetches again at once after a
+* fetch that found a job while more are ready than its workers take in one poll, by the queue's ready count that the
+* queue maintenance refreshes about every minute, so a backlog drains as fast as its jobs run rather than one job per
+* worker each poll.
+*/
+const workOptions = (concurrency, pollSeconds) => ({
+	batchSize: 1,
+	localConcurrency: concurrency,
+	pollingIntervalSeconds: pollSeconds,
+	burstWhenReadyExceeds: concurrency,
+	includeMetadata: true,
+	perJobResults: true
+});
+/**
 * The pg-boss send options of one enqueue: when, how urgent, and the key a waiting job is found by. An ordered job's
 * group is its key in pg-boss, which keeps one group's jobs in order.
 */
@@ -41,4 +55,4 @@ const sendOptions = (options, enqueue = {}) => {
 	};
 };
 //#endregion
-export { queueOptions, queueSettingsDiffer, sendOptions };
+export { queueOptions, queueSettingsDiffer, sendOptions, workOptions };

package/dist/jobs/runtime.js

@@ -5,7 +5,7 @@ import { runJob, validatePayload } from "./run-job.js";
 import { platformMailer } from "../mail/platform-mailer.js";
 import { runInBackground } from "../background-work.js";
 import { jobsDatabase } from "./database.js";
-import { queueOptions, queueSettingsDiffer, sendOptions } from "./options.js";
+import { queueOptions, queueSettingsDiffer, sendOptions, workOptions } from "./options.js";
 import { createSchedules } from "./schedules.js";
 import { sql } from "kysely";
 import { PgBoss } from "pg-boss";
@@ -50,13 +50,7 @@ const startJobs = async ({ db, jobs, work = true, pollSeconds = 2, shutdownSecon
 		const running = workers.get(definition.name);
 		if (running?.concurrency === concurrency) return;
 		if (running) await boss.offWork(definition.name);
-		const id = await boss.work(definition.name, {
-			batchSize: 1,
-			localConcurrency: concurrency,
-			pollingIntervalSeconds: pollSeconds,
-			includeMetadata: true,
-			perJobResults: true
-		}, async ([job]) => runInBackground(async () => {
+		const id = await boss.work(definition.name, workOptions(concurrency, pollSeconds), async ([job]) => runInBackground(async () => {
 			const current = definitions.get(definition.name) ?? definition;
 			if (current.options.schedule !== void 0 && job.singletonKey === "protobase.schedule") await schedules.following(current, job.startAfter);
 			return [await runJob(current, job, db, mail)];

package/dist/mail/define-email.d.ts

@@ -10,14 +10,20 @@ export type EmailOptions<Data extends object> = {
    * It is rendered to the HTML part, and the plain-text part is made from that HTML.
    */
   component: EmailComponent<Data>;
+  /**
+   * More header fields, or how to make them from the email's data: such as `List-Unsubscribe` with the recipient's own
+   * unsubscribe link, and `List-Unsubscribe-Post: List-Unsubscribe=One-Click`, which mailbox providers expect of bulk mail.
+   */
+  headers?: Record<string, string> | ((data: Data) => Record<string, string>);
 };
 /** A function component of the email's data, as JSX writes one; typed here so the server's own types need no React. */
 export type EmailComponent<Data> = (props: Data) => unknown;
-/** An email as `render` gives it: the subject and both parts of the body. */
+/** An email as `render` gives it: the subject, both parts of the body, and its header fields when it has any. */
 export type RenderedEmail = {
   subject: string;
   html: string;
   text: string;
+  headers?: Record<string, string>;
 };
 export type EmailTemplate<Data extends object> = {
   readonly name: string;

package/dist/mail/define-email.js

@@ -18,10 +18,13 @@ const defineEmail = (options) => {
 	const render = async (data) => {
 		const renderer = await loadRenderer();
 		const html = await renderer.render(renderer.createElement(options.component, data));
+		const subject = typeof options.subject === "function" ? options.subject(data) : options.subject;
+		const headers = typeof options.headers === "function" ? options.headers(data) : options.headers;
 		return {
-			subject: typeof options.subject === "function" ? options.subject(data) : options.subject,
+			subject,
 			html,
-			text: renderer.toPlainText(html)
+			text: renderer.toPlainText(html),
+			...headers && { headers }
 		};
 	};
 	const send = async (to, data, mailer = platformMailer()) => {

package/dist/mail/email-layout.d.ts

@@ -0,0 +1,26 @@
+import { MailingApp } from "./mailing-app.js";
+import { ReactNode } from "react";
+//#region src/mail/email-layout.d.ts
+export type EmailLayoutProps = {
+  app: MailingApp;
+  /** The line inboxes show after the subject. */
+  preview: string;
+  heading: string;
+  children: ReactNode;
+};
+/** An email: its heading and body on a card, and a footer naming the app, linked to its home page. */
+export declare const EmailLayout: ({ app, preview, heading, children }: EmailLayoutProps) => import("react").JSX.Element;
+/** A code to type in, on a line of its own in both parts. */
+export declare const EmailCode: ({ code }: {
+  code: string;
+}) => import("react").JSX.Element;
+/** A remark below the message, such as what to do when the email was not expected. */
+export declare const EmailNote: ({ children }: {
+  children: ReactNode;
+}) => import("react").JSX.Element;
+/** The email's one action, such as signing in: a button, and the label with the link in the plain-text part. */
+export declare const EmailButton: ({ href, children }: {
+  href: string;
+  children: ReactNode;
+}) => import("react").JSX.Element;
+//#endregion

package/dist/{better-auth/auth-mail/auth-email-layout.js → mail/email-layout.js}

@@ -1,6 +1,6 @@
 import { Body, Button, Container, Head, Heading, Hr, Html, Link, Preview, Text } from "react-email";
 import { jsx, jsxs } from "react/jsx-runtime";
-//#region src/better-auth/auth-mail/auth-email-layout.tsx
+//#region src/mail/email-layout.tsx
 const styles = {
 	body: {
 		backgroundColor: "#f4f4f5",
@@ -39,8 +39,8 @@ const styles = {
 		fontWeight: 600
 	}
 };
-/** An auth email: its heading and body on a card, and a footer naming the app, linked to its home page. */
-const AuthEmailLayout = ({ app, preview, heading, children }) => /* @__PURE__ */ jsxs(Html, {
+/** An email: its heading and body on a card, and a footer naming the app, linked to its home page. */
+const EmailLayout = ({ app, preview, heading, children }) => /* @__PURE__ */ jsxs(Html, {
 	lang: "en",
 	children: [
 		/* @__PURE__ */ jsx(Head, {}),
@@ -87,4 +87,4 @@ const EmailButton = ({ href, children }) => /* @__PURE__ */ jsx(Button, {
 	children
 });
 //#endregion
-export { AuthEmailLayout, EmailButton, EmailCode, EmailNote };
+export { EmailButton, EmailCode, EmailLayout, EmailNote };

package/dist/mail/mailing-app.d.ts

@@ -0,0 +1,7 @@
+//#region src/mail/mailing-app.d.ts
+/** The app an email comes from: its name, and its home page on the origin the request came to. */
+export type MailingApp = {
+  name: string;
+  url: string;
+};
+//#endregion

package/dist/{better-auth/auth-mail → mail}/mailing-app.js

@@ -1,4 +1,4 @@
-//#region src/better-auth/auth-mail/mailing-app.ts
+//#region src/mail/mailing-app.ts
 /**
 * The app as an auth email names it: `appName`, and the home page on the origin of `requestURL`, a URL on the origin
 * the request came to (such as Better Auth's `ctx.context.baseURL`), or on `baseURL`'s origin without one.

package/dist/mail/smtp-mailer.d.ts

@@ -6,6 +6,11 @@ export type MailMessage = {
   text: string;
   /** The HTML body, sent beside `text` as the alternative clients show when they can. */
   html?: string;
+  /**
+   * More header fields by name, such as `List-Unsubscribe` and `List-Unsubscribe-Post`, which mailbox providers expect
+   * of bulk mail. A value is one line.
+   */
+  headers?: Record<string, string>;
 };
 /** Sends one message; rejects when the server refuses it. */
 export type Mailer = {

package/dist/mail/smtp-mailer.js

@@ -10,6 +10,7 @@
 const smtpMailer = (settings) => {
 	let transport;
 	return { send: async (message) => {
+		checkHeaders(message.headers);
 		transport ??= import("nodemailer").then(({ createTransport }) => createTransport({
 			url: settings.smtpUrl,
 			name: senderDomain(settings.from)
@@ -26,5 +27,11 @@ const sender = ({ from, name }) => name ? {
 } : from;
 /** The domain of a sender address `readMailSettings` accepted, so always a dotted hostname. */
 const senderDomain = (from) => from.slice(from.lastIndexOf("@") + 1);
+const checkHeaders = (headers = {}) => {
+	for (const [name, value] of Object.entries(headers)) {
+		if (!/^[!-9;-~]+$/.test(name)) throw new Error(`Mail header name "${name}" is not a valid header field name`);
+		if (/[\r\n]/.test(value)) throw new Error(`Mail header ${name} has a line break; a header value is one line`);
+	}
+};
 //#endregion
 export { smtpMailer };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protobase/server",
-  "version": "0.23.8",
+  "version": "0.23.10",
   "description": "The Protobase REST API as a Hono app, with Better Auth sign-in.",
   "license": "Apache-2.0",
   "repository": {
@@ -15,7 +15,8 @@
     "node": ">=22.12.0"
   },
   "exports": {
-    ".": "./dist/index.js"
+    ".": "./dist/index.js",
+    "./email": "./dist/email.js"
   },
   "types": "./dist/index.d.ts",
   "files": [
@@ -31,9 +32,9 @@
   "dependencies": {
     "@better-auth/passkey": "^1.7.7",
     "@better-auth/sso": "^1.7.7",
-    "@protobase/layout": "0.23.8",
-    "@protobase/query": "0.23.8",
-    "@protobase/schema": "0.23.8",
+    "@protobase/layout": "0.23.10",
+    "@protobase/query": "0.23.10",
+    "@protobase/schema": "0.23.10",
     "@react-email/render": "^2.1.0",
     "@scalar/hono-api-reference": "^0.12.10",
     "@sentry/core": "^11.7.0",