node-appwrite 17.2.0 → 19.0.0

package/dist/query.d.mts

@@ -1,5 +1,5 @@
 type QueryTypesSingle = string | number | boolean;
-type QueryTypesList = string[] | number[] | boolean[] | Query[];
+type QueryTypesList = string[] | number[] | boolean[] | Query[] | any[];
 type QueryTypes = QueryTypesSingle | QueryTypesList;
 type AttributesTypes = string | string[];
 /**
@@ -27,18 +27,18 @@ declare class Query {
      * Filter resources where attribute is equal to value.
      *
      * @param {string} attribute
-     * @param {QueryTypes} value
+     * @param {QueryTypes | any[]} value
      * @returns {string}
      */
-    static equal: (attribute: string, value: QueryTypes) => string;
+    static equal: (attribute: string, value: QueryTypes | any[]) => string;
     /**
      * Filter resources where attribute is not equal to value.
      *
      * @param {string} attribute
-     * @param {QueryTypes} value
+     * @param {QueryTypes | any[]} value
      * @returns {string}
      */
-    static notEqual: (attribute: string, value: QueryTypes) => string;
+    static notEqual: (attribute: string, value: QueryTypes | any[]) => string;
     /**
      * Filter resources where attribute is less than value.
      *
@@ -175,7 +175,93 @@ declare class Query {
      * @param {string | string[]} value
      * @returns {string}
      */
-    static contains: (attribute: string, value: string | string[]) => string;
+    static contains: (attribute: string, value: string | any[]) => string;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * Filter resources where attribute does not start with value.
+     *
+     * @param {string} attribute
+     * @param {string} value
+     * @returns {string}
+     */
+    static notStartsWith: (attribute: string, value: string) => string;
+    /**
+     * Filter resources where attribute does not end with value.
+     *
+     * @param {string} attribute
+     * @param {string} value
+     * @returns {string}
+     */
+    static notEndsWith: (attribute: string, value: string) => string;
+    /**
+     * Filter resources where document was created before date.
+     *
+     * @param {string} value
+     * @returns {string}
+     */
+    static createdBefore: (value: string) => string;
+    /**
+     * Filter resources where document was created after date.
+     *
+     * @param {string} value
+     * @returns {string}
+     */
+    static createdAfter: (value: string) => string;
+    /**
+     * Filter resources where document was created between dates.
+     *
+     * @param {string} start
+     * @param {string} end
+     * @returns {string}
+     */
+    static createdBetween: (start: string, end: string) => string;
+    /**
+     * Filter resources where document was updated before date.
+     *
+     * @param {string} value
+     * @returns {string}
+     */
+    static updatedBefore: (value: string) => string;
+    /**
+     * Filter resources where document was updated after date.
+     *
+     * @param {string} value
+     * @returns {string}
+     */
+    static updatedAfter: (value: string) => string;
+    /**
+     * Filter resources where document was updated between dates.
+     *
+     * @param {string} start
+     * @param {string} end
+     * @returns {string}
+     */
+    static updatedBetween: (start: string, end: string) => string;
     /**
      * Combine multiple queries using logical OR operator.
      *
@@ -190,6 +276,110 @@ declare class Query {
      * @returns {string}
      */
     static and: (queries: string[]) => string;
+    /**
+     * 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) => string;
+    /**
+     * 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) => string;
+    /**
+     * 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) => string;
+    /**
+     * 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) => string;
+    /**
+     * Filter resources where attribute intersects with the given geometry.
+     *
+     * @param {string} attribute
+     * @param {any[]} values
+     * @returns {string}
+     */
+    static intersects: (attribute: string, values: any[]) => string;
+    /**
+     * 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;
+    /**
+     * Filter resources where attribute crosses the given geometry.
+     *
+     * @param {string} attribute
+     * @param {any[]} values
+     * @returns {string}
+     */
+    static crosses: (attribute: string, values: any[]) => string;
+    /**
+     * 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;
+    /**
+     * Filter resources where attribute overlaps with the given geometry.
+     *
+     * @param {string} attribute
+     * @param {any[]} values
+     * @returns {string}
+     */
+    static overlaps: (attribute: string, values: any[]) => string;
+    /**
+     * 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;
+    /**
+     * Filter resources where attribute touches the given geometry.
+     *
+     * @param {string} attribute
+     * @param {any[]} values
+     * @returns {string}
+     */
+    static touches: (attribute: string, values: any[]) => string;
+    /**
+     * 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;
 }
 
 export { Query, QueryTypes, QueryTypesList };

package/dist/query.d.ts

@@ -1,5 +1,5 @@
 type QueryTypesSingle = string | number | boolean;
-type QueryTypesList = string[] | number[] | boolean[] | Query[];
+type QueryTypesList = string[] | number[] | boolean[] | Query[] | any[];
 type QueryTypes = QueryTypesSingle | QueryTypesList;
 type AttributesTypes = string | string[];
 /**
@@ -27,18 +27,18 @@ declare class Query {
      * Filter resources where attribute is equal to value.
      *
      * @param {string} attribute
-     * @param {QueryTypes} value
+     * @param {QueryTypes | any[]} value
      * @returns {string}
      */
