Packages

The Vovk.ts repository  holds the npm packages, the examples, the performance tests and this documentation.

npm Packages

vovk 

The runtime library: decorators, utilities, types and other code used on the server and on the client. Its only peer dependency is openapi3-ts , for types, and Bundlephobia  reports it as 100% self-composed.

npm install vovk openapi3-ts

pnpm add vovk openapi3-ts

yarn add vovk openapi3-ts

bun add vovk openapi3-ts

vovk-cli 

The CLI. Install it globally or as a dev dependency. It provides the vovk binary.

npm install vovk-cli --save-dev

pnpm add vovk-cli --save-dev

yarn add vovk-cli --dev

bun add vovk-cli --dev

npx vovk-cli <command>

pnpm dlx vovk-cli <command>

yarn dlx vovk-cli <command>

bun x vovk-cli <command>

Or:

npx vovk <command>

vovk-ajv 

Exports validateOnClient, which validates input on the client with the emitted JSON Schema.

npm install vovk-ajv

pnpm add vovk-ajv

yarn add vovk-ajv

bun add vovk-ajv

vovk-python 

Templates and utilities that generate the Python client library.

npm install vovk-python --save-dev

pnpm add vovk-python --save-dev

yarn add vovk-python --dev

bun add vovk-python --dev

vovk-rust 

Templates and utilities that generate the Rust client library.

npm install vovk-rust --save-dev

pnpm add vovk-rust --save-dev

yarn add vovk-rust --dev

bun add vovk-rust --dev

Examples and Other Folders

examples/kitchen-sink 

Examples and proofs of concept, served at examples.vovk.dev . Its client library is published to npm as vovk-examples , and this site uses it.

examples/hello-world 

A minimal Vovk.ts example, served at hello-world.vovk.dev . See the “Hello World” page. Its client library is published as vovk-hello-world on npm , crates.io  and PyPI .

examples/multitenant 

Shows multitenancy with Vovk.ts, served at multitenant.vovk.dev .

perf 

Overhead performance tests for Vovk.ts.

docs 

This documentation, served at vovk.dev .