Upgrading valibot 0.31 to 0.32
Breaking0.31.1 → 0.32.0Breaking1New1Changed2Fixed2
BreakingUpgrade verdict
1 breaking change.
In plain terms
- Remove unused skipPipe option from Config type and refactor library.
Must act 1 item needs code or config changes
What you must change
Breaking1
Remove unused skipPipe option from Config type and refactor library.
skipPipeConfigAPI changes
Generated by DepDelta from published .d.ts files. Not mixed with prose notes.
- removed:
interface FlatErrors<TNestedPath extends string> - removed:
readonly property Config.skipPipe?: boolean - removed:
readonly property FlatErrors.nested?: Prettify<Readonly<Partial<Record<TNestedPath, [string, ...string[]]>>>> - removed:
readonly property FlatErrors.other?: [string, ...string[]] - removed:
readonly property FlatErrors.root?: [string, ...string[]] - changed:
function _addIssue<const TContext extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>> | BaseValidation<unknown, unknown, BaseIssue<unknown>> | BaseValidationAsync<unknown, unknown, BaseIssue<unknown>>>(context: TContext, label: string, dataset: Dataset<unknown, BaseIssue<unknown>>, config: Config<InferIssue<TContext>>, other?: Other<Inf… → function _addIssue<const TContext extends Context>(context: TContext, label: string, dataset: Dataset<unknown, BaseIssue<unknown>>, config: Config<InferIssue<TContext>>, other?: Other<TContext>): void - changed:
function config<TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>>(schema: TSchema, config: Omit<Config<InferIssue<TSchema>>, 'skipPipe'>): TSchema → function config<TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>>(schema: TSchema, config: Config<InferIssue<TSchema>>): TSchema - changed:
function flatten(issues: [BaseIssue<unknown>, ...BaseIssue<unknown>[]]): Prettify<FlatErrors<string>> → function flatten(issues: [BaseIssue<unknown>, ...BaseIssue<unknown>[]]): FlatErrors<undefined> - changed:
function flatten<TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>>(issues: [InferIssue<TSchema>, ...InferIssue<TSchema>[]]): Prettify<FlatErrors<IssueDotPath<TSchema>>> → function flatten<TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>>(issues: [InferIssue<TSchema>, ...InferIssue<TSchema>[]]): FlatErrors<TSchema> - changed:
function parse<const TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>>>(schema: TSchema, input: unknown, config?: Omit<Config<InferIssue<TSchema>>, 'skipPipe'>): InferOutput<TSchema> → function parse<const TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>>>(schema: TSchema, input: unknown, config?: Config<InferIssue<TSchema>>): InferOutput<TSchema> - changed:
function parseAsync<const TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>>(schema: TSchema, input: unknown, config?: Omit<Config<InferIssue<TSchema>>, 'skipPipe'>): Promise<InferOutput<TSchema>> → function parseAsync<const TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>>(schema: TSchema, input: unknown, config?: Config<InferIssue<TSchema>>): Promise<InferOutput<TSchema>> - changed:
function parser<const TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>>, const TConfig extends Omit<Config<InferIssue<TSchema>>, 'skipPipe'> | undefined>(schema: TSchema, config: TConfig): Parser<TSchema, TConfig> → function parser<const TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>>, const TConfig extends Config<InferIssue<TSchema>> | undefined>(schema: TSchema, config: TConfig): Parser<TSchema, TConfig> - changed:
function parserAsync<const TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>, const TConfig extends Omit<Config<InferIssue<TSchema>>, 'skipPipe'> | undefined>(schema: TSchema, config: TConfig): ParserAsync<TSchema, TConfig> → function parserAsync<const TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>, const TConfig extends Config<InferIssue<TSchema>> | undefined>(schema: TSchema, config: TConfig): ParserAsync<TSchema, TConfig> - changed:
function safeParse<const TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>>>(schema: TSchema, input: unknown, config?: Omit<Config<InferIssue<TSchema>>, 'skipPipe'>): SafeParseResult<TSchema> → function safeParse<const TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>>>(schema: TSchema, input: unknown, config?: Config<InferIssue<TSchema>>): SafeParseResult<TSchema> - changed:
function safeParseAsync<const TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>>(schema: TSchema, input: unknown, config?: Omit<Config<InferIssue<TSchema>>, 'skipPipe'>): Promise<SafeParseResult<TSchema>> → function safeParseAsync<const TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>>(schema: TSchema, input: unknown, config?: Config<InferIssue<TSchema>>): Promise<SafeParseResult<TSchema>> - changed:
function safeParser<const TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>>, const TConfig extends Omit<Config<InferIssue<TSchema>>, 'skipPipe'> | undefined>(schema: TSchema, config: TConfig): SafeParser<TSchema, TConfig> → function safeParser<const TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>>, const TConfig extends Config<InferIssue<TSchema>> | undefined>(schema: TSchema, config: TConfig): SafeParser<TSchema, TConfig> - changed:
function safeParserAsync<const TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>, const TConfig extends Omit<Config<InferIssue<TSchema>>, 'skipPipe'> | undefined>(schema: TSchema, config: TConfig): SafeParserAsync<TSchema, TConfig> → function safeParserAsync<const TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>, const TConfig extends Config<InferIssue<TSchema>> | undefined>(schema: TSchema, config: TConfig): SafeParserAsync<TSchema, TConfig> - changed:
interface Parser<TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>>, TConfig extends Omit<Config<InferIssue<TSchema>>, 'skipPipe'> | undefined> → interface Parser<TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>>, TConfig extends Config<InferIssue<TSchema>> | undefined> - changed:
interface ParserAsync<TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>, TConfig extends Omit<Config<InferIssue<TSchema>>, 'skipPipe'> | undefined> → interface ParserAsync<TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>, TConfig extends Config<InferIssue<TSchema>> | undefined> - changed:
interface SafeParser<TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>>, TConfig extends Omit<Config<InferIssue<TSchema>>, 'skipPipe'> | undefined> → interface SafeParser<TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>>, TConfig extends Config<InferIssue<TSchema>> | undefined> - changed:
interface SafeParserAsync<TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>, TConfig extends Omit<Config<InferIssue<TSchema>>, 'skipPipe'> | undefined> → interface SafeParserAsync<TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>, TConfig extends Config<InferIssue<TSchema>> | undefined> - changed:
method BaseTransformation._run(dataset: TypedDataset<TInput, never>, config: Config<TIssue>): TypedDataset<TOutput, TIssue> → method BaseTransformation._run(dataset: TypedDataset<TInput, never>, config: Config<TIssue>): Dataset<TOutput, TIssue> - changed:
method BaseTransformationAsync._run(dataset: TypedDataset<TInput, never>, config: Config<TIssue>): Promise<TypedDataset<TOutput, TIssue>> → method BaseTransformationAsync._run(dataset: TypedDataset<TInput, never>, config: Config<TIssue>): Promise<Dataset<TOutput, TIssue>> - changed:
readonly property EnumSchema.options: (keyof TEnum)[] → readonly property EnumSchema.options: TEnum[keyof TEnum][] - changed:
type GlobalConfig = Omit<Config<never>, 'message' | 'skipPipe'> → type GlobalConfig = Omit<Config<never>, 'message'> - added:
function rawCheck<TInput>(action: (context: Context$2<TInput>) => void): RawCheckAction<TInput> - added:
function rawCheckAsync<TInput>(action: (context: Context$2<TInput>) => MaybePromise<void>): RawCheckActionAsync<TInput> - added:
function rawTransform<TInput, TOutput>(action: (context: Context$1<TInput>) => TOutput): RawTransformAction<TInput, TOutput> - added:
function rawTransformAsync<TInput, TOutput>(action: (context: Context$1<TInput>) => MaybePromise<TOutput>): RawTransformActionAsync<TInput, TOutput> - added:
interface RawCheckAction<TInput> extends BaseValidation<TInput, TInput, RawCheckIssue<TInput>> - added:
interface RawCheckActionAsync<TInput> extends BaseValidationAsync<TInput, TInput, RawCheckIssue<TInput>> - added:
interface RawCheckIssue<TInput> extends BaseIssue<TInput> - added:
interface RawTransformAction<TInput, TOutput> extends BaseTransformation<TInput, TOutput, RawTransformIssue<TInput>> - added:
interface RawTransformActionAsync<TInput, TOutput> extends BaseTransformationAsync<TInput, TOutput, RawTransformIssue<TInput>> - added:
interface RawTransformIssue<TInput> extends BaseIssue<TInput> - added:
readonly property RawCheckAction.expects: null - added:
readonly property RawCheckAction.reference: typeof rawCheck - added:
readonly property RawCheckAction.type: 'raw_check' - added:
readonly property RawCheckActionAsync.expects: null - added:
readonly property RawCheckActionAsync.reference: typeof rawCheckAsync - added:
readonly property RawCheckActionAsync.type: 'raw_check' - added:
readonly property RawCheckIssue.kind: 'validation' - added:
readonly property RawCheckIssue.type: 'raw_check' - added:
readonly property RawTransformAction.reference: typeof rawTransform - added:
readonly property RawTransformAction.type: 'raw_transform' - added:
readonly property RawTransformActionAsync.reference: typeof rawTransformAsync - added:
readonly property RawTransformActionAsync.type: 'raw_transform' - added:
readonly property RawTransformIssue.kind: 'transformation' - added:
readonly property RawTransformIssue.type: 'raw_transform' - added:
type FlatErrors<TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>> | undefined> = Prettify<{ readonly root?: [string, ...string[]]; readonly nested?: Prettify<Readonly<Partial<Record<TSchema extends BaseSchema<unknown, unknown, BaseIssue<unk…