zmdbzero-maintenance data layer
Docs Benchmarks Anti-patterns OpenAPI
Docs / Reference

Package referenceTODO

🚧 TODO — not yet implemented. This capability is on the roadmap and is not an anti-pattern for zmdb; it simply isn't built yet. catalog contract frozen; generated package rows and the verified one-product documentation journey are pending Track / contribute via the issue tracker.

Package reference

📝 Note

The section below is generated from the read-only product catalog and current package manifests. build:docs refreshes it.

zmdb is installed as one product; use the manifest-derived command in the generated table below.

The root and @zmdb/core/* subpaths are the application-facing contract. Individual @zmdb/* packages are advanced dependency firebreaks for consumers that deliberately need one concern without the complete product; they are not steps in the beginner setup.

The generated reference contains one row per official product-catalog entry. The catalog supplies product role, optionality, facade exposure, documentation ownership and external proof. Each package manifest supplies:

Optional drivers, frontend adapters, transports, brokers, telemetry providers, and similar technologies appear only when selected. Importing @zmdb/core must not load them.

<!-- generated: product-catalog package-reference -->

PackageVersionRelease unitSupportRoleInstall modeInstallationDescriptionDocumentation
@zmdb/ai1.0.0-beta.2integrationsupportedaiintegration: provider-neutral AI tools and provider adaptersyarn add @zmdb/ai@1.0.0-beta.2 @zmdb/schema@1.0.0-beta.2 @zmdb/validator@1.0.0-beta.2Provider-neutral AI tool documents, bounded chat orchestration, shared tool invocation, OpenAPI-derived tools, and optional Anthropic, LangChain, and Vercel AI SDK adapters for zmdb.llm-function-calling
@zmdb/app1.0.0-beta.2coresupportedapprequiredyarn add @zmdb/core@1.0.0-beta.2Protocol-neutral application kernel for zmdb: Stage-3 metadata, dependency injection, modules, lifecycle, messaging, commands, events, CQRS, state, health, observability, and an optional OpenTelemetry adapter.web-app
@zmdb/cli1.0.0-beta.2toolingsupportedclitoolingyarn add --dev @zmdb/cli@1.0.0-beta.2The zmdb executable and developer command APIs for schema, application and HTTP workflows.cli-overview
@zmdb/client1.0.0-beta.2integrationprovisionalclientintegration: generated HTTP clients and framework bindingsyarn add @zmdb/client@1.0.0-beta.2HTTP client runtime for generated and manually declared zmdb operations, with optional Angular, React, React Native, Solid, Svelte, and Vue bindings.generated-client
@zmdb/cockroach1.0.0-beta.2integrationsupportedcockroachintegration: CockroachDByarn add @zmdb/cockroach@1.0.0-beta.2 @zmdb/orm@1.0.0-beta.2 @zmdb/sql@1.0.0-beta.2CockroachDB vertical for zmdb: PostgreSQL-family dialect overrides, migrations, catalog introspection, retries, and a pg-protocol driver.dialect-cockroach
@zmdb/compiler1.0.0-beta.2toolingsupportedcompilertoolingyarn add --dev @zmdb/compiler@1.0.0-beta.2The single TypeScript front end for zmdb reflection, AOT emission, code generation, build adapters, lint rules, and project configuration.aot-setup
@zmdb/core1.0.0-beta.2coresupportedproductrequiredyarn add @zmdb/core@1.0.0-beta.2The cohesive zmdb product: schema, SQL, validation, typed ORM, repositories, application kernel, HTTP, migrations, configuration, CLI, and tooling from one install.package-reference
@zmdb/jobs1.0.0-beta.2coresupportedjobscapability: jobsyarn add @zmdb/jobs@1.0.0-beta.2Portable typed queues, workers, scheduling, leases, and application lifecycle integration.web-queues
@zmdb/jobs-postgres1.0.0-beta.2integrationsupportedjobs-postgresprovider: jobs / PostgreSQLyarn add @zmdb/jobs-postgres@1.0.0-beta.2 @zmdb/jobs@1.0.0-beta.2 pg@^8.23.0node-postgres JobStore adapter for caller-owned PostgreSQL pools and clients.web-queues
@zmdb/jobs-sqlite1.0.0-beta.2integrationsupportedjobs-sqliteprovider: jobs / SQLiteyarn add @zmdb/jobs-sqlite@1.0.0-beta.2 @zmdb/jobs@1.0.0-beta.2Explicit SQLite persistence and owned memory storage for portable zmdb jobs.web-queues
@zmdb/mcp1.0.0-beta.2integrationprovisionalmcpintegration: Model Context Protocolyarn add @zmdb/mcp@1.0.0-beta.2Transport-neutral MCP client and server cores with validated tool dispatch, authenticated identity, and bounded remote calls.llm-mcp
@zmdb/migrations1.0.0-beta.2toolingsupportedmigrationstoolingyarn add --dev @zmdb/migrations@1.0.0-beta.2Schema snapshots, deterministic migration plans, ledger runners, embedded execution, catalog introspection, and declaration emission for zmdb.migrations
@zmdb/mssql1.0.0-beta.2integrationsupportedmssqlintegration: SQL Serveryarn add @zmdb/mssql@1.0.0-beta.2 @zmdb/orm@1.0.0-beta.2 @zmdb/sql@1.0.0-beta.2Complete SQL Server vertical for zmdb: T-SQL compilation, migrations, structural node-mssql execution, catalog introspection, and capability metadata.dialect-mssql
@zmdb/mysql1.0.0-beta.2integrationsupportedmysqlintegration: MySQLyarn add @zmdb/mysql@1.0.0-beta.2 @zmdb/orm@1.0.0-beta.2 @zmdb/sql@1.0.0-beta.2Complete MySQL compiler, migrations, introspection, and structural mysql2 driver vertical for zmdb.dialect-mysql
@zmdb/next1.0.0-beta.2integrationprovisionalnextintegration: Next.jsyarn add @zmdb/next@1.0.0-beta.2 'next@>=16.3.4 <17.0.0' 'react@>=19.2.8 <20.0.0' 'react-dom@>=19.2.8 <20.0.0'Request-scoped Next.js server clients and React browser bindings for generated zmdb clients.client-next
@zmdb/nuxt1.0.0-beta.2integrationprovisionalnuxtintegration: Nuxt 4yarn add @zmdb/nuxt@1.0.0-beta.2 'nuxt@>=4.5.2 <5.0.0' 'vue@>=3.5.42 <4.0.0'Nuxt module, request-scoped Nitro transport, Vue bindings, and native hydration for generated zmdb clients.client-nuxt
@zmdb/orm1.0.0-beta.2coresupportedormrequiredyarn add @zmdb/core@1.0.0-beta.2Auto-validating CRUD repository over a zmdb schema: transactions, populate, read-replicas, lifecycle events, and seeding. No proxies, no identity map.repository
@zmdb/postgres1.0.0-beta.2integrationsupportedpostgresintegration: PostgreSQLyarn add @zmdb/postgres@1.0.0-beta.2 @zmdb/orm@1.0.0-beta.2 @zmdb/sql@1.0.0-beta.2The complete PostgreSQL vertical for zmdb: dialect, migrations, catalog introspection, node-postgres driver, cursors, and cancellation.dialect-postgres
@zmdb/protobuf1.0.0-beta.2integrationsupportedprotobufintegration: Protocol Buffersyarn add @zmdb/protobuf@1.0.0-beta.2Zero-dependency protobuf calls, typed gRPC service artifacts, and the wire runtime targeted by zmdb's ahead-of-time compiler.protobuf-message
@zmdb/schema1.0.0-beta.2coresupportedschemarequiredyarn add @zmdb/core@1.0.0-beta.2Schema DSL + compile-time type derivation (Entity/Create/Update/read DTOs), relations, OpenAPI, and custom types — the single source of truth for a zmdb data layer.schema-declaration
@zmdb/singlestore1.0.0-beta.2integrationsupportedsinglestoreintegration: SingleStoreyarn add @zmdb/singlestore@1.0.0-beta.2 @zmdb/orm@1.0.0-beta.2 @zmdb/sql@1.0.0-beta.2SingleStore vertical for zmdb: MySQL-family compilation, storage-aware migrations, catalog introspection, and mysql2 driver binding.dialect-singlestore
@zmdb/sql1.0.0-beta.2coresupportedsqlrequiredyarn add @zmdb/core@1.0.0-beta.2SQL-first, dialect-aware query compiler with reads, writes, joins, aggregates, full-text search, set operations, and schema-object DDL.raw-sql
@zmdb/sqlite1.0.0-beta.2integrationsupportedsqliteintegration: SQLiteyarn add @zmdb/sqlite@1.0.0-beta.2 @zmdb/orm@1.0.0-beta.2 @zmdb/sql@1.0.0-beta.2Complete SQLite vertical for zmdb: SQL dialect, migrations, introspection, embedded migrations, and a node:sqlite driver with no third-party database client.dialect-sqlite
@zmdb/sveltekit1.0.0-beta.2integrationprovisionalsveltekitintegration: SvelteKityarn add @zmdb/sveltekit@1.0.0-beta.2 '@sveltejs/kit@>=2.70.3 <3.0.0' 'svelte@>=5.57.0 <6.0.0'Request-local SvelteKit clients, typed load helpers, explicit credential forwarding, and navigation cancellation for generated zmdb clients.client-sveltekit
@zmdb/transport1.0.0-beta.2integrationprovisionaltransportintegration: gRPC and broker transportsyarn add @zmdb/transport@1.0.0-beta.2 @zmdb/app@1.0.0-beta.2gRPC, Kafka, NATS, RabbitMQ, Redis, and SQS transport adapters for the protocol-neutral zmdb application messaging contract.web-microservices-transports
@zmdb/validator1.0.0-beta.2coresupportedvalidatorrequiredyarn add @zmdb/core@1.0.0-beta.2Runtime helpers for ahead-of-time validation and JSON serialization: is/assert/validate/equals/random, unions, transforms, and generated-code errors.aot-setup
@zmdb/web1.0.0-beta.2coresupportedwebrequiredyarn add @zmdb/core@1.0.0-beta.2HTTP framework for the zmdb application kernel: Stage-3 controllers, typed request context, middleware, OpenAPI, gateways, testing, and runtime adapters.web-overview

@zmdb/ai#

Provider-neutral AI tool documents, bounded chat orchestration, shared tool invocation, OpenAPI-derived tools, and optional Anthropic, LangChain, and Vercel AI SDK adapters for zmdb.

@zmdb/app#

Protocol-neutral application kernel for zmdb: Stage-3 metadata, dependency injection, modules, lifecycle, messaging, commands, events, CQRS, state, health, observability, and an optional OpenTelemetry adapter.

@zmdb/cli#

The zmdb executable and developer command APIs for schema, application and HTTP workflows.

@zmdb/client#

HTTP client runtime for generated and manually declared zmdb operations, with optional Angular, React, React Native, Solid, Svelte, and Vue bindings.

@zmdb/cockroach#

CockroachDB vertical for zmdb: PostgreSQL-family dialect overrides, migrations, catalog introspection, retries, and a pg-protocol driver.

@zmdb/compiler#

The single TypeScript front end for zmdb reflection, AOT emission, code generation, build adapters, lint rules, and project configuration.

@zmdb/core#

The cohesive zmdb product: schema, SQL, validation, typed ORM, repositories, application kernel, HTTP, migrations, configuration, CLI, and tooling from one install.

@zmdb/jobs#

Portable typed queues, workers, scheduling, leases, and application lifecycle integration.

@zmdb/jobs-postgres#

node-postgres JobStore adapter for caller-owned PostgreSQL pools and clients.

@zmdb/jobs-sqlite#

Explicit SQLite persistence and owned memory storage for portable zmdb jobs.

@zmdb/mcp#

Transport-neutral MCP client and server cores with validated tool dispatch, authenticated identity, and bounded remote calls.

@zmdb/migrations#

Schema snapshots, deterministic migration plans, ledger runners, embedded execution, catalog introspection, and declaration emission for zmdb.

@zmdb/mssql#

Complete SQL Server vertical for zmdb: T-SQL compilation, migrations, structural node-mssql execution, catalog introspection, and capability metadata.

@zmdb/mysql#

Complete MySQL compiler, migrations, introspection, and structural mysql2 driver vertical for zmdb.

@zmdb/next#

Request-scoped Next.js server clients and React browser bindings for generated zmdb clients.

@zmdb/nuxt#

Nuxt module, request-scoped Nitro transport, Vue bindings, and native hydration for generated zmdb clients.

@zmdb/orm#

Auto-validating CRUD repository over a zmdb schema: transactions, populate, read-replicas, lifecycle events, and seeding. No proxies, no identity map.

@zmdb/postgres#

The complete PostgreSQL vertical for zmdb: dialect, migrations, catalog introspection, node-postgres driver, cursors, and cancellation.

@zmdb/protobuf#

Zero-dependency protobuf calls, typed gRPC service artifacts, and the wire runtime targeted by zmdb's ahead-of-time compiler.

@zmdb/schema#

Schema DSL + compile-time type derivation (Entity/Create/Update/read DTOs), relations, OpenAPI, and custom types — the single source of truth for a zmdb data layer.

@zmdb/singlestore#

SingleStore vertical for zmdb: MySQL-family compilation, storage-aware migrations, catalog introspection, and mysql2 driver binding.

@zmdb/sql#

SQL-first, dialect-aware query compiler with reads, writes, joins, aggregates, full-text search, set operations, and schema-object DDL.

@zmdb/sqlite#

Complete SQLite vertical for zmdb: SQL dialect, migrations, introspection, embedded migrations, and a node:sqlite driver with no third-party database client.

@zmdb/sveltekit#

Request-local SvelteKit clients, typed load helpers, explicit credential forwarding, and navigation cancellation for generated zmdb clients.

@zmdb/transport#

gRPC, Kafka, NATS, RabbitMQ, Redis, and SQS transport adapters for the protocol-neutral zmdb application messaging contract.

@zmdb/validator#

Runtime helpers for ahead-of-time validation and JSON serialization: is/assert/validate/equals/random, unions, transforms, and generated-code errors.

@zmdb/web#

HTTP framework for the zmdb application kernel: Stage-3 controllers, typed request context, middleware, OpenAPI, gateways, testing, and runtime adapters.

<!-- /generated: product-catalog package-reference -->

Release versions, changelog entries, npm tags, and publish order are not product catalog fields. The release model combines this catalog membership with architecture-policy edges, package manifests and the root changelog. See the architecture guide for the generated graph and atomic package-admission workflow; the repository's PUBLISHING.md carries the complete changelog, bump, dry-run, exact-tag, and retry procedure.