eddev 2.0.0-beta.12 → 2.0.0-beta.121

package/dist/app/lib/routing/hooks/useRoute.d.ts

@@ -1,2 +1,17 @@
-import { RouteState } from "../types";
+import type { RouteState } from "../types.js";
+/**
+ * Returns the current route object.
+ *
+ * In most circumstances, this will be the active top-level route.
+ *
+ * In cases where manual rendering of routes is taking place, such as during page transitions or in some modal cases.
+ *
+ * @returns The current route
+ */
 export declare function useRoute(): RouteState;
+/**
+ * Returns the current route, if it matches the specified view, otherwise null.
+ */
+export declare function useViewRoute<V extends keyof ViewProps>(view: V): Extract<RouteState, {
+    view: V;
+}> | null;

package/dist/app/lib/routing/hooks/useRoute.js

@@ -1,5 +1,26 @@
 import { useContext } from "react";
-import { RouteItemContext } from "../context";
+import { RouteItemContext } from "../context.js";
+/**
+ * Returns the current route object.
+ *
+ * In most circumstances, this will be the active top-level route.
+ *
+ * In cases where manual rendering of routes is taking place, such as during page transitions or in some modal cases.
+ *
+ * @returns The current route
+ */
 export function useRoute() {
     return useContext(RouteItemContext);
 }
+/**
+ * Returns the current route, if it matches the specified view, otherwise null.
+ */
+export function useViewRoute(view) {
+    const route = useContext(RouteItemContext);
+    if (route.view === view) {
+        return route;
+    }
+    else {
+        return null;
+    }
+}

package/dist/app/lib/routing/hooks/useRouteMeta.d.ts

@@ -0,0 +1,5 @@
+import { RouteMeta } from "../types";
+export declare const $routeMetaStore: {
+    data: RouteMeta;
+};
+export declare function useRouteMeta(): RouteMeta;

package/dist/app/lib/routing/hooks/useRouteMeta.js

@@ -0,0 +1,9 @@
+import { proxy, useSnapshot } from "valtio";
+export const $routeMetaStore = proxy({
+    data: {},
+});
+export function useRouteMeta() {
+    return useSnapshot($routeMetaStore, {
+        sync: true,
+    }).data;
+}

package/dist/app/lib/routing/hooks/useRouteTransition.d.ts

@@ -1,4 +1,4 @@
-import type { RouteState } from "../types";
+import type { RouteState } from "../types.js";
 type TransitionFunction = (currentRoute: RouteState, nextRoute: RouteState) => void | Promise<any | void>;
 export declare function useRouteTransition(func: TransitionFunction): void;
 export {};

package/dist/app/lib/routing/hooks/useRouteTransition.js

@@ -1,5 +1,5 @@
 import { useEffect, useRef } from "react";
