Add readme, license and few more tests

LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -1,61 +1,121 @@
-# TsRoutes
+# ts-routes
 
-<a alt="Nx logo" href="https://nx.dev" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png" width="45"></a>
+[![npm](https://img.shields.io/npm/v/ts-routes)](https://www.npmjs.com/package/ts-routes)
+[![Actions Status](https://github.com/leancodepl/ts-routes/workflows/build/badge.svg)](https://github.com/leancodepl/ts-routes/actions)
 
-✨ **This workspace has been generated by [Nx, a Smart, fast and extensible build system.](https://nx.dev)** ✨
+Helper library for constructing strongly typed parameterized routing paths. It prevents you from passing hardcoded
+strings with routes across the app.
 
-## Generate code
+## Installation
 
-If you happen to use Nx plugins, you can leverage code generators that might come with it.
-
-Run `nx list` to get a list of available plugins and whether they have generators. Then run `nx list <plugin-name>` to
-see what generators are available.
+```
+npm install ts-routes
+yarn add ts-routes
+```
 
-Learn more about [Nx generators on the docs](https://nx.dev/plugin-features/use-code-generators).
+## Quick start
+
+First, define your routes as an array of `RouteElement`:
+
+```typescript
+const routes = [
+    { name: "home", path: "" },
+    { name: "products", path: "products/" },
+    { name: "users", path: "users/:userId" },
+    {
+        name: "items",
+        path: "items/",
+        children: [
+            { name: "item", path: ":itemId" },
+            { name: "edit", path: "edit/:itemId" },
+        ],
+    },
+] as const;
+```
 
-## Running tasks
+Then, create your path-making function using `mkPath`:
 
-To execute tasks with Nx use the following syntax:
+```typescript
+import { mkPath } from "@leancodepl/ts-routes";
 
-```
-nx <target> <project> <...options>
+const path = mkPath(routes);
 ```
 
-You can also run multiple targets:
+Now, you can create paths like this:
 
-```
-nx run-many -t <target1> <target2>
+```typescript
+const homePath = path("home"); // Output: '/'
+const productsPath = path("products"); // Output: '/products/'
+const userPath = path("users", { userId: "42" }); // Output: '/users/42'
+const itemPath = path("items", "item", { itemId: "1" }); // Output: '/items/1'
+const editItemPath = path("items", "edit", { itemId: "1" }); // Output: '/items/edit/1'
 ```
 
-..or add `-p` to filter specific projects
+## Examples
 
-```
-nx run-many -t <target1> <target2> -p <proj1> <proj2>
+### Usage with `react-router`:
+
+#### Route definition
+
+```typescript
+import { useRoutes } from "react-router";
+
+type MutableDeep<T> = T extends string
+    ? T
+    : T extends ReadonlyArray<infer ArrayType>
+    ? Array<MutableDeep<ArrayType>>
+    : {
+          -readonly [K in keyof T]: MutableDeep<T[K]>;
+      };
+
+const routes = [
+    { name: "home", path: "" },
+    { name: "products", path: "products/" },
+    { name: "users", path: "users/:userId" },
+    // ...
+] as const;
+
+export path = mkPath(routes);
+
+const mutableRoutes = routes as unknown as MutableDeep<typeof routes>; // React Router typings are not compatible with readonly objects
+
+function App() {
+    const router = useRoutes(routes);
+
+    return <main>{router}</main>;
+}
 ```
 
-Targets can be defined in the `package.json` or `projects.json`. Learn more
-[in the docs](https://nx.dev/core-features/run-tasks).
+This will create an equivalent of `<Routes>` component with routes defined in `routes` array, more info about
+`useRoutes` [here](https://reactrouter.com/en/main/hooks/use-routes).
 
-## Want better Editor Integration?
+#### Page navigation
+
+Function created with `mkPath` can be used to generate paths for `Link` component or any other navigation method:
+
+```typescript
+import { Link } from "react-router-dom";
+import { path } from "./path";
+
+function DemoLink() {
+    return <Link to={path("home")}>Home</Link>;
+}
+```
 
-Have a look at the [Nx Console extensions](https://nx.dev/nx-console). It provides autocomplete support, a UI for
-exploring and running tasks & generators, and more! Available for VSCode, IntelliJ and comes with a LSP for Vim users.
+## API
 
-## Ready to deploy?
+### `mkPath(routes: RouteElement[])`
 
-Just run `nx build demoapp` to build the application. The build artifacts will be stored in the `dist/` directory, ready
-to be deployed.
+Create a path-making function based on a list of `RouteElement`.
 
-## Set up CI!
+-   `routes` - An array of route elements to create the path-making function.
 
-Nx comes with local caching already built-in (check your `nx.json`). On CI you might want to go a step further.
+### `RouteElement`
 
--   [Set up remote caching](https://nx.dev/core-features/share-your-cache)
--   [Set up task distribution across multiple machines](https://nx.dev/core-features/distribute-task-execution)
--   [Learn more how to setup CI](https://nx.dev/recipes/ci)
+`{ name: string; path: string; children?: readonly RouteElement[] }`
 
-## Connect with us!
+A single route element that defines:
 
--   [Join the community](https://nx.dev/community)
--   [Subscribe to the Nx Youtube Channel](https://www.youtube.com/@nxdevtools)
--   [Follow us on Twitter](https://twitter.com/nxdevtools)
+-   `name` - The name of the route.
+-   `path` - The path associated with the route. Can contain variables like `:userId`.
+-   `children` (optional) - An array of child routes.

packages/routes/package.json

@@ -4,6 +4,8 @@
   "type": "commonjs",
   "main": "./index.cjs",
   "module": "./index.js",
+  "author": "LeanCode",
+  "license": "Apache-2.0",
   "dependencies": {
     "react-router": "^6.15.0"
   }