react-native-appwrite 0.17.1 → 0.18.0

package/docs/examples/account/list-identities.md

@@ -7,7 +7,8 @@ const client = new Client()
 const account = new Account(client);
 
 const result = await account.listIdentities({
-    queries: [] // optional
+    queries: [], // optional
+    total: false // optional
 });
 
 console.log(result);

package/docs/examples/account/list-logs.md

@@ -7,7 +7,8 @@ const client = new Client()
 const account = new Account(client);
 
 const result = await account.listLogs({
-    queries: [] // optional
+    queries: [], // optional
+    total: false // optional
 });
 
 console.log(result);

package/docs/examples/databases/create-document.md

@@ -1,4 +1,4 @@
-import { Client, Databases } from "react-native-appwrite";
+import { Client, Databases, Permission, Role } from "react-native-appwrite";
 
 const client = new Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint

package/docs/examples/databases/list-documents.md

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

package/docs/examples/databases/update-document.md

@@ -1,4 +1,4 @@
-import { Client, Databases } from "react-native-appwrite";
+import { Client, Databases, Permission, Role } from "react-native-appwrite";
 
 const client = new Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint

package/docs/examples/databases/upsert-document.md

@@ -1,4 +1,4 @@
-import { Client, Databases } from "react-native-appwrite";
+import { Client, Databases, Permission, Role } from "react-native-appwrite";
 
 const client = new Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint

package/docs/examples/functions/list-executions.md

@@ -8,7 +8,8 @@ const functions = new Functions(client);
 
 const result = await functions.listExecutions({
     functionId: '<FUNCTION_ID>',
-    queries: [] // optional
+    queries: [], // optional
+    total: false // optional
 });
 
 console.log(result);

package/docs/examples/storage/create-file.md

@@ -1,4 +1,4 @@
-import { Client, Storage } from "react-native-appwrite";
+import { Client, Storage, Permission, Role } from "react-native-appwrite";
 
 const client = new Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint

package/docs/examples/storage/list-files.md

@@ -9,7 +9,8 @@ const storage = new Storage(client);
 const result = await storage.listFiles({
     bucketId: '<BUCKET_ID>',
     queries: [], // optional
-    search: '<SEARCH>' // optional
+    search: '<SEARCH>', // optional
+    total: false // optional
 });
 
 console.log(result);

package/docs/examples/storage/update-file.md

@@ -1,4 +1,4 @@
-import { Client, Storage } from "react-native-appwrite";
+import { Client, Storage, Permission, Role } from "react-native-appwrite";
 
 const client = new Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint

package/docs/examples/tablesdb/create-row.md

@@ -1,4 +1,4 @@
-import { Client, TablesDB } from "react-native-appwrite";
+import { Client, TablesDB, Permission, Role } from "react-native-appwrite";
 
 const client = new Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint

package/docs/examples/tablesdb/list-rows.md

@@ -10,7 +10,8 @@ const result = await tablesDB.listRows({
     databaseId: '<DATABASE_ID>',
     tableId: '<TABLE_ID>',
     queries: [], // optional
-    transactionId: '<TRANSACTION_ID>' // optional
+    transactionId: '<TRANSACTION_ID>', // optional
+    total: false // optional
 });
 
 console.log(result);

package/docs/examples/tablesdb/update-row.md

@@ -1,4 +1,4 @@
-import { Client, TablesDB } from "react-native-appwrite";
+import { Client, TablesDB, Permission, Role } from "react-native-appwrite";
 
 const client = new Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint

package/docs/examples/tablesdb/upsert-row.md

@@ -1,4 +1,4 @@
-import { Client, TablesDB } from "react-native-appwrite";
+import { Client, TablesDB, Permission, Role } from "react-native-appwrite";
 
 const client = new Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint

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

@@ -9,7 +9,8 @@ const teams = new Teams(client);
 const result = await teams.listMemberships({
     teamId: '<TEAM_ID>',
     queries: [], // optional
-    search: '<SEARCH>' // optional
+    search: '<SEARCH>', // optional
+    total: false // optional
 });
 
 console.log(result);

package/docs/examples/teams/list.md

