-
Notifications
You must be signed in to change notification settings - Fork 8
feat: Console SDK update for version 3.1.0 #62
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,9 @@ | ||
| # Change Log | ||
|
|
||
| ## 3.0.1 | ||
|
|
||
| * Fix very large double values (for example 1.7976931348623157e+308) from being expanded into giant integer literals | ||
|
|
||
| ## 3.0.0 | ||
|
|
||
| * Breaking: EmailTemplateType enum values renamed and updated (Magicsession -> MagicSession, Mfachallenge -> MfaChallenge, Sessionalert -> SessionAlert, Otpsession -> OtpSession) and their underlying string values changed accordingly, which may affect existing integrations. | ||
|
|
@@ -100,3 +104,91 @@ Fix bigint and float parsing in SDK. | |
| ## 1.5.0 | ||
|
|
||
| * Adds support for `databasesReadsTotal` and `databasesWritesTotal` attributes | ||
|
|
||
| ## 22.3.1 | ||
|
|
||
| * Add `upsert` method to Realtime `Channels` helper class | ||
| * Fix `bignumber.js` bundler conflict with Next.js Turbopack by removing direct dependency in favor of transitive dependency from `json-bigint` | ||
|
|
||
| ## 22.1.0 | ||
|
|
||
| * Add `queries` parameter to `Realtime.subscribe()` and `client.subscribe()` for server-side query filtering | ||
| * Add slot-based subscription management with subscription ID mappings from backend | ||
| * Add `subscriptions` field to `RealtimeResponseEvent` type | ||
| * Fix `Roles` enum removed from Teams service; `roles` parameter now accepts `string[]` | ||
| * Fix parameter detection in overloaded methods to check for optional params (Account, Avatars, Graphql) | ||
| * Fix WebSocket connection handling with stale connection guards and improved close/reconnect logic | ||
| * Fix doc examples wrapped in markdown code fences | ||
|
||
|
|
||
| ## 22.0.0 | ||
|
|
||
| * Add array-based enum parameters (e.g., `permissions: BrowserPermission[]`). | ||
| * Breaking change: `Output` enum has been removed; use `ImageFormat` instead. | ||
| * Add `Channel` helpers for Realtime. | ||
|
|
||
| ## 21.5.0 | ||
|
|
||
| * Add `getScreenshot` method to `Avatars` service | ||
| * Add `Theme`, `Timezone` and `Output` enums | ||
|
|
||
| ## 21.4.0 | ||
|
|
||
| * Add `total` parameter to list queries allowing skipping counting rows in a table for improved performance | ||
| * Add `Operator` class for atomic modification of rows via update, bulk update, upsert, and bulk upsert operations | ||
|
|
||
| ## 21.3.0 | ||
|
|
||
| * Add new `Realtime` service with methods for subscribing to channels and receiving messages | ||
| * Fix `client.setSession` not working when using realtime | ||
| * Deprecate `client.subscribe` method in favor of `Realtime` service | ||
|
|
||
| > Note: Deprecated methods are still available for backwards compatibility, but might be removed in future versions. | ||
|
|
||
| ## 21.2.1 | ||
|
|
||
| * Add transaction support for Databases and TablesDB | ||
|
|
||
| ## 21.1.0 | ||
|
|
||
| * Deprecate `createVerification` method in `Account` service | ||
| * Add `createEmailVerification` method in `Account` service | ||
|
|
||
| ## 18.2.0 | ||
|
|
||
| * Add `incrementDocumentAttribute` and `decrementDocumentAttribute` support to `Databases` service | ||
| * Add `gif` support to `ImageFormat` enum | ||
| * Fix undefined `fileParam` error in `chunkedUpload` method | ||
| * Fix autocompletion not working for `Document` model even when generic is passed | ||
|
|
||
| ## 18.1.1 | ||
|
|
||
| * Fix using `devKeys` resulting in an error by conditionally removing credentials | ||
|
|
||
| ## 18.1.0 | ||
|
|
||
| * Add `devKeys` support to `Client` service | ||
| * Add `upsertDocument` support to `Databases` service | ||
|
|
||
| ## 18.0.0 | ||
|
|
||
| * Add `<REGION>` to doc examples due to the new multi region endpoints | ||
| * Remove `Gif` from ImageFormat enum | ||
|
||
| * Remove `search` param from `listExecutions` method | ||
| * Add `token` param to `getFilePreview` and `getFileView` for File tokens usage | ||
| * Improve CORS error catching in `client.call` method | ||
|
|
||
| ## 17.0.2 | ||
|
|
||
| * Fix requests failing by removing `Content-Type` header from `GET` and `HEAD` requests | ||
|
|
||
| ## 17.0.1 | ||
|
|
||
| * Remove unnecessary titles from method descriptions | ||
| * Fix duplicate adding of payload params | ||
| * Remove unnecessary awaits and asyncs | ||
| * Ensure `AppwriteException` response is always string | ||
|
|
||
| ## 17.0.0 | ||
|
|
||
| * Fix pong response & chunked upload | ||
| * Add `ping` support to `Realtime` service | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| ```javascript | ||
| import { Client, Domains } from "@appwrite.io/console"; | ||
|
|
||
| const client = new Client() | ||
| .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint | ||
| .setProject('<YOUR_PROJECT_ID>'); // Your project ID | ||
|
|
||
| const domains = new Domains(client); | ||
|
|
||
| const result = await domains.createPurchase({ | ||
| domain: '', | ||
| teamId: '<TEAM_ID>', | ||
|
Comment on lines
+10
to
+12
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Use a placeholder domain instead of an empty string. Line 11 currently uses 🤖 Prompt for AI Agents |
||
| firstName: '<FIRST_NAME>', | ||
| lastName: '<LAST_NAME>', | ||
| email: 'email@example.com', | ||
| phone: '+12065550100', | ||
| billingAddressId: '<BILLING_ADDRESS_ID>', | ||
| paymentMethodId: '<PAYMENT_METHOD_ID>', | ||
| addressLine3: '<ADDRESS_LINE3>', // optional | ||
| companyName: '<COMPANY_NAME>', // optional | ||
| periodYears: 1 // optional | ||
| }); | ||
|
|
||
| console.log(result); | ||
| ``` | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tone tweak: avoid “very”.
Line 5: consider removing or replacing “very” for a cleaner changelog entry.
🧰 Tools
🪛 LanguageTool
[style] ~5-~5: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: # Change Log ## 3.0.1 * Fix very large double values (for example 1.7976931348...
(EN_WEAK_ADJECTIVE)
🤖 Prompt for AI Agents