@ubean/routing 0.1.2 → 0.1.3

package/dist/types.d.ts

@@ -0,0 +1,157 @@
+import { PageHead, RouteMeta } from "@ubean/types";
+//#region src/types.d.ts
+/**
+ * HTTP methods supported by ubean API routes.
+ * Aligned with Hono's built-in methods (excludes TRACE).
+ */
+declare const HTTP_METHODS: readonly ["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS"];
+type HttpMethod = (typeof HTTP_METHODS)[number];
+interface ScannedFile {
+  fullPath: string;
+  relativePath: string;
+  dirname: string;
+  basename: string;
+}
+interface ScannedApiRoute extends ScannedFile {
+  route: string;
+  method?: HttpMethod | Lowercase<HttpMethod>;
+  env?: 'dev' | 'prod' | 'prerender';
+  exports: string[];
+  hasMeta: boolean;
+  fileMeta?: RouteMeta;
+}
+interface ScannedMiddleware extends ScannedFile {
+  order: number;
+  global: boolean;
+}
+interface ScannedPageRoute extends ScannedFile {
+  name: string;
+  route: string;
+  path: string;
+  layout?: string | false;
+  cache?: boolean;
+  isReuse: boolean;
+  isMarkdown: boolean;
+  reuseTarget?: string;
+  pageMeta?: PageMeta;
+  frontmatter?: Record<string, unknown>;
+}
+interface ScannedLayout extends ScannedFile {
+  name: string;
+  path: string;
+  isDefault: boolean;
+}
+interface ScannedPlugin extends ScannedFile {
+  order: number;
+}
+interface ScannedCronTask extends ScannedFile {
+  name: string;
+}
+interface ScannedQueue extends ScannedFile {
+  name: string;
+}
+interface ScannedLocale extends ScannedFile {
+  code: string;
+  namespace?: string;
+  isDefault?: boolean;
+  name?: string;
+  dir?: 'ltr' | 'rtl';
+}
+interface AppEntry {
+  exists: boolean;
+  fullPath?: string;
+  relativePath?: string;
+}
+interface ScannedAppEntry {
+  shared: AppEntry;
+  server: AppEntry;
+  client: AppEntry;
+}
+interface ScannedServerEntry {
+  shared: AppEntry;
+  dev: AppEntry;
+  prod: AppEntry;
+}
+interface ScanOptions {
+  cwd: string;
+  srcDir: string;
+  dirs?: {
+    routes?: string | string[];
+    middleware?: string | string[];
+    pages?: string | string[];
+    layouts?: string | string[];
+    plugins?: string | string[];
+    crons?: string | string[];
+    queues?: string | string[];
+    locales?: string | string[];
+  };
+  ignore?: string[];
+}
+interface ScanResult {
+  apiRoutes: ScannedApiRoute[];
+  middlewares: ScannedMiddleware[];
+  pages: ScannedPageRoute[];
+  layouts: ScannedLayout[];
+  plugins: ScannedPlugin[];
+  crons: ScannedCronTask[];
+  queues: ScannedQueue[];
+  locales: ScannedLocale[];
+  defaultLocale?: string;
+  appEntry: ScannedAppEntry;
+  serverEntry: ScannedServerEntry;
+}
+declare const GLOB_SCAN_PATTERN = "**/*.{js,mjs,cjs,ts,mts,cts,tsx,jsx}";
+declare const GLOB_VUE_PATTERN = "**/*.{vue,ts,md,mdx}";
+declare const GLOB_LAYOUT_PATTERN = "**/*.{vue,ts}";
+/**
+ * Page-level head configuration (SEO title, meta, link, etc.).
+ * Used by Markdown frontmatter; Vue pages use `useHead()` at runtime instead.
+ *
+ * `PageHead` itself is imported from `@ubean/types` to avoid a
+ * routing ↔ pages circular dependency.
+ */
+/**
+ * Page-level route metadata extracted from `definePage()` macro calls.
+ *
+ * `meta` is typed against the local `RouteMeta` (re-exported from
+ * `@ubean/types`). When the consumer augments `vue-router`'s
+ * `RouteMeta` interface, the augmented members flow through here via
+ * the `@ubean/types` re-export.
+ *
+ * NOTE: The `declare module 'vue-router' { interface RouteMeta { ... } }`
+ * augmentation is owned by `@ubean/runtime` to keep this package
+ * decoupled from the Vue runtime.
+ */
+interface PageMeta {
+  name?: string;
+  path?: string;
+  layout?: string | false;
+  reuse?: string;
+  /**
+   * Route metadata. Extends vue-router's `RouteMeta` so projects can
+   * augment it via `declare module 'vue-router' { interface RouteMeta { ... } }`
+   * and get full type-safety inside `definePage({ meta: { ... } })`.
+   */
+  meta?: RouteMeta;
+  middleware?: string | string[];
+  requiresAuth?: boolean;
+  /**
+   * Enable `<keep-alive>` caching for this page.
+   * When `true`, the page component instance is preserved (not destroyed)
+   * when navigating away, and restored when navigating back.
+   * The page's route name is used as the cache key (component name).
+   * Can be toggled at runtime via `enablePageCache(name)` / `disablePageCache(name)`.
+   */
+  cache?: boolean;
+  /**
+   * Page-level head configuration (SEO title, meta, link, etc.).
+   * Used by Markdown frontmatter; Vue pages use `useHead()` at runtime instead.
+   */
+  head?: PageHead;
+}
+interface DefineMetaResult {
+  meta?: Record<string, unknown>;
+  requiresAuth?: boolean;
+}
+//#endregion
+export { AppEntry, DefineMetaResult, GLOB_LAYOUT_PATTERN, GLOB_SCAN_PATTERN, GLOB_VUE_PATTERN, HTTP_METHODS, HttpMethod, type PageHead, PageMeta, type RouteMeta, ScanOptions, ScanResult, ScannedApiRoute, ScannedAppEntry, ScannedCronTask, ScannedFile, ScannedLayout, ScannedLocale, ScannedMiddleware, ScannedPageRoute, ScannedPlugin, ScannedQueue, ScannedServerEntry };

