@push.rocks/smartjmap 1.0.0 → 2.0.0

package/dist_ts/classes.memorymailbackend.d.ts

@@ -0,0 +1,109 @@
+import type { IJmapEmailAddress } from './classes.jmapclient.js';
+import { type IJmapAccountInfo, type IJmapBlobRecord, type IJmapChanges, type IJmapEmailQueryOptions, type IJmapEmailQueryResult, type IJmapEmailRecord, type IJmapEmailSetRequest, type IJmapEmailSetResult, type IJmapEnvelope, type IJmapGetResult, type IJmapIdentityRecord, type IJmapMailBackend, type IJmapMailboxRecord, type IJmapSubmissionInput, type IJmapSubmissionRecord, type IJmapThreadRecord, type TJmapChangeListener, type TJmapPrincipal } from './interfaces.backend.js';
+/** A change-log entry: which ids changed at which numeric state. */
+export interface IMemoryChangeEntry {
+    state: number;
+    created: string[];
+    updated: string[];
+    destroyed: string[];
+}
+/** Base mailbox fields stored in memory; counters are computed on read. */
+export interface IMemoryMailbox {
+    id: string;
+    name: string;
+    role: string | null;
+    parentId: string | null;
+    sortOrder: number;
+}
+/** A stored submission, including the envelope and raw payload for inspection. */
+export interface IMemorySubmission extends IJmapSubmissionRecord {
+    envelope: IJmapEnvelope;
+    message: Uint8Array;
+}
+/** The in-memory per-account store, exposed publicly for test assertions. */
+export interface IMemoryMailAccount {
+    username: string;
+    accountId: string;
+    mailboxes: Map<string, IMemoryMailbox>;
+    emails: Map<string, IJmapEmailRecord>;
+    blobs: Map<string, IJmapBlobRecord>;
+    submissions: Map<string, IMemorySubmission>;
+    identities: IJmapIdentityRecord[];
+    emailState: number;
+    emailChanges: IMemoryChangeEntry[];
+    mailboxState: number;
+    mailboxChanges: IMemoryChangeEntry[];
+    threadIdsBySubject: Map<string, string>;
+    idCounter: number;
+}
+/** Seeding input for `addEmail`: a convenience superset of an Email create. */
+export interface IMemoryEmailInput {
+    from: IJmapEmailAddress | IJmapEmailAddress[];
+    to: IJmapEmailAddress | IJmapEmailAddress[];
+    cc?: IJmapEmailAddress[];
+    bcc?: IJmapEmailAddress[];
+    subject?: string;
+    textBody?: string;
+    htmlBody?: string;
+    keywords?: Record<string, boolean>;
+    receivedAt?: string;
+    attachments?: Array<{
+        name: string;
+        type: string;
+        content: string | Uint8Array;
+    }>;
+}
+/**
+ * The in-memory reference implementation of `IJmapMailBackend`, used as the
+ * default backend of `JmapServer` for offline testing. Accounts are keyed by
+ * username (accountId = `account_<username>`) and auto-created on first
+ * reference. Seeding helpers: `addAccount`, `createMailbox`, `addEmail`.
+ *
+ * Documented simplifications: thread ids derive from normalized subjects (not
+ * References headers), raw RFC 5322 blobs render headers + the text body only
+ * (attachments are separate blobs, not MIME-encoded into the raw message),
+ * the change log grows unboundedly (one entry per mutation), and destroyed
+ * emails leave their blobs in the blob store.
+ */
+export declare class MemoryMailBackend implements IJmapMailBackend {
+    accounts: Map<string, IMemoryMailAccount>;
+    private changeListeners;
+    /** Ensures an account exists for the username and returns it. */
+    addAccount(username: string): IMemoryMailAccount;
+    /** Creates a mailbox (name must be unique per account). Returns the mailbox id. */
+    createMailbox(username: string, name: string, role?: string): string;
+    /**
+     * Seeds an email into a mailbox (matched by name or role), bumps the Email
+     * state, and notifies change listeners — connected JmapServers turn this
+     * into a StateChange push. Returns the email id.
+     */
+    addEmail(username: string, mailboxName: string, input: IMemoryEmailInput): string;
+    resolveAccount(principal: TJmapPrincipal): Promise<IJmapAccountInfo | null>;
+    getMailboxes(accountId: string, ids: string[] | null): Promise<IJmapGetResult<IJmapMailboxRecord>>;
+    getMailboxChanges(accountId: string, sinceState: string, maxChanges?: number): Promise<IJmapChanges | null>;
+    getEmails(accountId: string, ids: string[], _properties?: string[] | null): Promise<IJmapGetResult<IJmapEmailRecord>>;
+    queryEmails(accountId: string, options: IJmapEmailQueryOptions): Promise<IJmapEmailQueryResult>;
+    getEmailChanges(accountId: string, sinceState: string, maxChanges?: number): Promise<IJmapChanges | null>;
+    setEmails(accountId: string, request: IJmapEmailSetRequest): Promise<IJmapEmailSetResult>;
+    getThreads(accountId: string, ids: string[]): Promise<IJmapGetResult<IJmapThreadRecord>>;
+    uploadBlob(accountId: string, data: Uint8Array, type: string): Promise<{
+        blobId: string;
+        size: number;
+    }>;
+    getBlob(accountId: string, blobId: string): Promise<IJmapBlobRecord | null>;
+    getIdentities(accountId: string): Promise<IJmapGetResult<IJmapIdentityRecord>>;
+    submitEmail(accountId: string, submission: IJmapSubmissionInput): Promise<IJmapSubmissionRecord>;
+    subscribeToChanges(listener: TJmapChangeListener): () => void;
+    private ensureAccount;
+    private requireAccountById;
+    private matchesFilter;
+    /** Builds a full email record from a validated create spec. Throws JmapBackendError. */
+    private buildEmailRecord;
+    /** Applies a normalized email update in place. Throws JmapBackendError. */
+    private applyEmailUpdate;
+    private resolveThreadId;
+    private collectChanges;
+    private bumpEmailState;
+    private emitChange;
+    private toSetError;
+}