Merge pull request #119 from appwrite/dev

Add 1.8.x support

Author: abnegate

README.md

@@ -1,12 +1,12 @@
 # Appwrite Node.js SDK
 
 ![License](https://img.shields.io/github/license/appwrite/sdk-for-node.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-node/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-node/releases).**
 
  > This is the Node.js SDK for integrating with Appwrite from your Node.js server-side code.
                             If you're looking to integrate from the browser, you should check [appwrite/sdk-for-web](https://github.com/appwrite/sdk-for-web)
@@ -27,6 +27,7 @@ npm install node-appwrite --save
 ## Getting Started
 
 ### Init your SDK
+
 Initialize your SDK with your Appwrite server API endpoint and project ID which can be found in your project settings page and your new API secret Key project API keys section.
 
 ```js
@@ -43,6 +44,7 @@ client
 ```
 
 ### Make Your First Request
+
 Once your SDK object is set, create any of the Appwrite service objects 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
@@ -80,7 +82,70 @@ promise.then(function (response) {
 });
 ```
 
+### Type Safety with Models
+
+The Appwrite Node 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 Node SDK raises `AppwriteException` object with `message`, `code` and `response` properties. You can handle any errors by catching `AppwriteException` and present the `message` to the user or handle it yourself based on the provided error information. Below is an example.
 
 ```js

docs/examples/account/create-email-password-session.md

@@ -6,7 +6,7 @@ const client = new sdk.Client()
 
 const account = new sdk.Account(client);
 
-const result = await account.createEmailPasswordSession(
-    'email@example.com', // email
-    'password' // password
-);
+const result = await account.createEmailPasswordSession({
+    email: 'email@example.com',
+    password: 'password'
+});

docs/examples/account/create-email-token.md

@@ -6,8 +6,8 @@ const client = new sdk.Client()
 
 const account = new sdk.Account(client);
 
-const result = await account.createEmailToken(
-    '<USER_ID>', // userId
-    'email@example.com', // email
-    false // phrase (optional)
-);
+const result = await account.createEmailToken({
+    userId: '<USER_ID>',
+    email: 'email@example.com',
+    phrase: false // optional
+});

docs/examples/account/create-j-w-t.md renamed to docs/examples/account/create-jwt.md

@@ -6,9 +6,9 @@ const client = new sdk.Client()
 
 const account = new sdk.Account(client);
 
-const result = await account.createMagicURLToken(
-    '<USER_ID>', // userId
-    'email@example.com', // email
-    'https://example.com', // url (optional)
-    false // phrase (optional)
-);
+const result = await account.createMagicURLToken({
+    userId: '<USER_ID>',
+    email: 'email@example.com',
+    url: 'https://example.com', // optional
+    phrase: false // optional
+});

docs/examples/account/create-magic-u-r-l-token.md renamed to docs/examples/account/create-magic-url-token.md

@@ -7,6 +7,6 @@ const client = new sdk.Client()
 
 const account = new sdk.Account(client);
 
-const result = await account.createMfaAuthenticator(
-    sdk.AuthenticatorType.Totp // type
-);
+const result = await account.createMFAAuthenticator({
+    type: sdk.AuthenticatorType.Totp
+});

docs/examples/account/create-mfa-authenticator.md

@@ -6,6 +6,6 @@ const client = new sdk.Client()
 
 const account = new sdk.Account(client);
 
-const result = await account.createMfaChallenge(
-    sdk.AuthenticationFactor.Email // factor
-);
+const result = await account.createMFAChallenge({
+    factor: sdk.AuthenticationFactor.Email
+});

docs/examples/account/create-mfa-challenge.md

@@ -7,4 +7,4 @@ const client = new sdk.Client()
 
 const account = new sdk.Account(client);
 
-const result = await account.createMfaRecoveryCodes();
+const result = await account.createMFARecoveryCodes();

docs/examples/account/create-mfa-recovery-codes.md

@@ -6,9 +6,9 @@ const client = new sdk.Client()
 
 const account = new sdk.Account(client);
 
-const result = await account.createOAuth2Token(
-    sdk.OAuthProvider.Amazon, // provider
-    'https://example.com', // success (optional)
-    'https://example.com', // failure (optional)
-    [] // scopes (optional)
-);
+const result = await account.createOAuth2Token({
+    provider: sdk.OAuthProvider.Amazon,
+    success: 'https://example.com', // optional
+    failure: 'https://example.com', // optional
+    scopes: [] // optional
+});

docs/examples/account/create-o-auth2token.md renamed to docs/examples/account/create-o-auth-2-token.md

@@ -6,7 +6,7 @@ const client = new sdk.Client()
 
 const account = new sdk.Account(client);
 
-const result = await account.createPhoneToken(
-    '<USER_ID>', // userId
-    '+12065550100' // phone
-);
+const result = await account.createPhoneToken({
+    userId: '<USER_ID>',
+    phone: '+12065550100'
+});