Skip to content
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

feat: support ZodUnions of ZodLiterals #91

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 5 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,8 @@ testem.log
.DS_Store
Thumbs.db

stats.html
stats.html

# Nix
/.direnv/
/.envrc
12 changes: 11 additions & 1 deletion packages/dev-app/src/router.ts
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,15 @@ export const appRouter = createTRPCRouter({
.query(() => {
return "It's an input";
}),
unionInput: procedure
.input(
z.object({
aUnion: z.union([z.literal("one"), z.literal(2)]),
})
)
.query(({ input }) => {
return input;
}),
emailTextInput: procedure
.input(
z.object({
Expand Down Expand Up @@ -175,7 +184,7 @@ export const appRouter = createTRPCRouter({
optionalEnum: z.enum(["Three", "Four"]).optional(),
stringArray: z.string().array(),
boolean: z.boolean(),
union: z.discriminatedUnion("disc", [
discriminatedUnion: z.discriminatedUnion("disc", [
z.object({
disc: z.literal("one"),
oneProp: z.string(),
Expand All @@ -185,6 +194,7 @@ export const appRouter = createTRPCRouter({
twoProp: z.enum(["one", "two"]),
}),
]),
union: z.union([z.literal("one"), z.literal(2)]),
})
)
.query(() => ({ goodJob: "yougotthedata" })),
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import { defaultReferences } from "@src/parse/input-mappers/defaultReferences";
import { parseZodUnionDef } from "@src/parse/input-mappers/zod/parsers/parseZodUnionDef";
import { UnionNode } from "@src/parse/parseNodeTypes";
import { z } from "zod";

describe("Parse Zod Union", () => {
it("should parse a union node", () => {
const expected: UnionNode = {
type: "union",
path: [],
values: [
{
type: "literal",
value: "one",
path: [],
},
{
type: "literal",
value: 2,
path: [],
},
],
};
const zodSchema = z.union([z.literal("one"), z.literal(2)]);
const parsedZod = parseZodUnionDef(zodSchema._def, defaultReferences());
expect(parsedZod).toStrictEqual(expected);
});
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import { nodePropertiesFromRef } from "@src/parse/utils";
import { ZodUnionDef } from "zod";
import { UnionNode, ParseFunction, LiteralNode } from "../../../parseNodeTypes";
import { zodSelectorFunction } from "../selector";

export const parseZodUnionDef: ParseFunction<ZodUnionDef, UnionNode> = (
def,
refs
) => {
refs.addDataFunctions.addDescriptionIfExists(def, refs);
return {
type: "union",
values: def.options.map(
(o) => zodSelectorFunction(o._def, { ...refs, path: [] }) as LiteralNode
),
...nodePropertiesFromRef(refs),
};
};
4 changes: 4 additions & 0 deletions packages/trpc-panel/src/parse/input-mappers/zod/selector.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import {
ZodPromiseDef,
ZodStringDef,
ZodUndefinedDef,
ZodUnionDef,
ZodVoidDef,
} from "zod";
import { parseZodStringDef } from "./parsers/parseZodStringDef";
Expand All @@ -40,6 +41,7 @@ import { parseZodEffectsDef } from "@src/parse/input-mappers/zod/parsers/parseZo
import { parseZodNullDef } from "@src/parse/input-mappers/zod/parsers/parseZodNullDef";
import { parseZodPromiseDef } from "@src/parse/input-mappers/zod/parsers/parseZodPromiseDef";
import { parseZodUndefinedDef } from "@src/parse/input-mappers/zod/parsers/parseZodUndefinedDef";
import { parseZodUnionDef } from "@src/parse/input-mappers/zod/parsers/parseZodUnionDef";
import { parseZodVoidDef } from "./parsers/parseZodVoidDef";

export const zodSelectorFunction: ParserSelectorFunction<ZodDefWithType> = (
Expand Down Expand Up @@ -89,6 +91,8 @@ export const zodSelectorFunction: ParserSelectorFunction<ZodDefWithType> = (
return parseZodPromiseDef(def as ZodPromiseDef, references);
case ZodFirstPartyTypeKind.ZodUndefined:
return parseZodUndefinedDef(def as ZodUndefinedDef, references);
case ZodFirstPartyTypeKind.ZodUnion:
return parseZodUnionDef(def as ZodUnionDef, references);
case ZodFirstPartyTypeKind.ZodVoid:
return parseZodVoidDef(def as ZodVoidDef, references);
}
Expand Down
6 changes: 6 additions & 0 deletions packages/trpc-panel/src/parse/parseNodeTypes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,11 @@ export type DiscriminatedUnionNode = {
discriminatorName: string;
} & SharedInputNodeProperties;

export type UnionNode = {
type: "union";
values: LiteralNode[];
} & SharedInputNodeProperties;

/**
* Any time you just want the front end to send back a value use this
*/
Expand All @@ -58,6 +63,7 @@ export type ParsedInputNode =
| ObjectNode
| EnumNode
| DiscriminatedUnionNode
| UnionNode
| LiteralNode
| StringNode
| NumberNode
Expand Down
10 changes: 10 additions & 0 deletions packages/trpc-panel/src/react-app/components/form/Field.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import { LiteralField } from "./fields/LiteralField";
import { NumberField } from "./fields/NumberField";
import { ObjectField } from "./fields/ObjectField";
import { TextField } from "./fields/TextField";
import { UnionField } from "./fields/UnionField";

export function Field({
inputNode,
Expand Down Expand Up @@ -77,6 +78,15 @@ export function Field({
node={inputNode}
/>
);
case "union":
return (
<UnionField
name={path}
label={label}
control={control}
node={inputNode}
/>
);
case "literal":
return <LiteralField />;
case "unsupported":
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
import React from "react";
import { Control, useController } from "react-hook-form";
import type { ParsedInputNode } from "@src/parse/parseNodeTypes";
import { BaseSelectField } from "./base/BaseSelectField";

export function UnionField({
name,
label,
control,
node,
}: {
name: string;
label: string;
control: Control<any>;
node: ParsedInputNode & { type: "union" };
}) {
const { field, fieldState } = useController({
name,
control,
});

return (
<BaseSelectField
options={node.values.map((n) => n.value as string)}
value={field.value}
onChange={field.onChange}
errorMessage={fieldState.error?.message}
label={label}
/>
);
}
5 changes: 5 additions & 0 deletions shell.nix
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
with import <nixpkgs> {};
mkShell {
name = "trpc-panel";
buildInputs = with nodePackages; [nodejs yarn];
}