@hkdigital/lib-core 0.3.1

package/dist/valibot/url.js

@@ -0,0 +1,95 @@
+// > Imports
+
+import * as v from 'valibot';
+
+// > Exports
+
+/**
+ * Schema to validate an URL or empty string.
+ */
+export const UrlOrEmptyString = v.pipe(
+	v.pipe(v.string(), v.trim()),
+	v.union([v.literal(''), v.pipe(v.string(), v.url())])
+);
+
+/**
+ * Schema to validate an url that may miss the protocol part
+ *
+ * @note an empty string is not allowed!
+ */
+export const HumanUrl = v.pipe(
+	v.string(),
+	v.trim(),
+	v.transform((value) => {
+		if (!value.length || value.includes('://')) {
+			return value;
+		} else {
+			// Prefix 'url' with 'https://'
+			return `https://${value}`;
+		}
+	}),
+	v.url()
+);
+
+/**
+ * Schema to validate url path, without a search and hash part
+ */
+export const UrlPath = v.pipe(
+	v.string(),
+	v.transform((value) => {
+		// Convert relative url to URL object
+		// @note removes ../../ parts
+		try {
+			return new URL(value, 'http://localhost');
+
+			// eslint-disable-next-line no-unused-vars
+		} catch (e) {
+			return null;
+		}
+	}),
+	v.custom((urlOrNull) => {
+		return urlOrNull ? true : false;
+	}, 'Invalid URL pathname'),
+	v.transform((url) => {
+		return url.pathname;
+	})
+);
+
+/**
+ * Schema to validate a url path, which consists of
+ * a path and optionally search and hash parts
+ */
+export const RelativeUrl = v.pipe(
+	v.string(),
+	v.transform((value) => {
+		// Convert relative url to URL object
+		// @note removes ../../ parts
+		try {
+			return new URL(value, 'http://localhost');
+
+			// eslint-disable-next-line no-unused-vars
+		} catch (e) {
+			return null;
+		}
+	}),
+	v.custom((urlOrNull) => {
+		return urlOrNull ? true : false;
+	}, 'Invalid URL pathname or search part'),
+	v.transform((url) => {
+		return (
+			`${url.pathname}` +
+			`${url.search.length <= 1 ? '' : url.search}` +
+			`${url.hash.length <= 1 ? '' : url.hash}`
+		);
+	})
+);
+
+/**
+ * Schema to validate an absolute or relative url
+ *
+ * @note an empty string is not allowed!
+ */
+export const AbsOrRelUrl = v.union([
+	v.pipe(v.string(), v.trim(), v.url()),
+	v.pipe(v.string(), v.nonEmpty(), RelativeUrl)
+]);

package/dist/valibot/user.d.ts

@@ -0,0 +1,6 @@
+export const Name: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TrimAction, v.RegexAction<string, undefined>]>;
+export const Fullname: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TrimAction, v.RegexAction<string, undefined>]>;
+export const Username: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TrimAction, v.RegexAction<string, undefined>]>;
+export const Surname: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TrimAction, v.RegexAction<string, undefined>]>;
+export const PhoneNumber: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TrimAction, v.RegexAction<string, undefined>]>;
+import * as v from 'valibot';

package/dist/valibot/user.js

@@ -0,0 +1,23 @@
+// > Imports
+
+import * as v from 'valibot';
+
+import {
+	RE_FULLNAME,
+	RE_NAME,
+	RE_USERNAME,
+	RE_SURNAME,
+	RE_PHONENUMBER
+} from '../constants/regexp/index.js';
+
+// > Exports
+
+export const Name = v.pipe(v.string(), v.trim(), v.regex(RE_NAME));
+
+export const Fullname = v.pipe(v.string(), v.trim(), v.regex(RE_FULLNAME));
+
+export const Username = v.pipe(v.string(), v.trim(), v.regex(RE_USERNAME));
+
+export const Surname = v.pipe(v.string(), v.trim(), v.regex(RE_SURNAME));
+
+export const PhoneNumber = v.pipe(v.string(), v.trim(), v.regex(RE_PHONENUMBER));

