@kasperrt/smolter 0.4.3 → 0.4.4

package/.generated/react/data.ts

@@ -1,29 +0,0 @@
-/**
- * Independent React resource data, forms and subscriptions.
- *
- * @module
- */
-export type {
-  ActionFunctionArgs as ResourceActionArgs,
-  DataResult as ResourceResult,
-  LoaderFunctionArgs as ResourceLoaderArgs,
-  ShouldRevalidateFunctionArgs as ResourceRevalidationArgs,
-} from "../core/resource-types.ts";
-export {
-  createResourceRouter,
-  ResourceRouter,
-} from "../core/resources.ts";
-export type { ResourceRouteModule } from "./resources/components.tsx";
-export {
-  Form as ResourceForm,
-  Route as Resource,
-  RouterProvider as ResourceProvider,
-  useActionData as useResourceActionData,
-  useFetcher as useResourceFetcher,
-  useLoaderData as useResourceData,
-  useNavigation as useResourceNavigation,
-  useRevalidator as useResourceRevalidator,
-  useRouteLoaderData,
-  useRouter as useResourceRouter,
-  useSubmit as useResourceSubmit,
-} from "./resources/components.tsx";

package/.generated/react/resources/components.tsx

@@ -1,416 +0,0 @@
-/** @jsxImportSource react */
-import type {
-  DataResult,
-  NavigationState,
-  Params,
-  ResourceModule,
-  RouteState,
-} from "../../core/resource-types.ts";
-import type { ResourceRouter } from "../../core/resources.ts";
-
-import {
-  Component,
-  type ComponentType,
-  createContext,
-  type PropsWithChildren,
-  type ReactNode,
-  useCallback,
-  useContext,
-  useEffect,
-  useMemo,
-  useRef,
-  useState,
-  useSyncExternalStore,
-} from "react";
-
-/** Resource handlers with optional React content, pending UI and retry boundary. */
-export interface ResourceRouteModule extends ResourceModule {
-  default?: ComponentType;
-  ErrorBoundary?: ComponentType<{ retry: () => void }>;
-  HydrateFallback?: ComponentType;
-}
-
-const RouterContext = createContext<ResourceRouter | null>(null);
-const RouteContext = createContext<{ params: Params; routeId: string } | null>(
-  null,
-);
-const FormContext = createContext<
-  ((input?: unknown) => Promise<DataResult<unknown>>) | null
->(null);
-
-interface RouterProviderProps extends PropsWithChildren {
-  initialMatches?: readonly { params?: Params; routeId: string }[];
-  router: ResourceRouter;
-}
-
-/** Provide a resource router and load initial matches; dispose it when unmounted. */
-export function RouterProvider({
-  children,
-  initialMatches = EMPTY_MATCHES,
-  router,
-}: RouterProviderProps): import("react").JSX.Element {
-  useEffect(() => {
-    for (const match of initialMatches) {
-      void router.load(match.routeId, match.params ?? {});
-    }
-
-    return () => router.dispose();
-  }, [initialMatches, router]);
-
-  return (
-    <RouterContext.Provider value={router}>{children}</RouterContext.Provider>
-  );
-}
-
-interface RouteProps extends PropsWithChildren {
-  params?: Params;
-  persistent?: boolean;
-  routeId: string;
-}
-
-/** Provide a resource route and render its content, loading state or retry boundary. */
-export function Route({
-  children,
-  params = {},
-  persistent = false,
-  routeId,
-}: RouteProps): import("react").JSX.Element {
-  const router = useRouter();
-  const stableParams = useStableParams(params);
-  const state = useRouteState(routeId, stableParams, true);
-  const route = router.getRoute(routeId) as ResourceRouteModule | null;
-  const retry = useCallback(
-    () => void router.retry(routeId, stableParams),
-    [routeId, router, stableParams],
-  );
-  const contextValue = useMemo(
-    () => ({ params: stableParams, routeId }),
-    [routeId, stableParams],
-  );
-  useEffect(() => {
-    if (persistent) router.persist(routeId, stableParams);
-  }, [persistent, routeId, router, stableParams]);
-  let content: ReactNode = children;
-
-  if (children === undefined && route?.default) {
-    const RouteComponent = route.default;
-    content = <RouteComponent />;
-  }
-
-  if (state.unexpectedError && route?.ErrorBoundary) {
-    const ErrorBoundary = route.ErrorBoundary;
-    content = <ErrorBoundary retry={retry} />;
-  }
-
-  if (
-    !state.unexpectedError &&
-    !state.loaderInitialized &&
-    route?.HydrateFallback
-  ) {
-    const HydrateFallback = route.HydrateFallback;
-    content = <HydrateFallback />;
-  }
-
-  return (
-    <RouteContext.Provider value={contextValue}>
-      <RenderErrorBoundary
-        onRetry={retry}
-        resetKey={`${routeId}:${JSON.stringify(stableParams)}`}
-        {...(route?.ErrorBoundary ? { fallback: route.ErrorBoundary } : {})}
-      >
-        {content}
-      </RenderErrorBoundary>
-    </RouteContext.Provider>
-  );
-}
-
-/** Read the current resource route loader result. */
-export function useLoaderData<Data>(): Data | null {
-  const route = useCurrentRoute();
-
-  return useRouteLoaderData<Data>(route.routeId, route.params);
-}
-
-/** Read loader data for a registered resource route. */
-export function useRouteLoaderData<Data>(
-  routeId: string,
-  params: Params = {},
-): Data | null {
-  const state = useRouteState(routeId, useStableParams(params), true);
-
-  return state.loaderData as Data | null;
-}
-
-/** Read the current resource route action result. */
-export function useActionData<Data>(): Data | null {
-  const route = useCurrentRoute();
-  const state = useRouteState(route.routeId, route.params, false);
-
-  return state.actionData as Data | null;
-}
-
-/** Read the current page navigation or submission state. */
-export function useNavigation(): { state: NavigationState } {
-  const route = useCurrentRoute();
-  const state = useRouteState(route.routeId, route.params, false);
-
-  return { state: state.navigationState };
-}
-
-/** Return the resource route revalidation function. */
-export function useRevalidator(): {
-  revalidate: () => Promise<DataResult<unknown>>;
-  state: string;
-} {
-  const route = useCurrentRoute();
-  const router = useRouter();
-  const state = useRouteState(route.routeId, route.params, false);
-
-  return useMemo(
-    () => ({
-      revalidate: () => router.load(route.routeId, route.params, true),
-      state: state.navigationState === "loading" ? "loading" : "idle",
-    }),
-    [route, router, state.navigationState],
-  );
-}
-
-interface FetcherOptions {
-  params?: Params;
-  routeId?: string;
-}
-
-interface FetcherTarget {
-  params?: Params;
-  routeId?: string;
-}
-
-interface FormProps extends PropsWithChildren {
-  action?: string;
-  input?: unknown;
-  params?: Params;
-}
-
-/** Submit a resource action from a form without document navigation. */
-export function Form({
-  action,
-  children,
-  input,
-  params,
-}: FormProps): import("react").JSX.Element {
-  const currentRoute = useContext(RouteContext);
-  const router = useRouter();
-  const routeId = action ?? currentRoute?.routeId ?? "";
-  const routeParams = useStableParams(params ?? currentRoute?.params ?? {});
-  const submit = useCallback(
-    (override?: unknown) =>
-      router.submit(
-        routeId,
-        override === undefined ? input : override,
-        routeParams,
-      ),
-    [input, routeId, routeParams, router],
-  );
-
-  if (!routeId) throw new Error("Form requires an action or a parent Route.");
-
-  return <FormContext.Provider value={submit}>{children}</FormContext.Provider>;
-}
-
-/** Return a function that submits form data through the current router. */
-export function useSubmit(): (input?: unknown) => Promise<DataResult<unknown>> {
-  const submit = useContext(FormContext);
-
-  if (!submit) throw new Error("useSubmit must be used inside Form.");
-
-  return submit;
-}
-
-/** Read or mutate a resource independently of the rendered route. */
-export function useFetcher<Data = unknown>(
-  options: FetcherOptions = {},
-): readonly [
-  { data: Data | null; error: string; state: NavigationState },
-  {
-    Form: ({
-      children,
-      input,
-    }: Pick<FormProps, "children" | "input">) => import("react").JSX.Element;
-    load: (target?: FetcherTarget) => Promise<DataResult<Data>>;
-    submit: (
-      input: unknown,
-      target?: FetcherTarget,
-    ) => Promise<DataResult<Data>>;
-  },
-] {
-  const currentRoute = useContext(RouteContext);
-  const router = useRouter();
-  const routeId = options.routeId ?? currentRoute?.routeId ?? "";
-  const params = useStableParams(options.params ?? currentRoute?.params ?? {});
-  const [data, setData] = useState<Data | null>(null);
-  const [error, setError] = useState("");
-  const [state, setState] = useState<NavigationState>("idle");
-  const controller = useRef<AbortController | null>(null);
-  useEffect(
-    () => () => {
-      controller.current?.abort();
-    },
-    [],
-  );
-  const run = useCallback(
-    async (mutating: boolean, input: unknown, target: FetcherTarget) => {
-      controller.current?.abort();
-
-      const nextController = new AbortController();
-      const { signal } = nextController;
-      const targetId = target.routeId ?? routeId;
-      const targetParams = target.params ?? params;
-
-      controller.current = nextController;
-      setError("");
-      setState(mutating ? "submitting" : "loading");
-
-      const result = await (mutating
-        ? router.fetchAction<Data>(targetId, input, targetParams, signal)
-        : router.fetchLoader<Data>(targetId, targetParams, signal));
-
-      if (signal.aborted) return result;
-
-      controller.current = null;
-      setData(result.data);
-      setError(result.error);
-      setState("idle");
-
-      if (result.unexpected && currentRoute) {
-        router.reportUnexpected(currentRoute.routeId, currentRoute.params);
-      }
-
-      return result;
-    },
-    [currentRoute, params, routeId, router],
-  );
-  const submit = useCallback(
-    (input: unknown, target: FetcherTarget = {}) => run(true, input, target),
-    [run],
-  );
-  const load = useCallback(
-    (target: FetcherTarget = {}) => run(false, undefined, target),
-    [run],
-  );
-  const BoundForm = useCallback(
-    ({ children, input }: Pick<FormProps, "children" | "input">) => (
-      <FormContext.Provider
-        value={(override) => submit(override === undefined ? input : override)}
-      >
-        {children}
-      </FormContext.Provider>
-    ),
-    [submit],
-  );
-
-  if (!routeId)
-    throw new Error("useFetcher requires a routeId or a parent Route.");
-
-  const fetcherState = useMemo(
-    () => ({ data, error, state }),
-    [data, error, state],
-  );
-  const fetcherOperations = useMemo(
-    () => ({ Form: BoundForm, load, submit }),
-    [BoundForm, load, submit],
-  );
-
-  return [fetcherState, fetcherOperations] as const;
-}
-
-/** Read the resource router supplied by its provider. */
-export function useRouter(): ResourceRouter {
-  const router = useContext(RouterContext);
-
-  if (!router) throw new Error("RouterProvider is missing.");
-
-  return router;
-}
-
-function useCurrentRoute() {
-  const route = useContext(RouteContext);
-
-  if (!route) throw new Error("This hook requires a parent Route.");
-
-  return route;
-}
-
-function useRouteState(routeId: string, params: Params, loadOnMount: boolean) {
-  const router = useRouter();
-  const subscribe = useCallback(
-    (listener: () => void) => router.subscribe(routeId, params, listener),
-    [params, routeId, router],
-  );
-  const getSnapshot = useCallback(
-    () => router.getSnapshot(routeId, params),
-    [params, routeId, router],
-  );
-  const state = useSyncExternalStore(subscribe, getSnapshot, getSnapshot);
-  useEffect(() => {
-    if (loadOnMount) void router.load(routeId, params);
-  }, [loadOnMount, params, routeId, router]);
-
-  return state;
-}
-
-function useStableParams(params: Params) {
-  const key = JSON.stringify(
-    Object.entries(params).sort(([left], [right]) => left.localeCompare(right)),
-  );
-  const ref = useRef({ key, value: params });
-
-  if (ref.current.key !== key) ref.current = { key, value: params };
-
-  return ref.current.value;
-}
-
-interface RenderErrorBoundaryProps extends PropsWithChildren {
-  fallback?: ComponentType<{ retry: () => void }>;
-  onRetry: () => void;
-  resetKey: string;
-}
-
-class RenderErrorBoundary extends Component<
-  RenderErrorBoundaryProps,
-  { error: Error | null }
-> {
-  override state = { error: null };
-
-  static getDerivedStateFromError(error: Error) {
-    return { error };
-  }
-
-  override componentDidUpdate(previousProps: RenderErrorBoundaryProps) {
-    if (this.state.error && previousProps.resetKey !== this.props.resetKey) {
-      this.setState({ error: null });
-    }
-  }
-
-  override render() {
-    if (this.state.error && this.props.fallback) {
-      const ErrorBoundary = this.props.fallback;
-
-      return (
-        <ErrorBoundary
-          retry={() => {
-            this.setState({ error: null });
-            this.props.onRetry();
-          }}
-        />
-      );
-    }
-
-    if (this.state.error) throw this.state.error;
-
-    return this.props.children;
-  }
-}
-
-export type { NavigationState, RouteState };
-
-const EMPTY_MATCHES: readonly { params?: Params; routeId: string }[] = [];

