From 617611ffebcfcf56d2a5bd83e3b552cd427fc522 Mon Sep 17 00:00:00 2001 From: Chirag Aggarwal Date: Sat, 17 Oct 2026 15:32:33 +0100 Subject: [PATCH 1/2] docs: refresh README --- README.md | 191 +++++++++++++++++++++++++----------------------------- 1 file changed, 87 insertions(+), 104 deletions(-) diff --git a/README.md b/README.md index bc005f5e..399b5671 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,11 @@ # Appwrite Console SDK -![License](https://img.shields.io/github/license/appwrite/sdk-for-console.svg?style=flat-square) -![Version](https://img.shields.io/badge/api%20version-2.4.0-blue.svg?style=flat-square) -[![Build Status](https://img.shields.io/travis/com/appwrite/sdk-generator?style=flat-square)](https://travis-ci.com/appwrite/sdk-generator) -[![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite) +![License](https://img.shields.io/badge/license-BSD--3--Clause-blue.svg?style=flat-square) +![Version](https://img.shields.io/badge/api%20version-2.5.0-blue.svg?style=flat-square) +[![X Account](https://img.shields.io/badge/follow-%40appwrite-000000?logo=x&style=flat-square)](https://x.com/appwrite) [![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord) -**This SDK targets Appwrite server version 2.4.x as shipped on Appwrite Cloud.** Self-hosted releases can lag behind Cloud — if you run an older self-hosted build, use a matching older SDK from [previous releases](https://github.com/appwrite/sdk-for-console/releases) when APIs differ. +**This SDK targets Appwrite server version 2.5.x as shipped on Appwrite Cloud.** Self-hosted releases can lag behind Cloud — if you run an older self-hosted build, use a matching older SDK from [previous releases](https://github.com/appwrite/sdk-for-console/releases) when APIs differ. Appwrite is an open-source backend as a service server that abstracts and simplifies complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way. Use the Console SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs) @@ -14,15 +13,13 @@ Appwrite is an open-source backend as a service server that abstracts and simpli ## Installation -### NPM - -To install via [NPM](https://www.npmjs.com/): +### npm ```bash -npm install @appwrite.io/console --save +npm install @appwrite.io/console ``` -If you're using a bundler (like [Rollup](https://rollupjs.org/) or [webpack](https://webpack.js.org/)), you can import the Appwrite module when you need it: +Import the modules you need. The package ships ES modules, CommonJS and TypeScript types: ```js import { Client, Account } from '@appwrite.io/console'; @@ -30,160 +27,146 @@ import { Client, Account } from '@appwrite.io/console'; ### CDN -To install with a CDN (content delivery network) add the following scripts to the bottom of your tag, but before you use any Appwrite services: +Add the script before any code that uses the SDK. It exposes every export on the global `Appwrite` object: ```html + ``` -## Getting Started - -### Add your Web Platform +## Getting started -For you to init your SDK and interact with Appwrite services you need to add a web platform to your project. To add a new platform, go to your Appwrite console, choose the project you created in the step before and click the 'Add Platform' button. +### Add a Web platform -From the options, choose to add a **Web** platform and add your client app hostname. By adding your hostname to your project platform you are allowing cross-domain communication between your project and the Appwrite API. +In the Appwrite Console, open your project and under **Add a platform** choose **Web app**. Enter the hostname your app runs on: `localhost` for local development, and your production domain once you deploy. Appwrite only accepts browser requests from hostnames registered as platforms, so a missing hostname shows up as a CORS error. -### Init your SDK +### Initialize the client -Initialize your SDK with your Appwrite server API endpoint and project ID which can be found in your project settings page. +Copy your endpoint and project ID from your project's **Settings** page. ```js -// Init your Web SDK -const client = new Client(); +import { Client } from 'appwrite'; -client - .setEndpoint('http://localhost/v1') // Your Appwrite Endpoint - .setProject('455x34dfkj') // Your project ID -; +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') + .setProject(''); ``` -### Make Your First Request +For a self-hosted Appwrite, use `https:///v1` as the endpoint. + +### Make your first request -Once your SDK object is set, access any of the Appwrite services and choose any request to send. Full documentation for any service method you would like to use can be found in your SDK documentation or in the [API References](https://appwrite.io/docs) section. +Create a service from the client and call any of its methods. Every method takes a single object of named parameters and returns a promise. See the [API reference](https://appwrite.io/docs/references) for every service and method. ```js +import { Account, ID } from 'appwrite'; + const account = new Account(client); -// Register User -account.create(ID.unique(), "email@example.com", "password", "Walter O'Brien") - .then(function (response) { - console.log(response); - }, function (error) { - console.log(error); - }); +const user = await account.create({ + userId: ID.unique(), + email: 'email@example.com', + password: 'password', + name: "Walter O'Brien", +}); +console.log(user); ``` -### Full Example +### Sign in with OAuth -```js -// Init your Web SDK -const client = new Client(); +Enable the provider in the Console under **Auth > Settings**, then redirect the user to it. The `success` and `failure` URLs must be on a hostname you registered as a platform. -client - .setEndpoint('http://localhost/v1') // Your Appwrite Endpoint - .setProject('455x34dfkj') -; +```js +import { Account, OAuthProvider } from 'appwrite'; const account = new Account(client); -// Register User -account.create(ID.unique(), "email@example.com", "password", "Walter O'Brien") - .then(function (response) { - console.log(response); - }, function (error) { - console.log(error); - }); +account.createOAuth2Session({ + provider: OAuthProvider.Github, + success: 'https://example.com/success', + failure: 'https://example.com/failure', +}); ``` -### Type Safety with Models +### Type safety with models + +Methods that return rows, such as `listRows` and `getRow`, accept a type parameter for your own row shape: -The Appwrite Web SDK provides type safety when working with database documents through generic methods. Methods like `listDocuments`, `getDocument`, and others accept a generic type parameter that allows you to specify your custom model type for full type safety. +```ts +import { TablesDB, type Models } from 'appwrite'; -**TypeScript:** -```typescript -interface Book { +interface Book extends Models.Row { name: string; author: string; releaseYear?: string; - category?: string; genre?: string[]; isCheckedOut: boolean; } -const databases = new Databases(client); +const tablesDB = new TablesDB(client); -try { - const documents = await databases.listDocuments( - 'your-database-id', - 'your-collection-id' - ); - - documents.documents.forEach(book => { - console.log(`Book: ${book.name} by ${book.author}`); // Now you have full type safety - }); -} catch (error) { - console.error('Appwrite error:', error); +const result = await tablesDB.listRows({ + databaseId: '', + tableId: '', +}); + +for (const book of result.rows) { + console.log(`${book.name} by ${book.author}`); } ``` -**JavaScript (with JSDoc for type hints):** -```javascript +In JavaScript, the same types are available through JSDoc: + +```js /** - * @typedef {Object} Book - * @property {string} name - * @property {string} author - * @property {string} [releaseYear] - * @property {string} [category] - * @property {string[]} [genre] - * @property {boolean} isCheckedOut + * @typedef {import('appwrite').Models.Row & { + * name: string, + * author: string, + * isCheckedOut: boolean, + * }} Book */ -const databases = new Databases(client); - -try { - /** @type {Models.DocumentList} */ - const documents = await databases.listDocuments( - 'your-database-id', - 'your-collection-id' - ); - - documents.documents.forEach(book => { - console.log(`Book: ${book.name} by ${book.author}`); // Type hints available in IDE - }); -} catch (error) { - console.error('Appwrite error:', error); -} +/** @type {import('appwrite').Models.RowList} */ +const result = await tablesDB.listRows({ + databaseId: '', + tableId: '', +}); ``` -**Tip**: You can use the `appwrite types` command to automatically generate TypeScript interfaces based on your Appwrite database schema. Learn more about [type generation](https://appwrite.io/docs/products/databases/type-generation). +The [Appwrite CLI](https://github.com/appwrite/sdk-for-cli) can generate these interfaces from your database schema with `appwrite types`. See [type generation](https://appwrite.io/docs/products/databases/tablesdb/type-generation). + +### Error handling -### Error Handling +Failed requests throw an `AppwriteException` with `message`, `code`, `type` and `response` properties. -The Appwrite Web SDK raises an `AppwriteException` object with `message`, `code` and `response` properties. You can handle any errors by catching the exception and present the `message` to the user or handle it yourself based on the provided error information. Below is an example. +```js +import { AppwriteException } from 'appwrite'; -```javascript try { - const user = await account.create(ID.unique(), "email@example.com", "password", "Walter O'Brien"); - console.log('User created:', user); + const user = await account.get(); + console.log(user); } catch (error) { - console.error('Appwrite error:', error.message); + if (error instanceof AppwriteException) { + console.error(error.code, error.type, error.message); + } } ``` -### Learn more +The [response codes](https://appwrite.io/docs/apis/response-codes) page lists every error type. -You can use the following resources to learn more and get help -- 🚀 [Getting Started Tutorial](https://appwrite.io/docs/getting-started-for-web) -- 📜 [Appwrite Docs](https://appwrite.io/docs) -- 💬 [Discord Community](https://appwrite.io/discord) -- 🚂 [Appwrite Web Playground](https://github.com/appwrite/playground-for-web) +### Learn more +- [Web quick start](https://appwrite.io/docs/quick-starts/web) +- [Appwrite docs](https://appwrite.io/docs) +- [Discord community](https://appwrite.io/discord) +- [Web playground](https://github.com/appwrite/playground-for-web) ## Contribution -This library is auto-generated by Appwrite custom [SDK Generator](https://github.com/appwrite/sdk-generator). To learn more about how you can help us improve this SDK, please check the [contribution guide](https://github.com/appwrite/sdk-generator/blob/master/CONTRIBUTING.md) before sending a pull-request. +This library is auto-generated by the Appwrite [SDK Generator](https://github.com/appwrite/sdk-generator). To learn more about how you can help us improve this SDK, please check the [contribution guide](https://github.com/appwrite/sdk-generator/blob/main/CONTRIBUTING.md) before sending a pull-request. ## License From 3b657fae0a7af08f87daa7d683fca4b2c5cc22b0 Mon Sep 17 00:00:00 2001 From: Chirag Aggarwal Date: Sat, 17 Oct 2026 17:47:06 +0100 Subject: [PATCH 2/2] docs: import from the console package in getting-started examples --- README.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 399b5671..1b17c402 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ In the Appwrite Console, open your project and under **Add a platform** choose * Copy your endpoint and project ID from your project's **Settings** page. ```js -import { Client } from 'appwrite'; +import { Client } from '@appwrite.io/console'; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') @@ -61,7 +61,7 @@ For a self-hosted Appwrite, use `https:///v1` as the endpoint. Create a service from the client and call any of its methods. Every method takes a single object of named parameters and returns a promise. See the [API reference](https://appwrite.io/docs/references) for every service and method. ```js -import { Account, ID } from 'appwrite'; +import { Account, ID } from '@appwrite.io/console'; const account = new Account(client); @@ -80,7 +80,7 @@ console.log(user); Enable the provider in the Console under **Auth > Settings**, then redirect the user to it. The `success` and `failure` URLs must be on a hostname you registered as a platform. ```js -import { Account, OAuthProvider } from 'appwrite'; +import { Account, OAuthProvider } from '@appwrite.io/console'; const account = new Account(client); @@ -96,7 +96,7 @@ account.createOAuth2Session({ Methods that return rows, such as `listRows` and `getRow`, accept a type parameter for your own row shape: ```ts -import { TablesDB, type Models } from 'appwrite'; +import { TablesDB, type Models } from '@appwrite.io/console'; interface Book extends Models.Row { name: string; @@ -121,15 +121,19 @@ for (const book of result.rows) { In JavaScript, the same types are available through JSDoc: ```js +import { TablesDB } from '@appwrite.io/console'; + +const tablesDB = new TablesDB(client); + /** - * @typedef {import('appwrite').Models.Row & { + * @typedef {import('@appwrite.io/console').Models.Row & { * name: string, * author: string, * isCheckedOut: boolean, * }} Book */ -/** @type {import('appwrite').Models.RowList} */ +/** @type {import('@appwrite.io/console').Models.RowList} */ const result = await tablesDB.listRows({ databaseId: '', tableId: '', @@ -143,7 +147,7 @@ The [Appwrite CLI](https://github.com/appwrite/sdk-for-cli) can generate these i Failed requests throw an `AppwriteException` with `message`, `code`, `type` and `response` properties. ```js -import { AppwriteException } from 'appwrite'; +import { AppwriteException } from '@appwrite.io/console'; try { const user = await account.get(); @@ -162,7 +166,6 @@ The [response codes](https://appwrite.io/docs/apis/response-codes) page lists ev - [Web quick start](https://appwrite.io/docs/quick-starts/web) - [Appwrite docs](https://appwrite.io/docs) - [Discord community](https://appwrite.io/discord) -- [Web playground](https://github.com/appwrite/playground-for-web) ## Contribution