@hkdigital/lib-core 0.3.10 → 0.3.12

package/README.md

@@ -5,14 +5,6 @@ Core library that we use to power up our SvelteKit projects
 This is a library for [SvelteKit](https://svelte.dev/) projects.
 It contains common code and components that we use to create our projects.
 
-## Status
-
-**EARLY DEVELOPMENT RELEASE**
-This package is incomplete and not fully tested.
-Do not use in production environments yet.
-
-### TODO
-
 ## Using the library
 
 ### Install
@@ -20,7 +12,21 @@ Do not use in production environments yet.
 The library can be installed as a normal NPM library.
 
 ```bash
-pnpm add @hkdigital/lib-sveltekit
+pnpm add @hkdigital/lib-core
+```
+
+### Peer Dependencies
+
+This library requires certain peer dependencies depending on which features you use:
+
+**For development logging:**
+```bash
+pnpm add -D pino-pretty
+```
+
+**For Vite config generators with imagetools:**
+```bash
+pnpm add -D vite-imagetools
 ```
 
 #### Tailwind
@@ -61,13 +67,31 @@ pnpm add -D npm-check-updates
 }
 ```
 
+### Vite Configuration
+
+The library provides configuration generators for Vite that include common HKdigital project settings:
+
+```javascript
+// vite.config.js
+import { defineConfig } from 'vitest/config';  
+import { generateViteConfig } from '@hkdigital/lib-core/config/vite.js';
+
+export default defineConfig(
+  await generateViteConfig({
+    enableImagetools: true,
+    enableVitest: true
+  })
+);
+```
+
+For detailed configuration options, see the [config documentation](./src/lib/config/README.md).
 
 ### Import JS, Svelte files and Typedefs
 
 Most subfolders have an index.js that export all functionality and typedefs.
 
 ```svelte
-import { CHAR } from '@hkdigital/lib-sveltekit/constants/regexp/index.js';
+import { CHAR } from '@hkdigital/lib-core/constants/regexp/index.js';
 ```
 
 ### Import CSS
@@ -78,7 +102,7 @@ For example:
 
 ```css
 /* src/app.css */
-@import '../node_modules/@hkdigital/lib-sveltekit/dist/css/utilities.css';
+@import '../node_modules/@hkdigital/lib-core/dist/css/utilities.css';
 ```
 
 ### Enable tailwind processing
@@ -121,7 +145,7 @@ Everything inside `src/lib` is part of the library, everything inside `src/route
 
 ## Publishing
 
