docs: nestjs guide for v3

[ymc9]

Summary by CodeRabbit

• Documentation
  • Updated ORM client examples with corrected import sources for Postgres and Sqlite dialects.
  • Added a comprehensive NestJS integration guide covering plain ORM usage, access-controlled ORM patterns, and automatic CRUD service setup with examples.
  • Improved documentation structure and navigation, including updated sidebar ordering for recipe pages.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Review	Updated (UTC)
zenstack-new-site	Ready	Preview, Comment	Dec 18, 2025 2:49am

[coderabbitai]

Walkthrough

Updates multiple documentation submodule pointers, changes dialect import paths in v3 docs to @zenstackhq/orm dialect packages, adds a NestJS integration guide, and adjusts a documentation sidebar position.

Changes

Cohort / File(s)	Change Summary
Submodule pointer updates code-repos/zenstackhq/v3-doc-orm, code-repos/zenstackhq/v3-doc-orm-computed-fields, code-repos/zenstackhq/v3-doc-orm-policy, code-repos/zenstackhq/v3-doc-orm-polymorphism, code-repos/zenstackhq/v3-doc-orm-typed-json, code-repos/zenstackhq/v3-doc-orm-validation, code-repos/zenstackhq/v3-doc-quick-start, code-repos/zenstackhq/v3-doc-server-adapter, code-repos/zenstackhq/v3-doc-tanstack-query	Updated recorded subproject commit hashes for multiple documentation submodules; no functional or API changes.
Dialect import path updates versioned_docs/version-3.x/migrate-prisma.md, versioned_docs/version-3.x/orm/client.md	Replaced PostgresDialect and SqliteDialect imports from kysely with imports from @zenstackhq/orm/dialects/... in documentation examples.
Documentation additions versioned_docs/version-3.x/recipe/nestjs.md	Added NestJS integration guide covering plain ORM usage, access-controlled ORM with PolicyPlugin, and an automatic CRUD/API handler setup.
Documentation maintenance versioned_docs/version-3.x/recipe/postgres-multi-schema.md	Updated front-matter sidebar_position from 2 to 3 (no content changes).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Submodule pointer updates are mechanical reference changes.
• Dialect import path edits are documentation-only.
• New NestJS guide is documentation content; no runtime logic to verify.

Possibly related PRs

• update code submodules #512 — Broad submodule pointer updates across the same v3 documentation subprojects.
• doc: update orm package name #501 — Related changes updating dialect import paths to @zenstackhq/orm in the same docs.
• docs: add api handler service usage #448 — Related NestJS documentation updates showing API handler / automatic CRUD usage.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'docs: nestjs guide for v3' accurately reflects the main change, which is the addition of a comprehensive NestJS integration guide documentation file.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs/nest-guide

---

📜 Recent review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 33aaf34 and 207a717.

📒 Files selected for processing (1)

