@softwareone/spi-sv5-library 1.4.0 → 1.5.0

package/dist/Form/FormController/Form.svelte

@@ -0,0 +1,155 @@
+<script lang="ts">
+	import type { ActionResult } from '@sveltejs/kit';
+	import { onDestroy, untrack, type Snippet } from 'svelte';
+
+	import { zod4Client } from 'sveltekit-superforms/adapters';
+	import {
+		superForm,
+		type TaintedFields,
+		type ValidationErrors
+	} from 'sveltekit-superforms/client';
+	import { z } from 'zod';
+
+	import { addToast, Spinner } from '../../index.js';
+	import { getFormContext } from './context.js';
+	import type { FormError } from './types.js';
+	import { isEqual } from './helper.js';
+
+	type Schema = z.infer<typeof schema>;
+
+	interface Props {
+		initialData: Schema;
+		action: string;
+		schema: z.ZodObject;
+		extraData?: Record<string, string | number>;
+		onsuccess: (data?: Record<string, unknown>) => void;
+		onfailure?: (status: number | undefined, error: unknown) => void;
+		children: Snippet;
+	}
+
+	let {
+		initialData,
+		action,
+		schema,
+		extraData,
+		onsuccess,
+		onfailure = undefined,
+		children
+	}: Props = $props();
+
+	let actionResult: ActionResult;
+	let isLoading = $state(false);
+
+	const { form, errors, isFormValid } = getFormContext<Schema>();
+
+	$form = structuredClone($state.snapshot(initialData));
+
+	const onUpdated = () => {
+		isLoading = false;
+
+		const data = actionResult && 'data' in actionResult ? actionResult.data : undefined;
+		const success = actionResult?.type === 'success';
+
+		addToast({ message: data?.message, type: success ? 'success' : 'warning' });
+		if (success) {
+			onsuccess(data);
+		}
+	};
+
+	const onError = ({ result }: { result: ActionResult }) => {
+		if (result.type === 'error') {
+			addToast({ message: 'There was an unexpected error.', type: 'danger' });
+			onfailure?.(result.status, result.error);
+		}
+	};
+
+	const {
+		form: superFormData,
+		enhance,
+		validateForm,
+		errors: superFormErrors,
+		tainted: superFormTained
+	} = superForm(initialData, {
+		applyAction: false,
+		autoFocusOnError: true,
+		dataType: 'json',
+		resetForm: false,
+		scrollToError: 'smooth',
+		validationMethod: 'oninput',
+		validators: zod4Client(schema),
+		warnings: { duplicateId: false },
+		onSubmit: ({ formData }) => {
+			isLoading = true;
+			return appendExtraData(formData);
+		},
+		onResult: ({ result }) => (actionResult = result),
+		onUpdated,
+		onError
+	});
+
+	const getErrors = (
+		errors: ValidationErrors<Record<string, unknown>>,
+		tained: TaintedFields<Record<string, unknown>>
+	) => {
+		const errorEntries = Object.entries(errors)
+			.filter(([field]) => Object.hasOwn(tained, field))
+			.map(([field, error]) => [field, error && '_errors' in error ? error._errors : error]);
+
+		return Object.fromEntries(errorEntries) as FormError<Schema>;
+	};
+
+	const appendExtraData = (formData: FormData) => {
+		if (extraData) {
+			Object.entries(extraData).forEach(([key, value]) => {
+				formData.set(key, String(value));
+			});
+		}
+
+		return formData;
+	};
+
+	$effect(() => {
+		if (
+			!isEqual(
+				$form,
+				untrack(() => $superFormData)
+			)
+		) {
+			$superFormData = structuredClone($form);
+			validateForm().then((result) => ($isFormValid = result.valid));
+		}
+	});
+
+	$effect(() => {
+		if (
+			!isEqual(
+				$superFormErrors,
+				untrack(() => $errors)
+			)
+		) {
+			$errors = getErrors(
+				$superFormErrors,
+				untrack(() => $superFormTained!)
+			);
+		}
+	});
+
+	onDestroy(() => {
+		$form = {};
+		$errors = {};
+		$isFormValid = false;
+	});
+</script>
+
+<Spinner show={isLoading} />
+
+<form
+	class="w-full"
+	id="form"
+	method="POST"
+	action="?/{action}"
+	use:enhance
+	onsubmit={(event) => event.preventDefault()}
+>
+	{@render children()}
+</form>

