@c9up/rune 0.1.6 → 0.1.8

package/dist/errors.js

@@ -11,4 +11,41 @@ export class RuneError extends Error {
         this.hint = options?.hint;
     }
 }
+/**
+ * Thrown by {@link ValidationSchema.validateOrThrow} — VineJS's
+ * `E_VALIDATION_ERROR`. Carries the structured `messages` array and an HTTP
+ * `status` (422) so web layers can render it directly, matching AdonisJS/VineJS.
+ */
+export class RuneValidationError extends Error {
+    /** Internal error code for programmatic handling (VineJS parity). */
+    code = "E_VALIDATION_ERROR";
+    /** HTTP status for the failure (422 Unprocessable Entity). */
+    status = 422;
+    /** Structured, per-field validation messages. */
+    messages;
+    constructor(messages, options) {
+        super("Validation failure", options);
+        this.name = "RuneValidationError";
+        this.messages = messages;
+        if ("captureStackTrace" in Error) {
+            Error.captureStackTrace(this, RuneValidationError);
+        }
+    }
+    get [Symbol.toStringTag]() {
+        return this.name;
+    }
+    toString() {
+        return `${this.name} [${this.code}]: ${this.message}`;
+    }
+}
+/**
+ * VineJS-compatible alias. Adonis/Vine code catches on the error's NAME:
+ *
+ *   import { errors } from '@c9up/rune'
+ *   if (error instanceof errors.E_VALIDATION_ERROR) { ... }
+ *
+ * Without this binding the namespace exists but the member does not, and a
+ * copy-pasted Adonis handler silently never matches.
+ */
+export const E_VALIDATION_ERROR = RuneValidationError;
 //# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -1 +1 @@
