Documentation article

API and package reference

Use the reference layer to choose the right package surface before diving into implementation details.

Reference6 min

The toolkit surface is easier to adopt when the public packages, core entry points, and expected responsibilities are named consistently in one place.

This page is not a generated API dump. It is the practical orientation layer that helps you find the right package or surface before you read implementation details in the repository.

Audience
Integrators
Difficulty
Intermediate
Last updated
July 28, 2026
Quick start
Start from the product-level entry point before choosing package-level integration details.
Toolkit repository
Inspect the repository, releases, and package layout directly.

Choose the right surface first

There are three surfaces to keep separate: the web product, the published toolkit packages, and the internal module graph that supports them.

Most consumers should start by deciding whether they need a browser workflow, a package integration, or a deeper contribution path. That decision narrows the relevant surface much faster than reading source folders top to bottom.

Map the package responsibilities

These layers are related, but they should not be documented as though they are the same entry point for every user.

  • Use the web app when you want guided exploration and fast validation.
  • Use published packages when you are embedding transformations in another system.
  • Use repository internals only when you are extending parsers, generators, or shared analysis layers.

Keep orchestration visible

The exact names may evolve with published releases, but the reference layer should always explain which package owns orchestration, which package parses, and which package renders a target format.

A typical integration seam

ts
import { transformSchema } from "@aio/sdk";
import { parseTypeScript } from "@aio/parser-typescript";
import { generateJsonSchema } from "@aio/generator-json-schema";

const parsed = parseTypeScript(sourceText);
const result = transformSchema({
  generator: generateJsonSchema,
  parsed,
});