@beechcms/api 0.6.0-preview.2 → 0.6.0-preview.3

package/dist/features/email/providers/resend.d.ts

@@ -0,0 +1,36 @@
+import type { EmailProvider } from '../email.provider';
+import type { OutboundEmail } from '../email.types';
+/**
+ * Resend implementation of EmailProvider.
+ *
+ * This is the ONLY file in the email module that knows about Resend.
+ * Every other file is completely unaware of which provider is active.
+ *
+ * ─── HOW TO REPLACE THIS PROVIDER ──────────────────────────────────────────
+ *  1. Create a new file in `providers/` (e.g., `providers/sendgrid.ts`).
+ *  2. Export a class that implements `EmailProvider` (a single method: `send`).
+ *  3. In `email.service.ts`, replace `new ResendEmailProvider(...)` with
+ *     your new class in the `createProvider()` function.
+ *  4. Update the environment variables in `types.ts` and `wrangler.jsonc`.
+ *  5. No other file in the project needs to be modified.
+ *
+ * Resend API Documentation: https://resend.com/docs/api-reference/emails/send-email
+ * ─────────────────────────────────────────────────────────────────────────────
+ */
+export declare class ResendEmailProvider implements EmailProvider {
+    private readonly apiKey;
+    /** When `true`, errors are logged to the console (development only). */
+    private readonly isDev;
+    constructor(apiKey: string, isDev?: boolean);
+    /**
+     * Sends the email via the Resend REST API (`POST /emails`).
+     *
+     * Throws an exception if Resend responds with a non-2xx status, so that
+     * the caller (`email.service.ts`) can decide whether to propagate the error
+     * or handle it silently (fire-and-forget).
+     *
+     * The response body is read for logging only in the development environment,
+     * to avoid unnecessarily consuming the body stream in production.
+     */
+    send(email: OutboundEmail): Promise<void>;
+}

package/dist/features/email/providers/smtp.d.ts

@@ -0,0 +1,11 @@
+import type { EmailProvider } from '../email.provider';
+import type { OutboundEmail } from '../email.types';
+export interface SmtpProviderConfig {
+    /** Base URL of the Mailpit HTTP API, e.g. http://localhost:8025 */
+    baseUrl: string;
+}
+export declare class SmtpEmailProvider implements EmailProvider {
+    private readonly endpoint;
+    constructor(config: SmtpProviderConfig);
+    send(email: OutboundEmail): Promise<void>;
+}

package/dist/features/email/templates/automation-mail.d.ts

@@ -0,0 +1,8 @@
+import type { AutomationMailParams } from '../email.types';
+/** Identity builder: automation payloads are already user-authored. */
+export declare function buildAutomationEmail(params: AutomationMailParams): {
+    to: string;
+    subject: string;
+    html: string;
+    text: string;
+};

package/dist/features/email/templates/password-changed.d.ts

@@ -0,0 +1,15 @@
+import type { EmailLocale } from '../email.types';
+/**
+ * Builds the "password changed" notification email.
+ *
+ * This email does not have a CTA button — it is a pure security notification.
+ * The `warning` block (red text) warns the user to take action if they
+ * were not the one who changed the password.
+ *
+ * @param locale - Language for the email subject and body.
+ * @returns Object with `subject` (string) and `html` (complete HTML document).
+ */
+export declare function buildPasswordChangedEmail(locale: EmailLocale): {
+    subject: string;
+    html: string;
+};

package/dist/features/email/templates/password-reset.d.ts

@@ -0,0 +1,18 @@
+import type { EmailLocale } from '../email.types';
+/**
+ * Builds the email with the password reset link.
+ *
+ * Composes the localized content with the base layout (`buildEmailShell`)
+ * injecting the CTA button pointing to the reset URL.
+ *
+ * @param resetUrl - Complete URL with the token in plain text, e.g.
+ *                   `https://dashboard.beechcms.dev/reset-password?token=<uuid>`.
+ *                   It is directly embedded in the CTA button — do not sanitize
+ *                   further: the token is an internally generated UUID.
+ * @param locale   - Language for the email subject and body.
+ * @returns Object with `subject` (string) and `html` (complete HTML document).
+ */
+export declare function buildPasswordResetEmail(resetUrl: string, locale: EmailLocale): {
+    subject: string;
+    html: string;
+};

