valibot

Many thanks to @compulim for contributing to this release.

• Fix bug in union and unionAsync schema for transformed inputs (issue #420)

Many thanks to @LorisSigrist, @samuelstroschein, @gmaxlev, @thundermiracle, @ivanhofer, @CanRau, @zkulbeda, @lucaschultz, @paoloricciuti, @hyunbinseo, and @bertez for contributing to this release.

Note: The library has been revised and refactored. Therefore, not every change is listed in detail.

• Add i18n feature, global configurations and improve error messages (pull request #397)
• Add number and bigint to PicklistOptions type (issue #378)
• Fix missing export of forwardAsync method (issue #412)

Many thanks to @Omochice for contributing to this release.

• Fix missing file extension for Deno (pull request #387)

Many thanks to @pschiffmann for contributing to this release.

• Remove NonNullable, NonNullish and NonOptional type
• Add NonNullableInput, NonNullableOutput, NonNullishInput, NonNullishOutput, NonOptionalInput and NonOptionalOutput type
• Improve type signature of omit, omitAsync, pick and pickAsync schema to also allow read-only object keys (issue #380)
• Fix type of pipe argument at intersect and intersectAsync schema

Many thanks to @WtfJoke, @dboune, @alexabw and @aypotu for contributing to this release.

• Improve performance of enum_ and enumAsync schema by caching values
• Change ISO timestamp regex to support timestamps with lower and higher millisecond accuracy (pull request #353)
• Change issue handling of union, unionAsync, variant and variantAsync schema to improve developer experience
• Fix bug in getDefaults, getDefaultsAsync, getFallbacks and getFallbacksAsync schema for falsy but not undefined values (issue #356)
• Fix type of pipe argument at union, unionAsync, variant and variantAsync schema
• Fix bug that broke pipeline execution in union, unionAsync, variant and variantAsync schema (issue #364)
• Fix typo in type name of startsWith validation action (pull request #375)

Migration guide

The changes in union, unionAsync, variant and variantAsync are breaking changes and may result in different behavior when returning issues. Please create an issue if you have questions about this.

import * as v from 'valibot';

// Change this
const UnionSchema = v.union(
  [v.string([v.email()]), v.literal('')],
  'Not a valid email'
);

// To that
const UnionSchema = v.union([
  v.string([v.email('Not a valid email')]),
  v.literal(''),
]);

Many thanks to @ariskemper, @ewautr, @cuberoot @lo1tuma and @richardvanbergen for contributing to this release.

• Add creditCard, decimal, hash, hexadecimal, hexColor and octal pipeline validation action (pull request #292, #304, #307, #308, #309)
• Add pipe parameter to intersect, intersectAsync, union, unionAsync, variant and variantAsync schema (discussion #297)
• Add support for multiple variant options with same discriminator key to variant and variantAsync schema (issue #310)
• Add path to issues if discriminator key of variant and variantAsync schema is missing (issue #235, #303)
• Change PicklistOptions type and generics of picklist and picklistAsync schema

Many thanks to @NotWorkingCode for contributing to this release.

• Fix output type of optional object and objectAsync entries with default value (issue #286)
• Fix output type of nullable, nullableAsync, nullish, nullishAsync, optional and optionalAsync schema with default value (issue #286)

Many thanks to @genki and @NotWorkingCode for contributing to this release.

• Add support for special schema as key of record schema (issue #291)
• Add support for special and specialAsync schema as key of recordAsync schema (issue #291)
• Fix input and output type of optional object keys with default value (issue #286)

Many thanks to @ariskemper, @ivands and @emilgpa for contributing to this release.

• Add bic validation function (pull request #284)
• Add mac, mac48 and mac64 validation function (pull request #270)
• Change PicklistOptions, UnionOptions and UnionOptionsAsync type from tuple to array (issue #279)
• Change IntersectOptions, IntersectOptionsAsync, UnionOptions and UnionOptionsAsync type to support readonly values (issue #279)
• Fix optional keys of ObjectInput and ObjectOutput type (issue #242)

Many thanks to @ecyrbe, @Demivan, @GriefMoDz, @demarchenac, @TFX0019, @AbePlays, @irg1008, @skotenko, @dukeofsoftware, @xxxhussein, @JortsEnjoyer0, @Karakatiza666, @micahjon, @lulucas, @xsjcTony, @ziyak97, @micha149, @anhzf and @jonlambert for contributing to this release.

• Add support for boolean to notValue validation (pull request #261)
• Add .typed to schema validation result and execute pipeline of complex schemas if output is typed (issue #76, #145)
• Add forward method that forwards issues of pipelines to nested fields (issue #76, #145)
• Add skipPipe option to is type guard method (pull request #166)
• Change return type of safeParse and safeParseAsync method
• Rename and change util functions and refactor codebase
• Fix RecordInput and RecordOuput type when using unionAsync as key
• Fix output type for nullable, nullableAsync, nullish, nullishAsync, optional and optionalAsync when using a default value (issue #271)

Many thanks to @Saeris, @lo1tuma, @david-plugge, @ciscoheat, @kazizi55 and @BastiDood for contributing to this release.

• Change structure of schemas, validations and transformations to make properties accessible (pull request #211)
• Fix errors in JSDoc comments and add JSDoc ESLint plugin (pull request #205)
• Fix missing file extension for Deno (pull request #249)

Migration guide

The internal structure of schema and pipeline functions has changed as a result of #211. These changes affect people who have created their own schema, validation, or transformation functions.

import { type BaseValidation, type ErrorMessage, getOutput, getPipeIssues } from 'valibot';

// Change this

export function minLength<TInput extends string | any[]>(
  requirement: number,
  error?: ErrorMessage
) {
  return (input: TInput): PipeResult<TInput> =>
    input.length < requirement
      ? getPipeIssues('min_length', error || 'Invalid length', input)
      : getOutput(input);
}

// To that

export type MinLengthValidation<
  TInput extends string | any[],
  TRequirement extends number
> = BaseValidation<TInput> & {
  type: 'min_length';
  requirement: TRequirement;
};

export function minLength<
  TInput extends string | any[],
  TRequirement extends number
>(
  requirement: TRequirement,
  message: ErrorMessage = 'Invalid length'
): MinLengthValidation<TInput, TRequirement> {
  return {
    type: 'min_length',
    async: false,
    message,
    requirement,
    _parse(input) {
      return input.length < this.requirement
        ? getPipeIssues(this.type, this.message, input, this.requirement)
        : getOutput(input);
    },
  };
}

If you have any questions or problems, please have a look at the source code or create an issue. I usually respond within 24 hours.

Many thanks to @lo1tuma for contributing to this release.

• Remove never from type signatur of strict objects and tuples (issue #234)

Many thanks to @lo1tuma, @Karakatiza666, @naveen-bharathi, @jsudelko, @danielo515, @iamriajul, @brandonpittman, @marek-hanzal, @kurtextrem, @BThomann, @hermanseder, @sillvva, @tjenkinson and many more peoples for contributing to this release.

• Add getRestAndDefaultArgs utility function
• Add rest argument to object and objectAsync schema
• Add variant and variantAsync schema (issue #90, #216)
• Add getFallback property to schema in fallback method (pull request #177)
• Add PartialObjectEntries and PartialObjectEntriesAsync type (issue #217)
• Add export for any validation regex (pull request #219)
• Add getDefaultAsync, getDefaults and getDefaultsAsync, getFallback, getFallbackAsync, getFallbacks, getFallbacksAsync method (issue #155)
• Add support for schema validation to transform and transformAsync
• Fix type check in date and dateAsync for invalid dates (pull request #214)
• Improve security of regular expressions (pull request #202)
• Improve optional, optionalAsync, nullable, nullableAsync, nullish and nullishAsync schema
• Change ObjectSchema and ObjectSchemaAsync type
• Change type check in tuple and tupleAsync to be less strict
• Change return type of action argument in coerce and coerceAsync to unknown
• Change type of brand, getDefault, transform and transformAsync method
• Change type of array, arrayAsync, intersection, intersectionAsync, map, mapAsync, object, objectAsync, union, unionAsync, record, recordAsync, set, setAsync, tuple and tupleAsync schema
• Rename schema property of every schema type to type
• Rename intersection and intersectionAsync schema to intersect and intersectAsync
• Rename enumType and enumTypeAsync schema to picklist and picklistAsync
• Rename nativeEnum and nativeEnumAsync schema to enum_ and enumAsync
• Rename nullType and nullTypeAsync schema to null_ and nullAsync
• Rename undefinedType and undefinedTypeAsync schema to undefined_ and undefinedAsync
• Rename voidType and voidTypeAsync schema to void_ and voidAsync
• Rename default property of optional, optionalAsync, nullable, nullableAsync, nullish and nullishAsync schema to getDefault
• Rename ObjectShape and ObjectShapeAsync types to ObjectEntries and ObjectEntriesAsync
• Rename TupleShape and TupleShapeAsync types to TupleItems and TupleItemsAsync
• Deprecate passthrough, strict and strip method in favor of object schema with rest argument

Migration guide

Unfortunately, I haven't had time to write a migration guide yet. If you have any questions or problems, please have a look at the source code or create an issue. I usually respond within 24 hours.

Many thanks to @lo1tuma, @Saeris, @sillvva, @kazizi55, @FleetAdmiralJakob, @kurtextrem, @xinha-sh and @husseyexplores for contributing to this release.

• Add notBytes, notLength, notSize and notValue validation function (pull request #194)
• Add support for unions as key of record and recordAsync schema (issue #201)
• Add support for pipeline validation to transform and transformAsync (issue #197)
• Change regex of email validation to improve performance and security (pull request #180)
• Change object and objectAsync schema to exclude non-existing keys (issue #199)
• Fix types at brand, transform and unwrap method (issue #195)
• Deprecate equal validation function in favor of value (issue #192)

Many thanks to @alonidiom, @davidmyersdev, @Karakatiza666, @abd2561024 and @brandonpittman for contributing to this release.

• Add intersection and intersectionAsync schema (pull request #117)
• Fix RecordInput and RecordOutput type (pull request #184)
• Change RecordSchema and RecordSchemaAsync type
• Change flatten function and improve types

Many thanks to @syhol and @adoublef for contributing to this release.

• Fix missing file extensions for Deno (pull request #178, #181)

Many thanks to @zkulbeda, @vicimpa, @jonlambert and @gmaxlev for contributing to this release.

• Add support for multiple branding of a value (pull request #88)
• Add support for dynamic error messages via functions (pull request #136)
• Add skipPipe option to skip execution of pipelines (pull request #164)

Many thanks to @jmcdo29, @divndev and @demarchenac for contributing to this release.

• Add ulid validation (pull request #151)
• Add getIssues, getOutput and getPipeIssues util and refactor code
• Fix type check in number and numberAsync schema (issue #157)
• Change PipeResult type to allow multiple issues (issue #161)
• Rename previous getIssues util to getSchemaIssues

Migration guide

For individual validation within a pipeline, it is now possible to return multiple issues. In addition, we provide two helper functions with getOutput and getPipeIssues to make your code more readable.

import { getOutput,  getPipeIssues, string } from 'valibot';

// Change this
const StringSchema = string([
  (input) => {
    if (input.length > 10) {
      return {
        issue: {
          validation: 'custom',
          message: 'Invalid length',
          input,
        },
      };
    }
    return { output: input };
  },
]);

// To that
const StringSchema = string([
  (input) =>
    input.length > 10
      ? getPipeIssues('custom', 'Invalid length', input)
      : getOutput(input),
]);

Many thanks to @demarchenac, @Demivan, @david-plugge, @abd2561024 and @ooga for contributing to this release.

• Add possibility to define path of pipeline issue (issue #133)
• Add support for enums as key of record and recordAsync schema (issue #134)
• Add support for default values to optional, optionalAsync, nullable, nullableAsync, nullish and nullishAsync schema (issue #96, #118)
• Add getDefault method to get default value of schema (issue #105)
• Deprecate withDefault method in favor of optional schema

Many thanks to @samualtnorman, @dmorosinotto, @FabienDehopre and @Yovach for contributing to this release.

• Add cuid2 validation (pull request #130)
• Add passthrough, passthroughAsync, strip and stripAsync method
• Add InstanceSchemaAsync overload to transformAsync method (pull request #138)
• Fix bug in strict and strictAsync method for optional keys (issue #131)

• Change object type check in object and record schema

Many thanks to @naruaway, @zkulbeda, @kurtextrem, @BastiDood, @ssalbdivad, @jussisaurio, @FlorianDevPhynix, @milankinen, @fvckDesa and @Demivan for contributing to this release.

• Add fallback and fallbackAsync method (pull request #103)
• Add excludes validation as negation of includes
• Add support for more primitives to literal schema (pull request #102)
• Add support for dynamic values to withDefault method
• Change flatten function so that issues are also accepted as argument
• Change return type of safeParse and safeParseAsync method
• Change error handling and refactor library to improve performance
• Rename .parse to ._parse and .types to ._types to mark it as internal

Migration guide

This version brings extreme performance improvements. However, this also required a few breaking changes. Below is an explanation of how these can be solved quite easily.

.parse

If you have been using the internal .parse API of a schema for validation directly, you must now switch to the parse method.

// Change this
YourSchema.parse(input);

// To that
parse(YourSchema, input);

safeParse

For safeParse we have depredated .data and .error. Use .output and .issues instead.

const result = safeParse(YourSchema, input);

if (result.success) {

  // Change this
  const output = result.data;

  // To that
  const output = result.output;

} else {

  // Change this
  const issues = result.error.issues;

  // To that
  const issues = result.issues;

}

If you still want to work with a ValiError, you can easily create a ValiError yourself.

const error = new ValiError(result.issues)

Custom validation

If you previously threw a ValiError on your own, for example in the pipeline of a schema, you must now return an object with an issue or output.

// Change this
const StringSchema = string([
  (input, info) => {
    if (input.length > 10) {
      throw new ValiError([
        {
          validation: 'custom',
          origin: 'value',
          message: 'Invalid length',
          input,
          ...info,
        },
      ]);
    }
    return input;
  },
]);

// To that
const StringSchema = string([
  (input) => {
    if (input.length > 10) {
      return {
        issue: {
          validation: 'custom',
          message: 'Invalid length',
          input,
        },
      };
    }
    return { output: input };
  },
]);

tRPC

Unfortunately we could not find a solution for tRPC yet. Currently you can either explicitly set your Valibot version to v0.12.0, call parse on your own or use TypeSchema as a layer in between.

Option 1:

npm install valibot@0.12.0     # npm
yarn add valibot@0.12.0        # yarn
pnpm add valibot@0.12.0        # pnpm
bun add valibot@0.12.0         # bun

Option 2:

import { parse } from 'valibot';

.input((input) => parse(YourSchema, input))

Option 3:

import { wrap } from '@decs/typeschema';

.input(wrap(YourSchema))

Many thanks to @naruaway, @MineLPPhynix, @mrsekut and @zkulbeda for contributing to this release.

• Change input type of mimeType validation to Blob
• Rename useDefault method to withDefault (issue #80)
• Add brand method to support branded types (pull request #85)

Many thanks to @jdgamble555 and @BastiDood for contributing to this release.

• Fix types of enumType and enumTypeAsync schema (issue #70)
• Improve performance of loops with for...of (pull request #68)

Many thanks to @NiclasHaderer and @gmaxlev for contributing to this release.

• Fix prototype pollution vulnerability of record and recordAsync (pull request #67)
• Add finite, safeInteger and multipleOf validation (pull request #64, #65, #66)

Many thanks to @gmaxlev for contributing to this release.

• Add integer validation (pull request #62)

Many thanks to @Danielwinkelmann and @sillvva for contributing to this release.

• Add imei validation and isLuhnAlgo util (pull request #37)
• Fix isoDateTime, isoTime, isoTimeSecond and isoTimestamp validation (pull request #42)

Many thanks to @Thanaen, @hungify and @yamiteru for contributing to this release.

• Fix infered object and record types (issue #9, #10, #34)
• Add strict and strictAsync method to detect unknown object keys

Many thanks to @JoakimDeak, @jasikpark, @luxferoo, @logaretm and @Yovach for contributing to this release.

• Add is method which can be used as a type guard (pull request #13)
• Throw all validation issues of a pipeline by default (issues #18)
• Add abortPipeEarly option to abort pipe on first error (issues #18)
• Add abortEarly option to abort on first error

• Add toMinValue and toMaxValue transformation

Many thanks to @lino-levan, @emilbonnek and @kiliman for contributing to this release.

• Fix invalid comparable import when using Deno
• Add util functions to exports of library
• Rename minRange and maxRange to minValue and maxValue (issue #20)
• Add value validation function

Many thanks to @lino-levan for contributing to this release.

• Add instance and instanceAsync schema
• Refactor library to work with Deno

Many thanks to @genki, @tigawanna, @userquin, @intrnl and @andrewbranch for contributing to this release.

• Add bytes, minBytes and maxBytes validation (pull request #1)
• Change build step to tsup and exports in package.json (issue #7)

Many thanks to @tigawanna, @userquin and @intrnl for contributing to this release.

• Change order of exports in package.json (issue #7)

• Add blob and blobAsync schema

Many thanks to @mhevery, @ryansolid and @colinhacks for contributing to this release.

• Initial release