dkimkit 0.0.0-stage → 0.7.0

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

@@ -0,0 +1,84 @@
+export interface SiteOptions {
+    appName?: string;
+    /** Who operates the service: a person's or business's legal name. */
+    legalName?: string;
+    contactEmail?: string;
+    /** Whose law governs the terms, e.g. "India". */
+    legalCountry?: string;
+    /** "Last updated" on the legal pages, YYYY-MM-DD. */
+    effectiveDate?: string;
+    /** Who sends our sign-in emails, e.g. "Resend", named in the privacy policy. */
+    mailProvider?: string;
+}
+export interface SiteContext extends SiteOptions {
+    publicUrl: string;
+    signupEnabled: boolean;
+    /**
+     * Present when there's a free plan; drives the pricing page. `comingSoon`: the free plan's
+     * limit applies but paid plans aren't available yet, so nothing about payment is promised.
+     */
+    plan?: {
+        freeDomains: number;
+        unitAmount: number;
+        currency: string;
+        provider: string;
+        comingSoon?: boolean;
+    };
+}
+/** What someone typed into the feedback form, shown again with an error, or `sent` once it's on its way. */
+export interface FeedbackForm {
+    kind: FeedbackKind;
+    message: string;
+    email: string;
+    sent?: boolean;
+    error?: string;
+}
+export declare const FEEDBACK_KINDS: {
+    readonly feature: "Feature request";
+    readonly feedback: "Feedback";
+    readonly problem: "Something isn’t working";
+};
+export type FeedbackKind = keyof typeof FEEDBACK_KINDS;
+export declare const MAX_FEEDBACK_LENGTH = 5000;
+export interface Page {
+    status: number;
+    headers: Record<string, string>;
+    body: string;
+}
+export declare class Site {
+    private readonly ctx;
+    readonly appName: string;
+    /** Payments are live (not just a free plan). */
+    private readonly billing;
+    private readonly docs;
+    constructor(ctx: SiteContext);
+    /** Missing settings show as a visible placeholder, so they're noticed before launch. */
+    missingSettings(): string[];
+    /** Routes a request path to a page, or null if it isn't a site page. */
+    render(path: string): Page | null;
+    /** The feedback page, blank or with what was submitted. Its form posts back to /feedback. */
+    feedbackPage(form?: FeedbackForm): Page;
+    private money;
+    private docLink;
+    /** A value the operator must configure; shown highlighted until it is. */
+    private setting;
+    private get operator();
+    private get email();
+    private get effective();
+    private cta;
+    private page;
+    private landing;
+    /** What's being built now, then what's planned after it. */
+    private roadmap;
+    private pricing;
+    /** Before payments launch: the free plan, and a paid plan marked as coming soon. */
+    private pricingComingSoon;
+    private about;
+    private contact;
+    private feedback;
+    private docPage;
+    private legal;
+    private terms;
+    private privacy;
+    private refunds;
+}