Merge pull request #92 from appwrite/dev

feat: React Native SDK update for version 1.0.0

Author: ChiragAgg5k

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/databases/list-documents.md

@@ -12,7 +12,8 @@ const result = await databases.listDocuments({
     collectionId: '<COLLECTION_ID>',
     queries: [], // optional
     transactionId: '<TRANSACTION_ID>', // optional
-    total: false // optional
+    total: false, // optional
+    ttl: 0 // optional
 });
 
 console.log(result);

docs/examples/tablesdb/list-rows.md

@@ -12,7 +12,8 @@ const result = await tablesDB.listRows({
     tableId: '<TABLE_ID>',
     queries: [], // optional
     transactionId: '<TRANSACTION_ID>', // optional
-    total: false // optional
+    total: false, // optional
+    ttl: 0 // optional
 });
 
 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.24.1",
+  "version": "1.0.0",
   "license": "BSD-3-Clause",
   "main": "dist/cjs/sdk.js",
   "exports": {

src/channel.ts

@@ -16,17 +16,28 @@ interface Resolved { _res: any }
 type Actionable = Document | Row | File | Team | Membership;
 
 function normalize(id: string): string {
-  const trimmed = id.trim();
-  return trimmed === "" ? "*" : trimmed;
+  if (id === undefined || id === null) {
+    throw new Error("Channel ID is required");
+  }
+  const trimmed = String(id).trim();
+  if (trimmed === "") {
+    throw new Error("Channel ID is required");
+  }
+  return 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 next<N>(segment: string, id?: string): Channel<N> {
+    const segments =
+      id === undefined
+        ? [...this.segments, segment]
+        : [...this.segments, segment, normalize(id)];
+
+    return new Channel<N>(segments) as any;
   }
 
   private resolve(action: string): Channel<Resolved> {
@@ -39,26 +50,26 @@ export class Channel<T> {
 
   // --- DATABASE ROUTE ---
   // Only available on Channel<Database>
-  collection(this: Channel<Database>, id: string = "*"): Channel<Collection> {
+  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> {
+  document(this: Channel<Collection>, id?: string): Channel<Document> {
     return this.next<Document>("documents", id);
   }
 
   // --- TABLESDB ROUTE ---
-  table(this: Channel<TablesDB>, id: string = "*"): Channel<Table> {
+  table(this: Channel<TablesDB>, id: string): Channel<Table> {
     return this.next<Table>("tables", id);
   }
 
-  row(this: Channel<Table>, id: string = "*"): Channel<Row> {
+  row(this: Channel<Table>, id?: string): Channel<Row> {
     return this.next<Row>("rows", id);
   }
 
   // --- BUCKET ROUTE ---
-  file(this: Channel<Bucket>, id: string = "*"): Channel<File> {
+  file(this: Channel<Bucket>, id?: string): Channel<File> {
     return this.next<File>("files", id);
   }
 
@@ -81,31 +92,31 @@ export class Channel<T> {
   }
 
   // --- ROOT FACTORIES ---
-  static database(id: string = "*") {
+  static database(id: string) {
     return new Channel<Database>(["databases", normalize(id)]);
   }
 
-  static tablesdb(id: string = "*") {
+  static tablesdb(id: string) {
     return new Channel<TablesDB>(["tablesdb", normalize(id)]);
   }
 
-  static bucket(id: string = "*") {
+  static bucket(id: string) {
     return new Channel<Bucket>(["buckets", normalize(id)]);
   }
 
-  static function(id: string = "*") {
+  static function(id: string) {
     return new Channel<Func>(["functions", normalize(id)]);
   }
 
-  static execution(id: string = "*") {
+  static execution(id: string) {
     return new Channel<Execution>(["executions", normalize(id)]);
   }
 
-  static team(id: string = "*") {
+  static team(id: string) {
     return new Channel<Team>(["teams", normalize(id)]);
   }
 
-  static membership(id: string = "*") {
+  static membership(id: string) {
     return new Channel<Membership>(["memberships", normalize(id)]);
   }
 

src/client.ts

@@ -158,7 +158,7 @@ class Client {
         'x-sdk-name': 'React Native',
         'x-sdk-platform': 'client',
         'x-sdk-language': 'reactnative',
-        'x-sdk-version': '0.24.1',
+        'x-sdk-version': '1.0.0',
         'X-Appwrite-Response-Format': '1.8.0',
     };
 

src/models.ts

@@ -238,7 +238,7 @@ export namespace Models {
          */
         $id: string;
         /**
-         * Row automatically incrementing ID.
+         * Row sequence ID.
          */
         $sequence: number;
         /**
@@ -277,7 +277,7 @@ export namespace Models {
          */
         $id: string;
         /**
-         * Document automatically incrementing ID.
+         * Document sequence ID.
          */
         $sequence: number;
         /**

src/services/databases.ts

@@ -315,11 +315,12 @@ export class Databases extends Service {
      * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
      * @param {string} params.transactionId - Transaction ID to read uncommitted changes within the transaction.
      * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @param {number} params.ttl - TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).
      * @throws {AppwriteException}
      * @returns {Promise}
      * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.listRows` instead.
      */
-    listDocuments<Document extends Models.Document = Models.DefaultDocument>(params: { databaseId: string, collectionId: string, queries?: string[], transactionId?: string, total?: boolean  }): Promise<Models.DocumentList<Document>>;
+    listDocuments<Document extends Models.Document = Models.DefaultDocument>(params: { databaseId: string, collectionId: string, queries?: string[], transactionId?: string, total?: boolean, ttl?: number  }): Promise<Models.DocumentList<Document>>;
     /**
      * Get a list of all the user's documents in a given collection. You can use the query params to filter your results.
      *
@@ -328,26 +329,28 @@ export class Databases extends Service {
      * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
      * @param {string} transactionId - Transaction ID to read uncommitted changes within the transaction.
      * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @param {number} ttl - TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).
      * @throws {AppwriteException}
      * @returns {Promise<Models.DocumentList<Document>>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listDocuments<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, queries?: string[], transactionId?: string, total?: boolean): Promise<Models.DocumentList<Document>>;
+    listDocuments<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, queries?: string[], transactionId?: string, total?: boolean, ttl?: number): Promise<Models.DocumentList<Document>>;
     listDocuments<Document extends Models.Document = Models.DefaultDocument>(
-        paramsOrFirst: { databaseId: string, collectionId: string, queries?: string[], transactionId?: string, total?: boolean } | string,
-        ...rest: [(string)?, (string[])?, (string)?, (boolean)?]    
+        paramsOrFirst: { databaseId: string, collectionId: string, queries?: string[], transactionId?: string, total?: boolean, ttl?: number } | string,
+        ...rest: [(string)?, (string[])?, (string)?, (boolean)?, (number)?]    
     ): Promise<Models.DocumentList<Document>> {
-        let params: { databaseId: string, collectionId: string, queries?: string[], transactionId?: string, total?: boolean };
+        let params: { databaseId: string, collectionId: string, queries?: string[], transactionId?: string, total?: boolean, ttl?: number };
 
         if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
-            params = (paramsOrFirst || {}) as { databaseId: string, collectionId: string, queries?: string[], transactionId?: string, total?: boolean };
+            params = (paramsOrFirst || {}) as { databaseId: string, collectionId: string, queries?: string[], transactionId?: string, total?: boolean, ttl?: number };
         } else {
             params = {
                 databaseId: paramsOrFirst as string,
                 collectionId: rest[0] as string,
                 queries: rest[1] as string[],
                 transactionId: rest[2] as string,
-                total: rest[3] as boolean            
+                total: rest[3] as boolean,
+                ttl: rest[4] as number            
             };
         }
 
@@ -356,6 +359,7 @@ export class Databases extends Service {
         const queries = params.queries;
         const transactionId = params.transactionId;
         const total = params.total;
+        const ttl = params.ttl;
 
         if (typeof databaseId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "databaseId"');
@@ -380,6 +384,10 @@ export class Databases extends Service {
             payload['total'] = total;
         }
 
+        if (typeof ttl !== 'undefined') {
+            payload['ttl'] = ttl;
+        }
+
         const uri = new URL(this.client.config.endpoint + apiPath);
         return this.client.call('get', uri, {
         }, payload);

src/services/tables-db.ts

@@ -315,10 +315,11 @@ export class TablesDB extends Service {
      * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
      * @param {string} params.transactionId - Transaction ID to read uncommitted changes within the transaction.
      * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @param {number} params.ttl - TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    listRows<Row extends Models.Row = Models.DefaultRow>(params: { databaseId: string, tableId: string, queries?: string[], transactionId?: string, total?: boolean  }): Promise<Models.RowList<Row>>;
+    listRows<Row extends Models.Row = Models.DefaultRow>(params: { databaseId: string, tableId: string, queries?: string[], transactionId?: string, total?: boolean, ttl?: number  }): Promise<Models.RowList<Row>>;
     /**
      * Get a list of all the user's rows in a given table. You can use the query params to filter your results.
      *
@@ -327,26 +328,28 @@ export class TablesDB extends Service {
      * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
      * @param {string} transactionId - Transaction ID to read uncommitted changes within the transaction.
      * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @param {number} ttl - TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).
      * @throws {AppwriteException}
      * @returns {Promise<Models.RowList<Row>>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listRows<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, queries?: string[], transactionId?: string, total?: boolean): Promise<Models.RowList<Row>>;
+    listRows<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, queries?: string[], transactionId?: string, total?: boolean, ttl?: number): Promise<Models.RowList<Row>>;
     listRows<Row extends Models.Row = Models.DefaultRow>(
-        paramsOrFirst: { databaseId: string, tableId: string, queries?: string[], transactionId?: string, total?: boolean } | string,
-        ...rest: [(string)?, (string[])?, (string)?, (boolean)?]    
+        paramsOrFirst: { databaseId: string, tableId: string, queries?: string[], transactionId?: string, total?: boolean, ttl?: number } | string,
+        ...rest: [(string)?, (string[])?, (string)?, (boolean)?, (number)?]    
     ): Promise<Models.RowList<Row>> {
-        let params: { databaseId: string, tableId: string, queries?: string[], transactionId?: string, total?: boolean };
+        let params: { databaseId: string, tableId: string, queries?: string[], transactionId?: string, total?: boolean, ttl?: number };
 
         if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
-            params = (paramsOrFirst || {}) as { databaseId: string, tableId: string, queries?: string[], transactionId?: string, total?: boolean };
+            params = (paramsOrFirst || {}) as { databaseId: string, tableId: string, queries?: string[], transactionId?: string, total?: boolean, ttl?: number };
         } else {
             params = {
                 databaseId: paramsOrFirst as string,
                 tableId: rest[0] as string,
                 queries: rest[1] as string[],
                 transactionId: rest[2] as string,
-                total: rest[3] as boolean            
+                total: rest[3] as boolean,
+                ttl: rest[4] as number            
             };
         }
 
@@ -355,6 +358,7 @@ export class TablesDB extends Service {
         const queries = params.queries;
         const transactionId = params.transactionId;
         const total = params.total;
+        const ttl = params.ttl;
 
         if (typeof databaseId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "databaseId"');
@@ -379,6 +383,10 @@ export class TablesDB extends Service {
             payload['total'] = total;
         }
 
+        if (typeof ttl !== 'undefined') {
+            payload['ttl'] = ttl;
+        }
+
         const uri = new URL(this.client.config.endpoint + apiPath);
         return this.client.call('get', uri, {
         }, payload);

src/services/teams.ts

@@ -371,7 +371,7 @@ export class Teams extends Service {
      * 
      *
      * @param {string} params.teamId - Team ID.
-     * @param {string[]} params.roles - Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.
+     * @param {string[]} params.roles - Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 81 characters long.
      * @param {string} params.email - Email of the new team member.
      * @param {string} params.userId - ID of the user to be added to a team.
      * @param {string} params.phone - Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
@@ -392,7 +392,7 @@ export class Teams extends Service {
      * 
      *
      * @param {string} teamId - Team ID.
-     * @param {string[]} roles - Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.
+     * @param {string[]} roles - Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 81 characters long.
      * @param {string} email - Email of the new team member.
      * @param {string} userId - ID of the user to be added to a team.
      * @param {string} phone - Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
@@ -531,7 +531,7 @@ export class Teams extends Service {
      *
      * @param {string} params.teamId - Team ID.
      * @param {string} params.membershipId - Membership ID.
-     * @param {string[]} params.roles - An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.
+     * @param {string[]} params.roles - An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 81 characters long.
      * @throws {AppwriteException}
      * @returns {Promise}
      */
@@ -542,7 +542,7 @@ export class Teams extends Service {
      *
      * @param {string} teamId - Team ID.
      * @param {string} membershipId - Membership ID.
-     * @param {string[]} roles - An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.
+     * @param {string[]} roles - An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 81 characters long.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Membership>}
      * @deprecated Use the object parameter style method for a better developer experience.