diff --git a/.changeset/blue-deers-study.md b/.changeset/blue-deers-study.md new file mode 100644 index 00000000..07120c17 --- /dev/null +++ b/.changeset/blue-deers-study.md @@ -0,0 +1,18 @@ +--- +"groqd": minor +--- + +Feature: Simplified APIs + +We removed irrelevant methods from the root `q` object, and from query chains. +This improves auto-complete and API discoverability, and reduces confusion. + +- The root `q` object no longer exposes irrelevant chaining methods. + - E.g. we removed: `q.filter(...)`, `q.deref()`, `q.field(...)`, etc. +- Query chains no longer expose irrelevant top-level utilites. + - E.g. we removed `(chain).star`, `(chain).conditional(...)`, `(chain).select(...)`, `(chain).value(...)`, etc. +- The subquery in a projection no longer exposes irrelvant chaining methods. + - E.g. with `.project(sub => ({ ... }))` we removed: `sub.filter(...)`, `sub.order(...)`, etc. + +> Backwards compatibility: we only removed methods that created invalid GROQ queries, +> so this change should be backwards compatible.