-
-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Implement Standard Schema spec (#1213)
Co-authored-by: Vincent Driessen <[email protected]>
- Loading branch information
1 parent
99c1e0c
commit 8116662
Showing
12 changed files
with
321 additions
and
51 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| /** The Standard Schema interface. */ | ||
| export interface StandardSchemaV1<Input = unknown, Output = Input> { | ||
| /** The Standard Schema properties. */ | ||
| readonly '~standard': StandardSchemaV1.Props<Input, Output>; | ||
| } | ||
|
|
||
| export declare namespace StandardSchemaV1 { | ||
| /** The Standard Schema properties interface. */ | ||
| export interface Props<Input = unknown, Output = Input> { | ||
| /** The version number of the standard. */ | ||
| readonly version: 1; | ||
| /** The vendor name of the schema library. */ | ||
| readonly vendor: string; | ||
| /** Validates unknown input values. */ | ||
| readonly validate: (value: unknown) => Result<Output> | Promise<Result<Output>>; | ||
| /** Inferred types associated with the schema. */ | ||
| readonly types?: Types<Input, Output> | undefined; | ||
| } | ||
|
|
||
| /** The result interface of the validate function. */ | ||
| export type Result<Output> = SuccessResult<Output> | FailureResult; | ||
|
|
||
| /** The result interface if validation succeeds. */ | ||
| export interface SuccessResult<Output> { | ||
| /** The typed output value. */ | ||
| readonly value: Output; | ||
| /** The non-existent issues. */ | ||
| readonly issues?: undefined; | ||
| } | ||
|
|
||
| /** The result interface if validation fails. */ | ||
| export interface FailureResult { | ||
| /** The issues of failed validation. */ | ||
| readonly issues: ReadonlyArray<Issue>; | ||
| } | ||
| /** The issue interface of the failure output. */ | ||
| export interface Issue { | ||
| /** The error message of the issue. */ | ||
| readonly message: string; | ||
| /** The path of the issue, if any. */ | ||
| readonly path?: ReadonlyArray<PropertyKey | PathSegment> | undefined; | ||
| } | ||
|
|
||
| /** The path segment interface of the issue. */ | ||
| export interface PathSegment { | ||
| /** The key representing a path segment. */ | ||
| readonly key: PropertyKey; | ||
| } | ||
|
|
||
| /** The Standard Schema types interface. */ | ||
| export interface Types<Input = unknown, Output = Input> { | ||
| /** The input type of the schema. */ | ||
| readonly input: Input; | ||
| /** The output type of the schema. */ | ||
| readonly output: Output; | ||
| } | ||
|
|
||
| /** Infers the input type of a Standard Schema. */ | ||
| export type InferInput<Schema extends StandardSchemaV1> = NonNullable< | ||
| Schema['~standard']['types'] | ||
| >['input']; | ||
|
|
||
| /** Infers the output type of a Standard Schema. */ | ||
| export type InferOutput<Schema extends StandardSchemaV1> = NonNullable< | ||
| Schema['~standard']['types'] | ||
| >['output']; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| import { string, numeric } from '../dist'; | ||
| import { expectAssignable, expectError, expectType } from 'tsd'; | ||
| import type { StandardSchemaV1 } from '@standard-schema/spec'; | ||
|
|
||
| expectAssignable<StandardSchemaV1>(string); | ||
| expectAssignable<StandardSchemaV1<unknown>>(string); | ||
| expectAssignable<StandardSchemaV1<unknown, string>>(string); | ||
|
|
||
| declare const input: StandardSchemaV1.InferInput<typeof numeric>; | ||
| declare const output: StandardSchemaV1.InferOutput<typeof numeric>; | ||
|
|
||
| expectType<unknown>(input); | ||
| expectType<number>(output); | ||
|
|
||
| // A generic function that accepts an arbitrary spec-compliant validator | ||
| declare function standardValidate<T extends StandardSchemaV1>( | ||
| schema: T, | ||
| input: StandardSchemaV1.InferInput<T>, | ||
| ): StandardSchemaV1.InferOutput<T>; | ||
|
|
||
| // `string` and `stringToNumber` are accepted by `standardValidate` | ||
| expectError(standardValidate(() => "I'm not a standard validator", 42)); | ||
| expectType<string>(standardValidate(string, "I'm a string")); | ||
| expectType<number>(standardValidate(numeric, "I'm a string")); | ||
| expectType<number>(standardValidate(numeric, ['not', 'a', 'string'])); |
Oops, something went wrong.