-{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,OAAO,SAAU,SAAQ,KAAK;IAC1B,IAAI,CAAS;IACb,IAAI,CAAU;IAEvB,YAAY,IAAY,EAAE,OAAe,EAAE,OAA2B;QACrE,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,QAAQ,IAAI,EAAE,CAAC;QAC3B,IAAI,CAAC,IAAI,GAAG,OAAO,EAAE,IAAI,CAAC;IAC3B,CAAC;CACD"}
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,OAAO,SAAU,SAAQ,KAAK;IAC1B,IAAI,CAAS;IACb,IAAI,CAAU;IAEvB,YAAY,IAAY,EAAE,OAAe,EAAE,OAA2B;QACrE,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,QAAQ,IAAI,EAAE,CAAC;QAC3B,IAAI,CAAC,IAAI,GAAG,OAAO,EAAE,IAAI,CAAC;IAC3B,CAAC;CACD;AAmBD;;;;GAIG;AACH,MAAM,OAAO,mBAAoB,SAAQ,KAAK;IAC7C,qEAAqE;IAC5D,IAAI,GAAG,oBAAoB,CAAC;IACrC,8DAA8D;IACrD,MAAM,GAAG,GAAG,CAAC;IACtB,iDAAiD;IACxC,QAAQ,CAAkB;IAEnC,YAAY,QAAyB,EAAE,OAAsB;QAC5D,KAAK,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;QACrC,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC;QAClC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,mBAAmB,IAAI,KAAK,EAAE,CAAC;YAClC,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,mBAAmB,CAAC,CAAC;QACpD,CAAC;IACF,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;QACvB,OAAO,IAAI,CAAC,IAAI,CAAC;IAClB,CAAC;IAEQ,QAAQ;QAChB,OAAO,GAAG,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;IACvD,CAAC;CACD;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,mBAAmB,CAAC"}

package/dist/formats.d.ts

@@ -0,0 +1,149 @@
+/**
+ * Format validators backing the VineJS string/number/array rules.
+ *
+ * VineJS delegates these to `validator.js`. rune has zero runtime dependencies,
+ * so each check is implemented here. Where VineJS ships a per-locale table we
+ * cannot reasonably reproduce in full (mobile numbers, postal codes, passports),
+ * rune supports a named subset and **fails closed** on an unknown locale rather
+ * than waving the value through — an unchecked value that reports "valid" is the
+ * failure mode this package exists to prevent.
+ */
+/** Code-point scan rather than a control-character regex, which lints as suspicious. */
+export declare const isAscii: (v: string) => boolean;
+export declare const isHexCode: (v: string) => boolean;
+export declare const isUlid: (v: string) => boolean;
+export declare const isJwt: (v: string) => boolean;
+export declare function isIpAddress(v: string, version?: 4 | 6): boolean;
+/** Luhn checksum — the digits-only part of card validation. */
+export declare function isCreditCard(v: string): boolean;
+/** IBAN mod-97 check (ISO 13616), computed digit by digit to avoid BigInt. */
+export declare function isIban(v: string): boolean;
+/** `"lat,lng"` within the valid ranges. */
+export declare function isCoordinates(v: string): boolean;
+/** Country codes rune can check postal codes for. */
+export declare const SUPPORTED_POSTAL_CODES: string[];
+export declare function isPostalCode(v: string, countryCode: string): boolean | null;
+/**
+ * Mobile numbers in E.164 form. Named deviation from VineJS: rune does NOT
+ * carry per-locale numbering plans, so `locale` is not accepted — a caller that
+ * needs one writes a `.regex()` or a custom rule.
+ */
+export declare const isMobile: (v: string) => boolean;
+/** HTML-escape the five characters that break out of markup (VineJS `escape`). */
+export declare function escapeHtml(v: string): string;
+/** Options accepted by `normalizeEmail` (subset of VineJS's). */
+export interface NormalizeEmailOptions {
+    /** validator.js spelling — takes precedence over the camelCase alias. */
+    all_lowercase?: boolean;
+    /** validator.js spelling. */
+    gmail_remove_dots?: boolean;
+    /** validator.js spelling. */
+    gmail_remove_subaddress?: boolean;
+    /** Lowercase the whole address. Defaults to `true`, like VineJS. */
+    allLowercase?: boolean;
+    /** Strip dots from a Gmail local part (`a.b@gmail.com` → `ab@gmail.com`). */
+    gmailRemoveDots?: boolean;
+    /** Drop a `+tag` suffix from the local part. */
+    gmailRemoveSubaddress?: boolean;
+}
+export declare function normalizeEmail(value: string, options?: NormalizeEmailOptions): string;
+/** Options accepted by `normalizeUrl` (subset of VineJS's). */
+export interface NormalizeUrlOptions {
+    /** Remove a leading `www.` from the host. */
+    stripWWW?: boolean;
+    /** Force this protocol (e.g. `"https"`). */
+    forceProtocol?: string;
+    /** Rewrite `http:` to `https:` (normalize-url `forceHttps`). */
+    forceHttps?: boolean;
+    /** Drop the trailing slash of an empty path. */
+    stripTrailingSlash?: boolean;
+    /** Drop the trailing slash of ANY path (normalize-url `removeTrailingSlash`). */
+    removeTrailingSlash?: boolean;
+    /** Drop the `#fragment`. */
+    stripHash?: boolean;
+    /** Drop the scheme entirely, leaving `example.com/path`. */
+    stripProtocol?: boolean;
+    /** Drop `user:pass@`. */
+    stripAuthentication?: boolean;
+    /** Drop `:80` / `:443` when they match the scheme's default. */
+    removeExplicitPort?: boolean;
+    /** Sort the query parameters by name, for a stable comparison key. */
+    sortQueryParameters?: boolean;
+    /** Query parameters to remove — names, or patterns matched against names. */
+    removeQueryParameters?: ReadonlyArray<string | RegExp>;
+    /** Drop `index.html` / `index.php`-style directory indexes. */
+    removeDirectoryIndex?: boolean;
+}
+export declare function normalizeUrl(value: string, options?: NormalizeUrlOptions): string;
+/** `dash-case`, `snake_case` and spaced words to `camelCase`. */
+export declare function toCamelCase(v: string): string;
+export declare const SUPPORTED_PASSPORTS: string[];
+export declare function isPassport(v: string, countryCode: string): boolean | null;
+/** Options accepted by `alpha()` / `alphaNumeric()` (VineJS spelling). */
+export interface AlphaOptions {
+    allowSpaces?: boolean;
+    allowUnderscores?: boolean;
+    allowDashes?: boolean;
+}
+/** Build the character class for `alpha`/`alphaNumeric` from its options. */
+export declare function alphaPattern(base: string, options?: AlphaOptions): RegExp;
+/** Options accepted by `url()` — the validator.js names VineJS forwards. */
+export interface UrlOptions {
+    /** validator.js spelling — takes precedence over the camelCase alias. */
+    require_protocol?: boolean;
+    /** validator.js spelling. */
+    require_tld?: boolean;
+    /** validator.js spelling. */
+    allow_underscores?: boolean;
+    /** Require an explicit scheme. Defaults to `true`, like validator.js. */
+    requireProtocol?: boolean;
+    /** Allowed schemes, without the colon. Defaults to http/https. */
+    protocols?: string[];
+    /** Require a dotted host (rejects `http://localhost`). Defaults to `true`. */
+    requireTld?: boolean;
+    /** Allow `_` in the host. */
+    allowUnderscores?: boolean;
+}
+export declare function isUrlWithOptions(value: string, options?: UrlOptions): boolean;
+export declare const SUPPORTED_MOBILE_LOCALES: string[];
+export declare function isMobileForLocale(v: string, locale: string): boolean | null;
+/**
+ * Options accepted by `email()` — the validator.js names VineJS forwards.
+ * Implemented here rather than delegated: rune carries no runtime dependency,
+ * so every check it claims to do, it does itself.
+ */
+export interface EmailOptions {
+    /** Accept `Name <a@b.io>`. Off by default. */
+    allow_display_name?: boolean;
+    /** Require a dotted domain. On by default. */
+    require_tld?: boolean;
+    /** Accept `user@[192.168.0.1]` / `user@[IPv6:…]`. Off by default. */
+    allow_ip_domain?: boolean;
+    /** Skip the RFC length caps (64 local / 254 total). Off by default. */
+    ignore_max_length?: boolean;
+    /** Characters refused anywhere in the local part. */
+    blacklisted_chars?: string;
+    /** Apply Gmail's own extra restrictions when the domain is Gmail. */
+    domain_specific_validation?: boolean;
+}
+/**
+ * Validate an email address.
+ *
+ * Deliberately structural rather than one giant regex: the length caps, the
+ * quoted local part and the IP-literal domain are separate rules in RFC 5321,
+ * and a single pattern that tries to express all of them is the classic source
+ * of both false accepts and false rejects.
+ */
+export declare function isEmail(value: string, options?: EmailOptions): boolean;
+/** Options accepted by `vat()` (VineJS 4.2 `vatRule`). */
+export interface VatOptions {
+    countryCode: string | string[];
+}
+/** Countries `vat()` can check. */
+export declare const SUPPORTED_VAT_COUNTRIES: string[];
+/**
+ * Validate a VAT number for one country. Returns `null` when the country has no
+ * rule, so the caller can fail LOUDLY instead of accepting the value.
+ */
+export declare function isVat(value: string, countryCode: string): boolean | null;
+//# sourceMappingURL=formats.d.ts.map

package/dist/formats.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"formats.d.ts","sourceRoot":"","sources":["../src/formats.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AASH,wFAAwF;AACxF,eAAO,MAAM,OAAO,GAAI,GAAG,MAAM,KAAG,OACiB,CAAC;AACtD,eAAO,MAAM,SAAS,GAAI,GAAG,MAAM,KAAG,OAAyB,CAAC;AAChE,eAAO,MAAM,MAAM,GAAI,GAAG,MAAM,KAAG,OAA0B,CAAC;AAC9D,eAAO,MAAM,KAAK,GAAI,GAAG,MAAM,KAAG,OAAyB,CAAC;AAuB5D,wBAAgB,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,OAAO,CAI/D;AAED,+DAA+D;AAC/D,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAe/C;AAED,8EAA8E;AAC9E,wBAAgB,MAAM,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAYzC;AAED,2CAA2C;AAC3C,wBAAgB,aAAa,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAOhD;AAyDD,qDAAqD;AACrD,eAAO,MAAM,sBAAsB,UAA4B,CAAC;AAEhE,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,GAAG,IAAI,CAG3E;AAED;;;;GAIG;AACH,eAAO,MAAM,QAAQ,GAAI,GAAG,MAAM,KAAG,OACC,CAAC;AAEvC,kFAAkF;AAClF,wBAAgB,UAAU,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAO5C;AAED,iEAAiE;AACjE,MAAM,WAAW,qBAAqB;IACrC,yEAAyE;IACzE,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,6BAA6B;IAC7B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,6BAA6B;IAC7B,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,oEAAoE;IACpE,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,6EAA6E;IAC7E,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,gDAAgD;IAChD,qBAAqB,CAAC,EAAE,OAAO,CAAC;CAChC;AAID,wBAAgB,cAAc,CAC7B,KAAK,EAAE,MAAM,EACb,OAAO,GAAE,qBAA0B,GACjC,MAAM,CAmBR;AAED,+DAA+D;AAC/D,MAAM,WAAW,mBAAmB;IACnC,6CAA6C;IAC7C,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,4CAA4C;IAC5C,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,gEAAgE;IAChE,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,gDAAgD;IAChD,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,iFAAiF;IACjF,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,4BAA4B;IAC5B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,4DAA4D;IAC5D,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,yBAAyB;IACzB,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,gEAAgE;IAChE,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,sEAAsE;IACtE,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,6EAA6E;IAC7E,qBAAqB,CAAC,EAAE,aAAa,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;IACvD,+DAA+D;IAC/D,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED,wBAAgB,YAAY,CAC3B,KAAK,EAAE,MAAM,EACb,OAAO,GAAE,mBAAwB,GAC/B,MAAM,CA8CR;AAED,iEAAiE;AACjE,wBAAgB,WAAW,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAO7C;AAuCD,eAAO,MAAM,mBAAmB,UAAyB,CAAC;AAE1D,wBAAgB,UAAU,CAAC,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,GAAG,IAAI,CAGzE;AAED,0EAA0E;AAC1E,MAAM,WAAW,YAAY;IAC5B,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,WAAW,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,6EAA6E;AAC7E,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,YAAiB,GAAG,MAAM,CAM7E;AAED,4EAA4E;AAC5E,MAAM,WAAW,UAAU;IAC1B,yEAAyE;IACzE,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,6BAA6B;IAC7B,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,6BAA6B;IAC7B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,yEAAyE;IACzE,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,kEAAkE;IAClE,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,8EAA8E;IAC9E,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,6BAA6B;IAC7B,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,wBAAgB,gBAAgB,CAC/B,KAAK,EAAE,MAAM,EACb,OAAO,GAAE,UAAe,GACtB,OAAO,CA0BT;AAkDD,eAAO,MAAM,wBAAwB,UAA8B,CAAC;AAEpE,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,GAAG,IAAI,CAI3E;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC5B,8CAA8C;IAC9C,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,8CAA8C;IAC9C,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,qEAAqE;IACrE,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,uEAAuE;IACvE,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,qDAAqD;IACrD,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,qEAAqE;IACrE,0BAA0B,CAAC,EAAE,OAAO,CAAC;CACrC;AA0BD;;;;;;;GAOG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,YAAiB,GAAG,OAAO,CAuD1E;AAED,0DAA0D;AAC1D,MAAM,WAAW,UAAU;IAC1B,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CAC/B;AAoDD,mCAAmC;AACnC,eAAO,MAAM,uBAAuB,UAAyB,CAAC;AAuE9D;;;GAGG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,GAAG,IAAI,CAQxE"}