@beechcms/api 0.6.3 → 0.6.5

package/dist/shared/email/email.types.d.ts

@@ -1,79 +0,0 @@
-/**
- * Shared types for the Beech CMS email module.
- *
- * All types used across provider, service, and templates are defined here
- * so that each layer remains decoupled from the others.
- */
-/**
- * Supported languages for the email template system.
- *
- * To add a new language:
- *  1. Add the ISO code here (e.g., `'fr'`).
- *  2. Add the corresponding translation in the `COPY` object of every
- *     file in `templates/`. TypeScript will flag missing keys.
- */
-export declare const SUPPORTED_EMAIL_LOCALES: readonly ['en', 'it'];
-export type EmailLocale = (typeof SUPPORTED_EMAIL_LOCALES)[number];
-/**
- * Resolves an unverified locale string (e.g., from a request body)
- * to a supported `EmailLocale` value. Any unknown value
- * safely falls back to `'en'`.
- *
- * @param raw - Raw value from the client (can be anything).
- * @returns A valid `EmailLocale`, always.
- */
-export declare function resolveEmailLocale(raw: unknown): EmailLocale;
-/**
- * Shared parameters for every email sending function in `email.service.ts`.
- * Specific functions extend this type with the additional fields
- * required for their respective templates.
- */
-export interface BaseEmailParams {
-    /** Main recipient address. */
-    to: string;
-    /** Email body language. Use `resolveEmailLocale()` before passing it here. */
-    locale: EmailLocale;
-    /**
-     * Resend API key (or the active provider's key). Must be non-empty —
-     * the caller is responsible for validating it before invoking the service.
-     */
-    apiKey: string;
-    /**
-     * Sender address in RFC 5321 format.
-     * Default: "Beech CMS <onboarding@resend.dev>" (Resend test sender).
-     * In production, set a verified address via the
-     * `EMAIL_FROM` environment variable.
-     */
-    from?: string;
-    /**
-     * When `true`, provider errors are logged to the console.
-     * Set to `false` in production to avoid exposing internal details.
-     */
-    isDev?: boolean;
-}
-/** Parameters for the password reset email — adds the reset URL. */
-export interface PasswordResetEmailParams extends BaseEmailParams {
-    /**
-     * Complete URL that the user clicks to set the new password.
-     * Contains the token in plain text as a query param `?token=<uuid>`.
-     * Constructed by the caller as `${APP_URL}/reset-password?token=${token}`.
-     */
-    resetUrl: string;
-    provider?: 'smtp' | 'resend';
-    smtpBaseUrl?: string;
-}
-/** Parameters for the "password changed" notification. No additional fields. */
-export interface PasswordChangedEmailParams extends BaseEmailParams {
-    provider?: 'smtp' | 'resend';
-    smtpBaseUrl?: string;
-}
-export interface AutomationMailParams {
-    to: string;
-    subject: string;
-    /** Plain text or HTML — passed verbatim to provider. */
-    body: string;
-    apiKey?: string;
-    from?: string;
-    provider?: 'smtp' | 'resend';
-    smtpBaseUrl?: string;
-}

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

@@ -1,7 +0,0 @@
-import type { AutomationMailParams } from '../email.types';
-export declare function buildAutomationEmail(params: AutomationMailParams): {
-    to: string;
-    subject: string;
-    html: string;
-    text: string;
-};

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

@@ -1,15 +0,0 @@
-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/shared/email/templates/password-reset.d.ts

@@ -1,18 +0,0 @@
-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/shared/email/templates/shell.d.ts

@@ -1,58 +0,0 @@
-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/shared/in-memory-queue-service.d.ts

@@ -1,16 +0,0 @@
-import type { IQueueService, JobRegistry, JobContext } from '@beechcms/core';
-type ScheduleBackgroundTask = (task: Promise<unknown>) => void;
-/**
- * Dev/offline + test fallback used when the QUEUE binding is absent. Runs the
- * matching handler in-process. In production this is never selected. Uses
- * executionCtx.waitUntil when available so enqueue stays non-blocking; falls
- * back to awaiting inline (tests) otherwise.
- */
-export declare class InMemoryQueueService implements IQueueService {
-    private readonly jobs;
-    private readonly context;
-    private readonly scheduleBackgroundTask?;
-    constructor(jobs: JobRegistry, context: JobContext, scheduleBackgroundTask?: ScheduleBackgroundTask | undefined);
-    enqueue<T>(name: string, payload: T): Promise<void>;
-}
-export {};

package/dist/shared/jobs/fts-sync.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/shared/queue-consumer.d.ts

@@ -1,9 +0,0 @@
-import type { JobRegistry, QueueMessage } from '@beechcms/core';
-import type { Env } from '../types';
-/**
- * Consumer-side dispatch. Mirrors index.ts `scheduled()`: builds an
- * engine-mediated JobContext from bindings (NEVER exposes env.DB to jobs) and
- * routes each message to its handler. ack() on success/unknown-name (drop),
- * retry() on throw so Cloudflare re-delivers.
- */
-export declare function dispatchQueueBatch(batch: MessageBatch<QueueMessage>, env: Env, _ctx: ExecutionContext, jobs: JobRegistry): Promise<void>;

package/dist/shared/storage/upload.d.ts

@@ -1,7 +0,0 @@
-export declare function deleteR2Objects(c: {
-    var: {
-        bucket: any;
-        mediaRepository: any;
-        systemStatsRepository: any;
-    };
-}, objectKeys: string[]): Promise<void>;

package/dist/shared/utils/request-utils.d.ts

@@ -1,13 +0,0 @@
-import type { HonoRequest } from "hono";
-/**
- * Extracts the real client IP address from a Cloudflare Worker request.
- *
- * Cloudflare injects the cf-connecting-ip header on every request that
- * passes through the edge. In local development (wrangler dev) or in
- * unit tests the header may be absent, in which case the string "unknown"
- * is returned so that rate-limiter keys remain non-empty and safe to use.
- *
- * Never derive security decisions from this value alone; treat it as a
- * best-effort hint for rate-limiting and logging purposes only.
- */
-export declare function getClientIp(request: HonoRequest): string;

package/dist/shared/utils/storage-utils.d.ts

@@ -1,7 +0,0 @@
-import { S3Client } from '@aws-sdk/client-s3';
-/**
- * Calcola la dimensione totale occupata in un bucket R2 (in byte).
- * Nota: esegue una scansione completa del bucket. Per bucket molto grandi
- * andrebbe implementata una cache o usato Cloudflare Logpush/Analytics.
- */
-export declare function getBucketSize(client: S3Client, bucketName: string): Promise<number>;