@vaadin/router - npm Package Compare versions

Comparing version 1.7.5 to 2.0.0-rc1

package.json

 {
   "name": "@vaadin/router",
-  "version": "1.7.5",
+  "version": "2.0.0-rc1",
   "description": "Small and powerful client-side router for Web Components. Framework-agnostic.",
-  "main": "dist/vaadin-router.js",
-  "module": "dist/vaadin-router.js",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "type": "module",
   "repository": "vaadin/vaadin-router",
@@ -22,9 +23,6 @@ "keywords": [
   "files": [
-    "index.js",
-    "index.polyfilled.js",
-    "interfaces.d.ts",
-    "src",
-    "dist/vaadin-router.*"
+    "dist"
   ],
   "scripts": {
+    "clean:build": "git clean -fx . -e .vite -e node_modules -e .idea -e .vscode",
     "install:dependencies": "bower install",
@@ -34,72 +32,77 @@ "lint": "npm-run-all --parallel lint:*",
     "lint:css": "stylelint demo/**/*.html",
-    "build": "rollup -c && npm-run-all --parallel build:minify.* build:typescript-declarations",
-    "build:minify.module": "uglifyjs dist/vaadin-router.umd.js -c -m --source-map content=dist/vaadin-router.umd.js.map,url=vaadin-router.umd.min.js.map --output dist/vaadin-router.umd.min.js",
-    "build:minify.browser": "uglifyjs dist/vaadin-router.js -c -m --mangle-props regex=/^__/ --toplevel --source-map --output dist/vaadin-router.min.js",
-    "build:typescript-declarations": "gen-typescript-declarations --outDir .",
-    "build:watch": "rollup -c -w",
-    "start": "npm run build && polyserve --port 8000",
-    "start:browser-sync": "browser-sync start --config bs-config.cjs",
-    "start:watch": "npm-run-all --parallel build:watch start start:browser-sync",
-    "test": "wct && npm run test:coverage && npm run test:typescript-declarations",
-    "test:coverage": "wct --profile=coverage",
-    "test:typescript-declarations": "tsc --noEmit",
-    "size-control": "bundlesize",
-    "docs": "npm run build && npm run docs:analyze && gulp -f gulpfile.cjs docs",
-    "docs:analyze": "polymer analyze dist/vaadin-router.js src/documentation/*.js > analysis.json",
+    "build": "npm-run-all --parallel build:*",
+    "build:esbuild": "tsx scripts/build.ts",
+    "build:tsc": "tsc --emitDeclarationOnly --isolatedModules -p tsconfig.build.json",
+    "start": "vite",
+    "test": "karma start karma.config.cjs",
+    "test:watch": "npm run test -- --watch",
+    "test:coverage": "npm run test -- --coverage",
+    "docs": "npm run build && echo \"not implemented\" >&2 && exit 1",
     "browserslist": "browserslist && browserslist --coverage",
+    "prepack": "npm run clean:build",
     "prepare": "npm run build",
-    "version": "gulp -f gulpfile.cjs version:update"
+    "typecheck": "tsc --noEmit"
   },
-  "bundlesize": [
-    {
-      "path": "dist/vaadin-router.min.js",
-      "maxSize": "8 kB"
-    }
-  ],
   "browserslist": [
-    "last 2 Chrome major versions",
-    "last 2 Android major versions",
-    "last 2 Firefox major versions",
-    "last 2 Edge major versions",
-    "last 2 Safari major versions",
-    "last 2 iOS major versions",
-    "Safari 9",
-    "iOS 9",
-    "IE 11"
+    "last 1 Chrome major versions",
+    "last 1 Firefox major versions",
+    "Firefox ESR",
+    "last 1 Edge major versions",
+    "Safari >= 13",
+    "iOS >= 13",
+    "last 1 ChromeAndroid major versions"
   ],
   "dependencies": {
-    "@vaadin/vaadin-usage-statistics": "^2.1.0",
-    "path-to-regexp": "2.4.0"
+    "@vaadin/vaadin-usage-statistics": "^2.1.2",
+    "path-to-regexp": "^6.3.0",
+    "type-fest": "^4.26.1"
   },
   "devDependencies": {
-    "@babel/core": "^7.20.12",
-    "@babel/preset-env": "^7.13.10",
-    "@polymer/gen-typescript-declarations": "^1.6.2",
-    "@rollup/plugin-babel": "^6.0.3",
-    "@rollup/plugin-commonjs": "^15.1.0",
-    "@rollup/plugin-node-resolve": "^15.0.1",
-    "@types/form-data": "^2.5.0",
-    "bower": "^1.8.12",
-    "browser-sync": "^2.26.14",
-    "browserslist": "^4.21.5",
-    "bundlesize": "^0.18.1",
-    "eslint": "^7.22.0",
-    "eslint-config-vaadin": "0.2.7",
-    "eslint-plugin-html": "^6.1.0",
-    "fs-extra": "^9.1.0",
-    "gulp": "^4.0.2",
-    "gulp-cli": "^2.3.0",
-    "gulp-git": "^2.10.1",
-    "gulp-replace": "^1.0.0",
+    "@esm-bundle/chai": "^4.3.4-fix.0",
+    "@testing-library/dom": "^10.4.0",
+    "@testing-library/user-event": "^14.5.2",
+    "@types/chai-as-promised": "^8.0.1",
+    "@types/chai-dom": "^1.11.0",
+    "@types/glob": "^8.1.0",
+    "@types/karma": "^6.3.8",
+    "@types/karma-chrome-launcher": "^3.1.1",
+    "@types/karma-mocha": "^1.3.1",
+    "@types/mocha": "^10.0.1",
+    "@types/sinon": "^17.0.3",
+    "@types/sinon-chai": "^4.0.0",
+    "bower": "^1.8.14",
+    "browserslist": "^4.24.0",
+    "chai-as-promised": "^8.0.0",
+    "chai-dom": "^1.11.0",
+    "esbuild": "^0.24.0",
+    "eslint": "^8.57.1",
+    "eslint-config-vaadin": "^1.0.0-alpha.28",
+    "eslint-plugin-html": "^8.1.2",
+    "eslint-plugin-oxlint": "^0.9.9",
+    "eslint-plugin-perfectionist": "^3.8.0",
+    "eslint-plugin-tsdoc": "^0.3.0",
+    "fs-extra": "^11.1.1",
+    "glob": "^11.0.0",
+    "karma": "^6.4.4",
+    "karma-chrome-launcher": "^3.2.0",
+    "karma-coverage": "^2.2.1",
+    "karma-iframes": "^1.3.1",
+    "karma-mocha": "^2.0.1",
+    "karma-parallel": "^0.3.1",
+    "karma-spec-reporter": "^0.0.36",
+    "karma-vite": "^1.0.5",
+    "magic-string": "^0.30.11",
+    "mocha": "^10.2.0",
     "npm-run-all": "^4.1.5",
-    "polymer-cli": "^1.9.11",
-    "polyserve": "^0.27.15",
-    "rollup": "^2.79.1",
-    "stylelint": "^13.12.0",
-    "typescript": "^4.9.4",
-    "uglify-es": "^3.3.9",
-    "wct-istanbul": "^0.14.3",
-    "web-component-tester": "^6.9.2",
-    "yargs": "^16.0.3"
+    "oxlint": "^0.9.9",
+    "prettier": "^3.1.0",
+    "sinon": "^19.0.2",
+    "sinon-chai": "^4.0.0",
+    "stylelint": "^16.9.0",
+    "tsx": "^4.19.1",
+    "typescript": "^5.6.2",
+    "typescript-eslint": "^8.8.1",
+    "vite": "5.4.8",
+    "yargs": "^17.7.2"
   }
 }

README.md

 [![NPM version](https://img.shields.io/npm/v/@vaadin/router.svg)](https://www.npmjs.com/package/@vaadin/router)
 [![npm bundle size (minified + gzip)](https://img.shields.io/bundlephobia/minzip/@vaadin/router.svg)](https://bundlephobia.com/result?p=@vaadin/router)
-[![Build Status](https://travis-ci.org/vaadin/vaadin-router.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-router)
-[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/vaadin/web-components?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 
 # Vaadin Router
 
-[Live Demo ↗](https://vaadin.github.io/vaadin-router/vaadin-router/demo)
-|
-[API documentation ↗](https://vaadin.github.io/vaadin-router/vaadin-router/)
+[Demo](https://vaadin.github.io/router/vaadin-router/demo)
+·
+[API documentation](https://vaadin.github.io/router/vaadin-router/)
 
-<p align="center">
-  <img width="120" alt="router hero banner" src="https://user-images.githubusercontent.com/22416150/42952145-74cead64-8b80-11e8-9dfd-09b01f904972.png">
-  <h2 align="center">A client-side router for Web Components</h2>
-</p>
-
 Vaadin Router is a small and powerful client-side router JS library. It uses the widely adopted express.js syntax for routes (`/users/:id`) to map URLs to Web Component views. All features one might expect from a modern router are supported: async route resolution, animated transitions, navigation guards, redirects, and more. It is framework-agnostic and works equally well with all Web Components regardless of how they are created (Polymer / SkateJS / Stencil / Angular / Vue / etc).
@@ -36,2 +29,21 @@
 ## Browser support
+
+A specific version of Vaadin Router supports the same browsers as the Vaadin platform major version which includes that version of Vaadin Router.
+See [Vaadin platform release notes](https://github.com/vaadin/platform/releases) for details on included Vaadin Router version and supported technologies.
+The Supported Technologies section is typically listed in the release notes of the first publicly available release of a Vaadin platform major version
+(for example [Vaadin 18.0.1](https://github.com/vaadin/platform/releases/tag/18.0.1) since 18.0.0 was skipped).
+
+### Desktop browsers
+
+Evergreen versions of the following browsers
+- Chrome, Firefox, Firefox ESR, Safari and Edge (Chromium)
+
+### Mobile browsers
+
+Built-in browsers in the following mobile operating systems:
+- Safari starting from iOS 13 (Safari 13 or newer)
+- Google Chrome evergreen on Android (requiring Android 4.4 or newer)
+
+### Sauce Labs test status
+
 [![Sauce Test Status](https://saucelabs.com/browser-matrix/vaadin-router.svg)](https://saucelabs.com/u/vaadin-router)
@@ -58,3 +70,3 @@
   - Public API tests: [http://127.0.0.1:8000/components/vaadin-router/test](http://127.0.0.1:8000/components/vaadin-router/test)
-  - Unit tests: [http://127.0.0.1:8000/components/vaadin-router/test/index.coverage.html](http://127.0.0.1:8000/components/vaadin-router/test/index.coverage.html)
+  - Unit tests: [http://127.0.0.1:8000/components/vaadin-router/test/index.html](http://127.0.0.1:8000/components/vaadin-router/test/index.html)
 
@@ -61,0 +73,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

Improved metrics

Number of package files

63

increased by90.91%

Number of low license alerts

0

decreased by-100%

Number of lines in readme file

95

increased by14.46%

Is type module

Yes

Worsened metrics

Total package byte prevSize

228860

decreased by-74.67%

Dependency count

3

increased by50%

Dev dependency count

46

increased by58.62%

Lines of code

2147

decreased by-74.49%

Number of low quality alerts

1

increased byInfinity%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedtype-fest@^4.26.1

• + Addedpath-to-regexp@6.3.0(transitive)

• + Addedtype-fest@4.26.1(transitive)

• - Removedpath-to-regexp@2.4.0(transitive)

• Updated@vaadin/vaadin-usage-statistics@^2.1.2

• Updatedpath-to-regexp@^6.3.0