@pracht/core 0.2.6 → 0.3.0

package/README.md

@@ -37,7 +37,7 @@ metadata for the failure phase and matched framework files when available.
 - `startApp()` — client-side hydration and runtime
 - `useLocation()` — access the current pathname and search string separately
 - `useRouteData()` — access loader data inside a route component
-- `useRevalidateRoute()` — trigger a revalidation of the current route's data
+- `useRevalidate()` — trigger a revalidation of the current route's data
 - `<Form>` — progressive enhancement form component
 
 ### Types

package/dist/index.d.mts

@@ -35,7 +35,9 @@ interface TimeRevalidatePolicy {
 }
 type RouteRevalidate = TimeRevalidatePolicy;
 type HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS";
-type ApiRouteArgs<TContext = RegisteredContext> = BaseRouteArgs<TContext>;
+type ApiRouteArgs<TContext = RegisteredContext> = Omit<BaseRouteArgs<TContext>, "route"> & {
+  route: ResolvedApiRoute;
+};
 type ApiRouteHandler<TContext = RegisteredContext> = (args: ApiRouteArgs<TContext>) => MaybePromise<Response>;
 interface ApiRouteModule<TContext = any> {
   default?: ApiRouteHandler<TContext>;
@@ -74,6 +76,14 @@ interface GroupMeta {
 }
 interface ApiConfig {
   middleware?: string[];
+  /**
+   * When `true` (the default), state-changing API requests
+   * (POST/PUT/PATCH/DELETE) are rejected unless the browser signals a
+   * same-origin/same-site fetch (Sec-Fetch-Site) or the request Origin
+   * matches the request URL's origin. Set to `false` to opt out if you
+   * build your own CSRF protection into middleware.
+   */
+  requireSameOrigin?: boolean;
 }
 interface RouteConfig extends RouteMeta {
   component: ModuleRef;
@@ -179,6 +189,7 @@ interface RouteModule<TContext = any, TLoader extends LoaderLike = undefined> {
   default?: FunctionComponent<RouteComponentProps<TLoader>>;
   ErrorBoundary?: FunctionComponent<ErrorBoundaryProps>;
   getStaticPaths?: () => MaybePromise<RouteParams[]>;
+  markdown?: string;
 }
 interface ShellModule<TContext = any> {
   Shell: FunctionComponent<ShellProps>;
@@ -188,6 +199,7 @@ interface ShellModule<TContext = any> {
 }
 type MiddlewareResult<TContext = any> = void | Response | {
   redirect: string;
+  status?: number;
 } | {
   context: Partial<TContext>;
 };
@@ -250,7 +262,10 @@ declare function forwardRef<P = {}>(fn: ((props: P, ref: any) => any) & {
  */
 declare function useIsHydrated(): boolean;
 //#endregion
-//#region src/runtime.d.ts
+//#region src/runtime-headers.d.ts
+declare function applyDefaultSecurityHeaders(headers: Headers): Headers;
+//#endregion
+//#region src/runtime-errors.d.ts
 type PrachtRuntimeDiagnosticPhase = "match" | "middleware" | "loader" | "action" | "render" | "api";
 interface PrachtRuntimeDiagnostics {
   phase: PrachtRuntimeDiagnosticPhase;
@@ -262,6 +277,14 @@ interface PrachtRuntimeDiagnostics {
   middlewareFiles?: string[];
   status: number;
 }
+interface SerializedRouteError {
+  message: string;
+  name: string;
+  status: number;
+  diagnostics?: PrachtRuntimeDiagnostics;
+}
+//#endregion
+//#region src/runtime-hooks.d.ts
 interface PrachtHydrationState<TData = unknown> {
   url: string;
   routeId: string;
@@ -269,35 +292,17 @@ interface PrachtHydrationState<TData = unknown> {
   error?: SerializedRouteError | null;
   pending?: boolean;
 }
-interface SerializedRouteError {
-  message: string;
-  name: string;
-  status: number;
-  diagnostics?: PrachtRuntimeDiagnostics;
-}
 interface StartAppOptions<TData = unknown> {
   initialData?: TData;
 }
-interface HandlePrachtRequestOptions<TContext = unknown> {
-  app: PrachtApp;
-  request: Request;
-  context?: TContext;
-  registry?: ModuleRegistry;
-  /** Expose raw server error details in rendered HTML and route-state JSON. */
-  debugErrors?: boolean;
-  clientEntryUrl?: string;
-  /** Per-source-file CSS map produced by the vite plugin (preferred over cssUrls). */
-  cssManifest?: Record<string, string[]>;
-  /** @deprecated Pass cssManifest instead for per-page CSS resolution. */
-  cssUrls?: string[];
-  /** Per-source-file JS chunk map produced by the vite plugin for modulepreload hints. */
-  jsManifest?: Record<string, string[]>;
-  apiRoutes?: ResolvedApiRoute[];
-}
 interface FormProps extends Omit<JSX.HTMLAttributes<HTMLFormElement>, "action" | "method"> {
   action?: string;
   method?: string;
 }
+interface Location {
+  pathname: string;
+  search: string;
+}
 declare global {
   interface Window {
     __PRACHT_STATE__?: PrachtHydrationState;
@@ -318,12 +323,14 @@ declare function PrachtRuntimeProvider<TData>({
   data,
   params,
   routeId,
+  stateVersion,
   url
 }: {
   children: ComponentChildren;
   data: TData;
   params?: RouteParams;
   routeId: string;
+  stateVersion?: number;
   url: string;
 }): _$preact.VNode<_$preact.Attributes & {
   value: PrachtRuntimeValue | undefined;
@@ -332,16 +339,12 @@ declare function PrachtRuntimeProvider<TData>({
 declare function startApp<TData = unknown>(options?: StartAppOptions<TData>): TData | undefined;
 declare function readHydrationState<TData = unknown>(): PrachtHydrationState<TData> | undefined;
 declare function useRouteData<TData = unknown>(): TData;
-interface Location {
-  pathname: string;
-  search: string;
-}
 declare function useLocation(): Location;
 declare function useParams(): RouteParams;
 declare function useRevalidate(): () => Promise<unknown>;
-/** @deprecated Use useRevalidate instead. */
-declare const useRevalidateRoute: typeof useRevalidate;
 declare function Form(props: FormProps): _$preact.VNode<_$preact.ClassAttributes<HTMLFormElement> & h.JSX.HTMLAttributes<HTMLFormElement>>;
+//#endregion
+//#region src/runtime-client-fetch.d.ts
 type RouteStateResult = {
   type: "data";
   data: unknown;
@@ -352,8 +355,25 @@ type RouteStateResult = {
   type: "error";
   error: SerializedRouteError;
 };
+//#endregion
+//#region src/runtime.d.ts
+interface HandlePrachtRequestOptions<TContext = unknown> {
+  app: PrachtApp;
+  request: Request;
+  context?: TContext;
+  registry?: ModuleRegistry;
+  /** Expose raw server error details in rendered HTML and route-state JSON. */
+  debugErrors?: boolean;
+  clientEntryUrl?: string;
+  /** Per-source-file CSS map produced by the vite plugin. */
+  cssManifest?: Record<string, string[]>;
+  /** Per-source-file JS chunk map produced by the vite plugin for modulepreload hints. */
+  jsManifest?: Record<string, string[]>;
+  apiRoutes?: ResolvedApiRoute[];
+}
 declare function handlePrachtRequest<TContext>(options: HandlePrachtRequestOptions<TContext>): Promise<Response>;
-declare function applyDefaultSecurityHeaders(headers: Headers): Headers;
+//#endregion
+//#region src/prerender.d.ts
 interface PrerenderResult {
   path: string;
   html: string;
@@ -370,12 +390,10 @@ interface PrerenderAppOptions {
   app: PrachtApp;
   registry?: ModuleRegistry;
   clientEntryUrl?: string;
-  /** Per-source-file CSS map produced by the vite plugin (preferred over cssUrls). */
+  /** Per-source-file CSS map produced by the vite plugin. */
   cssManifest?: Record<string, string[]>;
   /** Per-source-file JS map produced by the vite plugin for modulepreload hints. */
   jsManifest?: Record<string, string[]>;
-  /** @deprecated Pass cssManifest instead for per-page CSS resolution. */
-  cssUrls?: string[];
 }
 declare function prerenderApp(options: PrerenderAppOptions): Promise<PrerenderResult[]>;
 declare function prerenderApp(options: PrerenderAppOptions & {
@@ -389,7 +407,7 @@ declare global {
     __PRACHT_ROUTER_READY__?: boolean;
   }
 }
-type ModuleMap = Record<string, () => Promise<any>>;
+type ModuleMap = Record<string, () => Promise<unknown>>;
 type NavigateFn = (to: string, options?: {
   replace?: boolean;
 }) => Promise<void>;
@@ -404,4 +422,4 @@ interface InitClientRouterOptions {
 }
 declare function initClientRouter(options: InitClientRouterOptions): Promise<void>;
 //#endregion
-export { type ApiConfig, type ApiRouteArgs, type ApiRouteHandler, type ApiRouteMatch, type ApiRouteModule, type BaseRouteArgs, type DataModule, type ErrorBoundaryProps, Form, type FormProps, type GroupDefinition, type GroupMeta, type HandlePrachtRequestOptions, type HeadArgs, type HeadMetadata, type HeadersArgs, type HttpMethod, type ISGManifestEntry, type InitClientRouterOptions, type LoaderArgs, type LoaderData, type LoaderFn, type Location, type MiddlewareArgs, type MiddlewareFn, type MiddlewareModule, type MiddlewareResult, type ModuleImporter, type ModuleRef, type ModuleRegistry, type NavigateFn, type PrachtApp, type PrachtAppConfig, PrachtHttpError, type PrachtHydrationState, type PrachtRuntimeDiagnosticPhase, type PrachtRuntimeDiagnostics, PrachtRuntimeProvider, type PrefetchStrategy, type PrerenderAppOptions, type PrerenderAppResult, type PrerenderResult, type Register, type RenderMode, type ResolvedApiRoute, type ResolvedPrachtApp, type ResolvedRoute, type RouteComponentProps, type RouteConfig, type RouteDefinition, type RouteMatch, type RouteMeta, type RouteModule, type RouteParams, type RouteRevalidate, type RouteStateResult, type RouteTreeNode, type SerializedRouteError, type ShellModule, type ShellProps, type StartAppOptions, Suspense, type TimeRevalidatePolicy, applyDefaultSecurityHeaders, buildPathFromSegments, defineApp, forwardRef, group, handlePrachtRequest, initClientRouter, lazy, matchApiRoute, matchAppRoute, prerenderApp, readHydrationState, resolveApiRoutes, resolveApp, route, startApp, timeRevalidate, useIsHydrated, useLocation, useNavigate, useParams, useRevalidate, useRevalidateRoute, useRouteData };
+export { type ApiConfig, type ApiRouteArgs, type ApiRouteHandler, type ApiRouteMatch, type ApiRouteModule, type BaseRouteArgs, type DataModule, type ErrorBoundaryProps, Form, type FormProps, type GroupDefinition, type GroupMeta, type HandlePrachtRequestOptions, type HeadArgs, type HeadMetadata, type HeadersArgs, type HttpMethod, type ISGManifestEntry, type InitClientRouterOptions, type LoaderArgs, type LoaderData, type LoaderFn, type Location, type MiddlewareArgs, type MiddlewareFn, type MiddlewareModule, type MiddlewareResult, type ModuleImporter, type ModuleRef, type ModuleRegistry, type NavigateFn, type PrachtApp, type PrachtAppConfig, PrachtHttpError, type PrachtHydrationState, type PrachtRuntimeDiagnosticPhase, type PrachtRuntimeDiagnostics, PrachtRuntimeProvider, type PrefetchStrategy, type PrerenderAppOptions, type PrerenderAppResult, type PrerenderResult, type Register, type RenderMode, type ResolvedApiRoute, type ResolvedPrachtApp, type ResolvedRoute, type RouteComponentProps, type RouteConfig, type RouteDefinition, type RouteMatch, type RouteMeta, type RouteModule, type RouteParams, type RouteRevalidate, type RouteStateResult, type RouteTreeNode, type SerializedRouteError, type ShellModule, type ShellProps, type StartAppOptions, Suspense, type TimeRevalidatePolicy, applyDefaultSecurityHeaders, buildPathFromSegments, defineApp, forwardRef, group, handlePrachtRequest, initClientRouter, lazy, matchApiRoute, matchAppRoute, prerenderApp, readHydrationState, resolveApiRoutes, resolveApp, route, startApp, timeRevalidate, useIsHydrated, useLocation, useNavigate, useParams, useRevalidate, useRouteData };