@moku-labs/web 1.13.2 → 1.15.0

package/dist/browser.d.mts

@@ -230,6 +230,28 @@ type Api$3 = {
   t(locale: string, key: string): string;
 };
 //#endregion
+//#region src/plugins/i18n/index.d.ts
+/**
+ * Internationalization plugin — locale registry plus a flat translation helper
+ * with default-locale fallback. Pure config-as-data (no state or events);
+ * consumed read-only by content, router, head, and build.
+ *
+ * @example Register locales and translations
+ * ```ts
+ * const app = createApp({
+ *   pluginConfigs: {
+ *     i18n: {
+ *       locales: ["en", "uk"],
+ *       defaultLocale: "en",
+ *       localeNames: { en: "English", uk: "Українська" },
+ *       translations: { uk: { "nav.home": "Головна" } }
+ *     }
+ *   }
+ * });
+ * ```
+ */
+declare const i18nPlugin: import("@moku-labs/core").PluginInstance<"i18n", Config$3, Record<string, never>, Api$3, {}> & Record<never, never>;
+//#endregion
 //#region src/plugins/router/iso-match.d.ts
 /**
  * A compiled, engine-agnostic path matcher: the same `.exec({ pathname })` shape the
@@ -287,7 +309,10 @@ interface RouteState<P extends string = string, D = unknown> {
   /** Loaded data type produced by `.load()` (widened only by `.load()`). */
   readonly data: D;
 }
