react-native-appwrite 0.19.0 → 0.20.0

package/docs/examples/teams/list-memberships.md

@@ -1,3 +1,4 @@
+```javascript
 import { Client, Teams } from "react-native-appwrite";
 
 const client = new Client()
@@ -14,3 +15,4 @@ const result = await teams.listMemberships({
 });
 
 console.log(result);
+```

package/docs/examples/teams/list.md

@@ -1,3 +1,4 @@
+```javascript
 import { Client, Teams } from "react-native-appwrite";
 
 const client = new Client()
@@ -13,3 +14,4 @@ const result = await teams.list({
 });
 
 console.log(result);
+```

package/docs/examples/teams/update-membership-status.md

@@ -1,3 +1,4 @@
+```javascript
 import { Client, Teams } from "react-native-appwrite";
 
 const client = new Client()
@@ -14,3 +15,4 @@ const result = await teams.updateMembershipStatus({
 });
 
 console.log(result);
+```

package/docs/examples/teams/update-membership.md

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

package/docs/examples/teams/update-name.md

@@ -1,3 +1,4 @@
+```javascript
 import { Client, Teams } from "react-native-appwrite";
 
 const client = new Client()
@@ -12,3 +13,4 @@ const result = await teams.updateName({
 });
 
 console.log(result);
+```

package/docs/examples/teams/update-prefs.md

