doc: update orm package name - #501

Merged
ymc9 merged 7 commits into
mainfrom
docs/qaas-v3
Nov 1, 2025
Merged

doc: update orm package name#501
ymc9 merged 7 commits into
mainfrom
docs/qaas-v3

Conversation

@ymc9

@ymc9ymc9 commented Nov 1, 2025

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Documentation
    • Updated version 3.x documentation across migration guides, API references, and plugin documentation to reflect that ZenStack client imports and type definitions are now sourced from the ORM package. Updated code examples and dependency installation instructions to guide developers on correct package imports and setup procedures.

@vercel

vercelBot commented Nov 1, 2025

Copy link
Copy Markdown

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

ProjectDeploymentPreviewCommentsUpdated (UTC)
zenstack-new-siteReadyReadyPreviewCommentNov 1, 2025 1:35am

@coderabbitai

Copy link
Copy Markdown
Contributor

Walkthrough

Documentation updates reflecting a package migration from @zenstackhq/runtime to @zenstackhq/orm across multiple ORM-related documentation files, including import examples, dependency declarations, and module references in version 3.x documentation.

Changes

Cohort / File(s)Change Summary
Package dependency and import updates
versioned_docs/version-3.x/migrate-prisma.md, versioned_docs/version-3.x/orm/quick-start.md
Updated package dependency from @zenstackhq/runtime to @zenstackhq/orm in installation and setup sections.
ZenStackClient import path updates
versioned_docs/version-3.x/orm/access-control/query.md, versioned_docs/version-3.x/orm/client.md, versioned_docs/version-3.x/reference/plugins/policy.md
Changed ZenStackClient import source from @zenstackhq/runtime to @zenstackhq/orm in code examples.
Type import path updates
versioned_docs/version-3.x/orm/client.md
Updated ClientContract type import from @zenstackhq/runtime to @zenstackhq/orm.
Module reference updates
versioned_docs/version-3.x/orm/errors.md, versioned_docs/version-3.x/orm/inferred-types.md, versioned_docs/version-3.x/reference/api.md, versioned_docs/version-3.x/reference/zmodel/attribute.md
Updated referenced module and import paths from @zenstackhq/runtime to @zenstackhq/orm in error, type, and metadata documentation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • All changes are documentation-only with highly homogeneous patterns (consistent package reference updates)
  • No functional logic, behavior changes, or complex reasoning required per file
  • Large scope (9 files) is offset by repetitive nature of edits (same refactoring applied uniformly)

Possibly related PRs

  • zenstack-docs#495: Updates documentation referencing the same public symbols (ZenStackClient) and package import paths in version-3.x docs.

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title Check✅ PassedThe pull request title "doc: update orm package name" is directly related to the changeset. All nine modified files are documentation files that systematically update import paths and package references from @zenstackhq/runtime to @zenstackhq/orm across multiple sections (migration guides, ORM documentation, API references, and zmodel attributes). The title clearly identifies that this is a documentation change focused on updating the ORM package references, which accurately captures the main objective of the PR. The use of the "doc:" prefix follows conventional commit message formatting and effectively conveys that this is a documentation-only change.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/qaas-v3

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 685bab3 and d3c7551.

📒 Files selected for processing (9)
  • versioned_docs/version-3.x/migrate-prisma.md (3 hunks)
  • versioned_docs/version-3.x/orm/access-control/query.md (1 hunks)
  • versioned_docs/version-3.x/orm/client.md (3 hunks)
  • versioned_docs/version-3.x/orm/errors.md (1 hunks)
  • versioned_docs/version-3.x/orm/inferred-types.md (1 hunks)
  • versioned_docs/version-3.x/orm/quick-start.md (1 hunks)
  • versioned_docs/version-3.x/reference/api.md (1 hunks)
  • versioned_docs/version-3.x/reference/plugins/policy.md (1 hunks)
  • versioned_docs/version-3.x/reference/zmodel/attribute.md (2 hunks)
🔇 Additional comments (9)
versioned_docs/version-3.x/orm/inferred-types.md (1)

22-22: Approve package reference update.

The ModelResult import path is correctly updated to reflect the new package organization.

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

49-49: Approve dependency update.

The manual setup dependency correctly references the new @zenstackhq/orm@next package.

versioned_docs/version-3.x/reference/zmodel/attribute.md (1)

368-368: Approve model-meta import path updates.

Both model-level and field-level @meta attribute documentation correctly reference the new @zenstackhq/orm/model-meta package path.

Also applies to: 485-485

versioned_docs/version-3.x/reference/api.md (1)

9-9: Approve API reference header update.

The API reference section correctly identifies the package as @zenstackhq/orm.

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

8-8: Approve error module reference update.

The error classes documentation correctly references the new @zenstackhq/orm package.

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

35-35: Approve migration guide package updates.

All three package references are correctly updated: the main dependency (line 35) and both database-specific import examples (PostgreSQL and SQLite tabs at lines 90 and 108).

Also applies to: 90-90, 108-108

versioned_docs/version-3.x/reference/plugins/policy.md (1)

149-149: Approve runtime plugin example update.

The policy plugin usage example correctly imports ZenStackClient from @zenstackhq/orm.

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

28-28: Approve database client documentation updates.

All package references are correctly updated across both database examples (SQLite and PostgreSQL) and the type import example. The ZenStackClient and ClientContract imports now reference @zenstackhq/orm.

Also applies to: 46-46, 66-66

versioned_docs/version-3.x/orm/access-control/query.md (1)

16-16: Import path update is correct and consistently applied.

The change updating ZenStackClient import from @zenstackhq/runtime to @zenstackhq/orm has been verified as complete and consistent across all related documentation files. No remaining references to the old package name were found in the ORM documentation, migration guide, or reference sections.


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

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

@ymc9
ymc9 merged commit 38efdf7 into mainNov 1, 2025
4 checks passed
@ymc9
ymc9 deleted the docs/qaas-v3 branch November 1, 2025 01:36
@coderabbitaicoderabbitaiBot mentioned this pull request Dec 18, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@ymc9
, '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