-    static equal: (attribute: string, value: QueryTypes) => string;
+    static equal: (attribute: string, value: QueryTypes | any[]) => string;
     /**
      * Filter resources where attribute is not equal to value.
      *
      * @param {string} attribute
-     * @param {QueryTypes} value
+     * @param {QueryTypes | any[]} value
      * @returns {string}
      */
-    static notEqual: (attribute: string, value: QueryTypes) => string;
+    static notEqual: (attribute: string, value: QueryTypes | any[]) => string;
     /**
      * Filter resources where attribute is less than value.
      *
@@ -175,7 +175,93 @@ declare class Query {
      * @param {string | string[]} value
      * @returns {string}
      */
-    static contains: (attribute: string, value: string | string[]) => string;
+    static contains: (attribute: string, value: string | any[]) => string;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * Filter resources where attribute does not start with value.
+     *
+     * @param {string} attribute
+     * @param {string} value
+     * @returns {string}
+     */
+    static notStartsWith: (attribute: string, value: string) => string;
+    /**
+     * Filter resources where attribute does not end with value.
+     *
+     * @param {string} attribute
+     * @param {string} value
+     * @returns {string}
+     */
+    static notEndsWith: (attribute: string, value: string) => string;
+    /**
+     * Filter resources where document was created before date.
+     *
+     * @param {string} value
+     * @returns {string}
+     */
+    static createdBefore: (value: string) => string;
+    /**
+     * Filter resources where document was created after date.
+     *
+     * @param {string} value
+     * @returns {string}
+     */
+    static createdAfter: (value: string) => string;
+    /**
+     * Filter resources where document was created between dates.
+     *
+     * @param {string} start
+     * @param {string} end
+     * @returns {string}
+     */
+    static createdBetween: (start: string, end: string) => string;
+    /**
+     * Filter resources where document was updated before date.
+     *
+     * @param {string} value
+     * @returns {string}
+     */
+    static updatedBefore: (value: string) => string;
+    /**
+     * Filter resources where document was updated after date.
+     *
+     * @param {string} value
+     * @returns {string}
+     */
+    static updatedAfter: (value: string) => string;
+    /**
+     * Filter resources where document was updated between dates.
+     *
+     * @param {string} start
+     * @param {string} end
+     * @returns {string}
+     */
+    static updatedBetween: (start: string, end: string) => string;
     /**
      * Combine multiple queries using logical OR operator.
      *
@@ -190,6 +276,110 @@ declare class Query {
      * @returns {string}
      */
     static and: (queries: string[]) => string;
+    /**
+     * 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) => string;
+    /**
+     * 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) => string;
+    /**
+     * 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) => string;
+    /**
+     * 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) => string;
+    /**
+     * Filter resources where attribute intersects with the given geometry.
+     *
+     * @param {string} attribute
+     * @param {any[]} values
+     * @returns {string}
+     */
+    static intersects: (attribute: string, values: any[]) => string;
+    /**
+     * 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;
+    /**
+     * Filter resources where attribute crosses the given geometry.
+     *
+     * @param {string} attribute
+     * @param {any[]} values
+     * @returns {string}
+     */
+    static crosses: (attribute: string, values: any[]) => string;
+    /**
+     * 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;
+    /**
+     * Filter resources where attribute overlaps with the given geometry.
+     *
+     * @param {string} attribute
+     * @param {any[]} values
+     * @returns {string}
+     */
+    static overlaps: (attribute: string, values: any[]) => string;
+    /**
+     * 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;
+    /**
+     * Filter resources where attribute touches the given geometry.
+     *
+     * @param {string} attribute
+     * @param {any[]} values
+     * @returns {string}
+     */
+    static touches: (attribute: string, values: any[]) => string;
+    /**
+     * 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;
 }
 
 export { Query, QueryTypes, QueryTypesList };

package/dist/query.js

@@ -36,7 +36,7 @@ const _Query = class _Query {
  * Filter resources where attribute is equal to value.
  *
  * @param {string} attribute
- * @param {QueryTypes} value
+ * @param {QueryTypes | any[]} value
  * @returns {string}
  */
 _Query.equal = (attribute, value) => new _Query("equal", attribute, value).toString();
@@ -44,7 +44,7 @@ _Query.equal = (attribute, value) => new _Query("equal", attribute, value).toStr
  * Filter resources where attribute is not equal to value.
  *
  * @param {string} attribute
- * @param {QueryTypes} value
+ * @param {QueryTypes | any[]} value
  * @returns {string}
  */
 _Query.notEqual = (attribute, value) => new _Query("notEqual", attribute, value).toString();
@@ -185,6 +185,92 @@ _Query.offset = (offset) => new _Query("offset", void 0, offset).toString();
  * @returns {string}
  */
 _Query.contains = (attribute, value) => 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}
