Skip to content

feat: async validator #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
BCsabaEngine wants to merge 3 commits into
base: main
Choose a base branch
from
Open

feat: async validator #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
98807be
feat: async validator
BCsabaEngine Jan 30, 2026
76911ca
feat: add test
BCsabaEngine Jan 30, 2026
795690f
feat: demo page
BCsabaEngine Jan 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions demo/src/App.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

import ActionDemo from './pages/ActionDemo.svelte';
import ArrayProperty from './pages/ArrayProperty.svelte';
import AsyncValidation from './pages/AsyncValidation.svelte';
import BasicValidation from './pages/BasicValidation.svelte';
import CalculatedClass from './pages/CalculatedClass.svelte';
import CalculatedFields from './pages/CalculatedFields.svelte';
Expand All @@ -20,6 +21,7 @@
| 'reset-demo'
| 'snapshot-demo'
| 'action-demo'
| 'async-validation'
| 'options-demo';

const demoModes: { value: DemoMode; name: string }[] = [
Expand All @@ -31,6 +33,7 @@
{ value: 'reset-demo', name: 'Reset' },
{ value: 'snapshot-demo', name: 'Snapshot & Rollback' },
{ value: 'action-demo', name: 'Action & Error' },
{ value: 'async-validation', name: 'Async Validation' },
{ value: 'options-demo', name: 'Options' }
];

Expand Down Expand Up @@ -137,6 +140,8 @@
<SnapshotDemo />
{:else if selectedMode === 'action-demo'}
<ActionDemo />
{:else if selectedMode === 'async-validation'}
<AsyncValidation />
{:else if selectedMode === 'options-demo'}
<OptionsDemo />
{/if}
Expand Down
261 changes: 261 additions & 0 deletions demo/src/pages/AsyncValidation.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,261 @@
<script lang="ts">
import { createSvState, stringValidator } from 'svstate';

import CodeBlock from '$components/CodeBlock.svelte';
import DemoSidebar from '$components/DemoSidebar.svelte';
import FormField from '$components/FormField.svelte';
import PageLayout from '$components/PageLayout.svelte';
import SourceCodeSection from '$components/SourceCodeSection.svelte';
import StatusBadges from '$components/StatusBadges.svelte';
import { randomId } from '$lib/utilities';

// Simulated taken usernames and emails
const takenUsernames = ['admin', 'user', 'test', 'demo', 'root'];
const takenEmails = ['admin@example.com', 'test@example.com', 'user@example.com'];

const sourceData = {
username: '',
email: ''
};

const {
data,
state: { errors, hasErrors, isDirty, asyncErrors, hasAsyncErrors, asyncValidating, hasCombinedErrors }
} = createSvState(sourceData, {
validator: (source) => ({
username: stringValidator(source.username).prepare('trim').required().minLength(3).maxLength(20).noSpace().getError(),
email: stringValidator(source.email).prepare('trim').required().email().getError()
}),
asyncValidator: {
username: async (value, _source, signal) => {
// Simulate API delay (500ms)
await new Promise((resolve, reject) => {
const timeout = setTimeout(resolve, 500);
signal.addEventListener('abort', () => {
clearTimeout(timeout);
reject(new DOMException('Aborted', 'AbortError'));
});
});

const username = String(value).toLowerCase();
return takenUsernames.includes(username) ? 'Username is already taken' : '';
},
email: async (value, _source, signal) => {
// Simulate API delay (300ms)
await new Promise((resolve, reject) => {
const timeout = setTimeout(resolve, 300);
signal.addEventListener('abort', () => {
clearTimeout(timeout);
reject(new DOMException('Aborted', 'AbortError'));
});
});

const email = String(value).toLowerCase();
return takenEmails.includes(email) ? 'Email is already registered' : '';
}
}
});

const fillWithValidData = () => {
data.username = `newuser${randomId()}`;
data.email = `${randomId()}@example.com`;
};

const fillWithTakenData = () => {
data.username = 'admin';
data.email = 'admin@example.com';
};

