@stackbox/cms 0.0.5 → 0.1.0

package/dist/types.d.ts

@@ -0,0 +1,277 @@
+import { html, type HSHtml } from "@hyperspan/html";
+import type { z } from "zod";
+type HtmlSafe = ReturnType<typeof html.raw>;
+export declare namespace Stackbox {
+    type CookieOptions = {
+        maxAge?: number;
+        domain?: string;
+        path?: string;
+        expires?: Date;
+        httpOnly?: boolean;
+        secure?: boolean;
+        sameSite?: "lax" | "strict" | true;
+    };
+    type Cookies = {
+        _req: globalThis.Request;
+        _responseHeaders: Headers | undefined;
+        _parsedCookies: Record<string, string>;
+        _encrypt: ((str: string) => string) | undefined;
+        _decrypt: ((str: string) => string) | undefined;
+        get: (name: string) => string | undefined;
+        set: (name: string, value: string, options?: CookieOptions) => void;
+        delete: (name: string) => void;
+    };
+    type Request = {
+        url: URL;
+        raw: globalThis.Request;
+        method: string;
+        headers: Headers;
+        query: URLSearchParams;
+        cookies: Cookies;
+        text: () => Promise<string>;
+        json: <T = unknown>() => Promise<T>;
+        formData: () => Promise<FormData>;
+        urlencoded: () => Promise<URLSearchParams>;
+    };
+    type Response = {
+        cookies: Cookies;
+        headers: Headers;
+        status: number | undefined;
+        html: (html: string, options?: ResponseInit) => Promise<globalThis.Response>;
+        json: (json: unknown, options?: ResponseInit) => Promise<globalThis.Response>;
+        text: (text: string, options?: ResponseInit) => Promise<globalThis.Response>;
+        redirect: (url: string, options?: ResponseInit) => Promise<globalThis.Response>;
+        error: (error: Error, options?: ResponseInit) => Promise<globalThis.Response>;
+        notFound: (options?: ResponseInit) => Promise<globalThis.Response>;
+        merge: (response: globalThis.Response) => Promise<globalThis.Response>;
+    };
+    interface Context<TEnv extends Record<string, unknown> = Record<string, unknown>> {
+        env: TEnv;
+        req: Request;
+        res: Response;
+    }
+    type CacheBounds = {
+        min?: number;
+        max?: number;
+    };
+    type CacheConfig = CacheBounds | false;
+    type CacheEntry = {
+        html: string;
+        expiresAt: number;
+    };
+    type CacheAdapter = {
+        get(key: string): CacheEntry | undefined | Promise<CacheEntry | undefined>;
+        set(key: string, entry: CacheEntry): void | Promise<void>;
+    };
+    type SiteConfig<T extends Record<string, unknown> = Record<string, unknown>> = {
+        readonly __kind: "siteConfig";
+        readonly config: T;
+    };
+    type BlockRenderResult = HSHtml | Promise<HSHtml>;
+    type RenderContext = {
+        siteConfig: SiteConfig;
+        ctx?: Context;
+        page?: SitePage;
+        hooks?: SiteHooks;
+    };
+    type Block = {
+        readonly __kind: "block";
+        readonly name: string;
+        readonly cache?: CacheConfig;
+        readonly source?: string;
+        render(ctx: RenderContext): BlockRenderResult;
+    };
+    type BlockOptionsOf<F> = F extends (options?: infer O) => unknown ? [O] extends [undefined] ? undefined : O : never;
+    type BlockFactory<TOptions = undefined> = (options?: TOptions) => Block;
+    type DefaultSlotContent = Block | string;
+    type SlotOptions = {
+        required?: boolean;
+        primary?: true;
+        schema?: z.ZodTypeAny;
+    };
+    type SlotDefinition = {
+        name: string;
+        options?: SlotOptions;
+    };
+    type SlotMeta = {
+        isDefault: boolean;
+        required: boolean;
+        schema?: z.ZodTypeAny;
+    };
+    type SlotNamesFrom<S extends readonly SlotDefinition[]> = S[number]["name"];
+    type RequiredSlotNamesFrom<S extends readonly SlotDefinition[]> = Extract<S[number], {
+        options: {
+            required: true;
+        };
+    } | {
+        options: {
+            primary: true;
+        };
+    }>["name"];
+    type SlotContentFromDefinition<D extends SlotDefinition> = D extends {
+        options: {
+            schema: infer Schema extends z.ZodTypeAny;
+        };
+    } ? z.input<Schema> : DefaultSlotContent;
+    type PageSlotsInput<S extends readonly SlotDefinition[], Required extends string> = {
+        [K in Required]: SlotContentFromDefinition<Extract<S[number], {
+            name: K;
+        }>>[];
+    } & Partial<{
+        [K in Exclude<SlotNamesFrom<S>, Required>]: SlotContentFromDefinition<Extract<S[number], {
+            name: K;
+        }>>[];
+    }>;
+    type SlotRenderValue = HSHtml | HtmlSafe | Promise<HSHtml>;
+    type Slot<TContent = DefaultSlotContent, D extends SlotDefinition = SlotDefinition> = {
+        readonly name: D["name"];
+        readonly definition: D;
+        readonly content: readonly TContent[];
+        render(): SlotRenderValue;
+    };
+    type TemplateSlotsFrom<S extends readonly SlotDefinition[]> = {
+        [K in SlotNamesFrom<S>]: Slot<SlotContentFromDefinition<Extract<S[number], {
+            name: K;
+        }>>, Extract<S[number], {
+            name: K;
+        }>>;
+    };
+    type PageMeta = {
+        description?: string;
+        robots?: string;
+        canonical?: string;
+        ogTitle?: string;
+        ogDescription?: string;
+        ogImage?: string;
+        twitterCard?: string;
+    };
+    type Page<Slots extends string = string, RequiredSlots extends Slots = never, Definitions extends readonly SlotDefinition[] = readonly SlotDefinition[]> = {
+        readonly __kind: "page";
+        path: string;
+        template: TemplateDescriptor<Slots, RequiredSlots, Definitions>;
+        title: string;
+        meta?: PageMeta;
+        cache?: CacheConfig;
+        source?: string;
+        slots: PageSlotsInput<Definitions, RequiredSlots>;
+    };
+    type SitePage = {
+        readonly __kind: "page";
+        path: string;
+        template: TemplateDescriptor<string, string>;
+        title: string;
+        meta?: PageMeta;
+        cache?: CacheConfig;
+        source?: string;
+        slots: Partial<Record<string, DefaultSlotContent[]>>;
+    };
+    type PageRenderView = Omit<Page, "template" | "slots">;
+    type TemplateRenderContext<S extends readonly SlotDefinition[] = readonly SlotDefinition[]> = {
+        head?: HSHtml;
+        siteConfig: SiteConfig;
+        page: PageRenderView;
+        slots: TemplateSlotsFrom<S>;
+    };
+    type TemplateRenderFn = (ctx: {
+        head?: HSHtml;
+        siteConfig: SiteConfig;
+        page: PageRenderView;
+        slots: Record<string, Slot>;
+    }) => HSHtml;
+    type TemplateDescriptor<Slots extends string = string, RequiredSlots extends Slots = never, Definitions extends readonly SlotDefinition[] = readonly SlotDefinition[]> = {
+        readonly __kind: "template";
+        siteConfig: SiteConfig;
+        formatPageTitle: (title: string) => string;
+        render: TemplateRenderFn;
+        slots: Record<Slots, SlotMeta>;
+        requiredSlots: readonly RequiredSlots[];
+        readonly __definitions?: Definitions;
+    };
+    type PluginRoute = {
+        path: string;
+        fetch: (request: globalThis.Request, ctx: Context) => globalThis.Response | Promise<globalThis.Response>;
+    };
+    type PluginRouteContext = {
+        site: Site;
+    };
+    type PluginBuildContext = {
+        site: Site;
+        outDir: string;
+        publicDir: string;
+    };
+    type Plugin = {
+        readonly __kind: "plugin";
+        readonly name: string;
+        readonly description: string;
+        readonly version: string;
+        readonly keywords: readonly string[];
+        readonly root: string;
+        readonly assetsDir: string;
+        readonly publicAssetsDir: string;
+        routes?: (ctx: PluginRouteContext) => readonly PluginRoute[] | Promise<readonly PluginRoute[]>;
+        build?: (ctx: PluginBuildContext) => void | Promise<void>;
+    };
+    type CreatePluginOptions = {
+        name: string;
+        description: string;
+        version: string;
+        keywords: readonly string[];
+        root: string;
+        routes?: (ctx: PluginRouteContext) => readonly PluginRoute[] | Promise<readonly PluginRoute[]>;
+        build?: (ctx: PluginBuildContext) => void | Promise<void>;
+    };
+    type Site<T extends Record<string, unknown> = Record<string, unknown>> = {
+        readonly __kind: "site";
+        readonly siteConfig: SiteConfig<T>;
+        readonly pages: readonly SitePage[];
+        readonly plugins: readonly Plugin[];
+        fetch(request: globalThis.Request, env?: Record<string, unknown>): Promise<globalThis.Response>;
+    };
+    type RenderSlotItemInfo = {
+        item: Block | string;
+        slot: string;
+        index: number;
+        page: SitePage;
+        ctx?: Context;
+    };
+    type AfterRenderInfo = {
+        page: SitePage;
+        ctx?: Context;
+    };
+    type BeforeResponseInfo = {
+        request: globalThis.Request;
+        page?: SitePage;
+        ctx: Context;
+    };
+    type SiteHooks = {
+        shouldCache?: (request: globalThis.Request) => boolean;
+        renderSlotItem?: (html: string, info: RenderSlotItemInfo) => string | Promise<string>;
+        afterRender?: (html: string, info: AfterRenderInfo) => string | Promise<string>;
+        beforeResponse?: (response: globalThis.Response, info: BeforeResponseInfo) => globalThis.Response | Promise<globalThis.Response>;
+    };
+    type BuildSettings = {
+        readonly outDir: string;
+        readonly publicDir: string;
+    };
+    type BuildOptions = {
+        site: Site;
+        outDir?: string;
+        publicDir?: string;
+    };
+    type BuildResult = {
+        readonly settings: BuildSettings;
+        readonly plugins: readonly Plugin[];
+    };
+    type BuildCliArgs = {
+        readonly command: "build";
+        readonly site?: string;
+        readonly outDir?: string;
+        readonly publicDir?: string;
+    };
+    type PluginAssetRequest = {
+        plugin: string;
+        relativePath: string;
+    };
+}
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,KAAK,MAAM,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAE7B,KAAK,QAAQ,GAAG,UAAU,CAAC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;AAE5C,yBAAiB,QAAQ,CAAC;IACxB,KAAY,aAAa,GAAG;QAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,OAAO,CAAC,EAAE,IAAI,CAAC;QACf,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,QAAQ,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,IAAI,CAAC;KACpC,CAAC;IAEF,KAAY,OAAO,GAAG;QACpB,IAAI,EAAE,UAAU,CAAC,OAAO,CAAC;QACzB,gBAAgB,EAAE,OAAO,GAAG,SAAS,CAAC;QACtC,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACvC,QAAQ,EAAE,CAAC,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC,GAAG,SAAS,CAAC;QAChD,QAAQ,EAAE,CAAC,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC,GAAG,SAAS,CAAC;QAChD,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,CAAC;QAC1C,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,KAAK,IAAI,CAAC;QACpE,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;KAChC,CAAC;IAEF,KAAY,OAAO,GAAG;QACpB,GAAG,EAAE,GAAG,CAAC;QACT,GAAG,EAAE,UAAU,CAAC,OAAO,CAAC;QACxB,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,OAAO,CAAC;QACjB,KAAK,EAAE,eAAe,CAAC;QACvB,OAAO,EAAE,OAAO,CAAC;QACjB,IAAI,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;QAC5B,IAAI,EAAE,CAAC,CAAC,GAAG,OAAO,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC;QACpC,QAAQ,EAAE,MAAM,OAAO,CAAC,QAAQ,CAAC,CAAC;QAClC,UAAU,EAAE,MAAM,OAAO,CAAC,eAAe,CAAC,CAAC;KAC5C,CAAC;IAEF,KAAY,QAAQ,GAAG;QACrB,OAAO,EAAE,OAAO,CAAC;QACjB,OAAO,EAAE,OAAO,CAAC;QACjB,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;QAC3B,IAAI,EAAE,CACJ,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,YAAY,KACnB,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAClC,IAAI,EAAE,CACJ,IAAI,EAAE,OAAO,EACb,OAAO,CAAC,EAAE,YAAY,KACnB,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAClC,IAAI,EAAE,CACJ,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,YAAY,KACnB,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAClC,QAAQ,EAAE,CACR,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,YAAY,KACnB,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAClC,KAAK,EAAE,CACL,KAAK,EAAE,KAAK,EACZ,OAAO,CAAC,EAAE,YAAY,KACnB,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAClC,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,YAAY,KAAK,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QACnE,KAAK,EAAE,CAAC,QAAQ,EAAE,UAAU,CAAC,QAAQ,KAAK,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;KACxE,CAAC;IAEF,UAAiB,OAAO,CACtB,IAAI,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;QAE9D,GAAG,EAAE,IAAI,CAAC;QACV,GAAG,EAAE,OAAO,CAAC;QACb,GAAG,EAAE,QAAQ,CAAC;KACf;IAED,KAAY,WAAW,GAAG;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAEzD,KAAY,WAAW,GAAG,WAAW,GAAG,KAAK,CAAC;IAE9C,KAAY,UAAU,GAAG;QACvB,IAAI,EAAE,MAAM,CAAC;QACb,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;IAEF,KAAY,YAAY,GAAG;QACzB,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC;QAC3E,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;KAC3D,CAAC;IAEF,KAAY,UAAU,CACpB,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACzD;QACF,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;QAC9B,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;KACpB,CAAC;IAEF,KAAY,iBAAiB,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAEzD,KAAY,aAAa,GAAG;QAC1B,UAAU,EAAE,UAAU,CAAC;QACvB,GAAG,CAAC,EAAE,OAAO,CAAC;QACd,IAAI,CAAC,EAAE,QAAQ,CAAC;QAChB,KAAK,CAAC,EAAE,SAAS,CAAC;KACnB,CAAC;IAEF,KAAY,KAAK,GAAG;QAClB,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;QACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,KAAK,CAAC,EAAE,WAAW,CAAC;QAC7B,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QACzB,MAAM,CAAC,GAAG,EAAE,aAAa,GAAG,iBAAiB,CAAC;KAC/C,CAAC;IAEF,KAAY,cAAc,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,KAAK,OAAO,GACpE,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,GACrB,SAAS,GACT,CAAC,GACH,KAAK,CAAC;IAEV,KAAY,YAAY,CAAC,QAAQ,GAAG,SAAS,IAAI,CAC/C,OAAO,CAAC,EAAE,QAAQ,KACf,KAAK,CAAC;IAEX,KAAY,kBAAkB,GAAG,KAAK,GAAG,MAAM,CAAC;IAEhD,KAAY,WAAW,GAAG;QACxB,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,OAAO,CAAC,EAAE,IAAI,CAAC;QACf,MAAM,CAAC,EAAE,CAAC,CAAC,UAAU,CAAC;KACvB,CAAC;IAEF,KAAY,cAAc,GAAG;QAC3B,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,CAAC,EAAE,WAAW,CAAC;KACvB,CAAC;IAEF,KAAY,QAAQ,GAAG;QACrB,SAAS,EAAE,OAAO,CAAC;QACnB,QAAQ,EAAE,OAAO,CAAC;QAClB,MAAM,CAAC,EAAE,CAAC,CAAC,UAAU,CAAC;KACvB,CAAC;IAEF,KAAY,aAAa,CAAC,CAAC,SAAS,SAAS,cAAc,EAAE,IAC3D,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC;IAEpB,KAAY,qBAAqB,CAAC,CAAC,SAAS,SAAS,cAAc,EAAE,IACnE,OAAO,CACL,CAAC,CAAC,MAAM,CAAC,EACT;QAAE,OAAO,EAAE;YAAE,QAAQ,EAAE,IAAI,CAAA;SAAE,CAAA;KAAE,GAAG;QAAE,OAAO,EAAE;YAAE,OAAO,EAAE,IAAI,CAAA;SAAE,CAAA;KAAE,CACjE,CAAC,MAAM,CAAC,CAAC;IAEZ,KAAY,yBAAyB,CAAC,CAAC,SAAS,cAAc,IAC5D,CAAC,SAAS;QAAE,OAAO,EAAE;YAAE,MAAM,EAAE,MAAM,MAAM,SAAS,CAAC,CAAC,UAAU,CAAA;SAAE,CAAA;KAAE,GAChE,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,GACf,kBAAkB,CAAC;IAEzB,KAAY,cAAc,CACxB,CAAC,SAAS,SAAS,cAAc,EAAE,EACnC,QAAQ,SAAS,MAAM,IACrB;SACD,CAAC,IAAI,QAAQ,GAAG,yBAAyB,CACxC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE;YAAE,IAAI,EAAE,CAAC,CAAA;SAAE,CAAC,CAChC,EAAE;KACJ,GAAG,OAAO,CAAC;SACT,CAAC,IAAI,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG,yBAAyB,CACnE,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE;YAAE,IAAI,EAAE,CAAC,CAAA;SAAE,CAAC,CAChC,EAAE;KACJ,CAAC,CAAC;IAEH,KAAY,eAAe,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAElE,KAAY,IAAI,CACd,QAAQ,GAAG,kBAAkB,EAC7B,CAAC,SAAS,cAAc,GAAG,cAAc,IACvC;QACF,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;QACzB,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;QACvB,QAAQ,CAAC,OAAO,EAAE,SAAS,QAAQ,EAAE,CAAC;QACtC,MAAM,IAAI,eAAe,CAAC;KAC3B,CAAC;IAEF,KAAY,iBAAiB,CAAC,CAAC,SAAS,SAAS,cAAc,EAAE,IAAI;SAClE,CAAC,IAAI,aAAa,CAAC,CAAC,CAAC,GAAG,IAAI,CAC3B,yBAAyB,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE;YAAE,IAAI,EAAE,CAAC,CAAA;SAAE,CAAC,CAAC,EAC1D,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE;YAAE,IAAI,EAAE,CAAC,CAAA;SAAE,CAAC,CAChC;KACF,CAAC;IAEF,KAAY,QAAQ,GAAG;QACrB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;IAEF,KAAY,IAAI,CACd,KAAK,SAAS,MAAM,GAAG,MAAM,EAC7B,aAAa,SAAS,KAAK,GAAG,KAAK,EACnC,WAAW,SAAS,SAAS,cAAc,EAAE,GAAG,SAAS,cAAc,EAAE,IACvE;QACF,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QACxB,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,EAAE,kBAAkB,CAAC,KAAK,EAAE,aAAa,EAAE,WAAW,CAAC,CAAC;QAChE,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,QAAQ,CAAC;QAChB,KAAK,CAAC,EAAE,WAAW,CAAC;QACpB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,KAAK,EAAE,cAAc,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;KACnD,CAAC;IAEF,KAAY,QAAQ,GAAG;QACrB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QACxB,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,EAAE,kBAAkB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC7C,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,QAAQ,CAAC;QAChB,KAAK,CAAC,EAAE,WAAW,CAAC;QACpB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC;KACtD,CAAC;IAEF,KAAY,cAAc,GAAG,IAAI,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,CAAC;IAE9D,KAAY,qBAAqB,CAC/B,CAAC,SAAS,SAAS,cAAc,EAAE,GAAG,SAAS,cAAc,EAAE,IAC7D;QACF,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,UAAU,EAAE,UAAU,CAAC;QACvB,IAAI,EAAE,cAAc,CAAC;QACrB,KAAK,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC;KAC7B,CAAC;IAEF,KAAY,gBAAgB,GAAG,CAAC,GAAG,EAAE;QACnC,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,UAAU,EAAE,UAAU,CAAC;QACvB,IAAI,EAAE,cAAc,CAAC;QACrB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;KAC7B,KAAK,MAAM,CAAC;IAEb,KAAY,kBAAkB,CAC5B,KAAK,SAAS,MAAM,GAAG,MAAM,EAC7B,aAAa,SAAS,KAAK,GAAG,KAAK,EACnC,WAAW,SAAS,SAAS,cAAc,EAAE,GAAG,SAAS,cAAc,EAAE,IACvE;QACF,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC;QAC5B,UAAU,EAAE,UAAU,CAAC;QACvB,eAAe,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;QAC3C,MAAM,EAAE,gBAAgB,CAAC;QACzB,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QAC/B,aAAa,EAAE,SAAS,aAAa,EAAE,CAAC;QACxC,QAAQ,CAAC,aAAa,CAAC,EAAE,WAAW,CAAC;KACtC,CAAC;IAEF,KAAY,WAAW,GAAG;QACxB,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,CACL,OAAO,EAAE,UAAU,CAAC,OAAO,EAC3B,GAAG,EAAE,OAAO,KACT,UAAU,CAAC,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;KACzD,CAAC;IAEF,KAAY,kBAAkB,GAAG;QAC/B,IAAI,EAAE,IAAI,CAAC;KACZ,CAAC;IAEF,KAAY,kBAAkB,GAAG;QAC/B,IAAI,EAAE,IAAI,CAAC;QACX,MAAM,EAAE,MAAM,CAAC;QACf,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;IAEF,KAAY,MAAM,GAAG;QACnB,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC;QAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;QAC7B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;QACzB,QAAQ,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;QACrC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;QAC3B,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;QACjC,MAAM,CAAC,EAAE,CACP,GAAG,EAAE,kBAAkB,KACpB,SAAS,WAAW,EAAE,GAAG,OAAO,CAAC,SAAS,WAAW,EAAE,CAAC,CAAC;QAC9D,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,kBAAkB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;KAC3D,CAAC;IAEF,KAAY,mBAAmB,GAAG;QAChC,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;QACpB,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;QAC5B,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,CAAC,EAAE,CACP,GAAG,EAAE,kBAAkB,KACpB,SAAS,WAAW,EAAE,GAAG,OAAO,CAAC,SAAS,WAAW,EAAE,CAAC,CAAC;QAC9D,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,kBAAkB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;KAC3D,CAAC;IAEF,KAAY,IAAI,CACd,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACzD;QACF,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QACxB,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;QACnC,QAAQ,CAAC,KAAK,EAAE,SAAS,QAAQ,EAAE,CAAC;QACpC,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;QACpC,KAAK,CACH,OAAO,EAAE,UAAU,CAAC,OAAO,EAC3B,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC5B,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;KACjC,CAAC;IAEF,KAAY,kBAAkB,GAAG;QAC/B,IAAI,EAAE,KAAK,GAAG,MAAM,CAAC;QACrB,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,QAAQ,CAAC;QACf,GAAG,CAAC,EAAE,OAAO,CAAC;KACf,CAAC;IAEF,KAAY,eAAe,GAAG;QAC5B,IAAI,EAAE,QAAQ,CAAC;QACf,GAAG,CAAC,EAAE,OAAO,CAAC;KACf,CAAC;IAEF,KAAY,kBAAkB,GAAG;QAC/B,OAAO,EAAE,UAAU,CAAC,OAAO,CAAC;QAC5B,IAAI,CAAC,EAAE,QAAQ,CAAC;QAChB,GAAG,EAAE,OAAO,CAAC;KACd,CAAC;IAEF,KAAY,SAAS,GAAG;QACtB,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,UAAU,CAAC,OAAO,KAAK,OAAO,CAAC;QACvD,cAAc,CAAC,EAAE,CACf,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,kBAAkB,KACrB,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QAC9B,WAAW,CAAC,EAAE,CACZ,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,eAAe,KAClB,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QAC9B,cAAc,CAAC,EAAE,CACf,QAAQ,EAAE,UAAU,CAAC,QAAQ,EAC7B,IAAI,EAAE,kBAAkB,KACrB,UAAU,CAAC,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;KACzD,CAAC;IAEF,KAAY,aAAa,GAAG;QAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QACxB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;KAC5B,CAAC;IAEF,KAAY,YAAY,GAAG;QACzB,IAAI,EAAE,IAAI,CAAC;QACX,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;IAEF,KAAY,WAAW,GAAG;QACxB,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC;QACjC,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;KACrC,CAAC;IAEF,KAAY,YAAY,GAAG;QACzB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;QAC1B,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QACvB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QACzB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;KAC7B,CAAC;IAEF,KAAY,kBAAkB,GAAG;QAC/B,MAAM,EAAE,MAAM,CAAC;QACf,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC;CACH"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stackbox/cms",
-  "version": "0.0.5",
+  "version": "0.1.0",
   "description": "Stackbox CMS engine",
   "type": "module",
   "license": "BSD-3-Clause",
