kanun 0.1.3 → 0.1.4

package/dist/index.d.ts

@@ -73,17 +73,20 @@ declare class replaceAttributePayload {
 //#region src/Contracts/BaseContract.d.ts
 type InitialRule = string | ValidationCallback | IRuleContract | BaseRule;
 type TRule = string | IRuleContract;
-interface InitialRules extends GenericObject {
-  [key: string]: InitialRule | InitialRule[];
-}
-interface Rules extends GenericObject {
-  [key: string]: TRule[];
-}
+type NestedStringMap = {
+  [key: string]: string | NestedStringMap;
+};
+type RuleLeaf = InitialRule | InitialRule[];
+type KnownRulePaths<X extends GenericObject, Prefix extends string = ''> = { [K in keyof X & string]: X[K] extends (infer A)[] ? `${Prefix}${K}` | `${Prefix}${K}.*` | (A extends GenericObject ? `${Prefix}${K}.*.${KnownRulePaths<A>}` : never) : X[K] extends GenericObject ? `${Prefix}${K}` | `${Prefix}${K}.${KnownRulePaths<X[K]>}` : `${Prefix}${K}` }[keyof X & string];
+type LooseNestedRulePaths<X extends GenericObject> = { [K in keyof X & string]: X[K] extends (infer _A)[] ? `${K}.*.${string}` : X[K] extends GenericObject ? `${K}.${string}` : never }[keyof X & string];
+type ScopedInitialRules<X extends GenericObject> = Partial<Record<KnownRulePaths<X> | LooseNestedRulePaths<X>, RuleLeaf>> & { [K in keyof X & string]?: X[K] extends (infer A)[] ? RuleLeaf | (A extends GenericObject ? ScopedInitialRules<A> : never) : X[K] extends GenericObject ? RuleLeaf | ScopedInitialRules<X[K]> : RuleLeaf };
+type InitialRules<X extends GenericObject = GenericObject> = ScopedInitialRules<keyof X extends never ? GenericObject : X>;
+type Rules<X extends GenericObject = GenericObject> = Partial<Record<Extract<keyof X, string>, TRule[]>> & Record<string, TRule[]>;
 interface ImplicitAttributes {
   [key: string]: string[];
 }
-type CustomMessages = GenericObject & {};
-type CustomAttributes = GenericObject & {};
+type CustomMessages<_X extends GenericObject = GenericObject> = GenericObject;
+type CustomAttributes<_X extends GenericObject = GenericObject> = GenericObject;
 interface ErrorMessage {
   error_type?: string;
   message: string;
@@ -272,7 +275,7 @@ declare class ErrorBag {
 }
 //#endregion
 //#region src/BaseValidator.d.ts
-declare class BaseValidator {
+declare class BaseValidator<D extends GenericObject = GenericObject> {
   /**
    * The lang used to return error messages
    */
@@ -308,18 +311,18 @@ declare class BaseValidator {
   /**
    * Custom messages returned based on the error
    */
-  customMessages: CustomMessages;
+  customMessages: CustomMessages<D>;
   /**
    * Object of custom attribute name;
    */
-  customAttributes: CustomAttributes;
-  constructor(data: object, rules: InitialRules, customMessages?: CustomMessages, customAttributes?: CustomAttributes);
-  setData(data: object): this;
-  setRules(rules: InitialRules): this;
+  customAttributes: CustomAttributes<D>;
+  constructor(data: D, rules: InitialRules<D>, customMessages?: CustomMessages<D>, customAttributes?: CustomAttributes<D>);
+  setData<ND extends GenericObject>(data: ND): BaseValidator<ND>;
+  setRules(rules: InitialRules<D>): this;
   setLang(lang: string): this;
   getLang(): string;
-  setCustomMessages(customMessages?: CustomMessages): this;
-  setCustomAttributes(customAttributes?: CustomAttributes): this;
+  setCustomMessages(customMessages?: CustomMessages<D>): this;
+  setCustomAttributes(customAttributes?: CustomAttributes<D>): this;
   stopOnFirstFailure(stopOnFirstFailure?: boolean): this;
   errors(): ErrorBag;
   clearErrors(keys?: string[]): ErrorBag;
@@ -660,6 +663,7 @@ type ValidationRuleSet = RuleName | RuleName[] | `${ValidationRuleName}${string
  * Parse rule names from rule string or string[] definitions
  */
 type ExtractRules<R> = R extends string ? R extends `${infer Head}|${infer Tail}` ? Head extends `${infer Rule}:${string}` ? Rule | ExtractRules<Tail> : Head | ExtractRules<Tail> : R extends `${infer Rule}:${string}` ? Rule : R : R extends string[] ? ExtractRules<R[number]> : never;
+type ValidatedByRules<D extends Record<string, any>, R extends RulesForData<D>> = { [K in Extract<keyof R, keyof D>]: D[K] };
 /**
  * Flatten data structure into dot-notation keys
  * including wildcards (*) for arrays.
@@ -699,13 +703,13 @@ declare class IValidator<D extends Record<string, any> = any, R extends RulesFor
    *
    * @throws ValidationException if validation fails
    */
-  validate(): Promise<Record<string, any>>;
+  validate(): Promise<ValidatedByRules<D, R>>;
   /**
    * Run the validator's rules against its data.
    * @param bagName
    * @returns
    */
-  validateWithBag(bagName: string): Promise<Record<string, any>>;
+  validateWithBag(bagName: string): Promise<ValidatedByRules<D, R>>;
   /**
    * Stop validation on first failure.
    */
@@ -713,7 +717,7 @@ declare class IValidator<D extends Record<string, any> = any, R extends RulesFor
   /**
    * Get the data that passed validation.
    */
-  validatedData(): Record<string, any>;
+  validatedData(): ValidatedByRules<D, R>;
   /**
    * Return all validated input.
    */
@@ -759,7 +763,7 @@ declare class IValidator<D extends Record<string, any> = any, R extends RulesFor
   /**
    * Get current data.
    */
-  getData(): Record<string, any>;
+  getData(): ValidatedByRules<D, R>;
   /**
    * Get current rules.
    */
@@ -869,7 +873,7 @@ declare function notRegex(value: RegExp): Regex;
 //#endregion
 //#region src/Core.d.ts
 declare class Password extends Password$1 {}
-declare function make(data?: GenericObject, rules?: InitialRules, customMessages?: CustomMessages, customAttributes?: CustomAttributes): BaseValidator;
+declare function make<D extends GenericObject = GenericObject>(data?: D, rules?: InitialRules<D>, customMessages?: CustomMessages<D>, customAttributes?: CustomAttributes<D>): BaseValidator<D>;
 //#endregion
 //#region src/Rules/IImplicitRule.d.ts
 declare class IImplicitRule extends IRuleContract {
@@ -1030,13 +1034,13 @@ declare class Validator<D extends Record<string, any> = any, R extends RulesForD
    *
    * @throws ValidationException if validation fails
    */
-  validate(): Promise<Record<string, any>>;
+  validate(): Promise<ValidatedByRules<D, R>>;
   /**
    * Run the validator's rules against its data.
    * @param bagName
    * @returns
    */
-  validateWithBag(bagName: string): Promise<Record<string, any>>;
+  validateWithBag(bagName: string): Promise<ValidatedByRules<D, R>>;
   /**
    * Stop validation on first failure.
    */
@@ -1044,7 +1048,7 @@ declare class Validator<D extends Record<string, any> = any, R extends RulesForD
   /**
    * Get the data that passed validation.
    */
-  validatedData(): Record<string, any>;
+  validatedData(): ValidatedByRules<D, R>;
   /**
    * Return all validated input.
    */
@@ -1090,7 +1094,7 @@ declare class Validator<D extends Record<string, any> = any, R extends RulesForD
   /**
    * Get current data.
    */
-  getData(): Record<string, any>;
+  getData(): ValidatedByRules<D, R>;
   /**
    * Get current rules.
    */
@@ -1432,4 +1436,4 @@ declare class ValidationException extends Error {
   getResponse(): any;
 }
 //#endregion
-export { BaseValidationRuleClass, BaseValidator, CustomAttributes, CustomErrors, CustomMessages, CustomValidationRules, DotPaths, ErrorBag, ErrorMessage, Errors, ExtendedRules, ExtractRules, FieldMessages, GenericCallable, GenericObject, IDatabaseDriver, IMessageBag, IValidationRule, IValidator, ImplicitAttributes, ImplicitRule, InitialRule, InitialRules, Lang, MessageBag, Messages, MessagesForRules, ParamableValidationRuleName, Password, PlainRuleName, ReplaceAttributeInterface, Rules, RulesForData, TRule, ValidationCallback, ValidationDataInterface, ValidationDatabaseExistsInput, ValidationException, ValidationMessageProvider, ValidationRule, ValidationRuleCallable, ValidationRuleName, ValidationRuleParserInterface, ValidationRuleSet, ValidationServiceProvider, Validator, addImplicitRule, buildValidationMethodName, compare, convertValuesToBoolean, convertValuesToNull, convertValuesToNumber, deepEqual, deepFind, deepSet, dotify, getFormattedAttribute, getKeyCombinations, getMessage, getNumericRules, getSize, isArrayOfRules, isImplicitRule, isInteger, isNumericRule, isObject, isRule, isSizeRule, make, mergeDeep, notRegex, plural, regex, register, registerImplicit, requiredIf, ruleIn, ruleNotIn, sameType, toDate, toSnakeCase };
+export { BaseValidationRuleClass, BaseValidator, CustomAttributes, CustomErrors, CustomMessages, CustomValidationRules, DotPaths, ErrorBag, ErrorMessage, Errors, ExtendedRules, ExtractRules, FieldMessages, GenericCallable, GenericObject, IDatabaseDriver, IMessageBag, IValidationRule, IValidator, ImplicitAttributes, ImplicitRule, InitialRule, InitialRules, Lang, MessageBag, Messages, MessagesForRules, NestedStringMap, ParamableValidationRuleName, Password, PlainRuleName, ReplaceAttributeInterface, Rules, RulesForData, TRule, ValidatedByRules, ValidationCallback, ValidationDataInterface, ValidationDatabaseExistsInput, ValidationException, ValidationMessageProvider, ValidationRule, ValidationRuleCallable, ValidationRuleName, ValidationRuleParserInterface, ValidationRuleSet, ValidationServiceProvider, Validator, addImplicitRule, buildValidationMethodName, compare, convertValuesToBoolean, convertValuesToNull, convertValuesToNumber, deepEqual, deepFind, deepSet, dotify, getFormattedAttribute, getKeyCombinations, getMessage, getNumericRules, getSize, isArrayOfRules, isImplicitRule, isInteger, isNumericRule, isObject, isRule, isSizeRule, make, mergeDeep, notRegex, plural, regex, register, registerImplicit, requiredIf, ruleIn, ruleNotIn, sameType, toDate, toSnakeCase };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kanun",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "description": "Framework-agnostic TypeScript-first validation library.",
   "type": "module",
   "files": [