-The name of this library is `@hkdigital/lib-sveltekit` and it is published on [NPM](https://npmjs.com). You need NPM credentials to publish in the scope `@hkdigital`.
+The name of this library is `@hkdigital/lib-core` and it is published on [NPM](https://npmjs.com). You need NPM credentials to publish in the scope `@hkdigital`.
 
 ```bash
 # Manually

package/dist/assets/autospuiten/car-paint-picker.d.ts

@@ -1,11 +1,11 @@
 export const carPaintImages: {
-    rusty: import("../../typedef/image.js").ImageMeta[];
-    "army-green": import("../../typedef/image.js").ImageMeta[];
-    "electric-blue": import("../../typedef/image.js").ImageMeta[];
-    "lemon-yellow": import("../../typedef/image.js").ImageMeta[];
-    "opaque-purple": import("../../typedef/image.js").ImageMeta[];
-    "sunset-orange": import("../../typedef/image.js").ImageMeta[];
-    "tomato-red": import("../../typedef/image.js").ImageMeta[];
+    rusty: import("../../network/typedef.js").ImageMeta[];
+    "army-green": import("../../network/typedef.js").ImageMeta[];
+    "electric-blue": import("../../network/typedef.js").ImageMeta[];
+    "lemon-yellow": import("../../network/typedef.js").ImageMeta[];
+    "opaque-purple": import("../../network/typedef.js").ImageMeta[];
+    "sunset-orange": import("../../network/typedef.js").ImageMeta[];
+    "tomato-red": import("../../network/typedef.js").ImageMeta[];
 };
 import Rusty from './car-paint-picker/rusty.jpg?preset=render&responsive';
 import ArmyGreen from './car-paint-picker/army-green.jpg?preset=render&responsive';

package/dist/classes/data/IterableTree.d.ts

@@ -15,21 +15,28 @@ export default class IterableTree {
     /**
      * Get an iterator to iterate over all object [ path, value ] entries
      *
-     * @returns {Iterator} object entries iterator
+     * @returns {Iterable<[string[], any]>} iterable that yields [path, value] pairs
      */
-    entries(): Iterator<any, any, any>;
+    entries(): Iterable<[string[], any]>;
     /**
      * Get an iterator to iterate over all object paths
      *
-     * @returns {Iterator} object path iterator
+     * @returns {Iterable<string[]>} iterable that yields path arrays
      */
-    paths(): Iterator<any, any, any>;
+    paths(): Iterable<string[]>;
     /**
      * Get an iterator to iterate over all values at the leaves of the paths in
      * the object
      *
-     * @returns {Iterator} object value iterator
+     * @returns {Iterable<any>} iterable that yields leaf values
      */
-    values(): Iterator<any, any, any>;
+    values(): Iterable<any>;
+    /**
+     * Make the class iterable by implementing Symbol.iterator
+     * Defaults to iterating over entries (path-value pairs)
+     *
+     * @returns {Iterable<[string[], any]>} iterable that yields [path, value] pairs
+     */
+    [Symbol.iterator](): Iterable<[string[], any]>;
     #private;
 }

package/dist/classes/data/IterableTree.js

@@ -48,7 +48,7 @@ export default class IterableTree {
 	/**
 	 * Get an iterator to iterate over all object [ path, value ] entries
 	 *
-	 * @returns {Iterator} object entries iterator
+	 * @returns {Iterable<[string[], any]>} iterable that yields [path, value] pairs
 	 */
 	*entries() {
 		const obj = this.obj;
@@ -56,7 +56,8 @@ export default class IterableTree {
 
 		const options = this.#options;
 
-		let { expandPathKeys, ignoreEmptyObjectLeaves, outputIntermediateNodes } = this.#options;
+		let { expandPathKeys, ignoreEmptyObjectLeaves, outputIntermediateNodes } =
+			this.#options;
 
 		if (parentArrPath) {
 			// Never expand keys if not in root object
@@ -163,7 +164,7 @@ export default class IterableTree {
 	/**
 	 * Get an iterator to iterate over all object paths
 	 *
-	 * @returns {Iterator} object path iterator
+	 * @returns {Iterable<string[]>} iterable that yields path arrays
 	 */
 	*paths() {
 		for (const entry of this.entries()) {
@@ -177,7 +178,7 @@ export default class IterableTree {
 	 * Get an iterator to iterate over all values at the leaves of the paths in
 	 * the object
 	 *
-	 * @returns {Iterator} object value iterator
+	 * @returns {Iterable<any>} iterable that yields leaf values
 	 */
 	*values() {
 		for (const entry of this.entries()) {
@@ -187,10 +188,22 @@ export default class IterableTree {
 
 	// -------------------------------------------------------------------- Method
 
+	/**
+	 * Make the class iterable by implementing Symbol.iterator
+	 * Defaults to iterating over entries (path-value pairs)
+	 *
+	 * @returns {Iterable<[string[], any]>} iterable that yields [path, value] pairs
+	 */
+	*[Symbol.iterator]() {
+		yield* this.entries();
+	}
+
+	// -------------------------------------------------------------------- Method
+
 	/**
 	 * Returns true if the iterator should recurse into the specified value
 	 *
-	 * @param {string} value
+	 * @param {any} value
 	 *
 	 * @return {boolean} true if the value should be iterated
 	 */

package/dist/classes/promise/HkPromise.d.ts

@@ -5,9 +5,9 @@
  */
 export default class HkPromise extends Promise<any> {
     /**
-     * @param {()=>void} [initFn]
+     * @param {(resolveFn?:function, rejectFn?:function)=>void} [initFn]
      */
-    constructor(initFn?: () => void);
+    constructor(initFn?: (resolveFn?: Function, rejectFn?: Function) => void);
     /**
      * Get value of property [resolved]
      *
@@ -41,7 +41,7 @@ export default class HkPromise extends Promise<any> {
     /**
      * Resolve the promise
      *
-     * @param {any} [value] - Value to pass to the "then" callbacks
+     * @param {...any} args - Values to pass to the "then" callbacks
      *
      * @returns {object} this
      */
@@ -49,7 +49,7 @@ export default class HkPromise extends Promise<any> {
     /**
      * Resolve the promise if the promise is still pending
      *
-     * @param {any} [value] - Value to pass to the "catch" callbacks
+     * @param {...any} args - Values to pass to the "then" callbacks
      *
      * @returns {object} this
      */
@@ -57,8 +57,8 @@ export default class HkPromise extends Promise<any> {
     /**
      * Reject the promise
      *
-     * @param {Object} [errorOrInfo]
-     *   Object to pass to the "catch" callbacks, usually an Error object
+     * @param {...any} args
+     *   Objects to pass to the "catch" callbacks, usually an Error object or details
      *
      * @returns {object} this
      */
@@ -66,8 +66,8 @@ export default class HkPromise extends Promise<any> {
     /**
      * Reject the promise if the promise is still pending
      *
-     * @param {Object} [errorOrInfo]
-     *   Object to pass to the "catch" callbacks, usually an Error object
+     * @param {...any} args
+     *   Objects to pass to the "catch" callbacks, usually an Error object or details
      *
      * @returns {object} this
      */
@@ -75,21 +75,21 @@ export default class HkPromise extends Promise<any> {
     /**
      * Reject the promise and set this.cancelled=true
      *
-     * @param {Object} [errorOrInfo]
-     *   Object to pass to the "catch" callbacks, usually an Error object
+     * @param {Error|*} [errorOrDetails]
+     *   Error object or details to pass to the "catch" callbacks
      *
      * @returns {object} this
      */
-    cancel(errorOrInfo?: any, ...args: any[]): object;
+    cancel(errorOrDetails?: Error | any): object;
     /**
-     * Reject the promise and set this.cancelled=true
+     * Reject the promise and set this.cancelled=true if still pending
      *
-     * @param {Object} [errorOrInfo]
-     *   Object to pass to the "catch" callbacks, usually an Error object
+     * @param {Error|*} [errorOrDetails]
+     *   Error object or details to pass to the "catch" callbacks
      *
      * @returns {object} this
      */
-    tryCancel(...args: any[]): object;
+    tryCancel(errorOrDetails?: Error | any): object;
     /**
      * Specify the number of milliseconds until the promise should time out.
      * - When a timeout occurs: the promise is cancelled and the following
@@ -108,14 +108,15 @@ export default class HkPromise extends Promise<any> {
     /**
      * Register a callback that is called when the promise resolves
      *
-     * @param {function} callback
+     * @param {...any} args - Callback functions and options
      */
     then(...args: any[]): Promise<any>;
     /**
      * Register a callback that is called when the promise rejects, is
      * cancelled or times out
      *
-     * @param {function} callback
+     * @param {...any} args - Callback functions and options
      */
     catch(...args: any[]): Promise<any>;
+    #private;
 }