Merged
ymc9 merged 7 commits into
mainfrom
docs/qaas-v3
Nov 1, 2025
Merged

doc: update orm package name#501
ymc9 merged 7 commits into
mainfrom
docs/qaas-v3

Conversation

@ymc9

@ymc9ymc9 commented Nov 1, 2025

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Documentation
    • Updated version 3.x documentation across migration guides, API references, and plugin documentation to reflect that ZenStack client imports and type definitions are now sourced from the ORM package. Updated code examples and dependency installation instructions to guide developers on correct package imports and setup procedures.

@vercel

vercelBot commented Nov 1, 2025

Copy link
Copy Markdown

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

ProjectDeploymentPreviewCommentsUpdated (UTC)
zenstack-new-siteReadyReadyPreviewCommentNov 1, 2025 1:35am

@coderabbitai

Copy link
Copy Markdown
Contributor

Walkthrough

Documentation updates reflecting a package migration from @zenstackhq/runtime to @zenstackhq/orm across multiple ORM-related documentation files, including import examples, dependency declarations, and module references in version 3.x documentation.

Changes

Cohort / File(s)Change Summary
Package dependency and import updates
versioned_docs/version-3.x/migrate-prisma.md, versioned_docs/version-3.x/orm/quick-start.md
Updated package dependency from @zenstackhq/runtime to @zenstackhq/orm in installation and setup sections.
ZenStackClient import path updates
versioned_docs/version-3.x/orm/access-control/query.md, versioned_docs/version-3.x/orm/client.md, versioned_docs/version-3.x/reference/plugins/policy.md
Changed ZenStackClient import source from @zenstackhq/runtime to @zenstackhq/orm in code examples.
Type import path updates
versioned_docs/version-3.x/orm/client.md
Updated ClientContract type import from @zenstackhq/runtime to @zenstackhq/orm.
Module reference updates
versioned_docs/version-3.x/orm/errors.md, versioned_docs/version-3.x/orm/inferred-types.md, versioned_docs/version-3.x/reference/api.md, versioned_docs/version-3.x/reference/zmodel/attribute.md
Updated referenced module and import paths from @zenstackhq/runtime to @zenstackhq/orm in error, type, and metadata documentation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • All changes are documentation-only with highly homogeneous patterns (consistent package reference updates)
  • No functional logic, behavior changes, or complex reasoning required per file
  • Large scope (9 files) is offset by repetitive nature of edits (same refactoring applied uniformly)

Possibly related PRs

  • zenstack-docs#495: Updates documentation referencing the same public symbols (ZenStackClient) and package import paths in version-3.x docs.

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title Check✅ PassedThe pull request title "doc: update orm package name" is directly related to the changeset. All nine modified files are documentation files that systematically update import paths and package references from @zenstackhq/runtime to @zenstackhq/orm across multiple sections (migration guides, ORM documentation, API references, and zmodel attributes). The title clearly identifies that this is a documentation change focused on updating the ORM package references, which accurately captures the main objective of the PR. The use of the "doc:" prefix follows conventional commit message formatting and effectively conveys that this is a documentation-only change.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/qaas-v3

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 685bab3 and d3c7551.

📒 Files selected for processing (9)
  • versioned_docs/version-3.x/migrate-prisma.md (3 hunks)
  • versioned_docs/version-3.x/orm/access-control/query.md (1 hunks)
  • versioned_docs/version-3.x/orm/client.md (3 hunks)
  • versioned_docs/version-3.x/orm/errors.md (1 hunks)
  • versioned_docs/version-3.x/orm/inferred-types.md (1 hunks)
  • versioned_docs/version-3.x/orm/quick-start.md (1 hunks)
  • versioned_docs/version-3.x/reference/api.md (1 hunks)
  • versioned_docs/version-3.x/reference/plugins/policy.md (1 hunks)
  • versioned_docs/version-3.x/reference/zmodel/attribute.md (2 hunks)
🔇 Additional comments (9)
versioned_docs/version-3.x/orm/inferred-types.md (1)

22-22: Approve package reference update.

The ModelResult import path is correctly updated to reflect the new package organization.

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

49-49: Approve dependency update.

The manual setup dependency correctly references the new @zenstackhq/orm@next package.

versioned_docs/version-3.x/reference/zmodel/attribute.md (1)

368-368: Approve model-meta import path updates.

Both model-level and field-level @meta attribute documentation correctly reference the new @zenstackhq/orm/model-meta package path.

Also applies to: 485-485

versioned_docs/version-3.x/reference/api.md (1)

9-9: Approve API reference header update.

The API reference section correctly identifies the package as @zenstackhq/orm.

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

8-8: Approve error module reference update.

The error classes documentation correctly references the new @zenstackhq/orm package.

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

35-35: Approve migration guide package updates.

All three package references are correctly updated: the main dependency (line 35) and both database-specific import examples (PostgreSQL and SQLite tabs at lines 90 and 108).

Also applies to: 90-90, 108-108

versioned_docs/version-3.x/reference/plugins/policy.md (1)

149-149: Approve runtime plugin example update.

The policy plugin usage example correctly imports ZenStackClient from @zenstackhq/orm.

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

28-28: Approve database client documentation updates.

All package references are correctly updated across both database examples (SQLite and PostgreSQL) and the type import example. The ZenStackClient and ClientContract imports now reference @zenstackhq/orm.

Also applies to: 46-46, 66-66

versioned_docs/version-3.x/orm/access-control/query.md (1)

16-16: Import path update is correct and consistently applied.

The change updating ZenStackClient import from @zenstackhq/runtime to @zenstackhq/orm has been verified as complete and consistent across all related documentation files. No remaining references to the old package name were found in the ORM documentation, migration guide, or reference sections.


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

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

@ymc9
ymc9 merged commit 38efdf7 into mainNov 1, 2025
4 checks passed
@ymc9
ymc9 deleted the docs/qaas-v3 branch November 1, 2025 01:36
@coderabbitaicoderabbitaiBot mentioned this pull request Dec 18, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@ymc9
, '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

