@standardbeagle/virtual-router 1.0.0 → 1.1.0

package/dist/ErrorBoundary.d.ts

@@ -0,0 +1,18 @@
+import { Component, ReactNode, ErrorInfo } from 'react';
+interface Props {
+    children: ReactNode;
+    fallback?: ReactNode;
+    onError?: (error: Error, errorInfo: ErrorInfo) => void;
+}
+interface State {
+    hasError: boolean;
+    error?: Error;
+    errorInfo?: ErrorInfo;
+}
+export declare class RouterErrorBoundary extends Component<Props, State> {
+    constructor(props: Props);
+    static getDerivedStateFromError(error: Error): State;
+    componentDidCatch(error: Error, errorInfo: ErrorInfo): void;
+    render(): string | number | boolean | Iterable<ReactNode> | import("react/jsx-runtime").JSX.Element | null | undefined;
+}
+export {};

package/dist/ErrorContext.d.ts

@@ -0,0 +1,20 @@
+import { ReactNode } from 'react';
+interface RouterError {
+    message: string;
+    code?: string;
+    path?: string;
+    timestamp: number;
+}
+interface ErrorContextType {
+    errors: RouterError[];
+    addError: (error: RouterError) => void;
+    clearErrors: () => void;
+    clearError: (timestamp: number) => void;
+}
+interface ErrorProviderProps {
+    children: ReactNode;
+}
+export declare function ErrorProvider({ children }: ErrorProviderProps): import("react/jsx-runtime").JSX.Element;
+export declare function useRouteError(): RouterError | null;
+export declare function useRouteErrors(): ErrorContextType | null;
+export {};

package/dist/FormHandler.d.ts

