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.

Sign up for GitHub

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(#232): add support for Omit / Pick in interface extend clause #249

Merged
merged 4 commits into from
Jul 11, 2024
Merged

feat(#232): add support for Omit / Pick in interface extend clause #249

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f66c172
test: adding failing test case
tvillaren Jun 29, 2024
45ab44d
partial: started refactoring for fix
tvillaren Jun 29, 2024
341fee9
feat: make tests pass + refacto
tvillaren Jun 30, 2024
14b3756
fix: typo
tvillaren Jun 30, 2024
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
24 changes: 23 additions & 1 deletion src/core/generateZodSchema.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -358,7 +358,7 @@ describe("generateZodSchema", () => {
);
});

it("should generate a schema with omit", () => {
it("should generate a schema with omit ", () => {
const source = `export type InvincibleSuperman = Omit<Superman, "weakness">;`;
expect(generate(source)).toMatchInlineSnapshot(
`"export const invincibleSupermanSchema = supermanSchema.omit({ "weakness": true });"`
Expand All @@ -372,6 +372,17 @@ describe("generateZodSchema", () => {
);
});

it("should generate a schema with omit in interface extension clause", () => {
const source = `export interface Superman extends Omit<Clark, "weakness"> {
withPower: boolean;
}`;
expect(generate(source)).toMatchInlineSnapshot(`
"export const supermanSchema = clarkSchema.omit({ "weakness": true }).extend({
withPower: z.boolean()
});"
`);
});

it("should generate a schema with pick", () => {
const source = `export type YouJustKnowMyName = Pick<SecretIdentity, "name">;`;
expect(generate(source)).toMatchInlineSnapshot(
Expand Down Expand Up @@ -459,6 +470,17 @@ describe("generateZodSchema", () => {
`);
});

it("should generate a schema with omit in interface extension clause and multiple clauses", () => {
const source = `export interface Superman extends KalL, Omit<Clark, "weakness">, Kryptonian {
withPower: boolean;
}`;
expect(generate(source)).toMatchInlineSnapshot(`
"export const supermanSchema = kalLSchema.extend(clarkSchema.omit({ "weakness": true }).shape).extend(kryptonianSchema.shape).extend({
withPower: z.boolean()
});"
`);
});

it("should deal with literal keys", () => {
const source = `export interface Villain {
"i.will.kill.everybody": true;
Expand Down
211 changes: 141 additions & 70 deletions src/core/generateZodSchema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,12 @@ export interface GenerateZodSchemaProps {
customJSDocFormatTypes: CustomJSDocFormatTypes;
}

type SchemaExtensionClause = {
extendedSchemaName: string;
omitOrPickType?: "Omit" | "Pick";
omitOrPickKeys?: ts.TypeNode;
};

/**
* Generate zod schema declaration
*
Expand All @@ -81,29 +87,47 @@ export function generateZodSchemaVariableStatement({
let requiresImport = false;

if (ts.isInterfaceDeclaration(node)) {
let schemaExtensionClauses: string[] | undefined;
let schemaExtensionClauses: SchemaExtensionClause[] | undefined;
if (node.typeParameters) {
throw new Error("Interface with generics are not supported!");
}
if (node.heritageClauses) {
// Looping on heritageClauses browses the "extends" keywords
schemaExtensionClauses = node.heritageClauses.reduce(
(deps: string[], h) => {
(deps: SchemaExtensionClause[], h) => {
if (h.token !== ts.SyntaxKind.ExtendsKeyword || !h.types) {
return deps;
}

// Looping on types browses the comma-separated interfaces
const heritages = h.types.map((expression) => {
return getDependencyName(expression.getText(sourceFile));
const identifierName = expression.expression.getText(sourceFile);

if (
["Omit", "Pick"].includes(identifierName) &&
expression.typeArguments
) {
const [originalType, keys] = expression.typeArguments;
return {
extendedSchemaName: getDependencyName(
originalType.getText(sourceFile)
),
omitOrPickType: identifierName as "Omit" | "Pick",
omitOrPickKeys: keys,
};
}

return { extendedSchemaName: getDependencyName(identifierName) };
});

return deps.concat(heritages);
},
[]
);

dependencies = dependencies.concat(schemaExtensionClauses);
dependencies = dependencies.concat(
schemaExtensionClauses.map((i) => i.extendedSchemaName)
);
}

schema = buildZodObject({
Expand Down Expand Up @@ -516,60 +540,19 @@ function buildZodPrimitive({
// Deal with `Omit<>` & `Pick<>` syntax
if (["Omit", "Pick"].includes(identifierName) && typeNode.typeArguments) {
const [originalType, keys] = typeNode.typeArguments;
let parameters: ts.ObjectLiteralExpression | undefined;

if (ts.isLiteralTypeNode(keys)) {
parameters = f.createObjectLiteralExpression([
f.createPropertyAssignment(
keys.literal.getText(sourceFile),
f.createTrue()
),
]);
}
if (ts.isUnionTypeNode(keys)) {
parameters = f.createObjectLiteralExpression(
keys.types.map((type) => {
if (!ts.isLiteralTypeNode(type)) {
throw new Error(
`${identifierName}<T, K> unknown syntax: (${
ts.SyntaxKind[type.kind]
} as K union part not supported)`
);
}
return f.createPropertyAssignment(
type.literal.getText(sourceFile),
f.createTrue()
);
})
);
}

if (!parameters) {
throw new Error(
`${identifierName}<T, K> unknown syntax: (${
ts.SyntaxKind[keys.kind]
} as K not supported)`
);
}
const zodCall = buildZodPrimitive({
z,
typeNode: originalType,
isOptional: false,
jsDocTags: {},
sourceFile,
dependencies,
getDependencyName,
skipParseJSDoc,
customJSDocFormatTypes,
});

return f.createCallExpression(
f.createPropertyAccessExpression(
buildZodPrimitive({
z,
typeNode: originalType,
isOptional: false,
jsDocTags: {},
sourceFile,
dependencies,
getDependencyName,
skipParseJSDoc,
customJSDocFormatTypes,
}),
f.createIdentifier(lower(identifierName))
),
undefined,
[parameters]
);
return buildOmitPickObject(identifierName, keys, sourceFile, zodCall);
}

const dependencyName = getDependencyName(identifierName);
Expand Down Expand Up @@ -1036,23 +1019,58 @@ function buildZodSchema(
}

function buildZodExtendedSchema(
schemaList: string[],
schemaList: SchemaExtensionClause[],
sourceFile: ts.SourceFile,
args?: ts.Expression[],
properties?: ZodProperty[]
) {
let zodCall = f.createIdentifier(schemaList[0]) as ts.Expression;
let zodCall = f.createIdentifier(
schemaList[0].extendedSchemaName
) as ts.Expression;

if (schemaList[0].omitOrPickType && schemaList[0].omitOrPickKeys) {
const keys = schemaList[0].omitOrPickKeys;
const omitOrPickIdentifierName = schemaList[0].omitOrPickType;
zodCall = buildOmitPickObject(
omitOrPickIdentifierName,
keys,
sourceFile,
zodCall
);
}

for (let i = 1; i < schemaList.length; i++) {
zodCall = f.createCallExpression(
f.createPropertyAccessExpression(zodCall, f.createIdentifier("extend")),
undefined,
[
f.createPropertyAccessExpression(
f.createIdentifier(schemaList[i]),
f.createIdentifier("shape")
),
]
);
const omitOrPickIdentifierName = schemaList[i].omitOrPickType;
const keys = schemaList[i].omitOrPickKeys;

if (omitOrPickIdentifierName && keys) {
zodCall = f.createCallExpression(
f.createPropertyAccessExpression(zodCall, f.createIdentifier("extend")),
undefined,
[
f.createPropertyAccessExpression(
buildOmitPickObject(
omitOrPickIdentifierName,
keys,
sourceFile,
f.createIdentifier(schemaList[i].extendedSchemaName)
),
f.createIdentifier("shape")
),
]
);
} else {
zodCall = f.createCallExpression(
f.createPropertyAccessExpression(zodCall, f.createIdentifier("extend")),
undefined,
[
f.createPropertyAccessExpression(
f.createIdentifier(schemaList[i].extendedSchemaName),
f.createIdentifier("shape")
),
]
);
}
}

if (args?.length) {
Expand Down Expand Up @@ -1108,7 +1126,7 @@ function buildZodObject({
dependencies: string[];
sourceFile: ts.SourceFile;
getDependencyName: Required<GenerateZodSchemaProps>["getDependencyName"];
schemaExtensionClauses?: string[];
schemaExtensionClauses?: SchemaExtensionClause[];
skipParseJSDoc: boolean;
customJSDocFormatTypes: CustomJSDocFormatTypes;
}) {
Expand Down Expand Up @@ -1152,6 +1170,7 @@ function buildZodObject({
if (schemaExtensionClauses && schemaExtensionClauses.length > 0) {
objectSchema = buildZodExtendedSchema(
schemaExtensionClauses,
sourceFile,
properties.length > 0
? [
f.createObjectLiteralExpression(
Expand Down Expand Up @@ -1344,3 +1363,55 @@ function buildSchemaReference(

throw new Error("Unknown IndexedAccessTypeNode.objectType type");
}

function buildOmitPickObject(
omitOrPickIdentifierName: string,
keys: ts.TypeNode,
sourceFile: ts.SourceFile,
zodCall: ts.Expression
) {
let parameters: ts.ObjectLiteralExpression | undefined;

if (ts.isLiteralTypeNode(keys)) {
parameters = f.createObjectLiteralExpression([
f.createPropertyAssignment(
keys.literal.getText(sourceFile),
f.createTrue()
),
]);
}
if (ts.isUnionTypeNode(keys)) {
parameters = f.createObjectLiteralExpression(
keys.types.map((type) => {
if (!ts.isLiteralTypeNode(type)) {
throw new Error(
`${omitOrPickIdentifierName}<T, K> unknown syntax: (${
ts.SyntaxKind[type.kind]
} as K union part not supported)`
);
}
return f.createPropertyAssignment(
type.literal.getText(sourceFile),
f.createTrue()
);
})
);
}

if (!parameters) {
throw new Error(
`${omitOrPickIdentifierName}<T, K> unknown syntax: (${
ts.SyntaxKind[keys.kind]
} as K not supported)`
);
}

return f.createCallExpression(
f.createPropertyAccessExpression(
zodCall,
f.createIdentifier(lower(omitOrPickIdentifierName))
),
undefined,
[parameters]
);
}