@fiddle-digital/string-tune 1.1.17 → 1.1.19

package/dist/index.d.mts

@@ -537,47 +537,6 @@ declare class ColorParserTool implements IStringTool<ColorParserInput, StringCol
     private hslToRgb;
 }
 
-type ValidationErrorCode = "required" | "invalid-email" | "too-short" | "too-long";
-type ValidationRule = "required" | "email" | {
-    type: "minLength";
-    value: number;
-} | {
-    type: "maxLength";
-    value: number;
-};
-interface ValidationInput {
-    /** Value to validate. */
-    value: string;
-    /** List of rules to apply. */
-    rules: ValidationRule[];
-    /**
-     * Optional message map: key = errorCode, value = string or function returning a message.
-     */
-    messages?: Partial<Record<ValidationErrorCode, string | ((args: {
-        value: string;
-        rule: ValidationRule;
-    }) => string)>>;
-}
-interface ValidationOutput {
-    /** `true` if valid, `false` if error found. */
-    valid: boolean;
-    /** One of the known error codes (or null if no error). */
-    error: ValidationErrorCode | null;
-    /** Final message (either default or user-defined). */
-    message: string | null;
-}
-/**
- * Tool for validating strings using rules like `required`, `minLength`, etc.
- * Allows custom error messages (as string or generator function).
- */
-declare class ValidationTool implements IStringTool<ValidationInput, ValidationOutput> {
-    /**
-     * Validates input value and returns error code + message.
-     */
-    process({ value, rules, messages }: ValidationInput): ValidationOutput;
-    private defaultMessage;
-}
-
 /**
  * Input parameters for EasingFunctionTool.
  */
@@ -799,6 +758,31 @@ declare class SplitOptionsParserTool implements IStringTool<SplitOptionsParserIn
     private parseParamsArray;
 }
 
+interface RuleParserInput {
+    value: string;
+}
+interface RuleParserResult {
+    key: string;
+    params?: string[];
+}
+declare class RuleParserTool implements IStringTool<RuleParserInput, RuleParserResult[]> {
+    process({ value }: RuleParserInput): RuleParserResult[];
+}
+
+interface ValidateInput {
+    rules: RuleParserResult[];
+    value: any;
+}
+interface ValidationResult {
+    valid: boolean;
+    errors: string[];
+}
+declare class ValidationTool implements IStringTool<ValidateInput, ValidationResult> {
+    process({ rules, value }: ValidateInput): ValidationResult;
+    validators: Record<string, (value: any, ...params: string[]) => boolean>;
+    getErrorMessage(key: string, params?: string[]): string;
+}
+
 /**
  * Interface describing all available tools used inside modules.
  */
@@ -860,6 +844,7 @@ interface StringToolsContainer {
     lerpVector: LerpVector2Tool;
     transformScaleParser: TransformScaleParserTool;
     optionsParser: SplitOptionsParserTool;
+    ruleParser: RuleParserTool;
 }
 
 /**
@@ -1773,6 +1758,13 @@ declare class StringSequence extends StringModule {
     private setSequenceState;
 }
 
+declare class StringForm extends StringModule {
+    constructor(context: StringContext);
+    onObjectConnected(object: StringObject): void;
+    getInputKey(field: HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement, idx: number): string;
+    getFieldValue(field: HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement): any;
+}
+
 declare class StringTune {
     /** Bound handler for the scroll start event */
     private onScrollStartBind;
@@ -2010,4 +2002,4 @@ declare class StringTune {
     destroy(): void;
 }
 
-export { type ScrollMarkRule as ScrollTriggerRule, StringAnchor, type StringContext, StringCursor, StringData, StringDelayLerpTracker, StringFPSTracker, StringGlide, StringLazy, StringLerp, StringLerpTracker, StringLoading, StringMagnetic, StringModule, StringObject, StringParallax, StringPositionTracker, StringProgress, StringResponsive, StringScrollbar, StringSequence, StringSplit, StringTune, StringVideoAutoplay, StringTune as default };
+export { type ScrollMarkRule as ScrollTriggerRule, StringAnchor, type StringContext, StringCursor, StringData, StringDelayLerpTracker, StringFPSTracker, StringForm, StringGlide, StringLazy, StringLerp, StringLerpTracker, StringLoading, StringMagnetic, StringModule, StringObject, StringParallax, StringPositionTracker, StringProgress, StringResponsive, StringScrollbar, StringSequence, StringSplit, StringTune, StringVideoAutoplay, StringTune as default };

