@airtop/json-schema-adapter-zod

Zod JSON Schema Adapter for the Airtop SDK

This schema adapter allows specifying zod objects as input when an Airtop SDK method requires a JSON schema.

Installation

npm install @airtop/sdk @airtop/json-schema-adapter-zod zod

Usage

import { AirtopClient } from "@airtop/sdk";
import { ZodJsonSchemaAdapter } from "@airtop/json-schema-adapter-zod";
import { z } from "zod";

const schema = z.object({
  results: z
    .array(
      z
        .object({
          name: z.string().describe("The name of the product"),
          description: z.string().describe("A brief description of the product's purpose"),
          benefit: z.string().describe("How the product supports developers"),
        })
        .strict(),
    )
    .optional(),
  error: z.string().min(1).describe("Error message in case of failure").optional(),
});

const client = new AirtopClient({
  outputSchemaAdapter: new ZodJsonSchemaAdapter(),
});

await client
  .withSessionId("session-id")
  .withWindowId("window-id")
  .pageQuery("title of the page", {
    configuration: {
      outputSchema: schema,
    }
  })