@@ -0,0 +1,38 @@
+import { ReactNode } from 'react';
+interface FormData {
+    [key: string]: string | File | (string | File)[];
+}
+interface FormHandlerProps {
+    action?: string;
+    method?: 'GET' | 'POST';
+    onSubmit?: (data: FormData, navigate: (path: string) => void) => void;
+    children: ReactNode;
+    className?: string;
+    id?: string;
+}
+export declare function Form({ action, method, onSubmit, children, ...props }: FormHandlerProps): import("react/jsx-runtime").JSX.Element;
+export declare function useFormData(): FormData | null;
+interface SubmitButtonProps {
+    formAction?: string;
+    formMethod?: 'GET' | 'POST';
+    children: ReactNode;
+    type?: 'submit' | 'button';
+    className?: string;
+    disabled?: boolean;
+}
+export declare function SubmitButton({ formAction, formMethod, children, type, ...props }: SubmitButtonProps): import("react/jsx-runtime").JSX.Element;
+export declare function useFormSubmission(): {
+    isSubmitting: boolean;
+    lastSubmission: FormData | null;
+    error: Error | null;
+};
+interface FormLinkProps {
+    to: string;
+    formData?: FormData;
+    method?: 'GET' | 'POST';
+    children: ReactNode;
+    className?: string;
+    onClick?: () => void;
+}
+export declare function FormLink({ to, formData, method, children, onClick, ...props }: FormLinkProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/connectors/nextjs.d.ts

@@ -0,0 +1 @@
+export * from './nextjs'

package/dist/connectors/nextjs.es.js

@@ -0,0 +1,24 @@
+import { j as jsxRuntimeExports, c as PathProvider } from "../provider-F-pulqTx.js";
+import { useCallback } from "react";
+import { usePathname, useRouter } from "next/navigation";
+function NextRouterConnector({ basePath, children, path }) {
+  const pathname = usePathname();
+  const router = useRouter();
+  const handleChange = useCallback((newPath) => {
+    router.push(newPath);
+  }, [router]);
+  return /* @__PURE__ */ jsxRuntimeExports.jsx(
+    PathProvider,
+    {
+      path: path ?? "/",
+      basePath,
+      externalPath: pathname,
+      onChange: handleChange,
+      children
+    }
+  );
+}
+export {
+  NextRouterConnector
+};
+//# sourceMappingURL=nextjs.es.js.map

package/dist/connectors/nextjs.es.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nextjs.es.js","sources":["../../src/connectors/nextjs.tsx"],"sourcesContent":["import { useCallback } from 'react';\nimport { usePathname, useRouter } from 'next/navigation';\nimport { PathProvider } from '../provider';\nimport type { ConnectorProps } from './types';\n\nexport function NextRouterConnector({ basePath, children, path }: ConnectorProps) {\n    const pathname = usePathname();\n    const router = useRouter();\n\n    const handleChange = useCallback((newPath: string) => {\n        router.push(newPath);\n    }, [router]);\n\n    return (\n        <PathProvider\n            path={path ?? '/'}\n            basePath={basePath}\n            externalPath={pathname}\n            onChange={handleChange}\n        >\n            {children}\n        </PathProvider>\n    );\n}\n"],"names":["jsx"],"mappings":";;;AAKO,SAAS,oBAAoB,EAAE,UAAU,UAAU,QAAwB;AAC9E,QAAM,WAAW;AACjB,QAAM,SAAS;AAET,QAAA,eAAe,YAAY,CAAC,YAAoB;AAClD,WAAO,KAAK,OAAO;AAAA,EAAA,GACpB,CAAC,MAAM,CAAC;AAGP,SAAAA,kCAAA;AAAA,IAAC;AAAA,IAAA;AAAA,MACG,MAAM,QAAQ;AAAA,MACd;AAAA,MACA,cAAc;AAAA,MACd,UAAU;AAAA,MAET;AAAA,IAAA;AAAA,EAAA;AAGb;"}

package/dist/connectors/react-router.d.ts

@@ -0,0 +1 @@
+export * from './react-router'

package/dist/connectors/react-router.es.js

@@ -0,0 +1,24 @@
+import { j as jsxRuntimeExports, c as PathProvider } from "../provider-F-pulqTx.js";
+import { useCallback } from "react";
+import { useLocation, useNavigate } from "react-router-dom";
+function ReactRouterConnector({ basePath, children, path }) {
+  const location = useLocation();
+  const navigate = useNavigate();
+  const handleChange = useCallback((newPath) => {
+    navigate(newPath);
+  }, [navigate]);
+  return /* @__PURE__ */ jsxRuntimeExports.jsx(
+    PathProvider,
+    {
+      path: path ?? "/",
+      basePath,
+      externalPath: location.pathname,
+      onChange: handleChange,
+      children
+    }
+  );
+}
+export {
+  ReactRouterConnector
+};
+//# sourceMappingURL=react-router.es.js.map

package/dist/connectors/react-router.es.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"react-router.es.js","sources":["../../src/connectors/react-router.tsx"],"sourcesContent":["import { useCallback } from 'react';\nimport { useLocation, useNavigate } from 'react-router-dom';\nimport { PathProvider } from '../provider';\nimport type { ConnectorProps } from './types';\n\nexport function ReactRouterConnector({ basePath, children, path }: ConnectorProps) {\n    const location = useLocation();\n    const navigate = useNavigate();\n\n    const handleChange = useCallback((newPath: string) => {\n        navigate(newPath);\n    }, [navigate]);\n\n    return (\n        <PathProvider\n            path={path ?? '/'}\n            basePath={basePath}\n            externalPath={location.pathname}\n            onChange={handleChange}\n        >\n            {children}\n        </PathProvider>\n    );\n}\n"],"names":["jsx"],"mappings":";;;AAKO,SAAS,qBAAqB,EAAE,UAAU,UAAU,QAAwB;AAC/E,QAAM,WAAW;AACjB,QAAM,WAAW;AAEX,QAAA,eAAe,YAAY,CAAC,YAAoB;AAClD,aAAS,OAAO;AAAA,EAAA,GACjB,CAAC,QAAQ,CAAC;AAGT,SAAAA,kCAAA;AAAA,IAAC;AAAA,IAAA;AAAA,MACG,MAAM,QAAQ;AAAA,MACd;AAAA,MACA,cAAc,SAAS;AAAA,MACvB,UAAU;AAAA,MAET;AAAA,IAAA;AAAA,EAAA;AAGb;"}

package/dist/connectors/tanstack.d.ts

@@ -0,0 +1 @@
+export * from './tanstack'

package/dist/connectors/tanstack.es.js

@@ -0,0 +1,24 @@
+import { j as jsxRuntimeExports, c as PathProvider } from "../provider-F-pulqTx.js";
+import { useCallback } from "react";
+import { useLocation, useNavigate } from "@tanstack/react-router";
+function TanStackRouterConnector({ basePath, children, path }) {
+  const location = useLocation();
+  const navigate = useNavigate();
+  const handleChange = useCallback((newPath) => {
+    navigate({ to: newPath });
+  }, [navigate]);
+  return /* @__PURE__ */ jsxRuntimeExports.jsx(
+    PathProvider,
+    {
+      path: path ?? "/",
+      basePath,
+      externalPath: location.pathname,
+      onChange: handleChange,
+      children
+    }
+  );
+}
+export {
+  TanStackRouterConnector
+};
+//# sourceMappingURL=tanstack.es.js.map