package/dist/index.d.ts

@@ -537,47 +537,6 @@ declare class ColorParserTool implements IStringTool<ColorParserInput, StringCol
     private hslToRgb;
 }
 
-type ValidationErrorCode = "required" | "invalid-email" | "too-short" | "too-long";
-type ValidationRule = "required" | "email" | {
-    type: "minLength";
-    value: number;
-} | {
-    type: "maxLength";
-    value: number;
-};
-interface ValidationInput {
-    /** Value to validate. */
-    value: string;
-    /** List of rules to apply. */
-    rules: ValidationRule[];
-    /**
-     * Optional message map: key = errorCode, value = string or function returning a message.
-     */
-    messages?: Partial<Record<ValidationErrorCode, string | ((args: {
-        value: string;
-        rule: ValidationRule;
-    }) => string)>>;
-}
-interface ValidationOutput {
-    /** `true` if valid, `false` if error found. */
-    valid: boolean;
-    /** One of the known error codes (or null if no error). */
-    error: ValidationErrorCode | null;
-    /** Final message (either default or user-defined). */
-    message: string | null;
-}
-/**
- * Tool for validating strings using rules like `required`, `minLength`, etc.
- * Allows custom error messages (as string or generator function).
- */
-declare class ValidationTool implements IStringTool<ValidationInput, ValidationOutput> {
-    /**
-     * Validates input value and returns error code + message.
-     */
-    process({ value, rules, messages }: ValidationInput): ValidationOutput;
-    private defaultMessage;
-}
-
 /**
  * Input parameters for EasingFunctionTool.
  */
@@ -799,6 +758,31 @@ declare class SplitOptionsParserTool implements IStringTool<SplitOptionsParserIn
     private parseParamsArray;
 }
 
+interface RuleParserInput {
+    value: string;
+}
+interface RuleParserResult {
+    key: string;
+    params?: string[];
+}
+declare class RuleParserTool implements IStringTool<RuleParserInput, RuleParserResult[]> {
+    process({ value }: RuleParserInput): RuleParserResult[];
+}
+
+interface ValidateInput {
+    rules: RuleParserResult[];
+    value: any;
+}
+interface ValidationResult {
+    valid: boolean;
+    errors: string[];
+}
+declare class ValidationTool implements IStringTool<ValidateInput, ValidationResult> {
+    process({ rules, value }: ValidateInput): ValidationResult;
+    validators: Record<string, (value: any, ...params: string[]) => boolean>;
+    getErrorMessage(key: string, params?: string[]): string;
+}
+
 /**
  * Interface describing all available tools used inside modules.
  */
@@ -860,6 +844,7 @@ interface StringToolsContainer {
     lerpVector: LerpVector2Tool;
     transformScaleParser: TransformScaleParserTool;
     optionsParser: SplitOptionsParserTool;
+    ruleParser: RuleParserTool;
 }
 
 /**
@@ -1773,6 +1758,13 @@ declare class StringSequence extends StringModule {
     private setSequenceState;
 }
 
+declare class StringForm extends StringModule {
+    constructor(context: StringContext);
+    onObjectConnected(object: StringObject): void;
+    getInputKey(field: HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement, idx: number): string;
+    getFieldValue(field: HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement): any;
+}
+
 declare class StringTune {
     /** Bound handler for the scroll start event */
     private onScrollStartBind;
@@ -2010,4 +2002,4 @@ declare class StringTune {
     destroy(): void;
 }
 
-export { type ScrollMarkRule as ScrollTriggerRule, StringAnchor, type StringContext, StringCursor, StringData, StringDelayLerpTracker, StringFPSTracker, StringGlide, StringLazy, StringLerp, StringLerpTracker, StringLoading, StringMagnetic, StringModule, StringObject, StringParallax, StringPositionTracker, StringProgress, StringResponsive, StringScrollbar, StringSequence, StringSplit, StringTune, StringVideoAutoplay, StringTune as default };
+export { type ScrollMarkRule as ScrollTriggerRule, StringAnchor, type StringContext, StringCursor, StringData, StringDelayLerpTracker, StringFPSTracker, StringForm, StringGlide, StringLazy, StringLerp, StringLerpTracker, StringLoading, StringMagnetic, StringModule, StringObject, StringParallax, StringPositionTracker, StringProgress, StringResponsive, StringScrollbar, StringSequence, StringSplit, StringTune, StringVideoAutoplay, StringTune as default };