-/** Render-time context handed to `.render()` / `.head()`; `data` is `.load()`'s return. */
+/**
+ * Render-time context handed to `.render()` / `.head()`; `data` is `.load()`'s return,
+ * `meta` the route's `.meta()` bag.
+ */
 interface RouteContext<S extends RouteState> {
   /** Resolved path params. */
   readonly params: S["params"];
@@ -295,6 +320,13 @@ interface RouteContext<S extends RouteState> {
   readonly data: S["data"];
   /** Active locale for this render. */
   readonly locale: string;
+  /**
+   * The route's `.meta()` bag (e.g. `{ activeTab: "home" }`). Available in `.render()` and
+   * `.head()`, identically at build and on the client — `meta` is compiled into the route and
+   * shipped in the client manifest, so a client-only route (dynamic, no `.generate()`, whose
+   * `.load()` data is `{}` on the client) can feed static per-route config into its render.
+   */
+  readonly meta: Record<string, unknown>;
   /**
    * Build a link to a named route by pattern substitution — the framework delivers
    * this on the context (same output as `app.router.toUrl`), so render/head build
@@ -375,21 +407,16 @@ interface GenerateContext {
   readonly has: (name: string) => boolean;
 }
 /**
- * Context handed to a route's `.layout()` wrapper: the render-time
- * {@link RouteContext} plus the route's `.meta()` bag, so persistent chrome (e.g. a
- * TopBar/TabNav) can read `locale` and `meta.activeTab`. Distinct from
- * `RouteContext` because the layout is the only handler that needs `meta`; keeping
- * it on its own type leaves `.render()`/`.head()` contexts unchanged.
+ * Context handed to a route's `.layout()` wrapper — identical to {@link RouteContext}
+ * (which now carries `meta` for every handler). Retained as a named alias so existing
+ * `.layout((ctx, children) => …)` typings keep compiling.
  *
  * @remarks
  * The layout is applied in the SSG render path ONLY. On client (SPA) navigation the
- * chrome is persistent and the layout is intentionally NOT re-applied — only the
- * inner swap region is replaced. See `build`'s pages phase and `spa`'s kernel.
+ * chrome is persistent and the layout is intentionally NOT re-applied — only the inner
+ * swap region is replaced. See `build`'s pages phase and `spa`'s kernel.
  */
-interface LayoutContext<S extends RouteState> extends RouteContext<S> {
-  /** The route's `.meta()` bag (e.g. `{ activeTab: "home" }`). */
-  readonly meta: Record<string, unknown>;
-}
+type LayoutContext<S extends RouteState> = RouteContext<S>;
 /** Head metadata produced by a route's `.head()` handler. */
 interface HeadConfig$1 {
   /** Document title. */
@@ -944,12 +971,25 @@ interface ResolvedSpaConfig {
   /** Pre-registered components. */
   components: ComponentDef[];
 }
-/** Context handed to every component lifecycle hook. */
+/**
+ * Context handed to every component lifecycle hook — the bound element + page data,
+ * plus the matched route's `params`/`meta`/`locale` and a link builder, so an island
+ * can read its route context (e.g. a `card` route's `ctx.meta.focus` + `ctx.params.id`)
+ * directly, without the page bridging it through `data-*` attributes.
+ */
 interface ComponentContext {
   /** The element the component instance is bound to. */
   el: Element;
   /** Page data extracted from the `script#__DATA__` payload. */
   data: PageData;
+  /** Resolved path params of the route matched for the current URL (empty if unmatched). */
+  readonly params: Record<string, string | undefined>;
+  /** The matched route's `.meta()` bag (empty if unmatched). */
+  readonly meta: Record<string, unknown>;
+  /** Active locale for the current route (empty string if unknown). */
+  readonly locale: string;
+  /** Build a link to a named route by pattern substitution (same output as `app.router.toUrl`). */
+  readonly url: (name: string, params?: Record<string, string>) => string;
 }
 /** Lifecycle hooks a component may implement. */
 interface ComponentHooks {
@@ -1173,28 +1213,6 @@ type SpaApi = {
  */
 declare const sitePlugin: import("@moku-labs/core").PluginInstance<"site", Config$4, Record<string, never>, Api$4, {}> & Record<never, never>;
 //#endregion
-//#region src/plugins/i18n/index.d.ts
-/**
- * Internationalization plugin — locale registry plus a flat translation helper
- * with default-locale fallback. Pure config-as-data (no state or events);
- * consumed read-only by content, router, head, and build.
- *
- * @example Register locales and translations
- * ```ts
- * const app = createApp({
- *   pluginConfigs: {
- *     i18n: {
- *       locales: ["en", "uk"],
- *       defaultLocale: "en",
- *       localeNames: { en: "English", uk: "Українська" },
- *       translations: { uk: { "nav.home": "Головна" } }
- *     }
- *   }
- * });
- * ```
- */
-declare const i18nPlugin: import("@moku-labs/core").PluginInstance<"i18n", Config$3, Record<string, never>, Api$3, {}> & Record<never, never>;
-//#endregion
 //#region src/plugins/router/builders/route-builder.d.ts
 /**
  * Create a fluent route builder from a URL pattern string. Captures the pattern
@@ -1258,8 +1276,8 @@ declare function createUrls<T extends RouteMap>(routes: T, defaultLocale?: strin
 /**
  * Router plugin — typed, named route definitions with locale-aware URL generation
  * and matching. Author routes with {@link route}, then register them the normal config
- * way via `pluginConfigs.router.routes` (compiled at init). Depends on site (base URL)
- * and i18n (locales).
+ * way via `pluginConfigs.router.routes` (compiled at init). Depends on site (base URL);
+ * i18n (locales) is OPTIONAL — falls back to a single default locale ("en") when absent.
  *
  * @example Register routes via config, then start/build
  * ```ts
@@ -1362,7 +1380,7 @@ declare function buildArticleHead(articleMeta: ArticleMeta, canonicalUrl: string
  * Head plugin — composes per-route `<head>` metadata (title template, Open Graph,
  * Twitter cards, canonical, hreflang). Use the re-exported SEO primitives
  * ({@link meta}, {@link og}, {@link twitter}, …) inside a route's `.head()`.
- * Depends on site, i18n, and router.
+ * Depends on site and router; i18n is OPTIONAL (single default-locale fallback when absent).
  *
  * @example Set global head defaults
  * ```ts
@@ -2072,7 +2090,8 @@ type Api = {
  * (locale fallback, draft filtering, sort, caching, events) lives here; source I/O +
  * the Markdown pipeline live in a {@link ContentProvider} you compose (like `env`
  * providers). The shell imports zero node code, so `contentPlugin` is browser-safe.
- * Depends on i18n; emits `content:ready` and `content:invalidated`.
+ * i18n is OPTIONAL (single default-locale fallback when absent); emits `content:ready`
+ * and `content:invalidated`.
  *
  * @example Compose the node filesystem provider with a content dir + Shiki theme
  * ```ts