• versioned_docs/version-3.x/recipe/nestjs.md (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• versioned_docs/version-3.x/recipe/nestjs.md

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b3c0096 and 33aaf34.

⛔ Files ignored due to path filters (1)

• versioned_docs/version-3.x/recipe/databases/_category_.yml is excluded by !**/*.yml

📒 Files selected for processing (13)

• code-repos/zenstackhq/v3-doc-orm (1 hunks)
• code-repos/zenstackhq/v3-doc-orm-computed-fields (1 hunks)
• code-repos/zenstackhq/v3-doc-orm-policy (1 hunks)
• code-repos/zenstackhq/v3-doc-orm-polymorphism (1 hunks)
• code-repos/zenstackhq/v3-doc-orm-typed-json (1 hunks)
• code-repos/zenstackhq/v3-doc-orm-validation (1 hunks)
• code-repos/zenstackhq/v3-doc-quick-start (1 hunks)
• code-repos/zenstackhq/v3-doc-server-adapter (1 hunks)
• code-repos/zenstackhq/v3-doc-tanstack-query (1 hunks)
• versioned_docs/version-3.x/migrate-prisma.md (2 hunks)
• versioned_docs/version-3.x/orm/client.md (2 hunks)
• versioned_docs/version-3.x/recipe/nestjs.md (1 hunks)
• versioned_docs/version-3.x/recipe/postgres-multi-schema.md (1 hunks)

🔇 Additional comments (14)

code-repos/zenstackhq/v3-doc-tanstack-query (1)

1-1: Submodule pointer update.

This is a routine submodule reference update pointing to a newer commit. Without access to the submodule repository itself, detailed code review of the commit pointer is not applicable. Ensure the submodule update aligns with the PR objectives and that all dependencies and documentation remain consistent.

code-repos/zenstackhq/v3-doc-orm-validation (1)

1-1: Submodule batch update — consistent across all nine v3-doc- repositories.*

This PR updates all nine v3-doc-* submodules in a single commit. The v3-doc-orm-validation pointer changes from 42aa1d6 to 20014ef, alongside parallel updates to orm, orm-computed-fields, orm-policy, orm-polymorphism, orm-typed-json, quick-start, server-adapter, and tanstack-query. Batching submodule updates this way is the right approach and keeps the documentation repositories in sync. The commit message "docs: nestjs guide for v3" aligns with the stated purpose of these changes.

code-repos/zenstackhq/v3-doc-orm-policy (1)

1-1: Submodule pointer update aligns with PR objectives.

This commit pointer update is part of the coordinated documentation refresh for the v3 NestJS guide. The change is consistent with the other submodule updates mentioned in the PR summary.

code-repos/zenstackhq/v3-doc-server-adapter (1)

1-1: Remove unverifiable speculative claims and provide actionable feedback only if concrete issues can be identified.

The review cannot reliably verify the submodule commit or broader PR scope without direct access to the repository or complete PR context. Reframe any feedback to focus only on observable facts: this is a submodule pointer update in the v3-doc-server-adapter repository that aligns with documentation maintenance work mentioned in the PR summary.

versioned_docs/version-3.x/recipe/postgres-multi-schema.md (1)

2-2: Sidebar position update looks good.

The change to reorder this recipe to position 3 aligns with the PR objective of adding a NestJS guide. The existing content is accurate and well-structured.

code-repos/zenstackhq/v3-doc-orm-computed-fields (1)

1-1: Submodule pointer update looks good.

This is a routine documentation submodule commit reference update, consistent with other coordinated updates in the PR for v3 documentation. No code review concerns apply to Git submodule pointer changes.

code-repos/zenstackhq/v3-doc-orm-polymorphism (1)

1-1: Submodule pointer updated; verify intended documentation changes are included.

This change updates the submodule pointer to a new commit. However, the substantive documentation changes (NestJS guide, import path updates, sidebar adjustments) exist in the referenced submodule repository and cannot be assessed from the pointer reference alone.

Confirm that commit 3ef64e7d2a66d8bdfbf3c0ad379f4db9fea0aac1 in the zenstackhq/v3-doc-orm-polymorphism repository includes all intended changes described in the PR objectives.

code-repos/zenstackhq/v3-doc-orm (1)

1-1: Submodule update is consistent with PR objective.

This change updates the v3-doc-orm documentation submodule pointer for the NestJS guide additions. The update aligns with ZenStack's documented NestJS integration support. Ensure related documentation changes have been merged to the submodule repository before merging this PR.

code-repos/zenstackhq/v3-doc-quick-start (1)

1-1: Submodule update to ZenStack V3 documentation is reasonable but cannot be fully verified in isolation.

The submodule pointer update to commit 64d688f0b0908a5526e88eae5015a5615023fe3d is consistent with ZenStack V3's documented architectural changes (Kysely-based ORM engine replacing Prisma) and the addition of NestJS integration guides. However, the actual content changes within the submodule cannot be reviewed from the diff alone. The update aligns with the broader ZenStack V3 initiative to replace Prisma with a Kysely-based ORM implementation while maintaining API compatibility.

Verify that:

• The submodule commit exists and is reachable in the remote repository
• The documentation builds successfully after the update

code-repos/zenstackhq/v3-doc-orm-typed-json (1)

1-1: Submodule pointer update looks good.

Routine update to the latest commit of the v3-doc-orm-typed-json documentation submodule as part of the broader submodule maintenance effort.

versioned_docs/version-3.x/recipe/nestjs.md (2)

1-61: Plain ORM section is well-structured.

The examples demonstrate proper DbService extension, module registration, and controller injection. All imports are correctly sourced from @zenstackhq/orm packages.

---

63-123: Verify plugin chaining API on line 97.

The code chains db.$use(new PolicyPlugin()).$setAuth(user) to apply access control. Confirm that the $use() method returns an object with a $setAuth() method as documented in the ZenStack API.

versioned_docs/version-3.x/orm/client.md (1)

27-59: Import path updates are correct and consistent.

The dialect imports have been updated to use the ZenStack ORM dialect packages (@zenstackhq/orm/dialects/*) instead of Kysely. The usage patterns in the examples remain correct and unchanged.

versioned_docs/version-3.x/migrate-prisma.md (1)

87-122: Import path updates are consistent with other documentation.

The dialect imports have been updated to @zenstackhq/orm/dialects/* packages in both PostgreSQL and SQLite examples. The initialization code remains correct and unchanged.