ysk-server-core 1.0.0

package/dist/email/webmail-project.d.ts

@@ -0,0 +1,194 @@
+/**
+ * Webmail as a PHP project — same delivery model as Adminer / phpMyAdmin:
+ * create PHP project → download Roundcube or SnappyMail into docRoot → goLive.
+ */
+import { type ProjectDto } from 'ysk-server-shared';
+import type { HostExecutor } from '../host/executor.js';
+import type { ProjectService } from '../hosting/project-service.js';
+import type { ProjectOpsService } from '../hosting/project-ops.js';
+export type WebmailTool = 'roundcube' | 'snappymail';
+/** Default Roundcube complete package (security line 1.7.x). Override with YSK_ROUNDCUBE_URL / YSK_ROUNDCUBE_VERSION. */
+export declare const ROUNDCUBE_VERSION: string;
+/** SnappyMail release. Override with YSK_SNAPPYMAIL_URL / YSK_SNAPPYMAIL_VERSION. */
+export declare const SNAPPYMAIL_VERSION: string;
+export declare function normalizeWebmailTool(raw: unknown): WebmailTool;
+/** Shared panel webmail project (one instance for all mail domains). */
+export declare const GLOBAL_WEBMAIL_PROJECT_NAME = "ysk-webmail";
+export declare function defaultWebmailProjectName(tool: WebmailTool, mailDomain?: string): string;
+/**
+ * Roundcube 1.6+ ships package-root index.php as a stub that tells operators to
+ * point HTTP at public_html/. The real entry is public_html/index.php with
+ * program/config as siblings of public_html (INSTALL_PATH = parent).
+ */
+export declare function resolveRoundcubePackageRoot(webOrPackageRoot: string): string;
+/** Prefer public_html web root when package root still has the stub index. */
+export declare function resolveRoundcubeWebRoot(packageRoot: string): string;
+/** True when path is a usable Roundcube HTTP docroot (not php-hello, not package stub). */
+export declare function isRoundcubeDocRoot(docRoot: string): boolean;
+/**
+ * True when SnappyMail markers present.
+ * Rejects the package-root stub that only says "point HTTP to /public_html"
+ * (that stub is NOT a working webmail — docRoot must be the public_html tree).
+ */
+export declare function isSnappyMailDocRoot(docRoot: string): boolean;
+/** True when docRoot is the unusable package-root stub (not public_html). */
+export declare function isWebmailPublicHtmlStub(docRoot: string): boolean;
+export declare function defaultWebmailHostname(mailDomain: string): string;
+/** Derive mail.* IMAP host from webmail or apex domain. */
+export declare function defaultImapHostForWebmail(webmailOrMailDomain: string): string;
+/** webmail.example.com / webmail2.foo.bar → example.com / foo.bar */
+export declare function stripWebmailHostnamePrefix(host: string): string | undefined;
+/** Resolve apex mail domain + IMAP/SMTP for a webmail install. */
+export declare function resolveWebmailMailEndpoints(input: {
+    webmailDomain: string;
+    mailDomain?: string;
+    imapHost?: string;
+    smtpHost?: string;
+}): {
+    mailDomain?: string;
+    imapHost: string;
+    smtpHost: string;
+};
+/**
+ * Download Roundcube or SnappyMail into project document root and write managed config.
+ */
+export declare function installWebmailIntoProject(input: {
+    host: HostExecutor;
+    homeDir: string;
+    docRoot?: string;
+    tool: WebmailTool;
+    /** Public webmail hostname (for notes only) */
+    domain: string;
+    imapHost?: string;
+    smtpHost?: string;
+    /** Apex mailbox domain for SnappyMail domain JSON (user@domain login). */
+    mailDomain?: string;
+    download?: boolean;
+    forceHttps?: boolean;
+    /** Install ysk_sso plugin into Roundcube plugins/ */
+    installSsoPlugin?: boolean;
+    panelBaseUrl?: string;
+}): Promise<{
+    ok: boolean;
+    notes: string[];
+    written: string[];
+    entryFile: string;
+    /** SnappyMail admin password (shown once) */
+    snappyAdminPassword?: string;
+    /**
+     * Absolute HTTP document root after install (may be …/public_html for Roundcube 1.6+).
+     * Callers should persist relative path on the project row before goLive.
+     */
+    webDocRoot?: string;
+    /** Relative to homeDir, e.g. app/public/public_html */
+    webDocRootRel?: string;
+}>;
+/**
+ * Seed SnappyMail data dir + admin password (shown once).
+ * Domain defaults point at local IMAP/SMTP; admin uses /?admin.
+ */
+export declare function ensureSnappyMailAdminBootstrap(docRoot: string, imapHost: string, smtpHost: string, adminPassword?: string, opts?: {
+    mailDomain?: string;
+}): {
+    written: string[];
+    notes: string[];
+    adminPassword: string;
+};
+/** Write ysk_sso plugin into Roundcube plugins/ and enable in config. */
+export declare function installYskSsoIntoRoundcube(docRoot: string, panelBaseUrl: string): {
+    written: string[];
+    notes: string[];
+    pluginDir: string;
+};
+/** Write/refresh Roundcube config.inc.php + writable temp/logs. */
+export declare function ensureRoundcubeRuntime(docRoot: string, imapHost: string, smtpHost: string, opts?: {
+    forceHttps?: boolean;
+    installSsoPlugin?: boolean;
+    panelBaseUrl?: string;
+}): {
+    written: string[];
+    notes: string[];
+};
+export declare function buildRoundcubeConfigInc(input: {
+    desKey: string;
+    imapHost: string;
+    smtpHost: string;
+    dbPath: string;
+    forceHttps?: boolean;
+    plugins?: string[];
+}): string;
+/**
+ * Create PHP project + install webmail + goLive (deploy + nginx via project lifecycle).
+ * Shared instance for all mail domains — one project / one hostname.
+ */
+export declare function createWebmailProject(input: {
+    projects: ProjectService;
+    projectOps: ProjectOpsService;
+    host: HostExecutor;
+    actor: string;
+    actorUserId?: string;
+    name: string;
+    domain: string;
+    tool?: WebmailTool;
+    download?: boolean;
+    imapHost?: string;
+    smtpHost?: string;
+    /** Apex mail domain for default naming only */
+    mailDomain?: string;
+    forceHttps?: boolean;
+    installSsoPlugin?: boolean;
+    panelBaseUrl?: string;
+    /**
+     * If project name or domain already exists, reinstall webmail into that project
+     * instead of failing (upgrade path). Default true for global shared webmail.
+     */
+    reinstall?: boolean;
+}): Promise<{
+    ok: boolean;
+    project?: ProjectDto;
+    projectId?: string;
+    urlHint?: string;
+    tool: WebmailTool;
+    notes: string[];
+    written: string[];
+    blocked?: boolean;
+    blockMessage?: string;
+    requiresExecute?: boolean;
+    requiresRoot?: boolean;
+    apply_status: 'applied' | 'written' | 'blocked' | 'failed';
+    snappyAdminPassword?: string;
+}>;
+/**
+ * Re-download / rewrite webmail into an existing PHP project (upgrade path).
+ */
+export declare function reinstallWebmailProject(input: {
+    projects: ProjectService;
+    projectOps: ProjectOpsService;
+    host: HostExecutor;
+    actor: string;
+    projectId: string;
+    tool?: WebmailTool;
+    download?: boolean;
+    imapHost?: string;
+    smtpHost?: string;
+    mailDomain?: string;
+    forceHttps?: boolean;
+    installSsoPlugin?: boolean;
+    panelBaseUrl?: string;
+    goLive?: boolean;
+}): Promise<{
+    ok: boolean;
+    project?: ProjectDto;
+    projectId?: string;
+    urlHint?: string;
+    tool: WebmailTool;
+    notes: string[];
+    written: string[];
+    blocked?: boolean;
+    blockMessage?: string;
+    requiresExecute?: boolean;
+    requiresRoot?: boolean;
+    apply_status: 'applied' | 'written' | 'blocked' | 'failed';
+    snappyAdminPassword?: string;
+}>;
+//# sourceMappingURL=webmail-project.d.ts.map

