Skip to content

README.md

Latest commit

 

History

History
45 lines (35 loc) · 1.98 KB

README.md

File metadata and controls

45 lines (35 loc) · 1.98 KB
Raw

Generate and call TypeScript clients

The checked-in todolist.ts and ledger.ts import generated clients. Generated output lives in the test's temporary directory, not in this repository. They call actual HTTP endpoints, check CRUD, first-write-wins retries, typed ID arrays and integer balances, and delete their own SDK test records.

Verified inputs:

  • openapi-nexus 0.2.3, downloaded from its GitHub release
  • Node.js 24.15.0 and TypeScript 6.0.3

Download the pinned release binary, not the generator source. The shared CI/local Justfile recipe downloads and extracts the Linux x86_64 musl archive. It requires Just 1.58.0, Bash, curl, tar and xz. Install TypeScript in a disposable tools directory or use an existing matching installation; put its tsc on PATH.

SQLREST_TOOLS=$(mktemp -d)
just download-openapi-nexus "$SQLREST_TOOLS/openapi-nexus"
cargo build --locked
OPENAPI_NEXUS_BIN="$SQLREST_TOOLS/openapi-nexus/openapi-nexus" \
  python3 scripts/e2e.py --sdk

For PostgreSQL, also set SQLREST_TEST_POSTGRES to a fresh disposable empty database URL and add --backend postgres. These runs publish the examples, fetch their live OpenAPI, generate, strictly compile, then execute both clients:

openapi-nexus generate -i openapi.json -o sdk --generators typescript-fetch

Compilation targets ES2022/CommonJS in a separate output directory; the generated package metadata does not leak ESM semantics into that runnable fixture. Production applications can use their own bundler/module configuration.

The examples pass an explicit Configuration({basePath}) at runtime. In a real site use the runtime's authorized proxy mount, not an exposed management endpoint or database connection string. The generator is optional and is not linked into SQLRest or required to serve requests.

The existing sdk_contract test separately verifies recursive schema retention and strict compile-time errors. No SDK recursion or primitive-field capability is trimmed to simplify these examples.