react-native-appwrite 0.17.1 → 0.19.0

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();

package/src/services/account.ts

@@ -183,33 +183,38 @@ export class Account extends Service {
      * Get the list of identities for the currently logged in user.
      *
      * @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. You may filter on the following attributes: userId, provider, providerUid, providerEmail, providerAccessTokenExpiry
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    listIdentities(params?: { queries?: string[]  }): Promise<Models.IdentityList>;
+    listIdentities(params?: { queries?: string[], total?: boolean  }): Promise<Models.IdentityList>;
     /**
      * Get the list of identities for the currently logged in user.
      *
      * @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. You may filter on the following attributes: userId, provider, providerUid, providerEmail, providerAccessTokenExpiry
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.IdentityList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listIdentities(queries?: string[]): Promise<Models.IdentityList>;
+    listIdentities(queries?: string[], total?: boolean): Promise<Models.IdentityList>;
     listIdentities(
-        paramsOrFirst?: { queries?: string[] } | string[]    
+        paramsOrFirst?: { queries?: string[], total?: boolean } | string[],
+        ...rest: [(boolean)?]    
     ): Promise<Models.IdentityList> {
-        let params: { queries?: string[] };
+        let params: { queries?: string[], total?: boolean };
 
         if (!paramsOrFirst || (paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
-            params = (paramsOrFirst || {}) as { queries?: string[] };
+            params = (paramsOrFirst || {}) as { queries?: string[], total?: boolean };
         } else {
             params = {
-                queries: paramsOrFirst as string[]            
+                queries: paramsOrFirst as string[],
+                total: rest[0] as boolean            
             };
         }
 
         const queries = params.queries;
+        const total = params.total;
 
         const apiPath = '/account/identities';
         const payload: Payload = {};
@@ -218,6 +223,10 @@ export class Account extends Service {
             payload['queries'] = queries;
         }
 
+        if (typeof total !== 'undefined') {
+            payload['total'] = total;
+        }
+
         const uri = new URL(this.client.config.endpoint + apiPath);
         return this.client.call('get', uri, {
         }, payload);
@@ -288,33 +297,38 @@ export class Account extends Service {
      * Get the list of latest security activity logs for the currently logged in user. Each log returns user IP address, location and date and time of log.
      *
      * @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). Only supported methods are limit and offset
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    listLogs(params?: { queries?: string[]  }): Promise<Models.LogList>;
+    listLogs(params?: { queries?: string[], total?: boolean  }): Promise<Models.LogList>;
     /**
      * Get the list of latest security activity logs for the currently logged in user. Each log returns user IP address, location and date and time of log.
      *
      * @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). Only supported methods are limit and offset
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.LogList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listLogs(queries?: string[]): Promise<Models.LogList>;
+    listLogs(queries?: string[], total?: boolean): Promise<Models.LogList>;
     listLogs(
-        paramsOrFirst?: { queries?: string[] } | string[]    
+        paramsOrFirst?: { queries?: string[], total?: boolean } | string[],
+        ...rest: [(boolean)?]    
     ): Promise<Models.LogList> {
-        let params: { queries?: string[] };
+        let params: { queries?: string[], total?: boolean };
 
         if (!paramsOrFirst || (paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
-            params = (paramsOrFirst || {}) as { queries?: string[] };
+            params = (paramsOrFirst || {}) as { queries?: string[], total?: boolean };
         } else {
             params = {
-                queries: paramsOrFirst as string[]            
+                queries: paramsOrFirst as string[],
+                total: rest[0] as boolean            
             };
         }
 
         const queries = params.queries;
+        const total = params.total;
 
         const apiPath = '/account/logs';
         const payload: Payload = {};
@@ -323,6 +337,10 @@ export class Account extends Service {
             payload['queries'] = queries;
         }
 
+        if (typeof total !== 'undefined') {
+            payload['total'] = total;
+        }
+
         const uri = new URL(this.client.config.endpoint + apiPath);
         return this.client.call('get', uri, {
         }, payload);
@@ -713,7 +731,7 @@ export class Account extends Service {
             throw new AppwriteException('Missing required parameter: "factor"');
         }
 
-        const apiPath = '/account/mfa/challenge';
+        const apiPath = '/account/mfa/challenges';
         const payload: Payload = {};
 
         if (typeof factor !== 'undefined') {
@@ -762,7 +780,7 @@ export class Account extends Service {
             throw new AppwriteException('Missing required parameter: "factor"');
         }
 
-        const apiPath = '/account/mfa/challenge';
+        const apiPath = '/account/mfa/challenges';
         const payload: Payload = {};
 
         if (typeof factor !== 'undefined') {
@@ -821,7 +839,7 @@ export class Account extends Service {
             throw new AppwriteException('Missing required parameter: "otp"');
         }
 
-        const apiPath = '/account/mfa/challenge';
+        const apiPath = '/account/mfa/challenges';
         const payload: Payload = {};
 
         if (typeof challengeId !== 'undefined') {
@@ -883,7 +901,7 @@ export class Account extends Service {
             throw new AppwriteException('Missing required parameter: "otp"');
         }
 
-        const apiPath = '/account/mfa/challenge';
+        const apiPath = '/account/mfa/challenges';
         const payload: Payload = {};
 
         if (typeof challengeId !== 'undefined') {