package/dist/connectors/tanstack.es.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tanstack.es.js","sources":["../../src/connectors/tanstack.tsx"],"sourcesContent":["import { useCallback } from 'react';\nimport { useLocation, useNavigate } from '@tanstack/react-router';\nimport { PathProvider } from '../provider';\nimport type { ConnectorProps } from './types';\n\nexport function TanStackRouterConnector({ basePath, children, path }: ConnectorProps) {\n    const location = useLocation();\n    const navigate = useNavigate();\n\n    const handleChange = useCallback((newPath: string) => {\n        navigate({ to: newPath });\n    }, [navigate]);\n\n    return (\n        <PathProvider\n            path={path ?? '/'}\n            basePath={basePath}\n            externalPath={location.pathname}\n            onChange={handleChange}\n        >\n            {children}\n        </PathProvider>\n    );\n}\n"],"names":["jsx"],"mappings":";;;AAKO,SAAS,wBAAwB,EAAE,UAAU,UAAU,QAAwB;AAClF,QAAM,WAAW;AACjB,QAAM,WAAW;AAEX,QAAA,eAAe,YAAY,CAAC,YAAoB;AACzC,aAAA,EAAE,IAAI,QAAA,CAAS;AAAA,EAAA,GACzB,CAAC,QAAQ,CAAC;AAGT,SAAAA,kCAAA;AAAA,IAAC;AAAA,IAAA;AAAA,MACG,MAAM,QAAQ;AAAA,MACd;AAAA,MACA,cAAc,SAAS;AAAA,MACvB,UAAU;AAAA,MAET;AAAA,IAAA;AAAA,EAAA;AAGb;"}

package/dist/connectors/types.d.ts

@@ -0,0 +1,8 @@
+import type { ReactNode } from 'react';
+export interface ConnectorProps {
+    basePath: string;
+    children: ReactNode;
+    path?: string;
+}
+export declare function stripBasePath(basePath: string, fullPath: string): string;
+export declare function prependBasePath(basePath: string, internalPath: string): string;

package/dist/index.d.ts

@@ -1,19 +1,29 @@
 import React from 'react';
-import type { PropsWithChildren } from 'react';
-import type { ReactElement } from 'react';
+import type { ComponentProps } from 'react';
+import type { ReactElement, ReactNode } from 'react';
+import type { RouteParams, SearchParams, NavigationObject } from './types.ts';
 export { PathProvider } from './provider.tsx';
+export type { ConnectorProps } from './connectors/types';
 export declare function usePath(): string;
-export declare function useHistory(): string[];
+export declare function useHistory(): readonly string[];
 export declare function useNavigate(): (url: string) => void;
-export declare function useNavigation(): any;
-export declare function useParams(): any;
-export declare function useSearchParams(): any;
-export declare function useRouteError(): any;
-export declare const Link: React.ForwardRefExoticComponent<Omit<any, "ref"> & React.RefAttributes<unknown>>;
+export declare function useNavigation(): NavigationObject;
+export declare function useParams(): RouteParams;
+export declare function useSearchParams(): SearchParams;
+export { useRouteError, useRouteErrors, ErrorProvider } from './ErrorContext';
+export { RouterErrorBoundary } from './ErrorBoundary';
+export { Form, SubmitButton, FormLink, useFormData, useFormSubmission } from './FormHandler';
+interface LinkProps extends Omit<ComponentProps<'a'>, 'href' | 'onClick'> {
+    to: string;
+    children: ReactNode;
+}
+export declare const Link: React.ForwardRefExoticComponent<Omit<LinkProps, "ref"> & React.RefAttributes<HTMLAnchorElement>>;
 interface RoutesProps {
+    children?: ReactNode;
 }
-export declare function Routes(props: PropsWithChildren<RoutesProps>): ReactElement;
+export declare function Routes({ children }: RoutesProps): ReactElement;
 interface RouteProps {
-    route: string;
+    path: string;
+    children?: ReactNode;
 }
-export declare function Route(_: PropsWithChildren<RouteProps>): ReactElement;
+export declare function Route(_: RouteProps): ReactElement;