@netrojs/fnetro 0.2.21 → 0.3.0

package/dist/core.js

@@ -1,16 +1,55 @@
+// types.ts
+var SPA_HEADER = "x-fnetro-spa";
+var STATE_KEY = "__FNETRO_STATE__";
+var PARAMS_KEY = "__FNETRO_PARAMS__";
+var SEO_KEY = "__FNETRO_SEO__";
+var DATA_KEY = /* @__PURE__ */ Symbol.for("fnetro:data");
+
 // core.ts
+var VUE_BRANDS = ["__name", "__file", "__vccOpts", "setup", "render", "data", "components"];
+function isAsyncLoader(c) {
+  if (typeof c !== "function") return false;
+  const f = c;
+  for (const brand of VUE_BRANDS) {
+    if (brand in f) return false;
+  }
+  return true;
+}
 function definePage(def) {
   return { __type: "page", ...def };
 }
 function defineGroup(def) {
   return { __type: "group", ...def };
 }
-function defineLayout(Component) {
-  return { __type: "layout", Component };
+function defineLayout(component) {
+  return { __type: "layout", component };
 }
 function defineApiRoute(path, register) {
   return { __type: "api", path, register };
 }
+function compilePath(path) {
+  const keys = [];
+  const src = path.replace(/\[\.\.\.([^\]]+)\]/g, (_, k) => {
+    keys.push(k);
+    return "(.*)";
+  }).replace(/\[([^\]]+)\]/g, (_, k) => {
+    keys.push(k);
+    return "([^/]+)";
+  }).replace(/\*/g, "(.*)");
+  return { re: new RegExp(`^${src}$`), keys };
+}
+function matchPath(cp, pathname) {
+  const m = pathname.match(cp.re);
+  if (!m) return null;
+  const params = {};
+  cp.keys.forEach((k, i) => {
+    params[k] = decodeURIComponent(m[i + 1] ?? "");
+  });
+  return params;
+}
+function toVueRouterPath(fnetroPath) {
+  return fnetroPath.replace(/\[\.\.\.([^\]]+)\]/g, ":$1(.*)*").replace(/\[([^\]]+)\]/g, ":$1");
+}
 function resolveRoutes(routes, options = {}) {
   const pages = [];
   const apis = [];
@@ -21,7 +60,11 @@ function resolveRoutes(routes, options = {}) {
       const prefix = (options.prefix ?? "") + route.prefix;
       const mw = [...options.middleware ?? [], ...route.middleware ?? []];
       const layout = route.layout !== void 0 ? route.layout : options.layout;
-      const sub = resolveRoutes(route.routes, { prefix, middleware: mw, layout });
+      const sub = resolveRoutes(route.routes, {
+        prefix,
+        middleware: mw,
+        ...layout !== void 0 && { layout }
+      });
       pages.push(...sub.pages);
       apis.push(...sub.apis);
     } else {
@@ -35,31 +78,8 @@ function resolveRoutes(routes, options = {}) {
   }
   return { pages, apis };
 }
-function compilePath(path) {
-  const keys = [];
-  const src = path.replace(/\[\.\.\.([^\]]+)\]/g, (_, k) => {
-    keys.push(k);
-    return "(.*)";
-  }).replace(/\[([^\]]+)\]/g, (_, k) => {
-    keys.push(k);
-    return "([^/]+)";
-  }).replace(/\*/g, "(.*)");
-  return { re: new RegExp(`^${src}$`), keys };
-}
-function matchPath(compiled, pathname) {
-  const m = pathname.match(compiled.re);
-  if (!m) return null;
-  const params = {};
-  compiled.keys.forEach((k, i) => {
-    params[k] = decodeURIComponent(m[i + 1] ?? "");
-  });
-  return params;
-}
-var SPA_HEADER = "x-fnetro-spa";
-var STATE_KEY = "__FNETRO_STATE__";
-var PARAMS_KEY = "__FNETRO_PARAMS__";
-var SEO_KEY = "__FNETRO_SEO__";
 export {
+  DATA_KEY,
   PARAMS_KEY,
   SEO_KEY,
   SPA_HEADER,
@@ -69,6 +89,8 @@ export {
   defineGroup,
   defineLayout,
   definePage,
+  isAsyncLoader,
   matchPath,
-  resolveRoutes
+  resolveRoutes,
+  toVueRouterPath
 };

package/dist/server.d.ts

@@ -1,5 +1,5 @@
 import { Hono, MiddlewareHandler, Context } from 'hono';
-import { Component, JSX } from 'solid-js';
+import { Component } from 'vue';
 import { Plugin } from 'vite';
 
 type HonoMiddleware = MiddlewareHandler;
@@ -16,44 +16,33 @@ interface SEOMeta {
     ogDescription?: string;
     ogImage?: string;
     ogImageAlt?: string;
-    ogImageWidth?: string;
-    ogImageHeight?: string;
     ogUrl?: string;
     ogType?: string;
     ogSiteName?: string;
-    ogLocale?: string;
     twitterCard?: 'summary' | 'summary_large_image' | 'app' | 'player';
     twitterSite?: string;
-    twitterCreator?: string;
     twitterTitle?: string;
     twitterDescription?: string;
     twitterImage?: string;
-    twitterImageAlt?: string;
+    /** Structured data injected as <script type="application/ld+json">. */
     jsonLd?: Record<string, unknown> | Record<string, unknown>[];
-    extra?: Array<{
-        name?: string;
-        property?: string;
-        httpEquiv?: string;
-        content: string;
-    }>;
 }
-type PageProps<TData extends object = {}> = TData & {
-    url: string;
-    params: Record<string, string>;
-};
-interface LayoutProps {
-    children: JSX.Element;
-    url: string;
-    params: Record<string, string>;
-}
-interface PageDef<TData extends object = {}> {
+type AsyncLoader = () => Promise<{
+    default: Component;
+} | Component>;
+interface PageDef<TData extends object = Record<string, never>> {
     readonly __type: 'page';
     path: string;
     middleware?: HonoMiddleware[];
     loader?: (c: LoaderCtx) => TData | Promise<TData>;
     seo?: SEOMeta | ((data: TData, params: Record<string, string>) => SEOMeta);
+    /** Override or disable the app-level layout for this route. */
     layout?: LayoutDef | false;
-    Page: Component<PageProps<TData>>;
+    /**
+     * The Vue component to render for this route.
+     * Use () => import('./Page.vue') for automatic code splitting.
+     */
+    component: Component | AsyncLoader;
 }
 interface GroupDef {
     readonly __type: 'group';
@@ -64,7 +53,8 @@ interface GroupDef {
 }
 interface LayoutDef {
     readonly __type: 'layout';
-    Component: Component<LayoutProps>;
+    /** Vue layout component — must contain <slot /> for page content. */
+    component: Component;
 }
 interface ApiRouteDef {
     readonly __type: 'api';
@@ -79,66 +69,79 @@ interface AppConfig {
     routes: Route[];
     notFound?: Component;
     htmlAttrs?: Record<string, string>;
+    /** Extra HTML injected into <head> (e.g. font preloads). */
     head?: string;
 }
-type ClientMiddleware = (url: string, next: () => Promise<void>) => Promise<void>;
-declare function definePage<TData extends object = {}>(def: Omit<PageDef<TData>, '__type'>): PageDef<TData>;
-declare function defineGroup(def: Omit<GroupDef, '__type'>): GroupDef;
-declare function defineLayout(Component: Component<LayoutProps>): LayoutDef;
-declare function defineApiRoute(path: string, register: ApiRouteDef['register']): ApiRouteDef;
 interface ResolvedRoute {
     fullPath: string;
     page: PageDef<any>;
     layout: LayoutDef | false | undefined;
     middleware: HonoMiddleware[];
 }
-declare function resolveRoutes(routes: Route[], options?: {
-    prefix?: string;
-    middleware?: HonoMiddleware[];
-    layout?: LayoutDef | false;
-}): {
-    pages: ResolvedRoute[];
-    apis: ApiRouteDef[];
-};
 interface CompiledPath {
     re: RegExp;
     keys: string[];
 }
-declare function compilePath(path: string): CompiledPath;
-declare function matchPath(compiled: CompiledPath, pathname: string): Record<string, string> | null;
+type ClientMiddleware = (url: string, next: () => Promise<void>) => Promise<void>;
+/** Custom request header that identifies an SPA navigation (JSON payload). */
 declare const SPA_HEADER = "x-fnetro-spa";
+/** window key for SSR-injected per-page loader data. */
 declare const STATE_KEY = "__FNETRO_STATE__";
+/** window key for SSR-injected URL params. */
 declare const PARAMS_KEY = "__FNETRO_PARAMS__";
+/** window key for SSR-injected SEO meta. */
 declare const SEO_KEY = "__FNETRO_SEO__";
+/**
+ * Vue provide/inject key for the reactive page-data object.
+ * Symbol.for() ensures the same reference across module instances (SSR safe).
+ */
+declare const DATA_KEY: unique symbol;
+
+/**
+ * Returns true when `c` is an async factory function (i.e. `() => import(...)`)
+ * rather than a resolved Vue component object.
+ *
+ * Used by both server.ts (to resolve the import before SSR) and client.ts
+ * (to wrap with defineAsyncComponent for lazy hydration).
+ */
+declare function isAsyncLoader(c: unknown): c is AsyncLoader;
+declare function definePage<TData extends object = Record<string, never>>(def: Omit<PageDef<TData>, '__type'>): PageDef<TData>;
+declare function defineGroup(def: Omit<GroupDef, '__type'>): GroupDef;
+/** Wrap a Vue layout component (must render <slot />) as a FNetro layout. */
+declare function defineLayout(component: Component): LayoutDef;
+declare function defineApiRoute(path: string, register: ApiRouteDef['register']): ApiRouteDef;
+declare function compilePath(path: string): CompiledPath;
+declare function matchPath(cp: CompiledPath, pathname: string): Record<string, string> | null;
+/**
+ * Convert FNetro `[param]` syntax to Vue Router `:param` syntax.
+ *
+ * `/posts/[slug]`    → `/posts/:slug`
+ * `/files/[...path]` → `/files/:path(.*)*`
+ */
+declare function toVueRouterPath(fnetroPath: string): string;
+declare function resolveRoutes(routes: Route[], options?: {
+    prefix?: string;
+    middleware?: HonoMiddleware[];
+    layout?: LayoutDef | false;
+}): {
+    pages: ResolvedRoute[];
+    apis: ApiRouteDef[];
+};
 
 interface AssetConfig {
-    /** Explicit script URLs injected into every HTML page. */
     scripts?: string[];
-    /** Explicit stylesheet URLs injected into every HTML page. */
     styles?: string[];
-    /**
-     * Directory that contains the Vite-generated `manifest.json`.
-     * When provided, asset URLs are resolved from the manifest so hashed
-     * filenames work correctly.  Typically equals `clientOutDir`.
-     */
+    /** Directory containing the Vite-built assets and .vite/manifest.json. */
     manifestDir?: string;
-    /**
-     * Key in the manifest corresponding to the client entry file.
-     * @default `'client.ts'`
-     */
     manifestEntry?: string;
 }
 interface FNetroOptions extends AppConfig {
-    /**
-     * Production asset configuration.
-     * In dev mode `@hono/vite-dev-server` injects assets automatically — ignored.
-     */
     assets?: AssetConfig;
 }
 interface FNetroApp {
-    /** The underlying Hono instance — attach custom routes, error handlers, etc. */
+    /** The Hono instance — attach extra routes, error handlers, middleware. */
     app: Hono;
-    /** Fetch handler for edge runtimes */
+    /** WinterCG-compatible fetch handler for edge runtimes. */
     handler: typeof Hono.prototype.fetch;
 }
 declare function createFNetro(config: FNetroOptions): FNetroApp;
@@ -149,24 +152,24 @@ interface ServeOptions {
     port?: number;
     hostname?: string;
     runtime?: Runtime;
-    /** Root directory for static file serving.  @default `'./dist'` */
+    /** Root directory that contains the built assets and public files. */
     staticDir?: string;
 }
 declare function serve(opts: ServeOptions): Promise<void>;
 interface FNetroPluginOptions {
-    /** Server entry file.   @default `'server.ts'` */
+    /** Server entry file.             @default 'server.ts' */
     serverEntry?: string;
-    /** Client entry file.   @default `'client.ts'` */
+    /** Client entry file.             @default 'client.ts' */
     clientEntry?: string;
-    /** Server bundle output directory.   @default `'dist/server'` */
+    /** Server bundle output dir.      @default 'dist/server' */
     serverOutDir?: string;
-    /** Client assets output directory.   @default `'dist/assets'` */
+    /** Client assets output dir.      @default 'dist/assets' */
     clientOutDir?: string;
-    /** Extra packages to mark external in the server bundle. */
+    /** Extra packages external to the server bundle. */
     serverExternal?: string[];
-    /** Extra options forwarded to `vite-plugin-solid`. */
-    solidOptions?: Record<string, unknown>;
+    /** Options forwarded to @vitejs/plugin-vue in the client build. */
+    vueOptions?: Record<string, unknown>;
 }
-declare function fnetroVitePlugin(opts?: FNetroPluginOptions): Plugin[];
+declare function fnetroVitePlugin(opts?: FNetroPluginOptions): Plugin;
 
-export { type ApiRouteDef, type AppConfig, type AssetConfig, type ClientMiddleware, type CompiledPath, type FNetroApp, type FNetroOptions, type FNetroPluginOptions, type GroupDef, type HonoMiddleware, type LayoutDef, type LayoutProps, type LoaderCtx, PARAMS_KEY, type PageDef, type PageProps, type ResolvedRoute, type Route, type Runtime, type SEOMeta, SEO_KEY, SPA_HEADER, STATE_KEY, type ServeOptions, compilePath, createFNetro, defineApiRoute, defineGroup, defineLayout, definePage, detectRuntime, fnetroVitePlugin, matchPath, resolveRoutes, serve };
+export { type ApiRouteDef, type AppConfig, type AssetConfig, type AsyncLoader, type ClientMiddleware, type CompiledPath, DATA_KEY, type FNetroApp, type FNetroOptions, type FNetroPluginOptions, type GroupDef, type HonoMiddleware, type LayoutDef, type LoaderCtx, PARAMS_KEY, type PageDef, type ResolvedRoute, type Route, type Runtime, type SEOMeta, SEO_KEY, SPA_HEADER, STATE_KEY, type ServeOptions, compilePath, createFNetro, defineApiRoute, defineGroup, defineLayout, definePage, detectRuntime, fnetroVitePlugin, isAsyncLoader, matchPath, resolveRoutes, serve, toVueRouterPath };