Skip to content

feat(zod): uuid validation #2801

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

Merged
ymc9 merged 6 commits into from
Sep 3, 2026
Merged

feat(zod): uuid validation #2801

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2fe7769
feat: uuid validation
sanny-io Aug 13, 2026
15c89ec
chore: update test schema
sanny-io Aug 13, 2026
e2501bc
chore: add tests
sanny-io Aug 13, 2026
217d075
fix: check `isUuid` version
sanny-io Aug 13, 2026
96af496
chore: add `isUuid` invocation test
sanny-io Aug 13, 2026
2f7e00c
Merge branch 'dev' into feat/uuid-validation
ymc9 Sep 3, 2026
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
1 change: 1 addition & 0 deletions packages/cli/test/db/pull.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -652,6 +652,7 @@ enum Status {
score Float @gte(0.0)
rating Decimal @lt(10)
rank BigInt @lte(999)
extId String @uuid
}`,
);
runCli('db push', workDir);
Expand Down
11 changes: 11 additions & 0 deletions packages/language/res/stdlib.zmodel
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -542,6 +542,11 @@ attribute @contains(_ text: String, _ message: String?) @@@targetField([StringFi
*/
attribute @regex(_ regex: String, _ message: String?) @@@targetField([StringField]) @@@validation @@@lite

/**
* Validates a string field value is a valid UUID.
*/
attribute @uuid(_ version: Int?, _ message: String?) @@@targetField([StringField]) @@@validation @@@lite

/**
* Validates a string field value is a valid email address.
*/
Expand Down Expand Up @@ -649,6 +654,12 @@ function isDate(field: String): Boolean {
function isTime(field: String, precision: Int?): Boolean {
} @@@expressionContext([ValidationRule])

/**
* Validates a string field value is a valid UUID.
*/
function isUuid(field: String, version: Int?): Boolean {
} @@@expressionContext([ValidationRule])
Comment thread
sanny-io marked this conversation as resolved.

/**
* Validates a string field value is a valid url.
*/
Expand Down
8 changes: 8 additions & 0 deletions packages/language/src/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import {
isLiteralExpr,
isMemberAccessExpr,
isModel,
isNumberLiteral,
isObjectExpr,
isPlugin,
isReferenceExpr,
Expand Down Expand Up @@ -78,6 +79,13 @@ export function getStringLiteral(node: AstNode | undefined): string | undefined
return isStringLiteral(node) ? node.value : undefined;
}

/**
* Try getting number value from a potential number literal expression
*/
export function getNumberLiteral(node: AstNode | undefined): number | undefined {
return isNumberLiteral(node) ? Number(node.value) : undefined;
}

const isoDateTimeRegex = /^\d{4}(-\d\d(-\d\d(T\d\d:\d\d(:\d\d)?(\.\d+)?(([+-]\d\d:\d\d)|Z)?)?)?)?$/i;

/**
Expand Down
9 changes: 9 additions & 0 deletions packages/language/src/validators/attribute-application-validator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ import {
getAttributeArg,
getContainingDataModel,
getDataSourceProvider,
getNumberLiteral,
getStringLiteral,
hasAttribute,
isAuthOrAuthMemberAccess,
Expand Down Expand Up @@ -460,6 +461,14 @@ export default class AttributeApplicationValidator implements AstValidator<Attri
}
}

@check('@uuid')
private _checkUuid(attr: AttributeApplication, accept: ValidationAcceptor) {
const version = getNumberLiteral(attr.args[0]?.value);
if (version !== undefined && version !== 4 && version !== 7) {
accept('error', `\`@uuid\` version must be \`4\` or \`7\``, { node: attr.args[0]! });
}
}

@check('@@schema')
private _checkSchema(attr: AttributeApplication, accept: ValidationAcceptor) {
const schemaName = getStringLiteral(attr.args[0]?.value);
Expand Down
14 changes: 14 additions & 0 deletions packages/language/src/validators/function-invocation-validator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,20 @@ export default class FunctionInvocationValidator implements AstValidator<Express
}
}

@func('isUuid')
private _checkIsUuid(expr: InvocationExpr, accept: ValidationAcceptor) {
// second argument must be 4 or 7 if provided
const versionArg = expr.args[1]?.value;
if (versionArg) {
const version = getLiteral<number>(versionArg);
if (version !== undefined && version !== 4 && version !== 7) {
accept('error', 'second argument must be 4 or 7', {
node: expr.args[1]!,
});
}
}
}

