@orieljs/validation 0.1.0-alpha.1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,9 @@
+Oriel
+Copyright 2026 meeeet-dev and Oriel contributors
+
+This product includes software developed by the Oriel project
+(https://orieljs.vercel.app, https://github.com/orieljs).
+
+Oriel is licensed under the Apache License, Version 2.0 (see LICENSE).
+The Oriel name and logo are not covered by that license; see TRADEMARKS.md
+(https://github.com/orieljs/framework/blob/main/TRADEMARKS.md).

package/dist/index.d.ts

@@ -0,0 +1,242 @@
+import { OrielError, ValidationError, Rules, MessageBag, ValidationRule, Validator as Validator$1, ValidationFactory, RuleCallback } from '@orieljs/contracts';
+import * as _orieljs_support from '@orieljs/support';
+import { ServiceProvider } from '@orieljs/support';
+
+declare class ValidationErrorImpl extends Error implements ValidationError {
+    readonly errors: Record<string, string[]>;
+    readonly errorBag: string;
+    readonly redirectTo?: string | undefined;
+    readonly kind: "Validation";
+    readonly status = 422;
+    readonly name = "ValidationError";
+    constructor(errors: Record<string, string[]>, errorBag?: string, redirectTo?: string | undefined);
+}
+declare class AuthorizationErrorImpl extends Error implements OrielError {
+    readonly kind: "Authorization";
+    readonly status = 403;
+    readonly name = "AuthorizationError";
+    constructor(message?: string);
+}
+declare class UnknownValidationRuleError extends Error implements OrielError {
+    readonly kind: "Server";
+    readonly status = 500;
+    readonly name = "UnknownValidationRuleError";
+    constructor(name: string);
+}
+/** A rule was written with a parameter it can't use (a bad regex, an unparseable date). A developer error, not a user one. */
+declare class InvalidRuleParameterError extends Error implements OrielError {
+    readonly kind: "Server";
+    readonly status = 500;
+    readonly name = "InvalidRuleParameterError";
+    constructor(rule: string, parameter: string, reason: string);
+}
+
+/**
+ * Mirrors Illuminate\Foundation\Http\FormRequest, minus dependency injection by type (Oriel resolves the current
+ * request and the ValidationFactory through inject(), never through constructor parameters — see spec §3 rule 5).
+ * A subclass only has to implement rules(); authorize()/messages()/attributes() default to Laravel's own defaults.
+ */
+declare abstract class FormRequest {
+    abstract rules(): Rules;
+    authorize(): boolean | Promise<boolean>;
+    messages(): Record<string, string>;
+    attributes(): Record<string, string>;
+    /**
+     * `const data = await StorePostRequest.validate()` (spec §4.3). Resolves the current request and the
+     * ValidationFactory from the active container, runs authorize() first (throwing AuthorizationErrorImpl if it
+     * returns false), then validates request.all() against rules()/messages()/attributes() and returns the typed
+     * validated data (or throws the 422 ValidationError — see ValidatorImpl.validated()).
+     */
+    static validate<T = Record<string, unknown>>(this: new () => FormRequest): Promise<T>;
+}
+
+/** Humanizes a (possibly dotted) attribute key, e.g. "items.0.product_name" -> "items.0.product name". */
+declare function defaultAttributeName(key: string): string;
+declare function applyReplacements(template: string, replacements: Record<string, string>): string;
+/** Laravel's English lang/en/validation.php, reproduced as closely as possible (see plan Notes/assumptions). */
+declare const DEFAULT_MESSAGES: Record<string, string>;
+
+declare class MessageBagImpl implements MessageBag {
+    private readonly items;
+    /** Not part of the MessageBag contract — used internally by ValidatorImpl and by after() hooks. */
+    add(key: string, message: string): void;
+    has(key: string): boolean;
+    first(key?: string): string | undefined;
+    get(key: string): string[];
+    all(): string[];
+    isEmpty(): boolean;
+    count(): number;
+    toObject(): Record<string, string[]>;
+}
+
+/** Everything a single rule needs to validate one concrete field. */
+interface RuleContext {
+    /** The concrete, wildcard-expanded field path, e.g. "items.1.name". */
+    attribute: string;
+    /** True when `attribute` came from expanding a wildcard pattern such as "items.*.email". */
+    expandedFromWildcard?: boolean;
+    value: unknown;
+    parameters: string[];
+    data: Record<string, unknown>;
+    /** Every named rule attached to this field (for size-type resolution: numeric/array/file/string). */
+    ruleNames: string[];
+}
+interface BuiltinRule {
+    validate(ctx: RuleContext): boolean | Promise<boolean>;
+    /** Which DEFAULT_MESSAGES key to use, e.g. `max.${sizeType}`. Most rules return a constant name. */
+    messageKey(ctx: RuleContext): string;
+    /** Extra :placeholder substitutions beyond :attribute (e.g. :max, :other, :values). */
+    replacements?(ctx: RuleContext): Record<string, string>;
+    /** Used when messageKey() isn't in DEFAULT_MESSAGES (e.g. an extend()ed rule with a custom message). */
+    defaultMessage?: string;
+    /** Runs even when the value is missing, blank, or null under nullable (the required* family, and accepted); a failure stops the field. */
+    implicit?: boolean;
+}
+type ParsedRule = {
+    kind: 'named';
+    name: string;
+    parameters: string[];
+} | {
+    kind: 'object';
+    rule: ValidationRule;
+};
+declare function parseRuleSpec(spec: string | ReadonlyArray<string | ValidationRule>): ParsedRule[];
+/** Laravel's definition of "empty" for the required family: null, undefined, '' and []. false and 0 are NOT empty. */
+declare function isEmptyValue(value: unknown): boolean;
+/** Duck-types Contracts/Http's UploadedFile without importing @orieljs/http. */
+declare function isUploadedFileLike(value: unknown): value is {
+    clientName: string;
+    mimeType: string;
+    size: number;
+    extension(): string;
+    arrayBuffer(): Promise<ArrayBuffer>;
+};
+/**
+ * Expands a `*`-wildcard rule pattern (e.g. "items.*.name") into every concrete path present in `data`
+ * (e.g. ["items.0.name", "items.1.name"]). A pattern with no `*` is returned unchanged. A `*` segment whose
+ * container is missing, not an array and not a plain object expands to nothing for that branch (Review Focus #4:
+ * every reported error is keyed by a concrete path, never the literal pattern). Object keys in UNSAFE_KEYS are
+ * treated as absent, so a JSON body like {"items":{"__proto__":{...}}} never yields a path through the prototype.
+ */
+declare function expandWildcardKeys(pattern: string, data: Record<string, unknown>): string[];
+
+/** Every built-in rule, merged. Later tasks (database rules) add their own spread here. */
+declare const builtinRules: Record<string, BuiltinRule>;
+
+/**
+ * Base for the fluent builders. Each one reports under a built-in rule name (`in`, `unique`, `exists`), so when it
+ * runs inside a Validator its failure goes through exactly the same lookup as the string rule: custom messages
+ * ("email.unique", "items.*.email.unique", "unique"), custom attributes, then the default text. Called directly
+ * as a plain ValidationRule, validate() fails with the default English message.
+ */
+declare abstract class BuiltinRuleObject implements ValidationRule {
+    abstract readonly ruleName: string;
+    abstract passes(attribute: string, value: unknown, data: Record<string, unknown>, expandedFromWildcard?: boolean): boolean | Promise<boolean>;
+    validate(attribute: string, value: unknown, fail: (message: string) => void, data: Record<string, unknown>, expandedFromWildcard?: boolean): Promise<void>;
+}
+declare class InRule extends BuiltinRuleObject {
+    private readonly values;
+    readonly ruleName = "in";
+    constructor(values: readonly unknown[]);
+    passes(_attribute: string, value: unknown): boolean;
+}
+declare class UniqueRule extends BuiltinRuleObject {
+    private readonly table;
+    private readonly column?;
+    readonly ruleName = "unique";
+    private exceptId;
+    private idColumnName;
+    constructor(table: string, column?: string | undefined);
+    /**
+     * Excludes the current record from the uniqueness check. Laravel's `Rule::unique('users')->ignore($user)` accepts
+     * a model directly (the common case: "update your profile without changing your email"), so a model instance is
+     * bound by its key (`getKey()`/`getKeyName()`), not the object itself — the object would reach the query builder
+     * as an opaque value and either be rejected by the driver or stringified (B27). A plain id still works as before;
+     * null (or "NULL") excludes nothing.
+     */
+    ignore(id: unknown, idColumn?: string): this;
+    passes(attribute: string, value: unknown, _data?: Record<string, unknown>, expandedFromWildcard?: boolean): Promise<boolean>;
+}
+declare class ExistsRule extends BuiltinRuleObject {
+    private readonly table;
+    private readonly column?;
+    readonly ruleName = "exists";
+    constructor(table: string, column?: string | undefined);
+    passes(attribute: string, value: unknown, _data?: Record<string, unknown>, expandedFromWildcard?: boolean): Promise<boolean>;
+}
+/** Fluent rule-object builders, for when a plain string rule can't express what's needed (e.g. .ignore()). */
+declare const Rule: {
+    in: (values: readonly unknown[]) => InRule;
+    unique: (table: string, column?: string) => UniqueRule;
+    exists: (table: string, column?: string) => ExistsRule;
+};
+
+/** See Task 9's writeup in the plan for exactly what this does and doesn't infer. */
+type SplitPipe<S extends string> = S extends `${infer Head}|${infer Tail}` ? Head | SplitPipe<Tail> : S;
+type RuleName<T extends string> = T extends `${infer Name}:${string}` ? Name : T;
+type Names<S extends string> = RuleName<SplitPipe<S>>;
+type BaseType<S extends string> = 'array' extends Names<S> ? unknown[] : 'boolean' extends Names<S> ? boolean : 'integer' extends Names<S> ? number : 'numeric' extends Names<S> ? number : 'email' extends Names<S> ? string : 'url' extends Names<S> ? string : 'uuid' extends Names<S> ? string : 'date' extends Names<S> ? string : 'string' extends Names<S> ? string : unknown;
+/**
+ * The inferred type for one rule string, e.g. 'nullable|integer' -> number | null. A non-literal `string` (a rules
+ * object declared without `as const`) carries no rule names to read, so it infers unknown: without this guard every
+ * `'x' extends string` check would match and the result would wrongly be `unknown[] | null`.
+ */
+type InferRuleType<S extends string> = string extends S ? unknown : 'nullable' extends Names<S> ? BaseType<S> | null : BaseType<S>;
+/**
+ * Best-effort: applies InferRuleType to every string-valued rule; array-form (mixed string/object) rules -> unknown.
+ * Strips `readonly` (via `-readonly`) so a `Rules` object declared `as const` (the common way to get literal rule
+ * strings for inference — see the Task 9 type test) still produces a plain, mutable validated-data shape, not a
+ * readonly one; a mapped type otherwise carries the source's readonly modifier over by default.
+ */
+type InferValidatedType<R> = {
+    -readonly [K in keyof R]: R[K] extends string ? InferRuleType<R[K]> : unknown;
+};
+
+/**
+ * Runs each field's rules the way Laravel's Validator does:
+ * - a missing key, or a string that is blank after trimming, only runs implicit rules (the required* family and
+ *   accepted); every other rule, including ValidationRule objects, is skipped for it;
+ * - an explicit null runs every rule unless the field is `nullable` (then only implicit rules run), so
+ *   `{ age: null }` still fails `integer`;
+ * - `sometimes` skips a missing field entirely;
+ * - a field stops validating after its first failure under `bail`, or after any implicit rule fails.
+ */
+declare class ValidatorImpl implements Validator$1 {
+    private readonly data;
+    private readonly rules;
+    private readonly customMessages;
+    private readonly customAttributes;
+    private readonly registry;
+    private readonly errorBagName;
+    private bag;
+    private ranPromise;
+    private readonly afterCallbacks;
+    constructor(data: Record<string, unknown>, rules: Rules, customMessages: Record<string, string>, customAttributes: Record<string, string>, registry: Record<string, BuiltinRule>, errorBagName?: string);
+    after(callback: (validator: Validator$1) => void | Promise<void>): this;
+    /** Not part of the Validator contract — lets an after() hook add a failure (MessageBag itself is read-only). */
+    fail(field: string, message: string): void;
+    passes(): Promise<boolean>;
+    fails(): Promise<boolean>;
+    errors(): MessageBagImpl;
+    validated<T = Record<string, unknown>>(): Promise<T>;
+    private fieldsFor;
+    private run;
+    private runRule;
+    /** Custom message (concrete field, then wildcard pattern, then rule name) or the default, with :attribute filled. */
+    private failureMessage;
+}
+
+declare class ValidationFactoryImpl implements ValidationFactory {
+    private readonly extended;
+    make(data: Record<string, unknown>, rules: Rules, messages?: Record<string, string>, attributes?: Record<string, string>): ValidatorImpl;
+    extend(name: string, callback: RuleCallback, message?: string): void;
+}
+
+/** Laravel's Validator facade: Validator.make(...)/Validator.extend(...), proxied to the resolved ValidationFactory. */
+declare const Validator: _orieljs_support.Facade<ValidationFactory, object>;
+
+declare class ValidationServiceProvider extends ServiceProvider {
+    register(): void;
+}
+
+export { AuthorizationErrorImpl, type BuiltinRule, BuiltinRuleObject, DEFAULT_MESSAGES, FormRequest, type InferRuleType, type InferValidatedType, InvalidRuleParameterError, MessageBagImpl, type ParsedRule, Rule, type RuleContext, UnknownValidationRuleError, ValidationErrorImpl, ValidationFactoryImpl, ValidationServiceProvider, Validator, ValidatorImpl, applyReplacements, builtinRules, defaultAttributeName, expandWildcardKeys, isEmptyValue, isUploadedFileLike, parseRuleSpec };