@obinexusltd/obix-sdk-forms 0.1.0
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/index.d.ts +46 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +67 -0
- package/dist/index.js.map +1 -0
- package/package.json +30 -0
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* OBIX Forms - Validation, autocomplete, progressive enhancement
|
|
3
|
+
* Comprehensive form management with advanced validation
|
|
4
|
+
*/
|
|
5
|
+
export interface ValidationRule {
|
|
6
|
+
name: string;
|
|
7
|
+
validate: (value: unknown) => boolean | Promise<boolean>;
|
|
8
|
+
message: string;
|
|
9
|
+
}
|
|
10
|
+
export type AutocompleteType = "off" | "on" | "name" | "email" | "tel" | "url" | "street-address" | "postal-code" | "cc-name" | "cc-number" | "cc-exp" | "cc-csc";
|
|
11
|
+
export interface FieldDefinition {
|
|
12
|
+
name: string;
|
|
13
|
+
type: string;
|
|
14
|
+
required: boolean;
|
|
15
|
+
validationRules: ValidationRule[];
|
|
16
|
+
autocomplete?: AutocompleteType;
|
|
17
|
+
initialValue?: unknown;
|
|
18
|
+
metadata?: Record<string, unknown>;
|
|
19
|
+
}
|
|
20
|
+
export interface ProgressiveEnhancement {
|
|
21
|
+
noJsBaseline: boolean;
|
|
22
|
+
gracefulDegradation: boolean;
|
|
23
|
+
lazyValidation: boolean;
|
|
24
|
+
}
|
|
25
|
+
export interface ValidationResult {
|
|
26
|
+
valid: boolean;
|
|
27
|
+
errors: Record<string, string[]>;
|
|
28
|
+
warnings?: Record<string, string[]>;
|
|
29
|
+
}
|
|
30
|
+
export interface FormConfig {
|
|
31
|
+
fields: FieldDefinition[];
|
|
32
|
+
progressiveEnhancement?: ProgressiveEnhancement;
|
|
33
|
+
submitHandler?: (data: Record<string, unknown>) => Promise<void>;
|
|
34
|
+
}
|
|
35
|
+
export type ValidationTiming = "onChange" | "onBlur" | "onSubmit";
|
|
36
|
+
export interface FormEngine {
|
|
37
|
+
validate(data: Record<string, unknown>): Promise<ValidationResult>;
|
|
38
|
+
getField(name: string): FieldDefinition | undefined;
|
|
39
|
+
submit(data: Record<string, unknown>): Promise<void>;
|
|
40
|
+
enableAutocomplete(fieldName: string, type: AutocompleteType): void;
|
|
41
|
+
setValidationTiming(timing: ValidationTiming): void;
|
|
42
|
+
getValidationTiming(): ValidationTiming;
|
|
43
|
+
shouldValidateOn(event: "change" | "blur" | "submit"): boolean;
|
|
44
|
+
}
|
|
45
|
+
export declare function createFormEngine(config: FormConfig): FormEngine;
|
|
46
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACzD,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,MAAM,gBAAgB,GACxB,KAAK,GACL,IAAI,GACJ,MAAM,GACN,OAAO,GACP,KAAK,GACL,KAAK,GACL,gBAAgB,GAChB,aAAa,GACb,SAAS,GACT,WAAW,GACX,QAAQ,GACR,QAAQ,CAAC;AAEb,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC;IAClB,eAAe,EAAE,cAAc,EAAE,CAAC;IAClC,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,sBAAsB;IACrC,YAAY,EAAE,OAAO,CAAC;IACtB,mBAAmB,EAAE,OAAO,CAAC;IAC7B,cAAc,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;CACrC;AAED,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,eAAe,EAAE,CAAC;IAC1B,sBAAsB,CAAC,EAAE,sBAAsB,CAAC;IAChD,aAAa,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAClE;AAED,MAAM,MAAM,gBAAgB,GAAG,UAAU,GAAG,QAAQ,GAAG,UAAU,CAAC;AAElE,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACnE,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS,CAAC;IACpD,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACrD,kBAAkB,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,GAAG,IAAI,CAAC;IACpE,mBAAmB,CAAC,MAAM,EAAE,gBAAgB,GAAG,IAAI,CAAC;IACpD,mBAAmB,IAAI,gBAAgB,CAAC;IACxC,gBAAgB,CAAC,KAAK,EAAE,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;CAChE;AAED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,UAAU,GAAG,UAAU,CAuE/D"}
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* OBIX Forms - Validation, autocomplete, progressive enhancement
|
|
3
|
+
* Comprehensive form management with advanced validation
|
|
4
|
+
*/
|
|
5
|
+
export function createFormEngine(config) {
|
|
6
|
+
const fields = new Map(config.fields.map((field) => [field.name, { ...field }]));
|
|
7
|
+
let validationTiming = "onSubmit";
|
|
8
|
+
return {
|
|
9
|
+
async validate(data) {
|
|
10
|
+
const errors = {};
|
|
11
|
+
const warnings = {};
|
|
12
|
+
for (const field of fields.values()) {
|
|
13
|
+
const value = data[field.name];
|
|
14
|
+
if (field.required && (value === undefined || value === null || value === "")) {
|
|
15
|
+
errors[field.name] = [...(errors[field.name] ?? []), "This field is required."];
|
|
16
|
+
}
|
|
17
|
+
for (const rule of field.validationRules) {
|
|
18
|
+
const isValid = await rule.validate(value);
|
|
19
|
+
if (!isValid) {
|
|
20
|
+
errors[field.name] = [...(errors[field.name] ?? []), rule.message];
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
if (field.required && !field.autocomplete) {
|
|
24
|
+
warnings[field.name] = [...(warnings[field.name] ?? []), "Missing autocomplete attribute for required field."];
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
return {
|
|
28
|
+
valid: Object.keys(errors).length === 0,
|
|
29
|
+
errors,
|
|
30
|
+
warnings
|
|
31
|
+
};
|
|
32
|
+
},
|
|
33
|
+
getField(name) {
|
|
34
|
+
return fields.get(name);
|
|
35
|
+
},
|
|
36
|
+
async submit(data) {
|
|
37
|
+
const result = await this.validate(data);
|
|
38
|
+
if (!result.valid) {
|
|
39
|
+
throw new Error("Form validation failed.");
|
|
40
|
+
}
|
|
41
|
+
await config.submitHandler?.(data);
|
|
42
|
+
},
|
|
43
|
+
enableAutocomplete(fieldName, type) {
|
|
44
|
+
const field = fields.get(fieldName);
|
|
45
|
+
if (!field) {
|
|
46
|
+
throw new Error(`Field '${fieldName}' not found.`);
|
|
47
|
+
}
|
|
48
|
+
field.autocomplete = type;
|
|
49
|
+
},
|
|
50
|
+
setValidationTiming(timing) {
|
|
51
|
+
validationTiming = timing;
|
|
52
|
+
},
|
|
53
|
+
getValidationTiming() {
|
|
54
|
+
return validationTiming;
|
|
55
|
+
},
|
|
56
|
+
shouldValidateOn(event) {
|
|
57
|
+
if (validationTiming === "onChange") {
|
|
58
|
+
return event === "change";
|
|
59
|
+
}
|
|
60
|
+
if (validationTiming === "onBlur") {
|
|
61
|
+
return event === "blur";
|
|
62
|
+
}
|
|
63
|
+
return event === "submit";
|
|
64
|
+
}
|
|
65
|
+
};
|
|
66
|
+
}
|
|
67
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AA8DH,MAAM,UAAU,gBAAgB,CAAC,MAAkB;IACjD,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;IACjF,IAAI,gBAAgB,GAAqB,UAAU,CAAC;IAEpD,OAAO;QACL,KAAK,CAAC,QAAQ,CAAC,IAA6B;YAC1C,MAAM,MAAM,GAA6B,EAAE,CAAC;YAC5C,MAAM,QAAQ,GAA6B,EAAE,CAAC;YAE9C,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC;gBACpC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAE/B,IAAI,KAAK,CAAC,QAAQ,IAAI,CAAC,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC,EAAE,CAAC;oBAC9E,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,yBAAyB,CAAC,CAAC;gBAClF,CAAC;gBAED,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,eAAe,EAAE,CAAC;oBACzC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;oBAC3C,IAAI,CAAC,OAAO,EAAE,CAAC;wBACb,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;oBACrE,CAAC;gBACH,CAAC;gBAED,IAAI,KAAK,CAAC,QAAQ,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;oBAC1C,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,oDAAoD,CAAC,CAAC;gBACjH,CAAC;YACH,CAAC;YAED,OAAO;gBACL,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC;gBACvC,MAAM;gBACN,QAAQ;aACT,CAAC;QACJ,CAAC;QACD,QAAQ,CAAC,IAAY;YACnB,OAAO,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;QACD,KAAK,CAAC,MAAM,CAAC,IAA6B;YACxC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACzC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;gBAClB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;YAC7C,CAAC;YAED,MAAM,MAAM,CAAC,aAAa,EAAE,CAAC,IAAI,CAAC,CAAC;QACrC,CAAC;QACD,kBAAkB,CAAC,SAAiB,EAAE,IAAsB;YAC1D,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YACpC,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,MAAM,IAAI,KAAK,CAAC,UAAU,SAAS,cAAc,CAAC,CAAC;YACrD,CAAC;YAED,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;QAC5B,CAAC;QACD,mBAAmB,CAAC,MAAwB;YAC1C,gBAAgB,GAAG,MAAM,CAAC;QAC5B,CAAC;QACD,mBAAmB;YACjB,OAAO,gBAAgB,CAAC;QAC1B,CAAC;QACD,gBAAgB,CAAC,KAAmC;YAClD,IAAI,gBAAgB,KAAK,UAAU,EAAE,CAAC;gBACpC,OAAO,KAAK,KAAK,QAAQ,CAAC;YAC5B,CAAC;YAED,IAAI,gBAAgB,KAAK,QAAQ,EAAE,CAAC;gBAClC,OAAO,KAAK,KAAK,MAAM,CAAC;YAC1B,CAAC;YAED,OAAO,KAAK,KAAK,QAAQ,CAAC;QAC5B,CAAC;KACF,CAAC;AACJ,CAAC"}
|
package/package.json
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@obinexusltd/obix-sdk-forms",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "OBIX Forms - Validation, autocomplete, progressive enhancement",
|
|
5
|
+
"main": "dist/index.js",
|
|
6
|
+
"types": "dist/index.d.ts",
|
|
7
|
+
"type": "module",
|
|
8
|
+
"scripts": {
|
|
9
|
+
"build": "tsc",
|
|
10
|
+
"test": "vitest run",
|
|
11
|
+
"test:watch": "vitest"
|
|
12
|
+
},
|
|
13
|
+
"files": [
|
|
14
|
+
"dist"
|
|
15
|
+
],
|
|
16
|
+
"exports": {
|
|
17
|
+
".": {
|
|
18
|
+
"import": "./dist/index.js",
|
|
19
|
+
"types": "./dist/index.d.ts"
|
|
20
|
+
}
|
|
21
|
+
},
|
|
22
|
+
"license": "MIT",
|
|
23
|
+
"author": "OBINexus <okpalan@protonmail.com>",
|
|
24
|
+
"peerDependencies": {
|
|
25
|
+
"@obinexusltd/obix-sdk-core": "^0.1.0"
|
|
26
|
+
},
|
|
27
|
+
"publishConfig": {
|
|
28
|
+
"access": "public"
|
|
29
|
+
}
|
|
30
|
+
}
|