Skip to content

feat: Console SDK update for version 2.2.0#53

Closed
ChiragAgg5k wants to merge 1 commit intomainfrom
dev
Closed

feat: Console SDK update for version 2.2.0#53
ChiragAgg5k wants to merge 1 commit intomainfrom
dev

Conversation

@ChiragAgg5k
Copy link
Copy Markdown
Member

@ChiragAgg5k ChiragAgg5k commented Jan 4, 2026

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

Summary by CodeRabbit

  • Chores

    • Version 2.2.0 released across SDK and all documentation
    • Updated API version badges and CDN script references
    • SDK version metadata updated to reflect current release
  • Refactor

    • Reorganized internal data model structure for improved maintainability

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Jan 4, 2026

Walkthrough

This pull request updates the SDK version from 2.1.0 to 2.2.0 across multiple files: the package.json manifest, README.md badges and CDN references, and the x-sdk-version header in src/client.ts. Additionally, the UsageSites type definition in src/models.ts is reorganized by moving eight metric-related fields from a trailing section to the top of the type definition for improved structure.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

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 title 'feat: Console SDK update for version 2.2.0' accurately describes the primary change: a version bump and SDK update across multiple files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
  • 📝 Generate docstrings

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 532a19f and fb34c32.

📒 Files selected for processing (4)
  • README.md
  • package.json
  • src/client.ts
  • src/models.ts
🔇 Additional comments (4)
README.md (1)

4-4: Version strings look consistent; please confirm API/format version intent

The README now:

  • Shows API version 1.8.1 in the badge.
  • References CDN @appwrite.io/console@2.2.0, which matches the SDK version elsewhere.

This all looks consistent with the 2.2.0 bump. One thing to double‑check: src/client.ts still sends X-Appwrite-Response-Format: 1.8.0. If the Console SDK is meant to target API/format 1.8.1 now, you may want to bump that header as well (or adjust the badge) so docs, headers, and backend expectations stay aligned.

Also applies to: 36-36

package.json (1)

5-5: SDK version bump is consistent with other references

Setting "version": "2.2.0" aligns with the CDN snippet in the README and the x-sdk-version header in src/client.ts. No issues from a manifest standpoint.

src/client.ts (1)

323-329: Header version bump matches package/README; verify response format vs API version

Updating 'x-sdk-version': '2.2.0' keeps the client metadata in sync with package.json and the README CDN snippet, which is good.

Given the README badge now advertises API version 1.8.1 while this client still sends X-Appwrite-Response-Format: 1.8.0, it’s worth confirming whether:

  • the response‑format header should also move to 1.8.1, or
  • the badge is intentionally ahead of the response format.

From a code perspective, the change here is fine.

src/models.ts (1)

5289-5414: UsageSites metrics structure is coherent; note new required fields

The updated UsageSites shape looks consistent and easier to reason about:

  • High‑level totals (sitesTotal, requestsTotal, inboundTotal, outboundTotal) and their corresponding Metric[] series (sites, requests, inbound, outbound) now sit together, mirroring the pattern already used in UsageSite and other usage types.
  • Existing deployment/build/execution metrics are preserved.

One minor consideration: these fields are all required, so any consumer code that was manually constructing UsageSites objects (e.g., in mocks) will now need to populate the new properties. For normal API responses, this should be non‑breaking as long as the backend is already returning these keys.


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.

@ChiragAgg5k ChiragAgg5k closed this Jan 5, 2026
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