@@ -8,7 +8,8 @@ const teams = new Teams(client);
 
 const result = await teams.list({
     queries: [], // optional
-    search: '<SEARCH>' // optional
+    search: '<SEARCH>', // optional
+    total: false // optional
 });
 
 console.log(result);

package/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 abstract and simplify complex and repetitive development tasks behind a very simple REST API",
-  "version": "0.17.1",
+  "version": "0.18.0",
   "license": "BSD-3-Clause",
   "main": "dist/cjs/sdk.js",
   "exports": {
@@ -37,7 +37,6 @@
     "react-native": ">=0.76.7 <1.0.0"
   },
   "peerDependencies": {
-    "expo": "*",
-    "react-native": "*"
+    "expo": "*"
   }
 }

package/src/client.ts

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

package/src/enums/execution-status.ts

@@ -3,4 +3,5 @@ export enum ExecutionStatus {
     Processing = 'processing',
     Completed = 'completed',
     Failed = 'failed',
+    Scheduled = 'scheduled',
 }

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 { Operator, Condition } from './operator';
 export { AuthenticatorType } from './enums/authenticator-type';
 export { AuthenticationFactor } from './enums/authentication-factor';
 export { OAuthProvider } from './enums/o-auth-provider';
@@ -24,3 +25,5 @@ export { Flag } from './enums/flag';
 export { ExecutionMethod } from './enums/execution-method';
 export { ImageGravity } from './enums/image-gravity';
 export { ImageFormat } from './enums/image-format';
+export { ExecutionTrigger } from './enums/execution-trigger';
+export { ExecutionStatus } from './enums/execution-status';

package/src/models.ts

