@kws3/ui 4.3.2 → 4.3.4

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/CHANGELOG.mdx CHANGED
@@ -1,3 +1,9 @@
1
+ ## 4.3.4
2
+ - Make granular types of form maker generic
3
+
4
+ ## 4.3.3
5
+ - More granular types for form maker
6
+
1
7
  ## 4.3.2
2
8
  - Extended typings for form helper
3
9
  - Fix typings for ButtonEvent
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kws3/ui",
3
- "version": "4.3.2",
3
+ "version": "4.3.4",
4
4
  "description": "UI components for use with Svelte v3 applications.",
5
5
  "main": "index.js",
6
6
  "svelte": "index.js",
@@ -39,5 +39,5 @@
39
39
  "devDependencies": {
40
40
  "typescript": "^5.2.2"
41
41
  },
42
- "gitHead": "a8f22c35003d283bc5b76ee2fd44a800931effc6"
42
+ "gitHead": "834bfdd2b9537ec3ffd7e56ac12a498be7b27269"
43
43
  }
package/types/index.d.ts CHANGED
@@ -131,22 +131,39 @@ export type ButtonTracker = {
131
131
  error: boolean;
132
132
  };
133
133
 
134
+ export type FormMakerValidators = { [key: string]: Function | Function[] };
135
+
136
+ export type FormMakerReturnFormData<T> = import("svelte/store").Writable<T>;
137
+
138
+ export type FormMakerReturnErrors<T> = import("svelte/store").Readable<{
139
+ [K in keyof T]: string;
140
+ }>;
141
+
142
+ export type FormMakerReturnTouched<T> = import("svelte/store").Readable<{
143
+ [K in keyof T]: boolean;
144
+ }>;
145
+
146
+ export type FormMakerReturnIsValid = import("svelte/store").Readable<boolean>;
147
+ export type FormMakerReturnIsTouched = import("svelte/store").Readable<boolean>;
148
+ export type FormMakerReturnTracker =
149
+ import("svelte/store").Writable<ButtonTracker>;
150
+
134
151
  export type FormMakerConfig<T = Record<string, any>> = {
135
152
  data: T;
136
- validators?: { [key: string]: Function | Function[] };
153
+ validators?: FormMakerValidators;
137
154
  strictMode?: boolean;
138
155
  };
139
156
 
140
- export type FormMakerReturnType<T> = {
141
- formData: import("svelte/store").Writable<T>;
142
- errors: import("svelte/store").Readable<{ [K in keyof T]: string }>;
143
- touched: import("svelte/store").Readable<{ [K in keyof T]: boolean }>;
144
- isValid: import("svelte/store").Readable<boolean>;
145
- isTouched: import("svelte/store").Readable<boolean>;
146
- tracker: import("svelte/store").Writable<ButtonTracker>;
157
+ export type FormMakerReturn<T> = {
158
+ formData: FormMakerReturnFormData<T>;
159
+ errors: FormMakerReturnErrors<T>;
160
+ touched: FormMakerReturnTouched<T>;
161
+ isValid: FormMakerReturnIsValid;
162
+ isTouched: FormMakerReturnIsTouched;
163
+ tracker: FormMakerReturnTracker;
147
164
  update: (newData: { [key: string]: any }) => void;
148
165
  reset: (e?: Event | null) => void;
149
- setValidators: (newValidators: FormMakerConfig["validators"]) => void;
166
+ setValidators: (newValidators: FormMakerValidators) => void;
150
167
  };
151
168
 
152
169
  export type CloneObject = <T>(obj: T) => T;
@@ -154,10 +171,10 @@ export type CloneObject = <T>(obj: T) => T;
154
171
  // Overloads
155
172
  export declare function MakeForms<T extends Record<string, any>>(
156
173
  items: FormMakerConfig<T>,
157
- ): FormMakerReturnType<T>;
174
+ ): FormMakerReturn<T>;
158
175
  export declare function MakeForms<T extends Record<string, any>>(
159
176
  items: FormMakerConfig<T>[],
160
- ): FormMakerReturnType<T>[];
177
+ ): FormMakerReturn<T>[];
161
178
 
162
179
  declare global {
163
180
  interface Navigator {