Skip to content

Conversation

abnegate
Copy link
Member

@abnegate abnegate commented Sep 23, 2025

This PR contains updates to the Web SDK for version 20.1.0.

Summary by CodeRabbit

  • New Features

    • Added option to randomly order query results.
  • Documentation

    • Updated CDN usage to the latest version.
    • Clarified that execution includes HTTP request headers.
    • Aligned parameter docs for equality filters to reflect single-value input.
  • Chores

    • Bumped SDK version to 20.1.0.
    • Updated SDK version reported in request headers.

Copy link

coderabbitai bot commented Sep 23, 2025

Walkthrough

  • README: CDN script updated to Appwrite 20.1.0.
  • package.json: version bumped from 20.0.0 to 20.1.0.
  • src/client.ts: default header x-sdk-version updated to 20.1.0.
  • src/models.ts: Execution.requestHeaders JSDoc corrected to refer to HTTP request headers.
  • src/query.ts: added static orderRandom(); updated equal and notEqual to accept a single QueryTypes value; adjusted related documentation.

Possibly related PRs

Suggested reviewers

  • loks0n

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 PR title succinctly and accurately captures the primary change — a Web SDK release bump to version 20.1.0 — and is concise, specific, and directly related to the changes in package.json, client headers, README, and the added Query.orderRandom method.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch dev

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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (4)
README.md (1)

36-36: CDN snippet updated; consider pinning the file path explicitly.

Minor: pointing to the concrete IIFE file avoids resolver ambiguity on some CDNs.

-<script src="https://cdn.jsdelivr.net/npm/[email protected]"></script>
+<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/iife/sdk.js"></script>
src/query.ts (3)

55-59: Clarify that equal() accepts single value or array.

Type allows both; doc should say so to prevent confusion.

- * @param {QueryTypes} value
+ * @param {QueryTypes} value Single value or array of values.

65-69: Clarify that notEqual() accepts single value or array.

Align docs with runtime behavior.

- * @param {QueryTypes} value
+ * @param {QueryTypes} value Single value or array of values.

198-205: New Query.orderRandom() — LGTM.

Optional: add a short README snippet in “Sorting” showing orderRandom alongside orderAsc/Desc.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8a5d716 and d34d57d.

📒 Files selected for processing (5)
  • README.md (1 hunks)
  • package.json (1 hunks)
  • src/client.ts (1 hunks)
  • src/models.ts (1 hunks)
  • src/query.ts (2 hunks)
🧰 Additional context used
🧬 Code graph analysis (1)
src/query.ts (2)
src/client.ts (2)
  • QueryTypes (805-805)
  • Query (802-802)
src/index.ts (2)
  • QueryTypes (20-20)
  • Query (8-8)
🔇 Additional comments (3)
src/client.ts (1)

319-321: x-sdk-version header synced to 20.1.0 — LGTM.

src/models.ts (1)

1028-1031: JSDoc corrected to “HTTP request headers” — LGTM.

package.json (1)

5-5: Version bump confirmed — no remaining 20.0.0 references found.
Repo-wide search (excluding lock/build dirs) returned no matches.

@abnegate abnegate closed this Sep 23, 2025
Sign up for free to 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