Merged
ymc9 merged 7 commits into
mainfrom
docs/qaas-v3
Nov 1, 2025
Merged

doc: update orm package name#501
ymc9 merged 7 commits into
mainfrom
docs/qaas-v3

Conversation

@ymc9

@ymc9ymc9 commented Nov 1, 2025

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Documentation
    • Updated version 3.x documentation across migration guides, API references, and plugin documentation to reflect that ZenStack client imports and type definitions are now sourced from the ORM package. Updated code examples and dependency installation instructions to guide developers on correct package imports and setup procedures.

@vercel

vercelBot commented Nov 1, 2025

Copy link
Copy Markdown

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

ProjectDeploymentPreviewCommentsUpdated (UTC)
zenstack-new-siteReadyReadyPreviewCommentNov 1, 2025 1:35am

@coderabbitai

Copy link
Copy Markdown
Contributor

Walkthrough

Documentation updates reflecting a package migration from @zenstackhq/runtime to @zenstackhq/orm across multiple ORM-related documentation files, including import examples, dependency declarations, and module references in version 3.x documentation.

Changes

Cohort / File(s)Change Summary
Package dependency and import updates
versioned_docs/version-3.x/migrate-prisma.md, versioned_docs/version-3.x/orm/quick-start.md
Updated package dependency from @zenstackhq/runtime to @zenstackhq/orm in installation and setup sections.
ZenStackClient import path updates
versioned_docs/version-3.x/orm/access-control/query.md, versioned_docs/version-3.x/orm/client.md, versioned_docs/version-3.x/reference/plugins/policy.md
Changed ZenStackClient import source from @zenstackhq/runtime to @zenstackhq/orm in code examples.
Type import path updates
versioned_docs/version-3.x/orm/client.md
Updated ClientContract type import from @zenstackhq/runtime to @zenstackhq/orm.
Module reference updates
versioned_docs/version-3.x/orm/errors.md, versioned_docs/version-3.x/orm/inferred-types.md, versioned_docs/version-3.x/reference/api.md, versioned_docs/version-3.x/reference/zmodel/attribute.md
Updated referenced module and import paths from @zenstackhq/runtime to @zenstackhq/orm in error, type, and metadata documentation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • All changes are documentation-only with highly homogeneous patterns (consistent package reference updates)
  • No functional logic, behavior changes, or complex reasoning required per file
  • Large scope (9 files) is offset by repetitive nature of edits (same refactoring applied uniformly)

Possibly related PRs

  • zenstack-docs#495: Updates documentation referencing the same public symbols (ZenStackClient) and package import paths in version-3.x docs.

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title Check✅ PassedThe pull request title "doc: update orm package name" is directly related to the changeset. All nine modified files are documentation files that systematically update import paths and package references from @zenstackhq/runtime to @zenstackhq/orm across multiple sections (migration guides, ORM documentation, API references, and zmodel attributes). The title clearly identifies that this is a documentation change focused on updating the ORM package references, which accurately captures the main objective of the PR. The use of the "doc:" prefix follows conventional commit message formatting and effectively conveys that this is a documentation-only change.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/qaas-v3

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 685bab3 and d3c7551.

📒 Files selected for processing (9)
  • versioned_docs/version-3.x/migrate-prisma.md (3 hunks)
  • versioned_docs/version-3.x/orm/access-control/query.md (1 hunks)
  • versioned_docs/version-3.x/orm/client.md (3 hunks)
  • versioned_docs/version-3.x/orm/errors.md (1 hunks)
  • versioned_docs/version-3.x/orm/inferred-types.md (1 hunks)
  • versioned_docs/version-3.x/orm/quick-start.md (1 hunks)
  • versioned_docs/version-3.x/reference/api.md (1 hunks)
  • versioned_docs/version-3.x/reference/plugins/policy.md (1 hunks)
  • versioned_docs/version-3.x/reference/zmodel/attribute.md (2 hunks)
🔇 Additional comments (9)
versioned_docs/version-3.x/orm/inferred-types.md (1)

22-22: Approve package reference update.

The ModelResult import path is correctly updated to reflect the new package organization.

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

49-49: Approve dependency update.

The manual setup dependency correctly references the new @zenstackhq/orm@next package.

versioned_docs/version-3.x/reference/zmodel/attribute.md (1)

368-368: Approve model-meta import path updates.

Both model-level and field-level @meta attribute documentation correctly reference the new @zenstackhq/orm/model-meta package path.

Also applies to: 485-485

versioned_docs/version-3.x/reference/api.md (1)

9-9: Approve API reference header update.

The API reference section correctly identifies the package as @zenstackhq/orm.

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

8-8: Approve error module reference update.

The error classes documentation correctly references the new @zenstackhq/orm package.

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

35-35: Approve migration guide package updates.

All three package references are correctly updated: the main dependency (line 35) and both database-specific import examples (PostgreSQL and SQLite tabs at lines 90 and 108).

Also applies to: 90-90, 108-108

versioned_docs/version-3.x/reference/plugins/policy.md (1)

149-149: Approve runtime plugin example update.

The policy plugin usage example correctly imports ZenStackClient from @zenstackhq/orm.

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

28-28: Approve database client documentation updates.

All package references are correctly updated across both database examples (SQLite and PostgreSQL) and the type import example. The ZenStackClient and ClientContract imports now reference @zenstackhq/orm.

Also applies to: 46-46, 66-66

versioned_docs/version-3.x/orm/access-control/query.md (1)

16-16: Import path update is correct and consistently applied.

The change updating ZenStackClient import from @zenstackhq/runtime to @zenstackhq/orm has been verified as complete and consistent across all related documentation files. No remaining references to the old package name were found in the ORM documentation, migration guide, or reference sections.


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

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

@ymc9
ymc9 merged commit 38efdf7 into mainNov 1, 2025
4 checks passed
@ymc9
ymc9 deleted the docs/qaas-v3 branch November 1, 2025 01:36
@coderabbitaicoderabbitaiBot mentioned this pull request Dec 18, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@ymc9
, '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

