nuxt-typed-router 2.0.0-beta.1 → 2.0.1

package/README.md

@@ -1,7 +1,7 @@
-# 🚗🚦 Typed Router for Nuxt
+
 
 <p align="center">
-  <img width='100' src="https://raw.githubusercontent.com/victorgarciaesgi/nuxt-typed-router/master/.github/images/logo.png" alt="nuxt-typed-router logo">
+  <img src="https://raw.githubusercontent.com/victorgarciaesgi/nuxt-typed-router/master/.github/images/cover.png" alt="nuxt-typed-router cover">
 </p>
 
 
@@ -18,26 +18,40 @@
 
 ## Provide a type safe router to Nuxt with auto-generated typed definitions for route names and autocompletion for route params
 
-- 🏎 Provides a hook `useTypedRouter` that returns an alias of `$typedRouter` and also a typed list of your routes
-- 🚚 Expose a global method `$typedRouter` (clone of vue-router), but typed with the routes defined in `pages` directory
-- 🚦 Provides auto-completion and errors for route params in `push` and `replace` methods
+- Automaticaly provides types check and autocomplete to `NuxtLink`
+- Exports a `useTypedRouter` and `useTypedRoute` composable
+- Supports routes defined in `config.extendRoutes`
+- Infer route params based on route name
+- Provide global `$typedRouter` util
+
+<br/>
 
 <br/>
