doc: update orm package name#501

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ymc9 merged 7 commits into from
Nov 1, 2025
Merged

doc: update orm package name #501

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e1f4907
doc: v3 query as a service
ymc9 Oct 31, 2025
9d563df
fix doc errors
ymc9 Oct 31, 2025
eae2590
addressing PR comments
ymc9 Oct 31, 2025
c459453
add server adapter sample
ymc9 Nov 1, 2025
65e68f8
update submodules
ymc9 Nov 1, 2025
70690f2
docs: update orm package name
ymc9 Nov 1, 2025
d3c7551
Merge remote-tracking branch 'origin/main' into docs/qaas-v3
ymc9 Nov 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions versioned_docs/version-3.x/migrate-prisma.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,7 @@ ZenStack v3 doesn't depend on Prisma at runtime. Its CLI has a peer dependency o
- Remove `prisma` and `@prisma/client` from your project dependencies.
- Install ZenStack packages

<PackageInstall dependencies={['@zenstackhq/runtime@next']} devDependencies={['@zenstackhq/cli@next']} />
<PackageInstall dependencies={['@zenstackhq/orm@next']} devDependencies={['@zenstackhq/cli@next']} />

- Install a database driver

Expand DownExpand Up@@ -87,7 +87,7 @@ Replace `new PrismaClient()` with `new ZenStackClient(schema, ...)` where `schem
<TabItem value="postgres" label={`PostgreSQL`}>

```ts title='db.ts'
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { schema } from './zenstack/schema';
import { PostgresDialect } from 'kysely';
import { Pool } from 'pg';
Expand All@@ -105,7 +105,7 @@ export const db = new ZenStackClient(schema, {
<TabItem value="sqlite" label={`SQLite`}>

```ts title='db.ts'
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { SqliteDialect } from 'kysely';
import SQLite from 'better-sqlite3';
import { schema } from './zenstack/schema';
Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-3.x/orm/access-control/query.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ After defining access control policies in ZModel, it's time to enjoy their benef
Similar to the schema side, access control's runtime aspect is encapsulated in the `@zenstackhq/plugin-policy` package too, as a Runtime Plugin (more about this topic [later](../plugins/index.md)). You should install it on the raw ORM client to get a new client instance with access control enforcement.

```ts
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { PolicyPlugin } from '@zenstackhq/plugin-policy';

// create an unprotected, "raw" ORM client
Expand Down
6 changes: 3 additions & 3 deletions versioned_docs/version-3.x/orm/client.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ The samples below only show creating a client using SQLite (via [better-sqlite3]
<PackageInstall dependencies={["better-sqlite3"]} devDependencies={['@types/better-sqlite3']} />

```ts title='db.ts'
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { SqliteDialect } from 'kysely';
import SQLite from 'better-sqlite3';
import { schema } from './zenstack/schema';
Expand All@@ -43,7 +43,7 @@ export const db = new ZenStackClient(schema, {
<PackageInstall dependencies={["pg"]} devDependencies={['@types/pg']} />

```ts title='db.ts'
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { schema } from './zenstack/schema';
import { PostgresDialect } from 'kysely';
import { Pool } from 'pg';
Expand All@@ -63,7 +63,7 @@ export const db = new ZenStackClient(schema, {
The created `db` object has the full ORM API inferred from the type of the `schema` parameter. When necessary, you can also explicitly get the inferred client type like:

```ts
import type { ClientContract } from '@zenstackhq/runtime';
import type { ClientContract } from '@zenstackhq/orm';
import type { SchemaType } from '@/zenstack/schema';

export type DbClient = ClientContract<SchemaType>;
Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-3.x/orm/errors.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ description: ORM Errors

# Errors

The ORM uses the following error classes from `@zenstackhq/runtime` to represent different types of failures:
The ORM uses the following error classes from `@zenstackhq/orm` to represent different types of failures:

## `InputValidationError`

Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-3.x/orm/inferred-types.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ Most of the time, you don't need to explicitly type the input and output of the

- `ModelResult`

The `ModelResult` generic type from `@zenstackhq/runtime` allows you to infer the exact model type given field selection and relation inclusion information.
The `ModelResult` generic type from `@zenstackhq/orm` allows you to infer the exact model type given field selection and relation inclusion information.

## Samples

Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-3.x/orm/quick-start.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,7 @@ You can also always configure a project manually with the following steps:

1. Install dependencies

<PackageInstall devDependencies={['@zenstackhq/cli@next']} dependencies={['@zenstackhq/runtime@next']} />
<PackageInstall devDependencies={['@zenstackhq/cli@next']} dependencies={['@zenstackhq/orm@next']} />

2. Create a `zenstack/schema.zmodel` file

Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-3.x/reference/api.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ sidebar_label: API

# API Reference

## `@zenstackhq/runtime`
## `@zenstackhq/orm`

### `class ZenStackClient`

Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-3.x/reference/plugins/policy.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -146,7 +146,7 @@ The following functions can be used in policy conditions:
The plugin exports a runtime plugin `PolicyPlugin` that can be installed on the ORM client to enable access control enforcement.

```ts
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { PolicyPlugin } from '@zenstackhq/plugin-policy';

const db = new ZenStackClient(...);
Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-3.x/reference/zmodel/attribute.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -365,7 +365,7 @@ _Params_:
attribute @@meta(_ name: String, _ value: Any)
```

Adds arbitrary metadata to a model. The metadata can be accessed by custom plugins for code generation, or at runtime from the `modelMeta` object exported from `@zenstackhq/runtime/model-meta`. The `value` parameter can be an arbitrary literal expression, including object literals.
Adds arbitrary metadata to a model. The metadata can be accessed by custom plugins for code generation, or at runtime from the `modelMeta` object exported from `@zenstackhq/orm/model-meta`. The `value` parameter can be an arbitrary literal expression, including object literals.

```zmodel
model User {
Expand DownExpand Up@@ -482,7 +482,7 @@ attribute @json()
attribute @meta(_ name: String, _ value: Any)
```

Adds arbitrary metadata to a field. The metadata can be accessed by custom plugins for code generation, or at runtime from the `modelMeta` object exported from `@zenstackhq/runtime/model-meta`. The `value` parameter can be an arbitrary literal expression, including object literals.
Adds arbitrary metadata to a field. The metadata can be accessed by custom plugins for code generation, or at runtime from the `modelMeta` object exported from `@zenstackhq/orm/model-meta`. The `value` parameter can be an arbitrary literal expression, including object literals.

```zmodel
model User {
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
doc: update orm package name#501

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ymc9
merged 7 commits into

from

Nov 1, 2025
 Merged


doc: update orm package name
#501
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
e1f4907

doc: v3 query as a service


ymc9 Oct 31, 2025
9d563df

fix doc errors


ymc9 Oct 31, 2025
eae2590

addressing PR comments


ymc9 Oct 31, 2025
c459453

add server adapter sample


ymc9 Nov 1, 2025
65e68f8

update submodules


ymc9 Nov 1, 2025
70690f2

docs: update orm package name


ymc9 Nov 1, 2025
d3c7551

Merge remote-tracking branch 'origin/main' into docs/qaas-v3


ymc9 Nov 1, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 3 additions & 3 deletions
versioned_docs/version-3.x/migrate-prisma.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,7 @@ ZenStack v3 doesn't depend on Prisma at runtime. Its CLI has a peer dependency o
- Remove `prisma` and `@prisma/client` from your project dependencies.
- Install ZenStack packages

 <PackageInstall dependencies={['@zenstackhq/runtime@next']} devDependencies={['@zenstackhq/cli@next']} />
 <PackageInstall dependencies={['@zenstackhq/orm@next']} devDependencies={['@zenstackhq/cli@next']} />

- Install a database driver

Expand DownExpand Up@@ -87,7 +87,7 @@ Replace `new PrismaClient()` with `new ZenStackClient(schema, ...)` where `schem
<TabItem value="postgres" label={`PostgreSQL`}>

```ts title='db.ts'
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { schema } from './zenstack/schema';
import { PostgresDialect } from 'kysely';
import { Pool } from 'pg';
Expand All@@ -105,7 +105,7 @@ export const db = new ZenStackClient(schema, {
<TabItem value="sqlite" label={`SQLite`}>

```ts title='db.ts'
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { SqliteDialect } from 'kysely';
import SQLite from 'better-sqlite3';
import { schema } from './zenstack/schema';
Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/orm/access-control/query.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ After defining access control policies in ZModel, it's time to enjoy their benef
Similar to the schema side, access control's runtime aspect is encapsulated in the `@zenstackhq/plugin-policy` package too, as a Runtime Plugin (more about this topic [later](../plugins/index.md)). You should install it on the raw ORM client to get a new client instance with access control enforcement.

```ts
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { PolicyPlugin } from '@zenstackhq/plugin-policy';

// create an unprotected, "raw" ORM client
Expand Down

6 changes: 3 additions & 3 deletions
versioned_docs/version-3.x/orm/client.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ The samples below only show creating a client using SQLite (via [better-sqlite3]
<PackageInstall dependencies={["better-sqlite3"]} devDependencies={['@types/better-sqlite3']} />

```ts title='db.ts'
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { SqliteDialect } from 'kysely';
import SQLite from 'better-sqlite3';
import { schema } from './zenstack/schema';
Expand All@@ -43,7 +43,7 @@ export const db = new ZenStackClient(schema, {
<PackageInstall dependencies={["pg"]} devDependencies={['@types/pg']} />

```ts title='db.ts'
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { schema } from './zenstack/schema';
import { PostgresDialect } from 'kysely';
import { Pool } from 'pg';
Expand All@@ -63,7 +63,7 @@ export const db = new ZenStackClient(schema, {
The created `db` object has the full ORM API inferred from the type of the `schema` parameter. When necessary, you can also explicitly get the inferred client type like:

```ts
import type { ClientContract } from '@zenstackhq/runtime';
import type { ClientContract } from '@zenstackhq/orm';
import type { SchemaType } from '@/zenstack/schema';

export type DbClient = ClientContract<SchemaType>;
Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/orm/errors.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ description: ORM Errors

# Errors

The ORM uses the following error classes from `@zenstackhq/runtime` to represent different types of failures:
The ORM uses the following error classes from `@zenstackhq/orm` to represent different types of failures:

## `InputValidationError`

Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/orm/inferred-types.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ Most of the time, you don't need to explicitly type the input and output of the

- `ModelResult`

 The `ModelResult` generic type from `@zenstackhq/runtime` allows you to infer the exact model type given field selection and relation inclusion information.
 The `ModelResult` generic type from `@zenstackhq/orm` allows you to infer the exact model type given field selection and relation inclusion information.

## Samples

Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/orm/quick-start.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,7 @@ You can also always configure a project manually with the following steps:

1. Install dependencies

 <PackageInstall devDependencies={['@zenstackhq/cli@next']} dependencies={['@zenstackhq/runtime@next']} />
 <PackageInstall devDependencies={['@zenstackhq/cli@next']} dependencies={['@zenstackhq/orm@next']} />

2. Create a `zenstack/schema.zmodel` file

Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/reference/api.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ sidebar_label: API

# API Reference

## `@zenstackhq/runtime`
## `@zenstackhq/orm`

### `class ZenStackClient`

Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/reference/plugins/policy.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -146,7 +146,7 @@ The following functions can be used in policy conditions:
The plugin exports a runtime plugin `PolicyPlugin` that can be installed on the ORM client to enable access control enforcement.

```ts
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { PolicyPlugin } from '@zenstackhq/plugin-policy';

const db = new ZenStackClient(...);
Expand Down

4 changes: 2 additions & 2 deletions
versioned_docs/version-3.x/reference/zmodel/attribute.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -365,7 +365,7 @@ _Params_:
attribute @@meta(_ name: String, _ value: Any)
```

Adds arbitrary metadata to a model. The metadata can be accessed by custom plugins for code generation, or at runtime from the `modelMeta` object exported from `@zenstackhq/runtime/model-meta`. The `value` parameter can be an arbitrary literal expression, including object literals.
Adds arbitrary metadata to a model. The metadata can be accessed by custom plugins for code generation, or at runtime from the `modelMeta` object exported from `@zenstackhq/orm/model-meta`. The `value` parameter can be an arbitrary literal expression, including object literals.

```zmodel
model User {
Expand DownExpand Up@@ -482,7 +482,7 @@ attribute @json()
attribute @meta(_ name: String, _ value: Any)
```

Adds arbitrary metadata to a field. The metadata can be accessed by custom plugins for code generation, or at runtime from the `modelMeta` object exported from `@zenstackhq/runtime/model-meta`. The `value` parameter can be an arbitrary literal expression, including object literals.
Adds arbitrary metadata to a field. The metadata can be accessed by custom plugins for code generation, or at runtime from the `modelMeta` object exported from `@zenstackhq/orm/model-meta`. The `value` parameter can be an arbitrary literal expression, including object literals.

```zmodel
model User {
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
doc: update orm package name#501

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ymc9
merged 7 commits into

from

Nov 1, 2025
 Merged


doc: update orm package name
#501
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
e1f4907

doc: v3 query as a service


ymc9 Oct 31, 2025
9d563df

fix doc errors


ymc9 Oct 31, 2025
eae2590

addressing PR comments


ymc9 Oct 31, 2025
c459453

add server adapter sample


ymc9 Nov 1, 2025
65e68f8

update submodules


ymc9 Nov 1, 2025
70690f2

docs: update orm package name


ymc9 Nov 1, 2025
d3c7551

Merge remote-tracking branch 'origin/main' into docs/qaas-v3


ymc9 Nov 1, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 3 additions & 3 deletions
versioned_docs/version-3.x/migrate-prisma.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,7 @@ ZenStack v3 doesn't depend on Prisma at runtime. Its CLI has a peer dependency o
- Remove `prisma` and `@prisma/client` from your project dependencies.
- Install ZenStack packages

 <PackageInstall dependencies={['@zenstackhq/runtime@next']} devDependencies={['@zenstackhq/cli@next']} />
 <PackageInstall dependencies={['@zenstackhq/orm@next']} devDependencies={['@zenstackhq/cli@next']} />

- Install a database driver

Expand DownExpand Up@@ -87,7 +87,7 @@ Replace `new PrismaClient()` with `new ZenStackClient(schema, ...)` where `schem
<TabItem value="postgres" label={`PostgreSQL`}>

```ts title='db.ts'
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { schema } from './zenstack/schema';
import { PostgresDialect } from 'kysely';
import { Pool } from 'pg';
Expand All@@ -105,7 +105,7 @@ export const db = new ZenStackClient(schema, {
<TabItem value="sqlite" label={`SQLite`}>

```ts title='db.ts'
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { SqliteDialect } from 'kysely';
import SQLite from 'better-sqlite3';
import { schema } from './zenstack/schema';
Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/orm/access-control/query.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ After defining access control policies in ZModel, it's time to enjoy their benef
Similar to the schema side, access control's runtime aspect is encapsulated in the `@zenstackhq/plugin-policy` package too, as a Runtime Plugin (more about this topic [later](../plugins/index.md)). You should install it on the raw ORM client to get a new client instance with access control enforcement.

```ts
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { PolicyPlugin } from '@zenstackhq/plugin-policy';

// create an unprotected, "raw" ORM client
Expand Down

6 changes: 3 additions & 3 deletions
versioned_docs/version-3.x/orm/client.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ The samples below only show creating a client using SQLite (via [better-sqlite3]
<PackageInstall dependencies={["better-sqlite3"]} devDependencies={['@types/better-sqlite3']} />

```ts title='db.ts'
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { SqliteDialect } from 'kysely';
import SQLite from 'better-sqlite3';
import { schema } from './zenstack/schema';
Expand All@@ -43,7 +43,7 @@ export const db = new ZenStackClient(schema, {
<PackageInstall dependencies={["pg"]} devDependencies={['@types/pg']} />

```ts title='db.ts'
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { schema } from './zenstack/schema';
import { PostgresDialect } from 'kysely';
import { Pool } from 'pg';
Expand All@@ -63,7 +63,7 @@ export const db = new ZenStackClient(schema, {
The created `db` object has the full ORM API inferred from the type of the `schema` parameter. When necessary, you can also explicitly get the inferred client type like:

```ts
import type { ClientContract } from '@zenstackhq/runtime';
import type { ClientContract } from '@zenstackhq/orm';
import type { SchemaType } from '@/zenstack/schema';

export type DbClient = ClientContract<SchemaType>;
Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/orm/errors.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ description: ORM Errors

# Errors

The ORM uses the following error classes from `@zenstackhq/runtime` to represent different types of failures:
The ORM uses the following error classes from `@zenstackhq/orm` to represent different types of failures:

## `InputValidationError`

Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/orm/inferred-types.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ Most of the time, you don't need to explicitly type the input and output of the

- `ModelResult`

 The `ModelResult` generic type from `@zenstackhq/runtime` allows you to infer the exact model type given field selection and relation inclusion information.
 The `ModelResult` generic type from `@zenstackhq/orm` allows you to infer the exact model type given field selection and relation inclusion information.

## Samples

Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/orm/quick-start.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,7 @@ You can also always configure a project manually with the following steps:

1. Install dependencies

 <PackageInstall devDependencies={['@zenstackhq/cli@next']} dependencies={['@zenstackhq/runtime@next']} />
 <PackageInstall devDependencies={['@zenstackhq/cli@next']} dependencies={['@zenstackhq/orm@next']} />

2. Create a `zenstack/schema.zmodel` file

Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/reference/api.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ sidebar_label: API

# API Reference

## `@zenstackhq/runtime`
## `@zenstackhq/orm`

### `class ZenStackClient`

Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/reference/plugins/policy.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -146,7 +146,7 @@ The following functions can be used in policy conditions:
The plugin exports a runtime plugin `PolicyPlugin` that can be installed on the ORM client to enable access control enforcement.

```ts
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { PolicyPlugin } from '@zenstackhq/plugin-policy';

const db = new ZenStackClient(...);
Expand Down

4 changes: 2 additions & 2 deletions
versioned_docs/version-3.x/reference/zmodel/attribute.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -365,7 +365,7 @@ _Params_:
attribute @@meta(_ name: String, _ value: Any)
```

Adds arbitrary metadata to a model. The metadata can be accessed by custom plugins for code generation, or at runtime from the `modelMeta` object exported from `@zenstackhq/runtime/model-meta`. The `value` parameter can be an arbitrary literal expression, including object literals.
Adds arbitrary metadata to a model. The metadata can be accessed by custom plugins for code generation, or at runtime from the `modelMeta` object exported from `@zenstackhq/orm/model-meta`. The `value` parameter can be an arbitrary literal expression, including object literals.

```zmodel
model User {
Expand DownExpand Up@@ -482,7 +482,7 @@ attribute @json()
attribute @meta(_ name: String, _ value: Any)
```

Adds arbitrary metadata to a field. The metadata can be accessed by custom plugins for code generation, or at runtime from the `modelMeta` object exported from `@zenstackhq/runtime/model-meta`. The `value` parameter can be an arbitrary literal expression, including object literals.
Adds arbitrary metadata to a field. The metadata can be accessed by custom plugins for code generation, or at runtime from the `modelMeta` object exported from `@zenstackhq/orm/model-meta`. The `value` parameter can be an arbitrary literal expression, including object literals.

```zmodel
model User {
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
doc: update orm package name#501

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ymc9
merged 7 commits into

from

Nov 1, 2025
 Merged


doc: update orm package name
#501
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
e1f4907

doc: v3 query as a service


ymc9 Oct 31, 2025
9d563df

fix doc errors


ymc9 Oct 31, 2025
eae2590

addressing PR comments


ymc9 Oct 31, 2025
c459453

add server adapter sample


ymc9 Nov 1, 2025
65e68f8

update submodules


ymc9 Nov 1, 2025
70690f2

docs: update orm package name


ymc9 Nov 1, 2025
d3c7551

Merge remote-tracking branch 'origin/main' into docs/qaas-v3


ymc9 Nov 1, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 3 additions & 3 deletions
versioned_docs/version-3.x/migrate-prisma.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,7 @@ ZenStack v3 doesn't depend on Prisma at runtime. Its CLI has a peer dependency o
- Remove `prisma` and `@prisma/client` from your project dependencies.
- Install ZenStack packages

 <PackageInstall dependencies={['@zenstackhq/runtime@next']} devDependencies={['@zenstackhq/cli@next']} />
 <PackageInstall dependencies={['@zenstackhq/orm@next']} devDependencies={['@zenstackhq/cli@next']} />

- Install a database driver

Expand DownExpand Up@@ -87,7 +87,7 @@ Replace `new PrismaClient()` with `new ZenStackClient(schema, ...)` where `schem
<TabItem value="postgres" label={`PostgreSQL`}>

```ts title='db.ts'
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { schema } from './zenstack/schema';
import { PostgresDialect } from 'kysely';
import { Pool } from 'pg';
Expand All@@ -105,7 +105,7 @@ export const db = new ZenStackClient(schema, {
<TabItem value="sqlite" label={`SQLite`}>

```ts title='db.ts'
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { SqliteDialect } from 'kysely';
import SQLite from 'better-sqlite3';
import { schema } from './zenstack/schema';
Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/orm/access-control/query.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ After defining access control policies in ZModel, it's time to enjoy their benef
Similar to the schema side, access control's runtime aspect is encapsulated in the `@zenstackhq/plugin-policy` package too, as a Runtime Plugin (more about this topic [later](../plugins/index.md)). You should install it on the raw ORM client to get a new client instance with access control enforcement.

```ts
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { PolicyPlugin } from '@zenstackhq/plugin-policy';

// create an unprotected, "raw" ORM client
Expand Down

6 changes: 3 additions & 3 deletions
versioned_docs/version-3.x/orm/client.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ The samples below only show creating a client using SQLite (via [better-sqlite3]
<PackageInstall dependencies={["better-sqlite3"]} devDependencies={['@types/better-sqlite3']} />

```ts title='db.ts'
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { SqliteDialect } from 'kysely';
import SQLite from 'better-sqlite3';
import { schema } from './zenstack/schema';
Expand All@@ -43,7 +43,7 @@ export const db = new ZenStackClient(schema, {
<PackageInstall dependencies={["pg"]} devDependencies={['@types/pg']} />

```ts title='db.ts'
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { schema } from './zenstack/schema';
import { PostgresDialect } from 'kysely';
import { Pool } from 'pg';
Expand All@@ -63,7 +63,7 @@ export const db = new ZenStackClient(schema, {
The created `db` object has the full ORM API inferred from the type of the `schema` parameter. When necessary, you can also explicitly get the inferred client type like:

```ts
import type { ClientContract } from '@zenstackhq/runtime';
import type { ClientContract } from '@zenstackhq/orm';
import type { SchemaType } from '@/zenstack/schema';

export type DbClient = ClientContract<SchemaType>;
Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/orm/errors.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ description: ORM Errors

# Errors

The ORM uses the following error classes from `@zenstackhq/runtime` to represent different types of failures:
The ORM uses the following error classes from `@zenstackhq/orm` to represent different types of failures:

## `InputValidationError`

Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/orm/inferred-types.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ Most of the time, you don't need to explicitly type the input and output of the

- `ModelResult`

 The `ModelResult` generic type from `@zenstackhq/runtime` allows you to infer the exact model type given field selection and relation inclusion information.
 The `ModelResult` generic type from `@zenstackhq/orm` allows you to infer the exact model type given field selection and relation inclusion information.

## Samples

Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/orm/quick-start.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,7 @@ You can also always configure a project manually with the following steps:

1. Install dependencies

 <PackageInstall devDependencies={['@zenstackhq/cli@next']} dependencies={['@zenstackhq/runtime@next']} />
 <PackageInstall devDependencies={['@zenstackhq/cli@next']} dependencies={['@zenstackhq/orm@next']} />

2. Create a `zenstack/schema.zmodel` file

Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/reference/api.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ sidebar_label: API

# API Reference

## `@zenstackhq/runtime`
## `@zenstackhq/orm`

### `class ZenStackClient`

Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/reference/plugins/policy.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -146,7 +146,7 @@ The following functions can be used in policy conditions:
The plugin exports a runtime plugin `PolicyPlugin` that can be installed on the ORM client to enable access control enforcement.

```ts
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { PolicyPlugin } from '@zenstackhq/plugin-policy';

const db = new ZenStackClient(...);
Expand Down

4 changes: 2 additions & 2 deletions
versioned_docs/version-3.x/reference/zmodel/attribute.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -365,7 +365,7 @@ _Params_:
attribute @@meta(_ name: String, _ value: Any)
```

Adds arbitrary metadata to a model. The metadata can be accessed by custom plugins for code generation, or at runtime from the `modelMeta` object exported from `@zenstackhq/runtime/model-meta`. The `value` parameter can be an arbitrary literal expression, including object literals.
Adds arbitrary metadata to a model. The metadata can be accessed by custom plugins for code generation, or at runtime from the `modelMeta` object exported from `@zenstackhq/orm/model-meta`. The `value` parameter can be an arbitrary literal expression, including object literals.

```zmodel
model User {
Expand DownExpand Up@@ -482,7 +482,7 @@ attribute @json()
attribute @meta(_ name: String, _ value: Any)
```

Adds arbitrary metadata to a field. The metadata can be accessed by custom plugins for code generation, or at runtime from the `modelMeta` object exported from `@zenstackhq/runtime/model-meta`. The `value` parameter can be an arbitrary literal expression, including object literals.
Adds arbitrary metadata to a field. The metadata can be accessed by custom plugins for code generation, or at runtime from the `modelMeta` object exported from `@zenstackhq/orm/model-meta`. The `value` parameter can be an arbitrary literal expression, including object literals.

```zmodel
model User {
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
doc: update orm package name#501

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ymc9
merged 7 commits into

from

Nov 1, 2025
 Merged


doc: update orm package name
#501
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
e1f4907

doc: v3 query as a service


ymc9 Oct 31, 2025
9d563df

fix doc errors


ymc9 Oct 31, 2025
eae2590

addressing PR comments


ymc9 Oct 31, 2025
c459453

add server adapter sample


ymc9 Nov 1, 2025
65e68f8

update submodules


ymc9 Nov 1, 2025
70690f2

docs: update orm package name


ymc9 Nov 1, 2025
d3c7551

Merge remote-tracking branch 'origin/main' into docs/qaas-v3


ymc9 Nov 1, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 3 additions & 3 deletions
versioned_docs/version-3.x/migrate-prisma.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,7 @@ ZenStack v3 doesn't depend on Prisma at runtime. Its CLI has a peer dependency o
- Remove `prisma` and `@prisma/client` from your project dependencies.
- Install ZenStack packages

 <PackageInstall dependencies={['@zenstackhq/runtime@next']} devDependencies={['@zenstackhq/cli@next']} />
 <PackageInstall dependencies={['@zenstackhq/orm@next']} devDependencies={['@zenstackhq/cli@next']} />

- Install a database driver

Expand DownExpand Up@@ -87,7 +87,7 @@ Replace `new PrismaClient()` with `new ZenStackClient(schema, ...)` where `schem
<TabItem value="postgres" label={`PostgreSQL`}>

```ts title='db.ts'
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { schema } from './zenstack/schema';
import { PostgresDialect } from 'kysely';
import { Pool } from 'pg';
Expand All@@ -105,7 +105,7 @@ export const db = new ZenStackClient(schema, {
<TabItem value="sqlite" label={`SQLite`}>

```ts title='db.ts'
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { SqliteDialect } from 'kysely';
import SQLite from 'better-sqlite3';
import { schema } from './zenstack/schema';
Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/orm/access-control/query.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ After defining access control policies in ZModel, it's time to enjoy their benef
Similar to the schema side, access control's runtime aspect is encapsulated in the `@zenstackhq/plugin-policy` package too, as a Runtime Plugin (more about this topic [later](../plugins/index.md)). You should install it on the raw ORM client to get a new client instance with access control enforcement.

```ts
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { PolicyPlugin } from '@zenstackhq/plugin-policy';

// create an unprotected, "raw" ORM client
Expand Down

6 changes: 3 additions & 3 deletions
versioned_docs/version-3.x/orm/client.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ The samples below only show creating a client using SQLite (via [better-sqlite3]
<PackageInstall dependencies={["better-sqlite3"]} devDependencies={['@types/better-sqlite3']} />

```ts title='db.ts'
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { SqliteDialect } from 'kysely';
import SQLite from 'better-sqlite3';
import { schema } from './zenstack/schema';
Expand All@@ -43,7 +43,7 @@ export const db = new ZenStackClient(schema, {
<PackageInstall dependencies={["pg"]} devDependencies={['@types/pg']} />

```ts title='db.ts'
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { schema } from './zenstack/schema';
import { PostgresDialect } from 'kysely';
import { Pool } from 'pg';
Expand All@@ -63,7 +63,7 @@ export const db = new ZenStackClient(schema, {
The created `db` object has the full ORM API inferred from the type of the `schema` parameter. When necessary, you can also explicitly get the inferred client type like:

```ts
import type { ClientContract } from '@zenstackhq/runtime';
import type { ClientContract } from '@zenstackhq/orm';
import type { SchemaType } from '@/zenstack/schema';

export type DbClient = ClientContract<SchemaType>;
Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/orm/errors.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ description: ORM Errors

# Errors

The ORM uses the following error classes from `@zenstackhq/runtime` to represent different types of failures:
The ORM uses the following error classes from `@zenstackhq/orm` to represent different types of failures:

## `InputValidationError`

Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/orm/inferred-types.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ Most of the time, you don't need to explicitly type the input and output of the

- `ModelResult`

 The `ModelResult` generic type from `@zenstackhq/runtime` allows you to infer the exact model type given field selection and relation inclusion information.
 The `ModelResult` generic type from `@zenstackhq/orm` allows you to infer the exact model type given field selection and relation inclusion information.

## Samples

Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/orm/quick-start.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,7 @@ You can also always configure a project manually with the following steps:

1. Install dependencies

 <PackageInstall devDependencies={['@zenstackhq/cli@next']} dependencies={['@zenstackhq/runtime@next']} />
 <PackageInstall devDependencies={['@zenstackhq/cli@next']} dependencies={['@zenstackhq/orm@next']} />

2. Create a `zenstack/schema.zmodel` file

Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/reference/api.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ sidebar_label: API

# API Reference

## `@zenstackhq/runtime`
## `@zenstackhq/orm`

### `class ZenStackClient`

Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/reference/plugins/policy.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -146,7 +146,7 @@ The following functions can be used in policy conditions:
The plugin exports a runtime plugin `PolicyPlugin` that can be installed on the ORM client to enable access control enforcement.

```ts
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { PolicyPlugin } from '@zenstackhq/plugin-policy';

const db = new ZenStackClient(...);
Expand Down

4 changes: 2 additions & 2 deletions
versioned_docs/version-3.x/reference/zmodel/attribute.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -365,7 +365,7 @@ _Params_:
attribute @@meta(_ name: String, _ value: Any)
```

Adds arbitrary metadata to a model. The metadata can be accessed by custom plugins for code generation, or at runtime from the `modelMeta` object exported from `@zenstackhq/runtime/model-meta`. The `value` parameter can be an arbitrary literal expression, including object literals.
Adds arbitrary metadata to a model. The metadata can be accessed by custom plugins for code generation, or at runtime from the `modelMeta` object exported from `@zenstackhq/orm/model-meta`. The `value` parameter can be an arbitrary literal expression, including object literals.

```zmodel
model User {
Expand DownExpand Up@@ -482,7 +482,7 @@ attribute @json()
attribute @meta(_ name: String, _ value: Any)
```

Adds arbitrary metadata to a field. The metadata can be accessed by custom plugins for code generation, or at runtime from the `modelMeta` object exported from `@zenstackhq/runtime/model-meta`. The `value` parameter can be an arbitrary literal expression, including object literals.
Adds arbitrary metadata to a field. The metadata can be accessed by custom plugins for code generation, or at runtime from the `modelMeta` object exported from `@zenstackhq/orm/model-meta`. The `value` parameter can be an arbitrary literal expression, including object literals.

```zmodel
model User {
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
doc: update orm package name#501

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ymc9
merged 7 commits into

from

Nov 1, 2025
 Merged


doc: update orm package name
#501
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
e1f4907

doc: v3 query as a service


ymc9 Oct 31, 2025
9d563df

fix doc errors


ymc9 Oct 31, 2025
eae2590

addressing PR comments


ymc9 Oct 31, 2025
c459453

add server adapter sample


ymc9 Nov 1, 2025
65e68f8

update submodules


ymc9 Nov 1, 2025
70690f2

docs: update orm package name


ymc9 Nov 1, 2025
d3c7551

Merge remote-tracking branch 'origin/main' into docs/qaas-v3


ymc9 Nov 1, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 3 additions & 3 deletions
versioned_docs/version-3.x/migrate-prisma.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,7 @@ ZenStack v3 doesn't depend on Prisma at runtime. Its CLI has a peer dependency o
- Remove `prisma` and `@prisma/client` from your project dependencies.
- Install ZenStack packages

 <PackageInstall dependencies={['@zenstackhq/runtime@next']} devDependencies={['@zenstackhq/cli@next']} />
 <PackageInstall dependencies={['@zenstackhq/orm@next']} devDependencies={['@zenstackhq/cli@next']} />

- Install a database driver

Expand DownExpand Up@@ -87,7 +87,7 @@ Replace `new PrismaClient()` with `new ZenStackClient(schema, ...)` where `schem
<TabItem value="postgres" label={`PostgreSQL`}>

```ts title='db.ts'
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { schema } from './zenstack/schema';
import { PostgresDialect } from 'kysely';
import { Pool } from 'pg';
Expand All@@ -105,7 +105,7 @@ export const db = new ZenStackClient(schema, {
<TabItem value="sqlite" label={`SQLite`}>

```ts title='db.ts'
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { SqliteDialect } from 'kysely';
import SQLite from 'better-sqlite3';
import { schema } from './zenstack/schema';
Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/orm/access-control/query.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ After defining access control policies in ZModel, it's time to enjoy their benef
Similar to the schema side, access control's runtime aspect is encapsulated in the `@zenstackhq/plugin-policy` package too, as a Runtime Plugin (more about this topic [later](../plugins/index.md)). You should install it on the raw ORM client to get a new client instance with access control enforcement.

```ts
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { PolicyPlugin } from '@zenstackhq/plugin-policy';

// create an unprotected, "raw" ORM client
Expand Down

6 changes: 3 additions & 3 deletions
versioned_docs/version-3.x/orm/client.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ The samples below only show creating a client using SQLite (via [better-sqlite3]
<PackageInstall dependencies={["better-sqlite3"]} devDependencies={['@types/better-sqlite3']} />

```ts title='db.ts'
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { SqliteDialect } from 'kysely';
import SQLite from 'better-sqlite3';
import { schema } from './zenstack/schema';
Expand All@@ -43,7 +43,7 @@ export const db = new ZenStackClient(schema, {
<PackageInstall dependencies={["pg"]} devDependencies={['@types/pg']} />

```ts title='db.ts'
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { schema } from './zenstack/schema';
import { PostgresDialect } from 'kysely';
import { Pool } from 'pg';
Expand All@@ -63,7 +63,7 @@ export const db = new ZenStackClient(schema, {
The created `db` object has the full ORM API inferred from the type of the `schema` parameter. When necessary, you can also explicitly get the inferred client type like:

```ts
import type { ClientContract } from '@zenstackhq/runtime';
import type { ClientContract } from '@zenstackhq/orm';
import type { SchemaType } from '@/zenstack/schema';

export type DbClient = ClientContract<SchemaType>;
Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/orm/errors.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ description: ORM Errors

# Errors

The ORM uses the following error classes from `@zenstackhq/runtime` to represent different types of failures:
The ORM uses the following error classes from `@zenstackhq/orm` to represent different types of failures:

## `InputValidationError`

Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/orm/inferred-types.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ Most of the time, you don't need to explicitly type the input and output of the

- `ModelResult`

 The `ModelResult` generic type from `@zenstackhq/runtime` allows you to infer the exact model type given field selection and relation inclusion information.
 The `ModelResult` generic type from `@zenstackhq/orm` allows you to infer the exact model type given field selection and relation inclusion information.

## Samples

Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/orm/quick-start.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,7 @@ You can also always configure a project manually with the following steps:

1. Install dependencies

 <PackageInstall devDependencies={['@zenstackhq/cli@next']} dependencies={['@zenstackhq/runtime@next']} />
 <PackageInstall devDependencies={['@zenstackhq/cli@next']} dependencies={['@zenstackhq/orm@next']} />

2. Create a `zenstack/schema.zmodel` file

Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/reference/api.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ sidebar_label: API

# API Reference

## `@zenstackhq/runtime`
## `@zenstackhq/orm`

### `class ZenStackClient`

Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/reference/plugins/policy.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -146,7 +146,7 @@ The following functions can be used in policy conditions:
The plugin exports a runtime plugin `PolicyPlugin` that can be installed on the ORM client to enable access control enforcement.

```ts
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { PolicyPlugin } from '@zenstackhq/plugin-policy';

const db = new ZenStackClient(...);
Expand Down

4 changes: 2 additions & 2 deletions
versioned_docs/version-3.x/reference/zmodel/attribute.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -365,7 +365,7 @@ _Params_:
attribute @@meta(_ name: String, _ value: Any)
```

Adds arbitrary metadata to a model. The metadata can be accessed by custom plugins for code generation, or at runtime from the `modelMeta` object exported from `@zenstackhq/runtime/model-meta`. The `value` parameter can be an arbitrary literal expression, including object literals.
Adds arbitrary metadata to a model. The metadata can be accessed by custom plugins for code generation, or at runtime from the `modelMeta` object exported from `@zenstackhq/orm/model-meta`. The `value` parameter can be an arbitrary literal expression, including object literals.

```zmodel
model User {
Expand DownExpand Up@@ -482,7 +482,7 @@ attribute @json()
attribute @meta(_ name: String, _ value: Any)
```

Adds arbitrary metadata to a field. The metadata can be accessed by custom plugins for code generation, or at runtime from the `modelMeta` object exported from `@zenstackhq/runtime/model-meta`. The `value` parameter can be an arbitrary literal expression, including object literals.
Adds arbitrary metadata to a field. The metadata can be accessed by custom plugins for code generation, or at runtime from the `modelMeta` object exported from `@zenstackhq/orm/model-meta`. The `value` parameter can be an arbitrary literal expression, including object literals.

```zmodel
model User {
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
doc: update orm package name#501

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ymc9
merged 7 commits into

from

Nov 1, 2025
 Merged


doc: update orm package name
#501
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
e1f4907

doc: v3 query as a service


ymc9 Oct 31, 2025
9d563df

fix doc errors


ymc9 Oct 31, 2025
eae2590

addressing PR comments


ymc9 Oct 31, 2025
c459453

add server adapter sample


ymc9 Nov 1, 2025
65e68f8

update submodules


ymc9 Nov 1, 2025
70690f2

docs: update orm package name


ymc9 Nov 1, 2025
d3c7551

Merge remote-tracking branch 'origin/main' into docs/qaas-v3


ymc9 Nov 1, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 3 additions & 3 deletions
versioned_docs/version-3.x/migrate-prisma.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,7 @@ ZenStack v3 doesn't depend on Prisma at runtime. Its CLI has a peer dependency o
- Remove `prisma` and `@prisma/client` from your project dependencies.
- Install ZenStack packages

 <PackageInstall dependencies={['@zenstackhq/runtime@next']} devDependencies={['@zenstackhq/cli@next']} />
 <PackageInstall dependencies={['@zenstackhq/orm@next']} devDependencies={['@zenstackhq/cli@next']} />

- Install a database driver

Expand DownExpand Up@@ -87,7 +87,7 @@ Replace `new PrismaClient()` with `new ZenStackClient(schema, ...)` where `schem
<TabItem value="postgres" label={`PostgreSQL`}>

```ts title='db.ts'
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { schema } from './zenstack/schema';
import { PostgresDialect } from 'kysely';
import { Pool } from 'pg';
Expand All@@ -105,7 +105,7 @@ export const db = new ZenStackClient(schema, {
<TabItem value="sqlite" label={`SQLite`}>

```ts title='db.ts'
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { SqliteDialect } from 'kysely';
import SQLite from 'better-sqlite3';
import { schema } from './zenstack/schema';
Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/orm/access-control/query.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ After defining access control policies in ZModel, it's time to enjoy their benef
Similar to the schema side, access control's runtime aspect is encapsulated in the `@zenstackhq/plugin-policy` package too, as a Runtime Plugin (more about this topic [later](../plugins/index.md)). You should install it on the raw ORM client to get a new client instance with access control enforcement.

```ts
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { PolicyPlugin } from '@zenstackhq/plugin-policy';

// create an unprotected, "raw" ORM client
Expand Down

6 changes: 3 additions & 3 deletions
versioned_docs/version-3.x/orm/client.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ The samples below only show creating a client using SQLite (via [better-sqlite3]
<PackageInstall dependencies={["better-sqlite3"]} devDependencies={['@types/better-sqlite3']} />

```ts title='db.ts'
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { SqliteDialect } from 'kysely';
import SQLite from 'better-sqlite3';
import { schema } from './zenstack/schema';
Expand All@@ -43,7 +43,7 @@ export const db = new ZenStackClient(schema, {
<PackageInstall dependencies={["pg"]} devDependencies={['@types/pg']} />

```ts title='db.ts'
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { schema } from './zenstack/schema';
import { PostgresDialect } from 'kysely';
import { Pool } from 'pg';
Expand All@@ -63,7 +63,7 @@ export const db = new ZenStackClient(schema, {
The created `db` object has the full ORM API inferred from the type of the `schema` parameter. When necessary, you can also explicitly get the inferred client type like:

```ts
import type { ClientContract } from '@zenstackhq/runtime';
import type { ClientContract } from '@zenstackhq/orm';
import type { SchemaType } from '@/zenstack/schema';

export type DbClient = ClientContract<SchemaType>;
Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/orm/errors.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ description: ORM Errors

# Errors

The ORM uses the following error classes from `@zenstackhq/runtime` to represent different types of failures:
The ORM uses the following error classes from `@zenstackhq/orm` to represent different types of failures:

## `InputValidationError`

Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/orm/inferred-types.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ Most of the time, you don't need to explicitly type the input and output of the

- `ModelResult`

 The `ModelResult` generic type from `@zenstackhq/runtime` allows you to infer the exact model type given field selection and relation inclusion information.
 The `ModelResult` generic type from `@zenstackhq/orm` allows you to infer the exact model type given field selection and relation inclusion information.

## Samples

Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/orm/quick-start.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,7 @@ You can also always configure a project manually with the following steps:

1. Install dependencies

 <PackageInstall devDependencies={['@zenstackhq/cli@next']} dependencies={['@zenstackhq/runtime@next']} />
 <PackageInstall devDependencies={['@zenstackhq/cli@next']} dependencies={['@zenstackhq/orm@next']} />

2. Create a `zenstack/schema.zmodel` file

Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/reference/api.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ sidebar_label: API

# API Reference

## `@zenstackhq/runtime`
## `@zenstackhq/orm`

### `class ZenStackClient`

Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/reference/plugins/policy.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -146,7 +146,7 @@ The following functions can be used in policy conditions:
The plugin exports a runtime plugin `PolicyPlugin` that can be installed on the ORM client to enable access control enforcement.

```ts
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { PolicyPlugin } from '@zenstackhq/plugin-policy';

const db = new ZenStackClient(...);
Expand Down

4 changes: 2 additions & 2 deletions
versioned_docs/version-3.x/reference/zmodel/attribute.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -365,7 +365,7 @@ _Params_:
attribute @@meta(_ name: String, _ value: Any)
```

Adds arbitrary metadata to a model. The metadata can be accessed by custom plugins for code generation, or at runtime from the `modelMeta` object exported from `@zenstackhq/runtime/model-meta`. The `value` parameter can be an arbitrary literal expression, including object literals.
Adds arbitrary metadata to a model. The metadata can be accessed by custom plugins for code generation, or at runtime from the `modelMeta` object exported from `@zenstackhq/orm/model-meta`. The `value` parameter can be an arbitrary literal expression, including object literals.

```zmodel
model User {
Expand DownExpand Up@@ -482,7 +482,7 @@ attribute @json()
attribute @meta(_ name: String, _ value: Any)
```

Adds arbitrary metadata to a field. The metadata can be accessed by custom plugins for code generation, or at runtime from the `modelMeta` object exported from `@zenstackhq/runtime/model-meta`. The `value` parameter can be an arbitrary literal expression, including object literals.
Adds arbitrary metadata to a field. The metadata can be accessed by custom plugins for code generation, or at runtime from the `modelMeta` object exported from `@zenstackhq/orm/model-meta`. The `value` parameter can be an arbitrary literal expression, including object literals.

```zmodel
model User {
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
doc: update orm package name#501

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ymc9
merged 7 commits into

from

Nov 1, 2025
 Merged


doc: update orm package name
#501
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
e1f4907

doc: v3 query as a service


ymc9 Oct 31, 2025
9d563df

fix doc errors


ymc9 Oct 31, 2025
eae2590

addressing PR comments


ymc9 Oct 31, 2025
c459453

add server adapter sample


ymc9 Nov 1, 2025
65e68f8

update submodules


ymc9 Nov 1, 2025
70690f2

docs: update orm package name


ymc9 Nov 1, 2025
d3c7551

Merge remote-tracking branch 'origin/main' into docs/qaas-v3


ymc9 Nov 1, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 3 additions & 3 deletions
versioned_docs/version-3.x/migrate-prisma.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,7 @@ ZenStack v3 doesn't depend on Prisma at runtime. Its CLI has a peer dependency o
- Remove `prisma` and `@prisma/client` from your project dependencies.
- Install ZenStack packages

 <PackageInstall dependencies={['@zenstackhq/runtime@next']} devDependencies={['@zenstackhq/cli@next']} />
 <PackageInstall dependencies={['@zenstackhq/orm@next']} devDependencies={['@zenstackhq/cli@next']} />

- Install a database driver

Expand DownExpand Up@@ -87,7 +87,7 @@ Replace `new PrismaClient()` with `new ZenStackClient(schema, ...)` where `schem
<TabItem value="postgres" label={`PostgreSQL`}>

```ts title='db.ts'
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { schema } from './zenstack/schema';
import { PostgresDialect } from 'kysely';
import { Pool } from 'pg';
Expand All@@ -105,7 +105,7 @@ export const db = new ZenStackClient(schema, {
<TabItem value="sqlite" label={`SQLite`}>

```ts title='db.ts'
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { SqliteDialect } from 'kysely';
import SQLite from 'better-sqlite3';
import { schema } from './zenstack/schema';
Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/orm/access-control/query.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ After defining access control policies in ZModel, it's time to enjoy their benef
Similar to the schema side, access control's runtime aspect is encapsulated in the `@zenstackhq/plugin-policy` package too, as a Runtime Plugin (more about this topic [later](../plugins/index.md)). You should install it on the raw ORM client to get a new client instance with access control enforcement.

```ts
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { PolicyPlugin } from '@zenstackhq/plugin-policy';

// create an unprotected, "raw" ORM client
Expand Down

6 changes: 3 additions & 3 deletions
versioned_docs/version-3.x/orm/client.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ The samples below only show creating a client using SQLite (via [better-sqlite3]
<PackageInstall dependencies={["better-sqlite3"]} devDependencies={['@types/better-sqlite3']} />

```ts title='db.ts'
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { SqliteDialect } from 'kysely';
import SQLite from 'better-sqlite3';
import { schema } from './zenstack/schema';
Expand All@@ -43,7 +43,7 @@ export const db = new ZenStackClient(schema, {
<PackageInstall dependencies={["pg"]} devDependencies={['@types/pg']} />

```ts title='db.ts'
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { schema } from './zenstack/schema';
import { PostgresDialect } from 'kysely';
import { Pool } from 'pg';
Expand All@@ -63,7 +63,7 @@ export const db = new ZenStackClient(schema, {
The created `db` object has the full ORM API inferred from the type of the `schema` parameter. When necessary, you can also explicitly get the inferred client type like:

```ts
import type { ClientContract } from '@zenstackhq/runtime';
import type { ClientContract } from '@zenstackhq/orm';
import type { SchemaType } from '@/zenstack/schema';

export type DbClient = ClientContract<SchemaType>;
Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/orm/errors.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ description: ORM Errors

# Errors

The ORM uses the following error classes from `@zenstackhq/runtime` to represent different types of failures:
The ORM uses the following error classes from `@zenstackhq/orm` to represent different types of failures:

## `InputValidationError`

Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/orm/inferred-types.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ Most of the time, you don't need to explicitly type the input and output of the

- `ModelResult`

 The `ModelResult` generic type from `@zenstackhq/runtime` allows you to infer the exact model type given field selection and relation inclusion information.
 The `ModelResult` generic type from `@zenstackhq/orm` allows you to infer the exact model type given field selection and relation inclusion information.

## Samples

Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/orm/quick-start.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,7 @@ You can also always configure a project manually with the following steps:

1. Install dependencies

 <PackageInstall devDependencies={['@zenstackhq/cli@next']} dependencies={['@zenstackhq/runtime@next']} />
 <PackageInstall devDependencies={['@zenstackhq/cli@next']} dependencies={['@zenstackhq/orm@next']} />

2. Create a `zenstack/schema.zmodel` file

Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/reference/api.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ sidebar_label: API

# API Reference

## `@zenstackhq/runtime`
## `@zenstackhq/orm`

### `class ZenStackClient`

Expand Down

2 changes: 1 addition & 1 deletion
versioned_docs/version-3.x/reference/plugins/policy.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -146,7 +146,7 @@ The following functions can be used in policy conditions:
The plugin exports a runtime plugin `PolicyPlugin` that can be installed on the ORM client to enable access control enforcement.

```ts
import { ZenStackClient } from '@zenstackhq/runtime';
import { ZenStackClient } from '@zenstackhq/orm';
import { PolicyPlugin } from '@zenstackhq/plugin-policy';

const db = new ZenStackClient(...);
Expand Down

4 changes: 2 additions & 2 deletions
versioned_docs/version-3.x/reference/zmodel/attribute.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -365,7 +365,7 @@ _Params_:
attribute @@meta(_ name: String, _ value: Any)
```

Adds arbitrary metadata to a model. The metadata can be accessed by custom plugins for code generation, or at runtime from the `modelMeta` object exported from `@zenstackhq/runtime/model-meta`. The `value` parameter can be an arbitrary literal expression, including object literals.
Adds arbitrary metadata to a model. The metadata can be accessed by custom plugins for code generation, or at runtime from the `modelMeta` object exported from `@zenstackhq/orm/model-meta`. The `value` parameter can be an arbitrary literal expression, including object literals.

```zmodel
model User {
Expand DownExpand Up@@ -482,7 +482,7 @@ attribute @json()
attribute @meta(_ name: String, _ value: Any)
```

Adds arbitrary metadata to a field. The metadata can be accessed by custom plugins for code generation, or at runtime from the `modelMeta` object exported from `@zenstackhq/runtime/model-meta`. The `value` parameter can be an arbitrary literal expression, including object literals.
Adds arbitrary metadata to a field. The metadata can be accessed by custom plugins for code generation, or at runtime from the `modelMeta` object exported from `@zenstackhq/orm/model-meta`. The `value` parameter can be an arbitrary literal expression, including object literals.

```zmodel
model User {
Expand Down