package/dist/core/resource-types.d.ts

@@ -1,41 +0,0 @@
-export type Params = Readonly<Record<string, string>>;
-/** Resource parameters and cancellation signal supplied to a loader. */
-export interface LoaderFunctionArgs {
-    params: Params;
-    signal: AbortSignal;
-}
-/** Submitted input, resource parameters and cancellation signal supplied to an action. */
-export interface ActionFunctionArgs<Input = unknown> {
-    input: Input;
-    params: Params;
-    signal: AbortSignal;
-}
-/** Successful resource data or a normalized resource failure. */
-export interface DataResult<Data> {
-    data: Data | null;
-    error: string;
-    unexpected?: true;
-}
-export interface ResourceModule {
-    action?: (args: ActionFunctionArgs) => Promise<DataResult<unknown>>;
-    loader?: (args: LoaderFunctionArgs) => Promise<DataResult<unknown>>;
-    shouldRevalidate?: (args: ShouldRevalidateFunctionArgs) => boolean;
-}
-/** Navigation or mutation context used to decide whether loader data should refresh. */
-export interface ShouldRevalidateFunctionArgs {
-    actionResult: DataResult<unknown>;
-    defaultShouldRevalidate: boolean;
-    params: Params;
-}
-export type NavigationState = "idle" | "loading" | "submitting";
-export interface RouteState {
-    actionData: unknown;
-    actionError: string;
-    actionState: "idle" | "submitting";
-    loaderData: unknown;
-    loaderError: string;
-    loaderInitialized: boolean;
-    loaderState: "idle" | "loading";
-    navigationState: NavigationState;
-    unexpectedError: boolean;
-}

