@appwrite.io/console 2.2.0 → 2.3.1

package/src/client.ts

@@ -1,5 +1,6 @@
 import { Models } from './models';
 import { Channel, ActionableChannel, ResolvedChannel } from './channel';
+import { Query } from './query';
 import JSONbigModule from 'json-bigint';
 import BigNumber from 'bignumber.js';
 const JSONbigParser = JSONbigModule({ storeAsString: false });
@@ -89,12 +90,17 @@ type RealtimeResponseEvent<T extends unknown> = {
     /**
      * Timestamp indicating the time of the event.
      */
-    timestamp: number;
+    timestamp: string;
 
     /**
      * Payload containing event-specific data.
      */
     payload: T;
+
+    /**
+     * Subscription IDs this event matches (from backend, optional).
+     */
+    subscriptions?: string[];
 }
 
 /**
@@ -125,6 +131,11 @@ type RealtimeResponseConnected = {
      * User object representing the connected user (optional).
      */
     user?: object;
+
+    /**
+     * Map slot index -> subscription ID from backend (optional).
+     */
+    subscriptions?: Record<string, string>;
 }
 
 /**
@@ -193,14 +204,30 @@ type Realtime = {
      */
     channels: Set<string>;
 
+    /**
+     * Set of query strings the client is subscribed to.
+     */
+    queries: Set<string>;
+
     /**
      * Map of subscriptions containing channel names and corresponding callback functions.
      */
     subscriptions: Map<number, {
         channels: string[];
+        queries: string[];
         callback: (payload: RealtimeResponseEvent<any>) => void
     }>;
 
+    /**
+     * Map slot index -> subscription ID (from backend, set on 'connected').
+     */
+    slotToSubscriptionId: Map<number, string>;
+
+    /**
+     * Map subscription ID -> slot index (for O(1) event dispatch).
+     */
+    subscriptionIdToSlot: Map<string, number>;
+
     /**
      * Counter for managing subscriptions.
      */
