docs(wasm-sdk): clarify aggregate groupBy behavior

[thephez]

Issue being fixed or feature implemented

The DocumentsQuery.groupBy declaration described the option exclusively as a count-query setting, despite the type also being shared by document sum and average queries. This caused generated declaration-based documentation to show count-specific wording for those methods.

What was done?

• Updated the DocumentsQuery.groupBy JSDoc in packages/wasm-sdk/src/queries/document.rs to describe all aggregate queries.
• Documented the ungrouped return values for getDocumentsCount, getDocumentsSum, and getDocumentsAverage.
• Corrected related internal comments that described groupBy as count-only.

How Has This Been Tested?

No build or automated tests were run because this change only updates documentation comments.

Breaking Changes

None.

Checklist:

• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have added or updated relevant unit/integration/functional/e2e tests
• I have added "!" to the title and described breaking changes in the corresponding section if my code contains any
• I have made corresponding changes to the documentation if needed

For repository code-owners and collaborators only

• I have assigned this pull request to a milestone

Summary by CodeRabbit

• Documentation
  • Clarified groupBy documentation for count, sum, and average aggregate results.
  • Documented the result shapes for ungrouped aggregate queries.
  • Updated terminology to consistently describe aggregate queries.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Team

Run ID: c14b3aa4-9c51-4a06-aaf4-665d09e621ab

📥 Commits

Reviewing files that changed from the base of the PR and between 3630a61 and 12914ce.

📒 Files selected for processing (1)

• packages/wasm-sdk/src/queries/document.rs

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.

---

📝 Walkthrough

Walkthrough

Updated groupBy documentation and related Rust comments to describe aggregate queries, including count, sum, and average results. No executable behavior changed.

Changes

Aggregate query documentation

Layer / File(s)	Summary
Align aggregate query documentation packages/wasm-sdk/src/queries/document.rs	The groupBy documentation now covers ungrouped count, sum, and average results. Rust comments use aggregate-query terminology and identify group_by as an aggregate-query option.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to 12914

This PR only corrects documentation wording for existing aggregate-query behavior, with no runtime or API behavior changes. No actionable merge-blocking risk remains beyond normal review.

Suggested reviewers: quantumexplorer, shumkov

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 1 files.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely describes the documentation change to clarify aggregate groupBy behavior in the WASM SDK.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

• Fix all pre-merge checks with AI

✨ Finishing Touches 💡 1

📝 Generate docstrings 💡

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch fix/wasm-sdk-aggregate-groupby-jsdoc

---

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.}

[thepastaclaw]

🕓 Ready for review — 11 ahead in queue (commit 12914ce)
Queue position: 12/52 · 2 reviews active
ETA: start ~20:58 UTC · complete ~21:53 UTC (median 54m across 30 recent reviews; 2 slots)
Queued 2d 5h ago · Last checked: 2026-09-03 16:20 UTC