Merge pull request #113 from appwrite/dev

loks0n · web-flow · commit c286ee14ab98 · 2024-12-18T09:55:26.000Z
release: web
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@16.0.3"></script>
+<script src="https://cdn.jsdelivr.net/npm/appwrite@16.1.0"></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": "16.0.3",
+  "version": "16.1.0",
   "license": "BSD-3-Clause",
   "main": "dist/cjs/sdk.js",
   "exports": {
diff --git a/src/client.ts b/src/client.ts
@@ -19,9 +19,9 @@ type Headers = {
  */
 type RealtimeResponse = {
     /**
-     * Type of the response: 'error', 'event', 'connected', or 'response'.
+     * Type of the response: 'error', 'event', 'connected', 'pong', or 'response'.
      */
-    type: 'error' | 'event' | 'connected' | 'response';
+    type: 'error' | 'event' | 'connected' | 'response' | 'pong';
 
     /**
      * Data associated with the response based on the response type.
@@ -129,6 +129,8 @@ type RealtimeRequestAuthenticate = {
     session: string;
 }
 
+type TimeoutHandle = ReturnType<typeof setTimeout> | number;
+
 /**
  * Realtime interface representing the structure of a realtime communication object.
  */
@@ -139,9 +141,14 @@ type Realtime = {
     socket?: WebSocket;
 
     /**
-     * Timeout duration for communication operations.
+     * Timeout for reconnect operations.
      */
-    timeout?: number;
+    timeout?: TimeoutHandle;
+
+    /**
+     * Heartbeat interval for the realtime connection.
+    */
+    heartbeat?: TimeoutHandle;
 
     /**
      * URL for establishing the WebSocket connection.
@@ -196,6 +203,11 @@ type Realtime = {
      */
     createSocket: () => void;
 
+    /**
+     * Function to create a new heartbeat interval.
+     */
+    createHeartbeat: () => void;
+
     /**
      * Function to clean up resources associated with specified channels.
      *
@@ -303,7 +315,7 @@ class Client {
         'x-sdk-name': 'Web',
         'x-sdk-platform': 'client',
         'x-sdk-language': 'web',
-        'x-sdk-version': '16.0.3',
+        'x-sdk-version': '16.1.0',
         'X-Appwrite-Response-Format': '1.6.0',
     };
 
@@ -394,6 +406,7 @@ class Client {
     private realtime: Realtime = {
         socket: undefined,
         timeout: undefined,
+        heartbeat: undefined,
         url: '',
         channels: new Set(),
         subscriptions: new Map(),
@@ -419,6 +432,17 @@ class Client {
                     return 60_000;
             }
         },
+        createHeartbeat: () => {
+            if (this.realtime.heartbeat) {
+                clearTimeout(this.realtime.heartbeat);
+            }
+
+            this.realtime.heartbeat = window?.setInterval(() => {
+                this.realtime.socket?.send(JSON.stringify({
+                    type: 'ping'
+                }));
+            }, 20_000);
+        },
         createSocket: () => {
             if (this.realtime.channels.size < 1) {
                 this.realtime.reconnect = false;
@@ -452,6 +476,7 @@ class Client {
                 this.realtime.socket.addEventListener('message', this.realtime.onMessage);
                 this.realtime.socket.addEventListener('open', _event => {
                     this.realtime.reconnectAttempts = 0;
+                    this.realtime.createHeartbeat();
                 });
                 this.realtime.socket.addEventListener('close', event => {
                     if (
@@ -669,6 +694,10 @@ class Client {
         return response;
     }
 
+    async ping(): Promise<string> {
+        return this.call('GET', new URL(this.config.endpoint + '/ping'));
+    }
+
     async call(method: string, url: URL, headers: Headers = {}, params: Payload = {}, responseType = 'json'): Promise<any> {
         const { uri, options } = this.prepareRequest(method, url, headers, params);
 
diff --git a/src/enums/image-format.ts b/src/enums/image-format.ts
@@ -4,4 +4,5 @@ export enum ImageFormat {
     Gif = 'gif',
     Png = 'png',
     Webp = 'webp',
+    Avif = 'avif',
 }
diff --git a/src/models.ts b/src/models.ts
@@ -842,11 +842,11 @@ export namespace Models {
          */
         userId: string;
         /**
-         * User name.
+         * User name. Hide this attribute by toggling membership privacy in the Console.
          */
         userName: string;
         /**
-         * User email address.
+         * User email address. Hide this attribute by toggling membership privacy in the Console.
          */
         userEmail: string;
         /**
@@ -870,7 +870,7 @@ export namespace Models {
          */
         confirm: boolean;
         /**
-         * Multi factor authentication status, true if the user has MFA enabled or false otherwise.
+         * Multi factor authentication status, true if the user has MFA enabled or false otherwise. Hide this attribute by toggling membership privacy in the Console.
          */
         mfa: boolean;
         /**
@@ -1198,5 +1198,9 @@ export namespace Models {
          * The target identifier.
          */
         identifier: string;
+        /**
+         * Is the target expired.
+         */
+        expired: boolean;
     }
 }
diff --git a/src/services/account.ts b/src/services/account.ts
@@ -129,7 +129,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,
         );
     }
     /**
-     * List Identities
+     * List identities
      *
      * Get the list of identities for the currently logged in user.
      *
@@ -273,7 +273,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,
         );
     }
     /**
-     * Create Authenticator
+     * Create authenticator
      *
      * Add an authenticator app to be used as an MFA factor. Verify the authenticator using the [verify authenticator](/docs/references/cloud/client-web/account#updateMfaAuthenticator) method.
      *
@@ -302,7 +302,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,
         );
     }
     /**
-     * Verify Authenticator
+     * Verify authenticator
      *
      * Verify an authenticator app after adding it using the [add authenticator](/docs/references/cloud/client-web/account#createMfaAuthenticator) method.
      *
@@ -338,7 +338,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,
         );
     }
     /**
-     * Delete Authenticator
+     * Delete authenticator
      *
      * Delete an authenticator for a user by ID.
      *
@@ -367,7 +367,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,
         );
     }
     /**
-     * Create MFA Challenge
+     * Create MFA challenge
      *
      * Begin the process of MFA verification after sign-in. Finish the flow with [updateMfaChallenge](/docs/references/cloud/client-web/account#updateMfaChallenge) method.
      *
@@ -399,7 +399,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,
         );
     }
     /**
-     * Create MFA Challenge (confirmation)
+     * Create MFA challenge (confirmation)
      *
      * Complete the MFA challenge by providing the one-time password. Finish the process of MFA verification by providing the one-time password. To begin the flow, use [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) method.
      *
@@ -438,7 +438,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,
         );
     }
     /**
-     * List Factors
+     * List factors
      *
      * List the factors available on the account to be used as a MFA challange.
      *
@@ -463,7 +463,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,
         );
     }
     /**
-     * Get MFA Recovery Codes
+     * Get MFA recovery codes
      *
      * Get recovery codes that can be used as backup for MFA flow. Before getting codes, they must be generated using [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) method. An OTP challenge is required to read recovery codes.
      *
@@ -488,7 +488,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,
         );
     }
     /**
-     * Create MFA Recovery Codes
+     * Create MFA recovery codes
      *
      * Generate recovery codes as backup for MFA flow. It&#039;s recommended to generate and show then immediately after user successfully adds their authehticator. Recovery codes can be used as a MFA verification type in [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) method.
      *
@@ -513,7 +513,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,
         );
     }
     /**
-     * Regenerate MFA Recovery Codes
+     * Regenerate MFA recovery codes
      *
      * Regenerate recovery codes that can be used as backup for MFA flow. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) method. An OTP challenge is required to regenreate recovery codes.
      *
diff --git a/src/services/locale.ts b/src/services/locale.ts
@@ -37,7 +37,7 @@ export class Locale {
         );
     }
     /**
-     * List Locale Codes
+     * List locale codes
      *
      * List of all locale codes in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).
      *
diff --git a/src/services/storage.ts b/src/services/storage.ts
@@ -178,7 +178,7 @@ If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunk
         );
     }
     /**
-     * Delete File
+     * Delete file
      *
      * Delete a file by its unique ID. Only users with write permissions have access to delete this resource.
      *
diff --git a/src/services/teams.ts b/src/services/teams.ts
@@ -182,7 +182,7 @@ export class Teams {
     /**
      * List team memberships
      *
-     * Use this endpoint to list a team&#039;s members using the team&#039;s ID. All team members have read access to this endpoint.
+     * Use this endpoint to list a team&#039;s members using the team&#039;s ID. All team members have read access to this endpoint. Hide sensitive attributes from the response by toggling membership privacy in the Console.
      *
      * @param {string} teamId
      * @param {string[]} queries
@@ -282,7 +282,7 @@ Please note that to avoid a [Redirect Attack](https://github.com/OWASP/CheatShee
     /**
      * Get team membership
      *
-     * Get a team member by the membership unique id. All team members have read access for this resource.
+     * Get a team member by the membership unique id. All team members have read access for this resource. Hide sensitive attributes from the response by toggling membership privacy in the Console.
      *
      * @param {string} teamId
      * @param {string} membershipId

Original file line number	Diff line number	Diff line change
`@@ -4,4 +4,5 @@ export enum ImageFormat {`
`4`	`4`	`Gif = 'gif',`
`5`	`5`	`Png = 'png',`
`6`	`6`	`Webp = 'webp',`
	`7`	`+ Avif = 'avif',`
`7`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -129,7 +129,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,`
`129`	`129`	`);`
`130`	`130`	`}`
`131`	`131`	`/**`
`132`		`- * List Identities`
	`132`	`+ * List identities`
`133`	`133`	`*`
`134`	`134`	`* Get the list of identities for the currently logged in user.`
`135`	`135`	`*`
`@@ -273,7 +273,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,`
`273`	`273`	`);`
`274`	`274`	`}`
`275`	`275`	`/**`
`276`		`- * Create Authenticator`
	`276`	`+ * Create authenticator`
`277`	`277`	`*`
`278`	`278`	`* Add an authenticator app to be used as an MFA factor. Verify the authenticator using the [verify authenticator](/docs/references/cloud/client-web/account#updateMfaAuthenticator) method.`
`279`	`279`	`*`
`@@ -302,7 +302,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,`
`302`	`302`	`);`
`303`	`303`	`}`
`304`	`304`	`/**`
`305`		`- * Verify Authenticator`
	`305`	`+ * Verify authenticator`
`306`	`306`	`*`
`307`	`307`	`* Verify an authenticator app after adding it using the [add authenticator](/docs/references/cloud/client-web/account#createMfaAuthenticator) method.`
`308`	`308`	`*`
`@@ -338,7 +338,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,`
`338`	`338`	`);`
`339`	`339`	`}`
`340`	`340`	`/**`
`341`		`- * Delete Authenticator`
	`341`	`+ * Delete authenticator`
`342`	`342`	`*`
`343`	`343`	`* Delete an authenticator for a user by ID.`
`344`	`344`	`*`
`@@ -367,7 +367,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,`
`367`	`367`	`);`
`368`	`368`	`}`
`369`	`369`	`/**`
`370`		`- * Create MFA Challenge`
	`370`	`+ * Create MFA challenge`
`371`	`371`	`*`
`372`	`372`	`* Begin the process of MFA verification after sign-in. Finish the flow with [updateMfaChallenge](/docs/references/cloud/client-web/account#updateMfaChallenge) method.`
`373`	`373`	`*`
`@@ -399,7 +399,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,`
`399`	`399`	`);`
`400`	`400`	`}`
`401`	`401`	`/**`
`402`		`- * Create MFA Challenge (confirmation)`
	`402`	`+ * Create MFA challenge (confirmation)`
`403`	`403`	`*`
`404`	`404`	`* Complete the MFA challenge by providing the one-time password. Finish the process of MFA verification by providing the one-time password. To begin the flow, use [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) method.`
`405`	`405`	`*`
`@@ -438,7 +438,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,`
`438`	`438`	`);`
`439`	`439`	`}`
`440`	`440`	`/**`
`441`		`- * List Factors`
	`441`	`+ * List factors`
`442`	`442`	`*`
`443`	`443`	`* List the factors available on the account to be used as a MFA challange.`
`444`	`444`	`*`
`@@ -463,7 +463,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,`
`463`	`463`	`);`
`464`	`464`	`}`
`465`	`465`	`/**`
`466`		`- * Get MFA Recovery Codes`
	`466`	`+ * Get MFA recovery codes`
`467`	`467`	`*`
`468`	`468`	`* Get recovery codes that can be used as backup for MFA flow. Before getting codes, they must be generated using [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) method. An OTP challenge is required to read recovery codes.`
`469`	`469`	`*`
`@@ -488,7 +488,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,`
`488`	`488`	`);`
`489`	`489`	`}`
`490`	`490`	`/**`
`491`		`- * Create MFA Recovery Codes`
	`491`	`+ * Create MFA recovery codes`
`492`	`492`	`*`
`493`	`493`	`* Generate recovery codes as backup for MFA flow. It's recommended to generate and show then immediately after user successfully adds their authehticator. Recovery codes can be used as a MFA verification type in [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) method.`
`494`	`494`	`*`
`@@ -513,7 +513,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,`
`513`	`513`	`);`
`514`	`514`	`}`
`515`	`515`	`/**`
`516`		`- * Regenerate MFA Recovery Codes`
	`516`	`+ * Regenerate MFA recovery codes`
`517`	`517`	`*`
`518`	`518`	`* Regenerate recovery codes that can be used as backup for MFA flow. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) method. An OTP challenge is required to regenreate recovery codes.`
`519`	`519`	`*`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ export class Locale {`
`37`	`37`	`);`
`38`	`38`	`}`
`39`	`39`	`/**`
`40`		`- * List Locale Codes`
	`40`	`+ * List locale codes`
`41`	`41`	`*`
`42`	`42`	`* List of all locale codes in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).`
`43`	`43`	`*`
Original file line number	Diff line number	Diff line change
`@@ -178,7 +178,7 @@ If you're creating a new file using one of the Appwrite SDKs, all the chunk`
`178`	`178`	`);`
`179`	`179`	`}`
`180`	`180`	`/**`
`181`		`- * Delete File`
	`181`	`+ * Delete file`
`182`	`182`	`*`
`183`	`183`	`* Delete a file by its unique ID. Only users with write permissions have access to delete this resource.`
`184`	`184`	`*`
Original file line number	Diff line number	Diff line change
`@@ -182,7 +182,7 @@ export class Teams {`
`182`	`182`	`/**`
`183`	`183`	`* List team memberships`
`184`	`184`	`*`
`185`		`- * Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint.`
	`185`	`+ * Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint. Hide sensitive attributes from the response by toggling membership privacy in the Console.`
`186`	`186`	`*`
`187`	`187`	`* @param {string} teamId`
`188`	`188`	`* @param {string[]} queries`
`@@ -282,7 +282,7 @@ Please note that to avoid a [Redirect Attack](https://github.com/OWASP/CheatShee`
`282`	`282`	`/**`
`283`	`283`	`* Get team membership`
`284`	`284`	`*`
`285`		`- * Get a team member by the membership unique id. All team members have read access for this resource.`
	`285`	`+ * Get a team member by the membership unique id. All team members have read access for this resource. Hide sensitive attributes from the response by toggling membership privacy in the Console.`
`286`	`286`	`*`
`287`	`287`	`* @param {string} teamId`
`288`	`288`	`* @param {string} membershipId`