@hkdigital/lib-core 0.5.85 → 0.5.87

package/dist/services/service-base/ServiceBase.js

@@ -152,7 +152,8 @@ export class ServiceBase extends EventEmitter {
     try {
       this._setTargetState(wasRunning ? STATE_RUNNING : STATE_CONFIGURED);
       this._setState(STATE_CONFIGURING);
-      this.logger.debug('Configuring service', { config });
+
+      this.logger.debug('Configuring service', { keys: Object.keys(config ?? {})});
 
       await this._configure(config, this.#lastConfig);
       this.#lastConfig = config;
@@ -160,9 +161,10 @@ export class ServiceBase extends EventEmitter {
       this._setState(wasRunning ? STATE_RUNNING : STATE_CONFIGURED);
       this.logger.info('Service configured');
       return { ok: true };
-    } catch (error) {
-      this._setError('configuration', /** @type {Error} */ (error));
-      return { ok: false, error: this.error };
+    } catch (thing) {
+      const error = /** @type {Error} */ (thing);
+      this._setError('configuration', error);
+      return { ok: false, error };
     }
   }
 

package/dist/ui/README.md

@@ -40,10 +40,10 @@ Compound or complex components that are:
 
 ```javascript
 // Import primitives for building blocks
-import { Button, TextInput, HkIcon } from '$lib/ui/primitives.js';
+import { Button, TextInput, SteezeIcon } from '$lib/ui/primitives.js';
 
 // Import components for complete solutions
-import { Presenter, ImageBox, HkAppLayout } from '$lib/ui/components.js';
+import { Presenter, ImageBox } from '$lib/ui/components.js';
 ```
 
-The distinction helps library users understand the intended use and complexity of each component.
+The distinction helps library users understand the intended use and complexity of each component.

package/dist/ui/primitives/icons/HkIcon.svelte

@@ -1,5 +1,10 @@
 <script>
   /**
+   * ===================================
+   * @depreceated Use SteezeIcon instead
+   * ===================================
+   *
+   *
    * Icon component
    *
    * Source code adapted from
@@ -38,11 +43,17 @@
     ...attrs
   } = $props();
 
-  /** @type {any} */
-  let icon = $state();
+  /** @type {import('./typedef.js').IconThemeSource|null} */
+  let icon = $state(null);
 
   $effect(() => {
-    icon = src?.[theme] ?? src?.['default'] ?? Object.values(src)?.[0];
+    if( src )
+    {
+      icon = src[theme] ?? src?.['default'] ?? Object.values(src)?.[0];
+    }
+    else {
+      throw new Error('Missing property [src]');
+    }
   });
 
   let normalizedSize = $derived.by(() => {
@@ -57,31 +68,33 @@
   });
 </script>
 
-<svg
-  data-hk-icon
-  {...icon?.a}
-  xmlns="http://www.w3.org/2000/svg"
-  width={normalizedSize}
-  height={normalizedSize}
-  class="{base} {classes}"
-  {...attrs}
->
-  {#each icon?.path ?? [] as a}
-    <path {...a} />
-  {/each}
-  {#each icon?.rect ?? [] as a}
-    <rect {...a} />
-  {/each}
-  {#each icon?.circle ?? [] as a}
-    <circle {...a} />
-  {/each}
-  {#each icon?.polygon ?? [] as a}
-    <polygon {...a} />
-  {/each}
-  {#each icon?.polyline ?? [] as a}
-    <polyline {...a} />
-  {/each}
-  {#each icon?.line ?? [] as a}
-    <line {...a} />
-  {/each}
-</svg>
+{#if icon}
+  <svg
+    data-hk-icon
+    {...icon?.a}
+    xmlns="http://www.w3.org/2000/svg"
+    width={normalizedSize}
+    height={normalizedSize}
+    class="{base} {classes}"
+    {...attrs}
+  >
+    {#each icon?.path ?? [] as a}
+      <path {...a} />
+    {/each}
+    {#each icon?.rect ?? [] as a}
+      <rect {...a} />
+    {/each}
+    {#each icon?.circle ?? [] as a}
+      <circle {...a} />
+    {/each}
+    {#each icon?.polygon ?? [] as a}
+      <polygon {...a} />
+    {/each}
+    {#each icon?.polyline ?? [] as a}
+      <polyline {...a} />
+    {/each}
+    {#each icon?.line ?? [] as a}
+      <line {...a} />
+    {/each}
+  </svg>
+{/if}

package/dist/ui/primitives/icons/{HkTabIcon.svelte → HkTabIcon.svelte__}

@@ -1,5 +1,9 @@
 <script>
 	/**
+	 * =========================================
+   * @depreceated Use SteezeTabBarIcon instead
+   * =========================================
+	 *
 	 * TabBarIcon component
 	 *
 	 * Following component guidelines from Skeleton

package/dist/ui/primitives/icons/SteezeIcon.svelte

@@ -50,50 +50,48 @@
     ...attrs
   } = $props();
 
-  /** @type {any} */
-  let icon = $state();
+  /** @type {import('./typedef.js').IconThemeSource|null} */
+  let icon = $state(null);
 
   $effect(() => {
-    icon = src?.[theme] ?? src?.['default'] ?? Object.values(src)?.[0];
+    if( src )
+    {
+      icon = src[theme] ?? src?.['default'] ?? Object.values(src)?.[0];
+    }
+    else {
+      throw new Error('Missing property [src]');
+    }
   });
-
-  // if (size !== '100%') {
-  //   if (size.slice(-1) !== '%') {
-  //     try {
-  //       size = parseInt(size, 10) + 'px';
-  //     } catch (error) {
-  //       size = '100%';
-  //     }
-  //   }
-  // }
 </script>
 
-<svg
-  data-component="icon"
-  data-type="steeze"
-  data-size={size}
-  data-variant={variant}
-  {...icon?.a}
-  xmlns="http://www.w3.org/2000/svg"
-  class="{base} {classes}"
-  {...attrs}
->
-  {#each icon?.path ?? [] as a}
-    <path {...a} />
-  {/each}
-  {#each icon?.rect ?? [] as a}
-    <rect {...a} />
-  {/each}
-  {#each icon?.circle ?? [] as a}
-    <circle {...a} />
-  {/each}
-  {#each icon?.polygon ?? [] as a}
-    <polygon {...a} />
-  {/each}
-  {#each icon?.polyline ?? [] as a}
-    <polyline {...a} />
-  {/each}
-  {#each icon?.line ?? [] as a}
-    <line {...a} />
-  {/each}
-</svg>
+{#if icon}
+  <svg
+    data-component="icon"
+    data-type="steeze"
+    data-size={size}
+    data-variant={variant}
+    {...icon.a}
+    xmlns="http://www.w3.org/2000/svg"
+    class="{base} {classes}"
+    {...attrs}
+  >
+    {#each icon.path ?? [] as a}
+      <path {...a} />
+    {/each}
+    {#each icon.rect ?? [] as a}
+      <rect {...a} />
+    {/each}
+    {#each icon.circle ?? [] as a}
+      <circle {...a} />
+    {/each}
+    {#each icon.polygon ?? [] as a}
+      <polygon {...a} />
+    {/each}
+    {#each icon.polyline ?? [] as a}
+      <polyline {...a} />
+    {/each}
+    {#each icon.line ?? [] as a}
+      <line {...a} />
+    {/each}
+  </svg>
+{/if}

package/dist/ui/primitives/icons/index.d.ts

@@ -1,3 +1,2 @@
-export { default as HkIcon } from "./HkIcon.svelte";
-export { default as HkTabIcon } from "./HkTabIcon.svelte";
 export { default as SteezeIcon } from "./SteezeIcon.svelte";
+export { default as HkIcon } from "./HkIcon.svelte";

package/dist/ui/primitives/icons/index.js

@@ -1,4 +1,11 @@
+export { default as SteezeIcon } from './SteezeIcon.svelte';
+
+// @todo create tab icon
+//export { default as SteezeTabIcon } from './SteezeTabIcon.svelte';
+
+// @depreceated
 export { default as HkIcon } from './HkIcon.svelte';
-export { default as HkTabIcon } from './HkTabIcon.svelte';
 
-export { default as SteezeIcon } from './SteezeIcon.svelte';
+// @depreceated
+// export { default as HkTabIcon } from './HkTabIcon.svelte';
+

package/dist/ui/primitives/inputs/text-input/TextInput.svelte

@@ -4,6 +4,9 @@
 
   import { Star, ExclamationTriangle, CheckCircle } from '@steeze-ui/heroicons';
 
+  //
+  // @fixme use SteezeIcon instead
+  //
   import { HkIcon } from '../../../primitives.js';
 
   import {

package/dist/util/object/index.d.ts

@@ -37,35 +37,35 @@ export function exportNotNullish(obj: object, onlyKeys?: string[]): object;
  * - This method can e.g. be used to export a data object without it's
  *   'internal' properties
  *
- * @param {object} obj
+ * @param {Record<string,any>} obj
  *
  * @param {string[]} [keepKeys]
  *   If specified, the specified private keys will be exported (e.g. `_id`)
  *
  * @returns {object} new object without properties that start with an underscore
  */
-export function exportPublic(obj: object, keepKeys?: string[]): object;
+export function exportPublic(obj: Record<string, any>, keepKeys?: string[]): object;
 /**
  * Creates a copy of an object or array that contains only primitive values
  * - Nested objects and arrays are completely removed
  * - Only string, number, boolean, null, undefined values are kept
  *
- * @param {object|array} objectOrArray
+ * @param {Record<string,any>|Array<any>} objectOrArray
  *
- * @returns {object|array} new object or array with only primitive values
+ * @returns {Record<string,any>|Array<any>} new object or array with only primitive values
  */
-export function exportNotNested(objectOrArray: object | array): object | array;
+export function exportNotNested(objectOrArray: Record<string, any> | Array<any>): Record<string, any> | Array<any>;
 /**
  * Keep only the specified keys in the object
  * - deletes all other key-value pairs in the object
  *
- * @param {object} obj
- * @param {string[]|Set} keys
+ * @param {Record<string,any>} obj
+ * @param {string[]|Set<string>} keys
  * @param {boolean} [removeNullAndUndefined=true]
  *
  * @returns {object} object that only contains the specified keys
  */
-export function keep(obj: object, keys: string[] | Set<any>, removeNullAndUndefined?: boolean): object;
+export function keep(obj: Record<string, any>, keys: string[] | Set<string>, removeNullAndUndefined?: boolean): object;
 /**
  * Freezes an object recursively
  * - Allows non-objects to be passed as input parameter (non-objects are
@@ -73,49 +73,51 @@ export function keep(obj: object, keys: string[] | Set<any>, removeNullAndUndefi
  *
  * @param {any} value
  *
+ * @param {Set<any>} [_found]
+ *
  * @returns {any}
  *   recursively frozen object or original input value if a non-object was
  *   supplied as input parameter
  */
-export function deepFreeze(value: any, _found: any): any;
+export function deepFreeze(value: any, _found?: Set<any>): any;
 /**
  * Set a value in an object using a path and value pair.
  * - Automatically creates parent objects
  *
  * @param {object} obj - Object to set the value in
- * @param {string|Array} path - Dot separated string path or array path
+ * @param {string|Array<string>} path - Dot separated string path or array path
  * @param {any} value - value to set
  *
  * @returns {boolean} true if the value was changed
  */
-export function objectSet(obj: object, path: string | any[], value: any, ...args: any[]): boolean;
+export function objectSet(obj: object, path: string | Array<string>, value: any, ...args: any[]): boolean;
 /**
  * Removes a value at the specified object path from the object.
  * - All parent objects that remain empty will be removed too (recursively)
  *
- * @param {object} obj - Object to delete the path from
- * @param {string|Array} path - Dot separated string path or array path
+ * @param {Record<string,any>} obj - Object to delete the path from
+ * @param {string|Array<string>} path - Dot separated string path or array path
  */
-export function deletePath(obj: object, path: string | any[]): void;
+export function deletePath(obj: Record<string, any>, path: string | Array<string>): void;
 /**
  * Get a value from an object using a path
  * - Returns a default value if not found, with is [undefined] by default
  *
- * @param {object} obj - Object to get the value from
- * @param {string|Array} path - Dot separated string path or array path
+ * @param {Record<string,any>} obj - Object to get the value from
+ * @param {string|Array<string>} path - Dot separated string path or array path
  *
  * @param {any} [defaultValue=undefined]
  *   Value to return if the value does not exist
  *
  * @return {any} value found at path, defaultValue or undefined
  */
-export function objectGet(obj: object, path: string | any[], defaultValue?: any): any;
+export function objectGet(obj: Record<string, any>, path: string | Array<string>, defaultValue?: any): any;
 /**
  * Get a value from an object using a path
  * - Throws an exception if the path does not exist or the value is undefined
  *
- * @param {object} obj - Object to get the value from
- * @param {string|Array} path - Dot separated string path or array path
+ * @param {Record<string,any>} obj - Object to get the value from
+ * @param {string|Array<string>} path - Dot separated string path or array path
  *
  * @param {function} [parseFn]
  *   Optional parser function that checks and converts the value
@@ -125,7 +127,7 @@ export function objectGet(obj: object, path: string | any[], defaultValue?: any)
  *
  * @return {any} value found at path
  */
-export function objectGetWithThrow(obj: object, path: string | any[], parseFn?: Function): any;
+export function objectGetWithThrow(obj: Record<string, any>, path: string | Array<string>, parseFn?: Function): any;
 /**
  * Get an iterator that returns the value of a path for each item (object)
  * in the list of objects

package/dist/util/object/index.js

@@ -112,7 +112,7 @@ export function exportNotNullish(obj, onlyKeys) {
  * - This method can e.g. be used to export a data object without it's
  *   'internal' properties
  *
- * @param {object} obj
+ * @param {Record<string,any>} obj
  *
  * @param {string[]} [keepKeys]
  *   If specified, the specified private keys will be exported (e.g. `_id`)
@@ -122,6 +122,7 @@ export function exportNotNullish(obj, onlyKeys) {
 export function exportPublic(obj, keepKeys) {
 	expect.object(obj);
 
+	/** @type {Record<string,any>} */
 	const newObj = {};
 
 	const keepKeysSet = keepKeys ? new Set(keepKeys) : null;
@@ -153,9 +154,9 @@ export function exportPublic(obj, keepKeys) {
  * - Nested objects and arrays are completely removed
  * - Only string, number, boolean, null, undefined values are kept
  *
- * @param {object|array} objectOrArray
+ * @param {Record<string,any>|Array<any>} objectOrArray
  *
- * @returns {object|array} new object or array with only primitive values
+ * @returns {Record<string,any>|Array<any>} new object or array with only primitive values
  */
 export function exportNotNested(objectOrArray) {
 	expect.object(objectOrArray);
@@ -209,6 +210,7 @@ export function exportNotNested(objectOrArray) {
 			return objectOrArray;
 		}
 
+		/** @type {Record<string,any>} */
 		const outputObj = {};
 
 		for (const key in objectOrArray) {
@@ -233,8 +235,8 @@ export function exportNotNested(objectOrArray) {
  * Keep only the specified keys in the object
  * - deletes all other key-value pairs in the object
  *
- * @param {object} obj
- * @param {string[]|Set} keys
+ * @param {Record<string,any>} obj
+ * @param {string[]|Set<string>} keys
  * @param {boolean} [removeNullAndUndefined=true]
  *
  * @returns {object} object that only contains the specified keys
@@ -272,6 +274,8 @@ export function keep(obj, keys, removeNullAndUndefined = true) {
  *
  * @param {any} value
  *
+ * @param {Set<any>} [_found]
+ *
  * @returns {any}
  *   recursively frozen object or original input value if a non-object was
  *   supplied as input parameter
@@ -311,7 +315,7 @@ export function deepFreeze(value, _found) {
  * - Automatically creates parent objects
  *
  * @param {object} obj - Object to set the value in
- * @param {string|Array} path - Dot separated string path or array path
+ * @param {string|Array<string>} path - Dot separated string path or array path
  * @param {any} value - value to set
  *
  * @returns {boolean} true if the value was changed
@@ -382,8 +386,8 @@ export function objectSet(obj, path, value) {
  * Removes a value at the specified object path from the object.
  * - All parent objects that remain empty will be removed too (recursively)
  *
- * @param {object} obj - Object to delete the path from
- * @param {string|Array} path - Dot separated string path or array path
+ * @param {Record<string,any>} obj - Object to delete the path from
+ * @param {string|Array<string>} path - Dot separated string path or array path
  */
 export function deletePath(obj, path) {
 	expect.object(obj);
@@ -500,8 +504,8 @@ export function deletePath(obj, path) {
  * Get a value from an object using a path
  * - Returns a default value if not found, with is [undefined] by default
  *
- * @param {object} obj - Object to get the value from
- * @param {string|Array} path - Dot separated string path or array path
+ * @param {Record<string,any>} obj - Object to get the value from
+ * @param {string|Array<string>} path - Dot separated string path or array path
  *
  * @param {any} [defaultValue=undefined]
  *   Value to return if the value does not exist
@@ -541,8 +545,8 @@ export function objectGet(obj, path, defaultValue) {
  * Get a value from an object using a path
  * - Throws an exception if the path does not exist or the value is undefined
  *
- * @param {object} obj - Object to get the value from
- * @param {string|Array} path - Dot separated string path or array path
+ * @param {Record<string,any>} obj - Object to get the value from
+ * @param {string|Array<string>} path - Dot separated string path or array path
  *
  * @param {function} [parseFn]
  *   Optional parser function that checks and converts the value

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@hkdigital/lib-core",
-	"version": "0.5.85",
+	"version": "0.5.87",
 	"author": {
 		"name": "HKdigital",
 		"url": "https://hkdigital.nl"

package/dist/ui/primitives/icons/HkTabIcon.svelte.d.ts

@@ -1,40 +0,0 @@
-export default HkTabIcon;
-type HkTabIcon = {
-    $on?(type: string, callback: (e: any) => void): () => void;
-    $set?(props: Partial<{
-        src: IconSource;
-        iconTheme?: string | undefined;
-        label?: string | undefined;
-        route?: string | undefined;
-        active?: boolean | undefined;
-        base?: string | undefined;
-        bg?: string | undefined;
-        padding?: string | undefined;
-        margin?: string | undefined;
-        classes?: string | undefined;
-        iconClasses?: string | undefined;
-        iconHeight?: string | undefined;
-        labelClasses?: string | undefined;
-        rect?: DOMRect | undefined;
-    } & {
-        [attr: string]: any;
-    }>): void;
-};
-declare const HkTabIcon: import("svelte").Component<{
-    src: import("./typedef.js").IconSource;
-    iconTheme?: string;
-    label?: string;
-    route?: string;
-    active?: boolean;
-    base?: string;
-    bg?: string;
-    padding?: string;
-    margin?: string;
-    classes?: string;
-    iconClasses?: string;
-    iconHeight?: string;
-    labelClasses?: string;
-    rect?: DOMRect;
-} & {
-    [attr: string]: any;
-}, {}, "">;

package/scripts/import-fixes.txt

@@ -1,60 +0,0 @@
-src/lib/ui/components/rows/panel-row-2/PanelRow2.svelte:2 - Parent index.js import (use $lib/ or import specific file)
-  import { PanelGridRow } from '../index.js';
-  import { PanelGridRow } from '../index.js'; // TODO: Import specific file or refactor
-
-src/lib/ui/components/tab-bar/HkTabBar.svelte:9 - Missing non-standard extension (use './HkTabBar.state.svelte.js')
-	import { createOrGetState } from './HkTabBar.state.svelte';
-	import { createOrGetState } from './HkTabBar.state.svelte.js';
-
-src/lib/ui/primitives/icons/HkTabIcon.svelte:13 - Directory import (write explicitly: '../area/index.js')
-	import { HkGridArea } from '../area';
-	import { HkGridArea } from '../area/index.js';
-
-src/lib/util/array/index.js:5 - Parent index.js import (use $lib/ or import specific file)
-import { smallestFirst, largestFirst } from '../compare/index.js';
-import { smallestFirst, largestFirst } from '../compare.js';
-
-src/lib/util/array/index.js:7 - Parent index.js import (use $lib/ or import specific file)
-import { objectGet, PATH_SEPARATOR } from '../object/index.js';
-import { objectGet, PATH_SEPARATOR } from '../object.js';
-
-src/lib/util/compare/index.js:3 - Parent index.js import (use $lib/ or import specific file)
-import { objectGet } from '../object/index.js';
-import { objectGet } from '../object.js';
-
-src/lib/util/expect/compounds.js:2 - Parent index.js import (use $lib/ or import specific file)
-import * as is from '../is/index.js';
-import * as is from '../is.js';
-
-src/lib/util/expect/objects.js:2 - Parent index.js import (use $lib/ or import specific file)
-import * as is from '../is/index.js';
-import * as is from '../is.js';
-
-src/lib/util/iterate/index.js:4 - Parent index.js import (use $lib/ or import specific file)
-import { smallestFirst, largestFirst } from '../compare/index.js';
-import { smallestFirst, largestFirst } from '../compare.js';
-
-src/lib/util/object/index.js:5 - Parent index.js import (use $lib/ or import specific file)
-import { equals } from '../compare/index.js';
-import { equals } from '../compare.js';
-
-src/lib/util/object/index.js:7 - Parent index.js import (use $lib/ or import specific file)
-import { toArrayPath } from '../array/index.js';
-import { toArrayPath } from '../array.js';
-
-src/lib/util/object/index.js:11 - Parent index.js import (use $lib/ or import specific file)
-import * as is from '../is/index.js';
-import * as is from '../is.js';
-
-src/lib/util/object/index.js:13 - Parent index.js import (use $lib/ or import specific file)
-import { iterateObjectPaths, iterateObjectEntries } from '../iterate/index.js';
-import { iterateObjectPaths, iterateObjectEntries } from '../iterate.js';
-
-src/lib/util/string/interpolate.js:5 - Parent index.js import (use $lib/ or import specific file)
-import { objectGet, PATH_SEPARATOR } from '../object/index.js';
-import { objectGet, PATH_SEPARATOR } from '../object.js';
-
-src/routes/explorer/[...path]/+page.svelte:4 - Parent index.js import (use $lib/ or import specific file)
-  import { TopBar, Explorer } from '../components/index.js';
-  import { TopBar, Explorer } from '../components.js';
-