package/dist/zod/all.d.ts

@@ -0,0 +1,6 @@
+export * from "./generic.js";
+export * from "./javascript.js";
+export * from "./user.js";
+export * from "./web.js";
+export default z;
+import { z } from 'zod';

package/dist/zod/all.js

@@ -0,0 +1,33 @@
+/**
+ * The following namespace style import can be used to acces the named exports
+ * and als the JSdoc typedefs
+ *
+ * @example
+ *
+ * import * as Zods from '<path-to>/zod/all.js';
+ *
+ * JSdoc:
+ * `@param {Zods.Name} name
+ * `@param {Zods.Timeout} t
+ *
+ * Assert style:
+ * Zods.String.parse(name);
+ *
+ * Parse style:
+ * const name = Zods.Name.parse('Jens ');
+ *
+ * Use default export 'z':
+ * // eslint-disable-next-line no-unused-vars
+ * import z, * as Zods from '<path-to>/zod/all.js';
+ *
+ * z.string().parse(name);
+ */
+
+import { z } from 'zod';
+
+export * from './generic.js';
+export * from './javascript.js';
+export * from './user.js';
+export * from './web.js';
+
+export default z;

package/dist/zod/generic.d.ts

@@ -0,0 +1,6 @@
+export type Label = string;
+export const Label: z.ZodString;
+export type LabelOrSymbol = string | Symbol;
+/** @typedef {string} Label */
+export const LabelOrSymbol: z.ZodUnion<[z.ZodString, z.ZodSymbol]>;
+import { z } from 'zod';

package/dist/zod/generic.js

@@ -0,0 +1,11 @@
+// > Imports
+
+import { z } from 'zod';
+
+// > Exports
+
+export const Label = z.string().min(1).max(80);
+/** @typedef {string} Label */
+
+export const LabelOrSymbol = z.union([z.string().min(1).max(80), z.symbol()]);
+/** @typedef {string|Symbol} LabelOrSymbol */

package/dist/zod/javascript.d.ts

@@ -0,0 +1,8 @@
+export type Timeout = number | NodeJS.Timeout;
+export const Timeout: z.ZodNumber;
+export type TimeoutOrUndefined = number | NodeJS.Timeout | undefined;
+/** @typedef {number|NodeJS.Timeout} Timeout */
+export const TimeoutOrUndefined: z.ZodUnion<[z.ZodNumber, z.ZodUndefined]>;
+declare const _default: {};
+export default _default;
+import { z } from 'zod';

package/dist/zod/javascript.js

@@ -0,0 +1,32 @@
+/**
+ * The following namespace style import can be used to acces the named exports
+ * and als the JSdoc typedefs
+ *
+ * import z, * as Zods from '<path-to>/all.js';
+ *
+ * @example
+ *
+ *  JSdoc:
+ *  `@param {Type.Name} name
+ *
+ *  Assert style:
+ *  Type.String.parse(name);
+ *
+ *  Parse style:
+ *  const name = Type.Name.parse('Jens ');
+ */
+
+// > Imports
+
+import { z } from 'zod';
+
+// > Exports
+
+export const Timeout = z.number();
+/** @typedef {number|NodeJS.Timeout} Timeout */
+
+export const TimeoutOrUndefined = z.union([z.number(), z.undefined()]);
+/** @typedef {number|NodeJS.Timeout|undefined} TimeoutOrUndefined */
+
+// Export default is required for exporting typedefs
+export default {};

package/dist/zod/user.d.ts

@@ -0,0 +1,9 @@
+export type Name = z.infer<typeof Name>;
+export const Name: z.ZodString;
+export type Fullname = z.infer<typeof Fullname>;
+/** @typedef { z.infer<typeof Name> } Name */
+export const Fullname: z.ZodString;
+export type Username = z.infer<typeof Username>;
+/** @typedef { z.infer<typeof Fullname> } Fullname */
+export const Username: z.ZodString;
+import { z } from 'zod';

package/dist/zod/user.js

