ysk-server-core 1.0.0

package/dist/email/service.d.ts

@@ -0,0 +1,211 @@
+/**
+ * Email domain management: real DKIM keygen + durable checklist/health + mailboxes.
+ */
+import type { EmailDnsRecord, EmailExternalTodo, EmailHealthReport } from 'ysk-server-shared';
+import { planEmailStackInstall, planTestSend } from './dns-records.js';
+import type { YskDatabase } from '../db/database.js';
+import type { AuditRepository } from '../repositories/audit-repo.js';
+import type { HostExecutor } from '../host/executor.js';
+export interface EmailDomainRecord {
+    id: string;
+    domain: string;
+    server_ip: string;
+    /** Optional public IPv6 for AAAA / SPF ip6: */
+    server_ipv6?: string;
+    mail_hostname: string;
+    dkim_selector: string;
+    dkim_public_key: string;
+    dkim_private_key: string;
+    dns_applied: boolean;
+    dmarc_present: boolean;
+    ptr_ok: boolean;
+    port25_open: boolean | null;
+    health_score: number;
+    created_at: string;
+    updated_at: string;
+}
+export declare class EmailService {
+    private readonly db;
+    private readonly host;
+    private readonly audit?;
+    /** When set, mailbox provision writes Maildir + virtual maps under dataDir */
+    private readonly dataDir?;
+    constructor(db: YskDatabase, host: HostExecutor, audit?: AuditRepository | undefined, 
+    /** When set, mailbox provision writes Maildir + virtual maps under dataDir */
+    dataDir?: string | undefined);
+    list(): EmailDomainRecord[];
+    get(id: string): EmailDomainRecord;
+    /**
+     * Create domain with real RSA DKIM keypair and initial health score.
+     */
+    create(input: {
+        domain: string;
+        serverIp: string;
+        serverIpv6?: string;
+        mailHostname?: string;
+        actor: string;
+    }): {
+        domain: EmailDomainRecord;
+        records: EmailDnsRecord[];
+        externalTodos: EmailExternalTodo[];
+        health: EmailHealthReport;
+        installPlan: ReturnType<typeof planEmailStackInstall>;
+    };
+    /**
+     * Delete email domain — same safety model as project delete:
+     * require confirmName === domain; optional removeData (dataDir/email/{domain}).
+     * Does not claim system Postfix/Dovecot maps were cleaned.
+     */
+    deleteDomain(id: string, actor: string, opts?: {
+        confirmName?: string;
+        removeData?: boolean;
+    }): {
+        ok: boolean;
+        domain: string;
+        removedMailboxes: number;
+        removedAliases: number;
+        notes: string[];
+        written: string[];
+        warnings?: string[];
+    };
+    /**
+     * Update external checklist flags and recompute health.
+     */
+    updateChecks(id: string, checks: Partial<{
+        dnsApplied: boolean;
+        dmarcPresent: boolean;
+        ptrOk: boolean;
+        port25Open: boolean | null;
+    }>, actor: string): {
+        domain: EmailDomainRecord;
+        health: EmailHealthReport;
+    };
+    getDnsBundle(id: string): {
+        records: EmailDnsRecord[];
+        externalTodos: EmailExternalTodo[];
+        health: EmailHealthReport;
+    };
+    /**
+     * Provision mailbox: always write managed Maildir + virtual maps under dataDir when available.
+     * Optional system vmail user when root + YSK_EXECUTE + provisionSystem.
+     * Never fakes system provision success.
+     */
+    createMailbox(domainId: string, input: {
+        localPart: string;
+        actor: string;
+        /** Panel user for package quota ownership */
+        actorUserId?: string;
+        password?: string;
+        /** Attempt system useradd under vmail (needs root + EXECUTE) */
+        provisionSystem?: boolean;
+    }): Promise<{
+        ok: boolean;
+        mailbox: Record<string, unknown>;
+        notes: string[];
+        written: string[];
+        requiresExecute: boolean;
+        requiresRoot: boolean;
+        commandResults: Array<{
+            argv: string[];
+            exitCode: number;
+            stderr: string;
+        }>;
+    }>;
+    listMailboxes(domainId?: string): Array<Record<string, unknown>>;
+    /**
+     * Delete one mailbox from control plane + Maildir best-effort; rewrite maps.
+     */
+    deleteMailbox(domainId: string, mailboxId: string, actor: string): Promise<{
+        ok: boolean;
+        address: string;
+        notes: string[];
+        written: string[];
+    }>;
+    /**
+     * Update mailbox password and/or status; refresh Dovecot passdb when dataDir present.
+     * Status `disabled` forces passdb password to `*` (login denied) while keeping stored hash.
+     */
+    updateMailbox(domainId: string, mailboxId: string, input: {
+        actor: string;
+        /** New password (min 8 chars). Omit or empty to keep current. */
+        password?: string;
+        /** Login status: active (allow) or disabled (block). */
+        status?: 'active' | 'disabled';
+    }): Promise<{
+        ok: boolean;
+        mailbox: Record<string, unknown>;
+        notes: string[];
+        written: string[];
+    }>;
+    /**
+     * Alias / forward / catch-all entries for a domain.
+     * type=catchall uses local_part="*" → virtual_alias `@domain dest`
+     */
+    listAliases(domainId: string): Array<Record<string, unknown>>;
+    createAlias(domainId: string, input: {
+        type: 'alias' | 'forward' | 'catchall';
+        /** ignored for catchall */
+        localPart?: string;
+        destinations: string[];
+        actor: string;
+    }): {
+        ok: boolean;
+        alias: Record<string, unknown>;
+        notes: string[];
+        written: string[];
+    };
+    deleteAlias(domainId: string, aliasId: string, actor: string): {
+        ok: boolean;
+        notes: string[];
+        written: string[];
+    };
+    /**
+     * Catch-all / autoreply / suspend flags on domain record.
+     * Always writes control-plane + dataDir artifacts.
+     * When applySystem=true: attempt Postfix suspend map + Dovecot sieve (EXECUTE+root).
+     * Never pretends applied without successful host commands.
+     */
+    updateDomainMailFlags(domainId: string, patch: {
+        catchallAddress?: string | null;
+        autoreplyEnabled?: boolean;
+        autoreplySubject?: string;
+        autoreplyBody?: string;
+        rateLimitPerHour?: number | null;
+        antispam?: boolean;
+        suspended?: boolean;
+        /** Attempt live Postfix/Dovecot apply */
+        applySystem?: boolean;
+    }, actor: string): Promise<{
+        domain: EmailDomainRecord;
+        ok: boolean;
+        notes: string[];
+        written: string[];
+        apply_status: 'written' | 'applied' | 'partial' | 'blocked';
+        blocked?: boolean;
+        blockMessage?: string;
+        commandResults?: Array<{
+            argv: string[];
+            exitCode: number;
+            stderr: string;
+        }>;
+    }>;
+    private rewriteVirtualAliasMap;
+    markApplyStatus(domainId: string, status: {
+        ok: boolean;
+        notes?: string[];
+        serviceStatus?: Record<string, string>;
+    }): void;
+    /**
+     * Attempt real test send via sendmail if available; otherwise structured failure.
+     */
+    testSend(id: string, input: {
+        from: string;
+        to: string;
+        subject?: string;
+    }, actor: string): Promise<{
+        ok: boolean;
+        plan: ReturnType<typeof planTestSend>;
+        result?: unknown;
+    }>;
+}
+//# sourceMappingURL=service.d.ts.map

