@sevenfold/setto-client 0.35.0 → 0.36.1

package/dist/types.d.ts

@@ -1,4 +1,5 @@
-import type { SectionSchema } from './section-schema';
+import type { SettoBlogData } from './blog/data.js';
+import type { SectionSchema } from './section-schema.js';
 export interface BrandColor {
     /** Display name in the swatch picker, e.g. 'Beige'. */
     label: string;
@@ -66,6 +67,13 @@ export interface SettoConfig {
     images?: {
         optimize?: boolean;
     };
+    /**
+     * The site's blog posts, as its build bundles them: `import blog from
+     * 'virtual:setto-blog'` with the `settoBlog()` plugin from
+     * `@setto/client/vite`. Without it the `blog` and `blog-latest` sections
+     * draw nothing.
+     */
+    blog?: SettoBlogData;
 }
 export interface DeploymentRow {
     id: string;

package/dist/vite/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * `@sevenfold/setto-client/vite` — build-time only. Runs in Node inside the
+ * site's Vite build; never imported by the site's browser code.
+ */
+export { settoBlog } from './plugin.js';
+export type { SettoBlogPluginOptions } from './plugin.js';

package/dist/vite/plugin.d.ts

@@ -0,0 +1,32 @@
+import type { Plugin } from 'vite';
+import { type BlogFrontmatter } from '../blog/contract.js';
+export interface SettoBlogPluginOptions {
+    /**
+     * The site's public address, for canonical links, `og:url`, RSS and the
+     * sitemap. Otherwise `SETTO_SITE_URL`, then Vercel's
+     * `VERCEL_PROJECT_PRODUCTION_URL`, then the first address in
+     * `public/sitemap.xml`. Without any, pages still get their own head, only
+     * with relative addresses, and no feed.
+     */
+    siteUrl?: string;
+    /** Hosts a post's images may come from. Setto's media store by default. */
+    imageHosts?: readonly string[];
+    /**
+     * Where the blog lives, for a site without a blog page in `pages.json`
+     * (one that routes by hand and mounts `<SettoBlog basePath>`). A blog page
+     * in the manifest wins.
+     */
+    blogPath?: string;
+}
+interface LoadedPost {
+    key: string;
+    frontmatter: BlogFrontmatter;
+    body: unknown;
+}
+export declare function loadPosts(root: string, imageHosts: readonly string[]): LoadedPost[];
+export declare function settoBlog(options?: SettoBlogPluginOptions): Plugin;
+/** Exported for tests: everything `writeBundle` does, given a built `outDir`. */
+export declare function writeStaticFiles(root: string, outDir: string, loaded: readonly LoadedPost[], options?: SettoBlogPluginOptions): {
+    written: string[];
+};
+export {};

package/dist/vite/static.d.ts

@@ -0,0 +1,78 @@
+/**
+ * The static files a blog adds to a site's build: one HTML page per post with
+ * its own head, the blog's index page, an RSS feed, and the posts in
+ * `sitemap.xml`.
+ *
+ * Why: the sites are single-page apps — every path is the same `index.html`.
+ * Google runs the JavaScript; Facebook, LinkedIn, X, Slack, Messenger and
+ * iMessage do not. They fetch the address and read the `og:` tags in the raw
+ * HTML, so without a file of its own a shared post shows the front page's
+ * title and picture. Vercel serves a real file before it applies the
+ * catch-all rewrite, so `/blogg/<slug>` gets this one and the app takes over
+ * in the browser as before.
+ *
+ * Pure functions over strings, so they can be tested without a build.
+ */
+import type { BlogFrontmatter } from '../blog/contract.js';
+export interface HeadMeta {
+    title: string;
+    description: string;
+    /** Absolute, when the site's address is known. */
+    url?: string;
+    /** Absolute. */
+    image?: string;
+    type: 'article' | 'website';
+    locale: string;
+    siteName?: string;
+    publishedTime?: string;
+    jsonLd?: Record<string, unknown>;
+    rssUrl?: string;
+    /** The same page in other languages, absolute; `x-default` for the primary. */
+    alternates?: {
+        hreflang: string;
+        href: string;
+    }[];
+}
+export declare const escapeXml: (value: string) => string;
+/**
+ * The site's `index.html` with a page's own head: its title, description,
+ * canonical address, Open Graph and Twitter tags and structured data. Any of
+ * those the front page already had are taken out first, so a crawler never
+ * reads two answers.
+ */
+export declare function withHead(indexHtml: string, meta: HeadMeta): string;
+/** `https://x.no` + `/blogg/a` — or the path alone when the address is unknown. */
+export declare function absolute(siteUrl: string | null, pathOrUrl: string): string;
+export interface PostHeadInput {
+    post: BlogFrontmatter;
+    blogPath: string;
+    siteUrl: string | null;
+    siteName?: string;
+}
+export declare function postHead({ post, blogPath, siteUrl, siteName }: PostHeadInput): HeadMeta;
+export declare function indexHead({ title, description, blogPath, siteUrl, siteName, locale, }: {
+    title: string;
+    description: string;
+    blogPath: string;
+    siteUrl: string | null;
+    siteName?: string;
+    locale: string;
+}): HeadMeta;
+export declare function rssFeed({ posts, blogPath, siteUrl, title, description, locale, }: {
+    posts: readonly BlogFrontmatter[];
+    blogPath: string;
+    siteUrl: string;
+    title: string;
+    description: string;
+    locale: string;
+}): string;
+/**
+ * The site's `sitemap.xml` with the blog and its posts added — before the
+ * closing tag, and only those not already listed.
+ */
+export declare function withSitemapEntries(sitemap: string, entries: readonly {
+    loc: string;
+    lastmod?: string;
+}[]): string;
+/** The site's own address, from the first `<loc>` of its sitemap. */
+export declare function originFromSitemap(sitemap: string): string | null;