feat: Flutter SDK update for version 20.1.0 #275
Conversation
WalkthroughAdds Account API methods Possibly related PRs
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (5)
🚧 Files skipped from review as they are similar to previous changes (5)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
lib/services/account.dart (1)
1366-1396: Update documentation link to reference the new method.Line 1373 references the deprecated
updateVerificationmethod. Since this is the newcreateEmailVerificationmethod, the documentation should referenceupdateEmailVerificationinstead to guide users to the current API.Apply this diff to update the documentation link:
- /// process](https://appwrite.io/docs/references/cloud/client-web/account#updateVerification). + /// process](https://appwrite.io/docs/references/cloud/client-web/account#updateEmailVerification).
🧹 Nitpick comments (1)
lib/services/account.dart (1)
29-29: Fix typo in documentation URL.The URL contains a typo: "verfication" should be "verification".
Apply this diff to fix the typo:
- /// [/account/verfication](https://appwrite.io/docs/references/cloud/client-web/account#createVerification) + /// [/account/verification](https://appwrite.io/docs/references/cloud/client-web/account#createVerification)Note: Consider also updating this reference to point to
createEmailVerificationinstead of the deprecatedcreateVerificationmethod.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (10)
CHANGELOG.md(1 hunks)README.md(1 hunks)docs/examples/account/create-email-verification.md(1 hunks)docs/examples/account/update-email-verification.md(1 hunks)lib/services/account.dart(4 hunks)lib/services/tables_db.dart(2 hunks)lib/src/client_browser.dart(1 hunks)lib/src/client_io.dart(1 hunks)pubspec.yaml(1 hunks)test/services/account_test.dart(2 hunks)
🔇 Additional comments (14)
lib/services/tables_db.dart (1)
33-35: Doc link refresh looks good.Updated URLs point to the new server-dart TablesDB docs and keep the comment formatting intact. 👍
Also applies to: 95-96
README.md (1)
24-24: LGTM!Version bump to 20.0.1 is consistent with the overall SDK update.
lib/src/client_io.dart (1)
61-61: LGTM!SDK version header update is consistent with the package version bump.
pubspec.yaml (1)
2-2: LGTM!Version bump to 20.0.1 is appropriate for this feature update.
lib/src/client_browser.dart (1)
43-43: LGTM!SDK version header update is consistent with the package version bump and matches the client_io.dart update.
docs/examples/account/create-email-verification.md (1)
1-11: LGTM!The example clearly demonstrates the usage of the new
createEmailVerificationmethod and follows the standard pattern for Appwrite SDK documentation examples.docs/examples/account/update-email-verification.md (1)
1-12: LGTM!The example clearly demonstrates the usage of the new
updateEmailVerificationmethod and follows the standard pattern for Appwrite SDK documentation examples.test/services/account_test.dart (2)
1383-1403: LGTM!The test for
createEmailVerificationfollows the established pattern in the test suite and appropriately validates the method's behavior.
1427-1448: LGTM!The test for
updateEmailVerificationfollows the established pattern in the test suite and appropriately validates the method's behavior.lib/services/account.dart (5)
1413-1431: LGTM! Well-executed deprecation strategy.The deprecation is properly annotated with a clear migration path, and the implementation maintains backward compatibility by pointing to the new email-specific endpoint. The duplicate code is intentional and acceptable for this transition period.
1437-1455: LGTM! Clean implementation of the new email verification update method.The method correctly implements the email verification completion endpoint with appropriate parameters and return type.
1461-1482: LGTM! Consistent deprecation pattern.The deprecation follows the same well-executed pattern as
createVerification, maintaining backward compatibility while guiding users to the new API.
1492-1507: LGTM! Consistent API path structure.The path update to
/account/verifications/phonealigns with the new RESTful endpoint structure and matches the pattern used for email verification.
1513-1531: LGTM! Consistent path update for phone verification.The path update maintains consistency with the create method and follows the new endpoint structure.
CHANGELOG.md
Outdated
| ## 20.0.1 | ||
|
|
||
| * Deprecate `createVerification` method in `Account` service | ||
| * Add `createEmailVerification` method in `Account` service | ||
|
|
There was a problem hiding this comment.
CHANGELOG entry appears incomplete.
Based on the AI summary and the test file changes (which include both createEmailVerification and updateEmailVerification tests), the changelog should document:
- Deprecation of
createVerificationmethod ✓ (documented) - Addition of
createEmailVerificationmethod ✓ (documented) - Deprecation of
updateVerificationmethod ✗ (missing) - Addition of
updateEmailVerificationmethod ✗ (missing)
Additionally, the AI summary mentions endpoint path updates (/account/verifications/email and /account/verifications/phone), which are not documented in the changelog.
Consider updating the changelog to:
## 20.0.1
-* Deprecate `createVerification` method in `Account` service
-* Add `createEmailVerification` method in `Account` service
+* Deprecate `createVerification` and `updateVerification` methods in `Account` service
+* Add `createEmailVerification` and `updateEmailVerification` methods in `Account` service
+* Update endpoint paths for email and phone verification methods📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## 20.0.1 | |
| * Deprecate `createVerification` method in `Account` service | |
| * Add `createEmailVerification` method in `Account` service | |
| ## 20.0.1 | |
| * Deprecate `createVerification` and `updateVerification` methods in `Account` service | |
| * Add `createEmailVerification` and `updateEmailVerification` methods in `Account` service | |
| * Update endpoint paths for email and phone verification methods |
🤖 Prompt for AI Agents
In CHANGELOG.md around lines 3 to 7, the 20.0.1 entry is incomplete: it
documents deprecation of createVerification and addition of
createEmailVerification but omits deprecation of updateVerification, addition of
updateEmailVerification, and the endpoint path updates
(/account/verifications/email and /account/verifications/phone). Update the
20.0.1 section to add entries noting deprecation of updateVerification, addition
of updateEmailVerification, and list the endpoint path changes for email and
phone verification routes; keep wording consistent with existing bullets and
include backticks for method names and endpoint paths.
ChiragAgg5k
changed the title
2 participants
This PR contains updates to the Flutter SDK for version 20.1.0.
Summary by CodeRabbit