kanun 1.0.1 → 1.0.2

package/README.md

@@ -16,7 +16,7 @@ npm install kanun
 For file validation, install the separate plugin package:
 
 ```bash
-npm install kanun kanun-plugin-file
+npm install kanun @kanun-hq/plugin-file
 ```
 
 ## Features
@@ -157,7 +157,7 @@ const validator = new Validator(
 
 ### Plugins
 
-Kanun supports installable plugins such as `kanun-plugin-file`.
+Kanun supports installable plugins such as `@kanun-hq/plugin-file`.
 
 Plugin usage, file validation rules, and framework upload adapters are fully documented:
 

package/dist/index.d.ts

@@ -45,6 +45,100 @@ declare abstract class IRuleContract {
   trans(path: string, params?: GenericObject): string;
 }
 //#endregion
+//#region src/Rules/in.d.ts
+declare class In extends BaseRule {
+  /**
+   * The name of the rule.
+   */
+  rule: string;
+  /**
+   * The accepted values.
+   */
+  values: (string | number)[];
+  /**
+   * Create a new In rule instance.
+   */
+  constructor(values: (string | number)[]);
+  /**
+   * Convert the rule to a validation string.
+   */
+  toString(): string;
+}
+//#endregion
+//#region src/Rules/notIn.d.ts
+declare class NotIn extends BaseRule {
+  /**
+   * The name of the rule.
+   */
+  rule: string;
+  /**
+   * The accepted values.
+   */
+  values: (string | number)[];
+  /**
+   * Create a new NotIn rule instance.
+   */
+  constructor(values: (string | number)[]);
+  /**
+   * Convert the rule to a validation string.
+   */
+  toString(): string;
+}
+//#endregion
+//#region src/Rules/regex.d.ts
+declare class Regex extends IRuleContract {
+  /**
+   * The Regular expression to validate
+   */
+  regex: RegExp;
+  /**
+   * Flag that decides whether the value should match the regular expression or not
+   */
+  shouldMatch: boolean;
+  constructor(regex: RegExp, shouldMatch?: boolean);
+  passes(value: any): boolean;
+  getMessage(): string;
+}
+//#endregion
+//#region src/Rules/requiredIf.d.ts
+declare class RequiredIf extends BaseRule {
+  /**
+   * The condition that validates the attribute
+   */
+  condition: boolean | CallableFunction;
+  /**
+   * Create a new required validation rule based on a condition.
+   */
+  constructor(condition: boolean | CallableFunction);
+  /**
+   * Convert the rule to a validation string.
+   */
+  toString(): string;
+}
+//#endregion
+//#region src/Contracts/ValidationRuleName.d.ts
+type ValidationRuleAutocompleteKind = 'plain' | 'paramable';
+interface ValidationRuleAutocompleteMap {}
+/**
+ * Backward-compatible alias for older plugin augmentations.
+ */
+interface CustomValidationRuleNameMap {}
+type LiteralUnion<T extends U, U = string> = T | (U & Record<never, never>);
+type PluginValidationRuleNameMap = ValidationRuleAutocompleteMap & CustomValidationRuleNameMap;
+type CustomParamableValidationRuleName = Extract<{ [K in keyof PluginValidationRuleNameMap]: PluginValidationRuleNameMap[K] extends 'paramable' ? K : never }[keyof PluginValidationRuleNameMap], string>;
+type CustomPlainRuleName = Extract<{ [K in keyof PluginValidationRuleNameMap]: PluginValidationRuleNameMap[K] extends 'plain' ? K : never }[keyof PluginValidationRuleNameMap], string>;
+type ParamableValidationRuleName = 'accepted_if' | 'after' | 'after_or_equal' | 'before' | 'before_or_equal' | 'between' | 'date_equals' | 'datetime' | 'declined_if' | 'digits_between' | 'different' | 'exists' | 'ends_with' | 'gt' | 'gte' | 'in' | 'includes' | 'lt' | 'lte' | 'max' | 'min' | 'not_in' | 'not_includes' | 'required_if' | 'required_unless' | 'required_with' | 'required_with_all' | 'required_without' | 'required_without_all' | 'same' | 'size' | 'starts_with' | 'unique' | CustomParamableValidationRuleName;
+type PlainRuleName = 'accepted' | 'alpha' | 'alpha_dash' | 'alpha_num' | 'array' | 'array_unique' | 'bail' | 'boolean' | 'confirmed' | 'date' | 'declined' | 'digits' | 'email' | 'integer' | 'json' | 'not_regex' | 'nullable' | 'numeric' | 'object' | 'present' | 'regex' | 'required' | 'sometimes' | 'string' | 'url' | 'hex' | 'uuid' | CustomPlainRuleName;
+type ValidationRuleName = ParamableValidationRuleName | PlainRuleName;
+type MethodRules = Regex | In | NotIn | RequiredIf;
+type ParamableRuleString = `${ParamableValidationRuleName}:${string}`;
+type ValidationRuleString = LiteralUnion<ValidationRuleName | ParamableRuleString>;
+/**
+ * Single rule value (supports autocomplete + arbitrary strings + RuleContract instances)
+ */
+type ValidationRuleEntry = ValidationRuleString | IRuleContract | MethodRules;
+type ValidationRuleSet = ValidationRuleEntry | readonly ValidationRuleEntry[] | LiteralUnion<`${ValidationRuleName}${string & `|${string}`}` | `${ParamableRuleString}${string & `|${string}`}`>;
+//#endregion
 //#region src/payloads/replaceAttributePayload.d.ts
 declare class replaceAttributePayload {
   /**
@@ -71,7 +165,7 @@ declare class replaceAttributePayload {
 }
 //#endregion
 //#region src/Contracts/BaseContract.d.ts
-type InitialRule = string | ValidationCallback | IRuleContract | BaseRule;
+type InitialRule = ValidationRuleEntry | ValidationCallback | BaseRule;
 type TRule = string | IRuleContract;
 type NestedStringMap = {
   [key: string]: string | NestedStringMap;
@@ -664,93 +758,6 @@ declare abstract class IValidationRule {
   passes(value: any, attribute: string): boolean | Promise<boolean>;
 }
 //#endregion
-//#region src/Rules/in.d.ts
-declare class In extends BaseRule {
-  /**
-   * The name of the rule.
-   */
-  rule: string;
-  /**
-   * The accepted values.
-   */
-  values: (string | number)[];
-  /**
-   * Create a new In rule instance.
-   */
-  constructor(values: (string | number)[]);
-  /**
-   * Convert the rule to a validation string.
-   */
-  toString(): string;
-}
-//#endregion
-//#region src/Rules/notIn.d.ts
-declare class NotIn extends BaseRule {
-  /**
-   * The name of the rule.
-   */
-  rule: string;
-  /**
-   * The accepted values.
-   */
-  values: (string | number)[];
-  /**
-   * Create a new NotIn rule instance.
-   */
-  constructor(values: (string | number)[]);
-  /**
-   * Convert the rule to a validation string.
-   */
-  toString(): string;
-}
-//#endregion
-//#region src/Rules/regex.d.ts
-declare class Regex extends IRuleContract {
-  /**
-   * The Regular expression to validate
-   */
-  regex: RegExp;
-  /**
-   * Flag that decides whether the value should match the regular expression or not
-   */
-  shouldMatch: boolean;
-  constructor(regex: RegExp, shouldMatch?: boolean);
-  passes(value: any): boolean;
-  getMessage(): string;
-}
-//#endregion
-//#region src/Rules/requiredIf.d.ts
-declare class RequiredIf extends BaseRule {
-  /**
-   * The condition that validates the attribute
-   */
-  condition: boolean | CallableFunction;
-  /**
-   * Create a new required validation rule based on a condition.
-   */
-  constructor(condition: boolean | CallableFunction);
-  /**
-   * Convert the rule to a validation string.
-   */
-  toString(): string;
-}
-//#endregion
-//#region src/Contracts/ValidationRuleName.d.ts
-interface CustomValidationRuleNameMap {
-  [key: string]: any;
-}
-type CustomParamableValidationRuleName = Extract<{ [K in keyof CustomValidationRuleNameMap]: CustomValidationRuleNameMap[K] extends 'paramable' ? K : never }[keyof CustomValidationRuleNameMap], string>;
-type CustomPlainRuleName = Extract<{ [K in keyof CustomValidationRuleNameMap]: CustomValidationRuleNameMap[K] extends 'plain' ? K : never }[keyof CustomValidationRuleNameMap], string>;
-type ParamableValidationRuleName = 'accepted_if' | 'after' | 'after_or_equal' | 'before' | 'before_or_equal' | 'between' | 'date_equals' | 'datetime' | 'declined_if' | 'digits_between' | 'different' | 'exists' | 'ends_with' | 'gt' | 'gte' | 'in' | 'includes' | 'lt' | 'lte' | 'max' | 'min' | 'not_in' | 'not_includes' | 'required_if' | 'required_unless' | 'required_with' | 'required_with_all' | 'required_without' | 'required_without_all' | 'same' | 'size' | 'starts_with' | 'unique' | CustomParamableValidationRuleName;
-type PlainRuleName = 'accepted' | 'alpha' | 'alpha_dash' | 'alpha_num' | 'array' | 'array_unique' | 'bail' | 'boolean' | 'confirmed' | 'date' | 'declined' | 'digits' | 'email' | 'integer' | 'json' | 'not_regex' | 'nullable' | 'numeric' | 'object' | 'present' | 'regex' | 'required' | 'sometimes' | 'string' | 'url' | 'hex' | 'uuid' | CustomPlainRuleName;
-type ValidationRuleName = ParamableValidationRuleName | PlainRuleName;
-type MethodRules = Regex | In | NotIn | RequiredIf;
-/**
- * Single rule value (supports autocomplete + arbitrary strings + RuleContract instances)
- */
-type RuleName = ValidationRuleName | `${ParamableValidationRuleName}:${string}` | IRuleContract | MethodRules;
-type ValidationRuleSet = RuleName | RuleName[] | `${ValidationRuleName}${string & `|${string}`}`;
-//#endregion
 //#region src/Contracts/ValidatorContracts.d.ts
 /**
  * Parse rule names from rule string or string[] definitions
@@ -1613,4 +1620,4 @@ declare class ValidationException extends Error {
   getResponse(): any;
 }
 //#endregion
-export { BaseValidationRuleClass, BaseValidator, CustomAttributes, CustomErrors, CustomMessages, CustomParamableValidationRuleName, CustomPlainRuleName, CustomValidationRuleNameMap, 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, ValidationValueInspector, Validator, ValidatorPlugin, ValidatorPluginApi, addImplicitRule, buildValidationMethodName, compare, convertValuesToBoolean, convertValuesToNull, convertValuesToNumber, deepEqual, deepFind, deepFindMessage, deepSet, definePlugin, dotify, getFormattedAttribute, getKeyCombinations, getMessage, getNumericRules, getSize, getValidationMessageType, getValidationSize, getValidationValueInspector, getValidatorContext, isArrayOfRules, isImplicitRule, isInteger, isNumericRule, isObject, isRule, isSizeRule, make, mergeDeep, notRegex, plural, regex, register, registerImplicit, registerValueInspector, requiredIf, ruleIn, ruleNotIn, runWithValidatorContext, sameType, toDate, toSnakeCase, usePlugin, useValidatorContext };
+export { BaseValidationRuleClass, BaseValidator, CustomAttributes, CustomErrors, CustomMessages, CustomParamableValidationRuleName, CustomPlainRuleName, CustomValidationRuleNameMap, 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, ValidationRuleAutocompleteKind, ValidationRuleAutocompleteMap, ValidationRuleCallable, ValidationRuleEntry, ValidationRuleName, ValidationRuleParserInterface, ValidationRuleSet, ValidationServiceProvider, ValidationValueInspector, Validator, ValidatorPlugin, ValidatorPluginApi, addImplicitRule, buildValidationMethodName, compare, convertValuesToBoolean, convertValuesToNull, convertValuesToNumber, deepEqual, deepFind, deepFindMessage, deepSet, definePlugin, dotify, getFormattedAttribute, getKeyCombinations, getMessage, getNumericRules, getSize, getValidationMessageType, getValidationSize, getValidationValueInspector, getValidatorContext, isArrayOfRules, isImplicitRule, isInteger, isNumericRule, isObject, isRule, isSizeRule, make, mergeDeep, notRegex, plural, regex, register, registerImplicit, registerValueInspector, requiredIf, ruleIn, ruleNotIn, runWithValidatorContext, sameType, toDate, toSnakeCase, usePlugin, useValidatorContext };

package/package.json

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