package/dist/features/email/templates/shell.d.ts

@@ -0,0 +1,58 @@
+import type { EmailLocale } from '../email.types';
+/**
+ * Content slots that every template must provide to compose a complete email.
+ * Each slot corresponds to a visual block in the email card layout.
+ */
+export interface EmailShellSlots {
+    /**
+     * H2 heading shown at the top of the card. Keep it under ~50 characters
+     * to ensure good readability on mobile clients.
+     */
+    title: string;
+    /**
+     * Main body text. Rendered as a paragraph.
+     * Safe inline HTML is allowed (e.g., `<strong>`, `<a href="...">`),
+     * but avoid block elements (`<p>`, `<div>`) that could break
+     * the layout structure in rigid email clients (Outlook, Gmail).
+     */
+    body: string;
+    /**
+     * Optional call-to-action button, rendered as a dark link-button.
+     * Omit for notification-only emails that do not require user action.
+     */
+    cta?: {
+        label: string;
+        href: string;
+    };
+    /**
+     * Optional warning paragraph. Rendered in red (#ef4444) to attract
+     * attention. Use it for security alerts
+     * ("if it wasn't you, act immediately").
+     */
+    warning?: string;
+    /**
+     * Small gray text at the bottom of the card.
+     * Used for notes like "automated notification, do not reply".
+     */
+    footer: string;
+}
+/**
+ * Builds the base HTML layout shared by all Beech CMS transactional emails.
+ *
+ * ─── SINGLE SOURCE OF TRUTH FOR BRANDING ─────────────────────────────────────
+ * Modifying this function changes the visual appearance of ALL outgoing emails
+ * simultaneously:
+ *   - background and card color
+ *   - border style and border-radius
+ *   - typographic scale and spacing
+ *   - CTA button style
+ *
+ * To change the text or structure of a specific email, instead modify
+ * the corresponding template file (`templates/password-reset.ts`, etc.).
+ * ─────────────────────────────────────────────────────────────────────────────
+ *
+ * @param locale - Used for the `lang` attribute of the `<html>` tag.
+ * @param slots  - Content blocks injected into the layout.
+ * @returns A complete and self-contained HTML document ready to be sent.
+ */
+export declare function buildEmailShell(locale: EmailLocale, slots: EmailShellSlots): string;

package/dist/features/notifications/index.d.ts

@@ -0,0 +1 @@
+export { notificationsApp } from './notifications.handler';

package/dist/features/notifications/notifications.handler.d.ts

@@ -0,0 +1,15 @@
+import { Hono } from 'hono';
+import type { Env, Variables } from '../../types';
+/**
+ * Notifications Feature Handler.
+ *
+ * Manages retrieval, mark read/unread, and deletion of system notifications.
+ * All persistence goes through the {@link INotificationRepository} injected
+ * by `repositoryMiddleware`. The handler owns the HTTP concerns only:
+ * ETag negotiation, status codes, error mapping.
+ */
+declare const notificationsApp: Hono<{
+    Bindings: Env;
+    Variables: Variables;
+}, import("hono/types").BlankSchema, "/">;
+export { notificationsApp };

package/dist/features/password-reset/index.d.ts

@@ -0,0 +1,6 @@
+import { Hono } from 'hono';
+import type { Env, Variables } from '../../types';
+export declare const passwordResetApp: Hono<{
+    Bindings: Env;
+    Variables: Variables;
+}, import("hono/types").BlankSchema, "/">;

package/dist/features/password-reset/request.d.ts

@@ -0,0 +1,10 @@
+import type { Context } from 'hono';
+import type { Env, Variables } from '../../types';
+/**
+ * Handles the password reset request.
+ * Generates a reset token, stores its hash in the database, and sends an email to the user.
+ */
+export declare function requestPasswordReset(context: Context<{
+    Bindings: Env;
+    Variables: Variables;
+}>): Promise<Response>;