// ─────────────────────────────────────────────
// Source code examples for the collapsible section
// ─────────────────────────────────────────────
const stateSourceCode = `const { data, state: { errors, hasErrors, asyncErrors, hasAsyncErrors, asyncValidating, hasCombinedErrors } } =
createSvState(sourceData, {
validator: (source) => ({
username: stringValidator(source.username).required().minLength(3).noSpace().getError(),
email: stringValidator(source.email).required().email().getError()
}),
asyncValidator: {
username: async (value, source, signal) => {
const res = await fetch(\`/api/check-username?u=\${value}\`, { signal });
const { available } = await res.json();
return available ? '' : 'Username already taken';
},
email: async (value, source, signal) => {
const res = await fetch(\`/api/check-email?e=\${value}\`, { signal });
const { available } = await res.json();
return available ? '' : 'Email already registered';
}
}
},
{ debounceAsyncValidation: 300 } // default is 300ms
);`;

const templateSourceCode = `<!-- Show loading spinner when validating -->
{#if $asyncValidating.includes('username')}
<span class="animate-spin">...</span>
{/if}

<!-- Show async error -->
{#if $asyncErrors.username}
<span class="text-red-500">{$asyncErrors.username}</span>
{/if}

<!-- Disable submit when any errors -->
<button disabled={$hasCombinedErrors}>Submit</button>`;

const storesSourceCode = `// Available stores for async validation:
$errors // Sync validation errors (nested object)
$hasErrors // true if any sync errors

$asyncErrors // Async validation errors (flat map by path)
$hasAsyncErrors // true if any async errors

$asyncValidating // Array of paths currently being validated
$hasCombinedErrors // hasErrors || hasAsyncErrors`;
</script>

<PageLayout
description="Demonstrates async validation with simulated API calls for username and email uniqueness checks."
title="Async Validation Demo"
>
{#snippet main()}
<StatusBadges hasErrors={$hasErrors} isDirty={$isDirty} />

<div class="mb-4 flex flex-wrap items-center gap-2">
<span
class="rounded px-2.5 py-0.5 text-xs font-medium {$hasAsyncErrors
? 'bg-red-100 text-red-800'
: 'bg-gray-100 text-gray-800'}"
>
Async Errors: {$hasAsyncErrors ? 'Yes' : 'No'}
</span>
<span
class="rounded px-2.5 py-0.5 text-xs font-medium {$hasCombinedErrors
? 'bg-red-100 text-red-800'
: 'bg-green-100 text-green-800'}"
>
Combined: {$hasCombinedErrors ? 'Has Errors' : 'Valid'}
</span>
</div>

