Zod Schema Proxy

Zod Aide lets you add methods to your Zod schemas by using the zodSchemaProxy function. Here’s a sample usage:

import { z } from "https://deno.land/x/zod@v3.21.4/mod.ts";
import * as ta from "https://deno.land/std@0.191.0/testing/asserts.ts";
import * as za from "https://raw.githubusercontent.com/netspective-labs/sql-aide/vX.Y.Z/lib/universal/zod-aide.ts";

// define a Zod schema
const syntheticSchema = z.object({
  text: z.string(),
  url: z.string().url(),
  number: z.number(),
});

// add methods to Zod schema using zodSchemaProxy
const proxiedSchema = za.zodSchemaProxy(syntheticSchema, {
  isText: (synthetic, value: string) => {
    return synthetic.text === value;
  },
  isNumberInRange: (synthetic) => {
    return synthetic.number >= 10 && synthetic.number <= 100;
  },
  aliasForText() {
    return this.text;
  },
});

// parse a value using the proxied schema
const parsedSynthetic = proxiedSchema.parse({
  text: "Sample text",
  url: "https://github.com/shah",
  number: 52,
});

ta.assert(parsedSynthetic.isText("Sample text")); // use added method

console.log("Parsed synthetic:", parsedSynthetic);
console.log("isText method output:", parsedSynthetic.isText("Sample text"));
console.log(
  "isNumberInRange method output:",
  parsedSynthetic.isNumberInRange(),
);
console.log("aliasForText method output:", parsedSynthetic.aliasForText());

In the above example, The syntheticSchema is defined as a Zod schema representing an object with text (a string), url (a URL conformant string), and number (a number). The zodSchemaProxy function is then used to create proxiedSchema, which is a proxied version of the syntheticSchema with additional methods(isText, isNumberInRange, aliasForText). Finally, an object is parsed using the proxiedSchema. This parsed object can then be interacted with using the extra methods, such as isText, which verifies if the text field of the object matches a specific string.

deno run ./examples/getting-started/07-zod-schema-proxy.sqla.ts

Produces:

Parsed synthetic: { text: 'Sample text', url: 'https://github.com/shah', number: 52 }
isText method output: true
isNumberInRange method output: true
aliasForText method output: 'Sample text'