@hkdigital/lib-core 0.4.30 → 0.4.31

package/dist/util/expect/arrays.d.ts

@@ -18,6 +18,7 @@ export function expect_stringArray(value: any): void;
 export function expect_objectArray(value: any): void;
 /**
  * Throws an exception if the value is not an Array or the array is empty
+ * @param {any} value - Value to check
  */
 export function expect_notEmptyArray(value: any): void;
 /**

package/dist/util/expect/arrays.js

@@ -35,6 +35,7 @@ export { expect_objectArray as objectArray };
 
 /**
  * Throws an exception if the value is not an Array or the array is empty
+ * @param {any} value - Value to check
  */
 export function expect_notEmptyArray(value) {
 	v.parse(v.pipe(v.instance(Array), v.nonEmpty()), value);

package/dist/util/expect/primitives.d.ts

@@ -2,24 +2,32 @@
  * Throws a validation error if value is not a string
  *
  * @param {any} value
+ *
+ * @asserts value is string
  */
 export function expect_string(value: any): void;
 /**
  * Throws a validation error if value is not a boolean
  *
  * @param {any} value
+ *
+ * @asserts value is boolean
  */
 export function expect_boolean(value: any): void;
 /**
  * Throws a validation error if value is not a number
  *
  * @param {any} value
+ *
+ * @asserts value is number
  */
 export function expect_number(value: any): void;
 /**
  * Throws a validation error if value is not a Symbol
  *
  * @param {any} value
+ *
+ * @asserts value is Symbol
  */
 export function expect_symbol(value: any): void;
 /**
@@ -32,30 +40,40 @@ export function expect_defined(value: any): void;
  * Throws a validation error if value is not a function
  *
  * @param {any} value
+ *
+ * @asserts value is function
  */
 export function expect_function(value: any): void;
 /**
  * Throws a validation error if value is not a Promise
  *
  * @param {any} value
+ *
+ * @asserts value is Promise
  */
 export function expect_promise(value: any): void;
 /**
  * Throws a validation error if value is not a Map
  *
  * @param {any} value
+ *
+ * @asserts value is Map
  */
 export function expect_map(value: any): void;
 /**
  * Throws a validation error if value is not a Set
  *
  * @param {any} value
+ *
+ * @asserts value is Set
  */
 export function expect_set(value: any): void;
 /**
  * Throws a validation error if value is not an Error instance
  *
  * @param {any} value
+ *
+ * @asserts value is Error
  */
 export function expect_error(value: any): void;
 export { expect_string as string, expect_boolean as boolean, expect_number as number, expect_symbol as symbol, expect_defined as defined, expect_function as function, _function as function, expect_function as class, _class as class, expect_promise as promise, expect_map as map, expect_set as set, expect_error as error };

package/dist/util/expect/primitives.js

@@ -4,6 +4,8 @@ import * as v from 'valibot';
  * Throws a validation error if value is not a string
  *
  * @param {any} value
+ *
+ * @asserts value is string
  */
 export function expect_string(value) {
 	v.parse(v.string(), value);
@@ -15,6 +17,8 @@ export { expect_string as string };
  * Throws a validation error if value is not a boolean
  *
  * @param {any} value
+ *
+ * @asserts value is boolean
  */
 export function expect_boolean(value) {
 	v.parse(v.boolean(), value);
@@ -26,6 +30,8 @@ export { expect_boolean as boolean };
  * Throws a validation error if value is not a number
  *
  * @param {any} value
+ *
+ * @asserts value is number
  */
 export function expect_number(value) {
 	v.parse(v.number(), value);
@@ -37,6 +43,8 @@ export { expect_number as number };
  * Throws a validation error if value is not a Symbol
  *
  * @param {any} value
+ *
+ * @asserts value is Symbol
  */
 export function expect_symbol(value) {
 	v.parse(v.symbol(), value);
@@ -68,6 +76,8 @@ export { expect_defined as defined };
  * Throws a validation error if value is not a function
  *
  * @param {any} value
+ *
+ * @asserts value is function
  */
 export function expect_function(value) {
 	v.parse(v.function(), value);
@@ -80,6 +90,8 @@ export { expect_function as class };
  * Throws a validation error if value is not a Promise
  *
  * @param {any} value
+ *
+ * @asserts value is Promise
  */
 export function expect_promise(value) {
 	v.parse(v.instance(Promise), value);
@@ -91,6 +103,8 @@ export { expect_promise as promise };
  * Throws a validation error if value is not a Map
  *
  * @param {any} value
+ *
+ * @asserts value is Map
  */
 export function expect_map(value) {
 	v.parse(v.instance(Map), value);
@@ -102,6 +116,8 @@ export { expect_map as map };
  * Throws a validation error if value is not a Set
  *
  * @param {any} value
+ *
+ * @asserts value is Set
  */
 export function expect_set(value) {
 	v.parse(v.instance(Set), value);
@@ -113,6 +129,8 @@ export { expect_set as set };
  * Throws a validation error if value is not an Error instance
  *
  * @param {any} value
+ *
+ * @asserts value is Error
  */
 export function expect_error(value) {
 	v.parse(v.instance(Error), value);

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

@@ -18,4 +18,17 @@ export function once(callback: Function): Function;
  */
 export function debounce(fn: Function, intervalMs?: number): Function;
 export function noop(): void;
-export function defer(fn: any): void;
+/**
+ * Defer the execution of a function
+ *  - Uses the best 'setImmediate' implementation supported by the current
+ *    runtime environment
+ *
+ * @param {function} fn - Function to execute
+ *
+ * --
+ *
+ * @note setImmediate is preferred over nextTick
+ *
+ * @see https://nodejs.org/en/docs/guides/event-loop-timers-and-nexttick/
+ */
+export const defer: typeof setImmediate | ((fn: any) => void);

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

@@ -3,8 +3,8 @@
  *
  * @param {number} xPct - X-coordinate as percentage
  * @param {number} yPct - Y-coordinate as percentage
- * @param {Array} polygon - Array of [x, y] points
+ * @param {Array<number[]>} polygon - Array of [x, y] points
  *
  * @returns {boolean} True if the point lies within the polygon
  */
-export function isPointInPolygon(xPct: number, yPct: number, polygon: any[]): boolean;
+export function isPointInPolygon(xPct: number, yPct: number, polygon: Array<number[]>): boolean;

package/dist/util/geometry/index.js

@@ -3,7 +3,7 @@
  *
  * @param {number} xPct - X-coordinate as percentage
  * @param {number} yPct - Y-coordinate as percentage
- * @param {Array} polygon - Array of [x, y] points
+ * @param {Array<number[]>} polygon - Array of [x, y] points
  *
  * @returns {boolean} True if the point lies within the polygon
  */

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

@@ -48,11 +48,11 @@ export function map(iterable: Iterable<any>, transformFn: Function): Generator;
  * @return {Iterable<[string[], any]>} iterable that yields [path, value] pairs
  */
 export function iterateObjectEntries(obj: object, options?: {
-    walkArrays?: boolean;
-    expandPathKeys?: boolean;
-    outputIntermediateNodes?: boolean;
-    ignoreEmptyObjectLeaves?: boolean;
-    depthFirst?: boolean;
+    walkArrays?: boolean | undefined;
+    expandPathKeys?: boolean | undefined;
+    outputIntermediateNodes?: boolean | undefined;
+    ignoreEmptyObjectLeaves?: boolean | undefined;
+    depthFirst?: boolean | undefined;
 }): Iterable<[string[], any]>;
 /**
  * Get an Iterator object that can be used to iterate over all paths in
@@ -92,6 +92,6 @@ export function iterateObjectValues(obj: object, options?: IterableTreeOptions):
 export function sortObjects({ it, getValueFn, reversed }: {
     it: Iterable<any>;
     getValueFn: Function;
-    reversed?: boolean;
-}): Promise<any[]>;
+    reversed?: boolean | undefined;
+}): Promise<array>;
 export type IterableTreeOptions = import("../../generic/typedef.js").IterableTreeOptions;

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

@@ -54,7 +54,7 @@ export function exportPublic(obj: object, keepKeys?: string[]): object;
  *
  * @returns {object|array} new object or array with only primitive values
  */
-export function exportNotNested(objectOrArray: object | any[]): object | any[];
+export function exportNotNested(objectOrArray: object | array): object | array;
 /**
  * Keep only the specified keys in the object
  * - deletes all other key-value pairs in the object
@@ -166,12 +166,12 @@ export function objectGetWithThrow(obj: object, path: string | any[], parseFn?:
  *   List of changes between the object before and object after
  */
 export function objectDiff(objBefore: object, objAfter: object, options: {
-    ignoreAdd?: boolean;
-    ignoreUpdate?: boolean;
-    ignoreDelete?: boolean;
-    ignorePrivate?: boolean;
-    deleteValue?: boolean;
-}, _recursion: any): any[];
+    ignoreAdd?: boolean | undefined;
+    ignoreUpdate?: boolean | undefined;
+    ignoreDelete?: boolean | undefined;
+    ignorePrivate?: boolean | undefined;
+    deleteValue?: boolean | undefined;
+} | undefined, _recursion: any): array;
 /**
  * Applies a list of differences to the input object
  * - A list of changes can be generated by e.g. objectDiff
@@ -188,10 +188,10 @@ export function objectDiff(objBefore: object, objAfter: object, options: {
  *   Ignore properties that start with an underscore e.g. _id or _updatedAt
  */
 export function patchObject(obj: object, changes: object[], options?: {
-    ignoreAdd?: boolean;
-    ignoreUpdate?: boolean;
-    ignoreDelete?: boolean;
-    ignorePrivate?: boolean;
+    ignoreAdd?: boolean | undefined;
+    ignoreUpdate?: boolean | undefined;
+    ignoreDelete?: boolean | undefined;
+    ignorePrivate?: boolean | undefined;
 }): void;
 /**
  * Extend the target object with methods and properties from the source
@@ -242,7 +242,7 @@ export function getPrototypeNames(obj: object): string[];
  *   nested object with the values that were found or defaultValues
  */
 export function getTree(obj: object, tree: object, options?: {
-    shallowLeaves?: boolean;
+    shallowLeaves?: boolean | undefined;
 }): object;
 /**
  * Deep clone an object or any kind of other variable
@@ -284,7 +284,7 @@ export function setReadOnlyProperty(obj: object, propertyName: string, value: an
  * @returns {object} updated object
  */
 export function updateObject(obj?: object, updateData?: object | Iterable<any>, options?: {
-    replaceArrays?: boolean;
+    replaceArrays?: boolean | undefined;
 }): object;
 /**
  * Copy own properties from an object to another object if they do not

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

@@ -12,8 +12,8 @@
  */
 export function getInstance({ needle, class: Class, args }: {
     class: any;
-    args?: any[];
-    needle?: string;
+    args?: any[] | undefined;
+    needle?: string | undefined;
 }): any;
 /**
  * Creates a proxy that instantiates the singleton class upon it's first usage
@@ -28,7 +28,7 @@ export function getInstance({ needle, class: Class, args }: {
  */
 export function lazySingleton<T>({ class: Class, args }: {
     class: new () => T;
-    args?: any[];
+    args?: any[] | undefined;
 }): T & {
     init: () => null;
 };

package/dist/util/svelte/loading/loading-tracker.svelte.d.ts

@@ -11,7 +11,7 @@
  *
  * @returns {Object} Loading tracker instance
  */
-export function createTracker(): any;
+export function createTracker(): Object;
 /**
  * Simple utility for tracking combined loading progress across multiple components
  */

package/dist/util/sveltekit/env/all.d.ts

@@ -31,10 +31,10 @@
  * // }
  */
 export function getAllEnv(options?: {
-    camelCase?: boolean;
-    parseValues?: boolean;
-    autoGroup?: boolean;
-}): any;
+    camelCase?: boolean | undefined;
+    parseValues?: boolean | undefined;
+    autoGroup?: boolean | undefined;
+}): Object;
 /**
  * Get combined environment variables by prefix
  *
@@ -43,7 +43,7 @@ export function getAllEnv(options?: {
  *
  * @returns {Object} Parsed configuration object
  */
-export function getAllEnvByPrefix(prefix: string, options?: any): any;
+export function getAllEnvByPrefix(prefix: string, options?: Object): Object;
 /**
  * Get raw combined environment variables (no parsing)
  *

package/dist/util/sveltekit/env/all.js

@@ -14,7 +14,7 @@
 
 import { getPublicEnv, getRawPublicEnv } from './public.js';
 import { getPrivateEnv, getRawPrivateEnv } from './private.js';
-import { autoGroupEnvByPrefix, parseEnv } from './parsers.js';
+import { autoGroupEnvByPrefix } from './parsers.js';
 
 /**
  * Get all environment variables (public + private) with automatic grouping
@@ -94,4 +94,4 @@ export function getRawAllEnv() {
   
   // Private variables take precedence over public ones
   return { ...publicVars, ...privateVars };
-}
+}

package/dist/util/sveltekit/env/parsers.d.ts

@@ -32,11 +32,11 @@
 export function parseEnv(env: {
     [x: string]: string;
 }, options?: {
-    camelCase?: boolean;
-    parseValues?: boolean;
-    prefix?: string;
-    removePrefix?: boolean;
-}): any;
+    camelCase?: boolean | undefined;
+    parseValues?: boolean | undefined;
+    prefix?: string | undefined;
+    removePrefix?: boolean | undefined;
+}): Object;
 /**
  * Parse environment variables by prefix
  *
@@ -48,7 +48,7 @@ export function parseEnv(env: {
  */
 export function parseEnvByPrefix(env: {
     [x: string]: string;
-}, prefix: string, options?: any): any;
+}, prefix: string, options?: Object): Object;
 /**
  * Convert SCREAMING_SNAKE_CASE to camelCase
  *
@@ -98,10 +98,10 @@ export function parseValue(value: string): any;
 export function autoGroupEnvByPrefix(env: {
     [x: string]: string;
 }, options?: {
-    camelCase?: boolean;
-    parseValues?: boolean;
+    camelCase?: boolean | undefined;
+    parseValues?: boolean | undefined;
 }): {
-    [x: string]: any;
+    [x: string]: Object;
 };
 /**
  * Group environment variables by specific prefixes
@@ -118,8 +118,8 @@ export function autoGroupEnvByPrefix(env: {
  */
 export function groupEnvByPrefixes(env: {
     [x: string]: string;
-}, prefixes: string[], options?: any): {
-    [x: string]: any;
+}, prefixes: string[], options?: Object): {
+    [x: string]: Object;
 };
 /**
  * Filter environment variables by pattern
@@ -132,4 +132,4 @@ export function groupEnvByPrefixes(env: {
  */
 export function filterEnvByPattern(env: {
     [x: string]: string;
-}, pattern: RegExp | string, options?: any): any;
+}, pattern: RegExp | string, options?: Object): Object;

package/dist/util/sveltekit/env/private.d.ts

@@ -33,10 +33,10 @@
  * // }
  */
 export function getPrivateEnv(options?: {
-    camelCase?: boolean;
-    parseValues?: boolean;
-    autoGroup?: boolean;
-}): any;
+    camelCase?: boolean | undefined;
+    parseValues?: boolean | undefined;
+    autoGroup?: boolean | undefined;
+}): Object;
 /**
  * Get private environment variables by prefix
  *
@@ -45,7 +45,7 @@ export function getPrivateEnv(options?: {
  *
  * @returns {Object} Parsed configuration object
  */
