@zeruxjs/validator 0.0.0-stage → 0.0.1

package/dist/actions/creditCard.js

@@ -0,0 +1,57 @@
+import { _addIssue, _isLuhnAlgo } from '../utils/index.js';
+/**
+ * Credit card regex.
+ */
+const CREDIT_CARD_REGEX = /^(?:\d{13,19}|\d{4}(?: \d{3,6}){2,4}|\d{4}(?:-\d{3,6}){2,4})$/u;
+/**
+ * Sanitize regex.
+ */
+const SANITIZE_REGEX = /[- ]/gu;
+/**
+ * Provider regex list.
+ */
+const PROVIDER_REGEX_LIST = [
+    // American Express
+    /^3[47]\d{13}$/u,
+    // Diners Club
+    /^3(?:0[0-5]|[68]\d)\d{11,13}$/u,
+    // Discover
+    /^6(?:011|5\d{2})\d{12,15}$/u,
+    // JCB
+    /^(?:2131|1800|35\d{3})\d{11}$/u,
+    // Mastercard
+    // Compatibility expression; previous external ReDoS lint exclusions are not used here.
+    /^5[1-5]\d{2}|(?:222\d|22[3-9]\d|2[3-6]\d{2}|27[01]\d|2720)\d{12}$/u,
+    // UnionPay
+    /^(?:6[27]\d{14,17}|81\d{14,17})$/u,
+    // Visa
+    /^4\d{12}(?:\d{3,6})?$/u,
+];
+// @__NO_SIDE_EFFECTS__
+export function creditCard(message) {
+    return {
+        kind: 'validation',
+        type: 'credit_card',
+        reference: creditCard,
+        async: false,
+        expects: null,
+        requirement(input) {
+            let sanitized;
+            return (CREDIT_CARD_REGEX.test(input) &&
+                // Remove any hyphens and blanks
+                (sanitized = input.replace(SANITIZE_REGEX, '')) &&
+                // Check if it matches a provider
+                PROVIDER_REGEX_LIST.some((regex) => regex.test(sanitized)) &&
+                // Check if passes luhn algorithm
+                _isLuhnAlgo(sanitized));
+        },
+        message,
+        '~run'(dataset, config) {
+            if (dataset.typed && !this.requirement(dataset.value)) {
+                _addIssue(this, 'credit card', dataset, config);
+            }
+            return dataset;
+        },
+    };
+}
+//# sourceMappingURL=creditCard.js.map

