dkimkit 0.0.0-stage → 0.7.0

package/dist/src/errors.d.ts

@@ -0,0 +1,17 @@
+import type { PlannedChange } from './types.js';
+export declare class ApiError extends Error {
+    readonly provider: string;
+    readonly status: number;
+    readonly body?: unknown | undefined;
+    constructor(provider: string, status: number, message: string, body?: unknown | undefined);
+}
+export declare class DnsConflictError extends Error {
+    readonly conflicts: PlannedChange[];
+    constructor(conflicts: PlannedChange[]);
+}
+/** Missing or invalid configuration (credentials, options) — the user's to fix. */
+export declare class ConfigError extends Error {
+    constructor(message: string);
+}
+/** What to check when a provider rejects the credentials. */
+export declare function apiErrorHint(err: ApiError): string | undefined;

package/dist/src/errors.js

@@ -0,0 +1,51 @@
+import { describeRecord } from './records.js';
+export class ApiError extends Error {
+    provider;
+    status;
+    body;
+    constructor(provider, status, message, body) {
+        super(`${provider} API error (${status}): ${message}`);
+        this.provider = provider;
+        this.status = status;
+        this.body = body;
+        this.name = 'ApiError';
+    }
+}
+export class DnsConflictError extends Error {
+    conflicts;
+    constructor(conflicts) {
+        const lines = conflicts.map((c) => `  ${describeRecord(c.record)}: ${c.reason}`);
+        super(`DNS records conflict with existing ones:\n${lines.join('\n')}`);
+        this.conflicts = conflicts;
+        this.name = 'DnsConflictError';
+    }
+}
+/** Missing or invalid configuration (credentials, options) — the user's to fix. */
+export class ConfigError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'ConfigError';
+    }
+}
+/** What to check when a provider rejects the credentials. */
+export function apiErrorHint(err) {
+    if (err.status !== 401 && err.status !== 403)
+        return undefined;
+    switch (err.provider) {
+        case 'SendGrid':
+            return 'Check the SendGrid API key has Sender Authentication and Inbound Parse permissions.';
+        case 'Postmark':
+            return 'Check the Postmark account API token (Account → API Tokens, not a server token).';
+        case 'Mailgun':
+            return 'Check the Mailgun API key, and that the region (US or EU) matches the account.';
+        case 'Amazon SES':
+            return 'Check the AWS credentials and region, and that they allow ses:CreateEmailIdentity, GetEmailIdentity, PutEmailIdentityMailFromAttributes and DeleteEmailIdentity.';
+        case 'Cloudflare':
+            return 'Check the Cloudflare token has Zone:Read and DNS:Edit for this zone.';
+        case 'Route53':
+            return 'Check the AWS credentials allow route53:ListHostedZonesByName, route53:ListResourceRecordSets and route53:ChangeResourceRecordSets.';
+        default:
+            return undefined;
+    }
+}
+//# sourceMappingURL=errors.js.map

package/dist/src/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAG9C,MAAM,OAAO,QAAS,SAAQ,KAAK;IAEtB;IACA;IAEA;IAJX,YACW,QAAgB,EAChB,MAAc,EACvB,OAAe,EACN,IAAc;QAEvB,KAAK,CAAC,GAAG,QAAQ,eAAe,MAAM,MAAM,OAAO,EAAE,CAAC,CAAC;QAL9C,aAAQ,GAAR,QAAQ,CAAQ;QAChB,WAAM,GAAN,MAAM,CAAQ;QAEd,SAAI,GAAJ,IAAI,CAAU;QAGvB,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC;IACzB,CAAC;CACF;AAED,MAAM,OAAO,gBAAiB,SAAQ,KAAK;IACpB;IAArB,YAAqB,SAA0B;QAC7C,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,cAAc,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QACjF,KAAK,CAAC,6CAA6C,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAFpD,cAAS,GAAT,SAAS,CAAiB;QAG7C,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAC;IACjC,CAAC;CACF;AAED,mFAAmF;AACnF,MAAM,OAAO,WAAY,SAAQ,KAAK;IACpC,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,aAAa,CAAC;IAC5B,CAAC;CACF;AAED,6DAA6D;AAC7D,MAAM,UAAU,YAAY,CAAC,GAAa;IACxC,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG;QAAE,OAAO,SAAS,CAAC;IAC/D,QAAQ,GAAG,CAAC,QAAQ,EAAE,CAAC;QACrB,KAAK,UAAU;YACb,OAAO,qFAAqF,CAAC;QAC/F,KAAK,UAAU;YACb,OAAO,kFAAkF,CAAC;QAC5F,KAAK,SAAS;YACZ,OAAO,gFAAgF,CAAC;QAC1F,KAAK,YAAY;YACf,OAAO,kKAAkK,CAAC;QAC5K,KAAK,YAAY;YACf,OAAO,sEAAsE,CAAC;QAChF,KAAK,SAAS;YACZ,OAAO,qIAAqI,CAAC;QAC/I;YACE,OAAO,SAAS,CAAC;IACrB,CAAC;AACH,CAAC"}