@func('cuid')
private _checkCuid(expr: InvocationExpr, accept: ValidationAcceptor) {
// first argument must be 1 or 2 if provided
Expand Down
75 changes: 75 additions & 0 deletions packages/language/test/attribute-application.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -588,6 +588,81 @@ describe('Attribute application validation tests', () => {
});
});

describe('Field-level @uuid attribute', () => {
it('does not require a version arg', async () => {
await loadSchema(
`
datasource db {
provider = 'sqlite'
url = 'file:./dev.db'
}

model User {
id String @id @uuid
}
`,
);
});

it('accepts supported version args', async () => {
await loadSchema(
`
datasource db {
provider = 'sqlite'
url = 'file:./dev.db'
}

model User {
id String @id @uuid(4)
}
`,
);

await loadSchema(
`
datasource db {
provider = 'sqlite'
url = 'file:./dev.db'
}

model User {
id String @id @uuid(7)
}
`,
);
});

it('rejects unsupported version args', async () => {
await loadSchemaWithError(
`
datasource db {
provider = 'sqlite'
url = 'file:./dev.db'
}

model User {
id String @id @uuid(1)
}
`,
/`@uuid` version must be `4` or `7`/,
);

await loadSchemaWithError(
`
datasource db {
provider = 'sqlite'
url = 'file:./dev.db'
}

model User {
id String @id @uuid(2)
}
`,
/`@uuid` version must be `4` or `7`/,
);
});
});