package/dist/Form/FormController/Form.svelte.d.ts

@@ -0,0 +1,13 @@
+import { type Snippet } from 'svelte';
+import { z } from 'zod';
+declare const Form: import("svelte").Component<{
+    initialData: Record<string, unknown>;
+    action: string;
+    schema: z.ZodObject;
+    extraData?: Record<string, string | number>;
+    onsuccess: (data?: Record<string, unknown>) => void;
+    onfailure?: (status: number | undefined, error: unknown) => void;
+    children: Snippet;
+}, {}, "">;
+type Form = ReturnType<typeof Form>;
+export default Form;

package/dist/Form/FormController/context.d.ts

@@ -0,0 +1,3 @@
+import type { FormContext } from './types.js';
+export declare const setFormContext: <T>() => FormContext<T>;
+export declare const getFormContext: <T>() => FormContext<T>;

package/dist/Form/FormController/context.js

@@ -0,0 +1,15 @@
+import { getContext, setContext } from 'svelte';
+import { writable } from 'svelte/store';
+const formContextKey = Symbol('formContext');
+export const setFormContext = () => {
+    const formContext = {
+        form: writable({}),
+        errors: writable({}),
+        isFormValid: writable(false)
+    };
+    setContext(formContextKey, formContext);
+    return formContext;
+};
+export const getFormContext = () => {
+    return getContext(formContextKey);
+};

package/dist/Form/FormController/helper.d.ts

@@ -0,0 +1,3 @@
+import type z from 'zod';
+export declare const validateSchema: (schema: z.ZodObject, data: z.infer<typeof schema>) => boolean;
+export declare const isEqual: (source: unknown, target: unknown) => boolean;

package/dist/Form/FormController/helper.js

@@ -0,0 +1,24 @@
+export const validateSchema = (schema, data) => {
+    const result = schema.safeParse(data);
+    return result.success;
+};
+export const isEqual = (source, target) => {
+    if (arePrimitivesEqual(source, target))
+        return true;
+    if (Array.isArray(source) && Array.isArray(target))
+        return areArraysEqual(source, target);
+    if (isObject(source) && isObject(target))
+        return areObjectsEqual(source, target);
+    return false;
+};
+const arePrimitivesEqual = (source, target) => source === target;
+const isObject = (object) => object !== null && typeof object === 'object' && !Array.isArray(object);
+const areArraysEqual = (sourceArray, targetArray) => sourceArray.length === targetArray.length &&
+    sourceArray.every((value, index) => isEqual(value, targetArray[index]));
+const areObjectsEqual = (sourceObject, targetObject) => {
+    const keys1 = Object.keys(sourceObject);
+    const keys2 = Object.keys(targetObject);
+    if (keys1.length !== keys2.length)
+        return false;
+    return keys1.every((key) => isEqual(sourceObject[key], targetObject[key]));
+};

package/dist/Form/FormController/types.d.ts

@@ -0,0 +1,7 @@
+import type { Writable } from 'svelte/store';
+export type FormError<T> = Record<keyof T, string[] | undefined>;
+export interface FormContext<T> {
+    form: Writable<T>;
+    errors: Writable<FormError<T>>;
+    isFormValid: Writable<boolean>;
+}

package/dist/Form/FormController/types.js

@@ -0,0 +1 @@
+export {};

package/dist/Form/FormController/zod-validations.d.ts

@@ -0,0 +1,19 @@
+import { type ZodString } from 'zod';
+type Range = {
+    from: number;
+    to: number;
+};
+declare class ZodValidationBuilder {
+    private validator;
+    constructor();
+    range(regex: RegExp, range: Range): this;
+    required(): this;
+    noWhitespace(): this;
+    uuid(): this;
+    min(length: number): this;
+    max(length: number): this;
+    regex(pattern: RegExp, message: string): this;
+    build(): ZodString;
+}
+export declare const createZodString: () => ZodValidationBuilder;
+export {};

package/dist/Form/FormController/zod-validations.js

