@akb2/react-router 0.0.0-stage → 1.1.0

package/LICENSE

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

package/README.md

@@ -1,3 +1,268 @@
-# Temporary Holding Version
+# @akb2/react-router
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[Русский](README.ru.md)
+
+Route configuration composition and React routing utilities built on Wouter.
+
+## Installation
+
+```sh
+pnpm add @akb2/react-router react@^18.3.1 wouter@^3.13.0 @akb2/types-tools@^1.5.0
+```
+
+React, Wouter, and `@akb2/types-tools` are required peers. This repository uses pnpm 12.5.1.
+
+## Public API
+
+The package entry point currently exports:
+
+| Export                    | Purpose                                                        |
+| ------------------------- | -------------------------------------------------------------- |
+| `reactRouterFabric`       | Merge route configurations.                                    |
+| `routerContextFabric`     | Create the router provider, hooks, and URL builders.           |
+| `componentsContextFabric` | Create the components provider and access hook.                |
+| `ReactComponents`         | Map component props to a typed set of React components.        |
+| `RouterComponents`        | Required router components: `FullPageLoader` with empty props. |
+| `RoutesDefinition`        | Type for rendering definitions.                                |
+| `RoutesKeys`              | Route keys as arrays or dot-separated strings.                 |
+| `RoutesPathKeys`          | Dot-separated route keys.                                      |
+
+Import all three factories directly from `@akb2/react-router`.
+
+## Compose route configurations
+
+```tsx
+import { reactRouterFabric } from "@akb2/react-router";
+
+const baseRoutes = {
+  home: { path: "", Template: () => <h1>Home</h1> },
+  users: { path: "users", Template: () => <h1>Users</h1> },
+  notFound: { isNotFound: true, Template: () => <h1>Not found</h1> },
+};
+
+const userRoutes = {
+  detail: {
+    putInKey: "users",
+    path: ":id",
+    Template: () => <h1>User details</h1>,
+  },
+};
+
+const routes = reactRouterFabric(baseRoutes, userRoutes);
+// routes.users.children.detail → /users/:id
+```
+
+The result is a configuration object, not a React router or provider. Without `putInKey`, routes are added at the root. With `putInKey`, a route is attached to `children` of the named root route. The target is a root key, not a dot-separated path. Duplicate keys and unresolved parent references throw errors; a missing parent currently uses the circular-dependency error message.
+
+## Route configuration
+
+| Field              | Meaning                                                |
+| ------------------ | ------------------------------------------------------ |
+| `path`             | One path; `""` represents the root.                    |
+| `paths`            | Alternative paths for the same route.                  |
+| `isNotFound`       | Marks the fallback route.                              |
+| `children`         | Nested routes appended to their parent path.           |
+| `Template`         | Component rendered for the active route.               |
+| `Module`           | Lazy React component rendered with Suspense.           |
+| `redirectUrl`      | Destination passed to Wouter's `Redirect`.             |
+| `props`            | Props passed to the active page.                       |
+| `SuspenseTemplate` | Per-route loading component.                           |
+| `putInKey`         | Parent root key used during configuration composition. |
+
+Dynamic path segments use `:name`, for example `users/:id`.
+
+`routerContextFabric` validates configurations at creation time. Each route must specify exactly one of `path`, `paths`, or `isNotFound`, and exactly one of `Template`, `Module`, or `redirectUrl`. Alternative paths must be nonempty. A single fallback route is required at the root and cannot have children. Generated duplicate URLs are rejected.
+
+## Create and render a router
+
+Using `routes` from the composition example:
+
+```tsx
+import {
+  routerContextFabric,
+  componentsContextFabric,
+  type ReactComponents,
+  type RouterComponents,
+} from "@akb2/react-router";
+
+type AppComponents = ReactComponents<RouterComponents>;
+
+const router = routerContextFabric(routes);
+const { ComponentsProvider } = componentsContextFabric<AppComponents>();
+const components: AppComponents = { FullPageLoader: () => <p>Loading…</p> };
+
+export function App() {
+  return (
+    <ComponentsProvider components={components}>
+      <router.RouterProvider />
+    </ComponentsProvider>
+  );
+}
+```
+
+Create factories outside components. `ComponentsProvider` supplies `FullPageLoader`; it is required by `RouterProvider` even when the current page is synchronous. A route's `SuspenseTemplate` overrides that loader.
+
+`RouterProvider` renders the active page and supplies the routes through `RouterContext`. It does not render arbitrary children as an application wrapper. Include navigation and layouts in route components as needed. Parent route templates are not automatically composed as nested layouts.
+
+Wouter manages location. To customize its routing environment, place its `Router` above the consumers.
+
+### Shared components
+
+`componentsContextFabric()` returns `ComponentsProvider`, `ComponentsContext`, and `useComponents`. Pass a component map containing `FullPageLoader` to the provider. Call `useComponents()` inside its descendants to read that map; calling it outside the provider throws an error.
+
+`RouterComponents` describes the required router component props. `ReactComponents<T>` maps props objects to `FC` types while preserving entries that are already component function types. Pass the resulting type as the factory's generic argument.
+
+Extend the props map to add shared components:
+
+```tsx
+type ExtendedComponents = ReactComponents<
+  RouterComponents & {
+    PageTitle: { title: string };
+  }
+>;
+
+const shared = componentsContextFabric<ExtendedComponents>();
+const extendedComponents: ExtendedComponents = {
+  FullPageLoader: () => <p>Loading…</p>,
+  PageTitle: ({ title }) => <h1>{title}</h1>,
+};
+
+function SharedPageTitle() {
+  const { PageTitle } = shared.useComponents();
+  return <PageTitle title="Users" />;
+}
+
+function SharedComponentsExample() {
+  return (
+    <shared.ComponentsProvider components={extendedComponents}>
+      <SharedPageTitle />
+    </shared.ComponentsProvider>
+  );
+}
+```
+
+In an application, pass this map to the provider wrapping `RouterProvider` and read it through `shared.useComponents()` inside page components.
+
+## Build URLs
+
+```ts
+router.createUrlFromRouteConfig("users.detail", { id: 42 });
+// "/users/42"
+router.createUrlFromRouteConfig(["users", "detail"], { id: 42 }, { tab: "profile" });
+// "/users/42?tab=profile"
+router.createUrlsFromRouteConfig("users.detail", { id: 42 });
+// ["/users/42"]
+```
+
+Both builders accept `(key, pathParams?, queryParams?, safePathParams?)`. They can be called outside React.
+
+- `createUrlFromRouteConfig` uses the first alternative path.
+- `createUrlsFromRouteConfig` returns all combinations of parent and child path alternatives.
+- Query keys and values are encoded; `null` values are omitted.
+- Path values are substituted directly, without URL encoding. Missing values become `*`.
+- Set `safePathParams` to `true` to keep placeholders such as `:id`.
+
+## Navigation and matching hooks
+
+Call hooks inside components or custom hooks:
+
+```tsx
+function UserNavigation() {
+  const [pathname, navigate] = router.useLocation<{ source: string }>();
+  const [matches, params] = router.useRoute("users.detail");
+  const active = router.useActivatedRoute();
+
+  return (
+    <button
+      onClick={() =>
+        navigate("users.detail", { id: 42 }, undefined, {
+          replace: true,
+          state: { source: "navigation" },
+        })
+      }
+    >
+      {pathname}: {matches ? params?.id : active.routeKeyString}
+    </button>
+  );
+}
+```
+
+| Hook                  | Result                                                                             |
+| --------------------- | ---------------------------------------------------------------------------------- |
+| `useLocation<S>()`    | `[pathname, navigate]`; pathname excludes the query string.                        |
+| `useRoute(key)`       | Wouter's match tuple with extracted parameters; checks the first path alternative. |
+| `useActivatedRoute()` | Active route metadata, including parent configurations.                            |
+
+`navigate(key, pathParams?, queryParams?, options?)` forwards `replace`, `state`, and `transition` options to Wouter. It selects the first path alternative containing all supplied path parameter keys, or the first alternative if none qualifies.
+
+`useActivatedRoute()` returns `activatedRoute`, `routeKey`, `routeKeyString`, `routeUrlMask`, `parents`, `pathParams`, and `queryParams`. Parameters read from the URL are strings. Static segments take priority over parameterized segments when choosing among matching candidates. On fallback, key and parent metadata may retain a matched prefix. Currently `routeUrlMask` contains the unmatched accumulated path and is empty after a complete match; it does not provide the matched route's full mask.
+
+## URL state hooks
+
+Inside a component:
+
+```tsx
+function UserIdControl() {
+  const [id, setId] = router.useRoutePathState<string>("id", "unknown");
+
+  return <button onClick={() => setId("43")}>Current user: {id}</button>;
+}
+
+function TabControl() {
+  const [tab, setTab] = router.useRouteQueryState<string>("tab", "overview");
+
+  return (
+    <div>
+      <span>{tab}</span>
+      <button onClick={() => setTab("settings")}>Settings</button>
+      <button onClick={() => setTab("overview")}>Reset tab</button>
+    </div>
+  );
+}
+```
+
+`useRoutePathState` reads a path parameter, using the fallback when absent. Its setter affects the URL only if that parameter exists in the current route path.
+
+`useRouteQueryState` reads a query parameter. Setting its fallback or an empty string removes that parameter; setting its current value skips navigation.
+
+Both setters use history replacement and attempt to preserve other parameters. Both hooks accept `string | number`, but existing URL values remain strings: a numeric generic does not parse numbers.
+
+## Types
+
+```ts
+import type { RoutesKeys, RoutesPathKeys } from "@akb2/react-router";
+
+type Key = RoutesKeys<typeof routes>;
+type PathKey = RoutesPathKeys<typeof routes>;
+type Router = typeof router;
+type ActiveRoute = ReturnType<typeof router.useActivatedRoute>;
+```
+
+Keep the inferred route object type to preserve specific route keys. `RoutesDefinition` describes rendering definitions rather than the complete path configuration. Other internal types are not exported at the package root.
+
+## Known limitations
+
+Four `it.fails` tests document two implementation defects:
+
+- Combining dynamic path parameters with query parameters during navigation can replace the final path parameter with `*`. This also affects the state hooks.
+- A shorter path alternative can match too early, causing active-route detection to return the fallback for a valid longer alternative.
+
+Router contexts are shared globally across factory calls, while helpers capture each factory's configuration. Avoid nesting providers from unrelated configurations.
+
+## Development
+
+```sh
+pnpm install
+pnpm test
+pnpm test:watch
+pnpm exec tsc -p tsconfig.test.json --noEmit
+pnpm build
+```
+
+Tests in `tests/router-context-fabric` cover each feature in a separate file. Expected-failure tests execute normally and must lose their `it.fails` annotation once the corresponding defect is fixed.
+
+`pnpm build` generates ESM, CommonJS, and TypeScript declarations in `.dist` from the public entry point.
+
+## License
+
+[MPL-2.0](LICENSE)