TypeBridge is a typed application toolkit for TypeDB. A versioned Split-YAML workspace is the schema authority. TypeBridge validates that workspace and generates Python, TypeScript/Node, and Rust bindings that share one Rust-owned schema, query, migration, validation, and ORM engine.
One system, three generated SDKs
| Surface | Generated application API | Distribution |
|---|---|---|
| Python | Value classes, model managers, transactions, direct/remote queries | type-bridge |
| TypeScript / Node | Branded values, model managers, native and remote queries | @type-bridge/node |
| Rust | Schema-bound create/model types, async CRUD and immutable queries | type-bridge |
| CLI | Split-YAML checks, migrations, and all three projections | Included with the Python package |
| Server | Remote V2 query execution over the same generated contract | ghcr.io/ds1sqe/type-bridge-server |
TypeBridge preserves TypeDB concepts directly: independent attributes, entities, relations, roles, inheritance, cardinality, ordering, keys, and uniqueness remain typed from schema through hydrated results.
Start from Split-YAML
Install the CLI and Python runtime:
pip install type-bridge
Create typebridge.yaml, a schema-set manifest, and one or more schema
fragments. Configure the generated package output in the workspace, then run:
type-bridge --manifest typebridge.yaml schema check
type-bridge --manifest typebridge.yaml schema generate
type-bridge --manifest typebridge.yaml migration make --name initial
type-bridge --manifest typebridge.yaml migration apply --environment development
One generation snapshot writes every configured Python, TypeScript, and Rust
package. Generated packages privately embed the verified authority used by
their managers and direct or remote queries, so ordinary applications never
configure or read an external authority JSON. A workspace deploying the optional
generic server can additionally configure artifacts.schema-authority.output;
the server mounts that generated, source-free artifact instead of compiling
YAML or accepting a user-maintained JSON schema.
The generated Python package owns the concise single-type manager:
from app_models import Age, Person, PersonId
from type_bridge import Database
db = Database(address="localhost:1729", database="example")
db.connect()
ada = Person(person_id=PersonId("ada"), age=Age(36))
Person.manager(db).put(ada)
people = Person.manager(db).filter(age__gte=18).all()
Use its package-local query session when a query spans types:
session = Person.query(db)
person = session.exact(Person)
adults = (
session.query(person)
.where(person.field(Person.age).gte(Age(18)))
.rows(limit=100)
)
Continue with the Python quick start, Split-YAML reference, and data guide.
TypeScript / Node
npm install @type-bridge/node
Import application values from the generated package and connection primitives
from @type-bridge/node:
import { RustDatabase } from "@type-bridge/node";
import { Age, Person, PersonId } from "./generated/models/index.js";
const db = RustDatabase.connect("localhost:1729", "example", {
username: "admin",
password: "password",
});
const ada = Person.create({
personId: PersonId.create("ada"),
age: Age.create(36n),
});
Person.manager(db).put(ada);
const people = Person.manager(db).filter({ age__gte: Age.create(18n) }).all();
See the TypeScript/Node guide for generated managers, transactions, and direct/remote queries.
Rust
The same workspace emits a schema-bound Rust crate. The generated SDK uses
Rust 1.88+ and the crates.io type-bridge runtime:
[dependencies]
type-bridge = "2"
Follow the Rust client guide for generation, direct execution, transactions, and remote queries.
Documentation
- Install a surface
- Model data in Split-YAML
- Read and write generated models
- Manage schemas and migrations
- Run the query server
- Browse the Cargo package index
- Compatibility and removals
Development
PYO3_USE_ABI3_FORWARD_COMPATIBILITY=1 uv sync --extra dev
uv run pytest
./test.sh
./scripts/check.sh all
uv run --extra docs mkdocs build --strict
See DEVELOPMENT.md for repository boundaries and verification.
License
TypeBridge-authored code is MIT licensed. Native artifacts also include third-party TypeDB components under Apache-2.0 and MPL-2.0; exact notices ship with each artifact.
1 maintainer
Metadata
1 maintainer
Release files for type-bridge 2.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| type_bridge-2.1.0.tar.gz | 193.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| type_bridge-2.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 440.8 kB
Release files / type_bridge-2.1.0.tar.gz
| Download URL | type_bridge-2.1.0.tar.gz |
|---|---|
| Size | 193.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1fc28fb8b80a97f036e158f8bb60ecf365f85f08529c527f242addd490f091ca
|
|
BLAKE2b-256 checksum How to use checksums |
6bd3be10989db4a53c161e7c991bb28a929ea3fb96fb45adbf58873529123f5d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 8, 2026.
Transparency logRelease files / type_bridge-2.1.0-py3-none-any.whl
| Download URL | type_bridge-2.1.0-py3-none-any.whl |
|---|---|
| Size | 247.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8662daa6d23aad33b6338c16e8c1beef5d8109d0e714a807c430b6f65ce28889
|
|
BLAKE2b-256 checksum How to use checksums |
b537735021480299a9bf36a38c1c17f6856b0fb6070da832ff2a0f9949fae2b4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 8, 2026.
Transparency log
