@riebeckite/honox 0.0.4 → 0.0.6

package/dist/server.js

@@ -48,14 +48,22 @@ function decodeSegment(segment) {
 function mountRiebeckiteEndpoints(app, options) {
   const endpoints = collectPluginEndpoints(options.config);
   for (const endpoint of endpoints) {
-    app.get(endpoint.path, async (context) => {
+    const method = endpoint.method ?? "GET";
+    const handler = async (context) => {
       const manifest = await options.content.getManifest();
+      const request = await toPluginEndpointRequest(context, method);
       const response = await endpoint.handler({
         config: options.config,
-        manifest
+        manifest,
+        request
       });
       return toHonoResponse(context, response);
-    });
+    };
+    if (method === "POST") {
+      app.post(endpoint.path, handler);
+    } else {
+      app.get(endpoint.path, handler);
+    }
   }
 }
 function collectPluginEndpoints(config) {
@@ -102,6 +110,20 @@ function validateEndpointPath(path) {
     );
   }
 }
+async function toPluginEndpointRequest(context, method) {
+  const headers = {};
+  context.req.raw.headers.forEach((value, key) => {
+    headers[key.toLowerCase()] = value;
+  });
+  return {
+    method,
+    url: context.req.url,
+    path: context.req.path,
+    query: context.req.query(),
+    headers,
+    body: await context.req.text()
+  };
+}
 function toHonoResponse(context, response) {
   const status = response.status ?? 200;
   if ("json" in response) {

package/dist/src/endpoints.d.ts

@@ -5,8 +5,23 @@ export type RiebeckiteEndpointMountOptions = {
 };
 type HonoLikeApp = {
     get(path: string, handler: (context: HonoLikeContext) => Promise<unknown>): void;
+    post(path: string, handler: (context: HonoLikeContext) => Promise<unknown>): void;
+};
+type HonoLikeHeaders = {
+    forEach(callback: (value: string, key: string) => void): void;
+};
+type HonoLikeRequest = {
+    method: string;
+    url: string;
+    path: string;
+    raw: {
+        headers: HonoLikeHeaders;
+    };
+    query(): Record<string, string>;
+    text(): Promise<string>;
 };
 type HonoLikeContext = {
+    req: HonoLikeRequest;
     json(body: unknown, status?: number, headers?: Record<string, string>): unknown;
     body(body: string, status?: number, headers?: Record<string, string>): unknown;
     text(body: string, status?: number, headers?: Record<string, string>): unknown;

package/dist/src/honox_islands.d.ts

@@ -1,10 +1,8 @@
-import type { Plugin } from "vite";
-type HonoxPlugin = Plugin | Promise<Plugin>;
+import type { PluginOption } from "vite";
 /**
  * Replaces HonoX's dependency walker with one that remains inside the app
  * directory. Riebeckite configurations import plugins with large dependency
  * graphs, which must not be traversed merely to determine whether a route
  * imports an island.
  */
-export declare function replaceHonoxIslandDependencyPlugin(plugins: HonoxPlugin[]): HonoxPlugin[];
-export {};
+export declare function replaceHonoxIslandDependencyPlugin(plugins: PluginOption[]): PluginOption[];

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

@@ -1,3 +1,4 @@
+import { type ScaffoldPreset, type ScaffoldPresetName } from "./presets.js";
 export type ScaffoldSiteOptions = {
     readonly targetDirectory: string;
     readonly name?: string;
@@ -5,6 +6,7 @@ export type ScaffoldSiteOptions = {
     readonly description?: string;
     readonly baseUrl?: string;
     readonly locale?: string;
+    readonly preset?: ScaffoldPresetName | ScaffoldPreset;
     readonly overwrite?: boolean;
 };
 export type ScaffoldSiteResult = {

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

@@ -1,14 +1,13 @@
-import type { SiteTemplateFile, SiteTemplateVariables } from "./templates.js";
-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;
+import { type ScaffoldPreset } from "./presets.js";
+import { type SiteTemplateFile, type SiteTemplateVariables } from "./templates.js";
 /**
- * Generates the localized content pages for the scaffold.
+ * Generates the content pages for a scaffold preset.
  *
- * Naming follows the l10n plugin convention: the default-language page keeps
- * the plain name (`index.md`) while every other language uses the
- * `<base>.<lang>.md` suffix. The l10n plugin derives the translation group
- * from the path, so `content/index.ja.md` and `content/index.md` share a
- * translation while being served under `/` and `/ja/`.
+ * 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): readonly SiteTemplateFile[];
+export declare function localizedContentFiles(variables: SiteTemplateVariables, preset: ScaffoldPreset): readonly SiteTemplateFile[];

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

@@ -0,0 +1 @@
+export declare function formatScaffoldNextSteps(relativeDirectory: string): string;

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

@@ -0,0 +1,105 @@
+/**
+ * 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 { full, 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 = "empty" | "minimal" | "starter" | "rich" | "full" | "max" | "ultra";
+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 `depth` the preset tier: 1 = rich essentials,
+ * 2 = full/max standard set, 3 = ultra full coverage.
+ */
+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 rich: ScaffoldPreset;
+export declare const full: ScaffoldPreset;
+export declare const max: ScaffoldPreset;
+export declare const ultra: 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;