Merged
ymc9 merged 7 commits into
mainfrom
docs/qaas-v3
Nov 1, 2025
Merged

doc: update orm package name#501
ymc9 merged 7 commits into
mainfrom
docs/qaas-v3

Conversation

@ymc9

@ymc9ymc9 commented Nov 1, 2025

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Documentation
    • Updated version 3.x documentation across migration guides, API references, and plugin documentation to reflect that ZenStack client imports and type definitions are now sourced from the ORM package. Updated code examples and dependency installation instructions to guide developers on correct package imports and setup procedures.

@vercel

vercelBot commented Nov 1, 2025

Copy link
Copy Markdown

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

ProjectDeploymentPreviewCommentsUpdated (UTC)
zenstack-new-siteReadyReadyPreviewCommentNov 1, 2025 1:35am

@coderabbitai

Copy link
Copy Markdown
Contributor

Walkthrough

Documentation updates reflecting a package migration from @zenstackhq/runtime to @zenstackhq/orm across multiple ORM-related documentation files, including import examples, dependency declarations, and module references in version 3.x documentation.

Changes

Cohort / File(s)Change Summary
Package dependency and import updates
versioned_docs/version-3.x/migrate-prisma.md, versioned_docs/version-3.x/orm/quick-start.md
Updated package dependency from @zenstackhq/runtime to @zenstackhq/orm in installation and setup sections.
ZenStackClient import path updates
versioned_docs/version-3.x/orm/access-control/query.md, versioned_docs/version-3.x/orm/client.md, versioned_docs/version-3.x/reference/plugins/policy.md
Changed ZenStackClient import source from @zenstackhq/runtime to @zenstackhq/orm in code examples.
Type import path updates
versioned_docs/version-3.x/orm/client.md
Updated ClientContract type import from @zenstackhq/runtime to @zenstackhq/orm.
Module reference updates
versioned_docs/version-3.x/orm/errors.md, versioned_docs/version-3.x/orm/inferred-types.md, versioned_docs/version-3.x/reference/api.md, versioned_docs/version-3.x/reference/zmodel/attribute.md
Updated referenced module and import paths from @zenstackhq/runtime to @zenstackhq/orm in error, type, and metadata documentation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • All changes are documentation-only with highly homogeneous patterns (consistent package reference updates)
  • No functional logic, behavior changes, or complex reasoning required per file
  • Large scope (9 files) is offset by repetitive nature of edits (same refactoring applied uniformly)

Possibly related PRs

  • zenstack-docs#495: Updates documentation referencing the same public symbols (ZenStackClient) and package import paths in version-3.x docs.

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title Check✅ PassedThe pull request title "doc: update orm package name" is directly related to the changeset. All nine modified files are documentation files that systematically update import paths and package references from @zenstackhq/runtime to @zenstackhq/orm across multiple sections (migration guides, ORM documentation, API references, and zmodel attributes). The title clearly identifies that this is a documentation change focused on updating the ORM package references, which accurately captures the main objective of the PR. The use of the "doc:" prefix follows conventional commit message formatting and effectively conveys that this is a documentation-only change.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/qaas-v3

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 685bab3 and d3c7551.

📒 Files selected for processing (9)
  • versioned_docs/version-3.x/migrate-prisma.md (3 hunks)
  • versioned_docs/version-3.x/orm/access-control/query.md (1 hunks)
  • versioned_docs/version-3.x/orm/client.md (3 hunks)
  • versioned_docs/version-3.x/orm/errors.md (1 hunks)
  • versioned_docs/version-3.x/orm/inferred-types.md (1 hunks)
  • versioned_docs/version-3.x/orm/quick-start.md (1 hunks)
  • versioned_docs/version-3.x/reference/api.md (1 hunks)
  • versioned_docs/version-3.x/reference/plugins/policy.md (1 hunks)
  • versioned_docs/version-3.x/reference/zmodel/attribute.md (2 hunks)
🔇 Additional comments (9)
versioned_docs/version-3.x/orm/inferred-types.md (1)

22-22: Approve package reference update.

The ModelResult import path is correctly updated to reflect the new package organization.

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

49-49: Approve dependency update.

The manual setup dependency correctly references the new @zenstackhq/orm@next package.

versioned_docs/version-3.x/reference/zmodel/attribute.md (1)

368-368: Approve model-meta import path updates.

Both model-level and field-level @meta attribute documentation correctly reference the new @zenstackhq/orm/model-meta package path.

Also applies to: 485-485

versioned_docs/version-3.x/reference/api.md (1)

9-9: Approve API reference header update.

The API reference section correctly identifies the package as @zenstackhq/orm.

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

8-8: Approve error module reference update.

The error classes documentation correctly references the new @zenstackhq/orm package.

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

35-35: Approve migration guide package updates.

All three package references are correctly updated: the main dependency (line 35) and both database-specific import examples (PostgreSQL and SQLite tabs at lines 90 and 108).

Also applies to: 90-90, 108-108

versioned_docs/version-3.x/reference/plugins/policy.md (1)

149-149: Approve runtime plugin example update.

The policy plugin usage example correctly imports ZenStackClient from @zenstackhq/orm.

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

28-28: Approve database client documentation updates.

All package references are correctly updated across both database examples (SQLite and PostgreSQL) and the type import example. The ZenStackClient and ClientContract imports now reference @zenstackhq/orm.

Also applies to: 46-46, 66-66

versioned_docs/version-3.x/orm/access-control/query.md (1)

16-16: Import path update is correct and consistently applied.

The change updating ZenStackClient import from @zenstackhq/runtime to @zenstackhq/orm has been verified as complete and consistent across all related documentation files. No remaining references to the old package name were found in the ORM documentation, migration guide, or reference sections.


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

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

@ymc9
ymc9 merged commit 38efdf7 into mainNov 1, 2025
4 checks passed
@ymc9
ymc9 deleted the docs/qaas-v3 branch November 1, 2025 01:36
@coderabbitaicoderabbitaiBot mentioned this pull request Dec 18, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@ymc9
, '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

