Merge pull request #17 from appwrite/dev

christyjacob4 · web-flow · commit 95c774abf408 · 2021-07-07T16:02:51.000+05:30
feat: update version
diff --git a/README.md b/README.md
@@ -1,15 +1,14 @@
 # Appwrite Web SDK
 
 ![License](https://img.shields.io/github/license/appwrite/sdk-for-web.svg?style=flat-square)
-![Version](https://img.shields.io/badge/api%20version-0.8.0-blue.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-0.9.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_io?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite_io)
 [![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord)
 
-**This SDK is compatible with Appwrite server version 0.8.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-web/releases).**
+**This SDK is compatible with Appwrite server version 0.9.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-web/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 Web 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)
+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. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)
 
 ![Appwrite](https://appwrite.io/images/github.png)
 
@@ -34,7 +33,7 @@ import { 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@3.1.0"></script>
+<script src="https://cdn.jsdelivr.net/npm/appwrite@3.2.0"></script>
 ```
 
 
@@ -46,7 +45,7 @@ For you to init your SDK and interact with Appwrite services you need to add a w
 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.
 
 ### Init your SDK
-Initialize your SDK code with your project ID which can be found in your project settings page.
+Initialize your SDK with your Appwrite server API endpoint and project ID which can be found in your project settings page.
 
 ```js
 // Init your Web SDK
@@ -59,7 +58,7 @@ sdk
 ```
 
 ### 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 section.
+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
 // Register User
@@ -92,7 +91,7 @@ sdk.account.create('me@example.com', 'password', 'Jane Doe')
 ```
 
 ### Learn more
-You can use followng resources to learn more and get help
+You can use following resources to learn more and get help
 - 🚀 [Getting Started Tutorial](https://appwrite.io/docs/getting-started-for-flutter)
 - 📜 [Appwrite Docs](https://appwrite.io/docs)
 - 💬 [Discord Community](https://appwrite.io/discord)
diff --git a/docs/examples/account/get-session.md b/docs/examples/account/get-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.getSession('[SESSION_ID]');
+
+promise.then(function (response) {
+    console.log(response); // Success
+}, function (error) {
+    console.log(error); // Failure
+});
diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
   "name": "appwrite",
   "homepage": "https://appwrite.io/support",
   "description": "Appwrite is an open-source self-hosted backend server that abstract and simplify complex and repetitive development tasks behind a very simple REST API",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "license": "BSD-3-Clause",
   "main": "dist/cjs/sdk.js",
   "exports": {
@@ -32,7 +32,7 @@
     "typescript": "^4.2.3"
   },
   "dependencies": {
-    "cross-fetch": "^3.1.0",
+    "cross-fetch": "^3.1.4",
     "isomorphic-form-data": "^2.0.0"
   },
   "jsdelivr": "dist/iife/sdk.js",
diff --git a/src/sdk.ts b/src/sdk.ts
@@ -29,8 +29,8 @@ class Appwrite {
         locale: '',
     };
     headers: Headers = {
-        'x-sdk-version': 'appwrite:web:3.1.0',
-        'X-Appwrite-Response-Format': '0.8.0',
+        'x-sdk-version': 'appwrite:web:3.2.0',
+        'X-Appwrite-Response-Format': '0.9.0',
     };
 
     /**
@@ -316,7 +316,8 @@ class Appwrite {
          * Use this endpoint to create a JSON Web Token. You can use the resulting JWT
          * to authenticate on behalf of the current user when working with the
          * Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes
-         * from its creation and will be invalid if the user will logout.
+         * from its creation and will be invalid if the user will logout in that time
+         * frame.
          *
          * @throws {AppwriteException}
          * @returns {Promise}
@@ -642,9 +643,10 @@ class Appwrite {
          *
          * Use this endpoint to allow a new user to register an anonymous account in
          * your project. This route will also create a new session for the user. To
-         * allow the new user to convert an anonymous account to a normal account
-         * account, you need to update its [email and
-         * password](/docs/client/account#accountUpdateEmail).
+         * allow the new user to convert an anonymous account to a normal account, you
+         * need to update its [email and
+         * password](/docs/client/account#accountUpdateEmail) or create an [OAuth2
+         * session](/docs/client/account#accountCreateOAuth2Session).
          *
          * @throws {AppwriteException}
          * @returns {Promise}
@@ -708,6 +710,30 @@ class Appwrite {
             }
         },
 
+        /**
+         * Get Session By ID
+         *
+         * Use this endpoint to get a logged in user's session using a Session ID.
+         * Inputting 'current' will return the current session being used.
+         *
+         * @param {string} sessionId
+         * @throws {AppwriteException}
+         * @returns {Promise}
+         */
+        getSession: async <T extends unknown>(sessionId: string): Promise<T> => {
+            if (typeof sessionId === 'undefined') {
+                throw new AppwriteException('Missing required parameter: "sessionId"');
+            }
+
+            let path = '/account/sessions/{sessionId}'.replace('{sessionId}', sessionId);
+            let payload: Payload = {};
+
+            const uri = new URL(this.config.endpoint + path);
+            return await this.call('get', uri, {
+                'content-type': 'application/json',
+            }, payload);
+        },
+
         /**
          * Delete Account Session
          *
@@ -1821,6 +1847,7 @@ class Appwrite {
          * @param {string} fileId
          * @param {number} width
          * @param {number} height
+         * @param {string} gravity
          * @param {number} quality
          * @param {number} borderWidth
          * @param {string} borderColor
@@ -1832,7 +1859,7 @@ class Appwrite {
          * @throws {AppwriteException}
          * @returns {URL}
          */
-        getFilePreview: (fileId: string, width?: number, height?: number, quality?: number, borderWidth?: number, borderColor?: string, borderRadius?: number, opacity?: number, rotation?: number, background?: string, output?: string): URL => {
+        getFilePreview: (fileId: string, width?: number, height?: number, gravity?: string, quality?: number, borderWidth?: number, borderColor?: string, borderRadius?: number, opacity?: number, rotation?: number, background?: string, output?: string): URL => {
             if (typeof fileId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "fileId"');
             }
@@ -1848,6 +1875,10 @@ class Appwrite {
                 payload['height'] = height;
             }
 
+            if (typeof gravity !== 'undefined') {
+                payload['gravity'] = gravity;
+            }
+
             if (typeof quality !== 'undefined') {
                 payload['quality'] = quality;
             }
