Schema definition in NextJS

Introduction

Schema definition helps you describe the shape and rules of your data clearly. It makes sure your app uses data correctly and avoids errors.

When you want to validate user input before saving it.

When you need to define the structure of data sent between server and client.

When working with databases to ensure data follows expected formats.

When building APIs to document and enforce data contracts.

When you want to catch mistakes early by checking data shapes.

Syntax

NextJS

import { z } from 'zod';

const schema = z.object({
  name: z.string(),
  age: z.number().int().positive(),
  email: z.string().email().optional()
});

This example uses zod, a popular schema library in Next.js projects.

Each field defines the expected type and rules, like string, number, or optional fields.

Examples

Defines a user with a username and password, both strings with minimum lengths.

NextJS

const userSchema = z.object({
  username: z.string().min(3),
  password: z.string().min(8)
});

Defines a product with an ID, a non-negative price, and optional tags as an array of strings.

NextJS

const productSchema = z.object({
  id: z.string(),
  price: z.number().nonnegative(),
  tags: z.array(z.string()).optional()
});

Defines a response that can be either success with data or failure with an error message.

NextJS

const responseSchema = z.union([
  z.object({ success: z.literal(true), data: z.any() }),
  z.object({ success: z.literal(false), error: z.string() })
]);

Sample Program

This code defines a user schema and checks if userData matches it. If valid, it prints the user data. If not, it shows errors.

NextJS

import { z } from 'zod';

const userSchema = z.object({
  name: z.string(),
  age: z.number().int().positive(),
  email: z.string().email().optional()
});

// Example data to validate
const userData = {
  name: 'Alice',
  age: 30,
  email: '[e-mail]'
};

try {
  const validatedUser = userSchema.parse(userData);
  console.log('Valid user:', validatedUser);
} catch (e) {
  console.log('Validation error:', e.errors);
}

Important Notes

Always validate data before using it to avoid bugs and security issues.

Schema libraries like zod integrate well with Next.js and TypeScript for better developer experience.

Optional fields let you accept data that may or may not be present.

Summary

Schema definition describes the shape and rules of your data.

It helps catch errors early by validating data before use.

Using libraries like zod makes schema definition easy and clear in Next.js projects.

Practice

1. What is the main purpose of schema definition in a Next.js project?

easy

A. To manage server-side rendering

B. To describe the shape and rules of your data

C. To style the user interface components

D. To handle routing between pages

Solution

1. Step 1: Understand schema definition role

   Schema definition is about specifying how data should look and behave.

2. Step 2: Identify its main use in Next.js

   It helps validate data to catch errors early before using it in the app.

3. Final Answer:

   To describe the shape and rules of your data -> Option B

4. Quick Check:

   Schema = Data shape and rules [OK]

Hint: Schema defines data shape and validation rules [OK]

Common Mistakes:

• Confusing schema with UI styling
• Thinking schema manages routing
• Assuming schema handles rendering

2. Which of the following is the correct way to define a simple string schema using the zod library in Next.js?

easy

A. const schema = z.string();

B. const schema = z.string;

C. const schema = z.String();

D. const schema = new z.string();

Solution

1. Step 1: Recall zod syntax for string schema

   In zod, string schema is created by calling z.string() as a function.

2. Step 2: Check each option's syntax

   const schema = z.string(); uses z.string() correctly. Others miss parentheses or use wrong casing or new keyword.

3. Final Answer:

   const schema = z.string(); -> Option A

4. Quick Check:

   z.string() is correct syntax [OK]

Hint: Use parentheses to call z.string() function [OK]

Common Mistakes:

• Omitting parentheses after z.string
• Using uppercase 'String' instead of 'string'
• Using 'new' keyword incorrectly

3. Given this schema definition using zod:

const userSchema = z.object({
  name: z.string(),
  age: z.number().min(18)
});
const result = userSchema.safeParse({ name: "Alice", age: 16 });
console.log(result.success);

What will be logged to the console?

medium

A. true

B. Throws an error

C. false

D. undefined

Solution

1. Step 1: Understand schema rules

   The schema requires 'name' as string and 'age' as number at least 18.

2. Step 2: Check input data against schema

   Input has age 16, which is less than minimum 18, so validation fails.

3. Final Answer:

   false -> Option C

4. Quick Check:

   Validation fails because age < 18 [OK]

Hint: Check min() constraints carefully in validation [OK]

Common Mistakes:

• Assuming validation passes despite age < 18
• Confusing safeParse result with direct parse
• Expecting an error instead of false success

4. Identify the error in this Next.js schema definition using zod:

const productSchema = z.object({
  id: z.number,
  title: z.string(),
  price: z.number()
});

medium

A. Missing comma after 'title' property

B. Schema object should be an array

C. Using z.string() incorrectly

D. Missing parentheses after z.number for 'id'

Solution

1. Step 1: Check each property schema syntax

   'id' uses z.number without parentheses, which is incorrect syntax.

2. Step 2: Verify other properties and object structure

   Other properties are correct; object schema is correctly defined as an object, not array.

3. Final Answer:

   Missing parentheses after z.number for 'id' -> Option D

4. Quick Check:

   z.number() needs parentheses [OK]

Hint: Always call zod types as functions with () [OK]

Common Mistakes:

• Forgetting parentheses after z.number or z.string
• Thinking schema must be an array
• Missing commas between properties

5. You want to define a schema for a user profile in Next.js using zod where the 'email' field is optional but if present must be a valid email string. Which schema definition is correct?

hard

A. const userProfileSchema = z.object({ email: z.string().email().optional() });

B. const userProfileSchema = z.object({ email: z.optional(z.string().email) });

C. const userProfileSchema = z.object({ email: z.string().optional().email() });

D. const userProfileSchema = z.object({ email: z.string().email() || undefined });

Solution

1. Step 1: Understand optional email schema in zod

   To make a field optional but validate if present, use .optional() after .email().

2. Step 2: Check each option's method chaining

   const userProfileSchema = z.object({ email: z.string().email().optional() }); correctly chains z.string().email().optional(). const userProfileSchema = z.object({ email: z.optional(z.string().email) }); uses z.optional incorrectly. const userProfileSchema = z.object({ email: z.string().optional().email() }); calls optional before email, which breaks validation. const userProfileSchema = z.object({ email: z.string().email() || undefined }); uses invalid syntax.

3. Final Answer:

   const userProfileSchema = z.object({ email: z.string().email().optional() }); -> Option A

4. Quick Check:

   Use .optional() after .email() for optional validated fields [OK]

Hint: Chain .optional() after .email() for optional email fields [OK]

Common Mistakes:

• Placing .optional() before .email()
• Using z.optional() wrapper incorrectly
• Trying to use || undefined for optional