Merged
ymc9 merged 7 commits into
mainfrom
docs/qaas-v3
Nov 1, 2025
Merged

doc: update orm package name#501
ymc9 merged 7 commits into
mainfrom
docs/qaas-v3

Conversation

@ymc9

@ymc9ymc9 commented Nov 1, 2025

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Documentation
    • Updated version 3.x documentation across migration guides, API references, and plugin documentation to reflect that ZenStack client imports and type definitions are now sourced from the ORM package. Updated code examples and dependency installation instructions to guide developers on correct package imports and setup procedures.

@vercel

vercelBot commented Nov 1, 2025

Copy link
Copy Markdown

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

ProjectDeploymentPreviewCommentsUpdated (UTC)
zenstack-new-siteReadyReadyPreviewCommentNov 1, 2025 1:35am

@coderabbitai

Copy link
Copy Markdown
Contributor

Walkthrough

Documentation updates reflecting a package migration from @zenstackhq/runtime to @zenstackhq/orm across multiple ORM-related documentation files, including import examples, dependency declarations, and module references in version 3.x documentation.

Changes

Cohort / File(s)Change Summary
Package dependency and import updates
versioned_docs/version-3.x/migrate-prisma.md, versioned_docs/version-3.x/orm/quick-start.md
Updated package dependency from @zenstackhq/runtime to @zenstackhq/orm in installation and setup sections.
ZenStackClient import path updates
versioned_docs/version-3.x/orm/access-control/query.md, versioned_docs/version-3.x/orm/client.md, versioned_docs/version-3.x/reference/plugins/policy.md
Changed ZenStackClient import source from @zenstackhq/runtime to @zenstackhq/orm in code examples.
Type import path updates
versioned_docs/version-3.x/orm/client.md
Updated ClientContract type import from @zenstackhq/runtime to @zenstackhq/orm.
Module reference updates
versioned_docs/version-3.x/orm/errors.md, versioned_docs/version-3.x/orm/inferred-types.md, versioned_docs/version-3.x/reference/api.md, versioned_docs/version-3.x/reference/zmodel/attribute.md
Updated referenced module and import paths from @zenstackhq/runtime to @zenstackhq/orm in error, type, and metadata documentation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • All changes are documentation-only with highly homogeneous patterns (consistent package reference updates)
  • No functional logic, behavior changes, or complex reasoning required per file
  • Large scope (9 files) is offset by repetitive nature of edits (same refactoring applied uniformly)

Possibly related PRs

  • zenstack-docs#495: Updates documentation referencing the same public symbols (ZenStackClient) and package import paths in version-3.x docs.

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title Check✅ PassedThe pull request title "doc: update orm package name" is directly related to the changeset. All nine modified files are documentation files that systematically update import paths and package references from @zenstackhq/runtime to @zenstackhq/orm across multiple sections (migration guides, ORM documentation, API references, and zmodel attributes). The title clearly identifies that this is a documentation change focused on updating the ORM package references, which accurately captures the main objective of the PR. The use of the "doc:" prefix follows conventional commit message formatting and effectively conveys that this is a documentation-only change.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/qaas-v3

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 685bab3 and d3c7551.

📒 Files selected for processing (9)
  • versioned_docs/version-3.x/migrate-prisma.md (3 hunks)
  • versioned_docs/version-3.x/orm/access-control/query.md (1 hunks)
  • versioned_docs/version-3.x/orm/client.md (3 hunks)
  • versioned_docs/version-3.x/orm/errors.md (1 hunks)
  • versioned_docs/version-3.x/orm/inferred-types.md (1 hunks)
  • versioned_docs/version-3.x/orm/quick-start.md (1 hunks)
  • versioned_docs/version-3.x/reference/api.md (1 hunks)
  • versioned_docs/version-3.x/reference/plugins/policy.md (1 hunks)
  • versioned_docs/version-3.x/reference/zmodel/attribute.md (2 hunks)
🔇 Additional comments (9)
versioned_docs/version-3.x/orm/inferred-types.md (1)

22-22: Approve package reference update.

The ModelResult import path is correctly updated to reflect the new package organization.

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

49-49: Approve dependency update.

The manual setup dependency correctly references the new @zenstackhq/orm@next package.

versioned_docs/version-3.x/reference/zmodel/attribute.md (1)

368-368: Approve model-meta import path updates.

Both model-level and field-level @meta attribute documentation correctly reference the new @zenstackhq/orm/model-meta package path.

Also applies to: 485-485

versioned_docs/version-3.x/reference/api.md (1)

9-9: Approve API reference header update.

The API reference section correctly identifies the package as @zenstackhq/orm.

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

8-8: Approve error module reference update.

The error classes documentation correctly references the new @zenstackhq/orm package.

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

35-35: Approve migration guide package updates.

All three package references are correctly updated: the main dependency (line 35) and both database-specific import examples (PostgreSQL and SQLite tabs at lines 90 and 108).

Also applies to: 90-90, 108-108

versioned_docs/version-3.x/reference/plugins/policy.md (1)

149-149: Approve runtime plugin example update.

The policy plugin usage example correctly imports ZenStackClient from @zenstackhq/orm.

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

28-28: Approve database client documentation updates.

All package references are correctly updated across both database examples (SQLite and PostgreSQL) and the type import example. The ZenStackClient and ClientContract imports now reference @zenstackhq/orm.

Also applies to: 46-46, 66-66

versioned_docs/version-3.x/orm/access-control/query.md (1)

16-16: Import path update is correct and consistently applied.

The change updating ZenStackClient import from @zenstackhq/runtime to @zenstackhq/orm has been verified as complete and consistent across all related documentation files. No remaining references to the old package name were found in the ORM documentation, migration guide, or reference sections.


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

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

@ymc9
ymc9 merged commit 38efdf7 into mainNov 1, 2025
4 checks passed
@ymc9
ymc9 deleted the docs/qaas-v3 branch November 1, 2025 01:36
@coderabbitaicoderabbitaiBot mentioned this pull request Dec 18, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@ymc9
, '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

