@riebeckite/honox 0.0.17 → 0.0.19

package/dist/src/ui/primitives.d.ts

@@ -1,3 +1,4 @@
+import type { ContentBodySlot, ContentBodySlots } from "@riebeckite/core";
 export type PrimitiveChildren = unknown;
 export type PrimitiveProps = {
     children?: PrimitiveChildren;
@@ -12,6 +13,9 @@ export type ArticleProps = PrimitiveProps & {
     "data-slot"?: string;
 };
 export type ArticleLayoutProps = PrimitiveProps & {
+    /**
+     * @deprecated Render aside content as children instead.
+     */
     aside?: PrimitiveChildren;
 };
 export type ArticleHeaderProps = (PrimitiveClassProps & {
@@ -24,6 +28,10 @@ export type ArticleHeaderProps = (PrimitiveClassProps & {
     children?: PrimitiveChildren;
 });
 export type ArticleContentProps = (PrimitiveClassProps & {
+    /**
+     * @deprecated Render Markdown HTML with `ArticleBody` inside an
+     * `ArticleContent` shell instead.
+     */
     html: string;
     children?: never;
     "data-slot"?: string;
@@ -44,5 +52,32 @@ export declare function ArticleLayout(props: ArticleLayoutProps): import("hono/j
 export declare function ArticleHeader(props: ArticleHeaderProps): import("hono/jsx/jsx-dev-runtime").JSX.Element;
 export declare function ArticleMeta(props: ArticleMetaProps): import("hono/jsx/jsx-dev-runtime").JSX.Element;
 export declare function ArticleContent(props: ArticleContentProps): import("hono/jsx/jsx-dev-runtime").JSX.Element;
+export type ArticleBodyProps = PrimitiveClassProps & {
+    html: string;
+};
+export type ContentSlotProps = PrimitiveClassProps & {
+    slots?: ContentBodySlots;
+    name: ContentBodySlot;
+};
+/**
+ * Whether a body slot holds renderable content.
+ *
+ * A slot is absent when its source map is missing, the value is missing, or
+ * the value is whitespace-only. This is the same check `ContentSlot` uses.
+ */
+export declare function hasSlot(slots: ContentBodySlots | undefined, name: ContentBodySlot): boolean;
+/**
+ * Renders a Plugin-provided body slot fragment at the position the Site chose.
+ *
+ * The Site owns placement; this primitive owns the lookup, empty handling, and
+ * HTML injection. It renders nothing when the slot is absent or blank.
+ */
+export declare function ContentSlot(props: ContentSlotProps): import("hono/jsx/jsx-dev-runtime").JSX.Element;
+/**
+ * Renders Markdown-produced HTML as the canonical article body.
+ *
+ * Owns the `.rb-article-content` Stable Hook so Sites never hand-write it.
+ */
+export declare function ArticleBody(props: ArticleBodyProps): import("hono/jsx/jsx-dev-runtime").JSX.Element;
 export declare function ArticleFooter(props: ArticleFooterProps): import("hono/jsx/jsx-dev-runtime").JSX.Element;
 export declare function Sidebar(props: SidebarProps): import("hono/jsx/jsx-dev-runtime").JSX.Element;

package/dist/src/ui/primitives.js

@@ -68,6 +68,32 @@ function ArticleContent(props) {
   }
   return /* @__PURE__ */ jsx("div", { class: className, "data-slot": dataSlot, children: props.children });
 }
+function hasSlot(slots, name) {
+  return Boolean(slots?.[name]?.trim());
+}
+function ContentSlot(props) {
+  const html = props.slots?.[props.name];
+  if (!html?.trim()) {
+    return null;
+  }
+  return /* @__PURE__ */ jsx(
+    "div",
+    {
+      "data-slot": props.name,
+      class: joinClassNames(props.class, props.className) || void 0,
+      dangerouslySetInnerHTML: { __html: html }
+    }
+  );
+}
+function ArticleBody(props) {
+  return /* @__PURE__ */ jsx(
+    "div",
+    {
+      class: joinClassNames("rb-article-content", props.class, props.className),
+      dangerouslySetInnerHTML: { __html: props.html }
+    }
+  );
+}
 function ArticleFooter(props) {
   return /* @__PURE__ */ jsx(
     "footer",
@@ -92,10 +118,13 @@ function joinClassNames(...classNames) {
 }
 export {
   Article,
+  ArticleBody,
   ArticleContent,
   ArticleFooter,
   ArticleHeader,
   ArticleLayout,
   ArticleMeta,
-  Sidebar
+  ContentSlot,
+  Sidebar,
+  hasSlot
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/honox",
-  "version": "0.0.17",
+  "version": "0.0.19",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -12,12 +12,6 @@
       "source": "./index.ts",
       "default": "./dist/index.js"
     },
-    "./scaffold": {
-      "types": "./dist/src/scaffold/presets.d.ts",
-      "import": "./dist/src/scaffold/presets.js",
-      "source": "./src/scaffold/presets.ts",
-      "default": "./dist/src/scaffold/presets.js"
-    },
     "./server": {
       "types": "./dist/server.d.ts",
       "import": "./dist/server.js",
@@ -36,11 +30,11 @@
     "esbuild": "^0.28.2",
     "hono": "^4.12.25",
     "vite": "^8.0.9",
-    "@riebeckite/core": "0.0.17"
+    "@riebeckite/core": "0.0.19"
   },
   "devDependencies": {
     "tsx": "^4.22.4",
-    "@riebeckite/test": "0.0.17"
+    "@riebeckite/test": "0.0.19"
   },
   "publishConfig": {
     "access": "public"
@@ -49,7 +43,6 @@
     "LICENSE",
     "README.md",
     "README_ja.md",
-    "assets",
     "dist"
   ],
   "repository": {

package/dist/src/scaffold/app-templates.d.ts

@@ -1,15 +0,0 @@
-import type { ScaffoldPreset } from "./presets.js";
-export declare function server(): string;
-export declare function client(): string;
-export declare function appConfig(): string;
-export declare function appContent(): string;
-export declare function paths(): string;
-export declare function globalDeclarations(): string;
-export declare function style(preset: ScaffoldPreset): string;
-export declare function siteHeader(): string;
-export declare function article(): string;
-export declare function renderer(preset: ScaffoldPreset): string;
-export declare function bareRenderer(): string;
-export declare function indexRoute(preset: ScaffoldPreset): string;
-export declare function staticIndexRoute(): string;
-export declare function slugRoute(preset: ScaffoldPreset): string;

package/dist/src/scaffold/deployment.d.ts

@@ -1,8 +0,0 @@
-import type { SiteTemplateFile } from "./templates.js";
-export type ScaffoldDeploymentOptions = {
-    readonly contentRepository?: string;
-    readonly siteRepository?: string;
-};
-export declare function assertGitHubRepository(value: string, option: string): void;
-export declare function deploymentTemplateFiles(options: ScaffoldDeploymentOptions): readonly SiteTemplateFile[];
-export declare function wranglerJsoncFile(workerName: string): SiteTemplateFile;

package/dist/src/scaffold/index.d.ts

@@ -1,26 +0,0 @@
-import { type ScaffoldPreset, type ScaffoldPresetName } from "./presets.js";
-export type ScaffoldSiteOptions = {
-    readonly targetDirectory: string;
-    readonly name?: string;
-    readonly siteTitle?: string;
-    readonly description?: string;
-    readonly baseUrl?: string;
-    readonly locale?: string;
-    readonly preset?: ScaffoldPresetName | ScaffoldPreset;
-    readonly overwrite?: boolean;
-    /** Generate the Cloudflare Workers GitHub Actions workflow. */
-    readonly githubActions?: boolean;
-    readonly cloudflareWorkers?: boolean;
-    /** Read content from this separate GitHub repository during deployment. */
-    readonly contentRepository?: string;
-    /** Site repository to notify from the generated content workflow. */
-    readonly siteRepository?: string;
-};
-export type ScaffoldSiteResult = {
-    readonly targetDirectory: string;
-    readonly files: readonly string[];
-};
-export declare class ScaffoldSiteError extends Error {
-    constructor(message: string);
-}
-export declare function scaffoldRiebeckiteSite(options: ScaffoldSiteOptions): Promise<ScaffoldSiteResult>;

package/dist/src/scaffold/localized-content.d.ts

@@ -1,13 +0,0 @@
-import { type ScaffoldPreset } from "./presets.js";
-import { type SiteTemplateFile, type SiteTemplateVariables } from "./templates.js";
-/**
- * Generates the content pages for a scaffold preset.
- *
- * Localized pages (`index`, `framework/plugins`, `framework/themes`) follow the
- * l10n plugin convention: the default-language page keeps the plain name
- * (`index.md`) while every other language uses the `<base>.<lang>.md` suffix.
- * Presets without l10n emit the index in the site's default language only.
- * Extra pages (`guide`, `examples`, `reference/*`) are English-only and are
- * suffixed with `.en` when English is not the site's default language.
- */
-export declare function localizedContentFiles(variables: SiteTemplateVariables, preset: ScaffoldPreset): readonly SiteTemplateFile[];

package/dist/src/scaffold/next-steps.d.ts

@@ -1,7 +0,0 @@
-export type ScaffoldNextStepsOptions = {
-    /** First Markdown file to edit, when the scaffold wrote one. */
-    readonly editFile?: string;
-    /** The site keeps its content in a separate repository. */
-    readonly externalContent?: boolean;
-};
-export declare function formatScaffoldNextSteps(relativeDirectory: string, options?: ScaffoldNextStepsOptions): string;

package/dist/src/scaffold/presets.d.ts

@@ -1,103 +0,0 @@
-/**
- * Scaffold presets.
- *
- * A preset is the declarative description of one starter template. The
- * scaffolder consumes a preset to decide which files it generates:
- *
- * - which plugins are registered in `riebeckite.config.ts`
- * - which theme is applied
- * - which content pages are emitted (localized, or English-only extras)
- * - which `app/` shell files are written
- *
- * Presets are cumulative in spirit but defined explicitly so each tier is
- * self-contained and can be imported and reused on its own:
- *
- *    import { showcase, starter } from "@riebeckite/honox/scaffold";
- */
-export declare const SCAFFOLD_LANGUAGES: readonly ["en", "ja", "zh-CN", "es", "de", "fr", "ko"];
-export type ScaffoldLanguage = (typeof SCAFFOLD_LANGUAGES)[number];
-export declare function defaultLanguageForLocale(locale: string): string;
-export type ScaffoldPresetName = "starter" | "minimal" | "showcase" | "empty";
-export declare const SCAFFOLD_PRESET_NAMES: readonly ScaffoldPresetName[];
-export declare function isScaffoldPresetName(value: string): value is ScaffoldPresetName;
-/** How a theme factory is referenced in the generated config file. */
-export type ScaffoldThemeSpec = {
-    /** Npm package, for example `@riebeckite/theme-minimal`. */
-    readonly package: string;
-    /** Factory/import name, for example `minimalTheme`. */
-    readonly factory: string;
-    /** Optional literal source for the factory call arguments, e.g. `{ colorMode: "light" }`. */
-    readonly options?: string;
-};
-/** How a plugin factory is referenced in the generated config file. */
-export type ScaffoldPluginSpec = {
-    /** Npm package, for example `@riebeckite/plugin-seo`. */
-    readonly package: string;
-    /** Factory/import name, for example `seo`. */
-    readonly factory: string;
-    /** Options source for the factory call; see {@link ScaffoldOptions}. */
-    readonly options?: ScaffoldOptions;
-};
-/**
- * Context passed to option sources. `variables` are the user-supplied site
- * values (`title`, `baseUrl`, ...), `languages` the preset's configured
- * languages, and configuration detail depth. `showcase` uses depth 3 so its
- * generated config is a complete options reference; the other presets keep
- * their configuration intentionally small.
- */
-export type ScaffoldOptionContext = {
-    readonly variables: {
-        readonly name: string;
-        readonly title: string;
-        readonly description: string;
-        readonly baseUrl: string;
-        readonly locale: string;
-    };
-    readonly languages: readonly ScaffoldLanguage[];
-    readonly depth: number;
-};
-/** A single option value: a literal, or a function of the scaffold context. */
-export type ScaffoldOptionValue = string | ((context: ScaffoldOptionContext) => string);
-/** A config field gated to a minimum preset depth. */
-export type ScaffoldOptionField = {
-    /** The lowest `ScaffoldOptionContext.depth` that includes this field. */
-    readonly depth: number;
-    readonly value: ScaffoldOptionValue;
-};
-/**
- * Options for a generated plugin call: a literal source string, a function
- * producing one, or a field map whose fields appear from a minimum depth.
- * The field map form lets each preset tier demonstrate the configuration
- * surface step by step while keeping one source of truth per plugin.
- */
-export type ScaffoldOptions = string | ((context: ScaffoldOptionContext) => string) | Readonly<Record<string, ScaffoldOptionField>>;
-/** Content pages the scaffold can emit. */
-export type ScaffoldPageKey = "index" | "framework/plugins" | "framework/themes" | "guide" | "examples" | "reference/plugins" | "reference/themes";
-/** `app/` shell files the scaffold can emit. */
-export type ScaffoldAppFileKey = "server" | "client" | "config" | "content" | "paths" | "global" | "style" | "renderer" | "index" | "slug" | "header" | "article";
-/** README verbosity. */
-export type ScaffoldReadmeLevel = "short" | "standard" | "rich";
-export type ScaffoldPreset = {
-    readonly name: ScaffoldPresetName;
-    /** One-line human description, shown by `--list-presets`. */
-    readonly description: string;
-    /** Languages the l10n plugin is configured with. A single entry means no l10n. */
-    readonly languages: readonly ScaffoldLanguage[];
-    readonly theme: ScaffoldThemeSpec | null;
-    readonly plugins: readonly ScaffoldPluginSpec[];
-    readonly contentPages: readonly ScaffoldPageKey[];
-    /**
-     * Order-sensitive; the scaffolder writes `app/` files in this order.
-     * Structural files (`server`, `client`, `config`, `content`, `paths`,
-     * `global`, `style`, `renderer`) are always included.
-     */
-    readonly appFiles: readonly ScaffoldAppFileKey[];
-    readonly readme: ScaffoldReadmeLevel;
-};
-export declare const empty: ScaffoldPreset;
-export declare const minimal: ScaffoldPreset;
-export declare const starter: ScaffoldPreset;
-export declare const showcase: ScaffoldPreset;
-export declare const scaffoldPresets: Readonly<Record<ScaffoldPresetName, ScaffoldPreset>>;
-export declare const SCAFFOLD_DEFAULT_PRESET: ScaffoldPresetName;
-export declare function resolveScaffoldPreset(value: ScaffoldPresetName | ScaffoldPreset | undefined): ScaffoldPreset;