describe('Native type mapping attributes', () => {
describe('sqlite', () => {
it('rejects when any native type mapping attribute is used', async () => {
Expand Down
48 changes: 48 additions & 0 deletions packages/language/test/function-invocation.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -414,4 +414,52 @@ describe('Function Invocation Tests', () => {
);
});
});

describe('isUuid() version validation', () => {
it('should accept valid uuid versions', async () => {
await loadSchema(`
datasource db {
provider = 'sqlite'
url = 'file:./dev.db'
}

model User {
id String @id @default(uuid(4))

@@validate(isUuid(id, 4))
}
`);

await loadSchema(`
datasource db {
provider = 'sqlite'
url = 'file:./dev.db'
}

model User {
id String @id @default(uuid(7))

@@validate(isUuid(id, 7))
}
`);
});

it('should reject invalid uuid versions', async () => {
await loadSchemaWithError(
`
datasource db {
provider = 'sqlite'
url = 'file:./dev.db'
}

model User {
id String @id @default(uuid())

@@validate(isUuid(id, 1))
}
`,
'second argument must be 4 or 7',
);
});
});
});
18 changes: 18 additions & 0 deletions packages/zod/src/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ const stringFuncZodMap = {
isEmail: 'email',
isUrl: 'url',
isPhone: 'e164',
isUuid: 'uuid',
isDate: 'date',
isTime: 'time',
isDateTime: 'datetime',
Expand Down Expand Up @@ -79,6 +80,15 @@ export function addStringValidation(
}
break;
}
case '@uuid': {
const version = getArgValue<number>(attr.args?.[0]?.value);
if (version === 7) {
result = result.uuidv7();
} else {
result = result.uuidv4();
}
break;
Comment thread
coderabbitai[bot] marked this conversation as resolved.
}
case '@email':
result = result.email();
break;
Expand Down Expand Up @@ -555,6 +565,7 @@ function evalCall(data: any, expr: CallExpression) {
case 'isEmail':
case 'isUrl':
case 'isPhone':
case 'isUuid':
case 'isDate':
case 'isTime':
case 'isDateTime': {
Expand All @@ -569,6 +580,13 @@ function evalCall(data: any, expr: CallExpression) {
`"isTime" optional second argument must be a number`,
);
return z.iso.time({ precision }).safeParse(fieldArg).success;
} else if (f === 'isUuid') {
const version = getArgValue<number>(expr.args?.[1]);
invariant(
version === null || version == undefined || version === 4 || version === 7,
`"isUuid" optional second argument must 4 or 7`,
);
return z.uuid({ version: version ? `v${version}` : undefined }).safeParse(fieldArg).success;
}
const fn = stringFuncZodMap[f];
return z.string()[fn]().safeParse(fieldArg).success;
Expand Down
16 changes: 16 additions & 0 deletions packages/zod/test/factory.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ describe.each([
metadata: null,
status: 'ACTIVE',
address: null,
extId: null,
};

// A fully valid Post object (without relations)
Expand Down Expand Up @@ -290,6 +291,21 @@ describe.each([
expect(result.success).toBe(true);
});

it('rejects invalid uuid for @uuid field', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({ ...validUser, extId: 'not-a-uuid' });
expect(result.success).toBe(false);
});

it('accepts valid uuid for @uuid field', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({
...validUser,
extId: '20ef31c8-a2c6-4dca-b87b-838e364ab4b3',
});
expect(result.success).toBe(true);
});

it('rejects invalid date for @date field', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({ ...validUser, birthdate: 'not-a-date' });
Expand Down
16 changes: 16 additions & 0 deletions packages/zod/test/schema/schema-lite.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ export class SchemaType implements SchemaDef {
name: "id",
type: "String",
id: true,
attributes: [{ name: "@default", args: [{ name: "value", value: ExpressionUtils.call("cuid") }] }] as readonly AttributeApplication[],
default: ExpressionUtils.call("cuid") as FieldDefault
},
email: {
Expand Down Expand Up @@ -82,6 +83,12 @@ export class SchemaType implements SchemaDef {
optional: true,
attributes: [{ name: "@time" }] as readonly AttributeApplication[]
},
extId: {
name: "extId",
type: "String",
optional: true,
attributes: [{ name: "@uuid" }] as readonly AttributeApplication[]
},
createdAt: {
name: "createdAt",
type: "DateTime",
Expand Down Expand Up @@ -129,6 +136,7 @@ export class SchemaType implements SchemaDef {
name: "id",
type: "String",
id: true,
attributes: [{ name: "@default", args: [{ name: "value", value: ExpressionUtils.call("cuid") }] }] as readonly AttributeApplication[],
default: ExpressionUtils.call("cuid") as FieldDefault
},
title: {
Expand Down Expand Up @@ -171,6 +179,7 @@ export class SchemaType implements SchemaDef {
name: "id",
type: "String",
id: true,
attributes: [{ name: "@default", args: [{ name: "value", value: ExpressionUtils.call("cuid") }] }] as readonly AttributeApplication[],
default: ExpressionUtils.call("cuid") as FieldDefault
},
name: {
Expand All @@ -184,6 +193,7 @@ export class SchemaType implements SchemaDef {
discount: {
name: "discount",
type: "Float",
attributes: [{ name: "@default", args: [{ name: "value", value: ExpressionUtils.literal(0) }] }] as readonly AttributeApplication[],
default: 0 as FieldDefault
},
finalPrice: {
Expand Down Expand Up @@ -211,11 +221,13 @@ export class SchemaType implements SchemaDef {
name: "id",
type: "Int",
id: true,
attributes: [{ name: "@default", args: [{ name: "value", value: ExpressionUtils.call("autoincrement") }] }] as readonly AttributeApplication[],
default: ExpressionUtils.call("autoincrement") as FieldDefault
},
createdAt: {
name: "createdAt",
type: "DateTime",
attributes: [{ name: "@default", args: [{ name: "value", value: ExpressionUtils.call("now") }] }] as readonly AttributeApplication[],
default: ExpressionUtils.call("now") as FieldDefault
},
assetType: {
Expand All @@ -239,12 +251,14 @@ export class SchemaType implements SchemaDef {
name: "id",
type: "Int",
id: true,
attributes: [{ name: "@default", args: [{ name: "value", value: ExpressionUtils.call("autoincrement") }] }] as readonly AttributeApplication[],
default: ExpressionUtils.call("autoincrement") as FieldDefault
},
createdAt: {
name: "createdAt",
type: "DateTime",
originModel: "Asset",
attributes: [{ name: "@default", args: [{ name: "value", value: ExpressionUtils.call("now") }] }] as readonly AttributeApplication[],
default: ExpressionUtils.call("now") as FieldDefault
},
assetType: {
Expand Down Expand Up @@ -275,12 +289,14 @@ export class SchemaType implements SchemaDef {
name: "id",
type: "Int",
id: true,
attributes: [{ name: "@default", args: [{ name: "value", value: ExpressionUtils.call("autoincrement") }] }] as readonly AttributeApplication[],
default: ExpressionUtils.call("autoincrement") as FieldDefault
},
createdAt: {
name: "createdAt",
type: "DateTime",
originModel: "Asset",
attributes: [{ name: "@default", args: [{ name: "value", value: ExpressionUtils.call("now") }] }] as readonly AttributeApplication[],
default: ExpressionUtils.call("now") as FieldDefault
},
assetType: {
Expand Down
Loading
Loading