Merged
ymc9 merged 7 commits into
mainfrom
docs/qaas-v3
Nov 1, 2025
Merged

doc: update orm package name#501
ymc9 merged 7 commits into
mainfrom
docs/qaas-v3

Conversation

@ymc9

@ymc9ymc9 commented Nov 1, 2025

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Documentation
    • Updated version 3.x documentation across migration guides, API references, and plugin documentation to reflect that ZenStack client imports and type definitions are now sourced from the ORM package. Updated code examples and dependency installation instructions to guide developers on correct package imports and setup procedures.

@vercel

vercelBot commented Nov 1, 2025

Copy link
Copy Markdown

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

ProjectDeploymentPreviewCommentsUpdated (UTC)
zenstack-new-siteReadyReadyPreviewCommentNov 1, 2025 1:35am

@coderabbitai

Copy link
Copy Markdown
Contributor

Walkthrough

Documentation updates reflecting a package migration from @zenstackhq/runtime to @zenstackhq/orm across multiple ORM-related documentation files, including import examples, dependency declarations, and module references in version 3.x documentation.

Changes

Cohort / File(s)Change Summary
Package dependency and import updates
versioned_docs/version-3.x/migrate-prisma.md, versioned_docs/version-3.x/orm/quick-start.md
Updated package dependency from @zenstackhq/runtime to @zenstackhq/orm in installation and setup sections.
ZenStackClient import path updates
versioned_docs/version-3.x/orm/access-control/query.md, versioned_docs/version-3.x/orm/client.md, versioned_docs/version-3.x/reference/plugins/policy.md
Changed ZenStackClient import source from @zenstackhq/runtime to @zenstackhq/orm in code examples.
Type import path updates
versioned_docs/version-3.x/orm/client.md
Updated ClientContract type import from @zenstackhq/runtime to @zenstackhq/orm.
Module reference updates
versioned_docs/version-3.x/orm/errors.md, versioned_docs/version-3.x/orm/inferred-types.md, versioned_docs/version-3.x/reference/api.md, versioned_docs/version-3.x/reference/zmodel/attribute.md
Updated referenced module and import paths from @zenstackhq/runtime to @zenstackhq/orm in error, type, and metadata documentation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • All changes are documentation-only with highly homogeneous patterns (consistent package reference updates)
  • No functional logic, behavior changes, or complex reasoning required per file
  • Large scope (9 files) is offset by repetitive nature of edits (same refactoring applied uniformly)

Possibly related PRs

  • zenstack-docs#495: Updates documentation referencing the same public symbols (ZenStackClient) and package import paths in version-3.x docs.

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title Check✅ PassedThe pull request title "doc: update orm package name" is directly related to the changeset. All nine modified files are documentation files that systematically update import paths and package references from @zenstackhq/runtime to @zenstackhq/orm across multiple sections (migration guides, ORM documentation, API references, and zmodel attributes). The title clearly identifies that this is a documentation change focused on updating the ORM package references, which accurately captures the main objective of the PR. The use of the "doc:" prefix follows conventional commit message formatting and effectively conveys that this is a documentation-only change.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/qaas-v3

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 685bab3 and d3c7551.

📒 Files selected for processing (9)
  • versioned_docs/version-3.x/migrate-prisma.md (3 hunks)
  • versioned_docs/version-3.x/orm/access-control/query.md (1 hunks)
  • versioned_docs/version-3.x/orm/client.md (3 hunks)
  • versioned_docs/version-3.x/orm/errors.md (1 hunks)
  • versioned_docs/version-3.x/orm/inferred-types.md (1 hunks)
  • versioned_docs/version-3.x/orm/quick-start.md (1 hunks)
  • versioned_docs/version-3.x/reference/api.md (1 hunks)
  • versioned_docs/version-3.x/reference/plugins/policy.md (1 hunks)
  • versioned_docs/version-3.x/reference/zmodel/attribute.md (2 hunks)
🔇 Additional comments (9)
versioned_docs/version-3.x/orm/inferred-types.md (1)

22-22: Approve package reference update.

The ModelResult import path is correctly updated to reflect the new package organization.

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

49-49: Approve dependency update.

The manual setup dependency correctly references the new @zenstackhq/orm@next package.

versioned_docs/version-3.x/reference/zmodel/attribute.md (1)

368-368: Approve model-meta import path updates.

Both model-level and field-level @meta attribute documentation correctly reference the new @zenstackhq/orm/model-meta package path.

Also applies to: 485-485

versioned_docs/version-3.x/reference/api.md (1)

9-9: Approve API reference header update.

The API reference section correctly identifies the package as @zenstackhq/orm.

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

8-8: Approve error module reference update.

The error classes documentation correctly references the new @zenstackhq/orm package.

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

35-35: Approve migration guide package updates.

All three package references are correctly updated: the main dependency (line 35) and both database-specific import examples (PostgreSQL and SQLite tabs at lines 90 and 108).

Also applies to: 90-90, 108-108

versioned_docs/version-3.x/reference/plugins/policy.md (1)

149-149: Approve runtime plugin example update.

The policy plugin usage example correctly imports ZenStackClient from @zenstackhq/orm.

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

28-28: Approve database client documentation updates.

All package references are correctly updated across both database examples (SQLite and PostgreSQL) and the type import example. The ZenStackClient and ClientContract imports now reference @zenstackhq/orm.

Also applies to: 46-46, 66-66

versioned_docs/version-3.x/orm/access-control/query.md (1)

16-16: Import path update is correct and consistently applied.

The change updating ZenStackClient import from @zenstackhq/runtime to @zenstackhq/orm has been verified as complete and consistent across all related documentation files. No remaining references to the old package name were found in the ORM documentation, migration guide, or reference sections.


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

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

@ymc9
ymc9 merged commit 38efdf7 into mainNov 1, 2025
4 checks passed
@ymc9
ymc9 deleted the docs/qaas-v3 branch November 1, 2025 01:36
@coderabbitaicoderabbitaiBot mentioned this pull request Dec 18, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@ymc9
, '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

