react-native-appwrite 0.11.0 → 0.13.0

package/README.md

@@ -1,12 +1,12 @@
 # Appwrite React Native SDK
 
 ![License](https://img.shields.io/github/license/appwrite/sdk-for-react-native.svg?style=flat-square)
-![Version](https://img.shields.io/badge/api%20version-1.7.4-blue.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-1.8.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)
 [![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord)
 
-**This SDK is compatible with Appwrite server version 1.7.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-react-native/releases).**
+**This SDK is compatible with Appwrite server version 1.8.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-react-native/releases).**
 
 Appwrite is an open-source backend as a service server that abstract and simplify 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 React Native 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)
 
@@ -21,15 +21,16 @@ npx expo install react-native-appwrite react-native-url-polyfill
 ```
 
 
-
 ## Getting Started
 
 ### Add your Platform
+
 If this is your first time using Appwrite, create an account and create your first project.
 
 Then, under **Add a platform**, add a **Android app** or a **Apple app**. You can skip optional steps.
 
 #### iOS steps
+
 Add your app **name** and **Bundle ID**. You can find your **Bundle Identifier** in the **General** tab for your app's primary target in XCode. For Expo projects you can set or find it on **app.json** file at your project's root directory.
 
 #### Android steps
@@ -47,6 +48,7 @@ import 'react-native-url-polyfill/auto'
 > `cd ios && pod install && cd ..`
 
 ### Init your SDK
+
 Initialize your SDK with your Appwrite server API endpoint and project ID which can be found in your project settings page.
 
 ```js
@@ -62,6 +64,7 @@ client
 ```
 
 ### 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.
 
 ```js
@@ -78,6 +81,7 @@ account.create(ID.unique(), 'me@example.com', 'password', 'Jane Doe')
 ```
 
 ### Full Example
+
 ```js
 import { Client, Account } from 'react-native-appwrite';
 // Init your React Native SDK
@@ -100,13 +104,90 @@ account.create(ID.unique(), 'me@example.com', 'password', 'Jane Doe')
     });
 ```
 
+### Type Safety with Models
+
+The Appwrite React Native 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.
+
+**TypeScript:**
+```typescript
+interface Book {
+    name: string;
+    author: string;
+    releaseYear?: string;
+    category?: string;
+    genre?: string[];
+    isCheckedOut: boolean;
+}
+
+const databases = new Databases(client);
+
+try {
+    const documents = await databases.listDocuments<Book>(
+        '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);
+}
+```
+
+**JavaScript (with JSDoc for type hints):**
+```javascript
+/**
+ * @typedef {Object} Book
+ * @property {string} name
+ * @property {string} author
+ * @property {string} [releaseYear]
+ * @property {string} [category]
+ * @property {string[]} [genre]
+ * @property {boolean} isCheckedOut
+ */
+
+const databases = new Databases(client);
+
+try {
+    /** @type {Models.DocumentList<Book>} */
+    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);
+}
+```
+
+**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).
+
+### Error Handling
+
+The Appwrite React Native 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.
+
+```javascript
+try {
+    const user = await account.create(ID.unique(), "email@example.com", "password", "Walter O'Brien");
+    console.log('User created:', user);
+} catch (error) {
+    console.error('Appwrite error:', error.message);
+}
+```
+
 ### Learn more
+
 You can use the following resources to learn more and get help
 - 🚀 [Getting Started Tutorial](https://appwrite.io/docs/quick-starts/react-native)
 - 📜 [Appwrite Docs](https://appwrite.io/docs)
 - 💬 [Discord Community](https://appwrite.io/discord)
 - 🚂 [Appwrite React Native Playground](https://github.com/appwrite/playground-for-react-native)
 
+
 ## 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.