package/dist/core/resources.d.ts

@@ -1,21 +0,0 @@
-import type { DataResult, Params, ResourceModule, RouteState } from "./resource-types.ts";
-/** Manage keyed resource reads, submissions, subscriptions and cancellation independently of navigation. */
-export declare class ResourceRouter {
-    #private;
-    constructor(routes: ReadonlyMap<string, ResourceModule>);
-    dispose(): void;
-    getRoute(routeId: string): ResourceModule | null;
-    getSnapshot(routeId: string, params: Params): RouteState;
-    hydrateRoute<Data>(routeId: string, data: Data, params?: Params): void;
-    persist(routeId: string, params?: Params): void;
-    disposeRoute(routeId: string, params?: Params): void;
-    load<Data>(routeId: string, params?: Params, force?: boolean): Promise<DataResult<Data>>;
-    subscribe(routeId: string, params: Params, listener: () => void): () => void;
-    submit<Data>(routeId: string, input: unknown, params?: Params): Promise<DataResult<Data>>;
-    fetchLoader<Data>(routeId: string, params: Params, signal: AbortSignal): Promise<DataResult<Data>>;
-    fetchAction<Data>(routeId: string, input: unknown, params: Params, signal: AbortSignal): Promise<DataResult<Data>>;
-    retry(routeId: string, params: Params): Promise<DataResult<unknown>>;
-    reportUnexpected(routeId: string, params: Params): void;
-}
-/** Create an independent resource-data router from registered modules; this does not manage URL history. */
-export declare function createResourceRouter(routes: ReadonlyMap<string, ResourceModule>): ResourceRouter;