@tarangdb/generator

TarangDB JSON schema to JavaScript/TypeScript code generator.

This package is primarily used by @tarangdb/cli, but can be used directly by tools that already have a Tarang schema response.

Install

npm install @tarangdb/generator

Usage

import { generateJavaScript, generateTypeScript } from "@tarangdb/generator";

const source = await fetch("https://api.tarangdb.com/v1/projects/{projectId}/schema", {
  headers: {
    Authorization: `Bearer ${process.env.TARANG_API_KEY}`,
  },
});

const schema = await source.json();
const tsCode = generateTypeScript(schema);
const jsCode = generateJavaScript(schema);

Generated TypeScript output includes:

• row, insert, and update interfaces per table
• TarangSchema registry for TarangClient<TarangSchema>
• tarangSchemaMetadata with table and column mappings
• ready-to-use typed tarang client that loads .env with dotenv/config

Generated JavaScript output includes:

• tarangSchemaMetadata with table and column mappings
• ready-to-use tarang client

Use generateJavaScript(schema, { module: "esm" }) to emit ESM JavaScript instead of CommonJS.

Status

This is an alpha release. The schema contract is versioned by schemaVersion.