package/dist/features/password-reset/reset.d.ts

@@ -0,0 +1,9 @@
+import type { Context } from 'hono';
+import type { Env, Variables } from '../../types';
+/**
+ * Handles the actual password reset process using a valid token.
+ */
+export declare function resetPassword(context: Context<{
+    Bindings: Env;
+    Variables: Variables;
+}>): Promise<Response>;

package/dist/features/rotate-field/index.d.ts

@@ -0,0 +1 @@
+export { rotateFieldApp } from './rotate-field.handler';

package/dist/features/rotate-field/rotate-field.handler.d.ts

@@ -0,0 +1,7 @@
+import { Hono } from 'hono';
+import type { Env, Variables } from '../../types';
+declare const rotateFieldApp: Hono<{
+    Bindings: Env;
+    Variables: Variables;
+}, import("hono/types").BlankSchema, "/">;
+export { rotateFieldApp };

package/dist/features/rotate-field/rotate-field.schema.d.ts

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+/**
+ * Schema for rotating a hashed field value.
+ * Used to update fields that have 'hash' privacy (e.g., passwords, PINs).
+ */
+export declare const rotateFieldRequestSchema: z.ZodObject<{
+    fieldAlias: z.ZodString;
+    currentValue: z.ZodString;
+    nextValue: z.ZodString;
+}, z.core.$strip>;
+export type RotateFieldRequest = z.infer<typeof rotateFieldRequestSchema>;

package/dist/features/schema/schema.handler.d.ts

@@ -0,0 +1,7 @@
+import { Hono } from 'hono';
+import type { Env, Variables } from '../../types';
+declare const schemaApp: Hono<{
+    Bindings: Env;
+    Variables: Variables;
+}, import("hono/types").BlankSchema, "/">;
+export { schemaApp };

package/dist/features/seeds/index.d.ts

@@ -0,0 +1 @@
+export { seedsApp } from './seeds.handler';

package/dist/features/seeds/seeds.handler.d.ts

@@ -0,0 +1,6 @@
+import { Hono } from 'hono';
+import type { Env, Variables } from '../../types';
+export declare const seedsApp: Hono<{
+    Bindings: Env;
+    Variables: Variables;
+}, import("hono/types").BlankSchema, "/">;

package/dist/features/settings/settings.handler.d.ts

@@ -0,0 +1,7 @@
+import { Hono } from 'hono';
+import type { Env, Variables } from '../../types';
+declare const settingsApp: Hono<{
+    Bindings: Env;
+    Variables: Variables;
+}, import("hono/types").BlankSchema, "/">;
+export { settingsApp };

package/dist/features/setup/index.d.ts

@@ -0,0 +1,7 @@
+import { Hono } from 'hono';
+import type { Env, Variables } from '../../types';
+declare const setupApp: Hono<{
+    Bindings: Env;
+    Variables: Variables;
+}, import("hono/types").BlankSchema, "/">;
+export { setupApp };

package/dist/features/stats/index.d.ts

@@ -0,0 +1 @@
+export { statsApp } from './stats.handler';

package/dist/features/stats/stats.handler.d.ts

@@ -0,0 +1,7 @@
+import { Hono } from 'hono';
+import type { Env, Variables } from '../../types';
+declare const statsApp: Hono<{
+    Bindings: Env;
+    Variables: Variables;
+}, import("hono/types").BlankSchema, "/">;
+export { statsApp };

package/dist/features/webhooks/index.d.ts

@@ -0,0 +1,3 @@
+import { Hono } from 'hono';
+import type { AppEnv } from '../../types';
+export declare const webhooksApp: Hono<AppEnv, import("hono/types").BlankSchema, "/">;

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+import type { Env } from './types';
+declare const _default: {
+    fetch(request: Request, env: Env, ctx: ExecutionContext): Response | Promise<Response>;
+    scheduled(controller: ScheduledController, env: Env, ctx: ExecutionContext): Promise<void>;
+};
+export default _default;