@getmicdrop/svelte-components 5.3.14 → 5.3.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/forms/createFieldTracker.svelte.d.ts +41 -0
- package/dist/forms/createFieldTracker.svelte.d.ts.map +1 -0
- package/dist/forms/createFieldTracker.svelte.js +94 -0
- package/dist/forms/createFormStore.svelte.d.ts +47 -0
- package/dist/forms/createFormStore.svelte.d.ts.map +1 -0
- package/dist/forms/createFormStore.svelte.js +223 -0
- package/dist/forms/index.d.ts +61 -0
- package/dist/forms/index.d.ts.map +1 -0
- package/dist/forms/index.js +60 -0
- package/dist/stores/createFormStore.d.ts +3 -0
- package/dist/stores/createFormStore.d.ts.map +1 -1
- package/dist/stores/createFormStore.js +24 -0
- package/dist/stores/index.d.ts +6 -0
- package/dist/stores/index.js +10 -0
- package/package.json +77 -65
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Field Tracker
|
|
3
|
+
*
|
|
4
|
+
* For forms that use individual $state fields instead of a single formData object.
|
|
5
|
+
* Provides the same UI state management (isSaving, isSaved, etc.) without
|
|
6
|
+
* managing the data directly.
|
|
7
|
+
*
|
|
8
|
+
* @example
|
|
9
|
+
* ```typescript
|
|
10
|
+
* import { createFieldTracker } from '@getmicdrop/svelte-components/forms';
|
|
11
|
+
*
|
|
12
|
+
* // Your individual fields
|
|
13
|
+
* let name = $state('');
|
|
14
|
+
* let email = $state('');
|
|
15
|
+
*
|
|
16
|
+
* // Create tracker with a function that computes isDirty
|
|
17
|
+
* const tracker = createFieldTracker(() => {
|
|
18
|
+
* if (!originalData) return false;
|
|
19
|
+
* return name !== originalData.name || email !== originalData.email;
|
|
20
|
+
* });
|
|
21
|
+
*
|
|
22
|
+
* // In save function:
|
|
23
|
+
* async function handleSave() {
|
|
24
|
+
* const result = await tracker.save(async () => {
|
|
25
|
+
* return await api.save({ name, email });
|
|
26
|
+
* });
|
|
27
|
+
* }
|
|
28
|
+
* ```
|
|
29
|
+
*/
|
|
30
|
+
export interface FieldTracker {
|
|
31
|
+
isLoading: boolean;
|
|
32
|
+
isSaving: boolean;
|
|
33
|
+
isSaved: boolean;
|
|
34
|
+
readonly isDirty: boolean;
|
|
35
|
+
canSave: (isValid: boolean) => boolean;
|
|
36
|
+
reset: () => void;
|
|
37
|
+
markSaved: () => void;
|
|
38
|
+
save: <R>(fn: () => Promise<R>) => Promise<R | undefined>;
|
|
39
|
+
}
|
|
40
|
+
export declare function createFieldTracker(isDirtyFn: () => boolean): FieldTracker;
|
|
41
|
+
//# sourceMappingURL=createFieldTracker.svelte.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"createFieldTracker.svelte.d.ts","sourceRoot":"","sources":["../../src/lib/forms/createFieldTracker.svelte.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AAMH,MAAM,WAAW,YAAY;IAE3B,SAAS,EAAE,OAAO,CAAC;IACnB,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,EAAE,OAAO,CAAC;IAGjB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAG1B,OAAO,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC;IAGvC,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,SAAS,EAAE,MAAM,IAAI,CAAC;IACtB,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;CAC3D;AAMD,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,MAAM,OAAO,GAAG,YAAY,CAqEzE"}
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Field Tracker
|
|
3
|
+
*
|
|
4
|
+
* For forms that use individual $state fields instead of a single formData object.
|
|
5
|
+
* Provides the same UI state management (isSaving, isSaved, etc.) without
|
|
6
|
+
* managing the data directly.
|
|
7
|
+
*
|
|
8
|
+
* @example
|
|
9
|
+
* ```typescript
|
|
10
|
+
* import { createFieldTracker } from '@getmicdrop/svelte-components/forms';
|
|
11
|
+
*
|
|
12
|
+
* // Your individual fields
|
|
13
|
+
* let name = $state('');
|
|
14
|
+
* let email = $state('');
|
|
15
|
+
*
|
|
16
|
+
* // Create tracker with a function that computes isDirty
|
|
17
|
+
* const tracker = createFieldTracker(() => {
|
|
18
|
+
* if (!originalData) return false;
|
|
19
|
+
* return name !== originalData.name || email !== originalData.email;
|
|
20
|
+
* });
|
|
21
|
+
*
|
|
22
|
+
* // In save function:
|
|
23
|
+
* async function handleSave() {
|
|
24
|
+
* const result = await tracker.save(async () => {
|
|
25
|
+
* return await api.save({ name, email });
|
|
26
|
+
* });
|
|
27
|
+
* }
|
|
28
|
+
* ```
|
|
29
|
+
*/
|
|
30
|
+
// ============================================================================
|
|
31
|
+
// Implementation
|
|
32
|
+
// ============================================================================
|
|
33
|
+
export function createFieldTracker(isDirtyFn) {
|
|
34
|
+
let isLoading = $state(false);
|
|
35
|
+
let isSaving = $state(false);
|
|
36
|
+
let isSaved = $state(false);
|
|
37
|
+
// Use the provided function to compute isDirty
|
|
38
|
+
const isDirty = $derived(isDirtyFn());
|
|
39
|
+
// Auto-reset isSaved when form becomes dirty
|
|
40
|
+
$effect(() => {
|
|
41
|
+
if (isDirty && isSaved) {
|
|
42
|
+
isSaved = false;
|
|
43
|
+
}
|
|
44
|
+
});
|
|
45
|
+
function canSave(isValid) {
|
|
46
|
+
return isDirty && isValid && !isSaving;
|
|
47
|
+
}
|
|
48
|
+
function reset() {
|
|
49
|
+
isLoading = false;
|
|
50
|
+
isSaving = false;
|
|
51
|
+
isSaved = false;
|
|
52
|
+
}
|
|
53
|
+
function markSaved() {
|
|
54
|
+
isSaved = true;
|
|
55
|
+
}
|
|
56
|
+
async function save(fn) {
|
|
57
|
+
isSaving = true;
|
|
58
|
+
try {
|
|
59
|
+
const result = await fn();
|
|
60
|
+
isSaved = true;
|
|
61
|
+
return result;
|
|
62
|
+
}
|
|
63
|
+
finally {
|
|
64
|
+
isSaving = false;
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
return {
|
|
68
|
+
get isLoading() {
|
|
69
|
+
return isLoading;
|
|
70
|
+
},
|
|
71
|
+
set isLoading(value) {
|
|
72
|
+
isLoading = value;
|
|
73
|
+
},
|
|
74
|
+
get isSaving() {
|
|
75
|
+
return isSaving;
|
|
76
|
+
},
|
|
77
|
+
set isSaving(value) {
|
|
78
|
+
isSaving = value;
|
|
79
|
+
},
|
|
80
|
+
get isSaved() {
|
|
81
|
+
return isSaved;
|
|
82
|
+
},
|
|
83
|
+
set isSaved(value) {
|
|
84
|
+
isSaved = value;
|
|
85
|
+
},
|
|
86
|
+
get isDirty() {
|
|
87
|
+
return isDirty;
|
|
88
|
+
},
|
|
89
|
+
canSave,
|
|
90
|
+
reset,
|
|
91
|
+
markSaved,
|
|
92
|
+
save,
|
|
93
|
+
};
|
|
94
|
+
}
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Form Store Factory
|
|
3
|
+
*
|
|
4
|
+
* Creates a reactive form store with standardized patterns for:
|
|
5
|
+
* - Dirty tracking
|
|
6
|
+
* - Zod validation
|
|
7
|
+
* - UI states (loading, saving, saved)
|
|
8
|
+
* - Section-level validation for progressive forms
|
|
9
|
+
*/
|
|
10
|
+
import { z } from 'zod';
|
|
11
|
+
export interface FormStoreOptions<T> {
|
|
12
|
+
/**
|
|
13
|
+
* Optional sections for progressive form validation.
|
|
14
|
+
* Keys are section names, values are arrays of field names.
|
|
15
|
+
* @example { basics: ['name', 'email'], details: ['bio'] }
|
|
16
|
+
*/
|
|
17
|
+
sections?: Record<string, (keyof T)[]>;
|
|
18
|
+
/**
|
|
19
|
+
* Mode: 'create' forms are dirty when any field has a value,
|
|
20
|
+
* 'edit' forms compare against original data.
|
|
21
|
+
* @default 'edit'
|
|
22
|
+
*/
|
|
23
|
+
mode?: 'create' | 'edit';
|
|
24
|
+
}
|
|
25
|
+
export interface FormStore<T extends Record<string, unknown>> {
|
|
26
|
+
data: T;
|
|
27
|
+
originalData: T | null;
|
|
28
|
+
errors: Partial<Record<keyof T, string>>;
|
|
29
|
+
isLoading: boolean;
|
|
30
|
+
isSaving: boolean;
|
|
31
|
+
isSaved: boolean;
|
|
32
|
+
showErrors: boolean;
|
|
33
|
+
readonly isDirty: boolean;
|
|
34
|
+
readonly isValid: boolean;
|
|
35
|
+
readonly canSave: boolean;
|
|
36
|
+
setOriginal: (data: T) => void;
|
|
37
|
+
validate: () => boolean;
|
|
38
|
+
validateField: (field: keyof T) => string | undefined;
|
|
39
|
+
fieldError: (field: keyof T) => string | undefined;
|
|
40
|
+
isSectionValid: (section: string) => boolean;
|
|
41
|
+
isSectionDirty: (section: string) => boolean;
|
|
42
|
+
reset: () => void;
|
|
43
|
+
resetToOriginal: () => void;
|
|
44
|
+
save: <R>(fn: () => Promise<R>) => Promise<R | undefined>;
|
|
45
|
+
}
|
|
46
|
+
export declare function createFormStore<T extends Record<string, unknown>>(schema: z.ZodSchema<T>, initialData: T, options?: FormStoreOptions<T>): FormStore<T>;
|
|
47
|
+
//# sourceMappingURL=createFormStore.svelte.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"createFormStore.svelte.d.ts","sourceRoot":"","sources":["../../src/lib/forms/createFormStore.svelte.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAMxB,MAAM,WAAW,gBAAgB,CAAC,CAAC;IACjC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC;IAEvC;;;;OAIG;IACH,IAAI,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,SAAS,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAE1D,IAAI,EAAE,CAAC,CAAC;IACR,YAAY,EAAE,CAAC,GAAG,IAAI,CAAC;IACvB,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;IAGzC,SAAS,EAAE,OAAO,CAAC;IACnB,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,OAAO,CAAC;IAGpB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAG1B,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,CAAC;IAC/B,QAAQ,EAAE,MAAM,OAAO,CAAC;IACxB,aAAa,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,MAAM,GAAG,SAAS,CAAC;IACtD,UAAU,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,MAAM,GAAG,SAAS,CAAC;IACnD,cAAc,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC;IAC7C,cAAc,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC;IAC7C,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,eAAe,EAAE,MAAM,IAAI,CAAC;IAG5B,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;CAC3D;AAMD,wBAAgB,eAAe,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/D,MAAM,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EACtB,WAAW,EAAE,CAAC,EACd,OAAO,GAAE,gBAAgB,CAAC,CAAC,CAAM,GAChC,SAAS,CAAC,CAAC,CAAC,CAyOd"}
|
|
@@ -0,0 +1,223 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Form Store Factory
|
|
3
|
+
*
|
|
4
|
+
* Creates a reactive form store with standardized patterns for:
|
|
5
|
+
* - Dirty tracking
|
|
6
|
+
* - Zod validation
|
|
7
|
+
* - UI states (loading, saving, saved)
|
|
8
|
+
* - Section-level validation for progressive forms
|
|
9
|
+
*/
|
|
10
|
+
import { z } from 'zod';
|
|
11
|
+
// ============================================================================
|
|
12
|
+
// Implementation
|
|
13
|
+
// ============================================================================
|
|
14
|
+
export function createFormStore(schema, initialData, options = {}) {
|
|
15
|
+
const { sections = {}, mode = 'edit' } = options;
|
|
16
|
+
// ---------------------------------------------------------------------------
|
|
17
|
+
// State
|
|
18
|
+
// ---------------------------------------------------------------------------
|
|
19
|
+
let data = $state({ ...initialData });
|
|
20
|
+
let originalData = $state(null);
|
|
21
|
+
let errors = $state({});
|
|
22
|
+
let isLoading = $state(false);
|
|
23
|
+
let isSaving = $state(false);
|
|
24
|
+
let isSaved = $state(false);
|
|
25
|
+
let showErrors = $state(false);
|
|
26
|
+
// ---------------------------------------------------------------------------
|
|
27
|
+
// Derived States
|
|
28
|
+
// ---------------------------------------------------------------------------
|
|
29
|
+
const isDirty = $derived.by(() => {
|
|
30
|
+
if (mode === 'create') {
|
|
31
|
+
// In create mode, dirty if any field has a non-empty value
|
|
32
|
+
return Object.values(data).some(value => {
|
|
33
|
+
if (Array.isArray(value))
|
|
34
|
+
return value.length > 0;
|
|
35
|
+
if (typeof value === 'string')
|
|
36
|
+
return value.trim() !== '';
|
|
37
|
+
if (typeof value === 'number')
|
|
38
|
+
return true;
|
|
39
|
+
if (typeof value === 'boolean')
|
|
40
|
+
return value !== false;
|
|
41
|
+
return value !== null && value !== undefined;
|
|
42
|
+
});
|
|
43
|
+
}
|
|
44
|
+
// In edit mode, compare to original
|
|
45
|
+
if (!originalData)
|
|
46
|
+
return false;
|
|
47
|
+
return JSON.stringify(data) !== JSON.stringify(originalData);
|
|
48
|
+
});
|
|
49
|
+
const isValid = $derived.by(() => {
|
|
50
|
+
const result = schema.safeParse(data);
|
|
51
|
+
return result.success;
|
|
52
|
+
});
|
|
53
|
+
const canSave = $derived(isDirty && isValid && !isSaving);
|
|
54
|
+
// Auto-reset isSaved when form becomes dirty
|
|
55
|
+
$effect(() => {
|
|
56
|
+
if (isDirty && isSaved) {
|
|
57
|
+
isSaved = false;
|
|
58
|
+
}
|
|
59
|
+
});
|
|
60
|
+
// ---------------------------------------------------------------------------
|
|
61
|
+
// Methods
|
|
62
|
+
// ---------------------------------------------------------------------------
|
|
63
|
+
function setOriginal(newData) {
|
|
64
|
+
originalData = { ...newData };
|
|
65
|
+
data = { ...newData };
|
|
66
|
+
errors = {};
|
|
67
|
+
showErrors = false;
|
|
68
|
+
isSaved = false;
|
|
69
|
+
}
|
|
70
|
+
function validate() {
|
|
71
|
+
showErrors = true;
|
|
72
|
+
const result = schema.safeParse(data);
|
|
73
|
+
if (!result.success) {
|
|
74
|
+
const fieldErrors = {};
|
|
75
|
+
for (const issue of result.error.issues) {
|
|
76
|
+
const field = issue.path[0];
|
|
77
|
+
if (!fieldErrors[field]) {
|
|
78
|
+
fieldErrors[field] = issue.message;
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
errors = fieldErrors;
|
|
82
|
+
return false;
|
|
83
|
+
}
|
|
84
|
+
errors = {};
|
|
85
|
+
return true;
|
|
86
|
+
}
|
|
87
|
+
function validateField(field) {
|
|
88
|
+
// Create a partial schema for just this field if possible
|
|
89
|
+
const result = schema.safeParse(data);
|
|
90
|
+
if (result.success)
|
|
91
|
+
return undefined;
|
|
92
|
+
const fieldIssue = result.error.issues.find(issue => issue.path[0] === field);
|
|
93
|
+
return fieldIssue?.message;
|
|
94
|
+
}
|
|
95
|
+
function fieldError(field) {
|
|
96
|
+
if (!showErrors)
|
|
97
|
+
return undefined;
|
|
98
|
+
return errors[field];
|
|
99
|
+
}
|
|
100
|
+
function isSectionValid(sectionName) {
|
|
101
|
+
const sectionFields = sections[sectionName];
|
|
102
|
+
if (!sectionFields)
|
|
103
|
+
return true;
|
|
104
|
+
// Check each field in the section
|
|
105
|
+
const result = schema.safeParse(data);
|
|
106
|
+
if (result.success)
|
|
107
|
+
return true;
|
|
108
|
+
// Check if any errors are in this section's fields
|
|
109
|
+
const sectionErrors = result.error.issues.filter(issue => sectionFields.includes(issue.path[0]));
|
|
110
|
+
return sectionErrors.length === 0;
|
|
111
|
+
}
|
|
112
|
+
function isSectionDirty(sectionName) {
|
|
113
|
+
const sectionFields = sections[sectionName];
|
|
114
|
+
if (!sectionFields || !originalData)
|
|
115
|
+
return false;
|
|
116
|
+
return sectionFields.some(field => {
|
|
117
|
+
const currentVal = JSON.stringify(data[field]);
|
|
118
|
+
const originalVal = JSON.stringify(originalData[field]);
|
|
119
|
+
return currentVal !== originalVal;
|
|
120
|
+
});
|
|
121
|
+
}
|
|
122
|
+
function reset() {
|
|
123
|
+
data = { ...initialData };
|
|
124
|
+
originalData = null;
|
|
125
|
+
errors = {};
|
|
126
|
+
showErrors = false;
|
|
127
|
+
isLoading = false;
|
|
128
|
+
isSaving = false;
|
|
129
|
+
isSaved = false;
|
|
130
|
+
}
|
|
131
|
+
function resetToOriginal() {
|
|
132
|
+
if (originalData) {
|
|
133
|
+
data = { ...originalData };
|
|
134
|
+
errors = {};
|
|
135
|
+
showErrors = false;
|
|
136
|
+
isSaved = false;
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
async function save(fn) {
|
|
140
|
+
if (!validate())
|
|
141
|
+
return undefined;
|
|
142
|
+
isSaving = true;
|
|
143
|
+
try {
|
|
144
|
+
const result = await fn();
|
|
145
|
+
// Update original to current (form is now clean)
|
|
146
|
+
originalData = { ...data };
|
|
147
|
+
isSaved = true;
|
|
148
|
+
return result;
|
|
149
|
+
}
|
|
150
|
+
finally {
|
|
151
|
+
isSaving = false;
|
|
152
|
+
}
|
|
153
|
+
}
|
|
154
|
+
// ---------------------------------------------------------------------------
|
|
155
|
+
// Return Store Interface
|
|
156
|
+
// ---------------------------------------------------------------------------
|
|
157
|
+
return {
|
|
158
|
+
// Data (read/write via getters/setters)
|
|
159
|
+
get data() {
|
|
160
|
+
return data;
|
|
161
|
+
},
|
|
162
|
+
set data(value) {
|
|
163
|
+
data = value;
|
|
164
|
+
},
|
|
165
|
+
get originalData() {
|
|
166
|
+
return originalData;
|
|
167
|
+
},
|
|
168
|
+
set originalData(value) {
|
|
169
|
+
originalData = value;
|
|
170
|
+
},
|
|
171
|
+
get errors() {
|
|
172
|
+
return errors;
|
|
173
|
+
},
|
|
174
|
+
set errors(value) {
|
|
175
|
+
errors = value;
|
|
176
|
+
},
|
|
177
|
+
// UI States (read/write)
|
|
178
|
+
get isLoading() {
|
|
179
|
+
return isLoading;
|
|
180
|
+
},
|
|
181
|
+
set isLoading(value) {
|
|
182
|
+
isLoading = value;
|
|
183
|
+
},
|
|
184
|
+
get isSaving() {
|
|
185
|
+
return isSaving;
|
|
186
|
+
},
|
|
187
|
+
set isSaving(value) {
|
|
188
|
+
isSaving = value;
|
|
189
|
+
},
|
|
190
|
+
get isSaved() {
|
|
191
|
+
return isSaved;
|
|
192
|
+
},
|
|
193
|
+
set isSaved(value) {
|
|
194
|
+
isSaved = value;
|
|
195
|
+
},
|
|
196
|
+
get showErrors() {
|
|
197
|
+
return showErrors;
|
|
198
|
+
},
|
|
199
|
+
set showErrors(value) {
|
|
200
|
+
showErrors = value;
|
|
201
|
+
},
|
|
202
|
+
// Derived States (readonly)
|
|
203
|
+
get isDirty() {
|
|
204
|
+
return isDirty;
|
|
205
|
+
},
|
|
206
|
+
get isValid() {
|
|
207
|
+
return isValid;
|
|
208
|
+
},
|
|
209
|
+
get canSave() {
|
|
210
|
+
return canSave;
|
|
211
|
+
},
|
|
212
|
+
// Methods
|
|
213
|
+
setOriginal,
|
|
214
|
+
validate,
|
|
215
|
+
validateField,
|
|
216
|
+
fieldError,
|
|
217
|
+
isSectionValid,
|
|
218
|
+
isSectionDirty,
|
|
219
|
+
reset,
|
|
220
|
+
resetToOriginal,
|
|
221
|
+
save,
|
|
222
|
+
};
|
|
223
|
+
}
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Form Utilities
|
|
3
|
+
*
|
|
4
|
+
* Provides standardized form state management with:
|
|
5
|
+
* - Dirty tracking (original vs current)
|
|
6
|
+
* - Zod validation
|
|
7
|
+
* - Loading/saving/saved states
|
|
8
|
+
* - Section-level validation for progressive forms
|
|
9
|
+
*
|
|
10
|
+
* @example Basic usage with formData object
|
|
11
|
+
* ```typescript
|
|
12
|
+
* import { createFormStore } from '@getmicdrop/svelte-components/forms';
|
|
13
|
+
* import { z } from 'zod';
|
|
14
|
+
*
|
|
15
|
+
* const schema = z.object({
|
|
16
|
+
* name: z.string().min(1, 'Name is required'),
|
|
17
|
+
* email: z.string().email('Invalid email'),
|
|
18
|
+
* });
|
|
19
|
+
*
|
|
20
|
+
* const form = createFormStore(schema, { name: '', email: '' });
|
|
21
|
+
*
|
|
22
|
+
* // In component:
|
|
23
|
+
* <Input bind:value={form.data.name} error={form.fieldError('name')} />
|
|
24
|
+
* <Button disabled={!form.canSave} loading={form.isSaving} success={form.isSaved}>
|
|
25
|
+
* Save
|
|
26
|
+
* </Button>
|
|
27
|
+
* ```
|
|
28
|
+
*
|
|
29
|
+
* @example Progressive form with sections
|
|
30
|
+
* ```typescript
|
|
31
|
+
* const form = createFormStore(schema, initialData, {
|
|
32
|
+
* sections: {
|
|
33
|
+
* basics: ['name', 'email'],
|
|
34
|
+
* details: ['bio', 'website'],
|
|
35
|
+
* }
|
|
36
|
+
* });
|
|
37
|
+
*
|
|
38
|
+
* // Check if section is complete
|
|
39
|
+
* {#if form.isSectionValid('basics')}
|
|
40
|
+
* <DetailsSection />
|
|
41
|
+
* {/if}
|
|
42
|
+
* ```
|
|
43
|
+
*
|
|
44
|
+
* @example Field tracker for individual $state fields
|
|
45
|
+
* ```typescript
|
|
46
|
+
* import { createFieldTracker } from '@getmicdrop/svelte-components/forms';
|
|
47
|
+
*
|
|
48
|
+
* let name = $state('');
|
|
49
|
+
* let email = $state('');
|
|
50
|
+
* let originalData = $state({ name: '', email: '' });
|
|
51
|
+
*
|
|
52
|
+
* const tracker = createFieldTracker(() => {
|
|
53
|
+
* return name !== originalData.name || email !== originalData.email;
|
|
54
|
+
* });
|
|
55
|
+
*
|
|
56
|
+
* // Use tracker.isSaving, tracker.isSaved, tracker.save(), etc.
|
|
57
|
+
* ```
|
|
58
|
+
*/
|
|
59
|
+
export { createFormStore, type FormStoreOptions, type FormStore, } from './createFormStore.svelte';
|
|
60
|
+
export { createFieldTracker, type FieldTracker, } from './createFieldTracker.svelte';
|
|
61
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/lib/forms/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyDG;AAEH,OAAO,EACL,eAAe,EACf,KAAK,gBAAgB,EACrB,KAAK,SAAS,GACf,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACL,kBAAkB,EAClB,KAAK,YAAY,GAClB,MAAM,6BAA6B,CAAC"}
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Form Utilities
|
|
3
|
+
*
|
|
4
|
+
* Provides standardized form state management with:
|
|
5
|
+
* - Dirty tracking (original vs current)
|
|
6
|
+
* - Zod validation
|
|
7
|
+
* - Loading/saving/saved states
|
|
8
|
+
* - Section-level validation for progressive forms
|
|
9
|
+
*
|
|
10
|
+
* @example Basic usage with formData object
|
|
11
|
+
* ```typescript
|
|
12
|
+
* import { createFormStore } from '@getmicdrop/svelte-components/forms';
|
|
13
|
+
* import { z } from 'zod';
|
|
14
|
+
*
|
|
15
|
+
* const schema = z.object({
|
|
16
|
+
* name: z.string().min(1, 'Name is required'),
|
|
17
|
+
* email: z.string().email('Invalid email'),
|
|
18
|
+
* });
|
|
19
|
+
*
|
|
20
|
+
* const form = createFormStore(schema, { name: '', email: '' });
|
|
21
|
+
*
|
|
22
|
+
* // In component:
|
|
23
|
+
* <Input bind:value={form.data.name} error={form.fieldError('name')} />
|
|
24
|
+
* <Button disabled={!form.canSave} loading={form.isSaving} success={form.isSaved}>
|
|
25
|
+
* Save
|
|
26
|
+
* </Button>
|
|
27
|
+
* ```
|
|
28
|
+
*
|
|
29
|
+
* @example Progressive form with sections
|
|
30
|
+
* ```typescript
|
|
31
|
+
* const form = createFormStore(schema, initialData, {
|
|
32
|
+
* sections: {
|
|
33
|
+
* basics: ['name', 'email'],
|
|
34
|
+
* details: ['bio', 'website'],
|
|
35
|
+
* }
|
|
36
|
+
* });
|
|
37
|
+
*
|
|
38
|
+
* // Check if section is complete
|
|
39
|
+
* {#if form.isSectionValid('basics')}
|
|
40
|
+
* <DetailsSection />
|
|
41
|
+
* {/if}
|
|
42
|
+
* ```
|
|
43
|
+
*
|
|
44
|
+
* @example Field tracker for individual $state fields
|
|
45
|
+
* ```typescript
|
|
46
|
+
* import { createFieldTracker } from '@getmicdrop/svelte-components/forms';
|
|
47
|
+
*
|
|
48
|
+
* let name = $state('');
|
|
49
|
+
* let email = $state('');
|
|
50
|
+
* let originalData = $state({ name: '', email: '' });
|
|
51
|
+
*
|
|
52
|
+
* const tracker = createFieldTracker(() => {
|
|
53
|
+
* return name !== originalData.name || email !== originalData.email;
|
|
54
|
+
* });
|
|
55
|
+
*
|
|
56
|
+
* // Use tracker.isSaving, tracker.isSaved, tracker.save(), etc.
|
|
57
|
+
* ```
|
|
58
|
+
*/
|
|
59
|
+
export { createFormStore, } from './createFormStore.svelte';
|
|
60
|
+
export { createFieldTracker, } from './createFieldTracker.svelte';
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
+
* @deprecated Use createFormStore from '@getmicdrop/svelte-components/forms' instead.
|
|
2
3
|
* @typedef {Object} FormStoreOptions
|
|
3
4
|
* @property {Object} initialData - Initial form data
|
|
4
5
|
* @property {string} [endpoint] - API endpoint for saving
|
|
@@ -11,6 +12,8 @@
|
|
|
11
12
|
* @property {boolean} [showToasts=true] - Show toast notifications
|
|
12
13
|
*/
|
|
13
14
|
/**
|
|
15
|
+
* @deprecated Use createFormStore from '@getmicdrop/svelte-components/forms' instead.
|
|
16
|
+
*
|
|
14
17
|
* Creates a comprehensive form store with state management, dirty tracking,
|
|
15
18
|
* validation, and save handling.
|
|
16
19
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"createFormStore.d.ts","sourceRoot":"","sources":["../../src/lib/stores/createFormStore.js"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"createFormStore.d.ts","sourceRoot":"","sources":["../../src/lib/stores/createFormStore.js"],"names":[],"mappings":"AAoBA;;;;;;;;;;;;GAYG;AAEH;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,0CAlBW,gBAAgB,GACd,MAAM,CAgXlB;;;;;iBAlYa,MAAM"}
|
|
@@ -1,7 +1,25 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @deprecated Use `@getmicdrop/svelte-components/forms` instead.
|
|
3
|
+
* This Svelte 4 store-based implementation will be removed in the next major version.
|
|
4
|
+
*
|
|
5
|
+
* Migration:
|
|
6
|
+
* ```typescript
|
|
7
|
+
* // Old (Svelte 4 stores):
|
|
8
|
+
* import { createFormStore } from '@getmicdrop/svelte-components/stores/createFormStore';
|
|
9
|
+
* const form = createFormStore({ initialData: {...}, endpoint: '...' });
|
|
10
|
+
*
|
|
11
|
+
* // New (Svelte 5 runes):
|
|
12
|
+
* import { createFormStore } from '@getmicdrop/svelte-components/forms';
|
|
13
|
+
* import { z } from 'zod';
|
|
14
|
+
* const schema = z.object({ name: z.string(), email: z.string().email() });
|
|
15
|
+
* const form = createFormStore(schema, { name: '', email: '' });
|
|
16
|
+
* ```
|
|
17
|
+
*/
|
|
1
18
|
import { writable, derived, get } from "svelte/store";
|
|
2
19
|
import { showToast } from "./toaster";
|
|
3
20
|
|
|
4
21
|
/**
|
|
22
|
+
* @deprecated Use createFormStore from '@getmicdrop/svelte-components/forms' instead.
|
|
5
23
|
* @typedef {Object} FormStoreOptions
|
|
6
24
|
* @property {Object} initialData - Initial form data
|
|
7
25
|
* @property {string} [endpoint] - API endpoint for saving
|
|
@@ -15,6 +33,8 @@ import { showToast } from "./toaster";
|
|
|
15
33
|
*/
|
|
16
34
|
|
|
17
35
|
/**
|
|
36
|
+
* @deprecated Use createFormStore from '@getmicdrop/svelte-components/forms' instead.
|
|
37
|
+
*
|
|
18
38
|
* Creates a comprehensive form store with state management, dirty tracking,
|
|
19
39
|
* validation, and save handling.
|
|
20
40
|
*
|
|
@@ -37,6 +57,10 @@ import { showToast } from "./toaster";
|
|
|
37
57
|
* <button on:click={form.submit} disabled={$form.isLoading}>Save</button>
|
|
38
58
|
*/
|
|
39
59
|
export function createFormStore(options = {}) {
|
|
60
|
+
console.warn(
|
|
61
|
+
'[DEPRECATED] createFormStore from stores/createFormStore is deprecated. ' +
|
|
62
|
+
'Use createFormStore from @getmicdrop/svelte-components/forms instead.'
|
|
63
|
+
);
|
|
40
64
|
const {
|
|
41
65
|
initialData = {},
|
|
42
66
|
endpoint = "",
|
package/dist/stores/index.d.ts
CHANGED
|
@@ -1 +1,7 @@
|
|
|
1
|
+
export { createFormStore, createFieldTracker } from "../forms/index";
|
|
2
|
+
export { createFormSave, createDirtyTracker } from "./formSave";
|
|
3
|
+
export { profileFormData, initialFormData, hasChanges } from "./formDataStore";
|
|
4
|
+
export { isSubPage, hideHeaderBackButton, selectedVenueData, isAnimatedNavigation } from "./navigation";
|
|
5
|
+
export { toast, showToast } from "./toaster";
|
|
6
|
+
export { auth, setAuthState, clearAuthState, initializeAuthState } from "./auth";
|
|
1
7
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/stores/index.js
CHANGED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
// Re-export form utilities from the new location
|
|
2
|
+
// These are Svelte 5 runes-based implementations
|
|
3
|
+
export { createFormStore, createFieldTracker } from '../forms/index';
|
|
4
|
+
|
|
5
|
+
// Legacy store exports (for backward compatibility)
|
|
6
|
+
export { createFormSave, createDirtyTracker } from './formSave';
|
|
7
|
+
export { profileFormData, initialFormData, hasChanges } from './formDataStore';
|
|
8
|
+
export { isSubPage, hideHeaderBackButton, selectedVenueData, isAnimatedNavigation } from './navigation';
|
|
9
|
+
export { toast, showToast } from './toaster';
|
|
10
|
+
export { auth, setAuthState, clearAuthState, initializeAuthState, isPerformer } from './auth';
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@getmicdrop/svelte-components",
|
|
3
|
-
"version": "5.3.
|
|
3
|
+
"version": "5.3.15",
|
|
4
4
|
"description": "Shared component library for Micdrop applications",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -55,67 +55,79 @@
|
|
|
55
55
|
"svelte": "./dist/patterns/*",
|
|
56
56
|
"import": "./dist/patterns/*"
|
|
57
57
|
},
|
|
58
|
-
"./calendar/*": {
|
|
59
|
-
"svelte": "./dist/calendar/*",
|
|
60
|
-
"import": "./dist/calendar/*"
|
|
61
|
-
},
|
|
62
|
-
"./components/*": {
|
|
63
|
-
"svelte": "./dist/components/*",
|
|
64
|
-
"import": "./dist/components/*"
|
|
65
|
-
},
|
|
66
|
-
"./config": {
|
|
67
|
-
"import": "./dist/config.js"
|
|
68
|
-
},
|
|
69
|
-
"./stores/formSave": {
|
|
70
|
-
"import": "./dist/stores/formSave.js"
|
|
71
|
-
},
|
|
72
|
-
"./stores/formDataStore": {
|
|
73
|
-
"import": "./dist/stores/formDataStore.js"
|
|
74
|
-
},
|
|
75
|
-
"./stores/navigation": {
|
|
76
|
-
"import": "./dist/stores/navigation.js"
|
|
77
|
-
},
|
|
78
|
-
"./stores/toaster": {
|
|
79
|
-
"import": "./dist/stores/toaster.js"
|
|
80
|
-
},
|
|
81
|
-
"./stores/auth": {
|
|
82
|
-
"import": "./dist/stores/auth.js"
|
|
83
|
-
},
|
|
84
|
-
"./stores/createFormStore": {
|
|
85
|
-
"import": "./dist/stores/createFormStore.js"
|
|
86
|
-
},
|
|
87
|
-
"./
|
|
88
|
-
"
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
"import": "./dist/
|
|
98
|
-
},
|
|
99
|
-
"./
|
|
100
|
-
"import": "./dist/
|
|
101
|
-
},
|
|
102
|
-
"./
|
|
103
|
-
"
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
"import": "./dist/
|
|
117
|
-
}
|
|
118
|
-
|
|
58
|
+
"./calendar/*": {
|
|
59
|
+
"svelte": "./dist/calendar/*",
|
|
60
|
+
"import": "./dist/calendar/*"
|
|
61
|
+
},
|
|
62
|
+
"./components/*": {
|
|
63
|
+
"svelte": "./dist/components/*",
|
|
64
|
+
"import": "./dist/components/*"
|
|
65
|
+
},
|
|
66
|
+
"./config": {
|
|
67
|
+
"import": "./dist/config.js"
|
|
68
|
+
},
|
|
69
|
+
"./stores/formSave": {
|
|
70
|
+
"import": "./dist/stores/formSave.js"
|
|
71
|
+
},
|
|
72
|
+
"./stores/formDataStore": {
|
|
73
|
+
"import": "./dist/stores/formDataStore.js"
|
|
74
|
+
},
|
|
75
|
+
"./stores/navigation": {
|
|
76
|
+
"import": "./dist/stores/navigation.js"
|
|
77
|
+
},
|
|
78
|
+
"./stores/toaster": {
|
|
79
|
+
"import": "./dist/stores/toaster.js"
|
|
80
|
+
},
|
|
81
|
+
"./stores/auth": {
|
|
82
|
+
"import": "./dist/stores/auth.js"
|
|
83
|
+
},
|
|
84
|
+
"./stores/createFormStore": {
|
|
85
|
+
"import": "./dist/stores/createFormStore.js"
|
|
86
|
+
},
|
|
87
|
+
"./forms": {
|
|
88
|
+
"types": "./dist/forms/index.d.ts",
|
|
89
|
+
"import": "./dist/forms/index.js"
|
|
90
|
+
},
|
|
91
|
+
"./forms/createFormStore": {
|
|
92
|
+
"types": "./dist/forms/createFormStore.svelte.d.ts",
|
|
93
|
+
"import": "./dist/forms/createFormStore.svelte.js"
|
|
94
|
+
},
|
|
95
|
+
"./forms/createFieldTracker": {
|
|
96
|
+
"types": "./dist/forms/createFieldTracker.svelte.d.ts",
|
|
97
|
+
"import": "./dist/forms/createFieldTracker.svelte.js"
|
|
98
|
+
},
|
|
99
|
+
"./services/EventService": {
|
|
100
|
+
"import": "./dist/services/EventService.js"
|
|
101
|
+
},
|
|
102
|
+
"./utils/greetings": {
|
|
103
|
+
"import": "./dist/utils/greetings.js"
|
|
104
|
+
},
|
|
105
|
+
"./utils/imageValidation": {
|
|
106
|
+
"import": "./dist/utils/imageValidation.js"
|
|
107
|
+
},
|
|
108
|
+
"./utils/portal": {
|
|
109
|
+
"import": "./dist/utils/portal.js"
|
|
110
|
+
},
|
|
111
|
+
"./utils/apiConfig": {
|
|
112
|
+
"import": "./dist/utils/apiConfig.js"
|
|
113
|
+
},
|
|
114
|
+
"./datetime": {
|
|
115
|
+
"types": "./dist/datetime/index.d.ts",
|
|
116
|
+
"import": "./dist/datetime/index.js"
|
|
117
|
+
},
|
|
118
|
+
"./utils/utils": {
|
|
119
|
+
"import": "./dist/utils/utils.js"
|
|
120
|
+
},
|
|
121
|
+
"./utils/utils/utils": {
|
|
122
|
+
"import": "./dist/utils/utils/utils.js"
|
|
123
|
+
},
|
|
124
|
+
"./constants/formOptions": {
|
|
125
|
+
"import": "./dist/constants/formOptions.js"
|
|
126
|
+
},
|
|
127
|
+
"./telemetry": {
|
|
128
|
+
"import": "./dist/telemetry.js"
|
|
129
|
+
}
|
|
130
|
+
},
|
|
119
131
|
"svelte": "./dist/index.js",
|
|
120
132
|
"files": [
|
|
121
133
|
"dist",
|
|
@@ -193,9 +205,9 @@
|
|
|
193
205
|
"check-password-strength": "^3.0.0",
|
|
194
206
|
"clsx": "^2.1.1",
|
|
195
207
|
"cookie": "^1.0.2",
|
|
196
|
-
"date-fns": "^3.6.0",
|
|
197
|
-
"date-fns-tz": "^3.2.0",
|
|
198
|
-
"dotenv": "^16.4.7",
|
|
208
|
+
"date-fns": "^3.6.0",
|
|
209
|
+
"date-fns-tz": "^3.2.0",
|
|
210
|
+
"dotenv": "^16.4.7",
|
|
199
211
|
"filepond": "^4.32.10",
|
|
200
212
|
"filepond-plugin-file-validate-size": "^2.2.8",
|
|
201
213
|
"filepond-plugin-file-validate-type": "^1.2.9",
|