Add Standard Schema v1 support #54
Conversation
|
|
| * | ||
| * Copyright (c) 2024 Colin McDonnell | ||
| */ | ||
| export interface StandardSchemaV1<Input = unknown, Output = Input> { |
There was a problem hiding this comment.
I'm not 100% clear on this but I wonder if we should just install the standardschema package and reexport those. The spec doesn't specify and suggests we can import or include here. This is the easiest approach I suppose.
@timostamm thoughts?
There was a problem hiding this comment.
Looking at arktype, this seems to be a the thing to do, redeclare these. So probably fine.
There was a problem hiding this comment.
The FAQ says it's fine to copy and paste the types if you don't want the dependency. We don't want the dependency, so this approach looks good to me.
I don't think we should export the type from index.ts though. Can we remove the export?
There was a problem hiding this comment.
I also referred to the FAQ and concluded that it’s better not to add the dependency.
I’ve exported only the createStandardSchema function.
fixed c23dbae
There was a problem hiding this comment.
I think we should add an example test here as well. I know it's new to this repo, but one of the functionalities that standard schema affords is specifying different types for input and output (in our case MessageShape<Desc> and MessageValidType<Desc>). This way we can ensure that the generated types take into account things like required fields (removing the need for assertions for existence).
There was a problem hiding this comment.
On looking over this again, I think we can skip adding an explicit test here and instead just write a tiny little bit of typescript that takes advantage of the MessageValidType. For example, if we use the OrderSchema in this file, and ensure that result.value has a user field without needing to use result.value.user? to conditionally access, that should be sufficient.
There was a problem hiding this comment.
Thanks for the feedback!
I thought it would be helpful to include an example demonstrating how to use valid-type with standard-schema, so I updated it to follow the style of valid-types.js.
updated 91e89cc
| input: undefined as unknown as MessageShape<Desc>, | ||
| output: undefined as unknown as MessageValidType<Desc>, |
There was a problem hiding this comment.
This strikes me as weird, ideally we could at least reference why these values need to exist but are in fact undefined. Maybe this is just an element of standard schema. Add a comment to indicate why these need to exist (ideally with references).
There was a problem hiding this comment.
Looking at arktype, they seem to just leave it out entirely and also refine the vendor value. I'm not sure we necessarily need to define the vendor stuff, but it seems like types might not actually be needed here.
There was a problem hiding this comment.
The types property is necessary for TypeScript’s type inference to work correctly, even though it’s not used at runtime.
types is used to associate type metadata with the schema. This property should be declared on the schema's type, but is not required to exist at runtime. Authors implementing a schema using a class are encouraged to use TypeScript's declare keyword or other means to avoid runtime overhead. InferInput and InferOutput can be used to extract their corresponding types.
I’ve added a comment to clarify this. d230997
ichizero
changed the title
## What's Changed * Add Standard Schema v1 support by @ichizero in #54 ## New Contributors * @ichizero made their first contribution in #54 **Full Changelog**: v0.4.0...v0.5.0
Description
Closes #52
This PR introduces a new utility,
createStandardSchema, which generates a Standard Schema v1 compliant validator for Protobuf message types. The main features and changes are as follows:StandardSchemaV1interface, following the standard-schema specification.validatemethod that returns results in the Standard Schema format, including detailed issues with error messages and paths.Violationobjects to Standard SchemaIssueobjects, ensuring compatibility and clarity in error reporting.typesproperty.This addition improves interoperability with tools and libraries that support the Standard Schema, and makes it easier to integrate Protobuf validation into broader validation workflows.