package/dist/email/service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../src/email/service.ts"],"names":[],"mappings":"AAAA;;GAEG;AAKH,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAE9F,OAAO,EAEL,qBAAqB,EACrB,YAAY,EACM,MAAM,kBAAkB,CAAC;AAC7C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AACrE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAGxD,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,+CAA+C;IAC/C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,MAAM,CAAC;IACxB,gBAAgB,EAAE,MAAM,CAAC;IACzB,WAAW,EAAE,OAAO,CAAC;IACrB,aAAa,EAAE,OAAO,CAAC;IACvB,MAAM,EAAE,OAAO,CAAC;IAChB,WAAW,EAAE,OAAO,GAAG,IAAI,CAAC;IAC5B,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,qBAAa,YAAY;IAErB,OAAO,CAAC,QAAQ,CAAC,EAAE;IACnB,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC;IACvB,8EAA8E;IAC9E,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;gBAJR,EAAE,EAAE,WAAW,EACf,IAAI,EAAE,YAAY,EAClB,KAAK,CAAC,EAAE,eAAe,YAAA;IACxC,8EAA8E;IAC7D,OAAO,CAAC,EAAE,MAAM,YAAA;IAGnC,IAAI,IAAI,iBAAiB,EAAE;IAI3B,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,iBAAiB;IAQlC;;OAEG;IACH,MAAM,CAAC,KAAK,EAAE;QACZ,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,MAAM,CAAC;QACjB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,KAAK,EAAE,MAAM,CAAC;KACf,GAAG;QACF,MAAM,EAAE,iBAAiB,CAAC;QAC1B,OAAO,EAAE,cAAc,EAAE,CAAC;QAC1B,aAAa,EAAE,iBAAiB,EAAE,CAAC;QACnC,MAAM,EAAE,iBAAiB,CAAC;QAC1B,WAAW,EAAE,UAAU,CAAC,OAAO,qBAAqB,CAAC,CAAC;KACvD;IA8DD;;;;OAIG;IACH,YAAY,CACV,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,MAAM,EACb,IAAI,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,OAAO,CAAA;KAAE,GACpD;QACD,EAAE,EAAE,OAAO,CAAC;QACZ,MAAM,EAAE,MAAM,CAAC;QACf,gBAAgB,EAAE,MAAM,CAAC;QACzB,cAAc,EAAE,MAAM,CAAC;QACvB,KAAK,EAAE,MAAM,EAAE,CAAC;QAChB,OAAO,EAAE,MAAM,EAAE,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;KACrB;IAiGD;;OAEG;IACH,YAAY,CACV,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,OAAO,CAAC;QACd,UAAU,EAAE,OAAO,CAAC;QACpB,YAAY,EAAE,OAAO,CAAC;QACtB,KAAK,EAAE,OAAO,CAAC;QACf,UAAU,EAAE,OAAO,GAAG,IAAI,CAAC;KAC5B,CAAC,EACF,KAAK,EAAE,MAAM,GACZ;QAAE,MAAM,EAAE,iBAAiB,CAAC;QAAC,MAAM,EAAE,iBAAiB,CAAA;KAAE;IAoC3D,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG;QACxB,OAAO,EAAE,cAAc,EAAE,CAAC;QAC1B,aAAa,EAAE,iBAAiB,EAAE,CAAC;QACnC,MAAM,EAAE,iBAAiB,CAAC;KAC3B;IAwBD;;;;OAIG;IACG,aAAa,CACjB,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE;QACL,SAAS,EAAE,MAAM,CAAC;QAClB,KAAK,EAAE,MAAM,CAAC;QACd,6CAA6C;QAC7C,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,gEAAgE;QAChE,eAAe,CAAC,EAAE,OAAO,CAAC;KAC3B,GACA,OAAO,CAAC;QACT,EAAE,EAAE,OAAO,CAAC;QACZ,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACjC,KAAK,EAAE,MAAM,EAAE,CAAC;QAChB,OAAO,EAAE,MAAM,EAAE,CAAC;QAClB,eAAe,EAAE,OAAO,CAAC;QACzB,YAAY,EAAE,OAAO,CAAC;QACtB,cAAc,EAAE,KAAK,CAAC;YAAE,IAAI,EAAE,MAAM,EAAE,CAAC;YAAC,QAAQ,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;KAC7E,CAAC;IAwMF,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAYhE;;OAEG;IACG,aAAa,CACjB,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC;QACT,EAAE,EAAE,OAAO,CAAC;QACZ,OAAO,EAAE,MAAM,CAAC;QAChB,KAAK,EAAE,MAAM,EAAE,CAAC;QAChB,OAAO,EAAE,MAAM,EAAE,CAAC;KACnB,CAAC;IA2FF;;;OAGG;IACG,aAAa,CACjB,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE;QACL,KAAK,EAAE,MAAM,CAAC;QACd,iEAAiE;QACjE,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,wDAAwD;QACxD,MAAM,CAAC,EAAE,QAAQ,GAAG,UAAU,CAAC;KAChC,GACA,OAAO,CAAC;QACT,EAAE,EAAE,OAAO,CAAC;QACZ,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACjC,KAAK,EAAE,MAAM,EAAE,CAAC;QAChB,OAAO,EAAE,MAAM,EAAE,CAAC;KACnB,CAAC;IA+GF;;;OAGG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAO7D,WAAW,CACT,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE;QACL,IAAI,EAAE,OAAO,GAAG,SAAS,GAAG,UAAU,CAAC;QACvC,2BAA2B;QAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,YAAY,EAAE,MAAM,EAAE,CAAC;QACvB,KAAK,EAAE,MAAM,CAAC;KACf,GACA;QAAE,EAAE,EAAE,OAAO,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAAC,KAAK,EAAE,MAAM,EAAE,CAAC;QAAC,OAAO,EAAE,MAAM,EAAE,CAAA;KAAE;IAwDtF,WAAW,CACT,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,MAAM,GACZ;QAAE,EAAE,EAAE,OAAO,CAAC;QAAC,KAAK,EAAE,MAAM,EAAE,CAAC;QAAC,OAAO,EAAE,MAAM,EAAE,CAAA;KAAE;IAqBtD;;;;;OAKG;IACG,qBAAqB,CACzB,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE;QACL,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAChC,gBAAgB,CAAC,EAAE,OAAO,CAAC;QAC3B,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACjC,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,yCAAyC;QACzC,WAAW,CAAC,EAAE,OAAO,CAAC;KACvB,EACD,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC;QACT,MAAM,EAAE,iBAAiB,CAAC;QAC1B,EAAE,EAAE,OAAO,CAAC;QACZ,KAAK,EAAE,MAAM,EAAE,CAAC;QAChB,OAAO,EAAE,MAAM,EAAE,CAAC;QAClB,YAAY,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;QAC5D,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,cAAc,CAAC,EAAE,KAAK,CAAC;YAAE,IAAI,EAAE,MAAM,EAAE,CAAC;YAAC,QAAQ,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;KAC9E,CAAC;IA+NF,OAAO,CAAC,sBAAsB;IA6B9B,eAAe,CACb,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE;QAAE,EAAE,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE,GAChF,IAAI;IAYP;;OAEG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,EACrD,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC;QAAE,EAAE,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC;CA+BrF"}