-export function getPrivateEnvByPrefix(prefix: string, options?: any): any;
+export function getPrivateEnvByPrefix(prefix: string, options?: Object): Object;
 /**
  * Get raw private environment variables (no parsing)
  *

package/dist/util/sveltekit/env/public.d.ts

@@ -29,10 +29,10 @@
  * // }
  */
 export function getPublicEnv(options?: {
-    camelCase?: boolean;
-    parseValues?: boolean;
-    autoGroup?: boolean;
-}): any;
+    camelCase?: boolean | undefined;
+    parseValues?: boolean | undefined;
+    autoGroup?: boolean | undefined;
+}): Object;
 /**
  * Get public environment variables by prefix
  *
@@ -41,7 +41,7 @@ export function getPublicEnv(options?: {
  *
  * @returns {Object} Parsed configuration object
  */
-export function getPublicEnvByPrefix(prefix: string, options?: any): any;
+export function getPublicEnvByPrefix(prefix: string, options?: Object): Object;
 /**
  * Get raw public environment variables (no parsing)
  *

package/dist/util/sveltekit/route-folders/index.d.ts

@@ -19,8 +19,8 @@ export function isValidRoutePath(path: string): boolean;
  */
 export function scanRouteFolders({ dirPath, maxDepth, skipFolders }: {
     dirPath: string;
-    maxDepth?: number;
-    skipFolders?: Set<string>;
+    maxDepth?: number | undefined;
+    skipFolders?: Set<string> | undefined;
 }, depth?: number): Promise<Array<{
     displayName: string;
     path: string;

package/dist/util/sveltekit/route-folders.d.ts

@@ -0,0 +1 @@
+export * from "./route-folders/index.js";

package/dist/util/{sveltekit.js → sveltekit/route-folders.js}

@@ -5,4 +5,4 @@
  * This module provides SvelteKit-specific utilities including route management.
  */
 
-export * from './sveltekit/route-folders/index.js';
+export * from './route-folders/index.js';

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

@@ -73,8 +73,8 @@ export function getWeekNumber(dateOrTimestamp: Date | number): number;
  * @returns {string} name of the month in the specified locale
  */
 export function getMonthName(dateOrTimestamp: Date | number, locale?: string, options?: {
-    month?: "numeric" | "2-digit" | "narrow" | "short" | "long";
-    timeZone?: string;
+    month?: "numeric" | "2-digit" | "narrow" | "short" | "long" | undefined;
+    timeZone?: string | undefined;
 }): string;
 /**
  * Get the name of the day of the week
@@ -91,8 +91,8 @@ export function getMonthName(dateOrTimestamp: Date | number, locale?: string, op
  * @returns {string} name of the day in the specified locale
  */
 export function getDayName(dateOrTimestamp: Date | number, locale?: string, options?: {
-    weekday?: "narrow" | "short" | "long";
-    timeZone?: string;
+    weekday?: "narrow" | "short" | "long" | undefined;
+    timeZone?: string | undefined;
 }): string;
 /**
  * Return the timestamp of the start of the day

package/dist/valibot/parsers/url.d.ts

@@ -11,18 +11,18 @@ export const HumanUrl: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.T
 /**
  * Parser for URL path, without a search and hash part
  */
-export const UrlPath: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TransformAction<string, URL>, v.CustomSchema<URL, "Invalid URL pathname">, v.TransformAction<URL, string>]>;
+export const UrlPath: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TransformAction<string, URL | null>, v.CustomSchema<URL | null, "Invalid URL pathname">, v.TransformAction<URL | null, string>]>;
 /**
  * Parser for URL path, which consists of
  * a path and optionally search and hash parts
  */
