@remix-run/router 0.2.0-pre.8 → 1.0.0

package/CHANGELOG.md

@@ -1,159 +1,14 @@
 # @remix-run/router
 
-## 0.2.0-pre.8
+## 1.0.0
 
-### Patch Changes
+This is the first stable release of `@remix-run/router`, which provides all the underlying routing and data loading/mutation logic for `react-router`. You should _not_ be using this package directly unless you are authoring a routing library similar to `react-router`.
 
-- fix: avoid uneccesary re-renders on `defer` resolution (#9155)
-- fix: pass `useMatches` objects to `ScrollRestoration` `getKey` (#9157)
-- fix: fetcher submission revalidating fetchers using wrong key (#9166)
-- fix: use a push navigation on submission errors (#9162)
+For an overview of the features provided by `react-router`, we recommend you go check out the [docs][rr-docs], especially the [feature overview][rr-feature-overview] and the [tutorial][rr-tutorial].
 
-## 0.2.0-pre.7
+For an overview of the features provided by `@remix-run/router`, please check out the [README][remix-router-readme].
 
-### Patch Changes
-
-- fix: fix default redirect push/replace behavior (#9117)
-
-## 0.2.0-pre.6
-
-### Patch Changes
-
-- fix: Rename `<Deferred>` to `<Await>` (#9095)
-
-  - We are no longer replacing the `Promise` on `loaderData` with the value/error
-    when it settles so it's now always a `Promise`.
-  - To that end, we changed from `<Deferred value={promise}>` to
-    `<Await resolve={promise}>` for clarity, and it also now supports using
-    `<Await>` with raw promises from anywhere, not only those on `loaderData`
-    from a defer() call.
-    - Note that raw promises will not be automatically cancelled on interruptions
-      so they are not recommended
-  - The hooks are now `useAsyncValue`/`useAsyncError`
-
-## 0.2.0-pre.5
-
-### Patch Changes
-
-- feat: Deferred API Updates (#9070)
-
-  - Support array and single promise usages
-    - `return defer([ await critical(), lazy() ])`
-    - `return defer(lazy())`
-  - Remove `Deferrable`/`ResolvedDeferrable` in favor of raw `Promise`'s and `Awaited`
-  - Remove generics from `useAsyncValue` until `useLoaderData` generic is decided in 6.5
-
-- feat: Add `createStaticRouter` for `@remix-run/router` SSR usage (#9013)
-
-  **Notable changes:**
-
-  - `request` is now the driving force inside the router utils, so that we can better handle `Request` instances coming form the server (as opposed to `string` and `Path` instances coming from the client)
-  - Removed the `signal` param from `loader` and `action` functions in favor of `request.signal`
-
-  **Example usage (Document Requests):**
-
-  ```jsx
-  // Create a static handler
-  let { query } = unstable_createStaticHandler(routes);
-
-  // Perform a full-document query for the incoming Fetch Request.  This will
-  // execute the appropriate action/loaders and return either the state or a
-  // Fetch Response in the case of redirects.
-  let state = await query(fetchRequest);
-
-  // If we received a Fetch Response back, let our server runtime handle directly
-  if (state instanceof Response) {
-    throw state;
-  }
-
-  // Otherwise, render our application providing the data routes and state
-  let html = ReactDOMServer.renderToString(
-    <React.StrictMode>
-      <DataStaticRouter routes={routes} state={state} />
-    </React.StrictMode>
-  );
-  ```
-
-  **Example usage (Data Requests):**
-
-  ```jsx
-  // Create a static route handler
-  let { queryRoute } = unstable_createStaticHandler(routes);
-
-  // Perform a single-route query for the incoming Fetch Request.  This will
-  // execute the appropriate singular action/loader and return either the raw
-  // data or a Fetch Response
-  let data = await queryRoute(fetchRequest);
-
-  // If we received a Fetch Response back, return it directly
-  if (data instanceof Response) {
-    return data;
-  }
-
-  // Otherwise, construct a Response from the raw data (assuming json here)
-  return new Response(JSON.stringify(data), {
-    headers: {
-      "Content-Type": "application/json; charset=utf-8",
-    },
-  });
-  ```
-
-- feat: SSR Updates for React Router (#9058)
-
-  _Note: The Data-Router SSR aspects of `@remix-run/router` and `react-router-dom` are being released as **unstable** in this release (`unstable_createStaticHandler` and `unstable_DataStaticRouter`), and we plan to finalize them in a subsequent minor release once the kinks can be worked out with the Remix integration. To that end, they are available for use, but are subject to breaking changes in the next minor release._
-
-  - Remove `useRenderDataRouter()` in favor of `<DataRouterProvider>`/`<DataRouter>`
-  - Support automatic hydration in `<DataStaticRouter>`/`<DataBrowserRouter>`/`<DataHashRouter>`
-    - Uses `window.__staticRouterHydrationData`
-    - Can be disabled on the server via `<DataStaticRouter hydrate={false}>`
-    - Can be disabled (or overridden) in the browser by passing `hydrationData` to `<DataBrowserRouter>`/`<DataHashRouter>`
-  - `<DataStaticRouter>` now tracks it's own SSR error boundaries on `StaticHandlerContext`
-  - `StaticHandlerContext` now exposes `statusCode`/`loaderHeaders`/`actionHeaders`
-  - `foundMissingHydrationData` check removed since Remix routes may have loaders (for modules) that don't return data for `loaderData`
-
-## 0.2.0-pre.4
-
-### Patch Changes
-
-- fix: Handle fetcher 404s as normal boundary errors (#9015)
-- feat: adds `defer()` support to data routers (#9002)
-- feat: add basename support for data routers (#9026)
-- ci: simplify dist/ directory for CJS/ESM only (#9017)
-- fix: Fix trailing slash behavior on pathless routing when using a basename (#9045)
-
-## 0.2.0-pre.3
-
-### Patch Changes
-
-- fix: properly handle `<Form encType="multipart/form-data">` submissions (#8984)
-- fix: Make path resolution trailing slash agnostic (#8861)
-- fix: don't default to a `REPLACE` navigation on form submissions if the action redirected. The redirect takes care of avoiding the back-button-resubmit scenario, so by using a `PUSH` we allow the back button to go back to the pre-submission form page (#8979)
-- fix: export ActionFunctionArgs/LoaderFunctionArgs up through router packages (#8975)
-- fix: preserve loader data for loaders that opted out of revalidation (#8973)
-
-[Full Changes](https://github.com/remix-run/react-router/compare/%40remix-run/router%400.2.0-pre.2...%40remix-run/router%400.2.0-pre.3)
-
-## 0.2.0-pre.2
-
-### Patch Changes
-
-- Capture fetcher errors at contextual route error boundaries (#8945)
-
-## 0.2.0-pre.1
-
-### Patch Changes
-
-- Fix missing `dist` files
-
-## 0.2.0-pre.0
-
-### Minor Changes
-
-- Change `formMethod=GET` to be a loading navigation instead of submitting
-
-### Patch Changes
-
-- Make `fallbackElement` optional and change type to `ReactNode` (type changes only) (#8896)
-- Properly trigger error boundaries on 404 routes
-- Fix `resolveTo` so that it does not mutate the provided pathname (#8839)
-- Pass fetcher `actionResult` through to `shouldRevalidate` on fetcher submissions
+[rr-docs]: https://reactrouter.com/
+[rr-feature-overview]: https://reactrouter.com/en/v6.4.0/start/overview
+[rr-tutorial]: https://reactrouter.com/en/v6.4.0/start/tutorial
+[remix-router-readme]: https://github.com/remix-run/react-router/blob/main/packages/router/README.md

package/README.md

@@ -1,11 +1,12 @@
-# Router
+# Remix Router
 
-The `@remix-run/router` package is the heart of [React Router](https://github.com/remix-run/react-router) and provides all the core functionality for routing, data loading, data mutations, and navigation.
+The `@remix-run/router` package is a framework-agnostic routing package (sometimes referred to as a browser-emulator) that serves as the heart of [React Router][react-router] and [Remix][remix] and provides all the core functionality for routing coupled with data loading and data mutations. It comes with built-in handling of errors, race-conditions, interruptions, cancellations, lazy-loading data, and much, much more.
 
-If you're using React Router, you should never `import` anything directly from
-the `@remix-run/router` or `react-router` packages, but you should have everything
-you need in either `react-router-dom` or `react-router-native`. Both of those
-packages re-export everything from `@remix-run/router` and `react-router`.
+If you're using React Router, you should never `import` anything directly from the `@remix-run/router` or `react-router` packages, but you should have everything you need in either `react-router-dom` or `react-router-native`. Both of those packages re-export everything from `@remix-run/router` and `react-router`.
+
+> **Warning**
+>
+> This router is a low-level package intended to be consumed by UI layer routing libraries. You should very likely not be using this package directly unless you are authoring a routing library such as [`react-router-dom`][react-router-repo] or one of it's other [UI ports][remix-routers-repo].
 
 ## API
 
@@ -15,12 +16,10 @@ A Router instance can be created using `createRouter`:
 // Create and initialize a router.  "initialize" contains all side effects
 // including history listeners and kicking off the initial data fetch
 let router = createRouter({
-  // Routes array using react-router RouteObject's
-  routes,
+  // Routes array
+  routes: ,
   // History instance
   history,
-  // Optional hydration data for SSR apps
-  hydrationData?: HydrationState;
 }).initialize()
 ```
 
@@ -28,6 +27,8 @@ Internally, the Router represents the state in an object of the following format
 
 ```ts
 interface RouterState {
+  // False during the initial data load, true once we have our initial data
+  initialized: boolean;
   // The `history` action of the most recently completed navigation
   historyAction: Action;
   // The current location of the router.  During a navigation this reflects
@@ -35,18 +36,10 @@ interface RouterState {
   location: Location;
   // The current set of route matches
   matches: DataRouteMatch[];
-  // False during the initial data load, true once we have our initial data
-  initialized: boolean;
   // The state of the current navigation
   navigation: Navigation;
-  // The state of an in-progress router.revalidate() calls
+  // The state of any in-progress router.revalidate() calls
   revalidation: RevalidationState;
-  // Scroll position to restore to for the active Location, false if we
-  // should not restore,m or null if we don't have a saved position
-  // Note: must be enabled via router.enableScrollRestoration()
-  restoreScrollPosition: number | false | null;
-  // Proxied `resetScroll` value passed to router.navigate() (default true)
-  resetScrollPosition: boolean;
   // Data from the loaders for the current matches
   loaderData: RouteData;
   // Data from the action for the current matches
@@ -55,6 +48,12 @@ interface RouterState {
   errors: RouteData | null;
   // Map of all active fetchers
   fetchers: Map<string, Fetcher>;
+  // Scroll position to restore to for the active Location, false if we
+  // should not restore, or null if we don't have a saved position
+  // Note: must be enabled via router.enableScrollRestoration()
+  restoreScrollPosition: number | false | null;
+  // Proxied `preventScrollReset` value passed to router.navigate()
+  preventScrollReset: boolean;
 }
 ```
 
@@ -98,6 +97,11 @@ router.fetch("key", "/page", {
 });
 ```
 
-## Revalidation
+### Revalidation
 
 By default, active loaders will revalidate after any navigation or fetcher mutation. If you need to kick off a revalidation for other use-cases, you can use `router.revalidate()` to re-execute all active loaders.
+
+[react-router]: https://reactrouter.com
+[remix]: https://remix.run
+[react-router-repo]: https://github.com/remix-run/react-router
+[remix-routers-repo]: https://github.com/brophdawg11/remix-routers

package/dist/index.d.ts

@@ -1,13 +1,8 @@
-import type { BrowserHistoryOptions, HashHistoryOptions, MemoryHistoryOptions } from "./history";
-import type { Router, RouterInit } from "./router";
 import { convertRoutesToDataRoutes } from "./utils";
 export type { ActionFunction, ActionFunctionArgs, AgnosticDataRouteMatch, AgnosticDataRouteObject, AgnosticRouteMatch, AgnosticRouteObject, TrackedPromise, FormEncType, FormMethod, JsonFunction, LoaderFunction, LoaderFunctionArgs, ParamParseKey, Params, PathMatch, PathPattern, RedirectFunction, ShouldRevalidateFunction, Submission, } from "./utils";
-export { ErrorResponse, defer, generatePath, getToPathname, invariant, isRouteErrorResponse, joinPaths, json, matchPath, matchRoutes, normalizePathname, redirect, resolvePath, resolveTo, stripBasename, warning, } from "./utils";
-export type { BrowserHistory, HashHistory, History, InitialEntry, Location, MemoryHistory, Path, To, } from "./history";
+export { AbortedDeferredError, ErrorResponse, defer, generatePath, getToPathname, invariant, isRouteErrorResponse, joinPaths, json, matchPath, matchRoutes, normalizePathname, redirect, resolvePath, resolveTo, stripBasename, warning, } from "./utils";
+export type { BrowserHistory, BrowserHistoryOptions, HashHistory, HashHistoryOptions, History, InitialEntry, Location, MemoryHistory, MemoryHistoryOptions, Path, To, } from "./history";
 export { Action, createBrowserHistory, createPath, createHashHistory, createMemoryHistory, parsePath, } from "./history";
 export * from "./router";
-export declare function createMemoryRouter({ initialEntries, initialIndex, ...routerInit }: MemoryHistoryOptions & Omit<RouterInit, "history">): Router;
-export declare function createBrowserRouter({ window, ...routerInit }: BrowserHistoryOptions & Omit<RouterInit, "history">): Router;
-export declare function createHashRouter({ window, ...routerInit }: HashHistoryOptions & Omit<RouterInit, "history">): Router;
 /** @internal */
 export { convertRoutesToDataRoutes as UNSAFE_convertRoutesToDataRoutes };