svelte-common 4.22.15 → 4.22.17

package/README.md

@@ -1,7 +1,7 @@
 [![Svelte v3](https://img.shields.io/badge/svelte-v3-orange.svg)](https://svelte.dev)
 [![npm](https://img.shields.io/npm/v/svelte-common.svg)](https://www.npmjs.com/package/svelte-common)
 [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
-[![Open Bundle](https://bundlejs.com/badge-light.svg)](https://bundlejs.com/?q=svelte-common)
+[![bundlejs](https://deno.bundlejs.com/?q=svelte-common\&badge=detailed)](https://bundlejs.com/?q=svelte-common)
 [![downloads](http://img.shields.io/npm/dm/svelte-common.svg?style=flat-square)](https://npmjs.org/package/svelte-common)
 [![GitHub Issues](https://img.shields.io/github/issues/arlac77/svelte-common.svg?style=flat-square)](https://github.com/arlac77/svelte-common/issues)
 [![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Farlac77%2Fsvelte-common%2Fbadge\&style=flat)](https://actions-badge.atrox.dev/arlac77/svelte-common/goto)
@@ -26,6 +26,8 @@ or the [live example](https://arlac77.github.io/components/svelte-common/example
 
 ### Table of Contents
 
+*   [AttributeDefinition](#attributedefinition)
+    *   [Properties](#properties)
 *   [tokens](#tokens)
     *   [Parameters](#parameters)
 *   [setAttribute](#setattribute)
@@ -47,6 +49,23 @@ or the [live example](https://arlac77.github.io/components/svelte-common/example
 *   [keyPrefixStore](#keyprefixstore)
     *   [Parameters](#parameters-9)
 
+## AttributeDefinition
+
+Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
+
+### Properties
+
+*   `type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+*   `writable` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
+*   `private` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** should the value be shown
+*   `depends` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** name of an attribute we depend on
+*   `additionalAttributes` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** extra attributes that are present in case our attribute is set
+*   `description` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+*   `default` **any?** the default value
+*   `set` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** set the value
+*   `get` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** get the value can be used to calculate default values
+*   `env` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>)?** environment variable use to provide the value
+
 ## tokens
 
 Split property path into tokens
@@ -99,8 +118,8 @@ Generate filter function.
 
 ### Parameters
 
-*   `filterBy` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
-*   `getters` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
+*   `filterBy` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**&#x20;
+*   `getters` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**&#x20;
 
 Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)**&#x20;
 
@@ -133,10 +152,8 @@ Synchronizes store value with the nodes "aria-sort" attribute.
 
 ### Parameters
 
-*   `th` &#x20;
-*   `store` &#x20;
-*   `the` **[Node](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)** header node
-*   `to` **WritableStore** keep in sync with sorting properties
+*   `th` **[Node](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)** the header node
+*   `store` **WritableStore** keep in sync with sorting properties
 
 ## sorter
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "svelte-common",
-  "version": "4.22.15",
+  "version": "4.22.17",
   "publishConfig": {
     "access": "public"
   },
@@ -34,24 +34,24 @@
   },
   "dependencies": {
     "svelte-command": "^1.1.39",
-    "svelte-entitlement": "^1.2.50"
+    "svelte-entitlement": "^1.2.51"
   },
   "devDependencies": {
     "@semantic-release/commit-analyzer": "^9.0.2",
     "@semantic-release/exec": "^6.0.3",
-    "@semantic-release/release-notes-generator": "^10.0.3",
-    "@sveltejs/vite-plugin-svelte": "^2.1.0",
+    "@semantic-release/release-notes-generator": "^11.0.1",
+    "@sveltejs/vite-plugin-svelte": "^2.3.0",
     "ava": "^5.2.0",
     "c8": "^7.13.0",
-    "documentation": "^14.0.1",
+    "documentation": "^14.0.2",
     "mf-styling": "^1.7.54",
-    "npm-pkgbuild": "^11.7.16",
-    "semantic-release": "^21.0.1",
-    "stylelint": "^15.6.0",
+    "npm-pkgbuild": "^11.8.6",
+    "semantic-release": "^21.0.2",
+    "stylelint": "^15.6.2",
     "stylelint-config-standard": "^33.0.0",
-    "svelte": "^3.58.0",
-    "testcafe": "^2.5.0",
-    "vite": "^4.3.1"
+    "svelte": "^3.59.1",
+    "testcafe": "^2.6.0",
+    "vite": "^4.3.8"
   },
   "optionalDependencies": {
     "mf-hosting-cloudflare": "^1.0.5",

package/src/attribute.mjs

@@ -10,7 +10,7 @@
  * @property {any} [default] the default value
  * @property {Function} [set] set the value
  * @property {Function} [get] get the value can be used to calculate default values
- * @property {string|string[]} [env] environment variable use to provide the value
+ * @property {string[]|string} [env] environment variable use to provide the value
  */
 
 /**

package/src/filter.mjs

@@ -23,8 +23,8 @@ function numberOp(a, b, op) {
 
 /**
  * Generate filter function.
- * @param {Object} filterBy
- * @param {Object} getters
+ * @param {Object} [filterBy]
+ * @param {Object} [getters]
  * @returns {Function}
  */
 export function filter(filterBy, getters) {

package/src/sorting.mjs

@@ -26,8 +26,8 @@ export function toggleOrderBy(orderBy) {
 /**
  * Add sortable toggle button to a th node.
  * Synchronizes store value with the nodes "aria-sort" attribute.
- * @param {Node} the header node
- * @param {WritableStore} to keep in sync with sorting properties
+ * @param {Element} th the header node
+ * @param {WritableStore} store keep in sync with sorting properties
  */
 export function sortable(th, store) {
   const storeSubscription = store.subscribe(orderBy =>
@@ -76,14 +76,14 @@ export function sortable(th, store) {
 
 /**
  * Generate a sort function for a given sort-by set.
- * @param {Object} sortBy
- * @param {Object} getters
- * @return {Function} sorter
+ * @param {Object|undefined} [sortBy]
+ * @param {Object} [getters]
+ * @return {Function|undefined} sorter
  */
-export function sorter(sortBy, getters = {}) {
+export function sorter(sortBy, getters) {
   if (sortBy) {
     for (const [key, value] of Object.entries(sortBy)) {
-      const getter = getters[key] || getAttribute;
+      const getter = getters && getters[key] || getAttribute;
 
       let rev = 1;