-export const RelativeUrl: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TransformAction<string, URL>, v.CustomSchema<URL, "Invalid URL pathname or search part">, v.TransformAction<URL, string>]>;
+export const RelativeUrl: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TransformAction<string, URL | null>, v.CustomSchema<URL | null, "Invalid URL pathname or search part">, v.TransformAction<URL | null, string>]>;
 /**
  * Parser for absolute or relative URL
  *
  * @note an empty string is not allowed!
  */
-export const AbsOrRelUrl: v.UnionSchema<[v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TrimAction, v.UrlAction<string, undefined>]>, v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.NonEmptyAction<string, undefined>, v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TransformAction<string, URL>, v.CustomSchema<URL, "Invalid URL pathname or search part">, v.TransformAction<URL, string>]>]>], undefined>;
+export const AbsOrRelUrl: v.UnionSchema<[v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TrimAction, v.UrlAction<string, undefined>]>, v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.NonEmptyAction<string, undefined>, v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TransformAction<string, URL | null>, v.CustomSchema<URL | null, "Invalid URL pathname or search part">, v.TransformAction<URL | null, string>]>]>], undefined>;
 /**
  * Parser for URL slug (e.g., "my-blog-post", "user-123")
  *

package/dist/valibot/parsers/url.js

@@ -53,6 +53,7 @@ export const UrlPath = v.pipe(
 		return urlOrNull ? true : false;
 	}, 'Invalid URL pathname'),
 	v.transform((url) => {
+		// @ts-ignore
 		return url.pathname;
 	})
 );
@@ -79,8 +80,11 @@ export const RelativeUrl = v.pipe(
 	}, 'Invalid URL pathname or search part'),
 	v.transform((url) => {
 		return (
+			// @ts-ignore
 			`${url.pathname}` +
+			// @ts-ignore
 			`${url.search.length <= 1 ? '' : url.search}` +
+			// @ts-ignore
 			`${url.hash.length <= 1 ? '' : url.hash}`
 		);
 	})
@@ -98,7 +102,7 @@ export const AbsOrRelUrl = v.union([
 
 /**
  * Parser for URL slug (e.g., "my-blog-post", "user-123")
- * 
+ *
  * @note Must start and end with Latin characters or numbers
  * @note Hyphens are allowed between character groups
  * @note Automatically converts to lowercase
@@ -108,4 +112,4 @@ export const Slug = v.pipe(
 	v.trim(),
 	v.toLowerCase(),
 	v.regex(new RegExp(URL_SLUG, 'v'), 'Must be a valid URL slug')
-);
+);

package/package.json

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

package/dist/util/sveltekit.d.ts

@@ -1 +0,0 @@
-export * from "./sveltekit/route-folders/index.js";