@spscommerce/ds-react 5.12.4 → 5.13.2

package/lib/form/SpsForm.examples.d.ts

@@ -38,4 +38,13 @@ export declare const SpsFormExamples: {
             };
         };
     };
+    custom_errors: {
+        label: string;
+        description: () => JSX.Element;
+        examples: {
+            basic: {
+                react: string;
+            };
+        };
+    };
 };

package/lib/form/hooks/useCustomValidator.d.ts

@@ -0,0 +1,7 @@
+import type { SpsValidator } from "../validation/types";
+export declare enum ValidationMode {
+    ON_CHANGE = 0,
+    ON_BLUR = 1,
+    ON_SUBMIT = 2
+}
+export declare function useCustomValidator<T>(validator: SpsValidator<T>, validatorConfig?: Record<string, ValidationMode>, dependencies?: any[]): SpsValidator<T>;

package/lib/form/hooks/useSpsForm.d.ts

@@ -9,6 +9,7 @@ export declare abstract class SpsFormMetaBase<T> {
     errors: SpsValidationErrors | null;
     revealAllErrors: boolean;
     preventativeErrors: any[];
+    submitted: boolean;
     constructor(path: Path, update: UpdateFn);
     abstract isPristine(): boolean;
     abstract markAsPristine(): SpsFormMetaBase<T>;
@@ -23,6 +24,7 @@ export declare abstract class SpsFormMetaBase<T> {
     hasPreventativeError(errorKey: string): boolean;
     hasPreventativeErrors(): boolean;
     isRequired(): boolean;
+    isSubmitted(): boolean;
     onFocus(): void;
     onBlur(): void;
 }
@@ -37,6 +39,7 @@ export declare class SpsFormFieldMeta<T> extends SpsFormMetaBase<T> {
     isFocused(): boolean;
     markAsFocused(): SpsFormFieldMeta<T>;
     markAsBlurred(): SpsFormFieldMeta<T>;
+    markAsSubmitted(): SpsFormFieldMeta<T>;
 }
 export declare type InferredSpsFormMeta<T> = SpsFormMetaBase<T> & (T extends any[] ? SpsFormArrayMeta<T> : T extends (Array<infer U> | undefined) ? SpsFormArrayMeta<U[]> | undefined : T extends object ? SpsFormGroupMeta<T> : T extends (object | undefined) ? SpsFormGroupMeta<object & T> | undefined : T extends boolean ? SpsFormFieldMeta<boolean> : T extends (infer V | undefined) ? SpsFormFieldMeta<V> | undefined : SpsFormFieldMeta<T>);
 export declare type SpsFormSetMembers<T> = {
@@ -61,6 +64,7 @@ export declare abstract class SpsFormSetMeta<T extends SpsFormSetValue, U extend
     markAsPristine(): this;
     markAsDirty(): this;
     markAsBlurred(): this;
+    markAsSubmitted(): this;
 }
 export declare class SpsFormGroupMeta<T extends object> extends SpsFormSetMeta<T> {
     protected inferMembers(inferFromValue: T): void;

package/lib/form/index.d.ts

@@ -6,6 +6,7 @@ export * from "./hooks/SpsAbstractControl.interface";
 export * from "./hooks/SpsControlSet.interface";
 export * from "./hooks/useForm";
 export * from "./hooks/useServerSideValidation";
+export * from "./hooks/useCustomValidator";
 export * from "./validation/SpsValidators";
 export * from "./validation/types";
 export * from "./validation/validate";

package/lib/form/validation/types.d.ts

@@ -5,3 +5,6 @@ export declare type SpsValidatorFactory<T> = (...args: any[]) => SpsValidator<T>
 export declare const OnBlurErrorKeys: Set<string>;
 export declare const AsTypingErrorKeys: Set<string>;
 export declare const PreventativeErrorKeys: Set<string>;
+export declare const OnSubmitErrorKeys: Set<string>;
+export declare function addOnChangeErrorKey(errorKey: string): void;
+export declare function addOnSubmitErrorKey(errorKey: string): void;