@h3ravel/validation 0.1.0-alpha.1

package/dist/index.d.ts

@@ -0,0 +1,340 @@
+/// <reference path="./app.globals.d.ts" />
+import * as _h3ravel_contracts0 from "@h3ravel/contracts";
+import { BaseValidationRuleClass, DotPaths, IMessageBag, IRequest, IValidationRule, IValidator, MessagesForRules, MessagesForRules as MessagesForRules$1, RulesForData, RulesForData as RulesForData$1, ValidationMessageProvider, ValidationRuleCallable, ValidationRuleSet } from "@h3ravel/contracts";
+import { ImplicitRule as ImplicitRule$1, Rule } from "simple-body-validator";
+import { UnprocessableEntityHttpException } from "@h3ravel/foundation";
+
+//#region src/utilities/MessageBag.d.ts
+declare class MessageBag implements IMessageBag {
+  /**
+   * All of the registered messages.
+   */
+  protected messages: Record<string, string[]>;
+  /**
+   * Default format for message output.
+   */
+  protected format: string;
+  /**
+   * Create a new message bag instance.
+   */
+  constructor(messages?: Record<string, string[] | string>);
+  /**
+   * Get all message keys.
+   */
+  keys(): string[];
+  /**
+   * Add a message.
+   */
+  add(key: string, message: string): this;
+  /**
+   * Add a message conditionally.
+   */
+  addIf(condition: boolean, key: string, message: string): this;
+  /**
+   * Check uniqueness of key/message pair.
+   */
+  protected isUnique(key: string, message: string): boolean;
+  /**
+   * Merge another message source into this one.
+   */
+  merge(messages: Record<string, string[]> | ValidationMessageProvider): this;
+  /**
+   * Determine if messages exist for all given keys.
+   */
+  has(key: string | string[] | null): boolean;
+  /**
+   * Determine if messages exist for any given key.
+   */
+  hasAny(keys?: string | string[]): boolean;
+  /**
+   * Determine if messages don't exist for given keys.
+   */
+  missing(key: string | string[]): boolean;
+  /**
+   * Get the first message for a given key.
+   */
+  first(key?: string | null, format?: string | null): string;
+  /**
+   * Get all messages for a given key.
+   */
+  get(key: string, format?: string | null): string[] | Record<string, string[]>;
+  /**
+   * Wildcard key match.
+   */
+  protected getMessagesForWildcardKey(key: string, format: string | null): Record<string, string[]>;
+  /**
+   * Get all messages.
+   */
+  all(format?: string | null): string[];
+  /**
+   * Get unique messages.
+   */
+  unique(format?: string | null): string[];
+  /**
+   * Remove messages for a key.
+   */
+  forget(key: string): this;
+  /**
+   * Format an array of messages.
+   */
+  protected transform(messages: string[], format: string, messageKey: string): string[];
+  /**
+   * Get proper format string.
+   */
+  protected checkFormat(format?: string | null): string;
+  /**
+   * Get raw messages.
+   */
+  messagesRaw(): Record<string, string[]>;
+  /**
+   * Alias for messagesRaw().
+   */
+  getMessages(): Record<string, string[]>;
+  /**
+   * Return message bag instance.
+   */
+  getMessageBag(): MessageBag;
+  /**
+   * Get format string.
+   */
+  getFormat(): string;
+  /**
+   * Set default message format.
+   */
+  setFormat(format?: string): this;
+  /**
+   * Empty checks.
+   */
+  isEmpty(): boolean;
+  isNotEmpty(): boolean;
+  any(): boolean;
+  /**
+   * Count total messages.
+   */
+  count(): number;
+  /**
+   * Array & JSON conversions.
+   */
+  toArray(): Record<string, string[]>;
+  jsonSerialize(): any;
+  toJson(options?: number): string;
+  toPrettyJson(): string;
+  /**
+   * String representation.
+   */
+  toString(): string;
+}
+//#endregion
+//#region src/Validator.d.ts
+declare class Validator<D extends Record<string, any> = any, R extends RulesForData$1<D> = RulesForData$1<D>> implements IValidator<D, R> {
+  #private;
+  private data;
+  private rules;
+  private _errors;
+  private passing;
+  private executed;
+  private instance?;
+  private errorBagName;
+  private registeredCustomRules;
+  private shouldStopOnFirstFailure;
+  constructor(data: D, rules: R, messages?: Partial<Record<MessagesForRules$1<R>, string>>);
+  /**
+   * Validate the data and return the instance
+   */
+  static make<D extends Record<string, any>, R extends RulesForData$1<D>>(data: D, rules: R, messages?: Partial<Record<MessagesForRules$1<R>, string>>): Validator<D, R>;
+  /**
+   * Run the validator and store results.
+   */
+  passes(): Promise<boolean>;
+  /**
+   * Opposite of passes()
+   */
+  fails(): Promise<boolean>;
+  /**
+   * Throw if validation fails, else return executed data
+   *
+   * @throws ValidationException if validation fails
+   */
+  validate(): Promise<Record<string, any>>;
+  /**
+   * Run the validator's rules against its data.
+   * @param bagName
+   * @returns
+   */
+  validateWithBag(bagName: string): Promise<Record<string, any>>;
+  /**
+   * Stop validation on first failure.
+   */
+  stopOnFirstFailure(): this;
+  /**
+   * Get the data that passed validation.
+   */
+  validatedData(): Record<string, any>;
+  /**
+   * Return all validated input.
+   */
+  validated(): Partial<D>;
+  /**
+   * Return a portion of validated input
+   */
+  safe(): {
+    only: (keys: string[]) => Partial<D>;
+    except: (keys: string[]) => Partial<D>;
+  };
+  /**
+   * Get the message container for the validator.
+   */
+  messages(): Promise<Partial<Record<MessagesForRules$1<R>, string>>>;
+  /**
+   * Add an after validation callback.
+   *
+   * @param  callback
+   */
+  after<C extends ((validator: Validator<D, R>) => void) | BaseValidationRuleClass>(callback: C | C[]): this;
+  /**
+   * Get all errors.
+   */
+  errors(): MessageBag;
+  errorBag(): string;
+  /**
+   * Reset validator with new data.
+   */
+  setData(data: D): this;
+  /**
+   * Set validation rules.
+   */
+  setRules(rules: R): this;
+  /**
+   * Add a single rule to existing rules.
+   */
+  addRule(key: DotPaths<D>, rule: ValidationRuleSet): this;
+  /**
+   * Merge additional rules.
+   */
+  mergeRules(rules: Record<string, string>): this;
+  /**
+   * Get current data.
+   */
+  getData(): Record<string, any>;
+  /**
+   * Get current rules.
+   */
+  getRules(): R;
+  /**
+   * Bind all required services here.
+   */
+  private bindServices;
+  private execute;
+}
+//#endregion
+//#region src/ImplicitRule.d.ts
+declare abstract class ImplicitRule extends ImplicitRule$1 {
+  rules: ValidationRuleCallable[];
+  /**
+   * Run the validation rule.
+   */
+  abstract validate(attribute: string, value: any, fail: (msg: string) => any): void;
+  /**
+   * Set the current validator.
+   */
+  setValidator?(validator: Validator<any, any>): this;
+}
+//#endregion
+//#region src/Providers/ValidationServiceProvider.d.ts
+/**
+ * Service provider for Validation utilities
+ */
+declare class ValidationServiceProvider {
+  private app;
+  registeredCommands?: (new (app: any, kernel: any) => any)[];
+  static priority: number;
+  constructor(app: any);
+  /**
+   * Register URL services in the container
+   */
+  register(): void;
+  /**
+   * Boot URL services
+   */
+  boot(): void;
+}
+//#endregion
+//#region src/ValidationRule.d.ts
+declare abstract class ValidationRule<D extends Record<string, any> = any, R extends RulesForData$1<D> = any> extends Rule implements IValidationRule {
+  rules: ValidationRuleCallable[];
+  private passing;
+  /**
+   * Run the validation rule.
+   */
+  abstract validate(attribute: string, value: any, fail: (msg: string) => any): void;
+  /**
+   * Set the current validator.
+   */
+  setValidator?(validator: Validator<D, R>): this;
+  /**
+   * Set the data under validation.
+   */
+  setData(_data: Record<string, any>): this;
+  passes(value: any, attribute: string): boolean | Promise<boolean>;
+}
+//#endregion
+//#region src/Rules/ExtendedRules.d.ts
+declare class ExtendedRules extends ValidationRule {
+  /**
+   * The validator instance.
+   */
+  protected validator: Validator<any, any>;
+  setValidator(validator: Validator<any, any>): this;
+  rules: ValidationRuleCallable[];
+  validate(): void;
+}
+//#endregion
+//#region src/ValidationException.d.ts
+declare class ValidationException extends UnprocessableEntityHttpException {
+  validator: Validator<any, any>;
+  response?: any;
+  status: number;
+  errorBag: string;
+  redirectTo?: string;
+  constructor(validator: Validator<any, any>, response?: any, errorBag?: string);
+  /**
+   * Send a custom response body for this exception
+   *
+   * @param request
+   * @returns
+   */
+  toResponse(request: IRequest): _h3ravel_contracts0.IResponse | {
+    message: string;
+    errors: Record<string, string[]>;
+  };
+  /**
+   * Create a new validation exception from a plain array of messages.
+   */
+  static withMessages(messages: Record<string, string[] | string>): ValidationException;
+  /**
+   * Create a readable summary message from the validation errors.
+   */
+  protected static summarize(validator: Validator<any, any>): string;
+  /**
+   * Get all of the validation error messages.
+   */
+  errors(): Record<string, string[]>;
+  /**
+   * Set the HTTP status code to be used for the response.
+   */
+  setStatus(status: number): this;
+  /**
+   * Set the error bag on the exception.
+   */
+  setErrorBag(errorBag: string): this;
+  /**
+   * Set the URL to redirect to on a validation error.
+   */
+  setRedirectTo(url: string): this;
+  /**
+   * Get the underlying response instance.
+   */
+  getResponse(): any;
+}
+//#endregion
+export { ExtendedRules, ImplicitRule, MessageBag, type MessagesForRules, type RulesForData, ValidationException, ValidationRule, ValidationServiceProvider, Validator };