@appwrite.io/console 1.10.0 → 2.1.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

@@ -1,5 +1,5 @@
 type QueryTypesSingle = string | number | boolean;
-export type QueryTypesList = string[] | number[] | boolean[] | Query[];
+export type QueryTypesList = string[] | number[] | boolean[] | Query[] | any[];
 export type QueryTypes = QueryTypesSingle | QueryTypesList;
 type AttributesTypes = string | string[];
 
@@ -195,6 +195,14 @@ export class Query {
   static orderAsc = (attribute: string): string =>
     new Query("orderAsc", attribute).toString();
 
+  /**
+   * Sort results randomly.
+   *
+   * @returns {string}
+   */
+  static orderRandom = (): string =>
+    new Query("orderRandom").toString();
+
   /**
    * Return results after documentId.
    *
@@ -238,9 +246,117 @@ export class Query {
    * @param {string | string[]} value
    * @returns {string}
    */
-  static contains = (attribute: string, value: string | string[]): string =>
+  static contains = (attribute: string, value: string | any[]): string =>
     new Query("contains", attribute, value).toString();
 
+  /**
+   * Filter resources where attribute does not contain the specified value.
+   *
+   * @param {string} attribute
+   * @param {string | any[]} value
+   * @returns {string}
+   */
+  static notContains = (attribute: string, value: string | any[]): string =>
+    new Query("notContains", attribute, value).toString();
+
+  /**
+   * Filter resources by searching attribute for value (inverse of search).
+   * A fulltext index on attribute is required for this query to work.
+   *
+   * @param {string} attribute
+   * @param {string} value
+   * @returns {string}
+   */
+  static notSearch = (attribute: string, value: string): string =>
+    new Query("notSearch", attribute, value).toString();
+
+  /**
+   * Filter resources where attribute is not between start and end (exclusive).
+   *
+   * @param {string} attribute
+   * @param {string | number} start
+   * @param {string | number} end
+   * @returns {string}
+   */
+  static notBetween = (attribute: string, start: string | number, end: string | number): string =>
+    new Query("notBetween", attribute, [start, end] as QueryTypesList).toString();
+
+  /**
+   * Filter resources where attribute does not start with value.
+   *
+   * @param {string} attribute
+   * @param {string} value
+   * @returns {string}
+   */
+  static notStartsWith = (attribute: string, value: string): string =>
+    new Query("notStartsWith", attribute, value).toString();
+
+  /**
+   * Filter resources where attribute does not end with value.
+   *
+   * @param {string} attribute
+   * @param {string} value
+   * @returns {string}
+   */
+  static notEndsWith = (attribute: string, value: string): string =>
+    new Query("notEndsWith", attribute, value).toString();
+
+  /**
+   * Filter resources where document was created before date.
+   *
+   * @param {string} value
+   * @returns {string}
+   */
+  static createdBefore = (value: string): string =>
+    Query.lessThan("$createdAt", value);
+
+  /**
+   * Filter resources where document was created after date.
+   *
+   * @param {string} value
+   * @returns {string}
+   */
+  static createdAfter = (value: string): string =>
+    Query.greaterThan("$createdAt", value);
+
+  /**
+   * Filter resources where document was created between dates.
+   *
+   * @param {string} start
+   * @param {string} end
+   * @returns {string}
+   */
+  static createdBetween = (start: string, end: string): string =>
+    Query.between("$createdAt", start, end);
+
+  /**
+   * Filter resources where document was updated before date.
+   *
+   * @param {string} value
+   * @returns {string}
+   */
+  static updatedBefore = (value: string): string =>
+    Query.lessThan("$updatedAt", value);
+
+  /**
+   * Filter resources where document was updated after date.
+   *
+   * @param {string} value
+   * @returns {string}
+   */
+  static updatedAfter = (value: string): string =>
+    Query.greaterThan("$updatedAt", value);
+
+  /**
+   * Filter resources where document was updated between dates.
+   *
+   * @param {string} start
+   * @param {string} end
+   * @returns {string}
+   */
+  static updatedBetween = (start: string, end: string): string =>
+    Query.between("$updatedAt", start, end);
+
   /**
    * Combine multiple queries using logical OR operator.
    *
@@ -258,4 +374,132 @@ export class Query {
    */
   static and = (queries: string[]) =>
     new Query("and", undefined, queries.map((query) => JSON.parse(query))).toString();
+
+  /**
+   * Filter resources where attribute is at a specific distance from the given coordinates.
+   *
+   * @param {string} attribute
+   * @param {any[]} values
+   * @param {number} distance
+   * @param {boolean} meters
+   * @returns {string}
+   */
+  static distanceEqual = (attribute: string, values: any[], distance: number, meters: boolean = true): string =>
+    new Query("distanceEqual", attribute, [[values, distance, meters]] as QueryTypesList).toString();
+
+  /**
+   * Filter resources where attribute is not at a specific distance from the given coordinates.
+   *
+   * @param {string} attribute
+   * @param {any[]} values
+   * @param {number} distance
+   * @param {boolean} meters
+   * @returns {string}
+   */
+  static distanceNotEqual = (attribute: string, values: any[], distance: number, meters: boolean = true): string =>
+    new Query("distanceNotEqual", attribute, [[values, distance, meters]] as QueryTypesList).toString();
+
+  /**
+   * Filter resources where attribute is at a distance greater than the specified value from the given coordinates.
+   *
+   * @param {string} attribute
+   * @param {any[]} values
+   * @param {number} distance
+   * @param {boolean} meters
+   * @returns {string}
+   */
+  static distanceGreaterThan = (attribute: string, values: any[], distance: number, meters: boolean = true): string =>
+    new Query("distanceGreaterThan", attribute, [[values, distance, meters]] as QueryTypesList).toString();
+
+  /**
+   * Filter resources where attribute is at a distance less than the specified value from the given coordinates.
+   *
+   * @param {string} attribute
+   * @param {any[]} values
+   * @param {number} distance
+   * @param {boolean} meters
+   * @returns {string}
+   */
+  static distanceLessThan = (attribute: string, values: any[], distance: number, meters: boolean = true): string =>
+    new Query("distanceLessThan", attribute, [[values, distance, meters]] as QueryTypesList).toString();
+
+  /**
+   * Filter resources where attribute intersects with the given geometry.
+   *
+   * @param {string} attribute
+   * @param {any[]} values
+   * @returns {string}
+   */
+  static intersects = (attribute: string, values: any[]): string =>
+    new Query("intersects", attribute, [values]).toString();
+
+  /**
+   * Filter resources where attribute does not intersect with the given geometry.
+   *
+   * @param {string} attribute
+   * @param {any[]} values
+   * @returns {string}
+   */
+  static notIntersects = (attribute: string, values: any[]): string =>
+    new Query("notIntersects", attribute, [values]).toString();
+
+  /**
+   * Filter resources where attribute crosses the given geometry.
+   *
+   * @param {string} attribute
+   * @param {any[]} values
+   * @returns {string}
+   */
+  static crosses = (attribute: string, values: any[]): string =>
+    new Query("crosses", attribute, [values]).toString();
+
+  /**
+   * Filter resources where attribute does not cross the given geometry.
+   *
+   * @param {string} attribute
+   * @param {any[]} values
+   * @returns {string}
+   */
+  static notCrosses = (attribute: string, values: any[]): string =>
+    new Query("notCrosses", attribute, [values]).toString();
+
+  /**
+   * Filter resources where attribute overlaps with the given geometry.
+   *
+   * @param {string} attribute
+   * @param {any[]} values
+   * @returns {string}
+   */
+  static overlaps = (attribute: string, values: any[]): string =>
+    new Query("overlaps", attribute, [values]).toString();
+
+  /**
+   * Filter resources where attribute does not overlap with the given geometry.
+   *
+   * @param {string} attribute
+   * @param {any[]} values
+   * @returns {string}
+   */
+  static notOverlaps = (attribute: string, values: any[]): string =>
+    new Query("notOverlaps", attribute, [values]).toString();
+
+  /**
+   * Filter resources where attribute touches the given geometry.
+   *
+   * @param {string} attribute
+   * @param {any[]} values
+   * @returns {string}
+   */
+  static touches = (attribute: string, values: any[]): string =>
+    new Query("touches", attribute, [values]).toString();
+
+  /**
+   * Filter resources where attribute does not touch the given geometry.
+   *
+   * @param {string} attribute
+   * @param {any[]} values
+   * @returns {string}
+   */
+  static notTouches = (attribute: string, values: any[]): string =>
+    new Query("notTouches", attribute, [values]).toString();
 }