package/dist/types.js

@@ -0,0 +1,19 @@
+//#region src/types.ts
+/**
+* HTTP methods supported by ubean API routes.
+* Aligned with Hono's built-in methods (excludes TRACE).
+*/
+const HTTP_METHODS = [
+	"GET",
+	"POST",
+	"PUT",
+	"PATCH",
+	"DELETE",
+	"HEAD",
+	"OPTIONS"
+];
+const GLOB_SCAN_PATTERN = "**/*.{js,mjs,cjs,ts,mts,cts,tsx,jsx}";
+const GLOB_VUE_PATTERN = "**/*.{vue,ts,md,mdx}";
+const GLOB_LAYOUT_PATTERN = "**/*.{vue,ts}";
+//#endregion
+export { GLOB_LAYOUT_PATTERN, GLOB_SCAN_PATTERN, GLOB_VUE_PATTERN, HTTP_METHODS };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ubean/routing",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "File-based routing core for ubean (scanner, rou3 matcher, route name generator, define-page AST extractor, file generator)",
   "files": [
     "dist"
@@ -30,8 +30,8 @@
     "scule": "^1.3.0",
     "tinyglobby": "^0.2.17",
     "ufo": "1.6.4",
-    "@ubean/types": "0.1.2",
-    "@ubean/utils": "0.1.2"
+    "@ubean/types": "0.1.3",
+    "@ubean/utils": "0.1.3"
   },
   "devDependencies": {
     "@types/node": "^26.1.1",
@@ -39,11 +39,11 @@
     "vite-plus": "0.2.6",
     "vue": "^3.5.40",
     "vue-router": "^5.2.0",
-    "@ubean/markdown": "0.1.2"
+    "@ubean/markdown": "0.1.3"
   },
   "peerDependencies": {
     "vue-router": "^4.0.0",
-    "@ubean/markdown": "0.1.2"
+    "@ubean/markdown": "0.1.3"
   },
   "peerDependenciesMeta": {
     "@ubean/markdown": {