Merge pull request #118 from appwrite/dev

abnegate · web-flow · commit 3bb1cfab688a · 2025-01-29T22:15:52.000+13:00
fix: pong response &amp; chunked upload
diff --git a/LICENSE b/LICENSE
@@ -1,4 +1,4 @@
-Copyright (c) 2024 Appwrite (https://appwrite.io) and individual contributors.
+Copyright (c) 2025 Appwrite (https://appwrite.io) and individual contributors.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
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-web.svg?style=flat-square)
-![Version](https://img.shields.io/badge/api%20version-1.6.0-blue.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-1.6.1-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)
@@ -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.1.0"></script>
+<script src="https://cdn.jsdelivr.net/npm/appwrite@17.0.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.1.0",
+  "version": "17.0.0",
   "license": "BSD-3-Clause",
   "main": "dist/cjs/sdk.js",
   "exports": {
diff --git a/src/client.ts b/src/client.ts
@@ -19,14 +19,14 @@ type Headers = {
  */
 type RealtimeResponse = {
     /**
-     * Type of the response: 'error', 'event', 'connected', 'pong', or 'response'.
+     * Type of the response: 'error', 'event', 'connected', 'response' or 'pong'.
      */
     type: 'error' | 'event' | 'connected' | 'response' | 'pong';
 
     /**
      * Data associated with the response based on the response type.
      */
-    data: RealtimeResponseAuthenticated | RealtimeResponseConnected | RealtimeResponseError | RealtimeResponseEvent<unknown>;
+    data: RealtimeResponseAuthenticated | RealtimeResponseConnected | RealtimeResponseError | RealtimeResponseEvent<unknown> | undefined;
 }
 
 /**
@@ -315,7 +315,7 @@ class Client {
         'x-sdk-name': 'Web',
         'x-sdk-platform': 'client',
         'x-sdk-language': 'web',
-        'x-sdk-version': '16.1.0',
+        'x-sdk-version': '17.0.0',
         'X-Appwrite-Response-Format': '1.6.0',
     };
 
@@ -531,6 +531,8 @@ class Client {
                             })
                         }
                         break;
+                    case 'pong':
+                        break; // Handle pong response if needed
                     case 'error':
                         throw message.data;
                     default:
diff --git a/src/enums/image-format.ts b/src/enums/image-format.ts
@@ -4,5 +4,6 @@ export enum ImageFormat {
     Gif = 'gif',
     Png = 'png',
     Webp = 'webp',
+    Heic = 'heic',
     Avif = 'avif',
 }
diff --git a/src/services/account.ts b/src/services/account.ts
@@ -406,9 +406,9 @@ This endpoint can also be used to convert an anonymous account to a normal one,
      * @param {string} challengeId
      * @param {string} otp
      * @throws {AppwriteException}
-     * @returns {Promise<{}>}
+     * @returns {Promise<Models.Session>}
      */
-    async updateMfaChallenge(challengeId: string, otp: string): Promise<{}> {
+    async updateMfaChallenge(challengeId: string, otp: string): Promise<Models.Session> {
         if (typeof challengeId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "challengeId"');
         }
@@ -1186,6 +1186,7 @@ A user is limited to 10 active sessions at a time by default. [Learn more about
     /**
      * Create push target
      *
+     * Use this endpoint to register a device for push notifications. Provide a target ID (custom or generated using ID.unique()), a device identifier (usually a device token), and optionally specify which provider should send notifications to this target. The target is automatically linked to the current session and includes device information like brand and model.
      *
      * @param {string} targetId
      * @param {string} identifier
@@ -1228,6 +1229,7 @@ A user is limited to 10 active sessions at a time by default. [Learn more about
     /**
      * Update push target
      *
+     * Update the currently logged in user&#039;s push notification target. You can modify the target&#039;s identifier (device token) and provider ID (token, email, phone etc.). The target must exist and belong to the current user. If you change the provider ID, notifications will be sent through the new messaging provider instead.
      *
      * @param {string} targetId
      * @param {string} identifier
@@ -1263,6 +1265,7 @@ A user is limited to 10 active sessions at a time by default. [Learn more about
     /**
      * Delete push target
      *
+     * Delete a push notification target for the currently logged in user. After deletion, the device will no longer receive push notifications. The target must exist and belong to the current user.
      *
      * @param {string} targetId
      * @throws {AppwriteException}
@@ -1336,7 +1339,7 @@ A user is limited to 10 active sessions at a time by default. [Learn more about
     /**
      * Create magic URL token
      *
-     * Sends the user an email with a secret key for creating a session. If the provided user ID has not been registered, a new user will be created. When the user clicks the link in the email, the user is redirected back to the URL you provided with the secret key and userId values attached to the URL query string. Use the query string parameters to submit a request to the [POST /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) endpoint to complete the login process. The link sent to the user&#039;s email address is valid for 1 hour. If you are on a mobile device you can leave the URL parameter empty, so that the login completion will be handled by your Appwrite instance by default.
+     * Sends the user an email with a secret key for creating a session. If the provided user ID has not been registered, a new user will be created. When the user clicks the link in the email, the user is redirected back to the URL you provided with the secret key and userId values attached to the URL query string. Use the query string parameters to submit a request to the [POST /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) endpoint to complete the login process. The link sent to the user&#039;s email address is valid for 1 hour.
 
 A user is limited to 10 active sessions at a time by default. [Learn more about session limits](https://appwrite.io/docs/authentication-security#limits).
 
diff --git a/src/services/avatars.ts b/src/services/avatars.ts
@@ -54,10 +54,6 @@ When one dimension is specified and the other is 0, the image is scaled with pre
 
         payload['project'] = this.client.config.project;
 
-        for (const [key, value] of Object.entries(Client.flatten(payload))) {
-            uri.searchParams.append(key, value);
-        }
-
         return uri.toString();
     }
     /**
@@ -103,10 +99,6 @@ When one dimension is specified and the other is 0, the image is scaled with pre
 
         payload['project'] = this.client.config.project;
 
-        for (const [key, value] of Object.entries(Client.flatten(payload))) {
-            uri.searchParams.append(key, value);
-        }
-
         return uri.toString();
     }
     /**
@@ -142,10 +134,6 @@ This endpoint does not follow HTTP redirects.
 
         payload['project'] = this.client.config.project;
 
-        for (const [key, value] of Object.entries(Client.flatten(payload))) {
-            uri.searchParams.append(key, value);
-        }
-
         return uri.toString();
     }
     /**
@@ -191,10 +179,6 @@ When one dimension is specified and the other is 0, the image is scaled with pre
 
         payload['project'] = this.client.config.project;
 
-        for (const [key, value] of Object.entries(Client.flatten(payload))) {
-            uri.searchParams.append(key, value);
-        }
-
         return uri.toString();
     }
     /**
@@ -240,10 +224,6 @@ This endpoint does not follow HTTP redirects.
 
         payload['project'] = this.client.config.project;
 
-        for (const [key, value] of Object.entries(Client.flatten(payload))) {
-            uri.searchParams.append(key, value);
-        }
-
         return uri.toString();
     }
     /**
@@ -291,10 +271,6 @@ When one dimension is specified and the other is 0, the image is scaled with pre
 
         payload['project'] = this.client.config.project;
 
-        for (const [key, value] of Object.entries(Client.flatten(payload))) {
-            uri.searchParams.append(key, value);
-        }
-
         return uri.toString();
     }
     /**
@@ -341,10 +317,6 @@ When one dimension is specified and the other is 0, the image is scaled with pre
 
         payload['project'] = this.client.config.project;
 
-        for (const [key, value] of Object.entries(Client.flatten(payload))) {
-            uri.searchParams.append(key, value);
-        }
-
         return uri.toString();
     }
 }
diff --git a/src/services/storage.ts b/src/services/storage.ts
@@ -242,10 +242,6 @@ If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunk
 
         payload['project'] = this.client.config.project;
 
-        for (const [key, value] of Object.entries(Client.flatten(payload))) {
-            uri.searchParams.append(key, value);
-        }
-
         return uri.toString();
     }
     /**
@@ -324,10 +320,6 @@ If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunk
 
         payload['project'] = this.client.config.project;
 
-        for (const [key, value] of Object.entries(Client.flatten(payload))) {
-            uri.searchParams.append(key, value);
-        }
-
         return uri.toString();
     }
     /**
@@ -362,10 +354,6 @@ If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunk
 
         payload['project'] = this.client.config.project;
 
-        for (const [key, value] of Object.entries(Client.flatten(payload))) {
-            uri.searchParams.append(key, value);
-        }
-
         return uri.toString();
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-Copyright (c) 2024 Appwrite (https://appwrite.io) and individual contributors.`
	`1`	`+Copyright (c) 2025 Appwrite (https://appwrite.io) and individual contributors.`
`2`	`2`	`All rights reserved.`
`3`	`3`
`4`	`4`	`Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:`
Original file line number	Diff line number	Diff line change
`@@ -4,5 +4,6 @@ export enum ImageFormat {`
`4`	`4`	`Gif = 'gif',`
`5`	`5`	`Png = 'png',`
`6`	`6`	`Webp = 'webp',`
	`7`	`+ Heic = 'heic',`
`7`	`8`	`Avif = 'avif',`
`8`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -406,9 +406,9 @@ This endpoint can also be used to convert an anonymous account to a normal one,`
`406`	`406`	`* @param {string} challengeId`
`407`	`407`	`* @param {string} otp`
`408`	`408`	`* @throws {AppwriteException}`
`409`		`- * @returns {Promise<{}>}`
	`409`	`+ * @returns {Promise<Models.Session>}`
`410`	`410`	`*/`
`411`		`- async updateMfaChallenge(challengeId: string, otp: string): Promise<{}> {`
	`411`	`+ async updateMfaChallenge(challengeId: string, otp: string): Promise<Models.Session> {`
`412`	`412`	`if (typeof challengeId === 'undefined') {`
`413`	`413`	`throw new AppwriteException('Missing required parameter: "challengeId"');`
`414`	`414`	`}`
`@@ -1186,6 +1186,7 @@ A user is limited to 10 active sessions at a time by default. [Learn more about`
`1186`	`1186`	`/**`
`1187`	`1187`	`* Create push target`
`1188`	`1188`	`*`
	`1189`	`+ * Use this endpoint to register a device for push notifications. Provide a target ID (custom or generated using ID.unique()), a device identifier (usually a device token), and optionally specify which provider should send notifications to this target. The target is automatically linked to the current session and includes device information like brand and model.`
`1189`	`1190`	`*`
`1190`	`1191`	`* @param {string} targetId`
`1191`	`1192`	`* @param {string} identifier`
`@@ -1228,6 +1229,7 @@ A user is limited to 10 active sessions at a time by default. [Learn more about`
`1228`	`1229`	`/**`
`1229`	`1230`	`* Update push target`
`1230`	`1231`	`*`
	`1232`	`+ * Update the currently logged in user's push notification target. You can modify the target's identifier (device token) and provider ID (token, email, phone etc.). The target must exist and belong to the current user. If you change the provider ID, notifications will be sent through the new messaging provider instead.`
`1231`	`1233`	`*`
`1232`	`1234`	`* @param {string} targetId`
`1233`	`1235`	`* @param {string} identifier`
`@@ -1263,6 +1265,7 @@ A user is limited to 10 active sessions at a time by default. [Learn more about`
`1263`	`1265`	`/**`
`1264`	`1266`	`* Delete push target`
`1265`	`1267`	`*`
	`1268`	`+ * Delete a push notification target for the currently logged in user. After deletion, the device will no longer receive push notifications. The target must exist and belong to the current user.`
`1266`	`1269`	`*`
`1267`	`1270`	`* @param {string} targetId`
`1268`	`1271`	`* @throws {AppwriteException}`
`@@ -1336,7 +1339,7 @@ A user is limited to 10 active sessions at a time by default. [Learn more about`
`1336`	`1339`	`/**`
`1337`	`1340`	`* Create magic URL token`
`1338`	`1341`	`*`
`1339`		- * Sends the user an email with a secret key for creating a session. If the provided user ID has not been registered, a new user will be created. When the user clicks the link in the email, the user is redirected back to the URL you provided with the secret key and userId values attached to the URL query string. Use the query string parameters to submit a request to the [POST /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) endpoint to complete the login process. The link sent to the user's email address is valid for 1 hour. If you are on a mobile device you can leave the URL parameter empty, so that the login completion will be handled by your Appwrite instance by default.
	`1342`	+ * Sends the user an email with a secret key for creating a session. If the provided user ID has not been registered, a new user will be created. When the user clicks the link in the email, the user is redirected back to the URL you provided with the secret key and userId values attached to the URL query string. Use the query string parameters to submit a request to the [POST /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) endpoint to complete the login process. The link sent to the user's email address is valid for 1 hour.
`1340`	`1343`
`1341`	`1344`	`A user is limited to 10 active sessions at a time by default. [Learn more about session limits](https://appwrite.io/docs/authentication-security#limits).`
`1342`	`1345`