<div class="space-y-4">
<div class="relative">
<FormField
id="username"
error={$errors?.username || $asyncErrors.username}
label="Username"
placeholder="Enter username (try 'admin', 'user', 'test')"
bind:value={data.username}
/>
{#if $asyncValidating.includes('username')}
<div class="absolute right-3 top-9">
<svg class="h-5 w-5 animate-spin text-blue-500" fill="none" viewBox="0 0 24 24">
<circle class="opacity-25" cx="12" cy="12" r="10" stroke="currentColor" stroke-width="4"></circle>
<path
class="opacity-75"
d="M4 12a8 8 0 018-8V0C5.373 0 0 5.373 0 12h4zm2 5.291A7.962 7.962 0 014 12H0c0 3.042 1.135 5.824 3 7.938l3-2.647z"
fill="currentColor"
></path>
</svg>
</div>
{/if}
</div>

<div class="relative">
<FormField
id="email"
error={$errors?.email || $asyncErrors.email}
label="Email"
placeholder="Enter email (try 'admin@example.com')"
type="email"
bind:value={data.email}
/>
{#if $asyncValidating.includes('email')}
<div class="absolute right-3 top-9">
<svg class="h-5 w-5 animate-spin text-blue-500" fill="none" viewBox="0 0 24 24">
<circle class="opacity-25" cx="12" cy="12" r="10" stroke="currentColor" stroke-width="4"></circle>
<path
class="opacity-75"
d="M4 12a8 8 0 018-8V0C5.373 0 0 5.373 0 12h4zm2 5.291A7.962 7.962 0 014 12H0c0 3.042 1.135 5.824 3 7.938l3-2.647z"
fill="currentColor"
></path>
</svg>
</div>
{/if}
</div>
</div>

<div class="mt-4 rounded-lg border border-blue-200 bg-blue-50 p-3">
<div class="text-sm text-blue-800">
<span class="font-medium">Taken usernames:</span> {takenUsernames.join(', ')}
</div>
<div class="mt-1 text-sm text-blue-800">
<span class="font-medium">Taken emails:</span> {takenEmails.join(', ')}
</div>
</div>

<div class="mt-6 flex gap-2">
<button
class="flex-1 cursor-pointer rounded-lg bg-green-600 px-4 py-2 text-sm font-medium text-white hover:bg-green-700 focus:outline-none focus:ring-2 focus:ring-green-500 disabled:cursor-not-allowed disabled:opacity-50"
disabled={$hasCombinedErrors || $asyncValidating.length > 0}
type="button"
>
{#if $asyncValidating.length > 0}
<span class="inline-flex items-center gap-2">
<svg class="h-4 w-4 animate-spin" fill="none" viewBox="0 0 24 24">
<circle class="opacity-25" cx="12" cy="12" r="10" stroke="currentColor" stroke-width="4"></circle>
<path
class="opacity-75"
d="M4 12a8 8 0 018-8V0C5.373 0 0 5.373 0 12h4zm2 5.291A7.962 7.962 0 014 12H0c0 3.042 1.135 5.824 3 7.938l3-2.647z"
fill="currentColor"
></path>
</svg>
Validating...
</span>
{:else}
Submit
{/if}
</button>
</div>
{/snippet}

{#snippet sidebar()}
<div class="w-full flex-shrink-0 space-y-4 xl:w-80">
<DemoSidebar {data} errors={$errors} hasErrors={$hasErrors} isDirty={$isDirty} onFill={fillWithValidData} />

<div class="rounded-lg border border-gray-300 bg-gray-50 p-4 shadow-inner">
<h6 class="mb-2 text-sm font-medium text-gray-700">Quick Fill</h6>
<button
class="w-full cursor-pointer rounded bg-orange-100 px-3 py-1.5 text-sm text-orange-800 hover:bg-orange-200"
onclick={fillWithTakenData}
type="button"
>
Fill with taken values
</button>
</div>

<div class="rounded-lg border border-gray-300 bg-gray-50 p-4 shadow-inner">
<h6 class="mb-2 text-sm font-medium text-gray-700">Async Validation State</h6>
<div class="space-y-1 text-xs text-gray-600">
<div><span class="font-medium">asyncValidating:</span> [{$asyncValidating.join(', ')}]</div>
<div><span class="font-medium">hasAsyncErrors:</span> {$hasAsyncErrors}</div>
<div><span class="font-medium">hasCombinedErrors:</span> {$hasCombinedErrors}</div>
</div>
</div>

<div class="rounded-lg border border-gray-300 bg-gray-50 p-4 shadow-inner">
<h6 class="mb-2 text-sm font-medium text-gray-700">Async Errors</h6>
<pre class="overflow-auto text-xs text-gray-600">{JSON.stringify($asyncErrors, null, 2)}</pre>
</div>
</div>
{/snippet}

{#snippet sourceCode()}
<SourceCodeSection>
<CodeBlock code={stateSourceCode} title="State Setup with Async Validators" />
<CodeBlock code={templateSourceCode} title="Template Usage" />
<CodeBlock code={storesSourceCode} title="Available Stores" />
</SourceCodeSection>
{/snippet}
</PageLayout>
3 changes: 3 additions & 0 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
export {
type AsyncErrors,
type AsyncValidator,
type AsyncValidatorFunction,
createSvState,
type EffectContext,
type Snapshot,
Expand Down
Loading