Merge pull request #84 from appwrite/dev

Author: abnegate

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change log
 
+## 0.21.0
+
+* Add `queries` parameter to `client.subscribe()` for filtering Realtime events
+* Fix `Roles` enum removed from Teams service; `roles` parameter now accepts `string[]`
+* Fix parameter detection in overloaded methods to check for optional params (Account, Avatars, Graphql)
+
 ## 0.20.0
 
 * Add array-based enum parameters (e.g., `permissions: BrowserPermission[]`).

README.md

@@ -6,7 +6,7 @@
 [![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)
 
-**This SDK is compatible with Appwrite server version 1.8.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-react-native/releases).**
+**This SDK is compatible with Appwrite server version latest. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-react-native/releases).**
 
 Appwrite is an open-source backend as a service server that abstracts and simplifies complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way. Use the React Native SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)
 

docs/examples/teams/create-membership.md

@@ -1,5 +1,5 @@
 ```javascript
-import { Client, Teams, Roles } from "react-native-appwrite";
+import { Client, Teams } from "react-native-appwrite";
 
 const client = new Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -9,7 +9,7 @@ const teams = new Teams(client);
 
 const result = await teams.createMembership({
     teamId: '<TEAM_ID>',
-    roles: [Roles.Admin],
+    roles: [],
     email: 'email@example.com', // optional
     userId: '<USER_ID>', // optional
     phone: '+12065550100', // optional

docs/examples/teams/update-membership.md

@@ -1,5 +1,5 @@
 ```javascript
-import { Client, Teams, Roles } from "react-native-appwrite";
+import { Client, Teams } from "react-native-appwrite";
 
 const client = new Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -10,7 +10,7 @@ const teams = new Teams(client);
 const result = await teams.updateMembership({
     teamId: '<TEAM_ID>',
     membershipId: '<MEMBERSHIP_ID>',
-    roles: [Roles.Admin]
+    roles: []
 });
 
 console.log(result);

package.json

@@ -2,7 +2,7 @@
   "name": "react-native-appwrite",
   "homepage": "https://appwrite.io/support",
   "description": "Appwrite is an open-source self-hosted backend server that abstracts and simplifies complex and repetitive development tasks behind a very simple REST API",
-  "version": "0.20.0",
+  "version": "0.21.0",
   "license": "BSD-3-Clause",
   "main": "dist/cjs/sdk.js",
   "exports": {

src/channel.ts

@@ -13,7 +13,7 @@ interface Team { _team: any }
 interface Membership { _mem: any }
 interface Resolved { _res: any }
 
-type Actionable = Document | Row | File | Execution | Team | Membership;
+type Actionable = Document | Row | File | Team | Membership;
 
 function normalize(id: string): string {
   const trimmed = id.trim();
@@ -62,11 +62,6 @@ export class Channel<T> {
     return this.next<File>("files", id);
   }
 
-  // --- FUNCTION ROUTE ---
-  execution(this: Channel<Func>, id: string = "*"): Channel<Execution> {
-    return this.next<Execution>("executions", id);
-  }
-
   // --- TERMINAL ACTIONS ---
   // Restricted to the Actionable union
   create(this: Channel<Actionable>): Channel<Resolved> {
@@ -98,6 +93,10 @@ export class Channel<T> {
     return new Channel<Func>(["functions", normalize(id)]);
   }
 
+  static execution(id: string = "*") {
+    return new Channel<Execution>(["executions", normalize(id)]);
+  }
+
   static team(id: string = "*") {
     return new Channel<Team>(["teams", normalize(id)]);
   }
@@ -106,9 +105,8 @@ export class Channel<T> {
     return new Channel<Membership>(["memberships", normalize(id)]);
   }
 
-  static account(userId: string = ""): string {
-    const id = normalize(userId);
-    return id === "*" ? "account" : `account.${id}`;
+  static account(): string {
+    return "account";
   }
 
   // Global events

src/client.ts

@@ -1,6 +1,7 @@
 import { Models } from './models';
 import { Service } from './service';
 import { Platform } from 'react-native';
+import { Query } from './query';
 import JSONbigModule from 'json-bigint';
 import BigNumber from 'bignumber.js';
 const JSONbigParser = JSONbigModule({ storeAsString: false });
@@ -90,8 +91,10 @@ type Realtime = {
     url?: string;
     lastMessage?: RealtimeResponse;
     channels: Set<string>;
+    queries: Set<string>;
     subscriptions: Map<number, {
         channels: string[];
+        queries: string[];
         callback: (payload: RealtimeResponseEvent<any>) => void
     }>;
     subscriptionsCounter: number;
@@ -101,7 +104,7 @@ type Realtime = {
     connect: () => void;
     createSocket: () => void;
     createHeartbeat: () => void;
-    cleanUp: (channels: string[]) => void;
+    cleanUp: (channels: string[], queries: string[]) => void;
     onMessage: (event: MessageEvent) => void;
 }
 
@@ -142,7 +145,7 @@ class Client {
         'x-sdk-name': 'React Native',
         'x-sdk-platform': 'client',
         'x-sdk-language': 'reactnative',
-        'x-sdk-version': '0.20.0',
+        'x-sdk-version': '0.21.0',
         'X-Appwrite-Response-Format': '1.8.0',
     };
 
@@ -284,6 +287,7 @@ class Client {
         heartbeat: undefined,
         url: '',
         channels: new Set(),
+        queries: new Set(),
         subscriptions: new Map(),
         subscriptionsCounter: 0,
         reconnect: true,
@@ -330,6 +334,9 @@ class Client {
             this.realtime.channels.forEach(channel => {
                 channels.append('channels[]', channel);
             });
+            this.realtime.queries.forEach(query => {
+                channels.append('queries[]', query);
+            });
 
             const url = this.config.endpointRealtime + '/realtime?' + channels.toString();
 
@@ -408,7 +415,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] )=> {
@@ -420,6 +427,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);
+                    }
+                }
+            })
         }
     }
 
@@ -448,21 +467,29 @@ 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[], callback: (payload: RealtimeResponseEvent<T>) => void): () => void {
+    subscribe<T extends unknown>(
+        channels: string | string[],
+        callback: (payload: RealtimeResponseEvent<T>) => void,
+        queries: (string | Query)[] = []
+    ): () => void {
         let channelArray = typeof channels === 'string' ? [channels] : channels;
         channelArray.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: channelArray,
+            queries: queryStrings,
             callback
         });
 
         this.realtime.connect();
 
         return () => {
             this.realtime.subscriptions.delete(counter);
-            this.realtime.cleanUp(channelArray);
+            this.realtime.cleanUp(channelArray, queryStrings);
             this.realtime.connect();
         }
     }

src/enums/o-auth-provider.ts

@@ -38,4 +38,6 @@ export enum OAuthProvider {
     Yandex = 'yandex',
     Zoho = 'zoho',
     Zoom = 'zoom',
+    GithubImagine = 'githubImagine',
+    GoogleImagine = 'googleImagine',
 }

src/enums/roles.ts

@@ -29,6 +29,5 @@ export { BrowserPermission } from './enums/browser-permission';
 export { ImageFormat } from './enums/image-format';
 export { ExecutionMethod } from './enums/execution-method';
 export { ImageGravity } from './enums/image-gravity';
-export { Roles } from './enums/roles';
 export { ExecutionTrigger } from './enums/execution-trigger';
 export { ExecutionStatus } from './enums/execution-status';