@@ -0,0 +1,16 @@
+// > Imports
+
+import { z } from 'zod';
+
+import { RE_FULLNAME, RE_NAME, RE_USERNAME } from '../constants/regexp/index.js';
+
+// > Exports
+
+export const Name = z.string().trim().regex(RE_NAME);
+/** @typedef { z.infer<typeof Name> } Name */
+
+export const Fullname = z.string().trim().regex(RE_FULLNAME);
+/** @typedef { z.infer<typeof Fullname> } Fullname */
+
+export const Username = z.string().trim().regex(RE_USERNAME);
+/** @typedef { z.infer<typeof Username> } Username */

package/dist/zod/web.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Parse Url
+ * - Allows relative urls (only the pathname and a search part of an url)
+ * - Require the use of the HTTP(s) protocol in absolute URL's
+ *
+ * @param {object} _
+ * @param {boolean} [_.allowRelative=true]
+ * @param {boolean} [_.requireHttp=true]
+ *
+ * @returns {{ parse:function }}
+ */
+export function UrlOrPath({ allowRelative, requireHttp }?: {
+    allowRelative?: boolean;
+    requireHttp?: boolean;
+}): {
+    parse: Function;
+};
+export type AbsOrRelUrl = string;
+export const AbsOrRelUrl: {
+    parse: Function;
+};

package/dist/zod/web.js

@@ -0,0 +1,52 @@
+// > Imports
+
+import { z } from 'zod';
+
+// > Exports
+
+/**
+ * Parse Url
+ * - Allows relative urls (only the pathname and a search part of an url)
+ * - Require the use of the HTTP(s) protocol in absolute URL's
+ *
+ * @param {object} _
+ * @param {boolean} [_.allowRelative=true]
+ * @param {boolean} [_.requireHttp=true]
+ *
+ * @returns {{ parse:function }}
+ */
+export function UrlOrPath({ allowRelative = true, requireHttp = true } = {}) {
+	// > URL parser
+	return z.string().refine((value) => {
+		let url;
+
+		try {
+			if (!allowRelative) {
+				// > Ensure that URL is absolute
+				url = new URL(value);
+
+				if (requireHttp) {
+					// > Ensure that protocol is http(s)
+					if (url.protocol.startsWith('http')) {
+						return null;
+					}
+				}
+
+				return `${url.origin}${url.pathname}` + `${url.search.length <= 1 ? '' : url.search}`;
+			} else {
+				// > Parse relative URL
+				// @note removes ../../ parts
+
+				url = new URL(value, 'http://localhost');
+
+				return `${url.pathname}` + `${url.search.length <= 1 ? '' : url.search}`;
+			}
+			// eslint-disable-next-line no-unused-vars
+		} catch (e) {
+			return null;
+		}
+	});
+}
+
+export const AbsOrRelUrl = UrlOrPath();
+/** @typedef {string} AbsOrRelUrl */

package/package.json