-import { useRouter } from "./useRouter";
+import { useRouter } from "./useRouter.js";
 export function useRouteTransition(func) {
     const subscribe = useRouter((r) => r.subscribe);
     const handler = useRef(func);

package/dist/app/lib/routing/hooks/useRouter.d.ts

@@ -1,2 +1,2 @@
-import { RouterAPI } from "../types";
+import { RouterAPI } from "../types.js";
 export declare function useRouter<T = RouterAPI>(selector?: (r: RouterAPI) => T): T;

package/dist/app/lib/routing/hooks/useRouter.js

@@ -1,5 +1,5 @@
 import { useContext } from "react";
-import { RouterContext } from "../context";
+import { RouterContext } from "../context.js";
 export function useRouter(selector) {
     const router = useContext(RouterContext);
     if (selector) {

package/dist/app/lib/routing/hooks/useRouterEvents.d.ts

@@ -1,2 +1,2 @@
-import type { RouterEvent } from "../types";
+import type { RouterEvent } from "../types.js";
 export declare function useRouterEvents(handler: (event: RouterEvent) => void): void;

package/dist/app/lib/routing/hooks/useRouterEvents.js

@@ -1,5 +1,5 @@
 import { useEffect, useRef } from "react";
-import { useRouter } from "./useRouter";
+import { useRouter } from "./useRouter.js";
 export function useRouterEvents(handler) {
     const subscribe = useRouter((r) => r.subscribe);
     const ref = useRef(handler);

package/dist/app/lib/routing/hooks/useRouterState.d.ts

@@ -1,2 +1,2 @@
-import { RouterAPIState } from "../types";
+import { RouterAPIState } from "../types.js";
 export declare function useRouterState<T = RouterAPIState>(selector?: (state: RouterAPIState) => T): T;

package/dist/app/lib/routing/hooks/useRouterState.js

@@ -1,5 +1,5 @@
 import { useContext } from "react";
-import { RouterStateContext } from "../context";
+import { RouterStateContext } from "../context.js";
 export function useRouterState(selector) {
     const ctx = useContext(RouterStateContext);
     if (selector)

package/dist/app/lib/routing/hooks/useSearchParams.js

@@ -1,6 +1,6 @@
 import { useMemo } from "react";
-import { useRoute } from "./useRoute";
-import { useRouter } from "./useRouter";
+import { useRoute } from "./useRoute.js";
+import { useRouter } from "./useRouter.js";
 export function useSearchParams(defaultValue) {
     const route = useRoute();
     const replaceQuery = useRouter((r) => r.replaceQuery);

package/dist/app/lib/routing/index.d.ts

@@ -1,13 +1,14 @@
-export * from "./types";
-export * from "./components/Link";
-export * from "./components/ScrollRestoration";
-export * from "./components/RouteRenderer";
-export * from "./components/ClientOnly";
-export * from "./hooks/useRoute";
-export * from "./hooks/useRouteTransition";
-export * from "./hooks/useRouter";
-export * from "./hooks/useRouterEvents";
-export * from "./hooks/useRouterState";
-export * from "./hooks/useRestorableState";
-export * from "./hooks/useIsSSR";
-export * from "./hooks/useSearchParams";
+export * from "./types.js";
+export * from "./components/Link.js";
+export * from "./components/ScrollRestoration.js";
+export * from "./components/RouteRenderer.js";
+export * from "./components/ClientOnly.js";
+export * from "./components/BackButton.js";
+export * from "./hooks/useRoute.js";
+export * from "./hooks/useRouteTransition.js";
+export * from "./hooks/useRouter.js";
+export * from "./hooks/useRouterEvents.js";
+export * from "./hooks/useRouterState.js";
+export * from "./hooks/useRestorableState.js";
+export * from "./hooks/useIsSSR.js";
+export * from "./hooks/useSearchParams.js";

package/dist/app/lib/routing/index.js

@@ -1,13 +1,14 @@
-export * from "./types";
-export * from "./components/Link";
-export * from "./components/ScrollRestoration";
-export * from "./components/RouteRenderer";
-export * from "./components/ClientOnly";
-export * from "./hooks/useRoute";
-export * from "./hooks/useRouteTransition";
-export * from "./hooks/useRouter";
-export * from "./hooks/useRouterEvents";
-export * from "./hooks/useRouterState";
-export * from "./hooks/useRestorableState";
-export * from "./hooks/useIsSSR";
-export * from "./hooks/useSearchParams";
+export * from "./types.js";
+export * from "./components/Link.js";
+export * from "./components/ScrollRestoration.js";
+export * from "./components/RouteRenderer.js";
+export * from "./components/ClientOnly.js";
+export * from "./components/BackButton.js";
+export * from "./hooks/useRoute.js";
+export * from "./hooks/useRouteTransition.js";
+export * from "./hooks/useRouter.js";
+export * from "./hooks/useRouterEvents.js";
+export * from "./hooks/useRouterState.js";
+export * from "./hooks/useRestorableState.js";
+export * from "./hooks/useIsSSR.js";
+export * from "./hooks/useSearchParams.js";

package/dist/app/lib/routing/loader.d.ts

@@ -1,6 +1,6 @@
 import { FunctionComponent, PropsWithChildren } from "react";
-import { DynamicComponent } from "../dynamic/dynamic";
-import { RouteData } from "./types";
+import { DynamicComponent } from "../dynamic/dynamic.js";
+import { RouteData } from "./types.js";
 export type RouteCacheEntry = {
     data: RouteData;
     component: FunctionComponent;

package/dist/app/lib/routing/loader.js

@@ -1,5 +1,5 @@
 import { parseURL, stringifyParsedURL, stringifyQuery, withTrailingSlash } from "ufo";
-import { viewManifestReader } from "../internal";
+import { viewManifestReader } from "../internal/read-view-manifest.js";
 export class RouteError extends Error {
     message;
     statusCode;
@@ -56,6 +56,7 @@ export class RouteLoader {
         return this.entries.has(cacheKey);
     }
     async loadRouteData(pathname, withAppData = false) {
+        pathname = withTrailingSlash(pathname);
         const cacheKey = this.getKey(pathname);
         // Cached value?
         if (this.entries.has(cacheKey))
@@ -65,27 +66,35 @@ export class RouteLoader {
             serverless: env.serverless,
             debug: env.dev,
         });
-        const promise = this.fetchImpl(requestUrl, {})
-            .then((response) => response.text())
-            .then((text) => {
+        const promise = this.fetchImpl(requestUrl)
+            .then(async (response) => {
+            if (response.redirected) {
+                return { redirect: response.url };
+            }
+            let text = await response.text();
             if (this.processProps) {
                 text = this.processProps(text);
             }
             try {
-                return JSON.parse(text);
+                const payload = JSON.parse(text);
+                if (!payload.view) {
+                    throw new RouteError(`Invalid route data for '${pathname}'`, 500);
+                }
+                return payload;
             }
             catch (err) {
                 throw new RouteError(`JSON parse error for route '${pathname}':\n${err?.message}`, 500);
             }
         })
-            .then((data) => {
+            .then(async (data) => {
             if (data.redirect) {
-                const redirect = data.redirect;
-                data = this.loadRouteData(redirect).then((data) => {
-                    data.canonical = redirect;
-                    return data;
-                });
+                const redirect = parseURL(data.redirect).pathname;
+                data = await this.loadRouteData(redirect);
+                data.canonical = redirect;
             }
+            return data;
+        })
+            .then((data) => {
             this.entries.set(cacheKey, new Promise((resolve) => resolve(data)));
             return data;
         });

package/dist/app/lib/routing/types.d.ts

@@ -1,9 +1,16 @@
 import { FunctionComponent } from "react";
-import type { RouteLoader } from "./loader";
-import { LinkHandlerMode, PointerOrMouseEvent } from "./utils";
-export type ParsedRouteTags = Record<"title" | "meta" | "script" | "style" | "link", {
-    [key: string]: string;
-}[]>;
+import type { RouteLoader } from "./loader.js";
+import { LinkHandlerMode, PointerOrMouseEvent } from "./utils.js";
+export type RouteMetaTag = {
+    tagName: string;
+    attributes: Record<string, string>;
+    inner?: string;
+};
+export type TrackerTags = {
+    head?: string;
+    body?: string;
+    footer?: string;
+};
 export interface RouteData {
     view: string;
     editLink?: string;
@@ -13,10 +20,13 @@ export interface RouteData {
     redirect?: string;
     canonical?: string;
     meta?: {
-        head: ParsedRouteTags;
-        footer: ParsedRouteTags;
+        head: RouteMetaTag[];
+        footer: RouteMetaTag[];
     };
 }
+export interface RouteDataWithTrackers extends RouteData {
+    trackers?: TrackerTags;
+}
 export type RouteReturnState<T = {}> = {
     scrollTop: number;
     scrollLeft: number;
@@ -73,7 +83,8 @@ export type RouterEvent = {
     data: RouteData;
 } | {
     type: "error";
-    critical: false;
+    critical: boolean;
+    url?: string;
     error: Error;
 };
 export type RouterSubscriber = (event: RouterEvent) => void;
@@ -99,14 +110,24 @@ export type RouterAPI = {
     replaceQuery: (search: Record<string, string | string[]>) => void;
     /** Replace the hash */
     replaceHash: (hash: string) => void;
-    /** Handle link clicking events */
-    handleClickEvent(e: PointerOrMouseEvent, href?: string): void;
+    /**
+     * Handle a click event, potentially triggering a route change.
+     *
+     * @param e A pointer or mouse event.
+     * @param href An optional URL. This must be provided if no `href` property exists on the clicked element
+     * @param preferBack If set, clicking this link will send the user 'back', when clicking a link to the previous history item.
+     */
+    handleClickEvent(e: PointerOrMouseEvent, href?: string, preferBack?: boolean | "exact"): void;
     /** A reference to the route loader (mostly for internal use) */
     loader: RouteLoader;
     /** Subscribe to events */
     subscribe: (subscribe: RouterSubscriber) => () => void;
     /** This function is used by the routing system automatically */
     emitEvent: (event: RouterEvent) => void;
+    /** Returns the current RouterAPIState */
+    getState: () => RouterAPIState | null;
+    /** Go back to a previous route in the history stack, or push it onto the stack if it isn't currently on the stack. */
+    restoreRoute: (route: RouteState) => void;
 };
 export type TypedRouteState<T, TProps> = {
     /** A unique ID, representing this history item. */
@@ -131,6 +152,12 @@ export type TypedRouteState<T, TProps> = {
     component: FunctionComponent<TProps>;
     /** The props for this route, to be passed to the component. */
     props: TProps;
+    /** Loaded metadata for this route */
+    meta: RouteMeta;
+};
+export type RouteMeta = {
+    title?: string;
+    tags?: RouteMetaTag[];
 };
 export type RouteState = {
     [K in keyof ViewProps]: TypedRouteState<K, ViewProps[K]>;

package/dist/app/lib/routing/utils.d.ts

@@ -1,15 +1,18 @@
 import { MouseEvent as ReactMouseEvent, PointerEvent as ReactPointerEvent } from "react";
-import { RouteLink, RouteState } from "./types";
+import { RouteData, RouteLink, RouteMeta, RouteState } from "./types.js";
 export declare function isSameOrigin(url: string): boolean;
+export declare function isSamePathname(a: string, b: string): boolean;
 export type PointerOrMouseEvent = MouseEvent | PointerEvent | ReactMouseEvent | ReactPointerEvent;
 export type LinkHandlerMode = {
     mode: "ignore" | "navigate" | "native";
     href?: string;
 };
-export declare function getLinkHandlerMode(e?: PointerOrMouseEvent, href?: string): LinkHandlerMode;
+export declare function getLinkHandlerMode(e?: PointerOrMouseEvent, href?: string, currentRoute?: RouteState): LinkHandlerMode;
 type Partialize<T, TKeys extends keyof T> = Partial<Pick<T, TKeys>> & Omit<T, TKeys>;
 export declare function normalizeRoute(route: Partialize<RouteState, "uri" | "returnState" | "key">): RouteState;
 export declare function stringifyRouteLink(route: RouteLink): string;
 export declare function parseQuery(query: string): Record<string, string | string[]>;
 export declare function stringifyQuery(query: any): string;
+export declare function getRouteMeta(data: RouteData): RouteMeta;
+export declare function addTrailingSlash(path?: string | null): string;
 export {};

package/dist/app/lib/routing/utils.js

@@ -1,5 +1,5 @@
-import { parseURL, resolveURL, stringifyParsedURL, withoutTrailingSlash } from "ufo";
-import { stringify as qsStringify, parse as qsParse } from "qs";
+import { parse as qsParse, stringify as qsStringify } from "qs";
+import { parseURL, resolveURL, stringifyParsedURL, withoutTrailingSlash, withTrailingSlash } from "ufo";
 export function isSameOrigin(url) {
     if (typeof document === "undefined") {
         return url.startsWith("/");
@@ -10,7 +10,12 @@ export function isSameOrigin(url) {
         return parsed.protocol === document.location.protocol && parsed.host === document.location.host;
     }
 }
-export function getLinkHandlerMode(e, href) {
+export function isSamePathname(a, b) {
+    const left = parseURL(a).pathname.replace(/\/$/, "").toLocaleLowerCase();
+    const right = parseURL(b).pathname.replace(/\/$/, "").toLocaleLowerCase();
+    return left === right;
+}
+export function getLinkHandlerMode(e, href, currentRoute) {
     try {
         // Attempt to get the link element, if there is one
         let eventTarget = null;
@@ -31,7 +36,11 @@ export function getLinkHandlerMode(e, href) {
         if (!href)
             return { mode: "native", href };
         // Resolve the URL and check if it's the same origin
-        const resolved = href.startsWith("http") ? href : resolveURL(document.location.href, href);
+        const resolved = href.startsWith("http")
+            ? href
+            : href.startsWith("/")
+                ? resolveURL(document.location.origin, href)
+                : resolveURL(document.location.href, href);
         const parsed = parseURL(resolved);
         const isSameOrigin = parsed.host?.replace(/:.+/, "") === document.location.host.replace(/:.+/, "");
         // External links should be handled natively
@@ -52,6 +61,17 @@ export function getLinkHandlerMode(e, href) {
         // Starts with /wp-, use native (wp-content, wp-admin etc)
         if (parsed.pathname.startsWith("/wp-"))
             return { mode: "native", href };
+        // If pathname+query are identical, but the hash is different, then allow the browser to handle it
+        if (currentRoute &&
+            isSamePathname(currentRoute.pathname, parsed.pathname) &&
+            currentRoute.search === parsed.search) {
+            if (currentRoute.hash !== parsed.hash) {
+                return { mode: "native", href };
+            }
+            else {
+                return { mode: "ignore", href };
+            }
+        }
         return { mode: "navigate", href };
     }
     catch (err) {
@@ -76,6 +96,7 @@ export function normalizeRoute(route) {
 export function stringifyRouteLink(route) {
     return stringifyParsedURL({
         ...route,
+        pathname: withTrailingSlash(route.pathname),
         search: stringifyQuery(route.query),
     });
 }
@@ -92,3 +113,15 @@ export function stringifyQuery(query) {
         arrayFormat: "brackets",
     });
 }
+export function getRouteMeta(data) {
+    return {
+        title: data.meta?.head.find((tag) => tag.tagName === "title")?.inner,
+        tags: data.meta?.head ?? [],
+    };
+}
+export function addTrailingSlash(path) {
+    if (path?.match(/\./)) {
+        return path;
+    }
+    return withTrailingSlash(path ?? undefined, true);
+}

package/dist/app/lib/{hooks → runtime}/apiConfig.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Configuration options for manipulating how the client interacts with the GraphQL API
+ */
 export type APIConfigStore = {
     /**
      * Any value, which will be used as part of the cache key for each query.
@@ -11,8 +14,9 @@ export type APIConfigStore = {
      */
     customQueryFetchOptions?: (type: "query" | "mutation", queryName: string, queryArgs: any, url: string, opts: RequestInit) => RequestInit | Promise<RequestInit>;
     /**
-     * Update aspects of the API client
+     * Allows you to hook into the response of a query or mutation.
      */
+    onResponse?: (response: Response, type: "query" | "mutation", queryName: string, queryArgs: any, url: string, opts: RequestInit) => void;
     set: (config: Partial<APIConfigStore>) => void;
 };
-export declare const useAPIConfig: import("zustand").UseBoundStore<import("zustand").StoreApi<APIConfigStore>>;
+export declare const apiConfig: APIConfigStore;

package/dist/app/lib/runtime/apiConfig.js

@@ -0,0 +1,6 @@
+import { proxy } from "valtio";
+export const apiConfig = proxy({
+    set: (config) => {
+        Object.assign(apiConfig, config);
+    },
+});

package/dist/app/lib/runtime/errorHandling.d.ts

@@ -0,0 +1,39 @@
+import { ContentBlock } from "../blocks";
+import { ReactNode } from "react";
+import { RouteState } from "../routing";
+export type ErrorEvent = {
+    /** The runtime error that occurred */
+    error: Error;
+    /** The Component stack (not available in renderBlockError) */
+    componentStack?: string;
+} & ({
+    type: "block";
+    /** The block which had an error, including it's type information, props, content and children */
+    block: ContentBlock;
+} | {
+    type: "route";
+    /** The route which had an error */
+    route: RouteState;
+});
+/**
+ * Configuration options for manipulating how the client interacts with the GraphQL API
+ */
+export type ErrorHandlingConfig = {
+    /**
+     * Triggered when a runtime error occurs in a block
+     * @param event The error event, containing the error and block information
+     **/
+    onReactError?(event: ErrorEvent): void;
+    /**
+     * Triggered when a React rendering error occurs, and allows you to return some JSX to render as a fallback.
+     * If not provided, the block will be hidden from the user.
+     * @param error The error event, containing the error and contextual information
+     * @param defaultDisplay The default display for the block — in development, this will display the error message. In production, this will be `null`.
+     */
+    renderFallback?(event: ErrorEvent, defaultDisplay: ReactNode): ReactNode;
+    /**
+     * Update the error handling configuration all at once
+     */
+    set: (config: Partial<ErrorHandlingConfig>) => void;
+};
+export declare const errorHandling: ErrorHandlingConfig;

package/dist/app/lib/runtime/errorHandling.js

@@ -0,0 +1,6 @@
+import { proxy } from "valtio";
+export const errorHandling = proxy({
+    set: (config) => {
+        Object.assign(errorHandling, config);
+    },
+});

package/dist/app/lib/runtime/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./apiConfig";
+export * from "./errorHandling";

package/dist/app/lib/runtime/index.js

@@ -0,0 +1,2 @@
+export * from "./apiConfig";
+export * from "./errorHandling";

package/dist/app/lib/views/index.d.ts

@@ -1 +1 @@
-export * from "./defineView";
+export * from "./defineView.js";

package/dist/app/lib/views/index.js

@@ -1 +1 @@
-export * from "./defineView";
+export * from "./defineView.js";

package/dist/app/server/defineRouter.d.ts

@@ -0,0 +1,2 @@
+import { Hono } from "hono";
+export declare function defineRouter(): Hono;

package/dist/app/server/defineRouter.js

@@ -0,0 +1,4 @@
+import { Hono } from "hono";
+export function defineRouter() {
+    return new Hono();
+}

package/dist/app/server/index.d.ts

@@ -1,3 +1,5 @@
-export * from "./render-ssr-page";
-export * from "./server-context";
-export * from "./proxy-wp-admin";
+export * from "./render-ssr-page.js";
+export * from "./server-context.js";
+export * from "./proxy-wp-admin.js";
+export * from "./defineRouter.js";
+export * from "./rpc.js";

package/dist/app/server/index.js

@@ -1,3 +1,5 @@
-export * from "./render-ssr-page";
-export * from "./server-context";
-export * from "./proxy-wp-admin";
+export * from "./render-ssr-page.js";
+export * from "./server-context.js";
+export * from "./proxy-wp-admin.js";
+export * from "./defineRouter.js";
+export * from "./rpc.js";

package/dist/app/server/proxy-wp-admin.d.ts

@@ -1,3 +1,2 @@
 import { EventHandlerRequest, H3Event } from "vinxi/http";
-import { ServerContext } from "./server-context";
-export declare function proxyWpAdmin(event: H3Event<EventHandlerRequest>, serverContext: ServerContext): Promise<Response>;
+export declare function proxyWpAdmin(event: H3Event<EventHandlerRequest>): Promise<Response>;