@marktiderman/genesis-sites 0.0.0-stage → 0.1.0

package/dist/web.d.ts

@@ -0,0 +1,118 @@
+import { f as FormsResolver, o as ReleaseSnapshot, R as ReleasePage, q as ResolvedForm } from './registry-CdgVymsu.js';
+import { p as SiteStore, b as BrandSource, R as ReservedPaths, c as FontInfo, q as SiteTheme } from './store-BzGw2i5J.js';
+import * as React from 'react';
+import 'zod';
+import '@marktiderman/genesis-design-system';
+
+/** Where this package serves its own files, under the site's base path. Reserved for pages. */
+declare const ASSETS_PREFIX = "/_gs";
+interface SiteRequestOptions {
+    /** The live path needs only `getLive`; preview needs the draft reads too. */
+    store: Pick<SiteStore, "getLive"> & Partial<Pick<SiteStore, "getDraft" | "listPages" | "getPageDraft">>;
+    brand: BrandSource;
+    /** The site this request is for, resolved by the host from the Host header (or a path). */
+    siteId: string;
+    /**
+     * `live` (default) serves the published release, cached at the CDN.
+     * `preview` serves the drafts, `noindex` and `no-store`; the store must be
+     * one signed in as the viewer, so the database's `can_view` decides who sees them.
+     */
+    mode?: "live" | "preview";
+    /**
+     * The site's primary origin (`https://riverside.example`) for canonical,
+     * Open Graph and sitemap URLs. Default: the request URL's origin. Pass it
+     * whenever a site has more than one hostname, so every alias names the same
+     * canonical address.
+     */
+    origin?: string;
+    /** The path the site is mounted under (`/sites-demo`); `""` at the root. */
+    basePath?: string;
+    /** Paths that belong to the host app; null for them. Default `DEFAULT_RESERVED_PATHS`. */
+    reserved?: ReservedPaths;
+    /** Resolves a form embed's slug. Without it, form embeds render nothing (and log). */
+    forms?: FormsResolver;
+    /** Called with the cache tags of every cacheable response, for hosts that set their own cache headers. */
+    onPublishedTags?: (tags: string[], info: {
+        siteId: string;
+        releaseId: string | null;
+        path: string;
+        status: number;
+    }) => void;
+    /** An unknown path: `fall-through` (default) returns null; `not-found` serves the site's 404 page. */
+    unknownPath?: "fall-through" | "not-found";
+    /** Font stylesheets: Google Fonts by default, `false` for none, or a function returning a URL per font. */
+    fonts?: false | ((font: FontInfo) => string | null);
+    /** A Content-Security-Policy header (default true). */
+    csp?: boolean;
+}
+/**
+ * Serve a site request, or return null when the request isn't the site's.
+ *
+ * @stability Beta
+ */
+declare function handleSiteRequest(request: Request, options: SiteRequestOptions): Promise<Response | null>;
+/**
+ * One page as an HTML string (tests, static export, the editor's preview frame).
+ *
+ * @stability Beta
+ */
+declare function renderSitePageToString(request: Request, options: SiteRequestOptions): Promise<{
+    status: number;
+    html: string;
+    headers: Headers;
+} | null>;
+
+/**
+ * SiteRenderer: one page of a release as a whole HTML document. Server-only
+ * output: it is rendered to a string or stream and never hydrated. The only
+ * script is the islands loader, and only on a page with a phone menu or a
+ * form.
+ */
+
+interface SiteAssets {
+    /** The shared stylesheet. */
+    css: string;
+    /** The form stylesheet, linked only on pages with a form. */
+    formsCss: string;
+    /** The islands loader. */
+    islands: string;
+}
+interface SiteRendererProps {
+    snapshot: ReleaseSnapshot;
+    /** The page to render, or null for the site's "not found" page. */
+    page: ReleasePage | null;
+    theme: SiteTheme;
+    /** The site's primary origin, for canonical and Open Graph URLs. */
+    origin: string;
+    /** The path prefix the site is served under (`""` at the root). */
+    basePath?: string;
+    mode?: "live" | "preview";
+    logo?: {
+        src: string;
+        alt: string;
+    };
+    /** Forms on the page, already resolved (see `collectFormSlugs`). */
+    forms?: ReadonlyMap<string, ResolvedForm | null>;
+    /** Asset URLs. */
+    assets: SiteAssets;
+    /** The stylesheet URL for a font, or null to rely on installed fonts. Default: Google Fonts. */
+    fontHref?: ((font: FontInfo) => string | null) | false;
+}
+declare const googleFontHref: (font: FontInfo) => string | null;
+/** The form slugs a page uses, to resolve before rendering: well-formed slugs of visible form embeds in the page body. */
+declare function collectFormSlugs(_snapshot: ReleaseSnapshot, page: ReleasePage | null): string[];
+/**
+ * The document for one page.
+ *
+ * @stability Beta
+ */
+declare function SiteRenderer({ snapshot, page, theme, origin, basePath, mode, logo, forms, assets, fontHref }: SiteRendererProps): React.JSX.Element;
+
+declare const ASSET_SIZES: {
+    readonly css: 32183;
+    readonly formsCss: 72702;
+    readonly islands: 2431;
+    readonly formIsland: 502065;
+};
+
+export { ASSETS_PREFIX, ASSET_SIZES, type SiteAssets, SiteRenderer, type SiteRendererProps, type SiteRequestOptions, collectFormSlugs, googleFontHref, handleSiteRequest, renderSitePageToString };