package/dist/actions/creditCard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"creditCard.js","sourceRoot":"","sources":["../../src/actions/creditCard.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AA0D3D;;GAEG;AACH,MAAM,iBAAiB,GACrB,gEAAgE,CAAC;AAEnE;;GAEG;AACH,MAAM,cAAc,GAAG,QAAQ,CAAC;AAEhC;;GAEG;AACH,MAAM,mBAAmB,GAAG;IAC1B,mBAAmB;IACnB,gBAAgB;IAChB,cAAc;IACd,gCAAgC;IAChC,WAAW;IACX,6BAA6B;IAC7B,MAAM;IACN,gCAAgC;IAChC,aAAa;IACb,uFAAuF;IACvF,oEAAoE;IACpE,WAAW;IACX,mCAAmC;IACnC,OAAO;IACP,wBAAwB;CACzB,CAAC;AAwBF,uBAAuB;AACvB,MAAM,UAAU,UAAU,CACxB,OAA+C;IAE/C,OAAO;QACL,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE,aAAa;QACnB,SAAS,EAAE,UAAU;QACrB,KAAK,EAAE,KAAK;QACZ,OAAO,EAAE,IAAI;QACb,WAAW,CAAC,KAAK;YACf,IAAI,SAA6B,CAAC;YAClC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC;gBACnC,gCAAgC;gBAChC,CAAC,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;gBAC/C,iCAAiC;gBACjC,mBAAmB,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,SAAU,CAAC,CAAC;gBAC3D,iCAAiC;gBACjC,WAAW,CAAC,SAAS,CAAC,CAAY,CAAC;QACvC,CAAC;QACD,OAAO;QACP,MAAM,CAAC,OAAO,EAAE,MAAM;YACpB,IAAI,OAAO,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACtD,SAAS,CAAC,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;YAClD,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/actions/cuid2.d.ts

@@ -0,0 +1,65 @@
+import type { BaseIssue, BaseValidation, ErrorMessage } from '../types/index.js';
+/**
+ * Cuid2 issue interface.
+ */
+export interface Cuid2Issue<TInput extends string> extends BaseIssue<TInput> {
+    /**
+     * The issue kind.
+     */
+    readonly kind: 'validation';
+    /**
+     * The issue type.
+     */
+    readonly type: 'cuid2';
+    /**
+     * The expected property.
+     */
+    readonly expected: null;
+    /**
+     * The received property.
+     */
+    readonly received: `"${string}"`;
+    /**
+     * The Cuid2 regex.
+     */
+    readonly requirement: RegExp;
+}
+/**
+ * Cuid2 action interface.
+ */
+export interface Cuid2Action<TInput extends string, TMessage extends ErrorMessage<Cuid2Issue<TInput>> | undefined> extends BaseValidation<TInput, TInput, Cuid2Issue<TInput>> {
+    /**
+     * The action type.
+     */
+    readonly type: 'cuid2';
+    /**
+     * The action reference.
+     */
+    readonly reference: typeof cuid2;
+    /**
+     * The expected property.
+     */
+    readonly expects: null;
+    /**
+     * The Cuid2 regex.
+     */
+    readonly requirement: RegExp;
+    /**
+     * The error message.
+     */
+    readonly message: TMessage;
+}
+/**
+ * Creates a [Cuid2](https://github.com/paralleldrive/cuid2) validation action.
+ *
+ * @returns A Cuid2 action.
+ */
+export declare function cuid2<TInput extends string>(): Cuid2Action<TInput, undefined>;
+/**
+ * Creates a [Cuid2](https://github.com/paralleldrive/cuid2) validation action.
+ *
+ * @param message The error message.
+ *
+ * @returns A Cuid2 action.
+ */
+export declare function cuid2<TInput extends string, const TMessage extends ErrorMessage<Cuid2Issue<TInput>> | undefined>(message: TMessage): Cuid2Action<TInput, TMessage>;

package/dist/actions/cuid2.js

@@ -0,0 +1,21 @@
+import { CUID2_REGEX } from '../regex.js';
+import { _addIssue } from '../utils/index.js';
+// @__NO_SIDE_EFFECTS__
+export function cuid2(message) {
+    return {
+        kind: 'validation',
+        type: 'cuid2',
+        reference: cuid2,
+        async: false,
+        expects: null,
+        requirement: CUID2_REGEX,
+        message,
+        '~run'(dataset, config) {
+            if (dataset.typed && !this.requirement.test(dataset.value)) {
+                _addIssue(this, 'Cuid2', dataset, config);
+            }
+            return dataset;
+        },
+    };
+}
+//# sourceMappingURL=cuid2.js.map

package/dist/actions/cuid2.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cuid2.js","sourceRoot":"","sources":["../../src/actions/cuid2.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAM1C,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AA4E9C,uBAAuB;AACvB,MAAM,UAAU,KAAK,CACnB,OAA0C;IAE1C,OAAO;QACL,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE,OAAO;QACb,SAAS,EAAE,KAAK;QAChB,KAAK,EAAE,KAAK;QACZ,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,WAAW;QACxB,OAAO;QACP,MAAM,CAAC,OAAO,EAAE,MAAM;YACpB,IAAI,OAAO,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC3D,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;YAC5C,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/actions/decimal.d.ts

@@ -0,0 +1,73 @@
+import type { BaseIssue, BaseValidation, ErrorMessage } from '../types/index.js';
+/**
+ * Decimal issue interface.
+ */
+export interface DecimalIssue<TInput extends string> extends BaseIssue<TInput> {
+    /**
+     * The issue kind.
+     */
+    readonly kind: 'validation';
+    /**
+     * The issue type.
+     */
+    readonly type: 'decimal';
+    /**
+     * The expected property.
+     */
+    readonly expected: null;
+    /**
+     * The received property.
+     */
+    readonly received: `"${string}"`;
+    /**
+     * The decimal regex.
+     */
+    readonly requirement: RegExp;
+}
+/**
+ * Decimal action interface.
+ */
+export interface DecimalAction<TInput extends string, TMessage extends ErrorMessage<DecimalIssue<TInput>> | undefined> extends BaseValidation<TInput, TInput, DecimalIssue<TInput>> {
+    /**
+     * The action type.
+     */
+    readonly type: 'decimal';
+    /**
+     * The action reference.
+     */
+    readonly reference: typeof decimal;
+    /**
+     * The expected property.
+     */
+    readonly expects: null;
+    /**
+     * The decimal regex.
+     */
+    readonly requirement: RegExp;
+    /**
+     * The error message.
+     */
+    readonly message: TMessage;
+}
+/**
+ * Creates a [decimal](https://en.wikipedia.org/wiki/Decimal) validation action.
+ *
+ * The difference between `decimal` and `digits` is that `decimal` accepts
+ * floating point numbers and negative numbers, while `digits` accepts only the
+ * digits 0-9.
+ *
+ * @returns An decimal action.
+ */
+export declare function decimal<TInput extends string>(): DecimalAction<TInput, undefined>;
+/**
+ * Creates a [decimal](https://en.wikipedia.org/wiki/Decimal) validation action.
+ *
+ * The difference between `decimal` and `digits` is that `decimal` accepts
+ * floating point numbers and negative numbers, while `digits` accepts only the
+ * digits 0-9.
+ *
+ * @param message The error message.
+ *
+ * @returns An decimal action.
+ */
+export declare function decimal<TInput extends string, const TMessage extends ErrorMessage<DecimalIssue<TInput>> | undefined>(message: TMessage): DecimalAction<TInput, TMessage>;

package/dist/actions/decimal.js

@@ -0,0 +1,21 @@
+import { DECIMAL_REGEX } from '../regex.js';
+import { _addIssue } from '../utils/index.js';
+// @__NO_SIDE_EFFECTS__
+export function decimal(message) {
+    return {
+        kind: 'validation',
+        type: 'decimal',
+        reference: decimal,
+        async: false,
+        expects: null,
+        requirement: DECIMAL_REGEX,
+        message,
+        '~run'(dataset, config) {
+            if (dataset.typed && !this.requirement.test(dataset.value)) {
+                _addIssue(this, 'decimal', dataset, config);
+            }
+            return dataset;
+        },
+    };
+}
+//# sourceMappingURL=decimal.js.map

package/dist/actions/decimal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"decimal.js","sourceRoot":"","sources":["../../src/actions/decimal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAM5C,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAuF9C,uBAAuB;AACvB,MAAM,UAAU,OAAO,CACrB,OAA4C;IAE5C,OAAO;QACL,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE,SAAS;QACf,SAAS,EAAE,OAAO;QAClB,KAAK,EAAE,KAAK;QACZ,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,aAAa;QAC1B,OAAO;QACP,MAAM,CAAC,OAAO,EAAE,MAAM;YACpB,IAAI,OAAO,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC3D,SAAS,CAAC,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;YAC9C,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/actions/description.d.ts

@@ -0,0 +1,26 @@
+import type { BaseMetadata } from '../types/index.js';
+/**
+ * Description action interface.
+ */
+export interface DescriptionAction<TInput, TDescription extends string> extends BaseMetadata<TInput> {
+    /**
+     * The action type.
+     */
+    readonly type: 'description';
+    /**
+     * The action reference.
+     */
+    readonly reference: typeof description;
+    /**
+     * The description text.
+     */
+    readonly description: TDescription;
+}
+/**
+ * Creates a description metadata action.
+ *
+ * @param description_ The description text.
+ *
+ * @returns A description action.
+ */
+export declare function description<TInput, TDescription extends string>(description_: TDescription): DescriptionAction<TInput, TDescription>;

package/dist/actions/description.js

@@ -0,0 +1,17 @@
+/**
+ * Creates a description metadata action.
+ *
+ * @param description_ The description text.
+ *
+ * @returns A description action.
+ */
+// @__NO_SIDE_EFFECTS__
+export function description(description_) {
+    return {
+        kind: 'metadata',
+        type: 'description',
+        reference: description,
+        description: description_,
+    };
+}
+//# sourceMappingURL=description.js.map

package/dist/actions/description.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"description.js","sourceRoot":"","sources":["../../src/actions/description.ts"],"names":[],"mappings":"AAqBA;;;;;;GAMG;AACH,uBAAuB;AACvB,MAAM,UAAU,WAAW,CACzB,YAA0B;IAE1B,OAAO;QACL,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,aAAa;QACnB,SAAS,EAAE,WAAW;QACtB,WAAW,EAAE,YAAY;KAC1B,CAAC;AACJ,CAAC"}

package/dist/actions/digits.d.ts

@@ -0,0 +1,73 @@
+import type { BaseIssue, BaseValidation, ErrorMessage } from '../types/index.js';
+/**
+ * Digits issue interface.
+ */
+export interface DigitsIssue<TInput extends string> extends BaseIssue<TInput> {
+    /**
+     * The issue kind.
+     */
+    readonly kind: 'validation';
+    /**
+     * The issue type.
+     */
+    readonly type: 'digits';
+    /**
+     * The expected property.
+     */
+    readonly expected: null;
+    /**
+     * The received property.
+     */
+    readonly received: `"${string}"`;
+    /**
+     * The digits regex.
+     */
+    readonly requirement: RegExp;
+}
+/**
+ * Digits action interface.
+ */
+export interface DigitsAction<TInput extends string, TMessage extends ErrorMessage<DigitsIssue<TInput>> | undefined> extends BaseValidation<TInput, TInput, DigitsIssue<TInput>> {
+    /**
+     * The action type.
+     */
+    readonly type: 'digits';
+    /**
+     * The action reference.
+     */
+    readonly reference: typeof digits;
+    /**
+     * The expected property.
+     */
+    readonly expects: null;
+    /**
+     * The digits regex.
+     */
+    readonly requirement: RegExp;
+    /**
+     * The error message.
+     */
+    readonly message: TMessage;
+}
+/**
+ * Creates a [digits](https://en.wikipedia.org/wiki/Numerical_digit) validation action.
+ *
+ * The difference between `digits` and `decimal` is that `digits` accepts only
+ * the digits 0-9, while `decimal` accepts floating point numbers and negative
+ * numbers.
+ *
+ * @returns An digits action.
+ */
+export declare function digits<TInput extends string>(): DigitsAction<TInput, undefined>;
+/**
+ * Creates a [digits](https://en.wikipedia.org/wiki/Numerical_digit) validation action.
+ *
+ * The difference between `digits` and `decimal` is that `digits` accepts only
+ * the digits 0-9, while `decimal` accepts floating point numbers and negative
+ * numbers.
+ *
+ * @param message The error message.
+ *
+ * @returns An digits action.
+ */
+export declare function digits<TInput extends string, const TMessage extends ErrorMessage<DigitsIssue<TInput>> | undefined>(message: TMessage): DigitsAction<TInput, TMessage>;

package/dist/actions/digits.js

@@ -0,0 +1,21 @@
+import { DIGITS_REGEX } from '../regex.js';
+import { _addIssue } from '../utils/index.js';
+// @__NO_SIDE_EFFECTS__
+export function digits(message) {
+    return {
+        kind: 'validation',
+        type: 'digits',
+        reference: digits,
+        async: false,
+        expects: null,
+        requirement: DIGITS_REGEX,
+        message,
+        '~run'(dataset, config) {
+            if (dataset.typed && !this.requirement.test(dataset.value)) {
+                _addIssue(this, 'digits', dataset, config);
+            }
+            return dataset;
+        },
+    };
+}
+//# sourceMappingURL=digits.js.map

package/dist/actions/digits.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"digits.js","sourceRoot":"","sources":["../../src/actions/digits.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAM3C,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAuF9C,uBAAuB;AACvB,MAAM,UAAU,MAAM,CACpB,OAA2C;IAE3C,OAAO;QACL,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,MAAM;QACjB,KAAK,EAAE,KAAK;QACZ,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,YAAY;QACzB,OAAO;QACP,MAAM,CAAC,OAAO,EAAE,MAAM;YACpB,IAAI,OAAO,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC3D,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;YAC7C,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/actions/domain.d.ts

@@ -0,0 +1,81 @@
+import type { BaseIssue, BaseValidation, ErrorMessage } from '../types/index.js';
+/**
+ * Domain issue interface.
+ *
+ * @beta
+ */
+export interface DomainIssue<TInput extends string> extends BaseIssue<TInput> {
+    /**
+     * The issue kind.
+     */
+    readonly kind: 'validation';
+    /**
+     * The issue type.
+     */
+    readonly type: 'domain';
+    /**
+     * The expected property.
+     */
+    readonly expected: null;
+    /**
+     * The received property.
+     */
+    readonly received: `"${string}"`;
+    /**
+     * The domain regex.
+     */
+    readonly requirement: RegExp;
+}
+/**
+ * Domain action interface.
+ *
+ * @beta
+ */
+export interface DomainAction<TInput extends string, TMessage extends ErrorMessage<DomainIssue<TInput>> | undefined> extends BaseValidation<TInput, TInput, DomainIssue<TInput>> {
+    /**
+     * The action type.
+     */
+    readonly type: 'domain';
+    /**
+     * The action reference.
+     */
+    readonly reference: typeof domain;
+    /**
+     * The expected property.
+     */
+    readonly expects: null;
+    /**
+     * The domain regex.
+     */
+    readonly requirement: RegExp;
+    /**
+     * The error message.
+     */
+    readonly message: TMessage;
+}
+/**
+ * Creates a [domain name](https://en.wikipedia.org/wiki/Domain_name) validation
+ * action.
+ *
+ * Hint: ASCII-only validation. Internationalized domain names (IDNs) are not
+ * supported, including Punycode-encoded labels.
+ *
+ * @returns A domain action.
+ *
+ * @beta
+ */
+export declare function domain<TInput extends string>(): DomainAction<TInput, undefined>;
+/**
+ * Creates a [domain name](https://en.wikipedia.org/wiki/Domain_name) validation
+ * action.
+ *
+ * Hint: ASCII-only validation. Internationalized domain names (IDNs) are not
+ * supported, including Punycode-encoded labels.
+ *
+ * @param message The error message.
+ *
+ * @returns A domain action.
+ *
+ * @beta
+ */
+export declare function domain<TInput extends string, const TMessage extends ErrorMessage<DomainIssue<TInput>> | undefined>(message: TMessage): DomainAction<TInput, TMessage>;

package/dist/actions/domain.js

@@ -0,0 +1,21 @@
+import { DOMAIN_REGEX } from '../regex.js';
+import { _addIssue } from '../utils/index.js';
+// @__NO_SIDE_EFFECTS__
+export function domain(message) {
+    return {
+        kind: 'validation',
+        type: 'domain',
+        reference: domain,
+        expects: null,
+        async: false,
+        requirement: DOMAIN_REGEX,
+        message,
+        '~run'(dataset, config) {
+            if (dataset.typed && !this.requirement.test(dataset.value)) {
+                _addIssue(this, 'domain', dataset, config);
+            }
+            return dataset;
+        },
+    };
+}
+//# sourceMappingURL=domain.js.map

package/dist/actions/domain.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"domain.js","sourceRoot":"","sources":["../../src/actions/domain.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAM3C,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AA+F9C,uBAAuB;AACvB,MAAM,UAAU,MAAM,CACpB,OAA2C;IAE3C,OAAO;QACL,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,MAAM;QACjB,OAAO,EAAE,IAAI;QACb,KAAK,EAAE,KAAK;QACZ,WAAW,EAAE,YAAY;QACzB,OAAO;QACP,MAAM,CAAC,OAAO,EAAE,MAAM;YACpB,IAAI,OAAO,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC3D,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;YAC7C,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/actions/email.d.ts

@@ -0,0 +1,75 @@
+import type { BaseIssue, BaseValidation, ErrorMessage } from '../types/index.js';
+/**
+ * Email issue interface.
+ */
+export interface EmailIssue<TInput extends string> extends BaseIssue<TInput> {
+    /**
+     * The issue kind.
+     */
+    readonly kind: 'validation';
+    /**
+     * The issue type.
+     */
+    readonly type: 'email';
+    /**
+     * The expected property.
+     */
+    readonly expected: null;
+    /**
+     * The received property.
+     */
+    readonly received: `"${string}"`;
+    /**
+     * The email regex.
+     */
+    readonly requirement: RegExp;
+}
+/**
+ * Email action interface.
+ */
+export interface EmailAction<TInput extends string, TMessage extends ErrorMessage<EmailIssue<TInput>> | undefined> extends BaseValidation<TInput, TInput, EmailIssue<TInput>> {
+    /**
+     * The action type.
+     */
+    readonly type: 'email';
+    /**
+     * The action reference.
+     */
+    readonly reference: typeof email;
+    /**
+     * The expected property.
+     */
+    readonly expects: null;
+    /**
+     * The email regex.
+     */
+    readonly requirement: RegExp;
+    /**
+     * The error message.
+     */
+    readonly message: TMessage;
+}
+/**
+ * Creates an [email](https://en.wikipedia.org/wiki/Email_address) validation
+ * action.
+ *
+ * Hint: This validation action intentionally only validates common email
+ * addresses. If you are interested in an action that covers the entire
+ * specification, please use the `rfcEmail` action instead.
+ *
+ * @returns An email action.
+ */
+export declare function email<TInput extends string>(): EmailAction<TInput, undefined>;
+/**
+ * Creates an [email](https://en.wikipedia.org/wiki/Email_address) validation
+ * action.
+ *
+ * Hint: This validation action intentionally only validates common email
+ * addresses. If you are interested in an action that covers the entire
+ * specification, please use the `rfcEmail` action instead.
+ *
+ * @param message The error message.
+ *
+ * @returns An email action.
+ */
+export declare function email<TInput extends string, const TMessage extends ErrorMessage<EmailIssue<TInput>> | undefined>(message: TMessage): EmailAction<TInput, TMessage>;

package/dist/actions/email.js

@@ -0,0 +1,21 @@
+import { EMAIL_REGEX } from '../regex.js';
+import { _addIssue } from '../utils/index.js';
+// @__NO_SIDE_EFFECTS__
+export function email(message) {
+    return {
+        kind: 'validation',
+        type: 'email',
+        reference: email,
+        expects: null,
+        async: false,
+        requirement: EMAIL_REGEX,
+        message,
+        '~run'(dataset, config) {
+            if (dataset.typed && !this.requirement.test(dataset.value)) {
+                _addIssue(this, 'email', dataset, config);
+            }
+            return dataset;
+        },
+    };
+}
+//# sourceMappingURL=email.js.map

package/dist/actions/email.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"email.js","sourceRoot":"","sources":["../../src/actions/email.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAM1C,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAsF9C,uBAAuB;AACvB,MAAM,UAAU,KAAK,CACnB,OAA0C;IAE1C,OAAO;QACL,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE,OAAO;QACb,SAAS,EAAE,KAAK;QAChB,OAAO,EAAE,IAAI;QACb,KAAK,EAAE,KAAK;QACZ,WAAW,EAAE,WAAW;QACxB,OAAO;QACP,MAAM,CAAC,OAAO,EAAE,MAAM;YACpB,IAAI,OAAO,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC3D,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;YAC5C,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/actions/emoji.d.ts

@@ -0,0 +1,65 @@
+import type { BaseIssue, BaseValidation, ErrorMessage } from '../types/index.js';
+/**
+ * Emoji issue interface.
+ */
+export interface EmojiIssue<TInput extends string> extends BaseIssue<TInput> {
+    /**
+     * The issue kind.
+     */
+    readonly kind: 'validation';
+    /**
+     * The issue type.
+     */
+    readonly type: 'emoji';
+    /**
+     * The expected property.
+     */
+    readonly expected: null;
+    /**
+     * The received property.
+     */
+    readonly received: `"${string}"`;
+    /**
+     * The emoji regex.
+     */
+    readonly requirement: RegExp;
+}
+/**
+ * Emoji action interface.
+ */
+export interface EmojiAction<TInput extends string, TMessage extends ErrorMessage<EmojiIssue<TInput>> | undefined> extends BaseValidation<TInput, TInput, EmojiIssue<TInput>> {
+    /**
+     * The action type.
+     */
+    readonly type: 'emoji';
+    /**
+     * The action reference.
+     */
+    readonly reference: typeof emoji;
+    /**
+     * The expected property.
+     */
+    readonly expects: null;
+    /**
+     * The emoji regex.
+     */
+    readonly requirement: RegExp;
+    /**
+     * The error message.
+     */
+    readonly message: TMessage;
+}
+/**
+ * Creates an [emoji](https://en.wikipedia.org/wiki/Emoji) validation action.
+ *
+ * @returns An emoji action.
+ */
+export declare function emoji<TInput extends string>(): EmojiAction<TInput, undefined>;
+/**
+ * Creates an [emoji](https://en.wikipedia.org/wiki/Emoji) validation action.
+ *
+ * @param message The error message.
+ *
+ * @returns An emoji action.
+ */
+export declare function emoji<TInput extends string, const TMessage extends ErrorMessage<EmojiIssue<TInput>> | undefined>(message: TMessage): EmojiAction<TInput, TMessage>;