Z
Zod•2d ago
Maxiviper117

Maxiviper117 - I'm working on validating an obj...

I'm working on validating an object where: - Some property keys are known and expected. - Other extra/unknown keys are allowed only if they follow a specific pattern. Pattern for extra keys: Keys should match the format:
metafield.<namespace>.<key>
Where: - namespace and key can contain alphanumeric characters, underscores, or hyphens. Here's the regex I'm using: 
const regex = /^metafield\.[a-zA-Z0-9_-]+\.[a-zA-Z0-9_-]+$/;
const regex = /^metafield\.[a-zA-Z0-9_-]+\.[a-zA-Z0-9_-]+$/;
Example payload: 
{
    "knownkey": "value",
    "metafield.test.key": "value",
    "metafield.test.key2": "value",
    "metafield.test.key3": "value",
    "metafield.test.key4": "value"
}
{
    "knownkey": "value",
    "metafield.test.key": "value",
    "metafield.test.key2": "value",
    "metafield.test.key3": "value",
    "metafield.test.key4": "value"
}
Question: How can I define a Zod type that allows: - Some known, explicitly typed keys. - And any number of extra keys that match the regex pattern above?
Solution:
If you wish to get more type safety, here is something: https://tsplay.dev/N5oVdW
TS Playground - An online editor for exploring TypeScript and JavaS...
The Playground lets you write TypeScript or JavaScript online in a safe and sharable way.
Jump to solution
4 Replies
Sikari
Sikari•2d ago
You would intersect your known object with the "unknown" record just like in pure types. Here's a playground for one of the implementations: https://tsplay.dev/ND9Ajm
TS Playground - An online editor for exploring TypeScript and JavaS...
The Playground lets you write TypeScript or JavaScript online in a safe and sharable way.
Solution
Sikari
Sikari•2d ago
If you wish to get more type safety, here is something: https://tsplay.dev/N5oVdW
TS Playground - An online editor for exploring TypeScript and JavaS...
The Playground lets you write TypeScript or JavaScript online in a safe and sharable way.
Maxiviper117
Maxiviper117OP•2d ago
@Sikari Thanks Added this to superRefine(): 
delete obj["knownKey"];
delete obj["knownKey"];
To exclude known keys from being checked against the regex.
Sikari
Sikari•2d ago
You might be able to swap the order of the schemas in the intersection, not sure if that would work. Alternatively, you could extract the known schema to a variable and exclude that way: 
const knownKeysSchema = z.object({
  knownKey: z.string(),
});

const schema = z.intersection(
  z
    .record(z.string())
    .superRefine((obj, ctx): obj is ObjectWithMetaFields => {
      const keys = Object.keys(obj).filter((x) => !(x in knownKeysSchema.shape));
      const invalidKeys = keys.filter((x) => metaFieldRegex.test(x) === false);

      if (invalidKeys.length > 0) {
        ctx.addIssue({
          fatal: true,
          code: "unrecognized_keys",
          keys: invalidKeys,
          message: `Meta fields must match the regex: ${metaFieldRegex.source}`,
        });
      }

      return z.NEVER;
  }),
  z.object({
    knownKey: z.string(),
  }),
);
const knownKeysSchema = z.object({
  knownKey: z.string(),
});

const schema = z.intersection(
  z
    .record(z.string())
    .superRefine((obj, ctx): obj is ObjectWithMetaFields => {
      const keys = Object.keys(obj).filter((x) => !(x in knownKeysSchema.shape));
      const invalidKeys = keys.filter((x) => metaFieldRegex.test(x) === false);

      if (invalidKeys.length > 0) {
        ctx.addIssue({
          fatal: true,
          code: "unrecognized_keys",
          keys: invalidKeys,
          message: `Meta fields must match the regex: ${metaFieldRegex.source}`,
        });
      }

      return z.NEVER;
  }),
  z.object({
    knownKey: z.string(),
  }),
);
Anyways, I hope that helps!

Did you find this page helpful?