@@ -14,7 +14,6 @@
   },
   "files": [
     "dist",
-    "AGENTS.md",
     "src/plugins"
   ],
   "exports": {
@@ -30,13 +29,24 @@
       "types": "./dist/plugins/random-quote/index.d.ts",
       "import": "./dist/plugins/random-quote/index.js"
     },
+    "./plugins/sitemap": {
+      "types": "./dist/plugins/sitemap/index.d.ts",
+      "import": "./dist/plugins/sitemap/index.js"
+    },
     "./link": {
       "types": "./dist/link.d.ts",
       "import": "./dist/link.js"
+    },
+    "./build": {
+      "types": "./dist/build.d.ts",
+      "import": "./dist/build.js"
     }
   },
+  "bin": {
+    "stackbox-cms": "./dist/cli.js"
+  },
   "scripts": {
-    "build": "tsc -p tsconfig.json && node scripts/copy-plugin-assets.mjs",
+    "build": "node scripts/emit-dist.mjs && node scripts/copy-plugin-assets.mjs && node scripts/generate-agents-md.mjs",
     "test": "npm run build && node --import tsx --test test/*.test.ts",
     "typecheck": "tsc --noEmit -p tsconfig.json",
     "prepack": "npm run build"

package/src/plugins/blog/AGENTS.md

@@ -18,6 +18,7 @@ The user asks for any of:
 
 ## Exports
 
+- **default export** — `createPlugin()` registration; pass to `createSite({ plugins })`
 - `createBlog()` — factory; returns `{ posts, listings }`
 - `BlogPostContent`, `BlogListingContent`, `Blog`, `BlogPost`, `BlogOptions` — types
 - `content[]` on post/listing objects accepts **blocks or HTML strings** — optional plugin blocks can be added later (e.g. share buttons)
@@ -60,7 +61,8 @@ Post paths: `{pathPrefix}/{slug}` where slug comes from frontmatter or filename.
 | --- | --- |
 | `content/blog/*.md` | Create markdown posts with frontmatter |
 | `pages/blog.ts` | Call `createBlog()`, map `listings` and `posts` to `createPage()` |
-| `server.ts` | Register `...blogListingPages` and `...blogPostPages` in `createSite({ pages })` |
+| `server.ts` | Register the default export plus `...blogListingPages` and `...blogPostPages` in `createSite({ pages, plugins })` |
+| `package.json` | Add `"build": "stackbox-cms build"` so registered plugin assets are copied |
 | `templates/site-template.ts` | Reuse existing site template (or create one) — blog does not ship its own |
 
 ## Markdown contract
@@ -121,10 +123,12 @@ export const blogPostPages = blog.posts.map((post) =>
 
 ```ts
 // server.ts
+import blogPlugin from "@stackbox/cms/plugins/blog";
 import { blogListingPages, blogPostPages } from "./pages/blog";
 
 export default createSite(siteConfig, {
   pages: [homePage, ...blogListingPages, ...blogPostPages],
+  plugins: [blogPlugin],
 });
 ```
 

package/src/plugins/blog/index.ts

@@ -1,19 +1,36 @@
-import type { PageMeta } from "../../pages.js";
-import type { DefaultSlotContent } from "../../slot-content.js";
+import { createPlugin } from "../../plugin.js";
+import type { Stackbox as SB } from "../../types.js";
 import { loadPosts, type BlogOptions, type BlogPost } from "./posts.js";
 
+export default createPlugin({
+  name: "sb-blog",
+  description:
+    "Load markdown posts at bundle time and return listing and post content objects to wire into createPage().",
+  version: "1.0.0",
+  keywords: [
+    "blog",
+    "posts",
+    "articles",
+    "journal",
+    "markdown posts",
+    "blog listing",
+    "blog page",
+  ],
+  root: import.meta.dirname,
+});
+
 export type { BlogPost, BlogOptions } from "./posts.js";
 
 export type BlogPostContent = {
   path: string;
   title: string;
-  meta?: PageMeta;
-  content: DefaultSlotContent[];
+  meta?: SB.PageMeta;
+  content: SB.DefaultSlotContent[];
 };
 
 export type BlogListingContent = {
   path: string;
-  content: DefaultSlotContent[];
+  content: SB.DefaultSlotContent[];
 };
 
 export type Blog = {

package/src/plugins/random-quote/AGENTS.md

@@ -17,8 +17,9 @@ This plugin is a **block-only** example — it exports no page factory or conten
 
 ## Exports
 
+- **default export** — `createPlugin()` registration; pass to `createSite({ plugins })` to serve `public_assets/`
 - `randomQuoteBlock(options?)` — block factory; `{ quotes }` overrides bundled defaults
-- `defaultQuotes` — bundled quote array (imported from `public_assets/quotes.json`)
+- `defaultQuotes` — bundled quote array (imported from `assets/quotes.json`)
 - `pickRandomQuote(quotes)` — picks one quote at random
 - `Quote` — type `{ text, author }`
 - `RandomQuoteBlockOptions` — type `{ quotes?: readonly Quote[] }`
@@ -37,25 +38,37 @@ import myQuotes from "../content/quotes.json" with { type: "json" };
 slots: { sidebar: [randomQuoteBlock({ quotes: myQuotes })] }
 ```
 
-Custom JSON must be an array of `{ text, author }` objects — same shape as bundled `public_assets/quotes.json`.
-
-Bundled quotes are also served as a public asset at `/_sb/plugins/random-quote/quotes.json` (via `pluginAssetPath("random-quote", "quotes.json")` from `@stackbox/cms/link`).
+Custom JSON must be an array of `{ text, author }` objects — same shape as bundled `assets/quotes.json`.
 
 Each request renders a randomly selected quote from the configured list.
 
-## Public assets
+## Assets
+
+- `assets/quotes.json` — private; imported into JS as `defaultQuotes`
+- `public_assets/widget.css` — public; served at `/_sb/plugins/sb-random-quote/widget.css` **only after** this plugin is registered
+
+```ts
+import randomQuotePlugin from "@stackbox/cms/plugins/random-quote";
+
+export default createSite(siteConfig, {
+  pages: [homePage],
+  plugins: [randomQuotePlugin],
+});
+```
 
-Bundled quotes live in `public_assets/quotes.json`. The build copies this folder to `dist/public/_sb/plugins/random-quote/` automatically — do not edit the copy script.
+Use `pluginAssetPath("sb-random-quote", "widget.css")` from `@stackbox/cms/link` for the stylesheet href. Do not copy plugin assets by scanning a `plugins/` folder — run `npx stackbox-cms build` so the package build script copies only registered plugins.
 
 ## Files to create or update
 
 | File | Action |
 | --- | --- |
+| `server.ts` | Register the default export in `createSite({ plugins })` so public assets are served |
+| `package.json` | Add `"build": "stackbox-cms build"` so registered plugin assets are copied |
 | Any page using the block | Import `randomQuoteBlock` and add to a slot array |
 | `content/quotes.json` | Optional — user's own quotes when not using bundled defaults |
 | `templates/site-template.ts` | Ensure the target slot exists (e.g. `sidebar`, `content`) |
 
-No `pages/*.ts` or `server.ts` changes required unless adding the block to a new page.
+Register the plugin in `server.ts` whenever the block is used so `public_assets/` are served. No `pages/*.ts` changes unless adding the block to a new page.
 
 ## Wiring example
 
@@ -76,4 +89,14 @@ export const homePage = createPage(siteTemplate, {
 });
 ```
 
+```ts
+// server.ts
+import randomQuotePlugin from "@stackbox/cms/plugins/random-quote";
+
+export default createSite(siteConfig, {
+  pages: [homePage],
+  plugins: [randomQuotePlugin],
+});
+```
+
 Use `randomQuoteBlock()` without options to keep bundled defaults. Combine with other blocks or HTML strings in the same slot.

package/src/plugins/random-quote/index.ts

@@ -1,6 +1,22 @@
 import { html } from "@hyperspan/html";
 import { createBlock } from "../../blocks.js";
-import bundledQuotes from "./public_assets/quotes.json" with { type: "json" };
+import { createPlugin } from "../../plugin.js";
+import bundledQuotes from "./assets/quotes.json" with { type: "json" };
+
+export default createPlugin({
+  name: "sb-random-quote",
+  description:
+    "A block that renders a random inspirational quote, using bundled defaults or a site-supplied list.",
+  version: "1.0.0",
+  keywords: [
+    "random quote",
+    "quote of the day",
+    "inspirational quote",
+    "sidebar quote",
+    "quotation",
+  ],
+  root: import.meta.dirname,
+});
 
 export type Quote = {
   text: string;

package/src/plugins/random-quote/public_assets/widget.css

@@ -0,0 +1,5 @@
+[data-block="random-quote"] {
+  margin: 0;
+  padding: 0.75rem 1rem;
+  border-left: 3px solid currentColor;
+}

package/src/plugins/sitemap/AGENTS.md

@@ -0,0 +1,82 @@
+# Sitemap plugin — agent playbook
+
+## Use when
+
+The user asks for any of:
+
+- sitemap, sitemap.xml, XML sitemap
+- SEO crawl list, search engine indexing URLs
+- static sitemap file in the public folder
+
+## Do not
+
+- Hand-roll sitemap XML — use `createSitemap()` or the default export
+- Put `/sitemap.xml` in `createPage()` — the plugin registers that route
+- Forget to register the plugin on `createSite({ plugins })`
+
+## Exports
+
+- **default export** — `createSitemap()` registration; pass to `createSite({ plugins })`
+- `createSitemap(options?)` — factory when you need `baseUrl`, `extraUrls`, or `exclude`
+- `renderSitemapXml(site, options?)` — shared XML renderer (fetch + build use this)
+- `collectSitemapUrls(site, options?)` — absolute `<loc>` URLs
+- `SitemapOptions` — type
+
+## API
+
+```ts
+import sitemapPlugin, { createSitemap } from "@stackbox/cms/plugins/sitemap";
+
+createSitemap({
+  baseUrl?: string,              // defaults to siteConfig.config.url
+  extraUrls?: string[],          // site-relative or absolute
+  exclude?: string[] | ((path) => boolean),
+});
+```
+
+**URLs included**
+
+- Every `createPage()` path (origin + path)
+- `extraUrls`
+- Pages with `meta.robots` containing `noindex` are excluded
+- Paths in `exclude` are dropped
+
+**Serving and static file**
+
+- `fetch("/sitemap.xml")` when the plugin is registered
+- `stackbox-cms build` writes `{publicDir}/sitemap.xml` via the plugin `build` hook
+
+## Files to create or update
+
+| File | Action |
+| --- | --- |
+| `server.ts` | Register the default export or `createSitemap(...)` in `createSite({ plugins })` |
+| `site.config.ts` | Ensure `url` is set (used as sitemap origin unless `baseUrl` is passed) |
+| `package.json` | Add `"build": "stackbox-cms build"` |
+
+## Wiring example
+
+```ts
+// server.ts
+import sitemapPlugin from "@stackbox/cms/plugins/sitemap";
+
+export default createSite(siteConfig, {
+  pages: [homePage, aboutPage],
+  plugins: [sitemapPlugin],
+});
+```
+
+```ts
+// With extra URLs and exclusions
+import { createSitemap } from "@stackbox/cms/plugins/sitemap";
+
+export default createSite(siteConfig, {
+  pages: [homePage, aboutPage],
+  plugins: [
+    createSitemap({
+      extraUrls: ["/llms.txt"],
+      exclude: ["/thanks"],
+    }),
+  ],
+});
+```