@ubean/runtime 0.1.1 → 0.1.3

package/dist/app-CDOvFfdJ.d.ts

@@ -0,0 +1,210 @@
+import { t as ViewTransitionOptions } from "./view-transitions-DRrLaRHL.js";
+import { VueHeadClient, useHead as useUnheadHead, useSeoMeta } from "@unhead/vue";
+import { PageObject } from "@ubean/pages";
+import { App, Component, PropType, VNode } from "vue";
+import { RouteRecordRaw, Router, useRouter } from "vue-router";
+//#region src/router.d.ts
+interface CreateUbeanRouterOptions {
+  routes: RouteRecordRaw[];
+  ssr?: boolean;
+  initialUrl?: string;
+  base?: string;
+  /**
+   * 在 router 实例创建后、初始导航(SSR 的 `router.push(initialUrl)`)之前调用,
+   * 用于注册 `beforeEach` / `beforeResolve` / `afterEach` 等导航守卫。
+   *
+   * 守卫注册必须同步完成(守卫函数本身可以返回 Promise)。
+   * 不要在此处执行异步操作(如发起 API 请求),否则会阻塞首次导航。
+   *
+   * 该回调在 Client 和 SSR 环境都会执行。
+   */
+  setup?: (router: Router) => void;
+}
+declare function createUbeanRouter(options: CreateUbeanRouterOptions): Router;
+//#endregion
+//#region src/app.d.ts
+interface UbeanAppOptions {
+  routes: RouteRecordRaw[];
+  resolveLayoutComponent: (name: string | false | null | undefined) => Promise<Component | null>;
+  defaultLayout?: string | null;
+  initialPage?: PageObject;
+  head?: VueHeadClient;
+  viewTransitions?: boolean | ViewTransitionOptions;
+  hydrate?: boolean;
+  /**
+   * 在 router 实例创建后、`app.use(router)` 之前调用,
+   * 用于注册 vue-router 的导航守卫(`beforeEach` / `beforeResolve` / `afterEach`)。
+   *
+   * Client 和 SSR 都会执行。守卫注册必须同步完成(守卫本身可返回 Promise)。
+   */
+  routerSetup?: (router: ReturnType<typeof createUbeanRouter>) => void;
+}
+interface UbeanAppInstance {
+  app: App;
+  router: ReturnType<typeof createUbeanRouter>;
+  head: VueHeadClient;
+  page: PageObject;
+}
+/**
+ * PageView — a globally-registered component that renders the matched route
+ * page, wrapped with `<Transition>` and `<KeepAlive>`.
+ *
+ * Layouts use `<PageView />` (instead of `<slot />`) to render the matched
+ * page. This follows vue-router's v-slot pattern, mirroring soybean-unify's
+ * `layouts/modules/layout-content/index.vue`:
+ *
+ * ```html
+ * <RouterView v-slot="{ Component, route }">
+ *   <Transition :name="pageAnimateMode" mode="out-in">
+ *     <KeepAlive :include="cachedRoutes" :exclude="excludeCachedRoutes">
+ *       <component :is="Component" v-if="reloadSignal" :key="tabId" />
+ *     </KeepAlive>
+ *   </Transition>
+ * </RouterView>
+ * ```
+ *
+ * In ubean, the equivalents are:
+ *   - `pageAnimateMode` → global `usePageTransition()` ref + `transition` prop + `route.meta.transition`
+ *   - `cachedRoutes` / `excludeCachedRoutes` → `useCacheViews().cachedViews` / `excludedViews`
+ *   - `reloadSignal` → `useReloadSignal().counter` (incremented by `reloadPage()`)
+ *   - `tabId` → `reloadKey` prop + reload counter (forces remount when changed)
+ *
+ * Props:
+ * - `transition`: transition name (string) or `false` to disable.
+ *   Priority: prop > `route.meta.transition` > global `usePageTransition()`.
+ * - `reloadKey`: a reactive key — changing it forces remount (reload).
+ *   When omitted, falls back to `route.fullPath` + global reload counter.
+ * - `mode`: Vue `<Transition>` mode. Defaults to `'out-in'`.
+ *
+ * On SSR, KeepAlive and Transition are skipped (client-only concepts).
+ */
+declare const PageView: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+  transition: {
+    type: (StringConstructor | BooleanConstructor)[];
+    default: undefined;
+  };
+  reloadKey: {
+    type: (StringConstructor | NumberConstructor)[];
+    default: undefined;
+  };
+  mode: {
+    type: PropType<"out-in" | "in-out" | "default">;
+    default: string;
+  };
+}>, () => VNode<import("vue").RendererNode, import("vue").RendererElement, {
+  [key: string]: any;
+}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+  transition: {
+    type: (StringConstructor | BooleanConstructor)[];
+    default: undefined;
+  };
+  reloadKey: {
+    type: (StringConstructor | NumberConstructor)[];
+    default: undefined;
+  };
+  mode: {
+    type: PropType<"out-in" | "in-out" | "default">;
+    default: string;
+  };
+}>> & Readonly<{}>, {
+  transition: string | boolean;
+  reloadKey: string | number;
+  mode: "out-in" | "in-out" | "default";
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+declare const Link: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+  to: {
+    type: PropType<string | Record<string, unknown>>;
+    default: undefined;
+  };
+  href: {
+    type: StringConstructor;
+    default: undefined;
+  };
+  replace: {
+    type: BooleanConstructor;
+    default: boolean;
+  };
+  prefetch: {
+    type: BooleanConstructor;
+    default: boolean;
+  };
+  activeClass: {
+    type: StringConstructor;
+    default: string;
+  };
+  exactActiveClass: {
+    type: StringConstructor;
+    default: string;
+  };
+  noActiveClass: {
+    type: BooleanConstructor;
+    default: boolean;
+  };
+}>, () => VNode<import("vue").RendererNode, import("vue").RendererElement, {
+  [key: string]: any;
+}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+  to: {
+    type: PropType<string | Record<string, unknown>>;
+    default: undefined;
+  };
+  href: {
+    type: StringConstructor;
+    default: undefined;
+  };
+  replace: {
+    type: BooleanConstructor;
+    default: boolean;
+  };
+  prefetch: {
+    type: BooleanConstructor;
+    default: boolean;
+  };
+  activeClass: {
+    type: StringConstructor;
+    default: string;
+  };
+  exactActiveClass: {
+    type: StringConstructor;
+    default: string;
+  };
+  noActiveClass: {
+    type: BooleanConstructor;
+    default: boolean;
+  };
+}>> & Readonly<{}>, {
+  to: string | Record<string, unknown>;
+  href: string;
+  replace: boolean;
+  prefetch: boolean;
+  activeClass: string;
+  exactActiveClass: string;
+  noActiveClass: boolean;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+declare const Head: import("vue").DefineComponent;
+declare function createUbeanApp(options: UbeanAppOptions): UbeanAppInstance;
+declare function createUbeanSSRApp(initialPage: PageObject, options: Omit<UbeanAppOptions, 'initialPage'>): {
+  app: App<Element>;
+  router: import("vue-router")._RouterClassic;
+  head: VueHeadClient;
+};
+declare function usePage<T = Record<string, unknown>>(): PageObject<T>;
+interface UbeanRouter {
+  push: (url: string, opts?: {
+    replace?: boolean;
+  }) => Promise<unknown>;
+  replace: (url: string) => Promise<unknown>;
+  back: () => void;
+  forward: () => void;
+  refresh: () => void;
+  readonly current: ReturnType<typeof useRouter>['currentRoute']['value'];
+  readonly navigating: boolean;
+  [key: string]: unknown;
+}
+declare function useRouter$1(): UbeanRouter;
+declare function useViewTransition(): {
+  enabled: boolean;
+  supports: boolean;
+  options: ViewTransitionOptions;
+};
+//#endregion
+export { UbeanAppOptions as a, createUbeanApp as c, useRouter$1 as d, useSeoMeta as f, createUbeanRouter as g, CreateUbeanRouterOptions as h, UbeanAppInstance as i, createUbeanSSRApp as l, useViewTransition as m, Link as n, UbeanRouter as o, useUnheadHead as p, PageView as r, VueHeadClient as s, Head as t, usePage as u };