svelte-guard-history-router - npm Package Compare versions

Comparing version 5.1.5 to 5.1.6

package.json

 {
   "name": "svelte-guard-history-router",
-  "version": "5.1.5",
+  "version": "5.1.6",
   "publishConfig": {
@@ -26,6 +26,6 @@ "access": "public"
     "prepare": "vite build",
-    "start": "vite dev",
+    "start": "vite preview",
     "test": "npm run test:ava && npm run test:cafe",
     "test:ava": "ava --timeout 2m tests/*.mjs",
-    "test:cafe": "testcafe $BROWSER:headless tests/cafe/*.js -s build/test --page-request-timeout 9000 --app-init-delay 3000 --app \"vite\"",
+    "test:cafe": "testcafe $BROWSER:headless tests/cafe/*.js -s build/test --page-request-timeout 9000 --app-init-delay 30000 --app \"vite preview\"",
     "cover": "c8 -x 'tests/**/*' --temp-directory build/tmp ava --timeout 2m tests/*.mjs && c8 report -r lcov -o build/coverage --temp-directory build/tmp",
@@ -38,3 +38,3 @@ "docs": "documentation readme --section=API ./src/**/*.mjs",
   "dependencies": {
-    "multi-path-matcher": "^2.1.13"
+    "multi-path-matcher": "^2.1.14"
   },
@@ -45,3 +45,3 @@ "devDependencies": {
     "@semantic-release/release-notes-generator": "^10.0.3",
-    "@sveltejs/vite-plugin-svelte": "^1.0.0-next.49",
+    "@sveltejs/vite-plugin-svelte": "^1.0.1",
     "ava": "^4.3.0",
@@ -51,8 +51,8 @@ "c8": "^7.11.3",
     "jsdom": "^20.0.0",
-    "mf-styling": "^1.2.25",
-    "npm-pkgbuild": "^10.9.2",
+    "mf-styling": "^1.2.29",
+    "npm-pkgbuild": "^10.11.1",
     "semantic-release": "^19.0.3",
     "svelte": "^3.48.0",
     "testcafe": "^1.19.0",
-    "vite": "^2.9.13"
+    "vite": "^3.0.0"
   },
@@ -59,0 +59,0 @@ "optionalDependencies": {

README.md

@@ -106,6 +106,8 @@ [![Svelte v3](https://img.shields.io/badge/svelte-v3-orange.svg)](https://svelte.dev)
 
+*   [active](#active)
+    *   [Parameters](#parameters)
 *   [Key](#key)
     *   [Properties](#properties)
 *   [BaseRouter](#baserouter)
-    *   [Parameters](#parameters)
+    *   [Parameters](#parameters-1)
     *   [Properties](#properties-1)
@@ -116,32 +118,32 @@ *   [component](#component)
     *   [path](#path-1)
-        *   [Parameters](#parameters-1)
+        *   [Parameters](#parameters-2)
     *   [replace](#replace)
-        *   [Parameters](#parameters-2)
+        *   [Parameters](#parameters-3)
     *   [push](#push)
-        *   [Parameters](#parameters-3)
+        *   [Parameters](#parameters-4)
     *   [finalizePush](#finalizepush)
-        *   [Parameters](#parameters-4)
+        *   [Parameters](#parameters-5)
     *   [continue](#continue)
-        *   [Parameters](#parameters-5)
+        *   [Parameters](#parameters-6)
     *   [abort](#abort)
-        *   [Parameters](#parameters-6)
+        *   [Parameters](#parameters-7)
     *   [subscribe](#subscribe)
-        *   [Parameters](#parameters-7)
+        *   [Parameters](#parameters-8)
     *   [updateActive](#updateactive)
-        *   [Parameters](#parameters-8)
+        *   [Parameters](#parameters-9)
     *   [addRoute](#addroute)
-        *   [Parameters](#parameters-9)
+        *   [Parameters](#parameters-10)
     *   [routeFor](#routefor)
-        *   [Parameters](#parameters-10)
+        *   [Parameters](#parameters-11)
     *   [pathFor](#pathfor)
-        *   [Parameters](#parameters-11)
+        *   [Parameters](#parameters-12)
 *   [BaseTransition](#basetransition)
     *   [searchParams](#searchparams)
     *   [searchParams](#searchparams-1)
-        *   [Parameters](#parameters-12)
+        *   [Parameters](#parameters-13)
     *   [nest](#nest)
-        *   [Parameters](#parameters-13)
+        *   [Parameters](#parameters-14)
     *   [continue](#continue-1)
     *   [abort](#abort-1)
-        *   [Parameters](#parameters-14)
+        *   [Parameters](#parameters-15)
 *   [DetailRoute](#detailroute)
@@ -153,13 +155,13 @@ *   [Properties](#properties-2)
     *   [enter](#enter)
-        *   [Parameters](#parameters-15)
+        *   [Parameters](#parameters-16)
     *   [leave](#leave)
-        *   [Parameters](#parameters-16)
+        *   [Parameters](#parameters-17)
 *   [redirectGuard](#redirectguard)
-    *   [Parameters](#parameters-17)
+    *   [Parameters](#parameters-18)
 *   [sequenceGuard](#sequenceguard)
-    *   [Parameters](#parameters-18)
+    *   [Parameters](#parameters-19)
 *   [parallelGuard](#parallelguard)
-    *   [Parameters](#parameters-19)
+    *   [Parameters](#parameters-20)
 *   [MasterRoute](#masterroute)
-    *   [Parameters](#parameters-20)
+    *   [Parameters](#parameters-21)
     *   [Properties](#properties-3)
@@ -173,18 +175,22 @@ *   [nullGuard](#nullguard)
 *   [SkeletonRoute](#skeletonroute)
-    *   [Parameters](#parameters-21)
+    *   [Parameters](#parameters-22)
     *   [Properties](#properties-4)
     *   [enter](#enter-1)
-        *   [Parameters](#parameters-22)
+        *   [Parameters](#parameters-23)
     *   [leave](#leave-1)
-        *   [Parameters](#parameters-23)
-    *   [matches](#matches)
         *   [Parameters](#parameters-24)
+    *   [isAcceptable](#isacceptable)
+        *   [Parameters](#parameters-25)
     *   [propertiesFor](#propertiesfor)
-        *   [Parameters](#parameters-25)
+        *   [Parameters](#parameters-26)
     *   [commonAncestor](#commonancestor)
-        *   [Parameters](#parameters-26)
-    *   [valueFor](#valueFor)
         *   [Parameters](#parameters-27)
+    *   [valueFor](#valuefor)
+        *   [Parameters](#parameters-28)
+    *   [value](#value-1)
+    *   [propertyMapping](#propertymapping-1)
+    *   [objectInstance](#objectinstance)
+*   [ValueStoreRoute](#valuestoreroute)
 *   [Transition](#transition)
-    *   [Parameters](#parameters-28)
+    *   [Parameters](#parameters-29)
     *   [Properties](#properties-5)
@@ -194,11 +200,24 @@ *   [start](#start)
     *   [redirect](#redirect)
-        *   [Parameters](#parameters-29)
+        *   [Parameters](#parameters-30)
     *   [abort](#abort-2)
-        *   [Parameters](#parameters-30)
+        *   [Parameters](#parameters-31)
+*   [findClosestAttribute](#findclosestattribute)
+    *   [Parameters](#parameters-32)
 *   [nameValueStore](#namevaluestore)
-    *   [Parameters](#parameters-31)
+    *   [Parameters](#parameters-33)
     *   [Properties](#properties-6)
 *   [WaitingGuard](#waitingguard)
-    *   [Parameters](#parameters-32)
+    *   [Parameters](#parameters-34)
 
+## active
+
+*   **See**: {Router.updateActive}
+
+Keeps the the node active state in sync.
+
+### Parameters
+
+*   `node` **any** 
+*   `router` **Router** 
+
 ## Key
@@ -239,3 +258,3 @@
 
-*   `routes` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<Route>** 
+*   `routes` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<Route>** all managed routes
 *   `base` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** url
@@ -359,17 +378,17 @@
 
-Find Route for a given object.
+Find Route for a given value.
 
 #### Parameters
 
-*   `object` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
+*   `value` **any** 
 
-Returns **Route** able to support given object
+Returns **Route** able to support given value
 
 ### pathFor
 
-Find path for a given object.
+Find path for a given value.
 
 #### Parameters
 
-*   `object` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
+*   `value` **any** 
 *   `suffix` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** to be appended
@@ -424,3 +443,3 @@
 
-Route to represent a slice of the prarent list of values.
+Route to represent a slice of the masters list of values.
 
@@ -570,25 +589,25 @@ ### Properties
 *   `transition` **[Transition](#transition)** 
-*   `untilRoute` **Route** the common ancestor with the next route
+*   `untilRoute` **Route** the common ancestor with the future route
 
-### matches
+### isAcceptable
 
-Check properties against object.
+Check if value and properties are acceptable for the route.
 
 #### Parameters
 
-*   `object` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
-*   `properties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
+*   `value` **any** to be placed into route
+*   `properties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** as presented in the route
 
-Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if object properties are matching with the given proerties
+Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if value can be accepted
 
 ### propertiesFor
 
-Extract properties from object.
-All property values are strings.
+Extract properties from a value.
+All property values must be strings.
 
 #### Parameters
 
-*   `object` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** source of the values
+*   `value` **any** source of the values
 
-Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** properties extracted from given object
+Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** properties extracted from given value
 
@@ -607,3 +626,3 @@ ### commonAncestor
 
-Deliver object for a given set of properties.
+Deliver value for a given set of properties of the transition.
 Default implemantation asks the parent route.
@@ -615,4 +634,28 @@
 
+Returns **any** for matching properties
+
+### value
+
+Deliver route value.
+Default implemantation asks the parent route.
+
+Returns **any** 
+
+### propertyMapping
+
+Deliver property mapping.
+Default implemantation asks the parent route.
+
 Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** for matching properties
 
+### objectInstance
+
+Default implemantation asks the parent route.
+
+## ValueStoreRoute
+
+**Extends SkeletonRoute**
+
+Route holding a single value
+
 ## Transition
@@ -670,2 +713,13 @@
 
+## findClosestAttribute
+
+Walks up the dom tree parents unti a node with a given attribute is found or the root node is reached.
+
+### Parameters
+
+*   `element` **[Element](https://developer.mozilla.org/docs/Web/API/Element)** 
+*   `attributeName` **stringg** 
+
+Returns **[Element](https://developer.mozilla.org/docs/Web/API/Element)** 
+
 ## nameValueStore
@@ -672,0 +726,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

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

Improved metrics

Total package byte prevSize

53183

increased by1.73%

Number of lines in readme file

778

increased by7.46%

Dependency changes

• Updatedmulti-path-matcher@^2.1.14