@vmz/core 0.2.7 → 0.3.0

package/dist/browser/client-nav.types.d.ts

@@ -0,0 +1,94 @@
+/**
+ * Client navigation option and helper types for `@vmz/core`.
+ */
+import type { ComponentCtorLike, DirectInstance } from './direct-api.types.js';
+export type HydrateFn = (Ctor: ComponentCtorLike, root: Element, props: object) => Promise<unknown>;
+export type HydrateRouteFn = (Page: ComponentCtorLike, root: Element, props: object, layouts?: ComponentCtorLike[]) => Promise<unknown>;
+export type HydrateRoutePageFn = (Page: ComponentCtorLike, root: Element, props: object) => Promise<unknown>;
+export type DomFallbackModule = {
+    hydrate?: HydrateFn;
+    hydrateRoute?: HydrateRouteFn;
+    hydrateRoutePage?: HydrateRoutePageFn;
+};
+export type ClientNavOpts = {
+    fetchImpl?: typeof fetch;
+    document?: Document;
+    history?: History;
+    location?: Location;
+    hydrate?: HydrateFn;
+    hydrateRoute?: HydrateRouteFn;
+    hydrateRoutePage?: HydrateRoutePageFn;
+    destroy?: (inst: DirectInstance | object) => void;
+    importPage?: (chunkId: string) => Promise<unknown>;
+};
+export type TransitionToOpts = {
+    replace?: boolean;
+    fromPop?: boolean;
+    softFail?: boolean;
+};
+export type TransitionLocaleOpts = {
+    replace?: boolean;
+    softFail?: boolean;
+    reload?: boolean;
+    [key: string]: unknown;
+};
+export type TransitionToOk = {
+    ok: true;
+    href: string;
+    chunkId: string;
+    retainedLayout: boolean;
+    scrollMode: string;
+    focusTarget: string | null;
+    localeId: string | null;
+};
+export type TransitionToFail = {
+    ok: false;
+    reason: string;
+};
+export type TransitionToResult = TransitionToOk | TransitionToFail;
+export type ClientNavResult = {
+    ok: false;
+    reason: string;
+} | {
+    ok: true;
+    transitionTo: (url: string | URL, opts?: TransitionToOpts) => Promise<TransitionToResult>;
+    transitionLocale: (toLocale: string, opts?: TransitionLocaleOpts) => Promise<unknown>;
+    dispose: () => void;
+    setFetch?: (impl: typeof fetch) => void;
+};
+export type ScrollPosition = {
+    x: number;
+    y: number;
+};
+export type ScrollRestoreResult = {
+    mode: string;
+    x: number;
+    y: number;
+};
+/** URL-like scroll restore target (pathname / search / hash). */
+export type ScrollTarget = {
+    pathname: string;
+    search: string;
+    hash: string;
+    mode?: string;
+    x?: number;
+    y?: number;
+};
+/** In-flight SPA navigation abort handle (AbortController). */
+export type InflightNav = AbortController;
+export type VmzNavHost = Element & {
+    __vmzInst?: DirectInstance | null;
+};
+export type VmzAppRoot = HTMLElement & {
+    __vmzInst?: DirectInstance | null;
+    __vmzPageHost?: VmzNavHost | null;
+    __vmzLayoutInsts?: DirectInstance[] | null;
+};
+export type LocaleRouting = {
+    locales?: string[];
+    defaultLocale?: string;
+    strategy?: string;
+    defaultPrefix?: string;
+    [key: string]: unknown;
+};
+export type LocaleHrefTable = Record<string, Record<string, string>>;

package/dist/browser/client-nav.types.js

@@ -0,0 +1,4 @@
+/**
+ * Client navigation option and helper types for `@vmz/core`.
+ */
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vmz/core",
-  "version": "0.2.7",
+  "version": "0.3.0",
   "type": "module",
   "description": "VMZ production runtime core — DOM / SSR / HTTP / WriteBarrier (no compiler)",
   "exports": {
@@ -70,12 +70,12 @@
     "linkedom": "^0.18.13"
   },
   "optionalDependencies": {
-    "@vmz/vmz-win32-x64": "0.2.7",
-    "@vmz/vmz-win32-arm64": "0.2.7",
-    "@vmz/vmz-darwin-x64": "0.2.7",
-    "@vmz/vmz-darwin-arm64": "0.2.7",
-    "@vmz/vmz-linux-x64": "0.2.7",
-    "@vmz/vmz-linux-arm64": "0.2.7"
+    "@vmz/vmz-win32-x64": "0.3.0",
+    "@vmz/vmz-win32-arm64": "0.3.0",
+    "@vmz/vmz-darwin-x64": "0.3.0",
+    "@vmz/vmz-darwin-arm64": "0.3.0",
+    "@vmz/vmz-linux-x64": "0.3.0",
+    "@vmz/vmz-linux-arm64": "0.3.0"
   },
   "publishConfig": {
     "access": "public"