+<p align="center">
+  <img src="https://github.com/victorgarciaesgi/nuxt-typed-router/blob/master/.github/images/nuxt-router.gif?raw=true"/>
+</p>
+<br/>
+
+
+# Documentation
+
+[![Open in StackBlitz](https://github.com/victorgarciaesgi/nuxt-typed-router/blob/master/.github/images/redirectDoc.svg?raw=true)](https://nuxt-typed-router.vercel.app/)
+
+# Play with it
+[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/edit/github-7e4xvw?file=store/testRouter.ts)
 
-Demo 🧪 : [nuxt-typed-router-demo](https://github.com/victorgarciaesgi/nuxt-typed-router-demo)
+Demo repo 🧪 : [nuxt-typed-router-demo](https://github.com/victorgarciaesgi/nuxt-typed-router-demo)
 
-## Compatibility:
+<br/>
+
+# Compatibility:
 
 - Nuxt 3
 - Nuxt 2 (via [`nuxt2` branch](https://github.com/victorgarciaesgi/nuxt-typed-router/tree/nuxt2))
 
-<br/>
-<p align="center">
-  <img src="https://github.com/victorgarciaesgi/nuxt-typed-router/blob/master/.github/images/in-action.gif?raw=true"/>
-</p>
-<br/>
 
-# Installation
+
+# Quick start
 
 ### For Nuxt 3
 
@@ -50,6 +64,7 @@ npm install -D nuxt-typed-router
 ### Nuxt 2 legacy
 
 Nuxt 2 version is no longer maintained, but still available in [`nuxt2` branch](https://github.com/victorgarciaesgi/nuxt-typed-router/tree/nuxt2)
+It only has route name autocomplete functionnality
 
 ```bash
 yarn add -D nuxt-typed-router@legacy
@@ -57,9 +72,8 @@ yarn add -D nuxt-typed-router@legacy
 npm install -D nuxt-typed-router@legacy
 ```
 
-# Quick start
-
-First, register the module in the `nuxt.config.ts`
+# Configuration
+Register the module in the `nuxt.config.ts`, done!
 
 ```ts
 export default defineNuxtConfig({

package/dist/module.json

@@ -5,5 +5,5 @@
     "nuxt": "^3.0.0-rc.1",
     "bridge": false
   },
-  "version": "2.0.0-beta.1"
+  "version": "2.0.1"
 }

package/dist/module.mjs

@@ -171,7 +171,8 @@ function createDeclarationRoutesFile() {
 function createRuntimeIndexFile() {
   return `
   ${watermarkTemplate}
-  export {routesNames, TypedRouteList} from './__routes';
+  export { routesNames } from './__routes';
+  export type { TypedRouteList } from './__routes';
   export * from './__useTypedRouter';
   export * from './__useTypedRoute';
   `;
@@ -205,7 +206,7 @@ function createTypedRouteParamsExport(routesParams) {
   return `export type TypedRouteParams = {
     ${routesParams.map(
     ({ name, params }) => `"${name}": ${params.length ? `{
-          ${params.map(({ key, required, type }) => `"${key}"${required ? "" : "?"}: ${type}`).join(",\n")}
+          ${params.map(({ key, required }) => `"${key}"${required ? "" : "?"}: string | number`).join(",\n")}
         }` : "never"}`
   ).join(",\n")}
   }`;
@@ -214,7 +215,7 @@ function createTypedRouteNamedMapperExport(routesParams) {
   return `export type TypedRouteNamedMapper = 
     ${routesParams.map(
     ({ name, params }) => `{name: "${name}" ${params.length ? `, params${params.some((s) => s.required) ? "" : "?"}: {
-          ${params.map(({ key, required, type }) => `"${key}"${required ? "" : "?"}: ${type}`).join(",\n")}
+          ${params.map(({ key, required }) => `"${key}"${required ? "" : "?"}: string | number`).join(",\n")}
         }` : ""}}`
   ).join("|\n")}
   `;
@@ -227,7 +228,9 @@ function createResolvedTypedRouteNamedMapperExport(routesParams) {
   } & (
     ${routesParams.map(
     ({ name, params }) => `{name: "${name}" ${params.length ? `, params: {
-          ${params.map(({ key, type }) => `"${key}": ${type}`).join(",\n")}
+                ${params.map(
+      ({ key, notRequiredOnPage }) => `"${key}"${notRequiredOnPage ? "?" : ""}: string`
+    ).join(",\n")}
         }` : ""}}`
   ).join("|\n")}
       )
@@ -457,15 +460,15 @@ function extractRouteParamsFromPath(path, isIndexFileForRouting, previousParams)
     if (matches) {
       const [_, mtch, key, optional] = matches;
       if (mtch) {
-        params.push({ name: key, required: !optional });
+        params.push({ name: key, optional: !!optional });
       }
     }
   } while (matches);
   let allMergedParams = params.map(
-    ({ name, required }) => ({
+    ({ name, optional }) => ({
       key: name,
-      type: "string | number",
-      required
+      required: !optional,
+      notRequiredOnPage: optional
     })
   );
   if (previousParams?.length) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-typed-router",
-  "version": "2.0.0-beta.1",
+  "version": "2.0.1",
   "description": "Provide autocompletion for pages route names generated by Nuxt router",
   "type": "module",
   "main": "./dist/module.cjs",
@@ -20,11 +20,11 @@
     "dev": "nuxi dev playground",
     "dev:build": "nuxi build playground",
     "dev:prepare": "nuxt-module-build --stub && nuxi prepare playground",
-    "build:test": "cross-env NUXT_BUILD_TYPE=stub pnpm run prepack && pnpm run dev:build",
-    "test": "pnpm run dev:prepare && pnpm run build:test && vitest run",
-    "test:watch": "pnpm run build:test && vitest",
-    "docs:dev": "cd docs && pnpm run dev",
-    "docs:buid": "(cd docs && nuxi build)"
+    "build:test": "cross-env NUXT_BUILD_TYPE=stub yarn prepack && yarn dev:build",
+    "test": "yarn dev:prepare && yarn build:test && vitest run",
+    "test:watch": "yarn build:test && vitest",
+    "docs:dev": "cd docs && yarn dev",
+    "docs:build": "npm run dev:prepare && cd docs && nuxi generate"
   },
   "publishConfig": {
     "access": "public"
@@ -39,6 +39,7 @@
     "nuxt 3",
     "nuxt 3 router"
   ],
+  "homepage": "https://nuxt-typed-router.vercel.app/",
   "repository": {
     "type": "git",
     "url": "git+https://victorgarciaesgi@github.com/victorgarciaesgi/nuxt-typed-router.git"