@opengeni/contracts 5.5.0 → 5.5.2-canary.40656248492001

package/dist/site-publishing.d.ts

@@ -0,0 +1,813 @@
+import { z } from "zod";
+/**
+ * Published Sites: a workspace Site served on its own hostname under a
+ * configurable Sites domain (production `opengeni.site`, staging a separate
+ * domain). Shared by the API, the Site gateway Worker, the console and the
+ * SDK. See docs/design/published-sites-2026-10-14.md.
+ *
+ * Nothing here names a concrete domain: every domain is configuration.
+ */
+export declare const SITE_HOSTNAME_LABEL_MIN = 3;
+export declare const SITE_HOSTNAME_LABEL_MAX = 63;
+/** A released hostname stays reserved to its workspace for at least this long. */
+export declare const SITE_HOSTNAME_RELEASE_HOLD_DAYS = 30;
+/** Labels no Site may take: platform, mail, auth and infrastructure names. */
+export declare const SITE_RESERVED_HOSTNAME_LABELS: readonly string[];
+/**
+ * Words that make a hostname look like a credential, payment or brand page.
+ * A label containing any of them is refused (substring match on the label
+ * with hyphens removed), whoever asks.
+ */
+export declare const SITE_BLOCKED_HOSTNAME_WORDS: readonly string[];
+export type SiteHostnameLabelProblem = "length" | "characters" | "hyphen" | "punycode" | "reserved" | "blocked";
+export declare const SITE_HOSTNAME_PROBLEM_MESSAGES: Readonly<Record<SiteHostnameLabelProblem, string>>;
+/**
+ * Validate one DNS label for a Site hostname. Pure and environment-neutral:
+ * the API, the gateway and the console all call it. Availability (global
+ * uniqueness and the release hold) is decided only by the API.
+ */
+export declare function siteHostnameLabelProblem(label: string): SiteHostnameLabelProblem | null;
+export declare const SiteHostnameLabel: z.ZodString;
+export type SiteHostnameLabel = z.infer<typeof SiteHostnameLabel>;
+/**
+ * Suggest a default label from a Site title: a slug plus a random
+ * four-character suffix (`team-dashboard-4k9x`), always valid by
+ * construction. `suffix` must be 4 chars of [a-z0-9]; callers supply it so
+ * this stays pure.
+ */
+export declare function suggestSiteHostnameLabel(title: string, suffix: string): string;
+/** Normalize a configured Sites domain (`opengeni.site`); throws when it is not a hostname. */
+export declare function normalizeSitesDomain(domain: string): string;
+/** `<label>.<domain>` for a valid label and configured domain. */
+export declare function siteHostname(label: string, sitesDomain: string): string;
+/**
+ * The label of a flat one-level Site hostname under the Sites domain, or null
+ * for the apex, deeper names, other domains and invalid labels. A port and a
+ * trailing dot are ignored.
+ */
+export declare function parseSiteHostname(host: string, sitesDomain: string): string | null;
+/**
+ * Who may open a published Site.
+ * - members: signed-in members of the Site's workspace.
+ * - invited: members plus people invited by email (they sign in to Opengeni).
+ * - public: anyone; anonymous visitors use a guest principal. On deployments
+ *   configured login-only (staging), public means any signed-in Opengeni user.
+ */
+export declare const SiteAccessMode: z.ZodEnum<{
+    invited: "invited";
+    members: "members";
+    public: "public";
+}>;
+export type SiteAccessMode = z.infer<typeof SiteAccessMode>;
+/**
+ * active: served. unpublished: the owner turned publishing off (the hostname
+ * stays held). suspended: taken down by the owner, a workspace admin or a
+ * platform moderator; the gateway serves a takedown page.
+ */
+export declare const SitePublicationStatus: z.ZodEnum<{
+    active: "active";
+    suspended: "suspended";
+    unpublished: "unpublished";
+}>;
+export type SitePublicationStatus = z.infer<typeof SitePublicationStatus>;
+export declare const SiteLimitProfileKind: z.ZodEnum<{
+    credits: "credits";
+    custom: "custom";
+    free: "free";
+    standard: "standard";
+    unlimited: "unlimited";
+}>;
+export type SiteLimitProfileKind = z.infer<typeof SiteLimitProfileKind>;
+/**
+ * Effective limits for a published Site. Money is in micro-USD
+ * (1_000_000 = $1). They apply to people outside the workspace only
+ * (invited people and public visitors, signed in or anonymous); workspace
+ * members are never limited by them and use the workspace's normal session
+ * limits, on any Site. Cloudflare cannot cap spend, so the edge applies only
+ * flood brakes; Opengeni enforces these values.
+ */
+export declare const SiteLimits: z.ZodObject<{
+    requestsPerMinutePerVisitor: z.ZodNullable<z.ZodNumber>;
+    guestWritesPerMinute: z.ZodNullable<z.ZodNumber>;
+    agentsEnabled: z.ZodBoolean;
+    guestAgentsEnabled: z.ZodBoolean;
+    conversationsPerVisitorPerDay: z.ZodNullable<z.ZodNumber>;
+    conversationsPerSitePerDay: z.ZodNullable<z.ZodNumber>;
+    turnsPerConversation: z.ZodNullable<z.ZodNumber>;
+    agentMicrosPerConversation: z.ZodNullable<z.ZodNumber>;
+    agentMicrosPerVisitorPerDay: z.ZodNullable<z.ZodNumber>;
+    agentMicrosPerVisitorPerMonth: z.ZodDefault<z.ZodNullable<z.ZodNumber>>;
+    agentMicrosPerSitePerDay: z.ZodDefault<z.ZodNullable<z.ZodNumber>>;
+    agentMicrosPerSitePerMonth: z.ZodNullable<z.ZodNumber>;
+    agentModels: z.ZodNullable<z.ZodArray<z.ZodString>>;
+}, z.core.$strip>;
+export type SiteLimits = z.infer<typeof SiteLimits>;
+/**
+ * The standard limits: $10 per Site per month for everyone outside the
+ * workspace together, no per-person limit, and internal bot guards for
+ * anonymous guests (conversation and message counts are not shown to Site
+ * owners). Deployments override them through settings.
+ */
+export declare const DEFAULT_SITE_LIMITS: Readonly<SiteLimits>;
+/** @deprecated The former `free` profile; now the standard limits (DEFAULT_SITE_LIMITS). */
+export declare const DEFAULT_FREE_SITE_LIMITS: Readonly<SiteLimits>;
+/** Hard caps that still apply under every profile, unlimited included. */
+export declare const UNLIMITED_SITE_FLOOD_BRAKES: Readonly<{
+    requestsPerMinutePerVisitor: 600;
+    conversationsPerSitePerDay: 10000;
+    agentMicrosPerConversation: 5000000;
+}>;
+export declare const SiteLimitProfile: z.ZodObject<{
+    kind: z.ZodEnum<{
+        credits: "credits";
+        custom: "custom";
+        free: "free";
+        standard: "standard";
+        unlimited: "unlimited";
+    }>;
+    overrides: z.ZodDefault<z.ZodNullable<z.ZodObject<{
+        requestsPerMinutePerVisitor: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        guestWritesPerMinute: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        agentsEnabled: z.ZodOptional<z.ZodBoolean>;
+        guestAgentsEnabled: z.ZodOptional<z.ZodBoolean>;
+        conversationsPerVisitorPerDay: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        conversationsPerSitePerDay: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        turnsPerConversation: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        agentMicrosPerConversation: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        agentMicrosPerVisitorPerDay: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        agentMicrosPerVisitorPerMonth: z.ZodOptional<z.ZodDefault<z.ZodNullable<z.ZodNumber>>>;
+        agentMicrosPerSitePerDay: z.ZodOptional<z.ZodDefault<z.ZodNullable<z.ZodNumber>>>;
+        agentMicrosPerSitePerMonth: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        agentModels: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export type SiteLimitProfile = z.infer<typeof SiteLimitProfile>;
+export declare const SiteEmbeddedAgent: z.ZodObject<{
+    enabled: z.ZodBoolean;
+    model: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    instructions: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    tools: z.ZodDefault<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+    guestTools: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>;
+export type SiteEmbeddedAgent = z.infer<typeof SiteEmbeddedAgent>;
+/** Changes to the embedded agent; omitted fields keep their current value. */
+export declare const SiteEmbeddedAgentChanges: z.ZodObject<{
+    enabled: z.ZodOptional<z.ZodBoolean>;
+    model: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    instructions: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    tools: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+    guestTools: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export type SiteEmbeddedAgentChanges = z.infer<typeof SiteEmbeddedAgentChanges>;
+/** A safe one-click fix for a readiness warning (applied through the ordinary APIs). */
+export declare const SitePublishWarningFix: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    kind: z.ZodLiteral<"site_data_guest_access">;
+    collection: z.ZodString;
+    guestAccess: z.ZodEnum<{
+        append: "append";
+        own: "own";
+        read: "read";
+    }>;
+}, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"site_sql_query_audience">;
+    query: z.ZodString;
+    audience: z.ZodEnum<{
+        everyone: "everyone";
+        signed_in: "signed_in";
+    }>;
+}, z.core.$strip>], "kind">;
+export type SitePublishWarningFix = z.infer<typeof SitePublishWarningFix>;
+export declare const SITE_PUBLISH_WARNING_CODES: readonly ["workspace_tools_members_only", "agent_tools_members_only", "site_data_guest_read", "site_data_guest_write", "site_data_members_write", "site_sql_query_signed_in", "site_sql_query_managers", 
+/** No longer reported (the fallback shows as outsideAgentModel); kept for compatibility. */
+"agent_model_outside_fallback", "agent_model_outside_unavailable", 
+/** The workspace has no credits for the outside model right now. */
+"agent_model_outside_no_credits", 
+/** The workspace's usage allowance is used up, so outsiders' turns are refused. */
+"agent_model_outside_allowance_used", 
+/** The page was too large to read, so what it uses was not checked. */
+"page_not_checked", 
+/**
+ * A public Site on a login-only deployment: every visitor signs in to
+ * Opengeni first. A notice about the deployment, with nothing to fix.
+ */
+"public_sign_in_required"];
+/** Warnings that only inform: nothing on the Site can or needs to change. */
+export declare const SITE_PUBLISH_NOTICE_CODES: ReadonlySet<(typeof SITE_PUBLISH_WARNING_CODES)[number]>;
+/**
+ * Something the published version uses that its audience may not do. Found
+ * by a conservative static reading of the page source and the Site's
+ * declared tools, collections and queries (docs/published-sites.md).
+ */
+export declare const SitePublishWarning: z.ZodObject<{
+    code: z.ZodEnum<{
+        agent_model_outside_allowance_used: "agent_model_outside_allowance_used";
+        agent_model_outside_fallback: "agent_model_outside_fallback";
+        agent_model_outside_no_credits: "agent_model_outside_no_credits";
+        agent_model_outside_unavailable: "agent_model_outside_unavailable";
+        agent_tools_members_only: "agent_tools_members_only";
+        page_not_checked: "page_not_checked";
+        public_sign_in_required: "public_sign_in_required";
+        site_data_guest_read: "site_data_guest_read";
+        site_data_guest_write: "site_data_guest_write";
+        site_data_members_write: "site_data_members_write";
+        site_sql_query_managers: "site_sql_query_managers";
+        site_sql_query_signed_in: "site_sql_query_signed_in";
+        workspace_tools_members_only: "workspace_tools_members_only";
+    }>;
+    message: z.ZodString;
+    suggestion: z.ZodString;
+    fix: z.ZodDefault<z.ZodNullable<z.ZodDiscriminatedUnion<[z.ZodObject<{
+        kind: z.ZodLiteral<"site_data_guest_access">;
+        collection: z.ZodString;
+        guestAccess: z.ZodEnum<{
+            append: "append";
+            own: "own";
+            read: "read";
+        }>;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"site_sql_query_audience">;
+        query: z.ZodString;
+        audience: z.ZodEnum<{
+            everyone: "everyone";
+            signed_in: "signed_in";
+        }>;
+    }, z.core.$strip>], "kind">>>;
+}, z.core.$strip>;
+export type SitePublishWarning = z.infer<typeof SitePublishWarning>;
+export declare const SitePublication: z.ZodObject<{
+    siteId: z.ZodString;
+    workspaceId: z.ZodString;
+    label: z.ZodString;
+    hostname: z.ZodString;
+    url: z.ZodString;
+    access: z.ZodEnum<{
+        invited: "invited";
+        members: "members";
+        public: "public";
+    }>;
+    status: z.ZodEnum<{
+        active: "active";
+        suspended: "suspended";
+        unpublished: "unpublished";
+    }>;
+    noindex: z.ZodBoolean;
+    agent: z.ZodObject<{
+        enabled: z.ZodBoolean;
+        model: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+        instructions: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+        tools: z.ZodDefault<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        guestTools: z.ZodDefault<z.ZodBoolean>;
+    }, z.core.$strip>;
+    limitProfile: z.ZodObject<{
+        kind: z.ZodEnum<{
+            credits: "credits";
+            custom: "custom";
+            free: "free";
+            standard: "standard";
+            unlimited: "unlimited";
+        }>;
+        overrides: z.ZodDefault<z.ZodNullable<z.ZodObject<{
+            requestsPerMinutePerVisitor: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            guestWritesPerMinute: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            agentsEnabled: z.ZodOptional<z.ZodBoolean>;
+            guestAgentsEnabled: z.ZodOptional<z.ZodBoolean>;
+            conversationsPerVisitorPerDay: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            conversationsPerSitePerDay: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            turnsPerConversation: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            agentMicrosPerConversation: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            agentMicrosPerVisitorPerDay: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            agentMicrosPerVisitorPerMonth: z.ZodOptional<z.ZodDefault<z.ZodNullable<z.ZodNumber>>>;
+            agentMicrosPerSitePerDay: z.ZodOptional<z.ZodDefault<z.ZodNullable<z.ZodNumber>>>;
+            agentMicrosPerSitePerMonth: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            agentModels: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>;
+    effectiveLimits: z.ZodObject<{
+        requestsPerMinutePerVisitor: z.ZodNullable<z.ZodNumber>;
+        guestWritesPerMinute: z.ZodNullable<z.ZodNumber>;
+        agentsEnabled: z.ZodBoolean;
+        guestAgentsEnabled: z.ZodBoolean;
+        conversationsPerVisitorPerDay: z.ZodNullable<z.ZodNumber>;
+        conversationsPerSitePerDay: z.ZodNullable<z.ZodNumber>;
+        turnsPerConversation: z.ZodNullable<z.ZodNumber>;
+        agentMicrosPerConversation: z.ZodNullable<z.ZodNumber>;
+        agentMicrosPerVisitorPerDay: z.ZodNullable<z.ZodNumber>;
+        agentMicrosPerVisitorPerMonth: z.ZodDefault<z.ZodNullable<z.ZodNumber>>;
+        agentMicrosPerSitePerDay: z.ZodDefault<z.ZodNullable<z.ZodNumber>>;
+        agentMicrosPerSitePerMonth: z.ZodNullable<z.ZodNumber>;
+        agentModels: z.ZodNullable<z.ZodArray<z.ZodString>>;
+    }, z.core.$strip>;
+    invitedEmails: z.ZodArray<z.ZodString>;
+    moderation: z.ZodObject<{
+        openReports: z.ZodNumber;
+        suspendedAt: z.ZodNullable<z.ZodString>;
+        suspendedBy: z.ZodNullable<z.ZodEnum<{
+            admin: "admin";
+            owner: "owner";
+            platform: "platform";
+        }>>;
+        suspendedReason: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>;
+    usage: z.ZodObject<{
+        agentMicrosThisMonth: z.ZodNumber;
+        agentMicrosToday: z.ZodDefault<z.ZodNumber>;
+        conversationsToday: z.ZodNumber;
+    }, z.core.$strip>;
+    warnings: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        code: z.ZodEnum<{
+            agent_model_outside_allowance_used: "agent_model_outside_allowance_used";
+            agent_model_outside_fallback: "agent_model_outside_fallback";
+            agent_model_outside_no_credits: "agent_model_outside_no_credits";
+            agent_model_outside_unavailable: "agent_model_outside_unavailable";
+            agent_tools_members_only: "agent_tools_members_only";
+            page_not_checked: "page_not_checked";
+            public_sign_in_required: "public_sign_in_required";
+            site_data_guest_read: "site_data_guest_read";
+            site_data_guest_write: "site_data_guest_write";
+            site_data_members_write: "site_data_members_write";
+            site_sql_query_managers: "site_sql_query_managers";
+            site_sql_query_signed_in: "site_sql_query_signed_in";
+            workspace_tools_members_only: "workspace_tools_members_only";
+        }>;
+        message: z.ZodString;
+        suggestion: z.ZodString;
+        fix: z.ZodDefault<z.ZodNullable<z.ZodDiscriminatedUnion<[z.ZodObject<{
+            kind: z.ZodLiteral<"site_data_guest_access">;
+            collection: z.ZodString;
+            guestAccess: z.ZodEnum<{
+                append: "append";
+                own: "own";
+                read: "read";
+            }>;
+        }, z.core.$strip>, z.ZodObject<{
+            kind: z.ZodLiteral<"site_sql_query_audience">;
+            query: z.ZodString;
+            audience: z.ZodEnum<{
+                everyone: "everyone";
+                signed_in: "signed_in";
+            }>;
+        }, z.core.$strip>], "kind">>>;
+    }, z.core.$strip>>>;
+    outsideAgentModel: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    createdAt: z.ZodString;
+    updatedAt: z.ZodString;
+}, z.core.$strip>;
+export type SitePublication = z.infer<typeof SitePublication>;
+/**
+ * GET /v1/workspaces/:ws/published-artifacts/:siteId/publication/link
+ *
+ * Where a published Site lives, for anyone who can open the Site in the app:
+ * its primary public URL and whether it is on the web now. Managing the
+ * publication (access, limits, moderation) stays with `SitePublication`.
+ */
+export declare const SitePublicationLink: z.ZodObject<{
+    siteId: z.ZodString;
+    hostname: z.ZodString;
+    url: z.ZodString;
+    status: z.ZodEnum<{
+        active: "active";
+        suspended: "suspended";
+        unpublished: "unpublished";
+    }>;
+}, z.core.$strip>;
+export type SitePublicationLink = z.infer<typeof SitePublicationLink>;
+/** PUT /v1/workspaces/:ws/published-artifacts/:siteId/publication */
+export declare const UpsertSitePublicationRequest: z.ZodObject<{
+    label: z.ZodOptional<z.ZodString>;
+    access: z.ZodOptional<z.ZodEnum<{
+        invited: "invited";
+        members: "members";
+        public: "public";
+    }>>;
+    status: z.ZodOptional<z.ZodEnum<{
+        active: "active";
+        unpublished: "unpublished";
+    }>>;
+    noindex: z.ZodOptional<z.ZodBoolean>;
+    agent: z.ZodOptional<z.ZodObject<{
+        enabled: z.ZodOptional<z.ZodBoolean>;
+        model: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        instructions: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        tools: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        guestTools: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>;
+    limitProfile: z.ZodOptional<z.ZodObject<{
+        kind: z.ZodEnum<{
+            credits: "credits";
+            custom: "custom";
+            free: "free";
+            standard: "standard";
+            unlimited: "unlimited";
+        }>;
+        overrides: z.ZodDefault<z.ZodNullable<z.ZodObject<{
+            requestsPerMinutePerVisitor: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            guestWritesPerMinute: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            agentsEnabled: z.ZodOptional<z.ZodBoolean>;
+            guestAgentsEnabled: z.ZodOptional<z.ZodBoolean>;
+            conversationsPerVisitorPerDay: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            conversationsPerSitePerDay: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            turnsPerConversation: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            agentMicrosPerConversation: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            agentMicrosPerVisitorPerDay: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            agentMicrosPerVisitorPerMonth: z.ZodOptional<z.ZodDefault<z.ZodNullable<z.ZodNumber>>>;
+            agentMicrosPerSitePerDay: z.ZodOptional<z.ZodDefault<z.ZodNullable<z.ZodNumber>>>;
+            agentMicrosPerSitePerMonth: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            agentModels: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+    invitedEmails: z.ZodOptional<z.ZodArray<z.ZodString>>;
+}, z.core.$strip>;
+export type UpsertSitePublicationRequest = z.infer<typeof UpsertSitePublicationRequest>;
+export declare const SiteHostnameAvailabilityProblem: z.ZodEnum<{
+    blocked: "blocked";
+    characters: "characters";
+    held: "held";
+    hyphen: "hyphen";
+    length: "length";
+    punycode: "punycode";
+    reserved: "reserved";
+    taken: "taken";
+}>;
+export type SiteHostnameAvailabilityProblem = z.infer<typeof SiteHostnameAvailabilityProblem>;
+/** GET /v1/workspaces/:ws/site-hostnames/:label */
+export declare const SiteHostnameAvailability: z.ZodObject<{
+    label: z.ZodString;
+    hostname: z.ZodNullable<z.ZodString>;
+    available: z.ZodBoolean;
+    problem: z.ZodNullable<z.ZodEnum<{
+        blocked: "blocked";
+        characters: "characters";
+        held: "held";
+        hyphen: "hyphen";
+        length: "length";
+        punycode: "punycode";
+        reserved: "reserved";
+        taken: "taken";
+    }>>;
+    message: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export type SiteHostnameAvailability = z.infer<typeof SiteHostnameAvailability>;
+/** POST .../publication/takedown (owner, workspace admin) and the platform admin route. */
+export declare const SiteTakedownRequest: z.ZodObject<{
+    reason: z.ZodString;
+}, z.core.$strip>;
+export type SiteTakedownRequest = z.infer<typeof SiteTakedownRequest>;
+export declare const SiteAbuseCategory: z.ZodEnum<{
+    copyright: "copyright";
+    harassment: "harassment";
+    illegal: "illegal";
+    malware: "malware";
+    other: "other";
+    phishing: "phishing";
+    spam: "spam";
+}>;
+export type SiteAbuseCategory = z.infer<typeof SiteAbuseCategory>;
+/** POST /_og/report on a Site host, forwarded to /v1/site-runtime/site/reports. */
+export declare const SiteAbuseReportRequest: z.ZodObject<{
+    category: z.ZodEnum<{
+        copyright: "copyright";
+        harassment: "harassment";
+        illegal: "illegal";
+        malware: "malware";
+        other: "other";
+        phishing: "phishing";
+        spam: "spam";
+    }>;
+    message: z.ZodDefault<z.ZodString>;
+    contactEmail: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+export type SiteAbuseReportRequest = z.infer<typeof SiteAbuseReportRequest>;
+export declare const SiteAbuseReport: z.ZodObject<{
+    id: z.ZodString;
+    siteId: z.ZodString;
+    hostname: z.ZodString;
+    category: z.ZodEnum<{
+        copyright: "copyright";
+        harassment: "harassment";
+        illegal: "illegal";
+        malware: "malware";
+        other: "other";
+        phishing: "phishing";
+        spam: "spam";
+    }>;
+    message: z.ZodString;
+    contactEmail: z.ZodNullable<z.ZodString>;
+    status: z.ZodEnum<{
+        actioned: "actioned";
+        dismissed: "dismissed";
+        open: "open";
+    }>;
+    createdAt: z.ZodString;
+}, z.core.$strip>;
+export type SiteAbuseReport = z.infer<typeof SiteAbuseReport>;
+/**
+ * The viewer as a Site sees it (`site.viewer`). Guests have no name or
+ * email. `id` is stable per Site and is the Site Data owner principal
+ * (`user:<subject>` or `guest:<visitor>`); it is not an Opengeni subject id
+ * usable anywhere else.
+ */
+export declare const SiteViewer: z.ZodObject<{
+    kind: z.ZodEnum<{
+        guest: "guest";
+        invited: "invited";
+        member: "member";
+        user: "user";
+    }>;
+    id: z.ZodString;
+    name: z.ZodNullable<z.ZodString>;
+    email: z.ZodNullable<z.ZodString>;
+    signedIn: z.ZodBoolean;
+}, z.core.$strip>;
+export type SiteViewer = z.infer<typeof SiteViewer>;
+/** The roles an owner may preview their published Site as ("View as visitor"). */
+export declare const SiteViewAs: z.ZodEnum<{
+    invited: "invited";
+    public: "public";
+}>;
+export type SiteViewAs = z.infer<typeof SiteViewAs>;
+/** The query parameter that starts (`invited`, `public`) or ends (`off`) a preview. */
+export declare const SITE_VIEW_AS_QUERY = "og_view_as";
+/**
+ * What this viewer may do, cheaply, so a page can hide features instead of
+ * failing. Anything refused at call time still answers with the error
+ * `not_available_for_viewer`.
+ */
+export declare const SiteViewerCapabilities: z.ZodObject<{
+    agent: z.ZodBoolean;
+    workspaceTools: z.ZodBoolean;
+    siteData: z.ZodEnum<{
+        guest: "guest";
+        viewer: "viewer";
+    }>;
+    sqlQueryAudiences: z.ZodArray<z.ZodEnum<{
+        everyone: "everyone";
+        signed_in: "signed_in";
+    }>>;
+    viewAs: z.ZodNullable<z.ZodEnum<{
+        invited: "invited";
+        public: "public";
+    }>>;
+}, z.core.$strip>;
+export type SiteViewerCapabilities = z.infer<typeof SiteViewerCapabilities>;
+/** The error code (`error.details.code`) when the viewer may not do something on a Site. */
+export declare const SITE_NOT_AVAILABLE_FOR_VIEWER_ERROR_CODE = "not_available_for_viewer";
+/** GET /_og/api/site/config (gateway shell and `site.viewer`). */
+export declare const SiteRuntimeConfig: z.ZodObject<{
+    siteId: z.ZodString;
+    title: z.ZodString;
+    hostname: z.ZodString;
+    versionId: z.ZodString;
+    access: z.ZodEnum<{
+        invited: "invited";
+        members: "members";
+        public: "public";
+    }>;
+    viewer: z.ZodObject<{
+        kind: z.ZodEnum<{
+            guest: "guest";
+            invited: "invited";
+            member: "member";
+            user: "user";
+        }>;
+        id: z.ZodString;
+        name: z.ZodNullable<z.ZodString>;
+        email: z.ZodNullable<z.ZodString>;
+        signedIn: z.ZodBoolean;
+    }, z.core.$strip>;
+    capabilities: z.ZodObject<{
+        agent: z.ZodBoolean;
+        workspaceTools: z.ZodBoolean;
+        siteData: z.ZodEnum<{
+            guest: "guest";
+            viewer: "viewer";
+        }>;
+        sqlQueryAudiences: z.ZodArray<z.ZodEnum<{
+            everyone: "everyone";
+            signed_in: "signed_in";
+        }>>;
+        viewAs: z.ZodNullable<z.ZodEnum<{
+            invited: "invited";
+            public: "public";
+        }>>;
+    }, z.core.$strip>;
+    agent: z.ZodObject<{
+        enabled: z.ZodBoolean;
+        model: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>;
+    siteData: z.ZodBoolean;
+    noindex: z.ZodBoolean;
+    abuseEmail: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export type SiteRuntimeConfig = z.infer<typeof SiteRuntimeConfig>;
+/**
+ * POST /v1/site-auth/authorize, called by the console page
+ * `/site-auth/authorize` with the signed-in user's ordinary credentials.
+ * Returns a one-time code bound to the host, PKCE challenge and redirect.
+ */
+export declare const SiteAuthAuthorizeRequest: z.ZodObject<{
+    host: z.ZodString;
+    state: z.ZodString;
+    codeChallenge: z.ZodString;
+    codeChallengeMethod: z.ZodLiteral<"S256">;
+    redirectUri: z.ZodString;
+}, z.core.$strip>;
+export type SiteAuthAuthorizeRequest = z.infer<typeof SiteAuthAuthorizeRequest>;
+export declare const SiteAuthAuthorizeResponse: z.ZodObject<{
+    redirectTo: z.ZodString;
+    site: z.ZodObject<{
+        title: z.ZodString;
+        hostname: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type SiteAuthAuthorizeResponse = z.infer<typeof SiteAuthAuthorizeResponse>;
+/** POST /v1/site-runtime/auth/exchange (gateway only, signed). */
+export declare const SiteAuthExchangeRequest: z.ZodObject<{
+    code: z.ZodString;
+    codeVerifier: z.ZodString;
+    redirectUri: z.ZodString;
+}, z.core.$strip>;
+export type SiteAuthExchangeRequest = z.infer<typeof SiteAuthExchangeRequest>;
+export declare const SiteAuthExchangeResponse: z.ZodObject<{
+    sessionToken: z.ZodString;
+    expiresAt: z.ZodString;
+    viewer: z.ZodObject<{
+        kind: z.ZodEnum<{
+            guest: "guest";
+            invited: "invited";
+            member: "member";
+            user: "user";
+        }>;
+        id: z.ZodString;
+        name: z.ZodNullable<z.ZodString>;
+        email: z.ZodNullable<z.ZodString>;
+        signedIn: z.ZodBoolean;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type SiteAuthExchangeResponse = z.infer<typeof SiteAuthExchangeResponse>;
+export declare const SITE_SESSION_COOKIE = "__Host-og_session";
+export declare const SITE_VISITOR_COOKIE = "__Host-og_v";
+export declare const SITE_LOGIN_COOKIE = "__Host-og_login";
+/** Paths the gateway owns on every Site host. */
+export declare const SITE_GATEWAY_PREFIX = "/_og";
+export declare const SITE_GATEWAY_API_PREFIX = "/_og/api";
+export declare const SITE_GATEWAY_VERSION_PREFIX = "/_og/v";
+export declare const SITE_GATEWAY_LOGIN_PATH = "/_og/auth/login";
+export declare const SITE_GATEWAY_CALLBACK_PATH = "/_og/auth/callback";
+export declare const SITE_GATEWAY_LOGOUT_PATH = "/_og/auth/logout";
+export declare const SITE_GATEWAY_REPORT_PATH = "/_og/report";
+/** The API prefix the gateway forwards `/_og/api/*` to. */
+export declare const SITE_RUNTIME_API_PREFIX = "/v1/site-runtime";
+export declare const SITE_GATEWAY_TIMESTAMP_HEADER = "x-opengeni-gateway-timestamp";
+export declare const SITE_GATEWAY_SIGNATURE_HEADER = "x-opengeni-gateway-signature";
+export declare const SITE_GATEWAY_HOST_HEADER = "x-opengeni-site-host";
+export declare const SITE_GATEWAY_SESSION_HEADER = "x-opengeni-site-session";
+export declare const SITE_GATEWAY_VISITOR_HEADER = "x-opengeni-site-visitor";
+export declare const SITE_GATEWAY_CLIENT_IP_HEADER = "x-opengeni-site-client-ip";
+export declare const SITE_GATEWAY_HUMAN_HEADER = "x-opengeni-site-human";
+/**
+ * Required on every signed request: lowercase hex SHA-256 of the exact body
+ * bytes (of the empty string when there is no body), the same value the
+ * gateway signs as `bodySha256`. The API verifies the signature from the
+ * headers before it reads the body, then checks the body against this hash.
+ */
+export declare const SITE_GATEWAY_BODY_SHA256_HEADER = "x-opengeni-site-body-sha256";
+/** Reject signed requests whose timestamp differs from the API clock by more. */
+export declare const SITE_GATEWAY_MAX_SKEW_SECONDS = 30;
+export declare const SITE_GATEWAY_SIGNATURE_VERSION = "v1";
+export type SiteGatewaySignedFields = {
+    method: string;
+    /** Path and query exactly as sent to the API, starting with /v1/site-runtime. */
+    pathWithQuery: string;
+    /** Unix seconds. */
+    timestamp: number;
+    /** Lowercase hex SHA-256 of the exact request body bytes (of "" when empty). */
+    bodySha256: string;
+    host: string;
+    /** Raw site-session token, or "" when the viewer is not signed in. */
+    session: string;
+    /** Gateway-minted visitor id, or "". */
+    visitor: string;
+    clientIp: string;
+    /** "1" when the gateway verified a bot challenge for this visitor, else "". */
+    human: string;
+};
+/**
+ * The exact string both sides HMAC-SHA256 with the shared gateway secret.
+ * The header carries `v1=<base64url signature>`; during secret rotation the
+ * API accepts the current or the previous secret.
+ */
+export declare function siteGatewayCanonicalString(fields: SiteGatewaySignedFields): string;
+/**
+ * The rebuildable host-map record the gateway reads from KV (`host:<hostname>`)
+ * and, on a miss, from GET /v1/site-runtime/host. Postgres is the source of truth.
+ */
+export declare const SiteHostMapRecord: z.ZodObject<{
+    v: z.ZodLiteral<1>;
+    hostname: z.ZodString;
+    siteId: z.ZodString;
+    status: z.ZodEnum<{
+        active: "active";
+        suspended: "suspended";
+        unpublished: "unpublished";
+    }>;
+    access: z.ZodEnum<{
+        invited: "invited";
+        members: "members";
+        public: "public";
+    }>;
+    versionId: z.ZodNullable<z.ZodString>;
+    title: z.ZodString;
+    noindex: z.ZodBoolean;
+    generation: z.ZodNumber;
+    updatedAt: z.ZodString;
+}, z.core.$strip>;
+export type SiteHostMapRecord = z.infer<typeof SiteHostMapRecord>;
+export declare function siteHostMapKey(hostname: string): string;
+/**
+ * usage_only: meter, never charge (the default). shadow: compute what
+ * credits mode would charge, without charging. credits: charge organization
+ * credits for usage above the workspace's monthly allowance.
+ */
+export declare const SitePlatformBillingMode: z.ZodEnum<{
+    credits: "credits";
+    shadow: "shadow";
+    usage_only: "usage_only";
+}>;
+export type SitePlatformBillingMode = z.infer<typeof SitePlatformBillingMode>;
+/** Gateway requests, Site SQL rows read and written, and Site SQL plus Site Data storage. */
+export declare const SitePlatformMeter: z.ZodEnum<{
+    requests: "requests";
+    sql_rows_read: "sql_rows_read";
+    sql_rows_written: "sql_rows_written";
+    storage_bytes: "storage_bytes";
+}>;
+export type SitePlatformMeter = z.infer<typeof SitePlatformMeter>;
+export declare const SitePlatformMeterUsage: z.ZodObject<{
+    meter: z.ZodEnum<{
+        requests: "requests";
+        sql_rows_read: "sql_rows_read";
+        sql_rows_written: "sql_rows_written";
+        storage_bytes: "storage_bytes";
+    }>;
+    used: z.ZodNumber;
+    peak: z.ZodNumber;
+    allowance: z.ZodNumber;
+    priceMicros: z.ZodNumber;
+    priceUnit: z.ZodNumber;
+    estimatedMicros: z.ZodNumber;
+}, z.core.$strip>;
+export type SitePlatformMeterUsage = z.infer<typeof SitePlatformMeterUsage>;
+/** The Opengeni-wide brake on Site platform usage (see docs/published-sites.md). */
+export declare const SitePlatformBrakeState: z.ZodObject<{
+    engaged: z.ZodBoolean;
+    engagedAt: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export type SitePlatformBrakeState = z.infer<typeof SitePlatformBrakeState>;
+/** GET /v1/workspaces/:ws/site-platform-usage */
+export declare const SitePlatformUsage: z.ZodObject<{
+    workspaceId: z.ZodString;
+    periodStart: z.ZodString;
+    billingMode: z.ZodEnum<{
+        credits: "credits";
+        shadow: "shadow";
+        usage_only: "usage_only";
+    }>;
+    meters: z.ZodArray<z.ZodObject<{
+        meter: z.ZodEnum<{
+            requests: "requests";
+            sql_rows_read: "sql_rows_read";
+            sql_rows_written: "sql_rows_written";
+            storage_bytes: "storage_bytes";
+        }>;
+        used: z.ZodNumber;
+        peak: z.ZodNumber;
+        allowance: z.ZodNumber;
+        priceMicros: z.ZodNumber;
+        priceUnit: z.ZodNumber;
+        estimatedMicros: z.ZodNumber;
+    }, z.core.$strip>>;
+    estimatedMicros: z.ZodNumber;
+    chargedMicros: z.ZodNumber;
+    shadowMicros: z.ZodNumber;
+    brake: z.ZodObject<{
+        engaged: z.ZodBoolean;
+        engagedAt: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type SitePlatformUsage = z.infer<typeof SitePlatformUsage>;
+/** details.code of the 503 every brake refusal carries. */
+export declare const SITE_PLATFORM_BRAKE_ERROR_CODE: "site_platform_brake_engaged";
+/** details.code of the 402 a workspace past its allowance without credits gets (credits mode). */
+export declare const SITE_PLATFORM_QUOTA_ERROR_CODE: "site_platform_quota_exhausted";
+export * from "./site-operations.js";
+/**
+ * Additional MessagePort bridge request methods, served by both hosts:
+ * - `viewer`: returns SiteViewer (console: the signed-in member).
+ * - `auth.signIn`: asks the host to sign the viewer in. The gateway shell
+ *   navigates the top window to /_og/auth/login; the console resolves
+ *   immediately because its viewer is already signed in. Returns
+ *   `{ started: boolean }`.
+ * The ready message advertises them with `viewer: 1`.
+ */
+export declare const SITE_BRIDGE_VIEWER_METHOD: "viewer";
+export declare const SITE_BRIDGE_SIGN_IN_METHOD: "auth.signIn";