.pick() mask allowing non-present props when present props are defined

[prescience-data]

Example

// Original schema
const FooSchema = z.object({
  foo: z.string(),
  bar: z.string()
})


const CorrectlyFailingSchema = FooSchema.pick({
  notARealProperty: true // This causes TypeScript error as expected.
})


const IncorrectlyPassingSchema = FooSchema.pick({
  foo: true,
  notARealProperty: true // Once an existing property is added to the mask, any non-defined props can pass as well.
})

This became an issue today where after passing through a bundler (esbuild), a non-descriptive error started throwing on e.t._parse:

TypeError: Cannot read properties of undefined

The issue occurred because I had removed a property "title" from the original schema, but not from the pick() mask, so title._parse() was throwing as title was now undefined.

[noyan-alimov]

Ideally typescript should cause an error.
I implemented to show a helpful error message.
Example schema:

const fish = z.object({
  name: z.string(),
  age: z.number(),
  nested: z.object({}),
});

And then:

fish.pick({ name: true, color: true })

Doing this should show color key does not exist in object schema. Available keys: name,age,nested

[prescience-data]

Additional context:

[scotttrinh]

Ahh, nice find @prescience-data . This is due to how Mask is defined:

zod/src/types.ts

Line 1651 in d2ac69c

pick<Mask extends { [k in keyof T]?: true }>(

That means as long as it extends the shape it passes the type checker. I think there is a way to update this to require that all of the keys are valid keys from T. Feel free to submit a PR for this if you get around to it. Otherwise I'll take a swing at it soon.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.