How can you create the "Property within Key of Type" structure using Zod?

Question

How can you create the "Property within Key of Type" structure using Zod?

My current challenge involves a Zod shape with multiple keys. I am in need of creating another shape that mirrors the same keys, but with different types. In regular Typescript, this could be achieved with:

type TypeA = {
  something1: number
  something2: number
  ...
  somethingN: number
}

type TypeB = {
  [Property in keyof TypeA]: string
}

By defining the shapes in this way, modifying TypeA automatically updates TypeB whenever keys are added or removed. Is there a method to replicate this functionality using Zod? If so, how can it be implemented?

The code snippet below does not achieve the desired outcome, as it only provides the shape for the first type:

const TypeA = z.object({
  something1: z.number(),
  something2: z.number(),
  ...
  somethingN: z.number()
)}

type TypeA = z.infer<typeof TypeA>

type TypeB = {
  [Property in keyof TypeA]: string
}
// TypeB shape is missing

I am searching for a solution within Zod that allows for iterating over keys and assigning them specific types (or perhaps shapes before being inferred). Is this functionality supported within Zod?

typescript zod

Answer 1

Answer №1

// define the list of property keys as a constant string array.
const PropertyKeyNames = ["key1", "key2", "keyN"] as const satisfies readonly string[];
type PropertyKeys = typeof PropertyKeyNames[number];

// create TypeA and TypeB using indexed properties.
type TypeA = {[Property in PropertyKeys]: number;};
type TypeB = {[Property in PropertyKeys]: string;};

// Create a zod schema instance dynamically at runtime.

/**
 * Creates a zod object with PropertyKeyNames as keys, each having a type specified by a zod object
 * @param zobject the zod object for each property, typically z.string()
 * @returns a z.object(...) function call result
 */
const build = (zobject: z.ZodTypeAny): ReturnType<typeof z.object> => {
    const shape: { [k: string]: z.ZodTypeAny } = {};
    for (const key of PropertyKeyNames) {
        shape[key] = zobject;
    }
    return z.object(shape);
};

// The resulting zod object with string type values.
const ZobjectWithString = build(z.string());

Tests :

const TestObjects = [
    {key1: "value1", key2: "value2", keyN: "value3"}, // OK
    {key1: "value1", key2: "value2", keyN: "value3", extraKey:"extra"}, // OK
    {keyN: "value3"}, // failed
    { username: "Ludwig" }, // failed
    undefined
]
let index = 0;
for(const obj of TestObjects){
    try {
        ZobjectWithString.parse(obj);
        console.log("Test " + index + " passed");
    }catch(e){
        console.log("Test " + index + " failed");
    }
    ++index;
}

Hope this helps!

Answer 2

// define the list of property keys as a constant string array.
const PropertyKeyNames = ["key1", "key2", "keyN"] as const satisfies readonly string[];
type PropertyKeys = typeof PropertyKeyNames[number];

// create TypeA and TypeB using indexed properties.
type TypeA = {[Property in PropertyKeys]: number;};
type TypeB = {[Property in PropertyKeys]: string;};

// Create a zod schema instance dynamically at runtime.

/**
 * Creates a zod object with PropertyKeyNames as keys, each having a type specified by a zod object
 * @param zobject the zod object for each property, typically z.string()
 * @returns a z.object(...) function call result
 */
const build = (zobject: z.ZodTypeAny): ReturnType<typeof z.object> => {
    const shape: { [k: string]: z.ZodTypeAny } = {};
    for (const key of PropertyKeyNames) {
        shape[key] = zobject;
    }
    return z.object(shape);
};

// The resulting zod object with string type values.
const ZobjectWithString = build(z.string());

Tests :

const TestObjects = [
    {key1: "value1", key2: "value2", keyN: "value3"}, // OK
    {key1: "value1", key2: "value2", keyN: "value3", extraKey:"extra"}, // OK
    {keyN: "value3"}, // failed
    { username: "Ludwig" }, // failed
    undefined
]
let index = 0;
for(const obj of TestObjects){
    try {
        ZobjectWithString.parse(obj);
        console.log("Test " + index + " passed");
    }catch(e){
        console.log("Test " + index + " failed");
    }
    ++index;
}

Hope this helps!

How can you create the "Property within Key of Type" structure using Zod?

Answer №1

Similar questions

Utilize string variables within TypeScript's enumeration feature

The data type 'string' cannot be assigned to the data type 'Position'

Encountering an issue with the property name despite already defining it

Angular framework does not trigger the button click event

Querying subdocuments within an array using MongoDB's aggregation framework

Dealing with requests on an interceptor after receiving a value from an observable in RxJS and Angular: Tips and tricks

Dependency mismatch in main package.json and sub package.json

Can a discriminated union be generated using mapped types in TypeScript?

How can I integrate the jQuery Plugin Mapael with Angular 5?

What is the best way to declare a global TypeScript variable in a definition file to make it accessible for import?

Is there a way to handle null return in case the data is not present?

Is it true that after setting the state in the main app with React/Recoil, it cannot be reset within a component?

Why is typescript-eslint flagging the error "Unsafe call of an any typed value" whenever I try to use the delete or update methods?

Error: The use of await in RequestPromise is not valid

Maximizing Jest's potential with multiple presets in a single configuration file/setup

What is the syntax for declaring a boolean or object type?

The parent component is failing to pass the form values to the child form group in CVA

Create boilerplate code easily in VS Code by using its feature that generates code automatically when creating a

Before proceeding to update in Angular 8, ensure the repository is not dirty. Commit or stash any changes that have been

"Firebase function fails to return Typescript class variable, resulting in 'undefined'