@@ -0,0 +1,133 @@
+{
+	"name": "@hkdigital/lib-core",
+	"version": "0.3.1",
+	"author": {
+		"name": "HKdigital",
+		"url": "https://hkdigital.nl"
+	},
+	"license": "ISC",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/HKdigital/hkdigital--lib-sveltekit.git"
+	},
+	"keywords": [
+		"component-library",
+		"sveltekit",
+		"skeleton",
+		"tailwindcss",
+		"runed",
+		"valibot"
+	],
+	"scripts": {
+		"dev": "run-s svelte:sync dev:start",
+		"build": "run-s svelte:sync build:*",
+		"preview": "vite preview",
+		"check": "run-s svelte:sync check:run",
+		"check:watch": "run-s svelte:sync check:watch-run",
+		"format": "prettier --write .",
+		"lint": "run-s lint:*",
+		"test": "run-s test:unit-run",
+		"prepack": "run-s prepack:*",
+		"publish:npm": "run-s publish:npm:version publish:npm:publish git:push",
+		"upgrade:hk": "run-s upgrade:hk:update pnpm:install",
+		"upgrade:all": "run-s upgrade:all:update pnpm:install",
+		"svelte:sync": "svelte-kit sync",
+		"dev:start": "vite dev",
+		"build:vite": "vite build",
+		"check:run": "svelte-check --tsconfig ./jsconfig.json",
+		"check:watch-run": "svelte-check --tsconfig ./jsconfig.json --watch",
+		"git:push": "git push",
+		"lint:prettier": "prettier --check .",
+		"lint:eslint": "eslint .",
+		"test:unit": "vitest",
+		"test:unit-run": "pnpm run test:unit -- --run",
+		"prepack:sync": "svelte-kit sync",
+		"prepack:build": "svelte-package",
+		"prepack:lint": "publint",
+		"publish:npm:version": "npm version patch",
+		"publish:npm:publish": "npm publish --access public",
+		"upgrade:hk:update": "ncu --dep dev,optional,peer,prod '@hkdigital/*' -u",
+		"upgrade:all:update": "ncu --dep dev,optional,peer,prod -u",
+		"pnpm:install": "pnpm install"
+	},
+	"files": [
+		"dist",
+		"!dist/**/*.test.*",
+		"!dist/**/*.spec.*",
+		"!dist/**/testdata.*",
+		"!dist/**/*.testdata.*"
+	],
+	"sideEffects": [
+		"**/*.css"
+	],
+	"svelte": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"type": "module",
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"svelte": "./dist/index.js",
+			"default": "./dist/index.js"
+		},
+		"./*": "./dist/*",
+		"./typedef": "./dist/typedef/index.js"
+	},
+	"peerDependencies": {
+		"@eslint/js": "^9.28.0",
+		"@steeze-ui/heroicons": "^2.4.2",
+		"@sveltejs/kit": "^2.21.2",
+		"eslint-plugin-import": "^2.31.0",
+		"pino": "^9.7.0",
+		"pino-pretty": "^13.0.0",
+		"runed": "^0.23.1",
+		"svelte": "^5.33.16",
+		"svelte-preprocess": "^6.0.3",
+		"valibot": "^1.1.0",
+		"zod": "^3.24.2"
+	},
+	"devDependencies": {
+		"@eslint/js": "^9.28.0",
+		"@playwright/test": "^1.52.0",
+		"@skeletonlabs/skeleton": "3.0.0",
+		"@skeletonlabs/skeleton-svelte": "1.2.3",
+		"@steeze-ui/heroicons": "^2.4.2",
+		"@sveltejs/adapter-auto": "^6.0.1",
+		"@sveltejs/package": "^2.3.11",
+		"@sveltejs/vite-plugin-svelte": "^5.1.0",
+		"@tailwindcss/typography": "^0.5.16",
+		"@testing-library/svelte": "^5.2.7",
+		"@testing-library/user-event": "^14.6.1",
+		"@types/eslint": "^9.6.1",
+		"autoprefixer": "^10.4.21",
+		"eslint": "^9.28.0",
+		"eslint-config-prettier": "^10.1.5",
+		"eslint-plugin-import": "^2.31.0",
+		"eslint-plugin-svelte": "^3.9.1",
+		"fake-indexeddb": "^6.0.0",
+		"globals": "^16.2.0",
+		"jsdom": "^26.1.0",
+		"npm-check-updates": "^18.0.1",
+		"npm-run-all": "^4.1.5",
+		"pino": "^9.7.0",
+		"pino-pretty": "^13.0.0",
+		"postcss": "^8.5.4",
+		"postcss-mixins": "^11.0.3",
+		"prettier": "^3.5.3",
+		"prettier-plugin-svelte": "^3.4.0",
+		"prettier-plugin-tailwindcss": "^0.6.12",
+		"publint": "^0.3.12",
+		"standardized-audio-context-mock": "^9.7.22",
+		"svelte": "^5.33.16",
+		"svelte-check": "^4.2.1",
+		"svelte-preprocess": "^6.0.3",
+		"tailwindcss": "^4.1.10",
+		"typescript": "^5.8.3",
+		"vite": "^6.3.5",
+		"vite-imagetools": "^7.1.0",
+		"vitest": "^3.2.2",
+		"zod": "^3.24.2"
+	},
+	"dependencies": {
+		"@tailwindcss/postcss": "^4.1.11"
+	}
+}