Merge pull request #146 from appwrite/dev

lohanidamodar · web-flow · commit ef1e00bed2b2 · 2025-10-27T12:10:47.000+05:45
feat: Web SDK update for version 21.3.0
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,13 @@
 # Change Log
 
+## 21.3.0
+
+* Add new `Realtime` service with methods for subscribing to channels and receiving messages
+* Fix `client.setSession` not working when using realtime
+* Deprecate `client.subscribe` method in favor of `Realtime` service
+
+> Note: Deprecated methods are still available for backwards compatibility, but might be removed in future versions.
+
 ## 21.2.1
 
 * Add transaction support for Databases and TablesDB
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@21.2.1"></script>
+<script src="https://cdn.jsdelivr.net/npm/appwrite@21.3.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": "21.2.1",
+  "version": "21.3.0",
   "license": "BSD-3-Clause",
   "main": "dist/cjs/sdk.js",
   "exports": {
diff --git a/src/client.ts b/src/client.ts
@@ -300,7 +300,11 @@ class Client {
     /**
      * Holds configuration such as project.
      */
-    config = {
+    config: {
+        endpoint: string;
+        endpointRealtime: string;
+        [key: string]: string | undefined;
+    } = {
         endpoint: 'https://cloud.appwrite.io/v1',
         endpointRealtime: '',
         project: '',
@@ -316,7 +320,7 @@ class Client {
         'x-sdk-name': 'Web',
         'x-sdk-platform': 'client',
         'x-sdk-language': 'web',
-        'x-sdk-version': '21.2.1',
+        'x-sdk-version': '21.3.0',
         'X-Appwrite-Response-Format': '1.8.0',
     };
 
@@ -473,7 +477,9 @@ class Client {
             }
 
             const channels = new URLSearchParams();
-            channels.set('project', this.config.project);
+            if (this.config.project) {
+                channels.set('project', this.config.project);
+            }
             this.realtime.channels.forEach(channel => {
                 channels.append('channels[]', channel);
             });
@@ -528,10 +534,13 @@ class Client {
                 this.realtime.lastMessage = message;
                 switch (message.type) {
                     case 'connected':
-                        const cookie = JSON.parse(window.localStorage.getItem('cookieFallback') ?? '{}');
-                        const session = cookie?.[`a_session_${this.config.project}`];
-                        const messageData = <RealtimeResponseConnected>message.data;
+                        let session = this.config.session;
+                        if (!session) {
+                            const cookie = JSON.parse(window.localStorage.getItem('cookieFallback') ?? '{}');
+                            session = cookie?.[`a_session_${this.config.project}`];
+                        }
 
+                        const messageData = <RealtimeResponseConnected>message.data;
                         if (session && !messageData.user) {
                             this.realtime.socket?.send(JSON.stringify(<RealtimeRequest>{
                                 type: 'authentication',
@@ -582,6 +591,9 @@ class Client {
     /**
      * Subscribes to Appwrite events and passes you the payload in realtime.
      *
+     * @deprecated Use the Realtime service instead.
+     * @see Realtime
+     *
      * @param {string|string[]} channels
      * Channel to subscribe - pass a single channel as a string or multiple with an array of strings.
      *
diff --git a/src/index.ts b/src/index.ts
@@ -16,6 +16,7 @@ export { Messaging } from './services/messaging';
 export { Storage } from './services/storage';
 export { TablesDB } from './services/tables-db';
 export { Teams } from './services/teams';
+export { Realtime } from './services/realtime';
 export type { Models, Payload, RealtimeResponseEvent, UploadProgress } from './client';
 export type { QueryTypes, QueryTypesList } from './query';
 export { Permission } from './permission';
diff --git a/src/services/realtime.ts b/src/services/realtime.ts
