Skip to content

Making possible for decode/encode fns to accept schema unions #5636

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
+118 −83
Draft

Making possible for decode/encode fns to accept schema unions #5636

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
775286f
wip
nikelborm Oct 14, 2025
c1925f8
wip
nikelborm Oct 14, 2025
4657248
wip
nikelborm Oct 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
196 changes: 113 additions & 83 deletions packages/effect/src/ParseResult.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -461,198 +461,220 @@ const getEffect = <R>(ast: AST.AST, isDecoding: boolean, options?: AST.ParseOpti
* @category decoding
* @since 3.10.0
*/
export const decodeUnknownSync = <A, I>(
schema: Schema.Schema<A, I, never>,
export const decodeUnknownSync = <S extends Schema.Schema.AnyNoContext>(
schema: S,
options?: AST.ParseOptions
): (u: unknown, overrideOptions?: AST.ParseOptions) => A => getSync(schema.ast, true, options)
): (u: unknown, overrideOptions?: AST.ParseOptions) => Schema.Schema.Type<S> => getSync(schema.ast, true, options)

/**
* @category decoding
* @since 3.10.0
*/
export const decodeUnknownOption = <A, I>(
schema: Schema.Schema<A, I, never>,
export const decodeUnknownOption = <S extends Schema.Schema.AnyNoContext>(
schema: S,
options?: AST.ParseOptions
): (u: unknown, overrideOptions?: AST.ParseOptions) => Option.Option<A> => getOption(schema.ast, true, options)
): (u: unknown, overrideOptions?: AST.ParseOptions) => Option.Option<Schema.Schema.Type<S>> =>
getOption(schema.ast, true, options)

/**
* @category decoding
* @since 3.10.0
*/
export const decodeUnknownEither = <A, I>(
schema: Schema.Schema<A, I, never>,
export const decodeUnknownEither = <S extends Schema.Schema.AnyNoContext>(
schema: S,
options?: AST.ParseOptions
): (u: unknown, overrideOptions?: AST.ParseOptions) => Either.Either<A, ParseIssue> =>
): (u: unknown, overrideOptions?: AST.ParseOptions) => Either.Either<Schema.Schema.Type<S>, ParseIssue> =>
getEither(schema.ast, true, options)

/**
* @category decoding
* @since 3.10.0
*/
export const decodeUnknownPromise = <A, I>(
schema: Schema.Schema<A, I, never>,
export const decodeUnknownPromise = <S extends Schema.Schema.AnyNoContext>(
schema: S,
options?: AST.ParseOptions
) => {
const parser = decodeUnknown(schema, options)
return (u: unknown, overrideOptions?: AST.ParseOptions): Promise<A> => Effect.runPromise(parser(u, overrideOptions))
const parser = decodeUnknown<Schema.Schema.WithoutContext<S>>(schema, options)
return (u: unknown, overrideOptions?: AST.ParseOptions): Promise<Schema.Schema.Type<S>> =>
Effect.runPromise(parser(u, overrideOptions))
}

/**
* @category decoding
* @since 3.10.0
*/
export const decodeUnknown = <A, I, R>(
schema: Schema.Schema<A, I, R>,
export const decodeUnknown = <S extends Schema.Schema.Any>(
schema: S,
options?: AST.ParseOptions
): (u: unknown, overrideOptions?: AST.ParseOptions) => Effect.Effect<A, ParseIssue, R> =>
getEffect(schema.ast, true, options)
): (
u: unknown,
overrideOptions?: AST.ParseOptions
) => Effect.Effect<Schema.Schema.Type<S>, ParseIssue, Schema.Schema.Context<S>> => getEffect(schema.ast, true, options)

/**
* @throws `ParseError`
* @category encoding
* @since 3.10.0
*/
export const encodeUnknownSync = <A, I>(
schema: Schema.Schema<A, I, never>,
export const encodeUnknownSync = <S extends Schema.Schema.AnyNoContext>(
schema: S,
options?: AST.ParseOptions
): (u: unknown, overrideOptions?: AST.ParseOptions) => I => getSync(schema.ast, false, options)
): (u: unknown, overrideOptions?: AST.ParseOptions) => Schema.Schema.Encoded<S> => getSync(schema.ast, false, options)

/**
* @category encoding
* @since 3.10.0
*/
export const encodeUnknownOption = <A, I>(
schema: Schema.Schema<A, I, never>,
export const encodeUnknownOption = <S extends Schema.Schema.AnyNoContext>(
schema: S,
options?: AST.ParseOptions
): (u: unknown, overrideOptions?: AST.ParseOptions) => Option.Option<I> => getOption(schema.ast, false, options)
): (u: unknown, overrideOptions?: AST.ParseOptions) => Option.Option<Schema.Schema.Encoded<S>> =>
getOption(schema.ast, false, options)

/**
* @category encoding
* @since 3.10.0
*/
export const encodeUnknownEither = <A, I>(
schema: Schema.Schema<A, I, never>,
export const encodeUnknownEither = <S extends Schema.Schema.AnyNoContext>(
schema: S,
options?: AST.ParseOptions
): (u: unknown, overrideOptions?: AST.ParseOptions) => Either.Either<I, ParseIssue> =>
): (u: unknown, overrideOptions?: AST.ParseOptions) => Either.Either<Schema.Schema.Encoded<S>, ParseIssue> =>
getEither(schema.ast, false, options)

/**
* @category encoding
* @since 3.10.0
*/
export const encodeUnknownPromise = <A, I>(
schema: Schema.Schema<A, I, never>,
export const encodeUnknownPromise = <S extends Schema.Schema.AnyNoContext>(
schema: S,
options?: AST.ParseOptions
) => {
const parser = encodeUnknown(schema, options)
return (u: unknown, overrideOptions?: AST.ParseOptions): Promise<I> => Effect.runPromise(parser(u, overrideOptions))
const parser = encodeUnknown<Schema.Schema.WithoutContext<S>>(schema, options)
return (u: unknown, overrideOptions?: AST.ParseOptions): Promise<Schema.Schema.Encoded<S>> =>
Effect.runPromise(parser(u, overrideOptions))
}

/**
* @category encoding
* @since 3.10.0
*/
export const encodeUnknown = <A, I, R>(
schema: Schema.Schema<A, I, R>,
export const encodeUnknown = <S extends Schema.Schema.Any>(
schema: S,
options?: AST.ParseOptions
): (u: unknown, overrideOptions?: AST.ParseOptions) => Effect.Effect<I, ParseIssue, R> =>
): (
u: unknown,
overrideOptions?: AST.ParseOptions
) => Effect.Effect<Schema.Schema.Encoded<S>, ParseIssue, Schema.Schema.Context<S>> =>
getEffect(schema.ast, false, options)

/**
* @category decoding
* @since 3.10.0
*/
export const decodeSync: <A, I>(
schema: Schema.Schema<A, I, never>,
export const decodeSync: <S extends Schema.Schema.AnyNoContext>(
schema: S,
options?: AST.ParseOptions
) => (i: I, overrideOptions?: AST.ParseOptions) => A = decodeUnknownSync
) => (i: Schema.Schema.Encoded<S>, overrideOptions?: AST.ParseOptions) => Schema.Schema.Type<S> = decodeUnknownSync

/**
* @category decoding
* @since 3.10.0
*/
export const decodeOption: <A, I>(
schema: Schema.Schema<A, I, never>,
export const decodeOption: <S extends Schema.Schema.AnyNoContext>(
schema: S,
options?: AST.ParseOptions
) => (i: I, overrideOptions?: AST.ParseOptions) => Option.Option<A> = decodeUnknownOption
) => (i: Schema.Schema.Encoded<S>, overrideOptions?: AST.ParseOptions) => Option.Option<Schema.Schema.Type<S>> =
decodeUnknownOption

/**
* @category decoding
* @since 3.10.0
*/
export const decodeEither: <A, I>(
schema: Schema.Schema<A, I, never>,
export const decodeEither: <S extends Schema.Schema.AnyNoContext>(
schema: S,
options?: AST.ParseOptions
) => (i: I, overrideOptions?: AST.ParseOptions) => Either.Either<A, ParseIssue> = decodeUnknownEither
) => (
i: Schema.Schema.Encoded<S>,
overrideOptions?: AST.ParseOptions
) => Either.Either<Schema.Schema.Type<S>, ParseIssue> = decodeUnknownEither

/**
* @category decoding
* @since 3.10.0
*/
export const decodePromise: <A, I>(
schema: Schema.Schema<A, I, never>,
export const decodePromise: <S extends Schema.Schema.AnyNoContext>(
schema: S,
options?: AST.ParseOptions
) => (i: I, overrideOptions?: AST.ParseOptions) => Promise<A> = decodeUnknownPromise
) => (i: Schema.Schema.Encoded<S>, overrideOptions?: AST.ParseOptions) => Promise<Schema.Schema.Type<S>> =
decodeUnknownPromise

/**
* @category decoding
* @since 3.10.0
*/
export const decode: <A, I, R>(
schema: Schema.Schema<A, I, R>,
export const decode: <S extends Schema.Schema.Any>(
schema: S,
options?: AST.ParseOptions
) => (i: I, overrideOptions?: AST.ParseOptions) => Effect.Effect<A, ParseIssue, R> = decodeUnknown
) => (
i: Schema.Schema.Encoded<S>,
overrideOptions?: AST.ParseOptions
) => Effect.Effect<Schema.Schema.Type<S>, ParseIssue, Schema.Schema.Context<S>> = decodeUnknown

/**
* @throws `ParseError`
* @category validation
* @since 3.10.0
*/
export const validateSync = <A, I, R>(
schema: Schema.Schema<A, I, R>,
export const validateSync = <S extends Schema.Schema.Any>(
schema: S,
options?: AST.ParseOptions
): (u: unknown, overrideOptions?: AST.ParseOptions) => A => getSync(AST.typeAST(schema.ast), true, options)
): (u: unknown, overrideOptions?: AST.ParseOptions) => Schema.Schema.Type<S> =>
getSync(AST.typeAST(schema.ast), true, options)

/**
* @category validation
* @since 3.10.0
*/
export const validateOption = <A, I, R>(
schema: Schema.Schema<A, I, R>,
export const validateOption = <S extends Schema.Schema.Any>(
schema: S,
options?: AST.ParseOptions
): (u: unknown, overrideOptions?: AST.ParseOptions) => Option.Option<A> =>
): (u: unknown, overrideOptions?: AST.ParseOptions) => Option.Option<Schema.Schema.Type<S>> =>
getOption(AST.typeAST(schema.ast), true, options)

/**
* @category validation
* @since 3.10.0
*/
export const validateEither = <A, I, R>(
schema: Schema.Schema<A, I, R>,
export const validateEither = <S extends Schema.Schema.Any>(
schema: S,
options?: AST.ParseOptions
): (u: unknown, overrideOptions?: AST.ParseOptions) => Either.Either<A, ParseIssue> =>
): (u: unknown, overrideOptions?: AST.ParseOptions) => Either.Either<Schema.Schema.Type<S>, ParseIssue> =>
getEither(AST.typeAST(schema.ast), true, options)

/**
* @category validation
* @since 3.10.0
*/
export const validatePromise = <A, I>(
schema: Schema.Schema<A, I, never>,
export const validatePromise = <S extends Schema.Schema.AnyNoContext>(
schema: S,
options?: AST.ParseOptions
) => {
const parser = validate(schema, options)
return (u: unknown, overrideOptions?: AST.ParseOptions): Promise<A> => Effect.runPromise(parser(u, overrideOptions))
const parser = validate<Schema.Schema.WithoutContext<S>>(schema, options)
return (u: unknown, overrideOptions?: AST.ParseOptions): Promise<Schema.Schema.Type<S>> =>
Effect.runPromise(parser(u, overrideOptions))
}

/**
* @category validation
* @since 3.10.0
*/
export const validate = <A, I, R>(
schema: Schema.Schema<A, I, R>,
export const validate = <S extends Schema.Schema.Any>(
schema: S,
options?: AST.ParseOptions
): (a: unknown, overrideOptions?: AST.ParseOptions) => Effect.Effect<A, ParseIssue, R> =>
): (
a: unknown,
overrideOptions?: AST.ParseOptions
) => Effect.Effect<Schema.Schema.Type<S>, ParseIssue, Schema.Schema.Context<S>> =>
getEffect(AST.typeAST(schema.ast), true, options)

/**
Expand All @@ -661,9 +683,9 @@ export const validate = <A, I, R>(
* @category validation
* @since 3.10.0
*/
export const is = <A, I, R>(schema: Schema.Schema<A, I, R>, options?: AST.ParseOptions) => {
export const is = <S extends Schema.Schema.AnyNoContext>(schema: S, options?: AST.ParseOptions) => {
const parser = goMemo(AST.typeAST(schema.ast), true)
return (u: unknown, overrideOptions?: AST.ParseOptions | number): u is A =>
return (u: unknown, overrideOptions?: AST.ParseOptions | number): u is Schema.Schema.Type<S> =>
Either.isRight(parser(u, { exact: true, ...mergeInternalOptions(options, overrideOptions) }) as any)
}

Expand All @@ -674,9 +696,9 @@ export const is = <A, I, R>(schema: Schema.Schema<A, I, R>, options?: AST.ParseO
* @category validation
* @since 3.10.0
*/
export const asserts = <A, I, R>(schema: Schema.Schema<A, I, R>, options?: AST.ParseOptions) => {
export const asserts = <S extends Schema.Schema.Any>(schema: S, options?: AST.ParseOptions) => {
const parser = goMemo(AST.typeAST(schema.ast), true)
return (u: unknown, overrideOptions?: AST.ParseOptions): asserts u is A => {
return (u: unknown, overrideOptions?: AST.ParseOptions): asserts u is Schema.Schema.Type<S> => {
const result: Either.Either<any, ParseIssue> = parser(u, {
exact: true,
...mergeInternalOptions(options, overrideOptions)
Expand All @@ -691,46 +713,54 @@ export const asserts = <A, I, R>(schema: Schema.Schema<A, I, R>, options?: AST.P
* @category encoding
* @since 3.10.0
*/
export const encodeSync: <A, I>(
schema: Schema.Schema<A, I, never>,
export const encodeSync: <S extends Schema.Schema.AnyNoContext>(
schema: S,
options?: AST.ParseOptions
) => (a: A, overrideOptions?: AST.ParseOptions) => I = encodeUnknownSync
) => (a: Schema.Schema.Type<S>, overrideOptions?: AST.ParseOptions) => Schema.Schema.Encoded<S> = encodeUnknownSync

/**
* @category encoding
* @since 3.10.0
*/
export const encodeOption: <A, I>(
schema: Schema.Schema<A, I, never>,
export const encodeOption: <S extends Schema.Schema.AnyNoContext>(
schema: S,
options?: AST.ParseOptions
) => (input: A, overrideOptions?: AST.ParseOptions) => Option.Option<I> = encodeUnknownOption
) => (a: Schema.Schema.Type<S>, overrideOptions?: AST.ParseOptions) => Option.Option<Schema.Schema.Encoded<S>> =
encodeUnknownOption

/**
* @category encoding
* @since 3.10.0
*/
export const encodeEither: <A, I>(
schema: Schema.Schema<A, I, never>,
export const encodeEither: <S extends Schema.Schema.AnyNoContext>(
schema: S,
options?: AST.ParseOptions
) => (a: A, overrideOptions?: AST.ParseOptions) => Either.Either<I, ParseIssue> = encodeUnknownEither
) => (
a: Schema.Schema.Type<S>,
overrideOptions?: AST.ParseOptions
) => Either.Either<Schema.Schema.Encoded<S>, ParseIssue> = encodeUnknownEither

/**
* @category encoding
* @since 3.10.0
*/
export const encodePromise: <A, I>(
schema: Schema.Schema<A, I, never>,
export const encodePromise: <S extends Schema.Schema.AnyNoContext>(
schema: S,
options?: AST.ParseOptions
) => (a: A, overrideOptions?: AST.ParseOptions) => Promise<I> = encodeUnknownPromise
) => (a: Schema.Schema.Type<S>, overrideOptions?: AST.ParseOptions) => Promise<Schema.Schema.Encoded<S>> =
encodeUnknownPromise

/**
* @category encoding
* @since 3.10.0
*/
export const encode: <A, I, R>(
schema: Schema.Schema<A, I, R>,
export const encode: <S extends Schema.Schema.Any>(
schema: S,
options?: AST.ParseOptions
) => (a: A, overrideOptions?: AST.ParseOptions) => Effect.Effect<I, ParseIssue, R> = encodeUnknown
) => (
a: Schema.Schema.Type<S>,
overrideOptions?: AST.ParseOptions
) => Effect.Effect<Schema.Schema.Encoded<S>, ParseIssue, Schema.Schema.Context<S>> = encodeUnknown

interface InternalOptions extends AST.ParseOptions {
readonly isEffectAllowed?: boolean
Expand Down
5 changes: 5 additions & 0 deletions packages/effect/src/Schema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,6 +342,11 @@ export declare namespace Schema {
*/
export type Context<S> = S extends Schema.Variance<infer _A, infer _I, infer R> ? R : never

/**
* @since 3.18.4
*/
export type WithoutContext<S> = Schema<Type<S>, Encoded<S>>

/**
* @since 3.10.0
*/
Expand Down