Documentation

TypeScript

Develop OpenPlait from the typescript/ workspace, with Python counterparts in tabs.

TypeScript

The reference implementation lives under typescript/ (npm workspaces), parallel to python/.

typescript/
  package.json
  packages/
    core/                 → @openplait/core
    adapter-sdk/          → @openplait/adapter-sdk
    adapter-clickhouse/   → @openplait/adapter-clickhouse
    adapter-tempo/        → @openplait/adapter-tempo
    adapter-loki/         → @openplait/adapter-loki
    adapter-prometheus/   → @openplait/adapter-prometheus
    adapter-jaeger/       → @openplait/adapter-jaeger
    runtime/              → @openplait/runtime
    perses/               → @openplait/perses

Develop from source

cd typescript
npm install
npm run check
npm run build

From the repo root:

npm run check:js
npm run build:js

Install published packages

npm install @openplait/core @openplait/adapter-sdk \
  @openplait/runtime @openplait/adapter-clickhouse

Continue with Getting started for registry + query examples (TypeScript and Python in tabs).

Release

cd typescript
VERSION=$(node -p "require('./packages/core/package.json').version")
git tag "ts-"
git push origin "ts-"

Workflow uses working-directory: typescript.

See PUBLISHING.md.