Added TypeScript support for optional parameters

appwrite · Dec 23, 2020 · 64cdc3e · 64cdc3e
1 parent 3f71ea1
commit 64cdc3e
Show file tree

Hide file tree

Showing 113 changed files with 1,257 additions and 143 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # Appwrite Web SDK
 
 ![License](https://img.shields.io/github/license/appwrite/sdk-for-js.svg?v=1)
-![Version](https://img.shields.io/badge/api%20version-0.6.0-blue.svg?v=1)
+![Version](https://img.shields.io/badge/api%20version-0.6.2-blue.svg?v=1)
 
 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 Web SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools.
@@ -30,9 +30,24 @@ import * as Appwrite from "appwrite";
 To install with a CDN (content delivery network) add the following scripts to the bottom of your <body> tag, but before you use any Appwrite services:
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/appwrite@1.1.0"></script>
+<script src="https://cdn.jsdelivr.net/npm/appwrite@1.2.0"></script>
 ```
 
+## Getting Started
+
+Initialise the Appwrite SDK in your code, and setup your API credentials:
+
+```js
+
+// Init your Web SDK
+var appwrite = new Appwrite();
+
+appwrite
+    .setEndpoint('http://localhost/v1') // Set only when using self-hosted solution
+    .setProject('455x34dfkj') // Your Appwrite Project UID
+;
+
+```
 
 
 ## Contribution

diff --git a/docs/examples/account/create-o-auth2session.md b/docs/examples/account/create-o-auth2session.md
@@ -1,13 +1,10 @@
 let sdk = new Appwrite();
 
 sdk
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
 ;
 
-let promise = sdk.account.createOAuth2Session('bitbucket');
+// Go to OAuth provider login page
+sdk.account.createOAuth2Session('amazon');
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
diff --git a/docs/examples/account/create-recovery.md b/docs/examples/account/create-recovery.md
@@ -1,6 +1,7 @@
 let sdk = new Appwrite();
 
 sdk
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
 ;
 

diff --git a/docs/examples/account/create-session.md b/docs/examples/account/create-session.md
@@ -1,6 +1,7 @@
 let sdk = new Appwrite();
 
 sdk
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
 ;
 

diff --git a/docs/examples/account/create-verification.md b/docs/examples/account/create-verification.md
@@ -1,6 +1,7 @@
 let sdk = new Appwrite();
 
 sdk
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
 ;
 

diff --git a/docs/examples/account/create.md b/docs/examples/account/create.md
@@ -1,6 +1,7 @@
 let sdk = new Appwrite();
 
 sdk
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
 ;
 

diff --git a/docs/examples/account/delete-session.md b/docs/examples/account/delete-session.md
@@ -1,6 +1,7 @@
 let sdk = new Appwrite();
 
 sdk
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
 ;
 

diff --git a/docs/examples/account/delete-sessions.md b/docs/examples/account/delete-sessions.md
@@ -1,6 +1,7 @@
 let sdk = new Appwrite();
 
 sdk
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
 ;
 

diff --git a/docs/examples/account/delete.md b/docs/examples/account/delete.md
@@ -1,6 +1,7 @@
 let sdk = new Appwrite();
 
 sdk
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
 ;
 

diff --git a/docs/examples/account/get-logs.md b/docs/examples/account/get-logs.md
@@ -1,6 +1,7 @@
 let sdk = new Appwrite();
 
 sdk
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
 ;
 

diff --git a/docs/examples/account/get-prefs.md b/docs/examples/account/get-prefs.md
@@ -1,6 +1,7 @@
 let sdk = new Appwrite();
 
 sdk
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
 ;
 

diff --git a/docs/examples/account/get-sessions.md b/docs/examples/account/get-sessions.md
@@ -1,6 +1,7 @@
 let sdk = new Appwrite();
 
 sdk
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
 ;
 

diff --git a/docs/examples/account/get.md b/docs/examples/account/get.md
@@ -1,6 +1,7 @@
 let sdk = new Appwrite();
 
 sdk
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
 ;
 

diff --git a/docs/examples/account/update-email.md b/docs/examples/account/update-email.md
@@ -1,6 +1,7 @@
 let sdk = new Appwrite();
 
 sdk
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
 ;
 

diff --git a/docs/examples/account/update-name.md b/docs/examples/account/update-name.md
@@ -1,6 +1,7 @@
 let sdk = new Appwrite();
 
 sdk
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
 ;
 

diff --git a/docs/examples/account/update-password.md b/docs/examples/account/update-password.md
@@ -1,6 +1,7 @@
 let sdk = new Appwrite();
 
 sdk
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
 ;
 

diff --git a/docs/examples/account/update-prefs.md b/docs/examples/account/update-prefs.md
@@ -1,6 +1,7 @@
 let sdk = new Appwrite();
 
 sdk
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
 ;
 

diff --git a/docs/examples/account/update-recovery.md b/docs/examples/account/update-recovery.md
@@ -1,6 +1,7 @@
 let sdk = new Appwrite();
 
 sdk
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
 ;
 

diff --git a/docs/examples/account/update-verification.md b/docs/examples/account/update-verification.md
@@ -1,6 +1,7 @@
 let sdk = new Appwrite();
 
 sdk
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
 ;
 

diff --git a/docs/examples/avatars/get-browser.md b/docs/examples/avatars/get-browser.md
@@ -1,13 +1,10 @@
 let sdk = new Appwrite();
 
 sdk
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
 ;
 
-let promise = sdk.avatars.getBrowser('aa');
+let result = sdk.avatars.getBrowser('aa');
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(result); // Resource URL
diff --git a/docs/examples/avatars/get-credit-card.md b/docs/examples/avatars/get-credit-card.md
@@ -1,9 +1,10 @@
 let sdk = new Appwrite();
 
 sdk
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
 ;
 
 let result = sdk.avatars.getCreditCard('amex');
 
-console.log(result); // Resource URL
+console.log(result); // Resource URL
diff --git a/docs/examples/avatars/get-favicon.md b/docs/examples/avatars/get-favicon.md
@@ -1,9 +1,10 @@
 let sdk = new Appwrite();
 
 sdk
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
 ;
 
 let result = sdk.avatars.getFavicon('https://example.com');
 
-console.log(result); // Resource URL
+console.log(result); // Resource URL
diff --git a/docs/examples/avatars/get-flag.md b/docs/examples/avatars/get-flag.md
@@ -1,9 +1,10 @@
 let sdk = new Appwrite();
 
 sdk
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
 ;
 
 let result = sdk.avatars.getFlag('af');
 
-console.log(result); // Resource URL
+console.log(result); // Resource URL
diff --git a/docs/examples/avatars/get-image.md b/docs/examples/avatars/get-image.md
@@ -1,9 +1,10 @@
 let sdk = new Appwrite();
 
 sdk
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
 ;
 
 let result = sdk.avatars.getImage('https://example.com');
 
-console.log(result); // Resource URL
+console.log(result); // Resource URL
diff --git a/docs/examples/avatars/get-initials.md b/docs/examples/avatars/get-initials.md
@@ -0,0 +1,10 @@
+let sdk = new Appwrite();
+
+sdk
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+;
+
+let result = sdk.avatars.getInitials();
+
+console.log(result); // Resource URL
diff --git a/docs/examples/avatars/get-q-r.md b/docs/examples/avatars/get-q-r.md
@@ -1,9 +1,10 @@
 let sdk = new Appwrite();
 
 sdk
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
 ;
 
 let result = sdk.avatars.getQR('[TEXT]');
 
-console.log(result); // Resource URL
+console.log(result); // Resource URL
diff --git a/docs/examples/database/create-document.md b/docs/examples/database/create-document.md
@@ -1,6 +1,7 @@
 let sdk = new Appwrite();
 
 sdk
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
 ;
 

diff --git a/docs/examples/database/delete-document.md b/docs/examples/database/delete-document.md
@@ -1,6 +1,7 @@
 let sdk = new Appwrite();
 
 sdk
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
 ;
 

diff --git a/docs/examples/database/get-document.md b/docs/examples/database/get-document.md
@@ -1,6 +1,7 @@
 let sdk = new Appwrite();
 
 sdk
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
 ;
 

diff --git a/docs/examples/database/list-documents.md b/docs/examples/database/list-documents.md
@@ -1,6 +1,7 @@
 let sdk = new Appwrite();
 
 sdk
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
 ;
 

diff --git a/docs/examples/database/update-document.md b/docs/examples/database/update-document.md
@@ -1,6 +1,7 @@
 let sdk = new Appwrite();
 
 sdk
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
 ;
 

diff --git a/docs/examples/examples/account/create-o-auth2session.md b/docs/examples/examples/account/create-o-auth2session.md
@@ -0,0 +1,10 @@
+let sdk = new Appwrite();
+
+sdk
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+;
+
+// Go to OAuth provider login page
+sdk.account.createOAuth2Session('amazon');
+
diff --git a/docs/examples/examples/account/create-recovery.md b/docs/examples/examples/account/create-recovery.md
@@ -0,0 +1,14 @@
+let sdk = new Appwrite();
+
+sdk
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+;
+
+let promise = sdk.account.createRecovery('email@example.com', 'https://example.com');
+
+promise.then(function (response) {
+    console.log(response); // Success
+}, function (error) {
+    console.log(error); // Failure
+});
diff --git a/docs/examples/examples/account/create-session.md b/docs/examples/examples/account/create-session.md
@@ -0,0 +1,14 @@
+let sdk = new Appwrite();
+
+sdk
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+;
+
+let promise = sdk.account.createSession('email@example.com', 'password');
+
+promise.then(function (response) {
+    console.log(response); // Success
+}, function (error) {
+    console.log(error); // Failure
+});
diff --git a/docs/examples/examples/account/create-verification.md b/docs/examples/examples/account/create-verification.md
@@ -0,0 +1,14 @@
+let sdk = new Appwrite();
+
+sdk
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+;
+
+let promise = sdk.account.createVerification('https://example.com');
+
+promise.then(function (response) {
+    console.log(response); // Success
+}, function (error) {
+    console.log(error); // Failure
+});
diff --git a/docs/examples/examples/account/create.md b/docs/examples/examples/account/create.md
@@ -0,0 +1,14 @@
+let sdk = new Appwrite();
+
+sdk
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+;
+
+let promise = sdk.account.create('email@example.com', 'password');
+
+promise.then(function (response) {
+    console.log(response); // Success
+}, function (error) {
+    console.log(error); // Failure
+});