Purview.Results.ZodSharp 1.0.0-prerelease.2

Purview.Results.ZodSharp

Bridges ZodSharp ValidationResult<T> values into Purview.Results, so validation outcomes flow through the same result pipeline as every other expected outcome instead of throwing.

Installation

dotnet add package Purview.Results.ZodSharp

Quick start

ZodSharp validation never throws: Validate returns a ValidationResult<T> carrying the validated value on success and every ValidationError on failure. ToResult translates that into a result whose error type the caller chooses:

return RepositoryReconciliationResultSchema
    .Validate(reconciliationResult)
    .ToResult<RepositoryReconciliationResult, ReconciliationError>(errors =>
        new ReconciliationResultInvalid(reconciliationResult, errors)
    );

When the surrounding method's success type differs from the validated type, produce the failure with the generated AsFailure<TValue>() helper instead, because the validated value is not the value the method succeeds with:

var validated = ProviderConnectionIdSchema.Validate(providerConnectionId);

if (!validated.IsSuccess)
    return new ProviderConnectionInvalid(providerConnectionId, validated.Errors)
        .AsFailure<RepositoryReconciliationResult>();

return await ReconcileCoreAsync(validated.Value, repositories, cancellationToken);

API

The error type must be named explicitly when it is a union, as in ToResult<RepositoryReconciliationResult, ReconciliationError>(...), because a union case does not carry the union type that contains it.

A factory returning a result rather than an error is deliberately not offered: for a lambda returning Result<TValue, TError> the compiler prefers a Func<..., TError> parameter and would silently nest the results. Naming the error type explicitly keeps the intent unambiguous.

Examples

src/examples/Examples.Zod is a runnable console example that validates a [ZodSchema] TenantInput and turns the outcome into a Result<Tenant, TenantError>, with the rejection carrying its reported ValidationErrors.

dotnet run --project src/examples/Examples.Zod

The repository README lists the Basic, ASP.NET Core and ASP.NET Core + Zod examples too.

Related packages

Agent skills

This package ships the purview-results-zodsharp-validation agent skill under .agents/. Repositories that import Purview.BuildSdk get it mirrored into their own .agents/ folder on the next restore or build, so AI agents working there receive the guidance automatically.

License

MIT — see LICENSE.md.