API Documentation

import { ZodForgeClient } from '@zodforge/cloud';

const client = new ZodForgeClient({
  apiKey: 'zf_your_api_key_here'
});

const result = await client.refineSchema({
  schema: {
    code: 'z.object({ email: z.string() })',
    typeName: 'User',
    fields: { email: 'z.string()' }
  },
  samples: [
    { email: 'user@example.com' },
    { email: 'Admin@TEST.org' }
  ]
});

console.log(result.refinedSchema.code);
// z.object({ email: z.string().email().toLowerCase().trim() })

import { refineSchema, setApiKey } from '@zodforge/cloud';

// Set API key globally
setApiKey('zf_your_api_key_here');

const result = await refineSchema({
  schema: {
    code: 'z.object({ price: z.number(), currency: z.string() })',
    typeName: 'Product',
    fields: { price: 'z.number()', currency: 'z.string()' }
  },
  samples: [
    { price: 100, currency: 'USD' },
    { price: 50, currency: 'EUR' }
  ]
});

// Check semantic relationships (Context Reasoning)
console.log(result.refinedSchema.relationships);
// [{
//   fields: ['price', 'currency'],
//   pattern: 'monetary_value',
//   suggestion: 'Consider creating a Money type...',
//   confidence: 0.92
// }]

// AI automatically detects lat+lng relationship
const result = await client.refineSchema({
  schema: {
    code: 'z.object({ lat: z.number(), lng: z.number() })',
    typeName: 'Location',
    fields: { lat: 'z.number()', lng: 'z.number()' }
  },
  samples: [
    { lat: 51.5074, lng: -0.1278 },  // London
    { lat: 40.7128, lng: -74.0060 }  // New York
  ]
});

// Check detected relationships
result.refinedSchema.relationships.forEach(rel => {
  console.log(`Pattern: ${rel.pattern}`);       // "geolocation"
  console.log(`Confidence: ${rel.confidence}`);   // 0.95
  console.log(`Suggestion: ${rel.suggestion}`);
});

result.refinedSchema.improvements.forEach(imp => {
  console.log(`Field: ${imp.field}`);
  console.log(`Source: ${imp.sourceSnippet}`);      // Actual sample data
  console.log(`Pattern: ${imp.detectedPattern}`);   // e.g., "email_format"
  console.log(`Rule: ${imp.ruleApplied}`);          // e.g., "RFC5322_email"
  console.log(`Change: ${imp.before} → ${imp.after}`);
});

// First call: ~9 seconds (AI processing)
const result1 = await client.refineSchema(request);
console.log(result1.processingTime);  // ~9000ms

// Second identical call: <1ms (cached)
const result2 = await client.refineSchema(request);
console.log(result2.cached);          // true
console.log(result2.processingTime);  // <1ms