Merged
ymc9 merged 7 commits into
mainfrom
docs/qaas-v3
Nov 1, 2025
Merged

doc: update orm package name#501
ymc9 merged 7 commits into
mainfrom
docs/qaas-v3

Conversation

@ymc9

@ymc9ymc9 commented Nov 1, 2025

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Documentation
    • Updated version 3.x documentation across migration guides, API references, and plugin documentation to reflect that ZenStack client imports and type definitions are now sourced from the ORM package. Updated code examples and dependency installation instructions to guide developers on correct package imports and setup procedures.

@vercel

vercelBot commented Nov 1, 2025

Copy link
Copy Markdown

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

ProjectDeploymentPreviewCommentsUpdated (UTC)
zenstack-new-siteReadyReadyPreviewCommentNov 1, 2025 1:35am

@coderabbitai

Copy link
Copy Markdown
Contributor

Walkthrough

Documentation updates reflecting a package migration from @zenstackhq/runtime to @zenstackhq/orm across multiple ORM-related documentation files, including import examples, dependency declarations, and module references in version 3.x documentation.

Changes

Cohort / File(s)Change Summary
Package dependency and import updates
versioned_docs/version-3.x/migrate-prisma.md, versioned_docs/version-3.x/orm/quick-start.md
Updated package dependency from @zenstackhq/runtime to @zenstackhq/orm in installation and setup sections.
ZenStackClient import path updates
versioned_docs/version-3.x/orm/access-control/query.md, versioned_docs/version-3.x/orm/client.md, versioned_docs/version-3.x/reference/plugins/policy.md
Changed ZenStackClient import source from @zenstackhq/runtime to @zenstackhq/orm in code examples.
Type import path updates
versioned_docs/version-3.x/orm/client.md
Updated ClientContract type import from @zenstackhq/runtime to @zenstackhq/orm.
Module reference updates
versioned_docs/version-3.x/orm/errors.md, versioned_docs/version-3.x/orm/inferred-types.md, versioned_docs/version-3.x/reference/api.md, versioned_docs/version-3.x/reference/zmodel/attribute.md
Updated referenced module and import paths from @zenstackhq/runtime to @zenstackhq/orm in error, type, and metadata documentation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • All changes are documentation-only with highly homogeneous patterns (consistent package reference updates)
  • No functional logic, behavior changes, or complex reasoning required per file
  • Large scope (9 files) is offset by repetitive nature of edits (same refactoring applied uniformly)

Possibly related PRs

  • zenstack-docs#495: Updates documentation referencing the same public symbols (ZenStackClient) and package import paths in version-3.x docs.

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title Check✅ PassedThe pull request title "doc: update orm package name" is directly related to the changeset. All nine modified files are documentation files that systematically update import paths and package references from @zenstackhq/runtime to @zenstackhq/orm across multiple sections (migration guides, ORM documentation, API references, and zmodel attributes). The title clearly identifies that this is a documentation change focused on updating the ORM package references, which accurately captures the main objective of the PR. The use of the "doc:" prefix follows conventional commit message formatting and effectively conveys that this is a documentation-only change.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/qaas-v3

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 685bab3 and d3c7551.

📒 Files selected for processing (9)
  • versioned_docs/version-3.x/migrate-prisma.md (3 hunks)
  • versioned_docs/version-3.x/orm/access-control/query.md (1 hunks)
  • versioned_docs/version-3.x/orm/client.md (3 hunks)
  • versioned_docs/version-3.x/orm/errors.md (1 hunks)
  • versioned_docs/version-3.x/orm/inferred-types.md (1 hunks)
  • versioned_docs/version-3.x/orm/quick-start.md (1 hunks)
  • versioned_docs/version-3.x/reference/api.md (1 hunks)
  • versioned_docs/version-3.x/reference/plugins/policy.md (1 hunks)
  • versioned_docs/version-3.x/reference/zmodel/attribute.md (2 hunks)
🔇 Additional comments (9)
versioned_docs/version-3.x/orm/inferred-types.md (1)

22-22: Approve package reference update.

The ModelResult import path is correctly updated to reflect the new package organization.

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

49-49: Approve dependency update.

The manual setup dependency correctly references the new @zenstackhq/orm@next package.

versioned_docs/version-3.x/reference/zmodel/attribute.md (1)

368-368: Approve model-meta import path updates.

Both model-level and field-level @meta attribute documentation correctly reference the new @zenstackhq/orm/model-meta package path.

Also applies to: 485-485

versioned_docs/version-3.x/reference/api.md (1)

9-9: Approve API reference header update.

The API reference section correctly identifies the package as @zenstackhq/orm.

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

8-8: Approve error module reference update.

The error classes documentation correctly references the new @zenstackhq/orm package.

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

35-35: Approve migration guide package updates.

All three package references are correctly updated: the main dependency (line 35) and both database-specific import examples (PostgreSQL and SQLite tabs at lines 90 and 108).

Also applies to: 90-90, 108-108

versioned_docs/version-3.x/reference/plugins/policy.md (1)

149-149: Approve runtime plugin example update.

The policy plugin usage example correctly imports ZenStackClient from @zenstackhq/orm.

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

28-28: Approve database client documentation updates.

All package references are correctly updated across both database examples (SQLite and PostgreSQL) and the type import example. The ZenStackClient and ClientContract imports now reference @zenstackhq/orm.

Also applies to: 46-46, 66-66

versioned_docs/version-3.x/orm/access-control/query.md (1)

16-16: Import path update is correct and consistently applied.

The change updating ZenStackClient import from @zenstackhq/runtime to @zenstackhq/orm has been verified as complete and consistent across all related documentation files. No remaining references to the old package name were found in the ORM documentation, migration guide, or reference sections.


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

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

@ymc9
ymc9 merged commit 38efdf7 into mainNov 1, 2025
4 checks passed
@ymc9
ymc9 deleted the docs/qaas-v3 branch November 1, 2025 01:36
@coderabbitaicoderabbitaiBot mentioned this pull request Dec 18, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@ymc9
, '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