@@ -0,0 +1,40 @@
+import { z } from 'zod';
+const REGEX_NO_WHITESPACE = /^\S*$/;
+class ZodValidationBuilder {
+    validator;
+    constructor() {
+        this.validator = z.string().trim();
+    }
+    range(regex, range) {
+        this.validator = this.validator.regex(regex, `Must be between ${range.from} and ${range.to}`);
+        return this;
+    }
+    required() {
+        this.validator = this.validator.min(1, 'Required');
+        return this;
+    }
+    noWhitespace() {
+        this.validator = this.validator.regex(REGEX_NO_WHITESPACE, 'Whitespace not allowed');
+        return this;
+    }
+    uuid() {
+        this.validator = this.validator.uuid('Invalid UUID format');
+        return this;
+    }
+    min(length) {
+        this.validator = this.validator.min(length, `Min ${length} characters required`);
+        return this;
+    }
+    max(length) {
+        this.validator = this.validator.max(length, `Max ${length} characters allowed`);
+        return this;
+    }
+    regex(pattern, message) {
+        this.validator = this.validator.regex(pattern, message);
+        return this;
+    }
+    build() {
+        return this.validator;
+    }
+}
+export const createZodString = () => new ZodValidationBuilder();

package/dist/Link/Link.svelte

@@ -0,0 +1,31 @@
+<script lang="ts">
+	import type { Snippet } from 'svelte';
+	import type { HTMLAnchorAttributes } from 'svelte/elements';
+
+	interface Props extends HTMLAnchorAttributes {
+		name?: string;
+		children?: Snippet;
+	}
+
+	let { name, children, ...props }: Props = $props();
+</script>
+
+<a class="link" {...props}>
+	{#if children}
+		{@render children()}
+	{:else}
+		{name}
+	{/if}
+</a>
+
+<style>
+	.link {
+		color: var(--primary-color, #472aff);
+		text-decoration: none;
+	}
+
+	.link:hover,
+	.link:focus-visible {
+		text-decoration: underline;
+	}
+</style>

package/dist/Link/Link.svelte.d.ts

@@ -0,0 +1,9 @@
+import type { Snippet } from 'svelte';
+import type { HTMLAnchorAttributes } from 'svelte/elements';
+interface Props extends HTMLAnchorAttributes {
+    name?: string;
+    children?: Snippet;
+}
+declare const Link: import("svelte").Component<Props, {}, "">;
+type Link = ReturnType<typeof Link>;
+export default Link;

package/dist/Waffle/Waffle.svelte

@@ -31,7 +31,7 @@
 		aria-label="Close waffle menu"
 	></div>
 
-	<aside
+	<div
 		class="waffle-dropdown"
 		transition:fade={{ duration: 250 }}
 		role="dialog"
@@ -49,7 +49,7 @@
 				{/each}
 			</ul>
 		</div>
-	</aside>
+	</div>
 {/if}
 
 <style>

package/dist/index.d.ts

@@ -1,46 +1,56 @@
 import Accordion from './Accordion/Accordion.svelte';
 import Avatar from './Avatar/Avatar.svelte';
 import Breadcrumbs from './Breadcrumbs/Breadcrumbs.svelte';
-import { addBreadcrumbsNameMap, type BreadcrumbsNameMap } from './Breadcrumbs/breadcrumbsState.svelte.js';
 import Button from './Button/Button.svelte';
 import Card from './Card/Card.svelte';
 import Chips from './Chips/Chips.svelte';
-import { ChipType } from './Chips/chipsState.svelte.js';
 import ErrorPage from './ErrorPage/ErrorPage.svelte';
 import Footer from './Footer/Footer.svelte';
-import Input from './Form/Input/Input.svelte';
-import Select from './Form/Select/Select.svelte';
-import type { SelectOption } from './Form/Select/selectState.svelte.js';
-import TextArea from './Form/TextArea/TextArea.svelte';
-import Toggle from './Form/Toggle/Toggle.svelte';
+import Form from './Form/FormController/Form.svelte';
 import Header from './Header/Header.svelte';
 import HeaderAccount from './Header/HeaderAccount.svelte';
 import HeaderLoader from './Header/HeaderLoader.svelte';
 import HeaderLogo from './Header/HeaderLogo.svelte';
 import HighlightPanel from './HighlightPanel/HighlightPanel.svelte';
-import { ColumnType, ImageType, type HighlightPanelColumn } from './HighlightPanel/highlightPanelState.svelte.js';
 import Home from './Home/Home.svelte';
-import type { HomeItem } from './Home/homeState.svelte.js';
+import Input from './Form/Input/Input.svelte';
+import Link from './Link/Link.svelte';
 import Menu from './Menu/Menu.svelte';
-import Sidebar from './Menu/Sidebar.svelte';
-import type { MenuItem } from './Menu/SidebarState.svelte';
 import Modal from './Modal/Modal.svelte';
-import type { ModalProps } from './Modal/modalState.svelte.js';
 import Notification from './Notification/Notification.svelte';
 import Processing from './Processing/Processing.svelte';
 import ProgressPage from './ProgressPage/ProgressPage.svelte';
-import { setProgressWizardStepsContext, getProgressWizardContext } from './ProgressWizard/context.js';
 import ProgressWizard from './ProgressWizard/ProgressWizard.svelte';
-import { setStepValidity, type ProgressWizardStep } from './ProgressWizard/progressWizardState.svelte.js';
 import Search from './Search/Search.svelte';
+import Select from './Form/Select/Select.svelte';
+import Sidebar from './Menu/Sidebar.svelte';
 import Spinner from './Spinner/Spinner.svelte';
 import Switcher from './Switcher/Switcher.svelte';
-import type { SwitcherOption } from './Switcher/switcherState.svelte.js';
 import Tabs from './Tabs/Tabs.svelte';
-import type { Tab } from './Tabs/tabsState.svelte.js';
+import TextArea from './Form/TextArea/TextArea.svelte';
 import Toaster from './Toast/Toast.svelte';
-import { addToast, type Toast } from './Toast/toastState.svelte';
+import Toggle from './Form/Toggle/Toggle.svelte';
 import Tooltip from './Tooltip/Tooltip.svelte';
 import Waffle from './Waffle/Waffle.svelte';
+import { addBreadcrumbsNameMap } from './Breadcrumbs/breadcrumbsState.svelte.js';
+import { ChipType } from './Chips/chipsState.svelte.js';
+import { ColumnType, ImageType } from './HighlightPanel/highlightPanelState.svelte.js';
+import { setProgressWizardStepsContext, getProgressWizardContext } from './ProgressWizard/context.js';
+import { setStepValidity } from './ProgressWizard/progressWizardState.svelte.js';
+import { addToast } from './Toast/toastState.svelte';
+import { setFormContext, getFormContext } from './Form/FormController/context.js';
+import { validateSchema } from './Form/FormController/helper.js';
+import { createZodString } from './Form/FormController/zod-validations.js';
+import type { BreadcrumbsNameMap } from './Breadcrumbs/breadcrumbsState.svelte.js';
+import type { FormError, FormContext } from './Form/FormController/types.js';
+import type { HighlightPanelColumn } from './HighlightPanel/highlightPanelState.svelte.js';
+import type { HomeItem } from './Home/homeState.svelte.js';
+import type { MenuItem } from './Menu/SidebarState.svelte';
+import type { ModalProps } from './Modal/modalState.svelte.js';
+import type { ProgressWizardStep } from './ProgressWizard/progressWizardState.svelte.js';
+import type { SwitcherOption } from './Switcher/switcherState.svelte.js';
+import type { SelectOption } from './Form/Select/selectState.svelte.js';
+import type { Tab } from './Tabs/tabsState.svelte.js';
+import type { Toast } from './Toast/toastState.svelte';
 import type { WaffleItem } from './Waffle/waffleState.svelte.js';
-export { Accordion, addBreadcrumbsNameMap, addToast, Avatar, Breadcrumbs, Button, Card, Chips, ChipType, ColumnType, ErrorPage, Footer, getProgressWizardContext, Header, HeaderAccount, HeaderLoader, HeaderLogo, HighlightPanel, Home, ImageType, Input, Menu, Modal, Notification, Processing, ProgressPage, ProgressWizard, Search, Select, setStepValidity, setProgressWizardStepsContext, Sidebar, Spinner, Switcher, Tabs, TextArea, Toaster, Toggle, Tooltip, Waffle, type BreadcrumbsNameMap, type HighlightPanelColumn, type HomeItem, type MenuItem, type ModalProps, type ProgressWizardStep, type SelectOption, type SwitcherOption, type Tab, type Toast, type WaffleItem };
+export { Accordion, Avatar, Breadcrumbs, Button, Card, Chips, ErrorPage, Footer, Form, Header, HeaderAccount, HeaderLoader, HeaderLogo, HighlightPanel, Home, Input, Link, Menu, Modal, Notification, Processing, ProgressPage, ProgressWizard, Search, Select, Sidebar, Spinner, Switcher, Tabs, TextArea, Toaster, Toggle, Tooltip, Waffle, addBreadcrumbsNameMap, addToast, getProgressWizardContext, setProgressWizardStepsContext, setStepValidity, setFormContext, getFormContext, validateSchema, createZodString, ChipType, ColumnType, ImageType, type BreadcrumbsNameMap, type HighlightPanelColumn, type HomeItem, type MenuItem, type ModalProps, type ProgressWizardStep, type SelectOption, type SwitcherOption, type Tab, type Toast, type WaffleItem, type FormError, type FormContext };

package/dist/index.js

@@ -1,39 +1,52 @@
+// Components
 import Accordion from './Accordion/Accordion.svelte';
 import Avatar from './Avatar/Avatar.svelte';
 import Breadcrumbs from './Breadcrumbs/Breadcrumbs.svelte';
-import { addBreadcrumbsNameMap } from './Breadcrumbs/breadcrumbsState.svelte.js';
 import Button from './Button/Button.svelte';
 import Card from './Card/Card.svelte';
 import Chips from './Chips/Chips.svelte';
-import { ChipType } from './Chips/chipsState.svelte.js';
 import ErrorPage from './ErrorPage/ErrorPage.svelte';
 import Footer from './Footer/Footer.svelte';
-import Input from './Form/Input/Input.svelte';
-import Select from './Form/Select/Select.svelte';
-import TextArea from './Form/TextArea/TextArea.svelte';
-import Toggle from './Form/Toggle/Toggle.svelte';
+import Form from './Form/FormController/Form.svelte';
 import Header from './Header/Header.svelte';
 import HeaderAccount from './Header/HeaderAccount.svelte';
 import HeaderLoader from './Header/HeaderLoader.svelte';
 import HeaderLogo from './Header/HeaderLogo.svelte';
 import HighlightPanel from './HighlightPanel/HighlightPanel.svelte';
-import { ColumnType, ImageType } from './HighlightPanel/highlightPanelState.svelte.js';
 import Home from './Home/Home.svelte';
+import Input from './Form/Input/Input.svelte';
+import Link from './Link/Link.svelte';
 import Menu from './Menu/Menu.svelte';
-import Sidebar from './Menu/Sidebar.svelte';
 import Modal from './Modal/Modal.svelte';
 import Notification from './Notification/Notification.svelte';
 import Processing from './Processing/Processing.svelte';
 import ProgressPage from './ProgressPage/ProgressPage.svelte';
-import { setProgressWizardStepsContext, getProgressWizardContext } from './ProgressWizard/context.js';
 import ProgressWizard from './ProgressWizard/ProgressWizard.svelte';
-import { setStepValidity } from './ProgressWizard/progressWizardState.svelte.js';
 import Search from './Search/Search.svelte';
+import Select from './Form/Select/Select.svelte';
+import Sidebar from './Menu/Sidebar.svelte';
 import Spinner from './Spinner/Spinner.svelte';
 import Switcher from './Switcher/Switcher.svelte';
 import Tabs from './Tabs/Tabs.svelte';
+import TextArea from './Form/TextArea/TextArea.svelte';
 import Toaster from './Toast/Toast.svelte';
-import { addToast } from './Toast/toastState.svelte';
+import Toggle from './Form/Toggle/Toggle.svelte';
 import Tooltip from './Tooltip/Tooltip.svelte';
 import Waffle from './Waffle/Waffle.svelte';
-export { Accordion, addBreadcrumbsNameMap, addToast, Avatar, Breadcrumbs, Button, Card, Chips, ChipType, ColumnType, ErrorPage, Footer, getProgressWizardContext, Header, HeaderAccount, HeaderLoader, HeaderLogo, HighlightPanel, Home, ImageType, Input, Menu, Modal, Notification, Processing, ProgressPage, ProgressWizard, Search, Select, setStepValidity, setProgressWizardStepsContext, Sidebar, Spinner, Switcher, Tabs, TextArea, Toaster, Toggle, Tooltip, Waffle };
+// State, enums, and helpers
+import { addBreadcrumbsNameMap } from './Breadcrumbs/breadcrumbsState.svelte.js';
+import { ChipType } from './Chips/chipsState.svelte.js';
+import { ColumnType, ImageType } from './HighlightPanel/highlightPanelState.svelte.js';
+import { setProgressWizardStepsContext, getProgressWizardContext } from './ProgressWizard/context.js';
+import { setStepValidity } from './ProgressWizard/progressWizardState.svelte.js';
+import { addToast } from './Toast/toastState.svelte';
+import { setFormContext, getFormContext } from './Form/FormController/context.js';
+import { validateSchema } from './Form/FormController/helper.js';
+import { createZodString } from './Form/FormController/zod-validations.js';
+export { 
+// Components
+Accordion, Avatar, Breadcrumbs, Button, Card, Chips, ErrorPage, Footer, Form, Header, HeaderAccount, HeaderLoader, HeaderLogo, HighlightPanel, Home, Input, Link, Menu, Modal, Notification, Processing, ProgressPage, ProgressWizard, Search, Select, Sidebar, Spinner, Switcher, Tabs, TextArea, Toaster, Toggle, Tooltip, Waffle, 
+// Functions and helpers
+addBreadcrumbsNameMap, addToast, getProgressWizardContext, setProgressWizardStepsContext, setStepValidity, setFormContext, getFormContext, validateSchema, createZodString, 
+// Enums
+ChipType, ColumnType, ImageType };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@softwareone/spi-sv5-library",
-	"version": "1.4.0",
+	"version": "1.5.0",
 	"description": "Svelte components",
 	"keywords": [
 		"svelte",
@@ -41,24 +41,35 @@
 		}
 	},
 	"peerDependencies": {
-		"svelte": "^5.0.0"
+		"svelte": "^5.0.0",
+		"sveltekit-superforms": "^2.0.0",
+		"zod": "^4.0.0"
+	},
+	"peerDependenciesMeta": {
+		"sveltekit-superforms": {
+			"optional": true
+		},
+		"zod": {
+			"optional": true
+		}
 	},
 	"devDependencies": {
-		"@sveltejs/adapter-auto": "^4.0.0",
-		"@sveltejs/adapter-node": "^5.2.12",
-		"@sveltejs/kit": "^2.16.0",
-		"@sveltejs/package": "^2.0.0",
-		"@sveltejs/vite-plugin-svelte": "^5.0.0",
-		"prettier": "^3.4.2",
-		"prettier-plugin-svelte": "^3.3.3",
-		"publint": "^0.3.2",
-		"svelte": "^5.0.0",
-		"svelte-check": "^4.0.0",
-		"typescript": "^5.0.0",
-		"vite": "^6.0.0",
-		"zod": "^3.25.76"
+		"@sveltejs/adapter-auto": "^7.0.0",
+		"@sveltejs/adapter-node": "^5.4.0",
+		"@sveltejs/kit": "^2.48.4",
+		"@sveltejs/package": "^2.5.4",
+		"@sveltejs/vite-plugin-svelte": "^6.2.1",
+		"prettier": "^3.6.2",
+		"prettier-plugin-svelte": "^3.4.0",
+		"publint": "^0.3.15",
+		"svelte": "^5.43.5",
+		"svelte-check": "^4.3.3",
+		"typescript": "^5.9.3",
+		"vite": "^6.3.0",
+		"zod": "^4.1.12",
+		"sveltekit-superforms": "^2.28.1"
 	},
 	"dependencies": {
-		"@sveltejs/kit": "^2.16.0"
+		"@sveltejs/kit": "^2.48.4"
 	}
 }