@@ -1027,7 +1027,7 @@ export namespace Models {
          */
         trigger: ExecutionTrigger;
         /**
-         * The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, or `failed`.
+         * The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, `failed`, or `scheduled`.
          */
         status: ExecutionStatus;
         /**

package/src/operator.ts

@@ -0,0 +1,308 @@
+type OperatorValuesSingle = string | number | boolean;
+export type OperatorValuesList = string[] | number[] | boolean[] | any[];
+export type OperatorValues = OperatorValuesSingle | OperatorValuesList;
+
+export enum Condition {
+  Equal = "equal",
+  NotEqual = "notEqual",
+  GreaterThan = "greaterThan",
+  GreaterThanEqual = "greaterThanEqual",
+  LessThan = "lessThan",
+  LessThanEqual = "lessThanEqual",
+  Contains = "contains",
+  IsNull = "isNull",
+  IsNotNull = "isNotNull",
+}
+
+/**
+ * Helper class to generate operator strings for atomic operations.
+ */
+export class Operator {
+  method: string;
+  values: OperatorValuesList | undefined;
+
+  /**
+   * Constructor for Operator class.
+   *
+   * @param {string} method
+   * @param {OperatorValues} values
+   */
+  constructor(
+    method: string,
+    values?: OperatorValues
+  ) {
+    this.method = method;
+
+    if (values !== undefined) {
+      if (Array.isArray(values)) {
+        this.values = values;
+      } else {
+        this.values = [values] as OperatorValuesList;
+      }
+    }
+  }
+
+  /**
+   * Convert the operator object to a JSON string.
+   *
+   * @returns {string}
+   */
+  toString(): string {
+    return JSON.stringify({
+      method: this.method,
+      values: this.values,
+    });
+  }
+
+  /**
+   * Increment a numeric attribute by a specified value.
+   *
+   * @param {number} value
+   * @param {number} max
+   * @returns {string}
+   */
+  static increment = (value: number = 1, max?: number): string => {
+    if (isNaN(value) || !isFinite(value)) {
+      throw new Error("Value cannot be NaN or Infinity");
+    }
+    if (max !== undefined && (isNaN(max) || !isFinite(max))) {
+      throw new Error("Max cannot be NaN or Infinity");
+    }
+    const values: any[] = [value];
+    if (max !== undefined) {
+      values.push(max);
+    }
+    return new Operator("increment", values).toString();
+  };
+
+  /**
+   * Decrement a numeric attribute by a specified value.
+   *
+   * @param {number} value
+   * @param {number} min
+   * @returns {string}
+   */
+  static decrement = (value: number = 1, min?: number): string => {
+    if (isNaN(value) || !isFinite(value)) {
+      throw new Error("Value cannot be NaN or Infinity");
+    }
+    if (min !== undefined && (isNaN(min) || !isFinite(min))) {
+      throw new Error("Min cannot be NaN or Infinity");
+    }
+    const values: any[] = [value];
+    if (min !== undefined) {
+      values.push(min);
+    }
+    return new Operator("decrement", values).toString();
+  };
+
+  /**
+   * Multiply a numeric attribute by a specified factor.
+   *
+   * @param {number} factor
+   * @param {number} max
+   * @returns {string}
+   */
+  static multiply = (factor: number, max?: number): string => {
+    if (isNaN(factor) || !isFinite(factor)) {
+      throw new Error("Factor cannot be NaN or Infinity");
+    }
+    if (max !== undefined && (isNaN(max) || !isFinite(max))) {
+      throw new Error("Max cannot be NaN or Infinity");
+    }
+    const values: any[] = [factor];
+    if (max !== undefined) {
+      values.push(max);
+    }
+    return new Operator("multiply", values).toString();
+  };
+
+  /**
+   * Divide a numeric attribute by a specified divisor.
+   *
+   * @param {number} divisor
+   * @param {number} min
+   * @returns {string}
+   */
+  static divide = (divisor: number, min?: number): string => {
+    if (isNaN(divisor) || !isFinite(divisor)) {
+      throw new Error("Divisor cannot be NaN or Infinity");
+    }
+    if (min !== undefined && (isNaN(min) || !isFinite(min))) {
+      throw new Error("Min cannot be NaN or Infinity");
+    }
+    if (divisor === 0) {
+      throw new Error("Divisor cannot be zero");
+    }
+    const values: any[] = [divisor];
+    if (min !== undefined) {
+      values.push(min);
+    }
+    return new Operator("divide", values).toString();
+  };
+
+  /**
+   * Apply modulo operation on a numeric attribute.
+   *
+   * @param {number} divisor
+   * @returns {string}
+   */
+  static modulo = (divisor: number): string => {
+    if (isNaN(divisor) || !isFinite(divisor)) {
+      throw new Error("Divisor cannot be NaN or Infinity");
+    }
+    if (divisor === 0) {
+      throw new Error("Divisor cannot be zero");
+    }
+    return new Operator("modulo", [divisor]).toString();
+  };
+
+  /**
+   * Raise a numeric attribute to a specified power.
+   *
+   * @param {number} exponent
+   * @param {number} max
+   * @returns {string}
+   */
+  static power = (exponent: number, max?: number): string => {
+    if (isNaN(exponent) || !isFinite(exponent)) {
+      throw new Error("Exponent cannot be NaN or Infinity");
+    }
+    if (max !== undefined && (isNaN(max) || !isFinite(max))) {
+      throw new Error("Max cannot be NaN or Infinity");
+    }
+    const values: any[] = [exponent];
+    if (max !== undefined) {
+      values.push(max);
+    }
+    return new Operator("power", values).toString();
+  };
+
+  /**
+   * Append values to an array attribute.
+   *
+   * @param {any[]} values
+   * @returns {string}
+   */
+  static arrayAppend = (values: any[]): string =>
+    new Operator("arrayAppend", values).toString();
+
+  /**
+   * Prepend values to an array attribute.
+   *
+   * @param {any[]} values
+   * @returns {string}
+   */
+  static arrayPrepend = (values: any[]): string =>
+    new Operator("arrayPrepend", values).toString();
+
+  /**
+   * Insert a value at a specific index in an array attribute.
+   *
+   * @param {number} index
+   * @param {any} value
+   * @returns {string}
+   */
+  static arrayInsert = (index: number, value: any): string =>
+    new Operator("arrayInsert", [index, value]).toString();
+
+  /**
+   * Remove a value from an array attribute.
+   *
+   * @param {any} value
+   * @returns {string}
+   */
+  static arrayRemove = (value: any): string =>
+    new Operator("arrayRemove", [value]).toString();
+
+  /**
+   * Remove duplicate values from an array attribute.
+   *
+   * @returns {string}
+   */
+  static arrayUnique = (): string =>
+    new Operator("arrayUnique", []).toString();
+
+  /**
+   * Keep only values that exist in both the current array and the provided array.
+   *
+   * @param {any[]} values
+   * @returns {string}
+   */
+  static arrayIntersect = (values: any[]): string =>
+    new Operator("arrayIntersect", values).toString();
+
+  /**
+   * Remove values from the array that exist in the provided array.
+   *
+   * @param {any[]} values
+   * @returns {string}
+   */
+  static arrayDiff = (values: any[]): string =>
+    new Operator("arrayDiff", values).toString();
+
+  /**
+   * Filter array values based on a condition.
+   *
+   * @param {Condition} condition
+   * @param {any} value
+   * @returns {string}
+   */
+  static arrayFilter = (condition: Condition, value?: any): string => {
+    const values: any[] = [condition as string, value === undefined ? null : value];
+    return new Operator("arrayFilter", values).toString();
+  };
+
+  /**
+   * Concatenate a value to a string or array attribute.
+   *
+   * @param {any} value
+   * @returns {string}
+   */
+  static stringConcat = (value: any): string =>
+    new Operator("stringConcat", [value]).toString();
+
+  /**
+   * Replace occurrences of a search string with a replacement string.
+   *
+   * @param {string} search
+   * @param {string} replace
+   * @returns {string}
+   */
+  static stringReplace = (search: string, replace: string): string =>
+    new Operator("stringReplace", [search, replace]).toString();
+
+  /**
+   * Toggle a boolean attribute.
+   *
+   * @returns {string}
+   */
+  static toggle = (): string =>
+    new Operator("toggle", []).toString();
+
+  /**
+   * Add days to a date attribute.
+   *
+   * @param {number} days
+   * @returns {string}
+   */
+  static dateAddDays = (days: number): string =>
+    new Operator("dateAddDays", [days]).toString();
+
+  /**
+   * Subtract days from a date attribute.
+   *
+   * @param {number} days
+   * @returns {string}
+   */
+  static dateSubDays = (days: number): string =>
+    new Operator("dateSubDays", [days]).toString();
+
+  /**
+   * Set a date attribute to the current date and time.
+   *
+   * @returns {string}
+   */
+  static dateSetNow = (): string =>
+    new Operator("dateSetNow", []).toString();
+}

package/src/query.ts

@@ -162,7 +162,7 @@ export class Query {
    * @returns {string}
    */
   static createdBefore = (value: string): string =>
-    new Query("createdBefore", undefined, value).toString();
+    Query.lessThan("$createdAt", value);
 
   /**
    * Filter resources where document was created after date.
@@ -171,7 +171,7 @@ export class Query {
    * @returns {string}
    */
   static createdAfter = (value: string): string =>
-    new Query("createdAfter", undefined, value).toString();
+    Query.greaterThan("$createdAt", value);
 
   /**
    * Filter resources where document was created between dates.
@@ -181,7 +181,7 @@ export class Query {
    * @returns {string}
    */
   static createdBetween = (start: string, end: string): string =>
-    new Query("createdBetween", undefined, [start, end] as QueryTypesList).toString();
+    Query.between("$createdAt", start, end);
 
   /**
    * Filter resources where document was updated before date.
@@ -190,7 +190,7 @@ export class Query {
    * @returns {string}
    */
   static updatedBefore = (value: string): string =>
-    new Query("updatedBefore", undefined, value).toString();
+    Query.lessThan("$updatedAt", value);
 
   /**
    * Filter resources where document was updated after date.
@@ -199,7 +199,7 @@ export class Query {
    * @returns {string}
    */
   static updatedAfter = (value: string): string =>
-    new Query("updatedAfter", undefined, value).toString();
+    Query.greaterThan("$updatedAt", value);
 
   /**
    * Filter resources where document was updated between dates.
@@ -209,7 +209,7 @@ export class Query {
    * @returns {string}
    */
   static updatedBetween = (start: string, end: string): string =>
-    new Query("updatedBetween", undefined, [start, end] as QueryTypesList).toString();
+    Query.between("$updatedAt", start, end);
 
   static or = (queries: string[]) =>
     new Query("or", undefined, queries.map((query) => JSON.parse(query))).toString();