-
-
Notifications
You must be signed in to change notification settings - Fork 159
add ~standard toJSONSchema support
#1493
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.
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 |
|---|---|---|
| @@ -1,35 +1,5 @@ | ||
| import { type } from "arktype" | ||
| const ark: { foo?: string } = {} | ||
|
|
||
| const original = type({ | ||
| id: "string", | ||
| name: "string", | ||
| "favoriteColor?": "string" | ||
| }) | ||
| ark.foo &&= `${ark.foo}1` | ||
|
|
||
| const updateSchema = original.map(prop => | ||
| prop.key === "name" ? | ||
| { | ||
| ...prop, | ||
| // update key name if needed | ||
| key: `prefix${prop.key}` as const, | ||
| // update optionality if needed | ||
| kind: "optional", | ||
| // update value if needed | ||
| value: prop.value.or(type.null) | ||
| } | ||
| : prop | ||
| ) | ||
|
|
||
| type Result = { | ||
| id: string | ||
| favoriteColor?: string | ||
| prefixname?: string | null | ||
| } | ||
|
|
||
| /* updateSchema: | ||
| { | ||
| id: "string", | ||
| "name?": "string" | ||
| "favoriteColor?": "string | null" | ||
| } | ||
| */ | ||
| console.log(ark.foo) |
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 | ||||
|---|---|---|---|---|---|---|
|
|
@@ -36,7 +36,8 @@ export declare namespace StandardSchemaV1 { | |||||
| } | ||||||
|
|
||||||
| export interface ArkTypeProps<Input = unknown, Output = Input> | ||||||
| extends Props<Input, Output> { | ||||||
| extends Props<Input, Output>, | ||||||
| StandardJSONSchemaSourceV1.Props { | ||||||
| readonly vendor: "arktype" | ||||||
| } | ||||||
|
|
||||||
|
|
@@ -121,6 +122,59 @@ export declare namespace StandardSchemaV1 { | |||||
| Schema["~standard"]["types"] | ||||||
| >["output"] | ||||||
|
|
||||||
| /** | ||||||
| * A Standard Schema that implements the Standard JSON Schema Source interface. | ||||||
| * */ | ||||||
| export interface WithJSONSchemaSource<Input = unknown, Output = Input> { | ||||||
| "~standard": StandardJSONSchemaSourceV1.PropsWithStandardSchema< | ||||||
| Input, | ||||||
| Output | ||||||
| > | ||||||
| } | ||||||
|
|
||||||
| // biome-ignore lint/complexity/noUselessEmptyExport: needed for granular visibility control of TS namespace | ||||||
| export {} | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * The Standard JSON Schema Source interface. A standard interface to be implemented by any object/instance that can be converted to JSON Schema. | ||||||
| */ | ||||||
| export interface StandardJSONSchemaSourceV1 { | ||||||
| "~standard": StandardJSONSchemaSourceV1.Props | ||||||
| } | ||||||
|
|
||||||
| export declare namespace StandardJSONSchemaSourceV1 { | ||||||
| export interface Props { | ||||||
| /** | ||||||
| * Converts the Standard Schema to a JSON Schema. | ||||||
| * @param params - The options for the toJSONSchema method. | ||||||
| * | ||||||
| * @returns The JSON Schema. | ||||||
| */ | ||||||
| readonly toJSONSchema: ( | ||||||
| params: StandardJSONSchemaSourceV1.Options | ||||||
| ) => Record<string, unknown> | ||||||
| } | ||||||
|
|
||||||
| export interface PropsWithStandardSchema<Input = unknown, Output = Input> | ||||||
| extends Props, | ||||||
| StandardSchemaV1.Props<Input, Output> {} | ||||||
|
|
||||||
| /** The target version of the JSON Schema spec. */ | ||||||
| export type Target = | ||||||
| | "draft-04" | ||||||
| | "draft-06" | ||||||
| | "draft-07" | ||||||
| | "draft-2019-09" | ||||||
| | "draft-2020-12" | ||||||
|
|
||||||
| export type IO = "input" | "output" | ||||||
|
|
||||||
| /** The options for the ~toJSONSchema method. */ | ||||||
| export interface Options { | ||||||
| /** @ Specifies whether the generated JSON Schema should reflect the expected input or output values. */ | ||||||
|
||||||
| /** @ Specifies whether the generated JSON Schema should reflect the expected input or output values. */ | |
| /** Specifies whether the generated JSON Schema should reflect the expected input or output values. */ |
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Using
as nevertype assertions hides potential type mismatches. Consider returning the proper type or using a more specific type assertion that matches the expected return typeRecord<string, unknown>.