fix: for appwrite 1.4.x

christyjacob4 · christyjacob4 · commit 6fbd8a537ad6 · 2023-08-31T22:01:35.000Z
diff --git a/README.md b/README.md
@@ -33,7 +33,7 @@ import { Client, Account } 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@12.0.0"></script>
+<script src="https://cdn.jsdelivr.net/npm/appwrite@12.0.1"></script>
 ```
 
 
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": "12.0.0",
+  "version": "12.0.1",
   "license": "BSD-3-Clause",
   "main": "dist/cjs/sdk.js",
   "exports": {
diff --git a/src/client.ts b/src/client.ts
@@ -102,7 +102,7 @@ class Client {
         'x-sdk-name': 'Web',
         'x-sdk-platform': 'client',
         'x-sdk-language': 'web',
-        'x-sdk-version': '12.0.0',
+        'x-sdk-version': '12.0.1',
         'X-Appwrite-Response-Format': '1.4.0',
     };
 
diff --git a/src/role.ts b/src/role.ts
@@ -1,34 +1,100 @@
+/**
+ * Helper class to generate role strings for `Permission`.
+ */
 export class Role {
+
+    /**
+     * Grants access to anyone.
+     * 
+     * This includes authenticated and unauthenticated users.
+     * 
+     * @returns {string}
+     */
     public static any(): string {
         return 'any'
     }
 
+    /**
+     * Grants access to a specific user by user ID.
+     * 
+     * You can optionally pass verified or unverified for
+     * `status` to target specific types of users.
+     *
+     * @param {string} id 
+     * @param {string} status 
+     * @returns {string}
+     */
     public static user(id: string, status: string = ''): string {
-        if(status === '') {
+        if (status === '') {
             return `user:${id}`
         }
         return `user:${id}/${status}`
     }
-    
+
+    /**
+     * Grants access to any authenticated or anonymous user.
+     * 
+     * You can optionally pass verified or unverified for
+     * `status` to target specific types of users.
+     * 
+     * @param {string} status 
+     * @returns {string}
+     */
     public static users(status: string = ''): string {
-        if(status === '') {
+        if (status === '') {
             return 'users'
         }
         return `users/${status}`
     }
-    
+
+    /**
+     * Grants access to any guest user without a session.
+     * 
+     * Authenticated users don't have access to this role.
+     * 
+     * @returns {string}
+     */
     public static guests(): string {
         return 'guests'
     }
-    
+
+    /**
+     * Grants access to a team by team ID.
+     * 
+     * You can optionally pass a role for `role` to target
+     * team members with the specified role.
+     * 
+     * @param {string} id 
+     * @param {string} role 
+     * @returns {string}
+     */
     public static team(id: string, role: string = ''): string {
-        if(role === '') {
+        if (role === '') {
             return `team:${id}`
         }
         return `team:${id}/${role}`
     }
 
+    /**
+     * Grants access to a specific member of a team.
+     * 
+     * When the member is removed from the team, they will
+     * no longer have access.
+     * 
+     * @param {string} id 
+     * @returns {string}
+     */
     public static member(id: string): string {
         return `member:${id}`
     }
+
+    /**
+     * Grants access to a user with the specified label.
+     * 
+     * @param {string} name 
+     * @returns  {string}
+     */
+    public static label(name: string): string {
+        return `label:${name}`
+    }
 }
diff --git a/src/services/storage.ts b/src/services/storage.ts
@@ -118,15 +118,15 @@ export class Storage extends Service {
         let id = undefined;
         let response = undefined;
 
-        const headers: { [header: string]: string } = {
+        const apiHeaders: { [header: string]: string } = {
             'content-type': 'multipart/form-data',
         }
 
         let counter = 0;
         const totalCounters = Math.ceil(size / Service.CHUNK_SIZE);
         if(fileId != 'unique()') {
             try {
-                response = await this.client.call('GET', new URL(this.client.config.endpoint + apiPath + '/' + fileId), headers);
+                response = await this.client.call('GET', new URL(this.client.config.endpoint + apiPath + '/' + fileId), apiHeaders);
                 counter = response.chunksUploaded;
             } catch(e) {
             }
@@ -136,16 +136,16 @@ export class Storage extends Service {
             const start = (counter * Service.CHUNK_SIZE);
             const end = Math.min((((counter * Service.CHUNK_SIZE) + Service.CHUNK_SIZE) - 1), size);
 
-            headers['content-range'] = 'bytes ' + start + '-' + end + '/' + size
+            apiHeaders['content-range'] = 'bytes ' + start + '-' + end + '/' + size
 
             if (id) {
-                headers['x-appwrite-id'] = id;
+                apiHeaders['x-appwrite-id'] = id;
             }
 
             const stream = file.slice(start, end + 1);
             payload['file'] = new File([stream], file.name);
 
-            response = await this.client.call('post', uri, headers, payload);
+            response = await this.client.call('post', uri, apiHeaders, payload);
 
             if (!id) {
                 id = response['$id'];
@@ -154,7 +154,7 @@ export class Storage extends Service {
             if (onProgress) {
                 onProgress({
                     $id: response.$id,
-                    progress: Math.min((counter + 1) * Service.CHUNK_SIZE - 1, size) / size * 100,
+                    progress: Math.min((counter + 1) * Service.CHUNK_SIZE, size) / size * 100,
                     sizeUploaded: end,
                     chunksTotal: response.chunksTotal,
                     chunksUploaded: response.chunksUploaded

-Original file line number
+Diff line change
 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/[email protected].0"></script>
 +<script src="https://cdn.jsdelivr.net/npm/[email protected].1"></script>
 ```