package/dist/src/hosted/api.d.ts

@@ -0,0 +1,107 @@
+import { type IncomingMessage, type Server, type ServerResponse } from 'node:http';
+import type { FetchLike } from '../http.js';
+import type { DnsHost } from '../dns-host.js';
+import type { DnsLookup } from '../propagation.js';
+import { AccountAuth, type Mailer } from './auth.js';
+import { BillingService, type BillingConfig } from './billing.js';
+import { Site, type SiteOptions } from './site.js';
+import { DomainService, type DomainInput, type Logger, type ProviderFactory } from './service.js';
+import { type Store } from './store.js';
+import { WidgetService } from './widget.js';
+import { BackgroundRunner } from './worker.js';
+export interface WidgetAssets {
+    loader: string;
+    frame: string;
+    dashboard: string;
+}
+export declare function loadWidgetAssets(): WidgetAssets;
+export interface ApiOptions {
+    service: DomainService;
+    widget: WidgetService;
+    /** Self-serve sign-up and the dashboard. Requires publicUrl. */
+    auth?: AccountAuth;
+    /** Pay-as-you-go billing. Without it there's no free-tier cap and no checkout. */
+    billing?: BillingService;
+    /** Without billing: a free plan whose domain cap applies, with payments coming soon. */
+    freePlan?: FreePlan;
+    /** The public website (landing, pricing, docs, legal pages). */
+    site?: Site;
+    /** Where the website's feedback form is sent. Without `to`, submissions are only logged. */
+    feedback?: {
+        mailer: Mailer;
+        to?: string;
+    };
+    assets?: WidgetAssets;
+    /** Public base URL (e.g. https://api.example.com) used in widget links. Defaults to the request's host. */
+    publicUrl?: string;
+    /** Requests per second per account, with bursts up to `burst`. */
+    rateLimit?: {
+        perSecond: number;
+        burst: number;
+    };
+    now?: () => number;
+    log?: Logger;
+}
+/** The request handler, separate from the listener so it can be mounted elsewhere. */
+export declare function createApiHandler(opts: ApiOptions): (req: IncomingMessage, res: ServerResponse) => Promise<void>;
+/** from/to as inclusive UTC days; defaults to the current calendar month so far. */
+export declare function parseUsagePeriod(query: URLSearchParams, now: number): {
+    from: string;
+    to: string;
+};
+export declare function parseDomainInput(body: Record<string, unknown>): DomainInput;
+export interface FreePlan {
+    freeDomains: number;
+}
+export interface HostedApiOptions {
+    /** postgres://… URL, or a SQLite file path (default ':memory:'). Ignored when `store` is given. */
+    database?: string;
+    store?: Store;
+    encryptionKey: string;
+    port?: number;
+    host?: string;
+    /** Run the background runner in this process. Default true. */
+    workers?: boolean;
+    runner?: {
+        concurrency?: number;
+        pollMs?: number;
+    };
+    rateLimit?: {
+        perSecond: number;
+        burst: number;
+    };
+    providers?: ProviderFactory;
+    lookup?: (domain: string) => Promise<DnsLookup>;
+    fetch?: FetchLike;
+    now?: () => number;
+    allowPrivateWebhooks?: boolean;
+    /** Public base URL for widget links (PUBLIC_URL). */
+    publicUrl?: string;
+    /** Override DNS host detection (tests). */
+    detectHost?: (domain: string) => Promise<DnsHost>;
+    /** Self-serve sign-up and dashboard (needs publicUrl). Without a mailer, sign-in links are logged. */
+    signup?: {
+        mailer?: Mailer;
+        appName?: string;
+    };
+    /** Pay-as-you-go billing (needs publicUrl). */
+    billing?: BillingConfig;
+    /** Before billing launches: cap free accounts at this many domains and show paid plans as coming soon. Ignored with `billing`. */
+    freePlan?: FreePlan;
+    /** The public website (needs publicUrl). */
+    site?: SiteOptions;
+    log?: Logger;
+}
+export interface HostedApi {
+    url: string;
+    port: number;
+    server: Server;
+    store: Store;
+    service: DomainService;
+    runner: BackgroundRunner;
+    billing?: BillingService;
+    auth?: AccountAuth;
+    site?: Site;
+    close(): Promise<void>;
+}
+export declare function startHostedApi(opts: HostedApiOptions): Promise<HostedApi>;