+ */
+_Query.notContains = (attribute, value) => 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}
+ */
+_Query.notSearch = (attribute, value) => 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}
+ */
+_Query.notBetween = (attribute, start, end) => new _Query("notBetween", attribute, [start, end]).toString();
+/**
+ * Filter resources where attribute does not start with value.
+ *
+ * @param {string} attribute
+ * @param {string} value
+ * @returns {string}
+ */
+_Query.notStartsWith = (attribute, value) => new _Query("notStartsWith", attribute, value).toString();
+/**
+ * Filter resources where attribute does not end with value.
+ *
+ * @param {string} attribute
+ * @param {string} value
+ * @returns {string}
+ */
+_Query.notEndsWith = (attribute, value) => new _Query("notEndsWith", attribute, value).toString();
+/**
+ * Filter resources where document was created before date.
+ *
+ * @param {string} value
+ * @returns {string}
+ */
+_Query.createdBefore = (value) => new _Query("createdBefore", void 0, value).toString();
+/**
+ * Filter resources where document was created after date.
+ *
+ * @param {string} value
+ * @returns {string}
+ */
+_Query.createdAfter = (value) => new _Query("createdAfter", void 0, value).toString();
+/**
+ * Filter resources where document was created between dates.
+ *
+ * @param {string} start
+ * @param {string} end
+ * @returns {string}
+ */
+_Query.createdBetween = (start, end) => new _Query("createdBetween", void 0, [start, end]).toString();
+/**
+ * Filter resources where document was updated before date.
+ *
+ * @param {string} value
+ * @returns {string}
+ */
+_Query.updatedBefore = (value) => new _Query("updatedBefore", void 0, value).toString();
+/**
+ * Filter resources where document was updated after date.
+ *
+ * @param {string} value
+ * @returns {string}
+ */
+_Query.updatedAfter = (value) => new _Query("updatedAfter", void 0, value).toString();
+/**
+ * Filter resources where document was updated between dates.
+ *
+ * @param {string} start
+ * @param {string} end
+ * @returns {string}
+ */
+_Query.updatedBetween = (start, end) => new _Query("updatedBetween", void 0, [start, end]).toString();
 /**
  * Combine multiple queries using logical OR operator.
  *
@@ -199,6 +285,110 @@ _Query.or = (queries) => new _Query("or", void 0, queries.map((query) => JSON.pa
  * @returns {string}
  */
 _Query.and = (queries) => new _Query("and", void 0, 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}
+ */
+_Query.distanceEqual = (attribute, values, distance, meters = true) => new _Query("distanceEqual", attribute, [[values, distance, meters]]).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}
+ */
+_Query.distanceNotEqual = (attribute, values, distance, meters = true) => new _Query("distanceNotEqual", attribute, [[values, distance, meters]]).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}
+ */
+_Query.distanceGreaterThan = (attribute, values, distance, meters = true) => new _Query("distanceGreaterThan", attribute, [[values, distance, meters]]).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}
+ */
+_Query.distanceLessThan = (attribute, values, distance, meters = true) => new _Query("distanceLessThan", attribute, [[values, distance, meters]]).toString();
+/**
+ * Filter resources where attribute intersects with the given geometry.
+ *
+ * @param {string} attribute
+ * @param {any[]} values
+ * @returns {string}
+ */
+_Query.intersects = (attribute, values) => 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}
+ */
+_Query.notIntersects = (attribute, values) => new _Query("notIntersects", attribute, [values]).toString();
+/**
+ * Filter resources where attribute crosses the given geometry.
+ *
+ * @param {string} attribute
+ * @param {any[]} values
+ * @returns {string}
+ */
+_Query.crosses = (attribute, values) => new _Query("crosses", attribute, [values]).toString();
+/**
+ * Filter resources where attribute does not cross the given geometry.
+ *
+ * @param {string} attribute
+ * @param {any[]} values
+ * @returns {string}
+ */
+_Query.notCrosses = (attribute, values) => new _Query("notCrosses", attribute, [values]).toString();
+/**
+ * Filter resources where attribute overlaps with the given geometry.
+ *
+ * @param {string} attribute
+ * @param {any[]} values
+ * @returns {string}
+ */
+_Query.overlaps = (attribute, values) => 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}
+ */
+_Query.notOverlaps = (attribute, values) => new _Query("notOverlaps", attribute, [values]).toString();
+/**
+ * Filter resources where attribute touches the given geometry.
+ *
+ * @param {string} attribute
+ * @param {any[]} values
+ * @returns {string}
+ */
+_Query.touches = (attribute, values) => new _Query("touches", attribute, [values]).toString();
+/**
+ * Filter resources where attribute does not touch the given geometry.
+ *
+ * @param {string} attribute
+ * @param {any[]} values
+ * @returns {string}
+ */
+_Query.notTouches = (attribute, values) => new _Query("notTouches", attribute, [values]).toString();
 let Query = _Query;
 
 exports.Query = Query;