@@ -241,7 +268,7 @@ type Realtime = {
      *
      * @param {string[]} channels - List of channel names to clean up.
      */
-    cleanUp: (channels: string[]) => void;
+    cleanUp: (channels: string[], queries: string[]) => void;
 
     /**
      * Function to handle incoming messages from the WebSocket connection.
@@ -360,7 +387,7 @@ class Client {
         'x-sdk-name': 'Console',
         'x-sdk-platform': 'console',
         'x-sdk-language': 'web',
-        'x-sdk-version': '2.2.0',
+        'x-sdk-version': '2.3.1',
         'X-Appwrite-Response-Format': '1.8.0',
     };
 
@@ -521,7 +548,10 @@ class Client {
         heartbeat: undefined,
         url: '',
         channels: new Set(),
+        queries: new Set(),
         subscriptions: new Map(),
+        slotToSubscriptionId: new Map(),
+        subscriptionIdToSlot: new Map(),
         subscriptionsCounter: 0,
         reconnect: true,
         reconnectAttempts: 0,
@@ -556,21 +586,31 @@ class Client {
             }, 20_000);
         },
         createSocket: () => {
-            if (this.realtime.channels.size < 1) {
+            if (this.realtime.subscriptions.size < 1) {
                 this.realtime.reconnect = false;
                 this.realtime.socket?.close();
                 return;
             }
 
-            const channels = new URLSearchParams();
-            if (this.config.project) {
-                channels.set('project', this.config.project as string);
-            }
+            const encodedProject = encodeURIComponent((this.config.project as string) ?? '');
+            let queryParams = 'project=' + encodedProject;
+
             this.realtime.channels.forEach(channel => {
-                channels.append('channels[]', channel);
+                queryParams += '&channels[]=' + encodeURIComponent(channel);
+            });
+
+            // Per-subscription queries: channel[slot][]=query so server can route events by subscription
+            const selectAllQuery = Query.select(['*']).toString();
+            this.realtime.subscriptions.forEach((sub, slot) => {
+                const queries = sub.queries.length > 0 ? sub.queries : [selectAllQuery];
+                sub.channels.forEach(channel => {
+                    queries.forEach(query => {
+                        queryParams += '&' + encodeURIComponent(channel) + '[' + slot + '][]=' + encodeURIComponent(query);
+                    });
+                });
             });
 
-            const url = this.config.endpointRealtime + '/realtime?' + channels.toString();
+            const url = this.config.endpointRealtime + '/realtime?' + queryParams;
 
             if (
                 url !== this.realtime.url || // Check if URL is present
@@ -619,15 +659,26 @@ class Client {
                 const message: RealtimeResponse = JSONbig.parse(event.data);
                 this.realtime.lastMessage = message;
                 switch (message.type) {
-                    case 'connected':
+                    case 'connected': {
+                        const messageData = <RealtimeResponseConnected>message.data;
+                        if (messageData?.subscriptions) {
+                            this.realtime.slotToSubscriptionId.clear();
+                            this.realtime.subscriptionIdToSlot.clear();
+                            for (const [slotStr, subscriptionId] of Object.entries(messageData.subscriptions)) {
+                                const slot = Number(slotStr);
+                                if (!isNaN(slot) && typeof subscriptionId === 'string') {
+                                    this.realtime.slotToSubscriptionId.set(slot, subscriptionId);
+                                    this.realtime.subscriptionIdToSlot.set(subscriptionId, slot);
+                                }
+                            }
+                        }
+
                         let session = this.config.session;
                         if (!session) {
                             const cookie = JSONbig.parse(window.localStorage.getItem('cookieFallback') ?? '{}');
                             session = cookie?.[`a_session_${this.config.project}`];
                         }
-
-                        const messageData = <RealtimeResponseConnected>message.data;
-                        if (session && !messageData.user) {
+                        if (session && !messageData?.user) {
                             this.realtime.socket?.send(JSONbig.stringify(<RealtimeRequest>{
                                 type: 'authentication',
                                 data: {
@@ -636,18 +687,33 @@ class Client {
                             }));
                         }
                         break;
-                    case 'event':
-                        let data = <RealtimeResponseEvent<unknown>>message.data;
-                        if (data?.channels) {
+                    }
+                    case 'event': {
+                        const data = <RealtimeResponseEvent<unknown>>message.data;
+                        if (!data?.channels) break;
+
+                        const eventSubIds = data.subscriptions;
+                        if (eventSubIds && eventSubIds.length > 0) {
+                            for (const subscriptionId of eventSubIds) {
+                                const slot = this.realtime.subscriptionIdToSlot.get(subscriptionId);
+                                if (slot !== undefined) {
+                                    const subscription = this.realtime.subscriptions.get(slot);
+                                    if (subscription) {
+                                        setTimeout(() => subscription.callback(data));
+                                    }
+                                }
+                            }
+                        } else {
                             const isSubscribed = data.channels.some(channel => this.realtime.channels.has(channel));
-                            if (!isSubscribed) return;
+                            if (!isSubscribed) break;
                             this.realtime.subscriptions.forEach(subscription => {
                                 if (data.channels.some(channel => subscription.channels.includes(channel))) {
                                     setTimeout(() => subscription.callback(data));
                                 }
-                            })
+                            });
                         }
                         break;
+                    }
                     case 'pong':
                         break; // Handle pong response if needed
                     case 'error':
@@ -659,7 +725,7 @@ class Client {
                 console.error(e);
             }
         },
-        cleanUp: channels => {
+        cleanUp: (channels, queries) => {
             this.realtime.channels.forEach(channel => {
                 if (channels.includes(channel)) {
                     let found = Array.from(this.realtime.subscriptions).some(([_key, subscription] )=> {
@@ -671,6 +737,18 @@ class Client {
                     }
                 }
             })
+
+            this.realtime.queries.forEach(query => {
+                if (queries.includes(query)) {
+                    let found = Array.from(this.realtime.subscriptions).some(([_key, subscription]) => {
+                        return subscription.queries?.includes(query);
+                    });
+
+                    if (!found) {
+                        this.realtime.queries.delete(query);
+                    }
+                }
+            })
         }
     }
 
@@ -709,7 +787,11 @@ class Client {
      * @param {(payload: RealtimeMessage) => void} callback Is called on every realtime update.
      * @returns {() => void} Unsubscribes from events.
      */
-    subscribe<T extends unknown>(channels: string | string[] | Channel<any> | ActionableChannel | ResolvedChannel | (Channel<any> | ActionableChannel | ResolvedChannel)[], callback: (payload: RealtimeResponseEvent<T>) => void): () => void {
+    subscribe<T extends unknown>(
+        channels: string | string[] | Channel<any> | ActionableChannel | ResolvedChannel | (Channel<any> | ActionableChannel | ResolvedChannel)[],
+        callback: (payload: RealtimeResponseEvent<T>) => void,
+        queries: (string | Query)[] = []
+    ): () => void {
         const channelArray = Array.isArray(channels) ? channels : [channels];
         // Convert Channel instances to strings
         const channelStrings = channelArray.map(ch => {
@@ -725,9 +807,13 @@ class Client {
         });
         channelStrings.forEach(channel => this.realtime.channels.add(channel));
 
+        const queryStrings = (queries ?? []).map(q => typeof q === 'string' ? q : q.toString());
+        queryStrings.forEach(query => this.realtime.queries.add(query));
+
         const counter = this.realtime.subscriptionsCounter++;
         this.realtime.subscriptions.set(counter, {
             channels: channelStrings,
+            queries: queryStrings,
             callback
         });
 
@@ -735,7 +821,7 @@ class Client {
 
         return () => {
             this.realtime.subscriptions.delete(counter);
-            this.realtime.cleanUp(channelStrings);
+            this.realtime.cleanUp(channelStrings, queryStrings);
             this.realtime.connect();
         }
     }

package/src/enums/{services.ts → backup-services.ts}

@@ -1,4 +1,4 @@
-export enum Services {
+export enum BackupServices {
     Databases = 'databases',
     Functions = 'functions',
     Storage = 'storage',

package/src/enums/build-runtime.ts

@@ -35,6 +35,7 @@ export enum BuildRuntime {
     Dart35 = 'dart-3.5',
     Dart38 = 'dart-3.8',
     Dart39 = 'dart-3.9',
+    Dart310 = 'dart-3.10',
     Dotnet60 = 'dotnet-6.0',
     Dotnet70 = 'dotnet-7.0',
     Dotnet80 = 'dotnet-8.0',
@@ -63,4 +64,5 @@ export enum BuildRuntime {
     Flutter329 = 'flutter-3.29',
     Flutter332 = 'flutter-3.32',
     Flutter335 = 'flutter-3.35',
+    Flutter338 = 'flutter-3.38',
 }

package/src/enums/registration-type.ts

@@ -0,0 +1,6 @@
+export enum RegistrationType {
+    New = 'new',
+    Transfer = 'transfer',
+    Renewal = 'renewal',
+    Trade = 'trade',
+}

package/src/enums/runtime.ts

@@ -35,6 +35,7 @@ export enum Runtime {
     Dart35 = 'dart-3.5',
     Dart38 = 'dart-3.8',
     Dart39 = 'dart-3.9',
+    Dart310 = 'dart-3.10',
     Dotnet60 = 'dotnet-6.0',
     Dotnet70 = 'dotnet-7.0',
     Dotnet80 = 'dotnet-8.0',
@@ -63,4 +64,5 @@ export enum Runtime {
     Flutter329 = 'flutter-3.29',
     Flutter332 = 'flutter-3.32',
     Flutter335 = 'flutter-3.35',
+    Flutter338 = 'flutter-3.38',
 }

package/src/enums/runtimes.ts

@@ -35,6 +35,7 @@ export enum Runtimes {
     Dart35 = 'dart-3.5',
     Dart38 = 'dart-3.8',
     Dart39 = 'dart-3.9',
+    Dart310 = 'dart-3.10',
     Dotnet60 = 'dotnet-6.0',
     Dotnet70 = 'dotnet-7.0',
     Dotnet80 = 'dotnet-8.0',
@@ -63,4 +64,5 @@ export enum Runtimes {
     Flutter329 = 'flutter-3.29',
     Flutter332 = 'flutter-3.32',
     Flutter335 = 'flutter-3.35',
+    Flutter338 = 'flutter-3.38',
 }

package/src/enums/scopes.ts

@@ -62,4 +62,5 @@ export enum Scopes {
     RestorationsWrite = 'restorations.write',
     DomainsRead = 'domains.read',
     DomainsWrite = 'domains.write',
+    EventsRead = 'events.read',
 }

package/src/index.ts

@@ -7,6 +7,7 @@
  */
 export { Client, Query, AppwriteException } from './client';
 export { Account } from './services/account';
+export { Activities } from './services/activities';
 export { Avatars } from './services/avatars';
 export { Backups } from './services/backups';
 export { Assistant } from './services/assistant';
@@ -49,7 +50,7 @@ export { Theme } from './enums/theme';
 export { Timezone } from './enums/timezone';
 export { BrowserPermission } from './enums/browser-permission';
 export { ImageFormat } from './enums/image-format';
-export { Services } from './enums/services';
+export { BackupServices } from './enums/backup-services';
 export { Platform } from './enums/platform';
 export { ConsoleResourceType } from './enums/console-resource-type';
 export { UsageRange } from './enums/usage-range';
@@ -57,6 +58,7 @@ export { RelationshipType } from './enums/relationship-type';
 export { RelationMutate } from './enums/relation-mutate';
 export { IndexType } from './enums/index-type';
 export { OrderBy } from './enums/order-by';
+export { RegistrationType } from './enums/registration-type';
 export { FilterType } from './enums/filter-type';
 export { Runtime } from './enums/runtime';
 export { Runtimes } from './enums/runtimes';
@@ -76,7 +78,6 @@ export { AuthMethod } from './enums/auth-method';
 export { PlatformType } from './enums/platform-type';
 export { ApiService } from './enums/api-service';
 export { SMTPSecure } from './enums/smtp-secure';
-export { Status } from './enums/status';
 export { EmailTemplateType } from './enums/email-template-type';
 export { EmailTemplateLocale } from './enums/email-template-locale';
 export { SmsTemplateType } from './enums/sms-template-type';
@@ -89,7 +90,6 @@ export { Adapter } from './enums/adapter';
 export { Frameworks } from './enums/frameworks';
 export { Compression } from './enums/compression';
 export { ImageGravity } from './enums/image-gravity';
-export { Roles } from './enums/roles';
 export { PasswordHash } from './enums/password-hash';
 export { MessagingProviderType } from './enums/messaging-provider-type';
 export { VCSDetectionType } from './enums/vcs-detection-type';