Merged
ymc9 merged 7 commits into
mainfrom
docs/qaas-v3
Nov 1, 2025
Merged

doc: update orm package name#501
ymc9 merged 7 commits into
mainfrom
docs/qaas-v3

Conversation

@ymc9

@ymc9ymc9 commented Nov 1, 2025

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Documentation
    • Updated version 3.x documentation across migration guides, API references, and plugin documentation to reflect that ZenStack client imports and type definitions are now sourced from the ORM package. Updated code examples and dependency installation instructions to guide developers on correct package imports and setup procedures.

@vercel

vercelBot commented Nov 1, 2025

Copy link
Copy Markdown

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

ProjectDeploymentPreviewCommentsUpdated (UTC)
zenstack-new-siteReadyReadyPreviewCommentNov 1, 2025 1:35am

@coderabbitai

Copy link
Copy Markdown
Contributor

Walkthrough

Documentation updates reflecting a package migration from @zenstackhq/runtime to @zenstackhq/orm across multiple ORM-related documentation files, including import examples, dependency declarations, and module references in version 3.x documentation.

Changes

Cohort / File(s)Change Summary
Package dependency and import updates
versioned_docs/version-3.x/migrate-prisma.md, versioned_docs/version-3.x/orm/quick-start.md
Updated package dependency from @zenstackhq/runtime to @zenstackhq/orm in installation and setup sections.
ZenStackClient import path updates
versioned_docs/version-3.x/orm/access-control/query.md, versioned_docs/version-3.x/orm/client.md, versioned_docs/version-3.x/reference/plugins/policy.md
Changed ZenStackClient import source from @zenstackhq/runtime to @zenstackhq/orm in code examples.
Type import path updates
versioned_docs/version-3.x/orm/client.md
Updated ClientContract type import from @zenstackhq/runtime to @zenstackhq/orm.
Module reference updates
versioned_docs/version-3.x/orm/errors.md, versioned_docs/version-3.x/orm/inferred-types.md, versioned_docs/version-3.x/reference/api.md, versioned_docs/version-3.x/reference/zmodel/attribute.md
Updated referenced module and import paths from @zenstackhq/runtime to @zenstackhq/orm in error, type, and metadata documentation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • All changes are documentation-only with highly homogeneous patterns (consistent package reference updates)
  • No functional logic, behavior changes, or complex reasoning required per file
  • Large scope (9 files) is offset by repetitive nature of edits (same refactoring applied uniformly)

Possibly related PRs

  • zenstack-docs#495: Updates documentation referencing the same public symbols (ZenStackClient) and package import paths in version-3.x docs.

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title Check✅ PassedThe pull request title "doc: update orm package name" is directly related to the changeset. All nine modified files are documentation files that systematically update import paths and package references from @zenstackhq/runtime to @zenstackhq/orm across multiple sections (migration guides, ORM documentation, API references, and zmodel attributes). The title clearly identifies that this is a documentation change focused on updating the ORM package references, which accurately captures the main objective of the PR. The use of the "doc:" prefix follows conventional commit message formatting and effectively conveys that this is a documentation-only change.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/qaas-v3

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 685bab3 and d3c7551.

📒 Files selected for processing (9)
  • versioned_docs/version-3.x/migrate-prisma.md (3 hunks)
  • versioned_docs/version-3.x/orm/access-control/query.md (1 hunks)
  • versioned_docs/version-3.x/orm/client.md (3 hunks)
  • versioned_docs/version-3.x/orm/errors.md (1 hunks)
  • versioned_docs/version-3.x/orm/inferred-types.md (1 hunks)
  • versioned_docs/version-3.x/orm/quick-start.md (1 hunks)
  • versioned_docs/version-3.x/reference/api.md (1 hunks)
  • versioned_docs/version-3.x/reference/plugins/policy.md (1 hunks)
  • versioned_docs/version-3.x/reference/zmodel/attribute.md (2 hunks)
🔇 Additional comments (9)
versioned_docs/version-3.x/orm/inferred-types.md (1)

22-22: Approve package reference update.

The ModelResult import path is correctly updated to reflect the new package organization.

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

49-49: Approve dependency update.

The manual setup dependency correctly references the new @zenstackhq/orm@next package.

versioned_docs/version-3.x/reference/zmodel/attribute.md (1)

368-368: Approve model-meta import path updates.

Both model-level and field-level @meta attribute documentation correctly reference the new @zenstackhq/orm/model-meta package path.

Also applies to: 485-485

versioned_docs/version-3.x/reference/api.md (1)

9-9: Approve API reference header update.

The API reference section correctly identifies the package as @zenstackhq/orm.

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

8-8: Approve error module reference update.

The error classes documentation correctly references the new @zenstackhq/orm package.

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

35-35: Approve migration guide package updates.

All three package references are correctly updated: the main dependency (line 35) and both database-specific import examples (PostgreSQL and SQLite tabs at lines 90 and 108).

Also applies to: 90-90, 108-108

versioned_docs/version-3.x/reference/plugins/policy.md (1)

149-149: Approve runtime plugin example update.

The policy plugin usage example correctly imports ZenStackClient from @zenstackhq/orm.

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

28-28: Approve database client documentation updates.

All package references are correctly updated across both database examples (SQLite and PostgreSQL) and the type import example. The ZenStackClient and ClientContract imports now reference @zenstackhq/orm.

Also applies to: 46-46, 66-66

versioned_docs/version-3.x/orm/access-control/query.md (1)

16-16: Import path update is correct and consistently applied.

The change updating ZenStackClient import from @zenstackhq/runtime to @zenstackhq/orm has been verified as complete and consistent across all related documentation files. No remaining references to the old package name were found in the ORM documentation, migration guide, or reference sections.


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

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

@ymc9
ymc9 merged commit 38efdf7 into mainNov 1, 2025
4 checks passed
@ymc9
ymc9 deleted the docs/qaas-v3 branch November 1, 2025 01:36
@coderabbitaicoderabbitaiBot mentioned this pull request Dec 18, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@ymc9