Skip to content

feat: Console SDK update for version 7.0.0#72

Merged
ChiragAgg5k merged 1 commit intomainfrom
dev
Mar 20, 2026
Merged

feat: Console SDK update for version 7.0.0#72
ChiragAgg5k merged 1 commit intomainfrom
dev

Conversation

@ChiragAgg5k
Copy link
Copy Markdown
Member

@ChiragAgg5k ChiragAgg5k commented Mar 20, 2026

This PR contains updates to the Console SDK for version 7.0.0.

Changes

  • Breaking: Updated $sequence type from number to string for rows and documents.
  • Updated: Compatibility note now refers to Appwrite server 1.9.x.
  • Updated: README badge shows API version 1.9.0.
  • Updated: Set header X-Appwrite-Response-Format to 1.9.0.

Summary by CodeRabbit

  • Breaking Changes

    • $sequence property type changed from number to string in Row and Document models
  • Documentation

    • Updated SDK compatibility to Appwrite server 1.9.x
    • Updated API version indicator to 1.9.0
    • Updated package version to 7.0.0

* Breaking: Updated `$sequence` type from `number` to `string` for rows and documents.
* Updated: Compatibility note now refers to Appwrite server `1.9.x`.
* Updated: README badge shows API version `1.9.0`.
* Updated: Set header `X-Appwrite-Response-Format` to `1.9.0`.
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 20, 2026

Walkthrough

This pull request releases version 7.0.0 of the Appwrite console SDK. It updates version numbers in package.json, README, and headers from 6.0.0 to 7.0.0, changes the Appwrite server compatibility target from 1.8.x to 1.9.x throughout documentation and headers, updates the response format header from 1.8.0 to 1.9.0, and introduces a breaking change by modifying the $sequence property type from number to string in both the Row and Document models.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

🚥 Pre-merge checks | ✅ 3
✅ 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 'feat: Console SDK update for version 7.0.0' directly and clearly summarizes the main change—a version bump to 7.0.0 for the Console SDK, which encompasses all file updates (package.json, CHANGELOG, README, client headers, type changes).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch dev
📝 Coding Plan
  • Generate coding plan for human review comments

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.

@greptile-apps
Copy link
Copy Markdown

greptile-apps bot commented Mar 20, 2026

Greptile Summary

This PR bumps the Console SDK to version 7.0.0 with compatibility for Appwrite server 1.9.x, introducing one breaking change and a set of consistent version string updates across the codebase.

Key changes:

  • Breaking: $sequence field type changed from number to string in both the Row and Document model types in src/models.ts. This is the only functional change; all other $sequence references in the codebase have been correctly updated.
  • X-Appwrite-Response-Format header bumped from 1.8.0 to 1.9.0 in src/client.ts.
  • x-sdk-version header updated from 6.0.0 to 7.0.0 in src/client.ts.
  • Server compatibility comment in src/index.ts updated from 1.8.x to 1.9.x.
  • package.json version bumped from 6.0.0 to 7.0.0.
  • README.md badge and CDN script tag updated to reflect 1.9.0 and 7.0.0 respectively.
  • CHANGELOG.md updated with a 7.0.0 entry documenting all changes.

All version strings are internally consistent and the breaking change is clearly documented.

Confidence Score: 5/5

  • This PR is safe to merge — all changes are consistent version bumps and a single, well-documented breaking type change.
  • The PR is a straightforward SDK version bump. The only functional change ($sequence: numberstring) is applied consistently in both model types that contain it, properly marked as breaking in the changelog, and has no other callers within the SDK itself that need updating. All version strings (package.json, client.ts headers, README.md, src/index.ts) are mutually consistent.
  • No files require special attention.

Important Files Changed

Filename Overview
src/models.ts Changed $sequence type from number to string in both Row and Document model types — a breaking change that is properly documented. No other usages of $sequence exist in the codebase.
src/client.ts Updated x-sdk-version to 7.0.0 and X-Appwrite-Response-Format to 1.9.0 — consistent with the version bump.
src/index.ts Updated the compatibility comment from Appwrite server 1.8.x to 1.9.x — straightforward documentation update.
package.json Bumped package version from 6.0.0 to 7.0.0 — correct for a major breaking-change release.
README.md Updated the API version badge from 1.8.2 to 1.9.0 and the CDN script tag from 6.0.0 to 7.0.0 — consistent documentation updates.
CHANGELOG.md Added a 7.0.0 section documenting the breaking $sequence type change, compatibility update, badge update, and response format header change.

Last reviewed commit: "feat: update Console..."

Copy link
Copy Markdown

@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: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Line 4: The README contains a compatibility sentence still stating "1.8.x"
that conflicts with the version badge showing 1.9.0; update the textual
compatibility sentence(s) that reference "1.8.x" to "1.9.x" so the docs match
the badge/version; search for the string "1.8.x" and replace it with "1.9.x"
(also update any nearby phrasing that implies 1.8-only compatibility) to ensure
consistency across README entries referenced in this diff.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: d98c11db-b580-45c3-b5f2-3240bacd5bf8

📥 Commits

Reviewing files that changed from the base of the PR and between 2f041f8 and 88538f7.

📒 Files selected for processing (6)
  • CHANGELOG.md
  • README.md
  • package.json
  • src/client.ts
  • src/index.ts
  • src/models.ts


![License](https://img.shields.io/github/license/appwrite/sdk-for-console.svg?style=flat-square)
![Version](https://img.shields.io/badge/api%20version-1.8.2-blue.svg?style=flat-square)
![Version](https://img.shields.io/badge/api%20version-1.9.0-blue.svg?style=flat-square)
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Update the compatibility sentence to 1.9.x to avoid contradictory docs.

Line 9 still says 1.8.x, which conflicts with the updated badge/version and can mislead users upgrading to 7.0.0.

📝 Proposed fix
-**This SDK is compatible with Appwrite server version 1.8.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-console/releases).**
+**This SDK is compatible with Appwrite server version 1.9.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-console/releases).**

Also applies to: 36-36

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 4, The README contains a compatibility sentence still
stating "1.8.x" that conflicts with the version badge showing 1.9.0; update the
textual compatibility sentence(s) that reference "1.8.x" to "1.9.x" so the docs
match the badge/version; search for the string "1.8.x" and replace it with
"1.9.x" (also update any nearby phrasing that implies 1.8-only compatibility) to
ensure consistency across README entries referenced in this diff.

@ChiragAgg5k ChiragAgg5k merged commit c1222d4 into main Mar 20, 2026
3 checks passed
@ChiragAgg5k ChiragAgg5k deleted the dev branch March 20, 2026 11:18
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.

2 participants