@@ -1,3 +1,4 @@
+```javascript
 import { Client, Teams } from "react-native-appwrite";
 
 const client = new Client()
@@ -12,3 +13,4 @@ const result = await teams.updatePrefs({
 });
 
 console.log(result);
+```

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "react-native-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": "0.19.0",
+  "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",
   "license": "BSD-3-Clause",
   "main": "dist/cjs/sdk.js",
   "exports": {
@@ -26,6 +26,7 @@
   },
   "devDependencies": {
     "@rollup/plugin-typescript": "8.3.2",
+    "@types/json-bigint": "1.0.4",
     "playwright": "1.56.1",
     "rollup": "2.75.4",
     "serve-handler": "6.1.0",
@@ -34,7 +35,9 @@
   },
   "dependencies": {
     "expo-file-system": "18.*.*",
-    "react-native": ">=0.76.7 <1.0.0"
+    "json-bigint": "1.0.0",
+    "react-native": ">=0.76.7 <1.0.0",
+    "bignumber.js": "^9.0.0"
   },
   "peerDependencies": {
     "expo": "*"

package/rollup.config.js

@@ -1,9 +1,11 @@
 import pkg from "./package.json";
 import typescript from "@rollup/plugin-typescript";
 
+const external = Object.keys(pkg.dependencies ?? {});
+
 export default {
-    external: Object.keys(pkg.dependencies),
     input: "src/index.ts",
+    external,
     plugins: [typescript()],
     output: [
         {

package/src/channel.ts

@@ -0,0 +1,134 @@
+interface Root {}
+interface Database { _db: any }
+interface Collection { _coll: any }
+interface Document { _doc: any }
+interface TablesDB { _tdb: any }
+interface Table { _tbl: any }
+interface Row { _row: any }
+interface Bucket { _bkt: any }
+interface File { _file: any }
+interface Func { _fn: any }
+interface Execution { _exec: any }
+interface Team { _team: any }
+interface Membership { _mem: any }
+interface Resolved { _res: any }
+
+type Actionable = Document | Row | File | Execution | Team | Membership;
+
+function normalize(id: string): string {
+  const trimmed = id.trim();
+  return trimmed === "" ? "*" : trimmed;
+}
+
+export class Channel<T> {
+  declare _type: T;
+
+  private constructor(private readonly segments: string[]) {}
+
+  private next<N>(segment: string, id: string = "*"): Channel<N> {
+    return new Channel<N>([...this.segments, segment, normalize(id)]) as any;
+  }
+
+  private resolve(action: string): Channel<Resolved> {
+    return new Channel<Resolved>([...this.segments, action]) as any;
+  }
+
+  toString(): string {
+    return this.segments.join(".");
+  }
+
+  // --- DATABASE ROUTE ---
+  // Only available on Channel<Database>
+  collection(this: Channel<Database>, id: string = "*"): Channel<Collection> {
+    return this.next<Collection>("collections", id);
+  }
+
+  // Only available on Channel<Collection>
+  document(this: Channel<Collection>, id: string = "*"): Channel<Document> {
+    return this.next<Document>("documents", id);
+  }
+
+  // --- TABLESDB ROUTE ---
+  table(this: Channel<TablesDB>, id: string = "*"): Channel<Table> {
+    return this.next<Table>("tables", id);
+  }
+
+  row(this: Channel<Table>, id: string = "*"): Channel<Row> {
+    return this.next<Row>("rows", id);
+  }
+
+  // --- BUCKET ROUTE ---
+  file(this: Channel<Bucket>, id: string = "*"): Channel<File> {
+    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> {
+    return this.resolve("create");
+  }
+
+  update(this: Channel<Actionable>): Channel<Resolved> {
+    return this.resolve("update");
+  }
+
+  delete(this: Channel<Actionable>): Channel<Resolved> {
+    return this.resolve("delete");
+  }
+
+  // --- ROOT FACTORIES ---
+  static database(id: string = "*") {
+    return new Channel<Database>(["databases", normalize(id)]);
+  }
+
+  static tablesdb(id: string = "*") {
+    return new Channel<TablesDB>(["tablesdb", normalize(id)]);
+  }
+
+  static bucket(id: string = "*") {
+    return new Channel<Bucket>(["buckets", normalize(id)]);
+  }
+
+  static function(id: string = "*") {
+    return new Channel<Func>(["functions", normalize(id)]);
+  }
+
+  static team(id: string = "*") {
+    return new Channel<Team>(["teams", normalize(id)]);
+  }
+
+  static membership(id: string = "*") {
+    return new Channel<Membership>(["memberships", normalize(id)]);
+  }
+
+  static account(userId: string = ""): string {
+    const id = normalize(userId);
+    return id === "*" ? "account" : `account.${id}`;
+  }
+
+  // Global events
+  static get documents(): string {
+    return "documents";
+  }
+
+  static get rows(): string {
+    return "rows";
+  }
+
+  static get files(): string {
+    return "files";
+  }
+
+  static get executions(): string {
+    return "executions";
+  }
+}
+
+// Export types for backward compatibility with realtime
+export type ActionableChannel = Channel<Document> | Channel<Row> | Channel<File> | Channel<Execution> | Channel<Team> | Channel<Membership>;
+export type ResolvedChannel = Channel<Resolved>;

package/src/client.ts

@@ -1,6 +1,33 @@
 import { Models } from './models';
 import { Service } from './service';
 import { Platform } from 'react-native';
+import JSONbigModule from 'json-bigint';
+import BigNumber from 'bignumber.js';
+const JSONbigParser = JSONbigModule({ storeAsString: false });
+const JSONbigSerializer = JSONbigModule({ useNativeBigInt: true });
+
+const MAX_SAFE = BigInt(Number.MAX_SAFE_INTEGER);
+const MIN_SAFE = BigInt(Number.MIN_SAFE_INTEGER);
+
+function reviver(_key: string, value: any): any {
+    if (BigNumber.isBigNumber(value)) {
+        if (value.isInteger()) {
+            const str = value.toFixed();
+            const bi = BigInt(str);
+            if (bi >= MIN_SAFE && bi <= MAX_SAFE) {
+                return Number(str);
+            }
+            return bi;
+        }
+        return value.toNumber();
+    }
+    return value;
+}
+
+const JSONbig = {
+    parse: (text: string) => JSONbigParser.parse(text, reviver),
+    stringify: JSONbigSerializer.stringify
+};
 
 type Payload = {
     [key: string]: any;
@@ -115,7 +142,7 @@ class Client {
         'x-sdk-name': 'React Native',
         'x-sdk-platform': 'client',
         'x-sdk-language': 'reactnative',
-        'x-sdk-version': '0.19.0',
+        'x-sdk-version': '0.20.0',
         'X-Appwrite-Response-Format': '1.8.0',
     };
 
@@ -129,6 +156,10 @@ class Client {
      * @returns {this}
      */
     setEndpoint(endpoint: string): this {
+        if (!endpoint || typeof endpoint !== 'string') {
+            throw new AppwriteException('Endpoint must be a valid string');
+        }
+
         if (!endpoint.startsWith('http://') && !endpoint.startsWith('https://')) {
             throw new AppwriteException('Invalid endpoint URL: ' + endpoint);
         }
@@ -147,6 +178,10 @@ class Client {
      * @returns {this}
      */
     setEndpointRealtime(endpointRealtime: string): this {
+        if (!endpointRealtime || typeof endpointRealtime !== 'string') {
+            throw new AppwriteException('Endpoint must be a valid string');
+        }
+
         if (!endpointRealtime.startsWith('ws://') && !endpointRealtime.startsWith('wss://')) {
             throw new AppwriteException('Invalid realtime endpoint URL: ' + endpointRealtime);
         }
@@ -278,7 +313,7 @@ class Client {
             }
 
             this.realtime.heartbeat = window?.setInterval(() => {
-                this.realtime.socket?.send(JSON.stringify({
+                this.realtime.socket?.send(JSONbig.stringify({
                     type: 'ping'
                 }));
             }, 20_000);
@@ -347,7 +382,7 @@ class Client {
         },
         onMessage: (event) => {
             try {
-                const message: RealtimeResponse = JSON.parse(event.data);
+                const message: RealtimeResponse = JSONbig.parse(event.data);
                 this.realtime.lastMessage = message;
                 switch (message.type) {
                     case 'event':
@@ -454,7 +489,7 @@ class Client {
         } else {
             switch (headers['content-type']) {
                 case 'application/json':
-                    options.body = JSON.stringify(params);
+                    options.body = JSONbig.stringify(params);
                     break;
 
                 case 'multipart/form-data':
@@ -487,7 +522,7 @@ class Client {
             }
 
             if (response.headers.get('content-type')?.includes('application/json')) {
-                data = await response.json();
+                data = JSONbig.parse(await response.text());
             } else if (responseType === 'arrayBuffer') {
                 data = await response.arrayBuffer();
             } else {
@@ -499,7 +534,7 @@ class Client {
             if (400 <= response.status) {
                 let responseText = '';
                 if (response.headers.get('content-type')?.includes('application/json')) {
-                    responseText = JSON.stringify(data);
+                    responseText = JSONbig.stringify(data);
                 } else {
                     responseText = data?.message;
                 }

package/src/enums/browser-permission.ts

@@ -0,0 +1,22 @@
+export enum BrowserPermission {
+    Geolocation = 'geolocation',
+    Camera = 'camera',
+    Microphone = 'microphone',
+    Notifications = 'notifications',
+    Midi = 'midi',
+    Push = 'push',
+    ClipboardRead = 'clipboard-read',
+    ClipboardWrite = 'clipboard-write',
+    PaymentHandler = 'payment-handler',
+    Usb = 'usb',
+    Bluetooth = 'bluetooth',
+    Accelerometer = 'accelerometer',
+    Gyroscope = 'gyroscope',
+    Magnetometer = 'magnetometer',
+    AmbientLightSensor = 'ambient-light-sensor',
+    BackgroundSync = 'background-sync',
+    PersistentStorage = 'persistent-storage',
+    ScreenWakeLock = 'screen-wake-lock',
+    WebShare = 'web-share',
+    XrSpatialTracking = 'xr-spatial-tracking',
+}

package/src/enums/o-auth-provider.ts

@@ -38,5 +38,4 @@ export enum OAuthProvider {
     Yandex = 'yandex',
     Zoho = 'zoho',
     Zoom = 'zoom',
-    Mock = 'mock',
 }

package/src/enums/roles.ts

@@ -0,0 +1,5 @@
+export enum Roles {
+    Admin = 'admin',
+    Developer = 'developer',
+    Owner = 'owner',
+}

package/src/index.ts

@@ -15,6 +15,7 @@ export { Query } from './query';
 export { Permission } from './permission';
 export { Role } from './role';
 export { ID } from './id';
+export { Channel } from './channel';
 export { Operator, Condition } from './operator';
 export { AuthenticatorType } from './enums/authenticator-type';
 export { AuthenticationFactor } from './enums/authentication-factor';
@@ -24,9 +25,10 @@ export { CreditCard } from './enums/credit-card';
 export { Flag } from './enums/flag';
 export { Theme } from './enums/theme';
 export { Timezone } from './enums/timezone';
-export { Output } from './enums/output';
+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 { ImageFormat } from './enums/image-format';
+export { Roles } from './enums/roles';
 export { ExecutionTrigger } from './enums/execution-trigger';
 export { ExecutionStatus } from './enums/execution-status';

package/src/models.ts

@@ -904,6 +904,14 @@ export namespace Models {
          * Total number of chunks uploaded
          */
         chunksUploaded: number;
+        /**
+         * Whether file contents are encrypted at rest.
+         */
+        encryption: boolean;
+        /**
+         * Compression algorithm used for the file. Will be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd).
+         */
+        compression: string;
     }
 
     /**

package/src/query.ts

@@ -1,5 +1,8 @@
-type QueryTypesSingle = string | number | boolean;
-export type QueryTypesList = string[] | number[] | boolean[] | Query[] | any[];
+import JSONbigModule from 'json-bigint';
+const JSONbig = JSONbigModule({ useNativeBigInt: true });
+
+type QueryTypesSingle = string | number | bigint | boolean;
+export type QueryTypesList = string[] | number[] | bigint[] | boolean[] | Query[] | any[];
 export type QueryTypes = QueryTypesSingle | QueryTypesList;
 type AttributesTypes = string | string[];
 
@@ -26,7 +29,7 @@ export class Query {
   }
 
   toString(): string {
-    return JSON.stringify({
+    return JSONbig.stringify({
       method: this.method,
       attribute: this.attribute,
       values: this.values,
@@ -39,6 +42,16 @@ export class Query {
   static notEqual = (attribute: string, value: QueryTypes): string =>
     new Query("notEqual", attribute, value).toString();
 
+  /**
+   * Filter resources where attribute matches a regular expression pattern.
+   *
+   * @param {string} attribute The attribute to filter on.
+   * @param {string} pattern The regular expression pattern to match.
+   * @returns {string}
+   */
+  static regex = (attribute: string, pattern: string): string =>
+    new Query("regex", attribute, pattern).toString();
+
   static lessThan = (attribute: string, value: QueryTypes): string =>
     new Query("lessThan", attribute, value).toString();
 
@@ -57,7 +70,25 @@ export class Query {
   static isNotNull = (attribute: string): string =>
     new Query("isNotNull", attribute).toString();
 
-  static between = (attribute: string, start: string | number, end: string | number) =>
+  /**
+   * Filter resources where the specified attributes exist.
+   *
+   * @param {string[]} attributes The list of attributes that must exist.
+   * @returns {string}
+   */
+  static exists = (attributes: string[]): string =>
+    new Query("exists", undefined, attributes).toString();
+
+  /**
+   * Filter resources where the specified attributes do not exist.
+   *
+   * @param {string[]} attributes The list of attributes that must not exist.
+   * @returns {string}
+   */
+  static notExists = (attributes: string[]): string =>
+    new Query("notExists", undefined, attributes).toString();
+
+  static between = (attribute: string, start: string | number | bigint, end: string | number | bigint) =>
     new Query("between", attribute, [start, end] as QueryTypesList).toString();
 
   static startsWith = (attribute: string, value: string): string =>
@@ -128,11 +159,11 @@ export class Query {
    * Filter resources where attribute is not between start and end (exclusive).
    *
    * @param {string} attribute
-   * @param {string | number} start
-   * @param {string | number} end
+   * @param {string | number | bigint} start
+   * @param {string | number | bigint} end
    * @returns {string}
    */
-  static notBetween = (attribute: string, start: string | number, end: string | number): string =>
+  static notBetween = (attribute: string, start: string | number | bigint, end: string | number | bigint): string =>
     new Query("notBetween", attribute, [start, end] as QueryTypesList).toString();
 
   /**
@@ -212,10 +243,24 @@ export class Query {
     Query.between("$updatedAt", start, end);
 
   static or = (queries: string[]) =>
-    new Query("or", undefined, queries.map((query) => JSON.parse(query))).toString();
+    new Query("or", undefined, queries.map((query) => JSONbig.parse(query))).toString();
 
   static and = (queries: string[]) =>
-    new Query("and", undefined, queries.map((query) => JSON.parse(query))).toString();
+    new Query("and", undefined, queries.map((query) => JSONbig.parse(query))).toString();
+
+  /**
+   * Filter array elements where at least one element matches all the specified queries.
+   *
+   * @param {string} attribute The attribute containing the array to filter on.
+   * @param {string[]} queries The list of query strings to match against array elements.
+   * @returns {string}
+   */
+  static elemMatch = (attribute: string, queries: string[]): string =>
+    new Query(
+      "elemMatch",
+      attribute,
+      queries.map((query) => JSONbig.parse(query))
+    ).toString();
 
   /**
    * Filter resources where attribute is at a specific distance from the given coordinates.

package/src/services/account.ts

@@ -280,13 +280,42 @@ export class Account extends Service {
     /**
      * Use this endpoint to create a JSON Web Token. You can use the resulting JWT to authenticate on behalf of the current user when working with the Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes from its creation and will be invalid if the user will logout in that time frame.
      *
+     * @param {number} params.duration - Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    createJWT(): Promise<Models.Jwt> {
+    createJWT(params?: { duration?: number  }): Promise<Models.Jwt>;
+    /**
+     * Use this endpoint to create a JSON Web Token. You can use the resulting JWT to authenticate on behalf of the current user when working with the Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes from its creation and will be invalid if the user will logout in that time frame.
+     *
+     * @param {number} duration - Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Jwt>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createJWT(duration?: number): Promise<Models.Jwt>;
+    createJWT(
+        paramsOrFirst?: { duration?: number } | number    
+    ): Promise<Models.Jwt> {
+        let params: { duration?: number };
+
+        if (!paramsOrFirst || (paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
+            params = (paramsOrFirst || {}) as { duration?: number };
+        } else {
+            params = {
+                duration: paramsOrFirst as number            
+            };
+        }
+
+        const duration = params.duration;
+
         const apiPath = '/account/jwts';
         const payload: Payload = {};
 
+        if (typeof duration !== 'undefined') {
+            payload['duration'] = duration;
+        }
+
         const uri = new URL(this.client.config.endpoint + apiPath);
         return this.client.call('post', uri, {
             'content-type': 'application/json',