package/dist/email/webmail-project.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webmail-project.d.ts","sourceRoot":"","sources":["../../src/email/webmail-project.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAYH,OAAO,EAAwB,KAAK,UAAU,EAAM,MAAM,mBAAmB,CAAC;AAC9E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AACpE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAiEnE,MAAM,MAAM,WAAW,GAAG,WAAW,GAAG,YAAY,CAAC;AAErD,yHAAyH;AACzH,eAAO,MAAM,iBAAiB,QAA+C,CAAC;AAK9E,qFAAqF;AACrF,eAAO,MAAM,kBAAkB,QAAiD,CAAC;AAKjF,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,OAAO,GAAG,WAAW,CAI9D;AAED,wEAAwE;AACxE,eAAO,MAAM,2BAA2B,gBAAgB,CAAC;AAEzD,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,WAAW,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAQxF;AAED;;;;GAIG;AACH,wBAAgB,2BAA2B,CAAC,gBAAgB,EAAE,MAAM,GAAG,MAAM,CAa5E;AAED,8EAA8E;AAC9E,wBAAgB,uBAAuB,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAkBnE;AAED,2FAA2F;AAC3F,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CA8B3D;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAoB5D;AAED,6EAA6E;AAC7E,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAShE;AAED,wBAAgB,sBAAsB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAKjE;AAED,2DAA2D;AAC3D,wBAAgB,yBAAyB,CAAC,mBAAmB,EAAE,MAAM,GAAG,MAAM,CAQ7E;AAED,qEAAqE;AACrE,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAI3E;AAED,kEAAkE;AAClE,wBAAgB,2BAA2B,CAAC,KAAK,EAAE;IACjD,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,GAAG;IAAE,UAAU,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAW9D;AAED;;GAEG;AACH,wBAAsB,yBAAyB,CAAC,KAAK,EAAE;IACrD,IAAI,EAAE,YAAY,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,WAAW,CAAC;IAClB,+CAA+C;IAC/C,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,0EAA0E;IAC1E,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,qDAAqD;IACrD,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,GAAG,OAAO,CAAC;IACV,EAAE,EAAE,OAAO,CAAC;IACZ,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,6CAA6C;IAC7C,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,uDAAuD;IACvD,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC,CA4CD;AAkUD;;;GAGG;AACH,wBAAgB,8BAA8B,CAC5C,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,aAAa,CAAC,EAAE,MAAM,EACtB,IAAI,CAAC,EAAE;IAAE,UAAU,CAAC,EAAE,MAAM,CAAA;CAAE,GAC7B;IAAE,OAAO,EAAE,MAAM,EAAE,CAAC;IAAC,KAAK,EAAE,MAAM,EAAE,CAAC;IAAC,aAAa,EAAE,MAAM,CAAA;CAAE,CA4I/D;AASD,yEAAyE;AACzE,wBAAgB,0BAA0B,CACxC,OAAO,EAAE,MAAM,EACf,YAAY,EAAE,MAAM,GACnB;IAAE,OAAO,EAAE,MAAM,EAAE,CAAC;IAAC,KAAK,EAAE,MAAM,EAAE,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,CAuD3D;AAED,mEAAmE;AACnE,wBAAgB,sBAAsB,CACpC,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE;IACL,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,GACA;IAAE,OAAO,EAAE,MAAM,EAAE,CAAC;IAAC,KAAK,EAAE,MAAM,EAAE,CAAA;CAAE,CAwGxC;AAED,wBAAgB,uBAAuB,CAAC,KAAK,EAAE;IAC7C,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB,GAAG,MAAM,CAuDT;AASD;;;GAGG;AACH,wBAAsB,oBAAoB,CAAC,KAAK,EAAE;IAChD,QAAQ,EAAE,cAAc,CAAC;IACzB,UAAU,EAAE,iBAAiB,CAAC;IAC9B,IAAI,EAAE,YAAY,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,+CAA+C;IAC/C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,GAAG,OAAO,CAAC;IACV,EAAE,EAAE,OAAO,CAAC;IACZ,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,WAAW,CAAC;IAClB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,YAAY,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC;IAC3D,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B,CAAC,CA6RD;AAED;;GAEG;AACH,wBAAsB,uBAAuB,CAAC,KAAK,EAAE;IACnD,QAAQ,EAAE,cAAc,CAAC;IACzB,UAAU,EAAE,iBAAiB,CAAC;IAC9B,IAAI,EAAE,YAAY,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,GAAG,OAAO,CAAC;IACV,EAAE,EAAE,OAAO,CAAC;IACZ,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,WAAW,CAAC;IAClB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,YAAY,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC;IAC3D,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B,CAAC,CAkND"}