node-appwrite 13.0.0 → 14.0.0-rc.2

package/dist/query.d.mts

@@ -2,33 +2,193 @@ type QueryTypesSingle = string | number | boolean;
 type QueryTypesList = string[] | number[] | boolean[] | Query[];
 type QueryTypes = QueryTypesSingle | QueryTypesList;
 type AttributesTypes = string | string[];
+/**
+ * Helper class to generate query strings.
+ */
 declare class Query {
     method: string;
     attribute: AttributesTypes | undefined;
     values: QueryTypesList | undefined;
+    /**
+     * Constructor for Query class.
+     *
+     * @param {string} method
+     * @param {AttributesTypes} attribute
+     * @param {QueryTypes} values
+     */
     constructor(method: string, attribute?: AttributesTypes, values?: QueryTypes);
+    /**
+     * Convert the query object to a JSON string.
+     *
+     * @returns {string}
+     */
     toString(): string;
+    /**
+     * Filter resources where attribute is equal to value.
+     *
+     * @param {string} attribute
+     * @param {QueryTypes} value
+     * @returns {string}
+     */
     static equal: (attribute: string, value: QueryTypes) => string;
+    /**
+     * Filter resources where attribute is not equal to value.
+     *
+     * @param {string} attribute
+     * @param {QueryTypes} value
+     * @returns {string}
+     */
     static notEqual: (attribute: string, value: QueryTypes) => string;
+    /**
+     * Filter resources where attribute is less than value.
+     *
+     * @param {string} attribute
+     * @param {QueryTypes} value
+     * @returns {string}
+     */
     static lessThan: (attribute: string, value: QueryTypes) => string;
+    /**
+     * Filter resources where attribute is less than or equal to value.
+     *
+     * @param {string} attribute
+     * @param {QueryTypes} value
+     * @returns {string}
+     */
     static lessThanEqual: (attribute: string, value: QueryTypes) => string;
+    /**
+     * Filter resources where attribute is greater than value.
+     *
+     * @param {string} attribute
+     * @param {QueryTypes} value
+     * @returns {string}
+     */
     static greaterThan: (attribute: string, value: QueryTypes) => string;
+    /**
+     * Filter resources where attribute is greater than or equal to value.
+     *
+     * @param {string} attribute
+     * @param {QueryTypes} value
+     * @returns {string}
+     */
     static greaterThanEqual: (attribute: string, value: QueryTypes) => string;
+    /**
+     * Filter resources where attribute is null.
+     *
+     * @param {string} attribute
+     * @returns {string}
+     */
     static isNull: (attribute: string) => string;
+    /**
+     * Filter resources where attribute is not null.
+     *
+     * @param {string} attribute
+     * @returns {string}
+     */
     static isNotNull: (attribute: string) => string;
+    /**
+     * Filter resources where attribute is between start and end (inclusive).
+     *
+     * @param {string} attribute
+     * @param {string | number} start
+     * @param {string | number} end
+     * @returns {string}
+     */
     static between: (attribute: string, start: string | number, end: string | number) => string;
+    /**
+     * Filter resources where attribute starts with value.
+     *
+     * @param {string} attribute
+     * @param {string} value
+     * @returns {string}
+     */
     static startsWith: (attribute: string, value: string) => string;
+    /**
+     * Filter resources where attribute ends with value.
+     *
+     * @param {string} attribute
+     * @param {string} value
+     * @returns {string}
+     */
     static endsWith: (attribute: string, value: string) => string;
+    /**
+     * Specify which attributes should be returned by the API call.
+     *
+     * @param {string[]} attributes
+     * @returns {string}
+     */
     static select: (attributes: string[]) => string;
+    /**
+     * Filter resources by searching attribute for value.
+     * A fulltext index on attribute is required for this query to work.
+     *
+     * @param {string} attribute
+     * @param {string} value
+     * @returns {string}
+     */
     static search: (attribute: string, value: string) => string;
+    /**
+     * Sort results by attribute descending.
+     *
+     * @param {string} attribute
+     * @returns {string}
+     */
     static orderDesc: (attribute: string) => string;
+    /**
+     * Sort results by attribute ascending.
+     *
+     * @param {string} attribute
+     * @returns {string}
+     */
     static orderAsc: (attribute: string) => string;
+    /**
+     * Return results after documentId.
+     *
+     * @param {string} documentId
+     * @returns {string}
+     */
     static cursorAfter: (documentId: string) => string;
+    /**
+     * Return results before documentId.
+     *
+     * @param {string} documentId
+     * @returns {string}
+     */
     static cursorBefore: (documentId: string) => string;
+    /**
+     * Return only limit results.
+     *
+     * @param {number} limit
+     * @returns {string}
+     */
     static limit: (limit: number) => string;
+    /**
+     * Filter resources by skipping the first offset results.
+     *
+     * @param {number} offset
+     * @returns {string}
+     */
     static offset: (offset: number) => string;
+    /**
+     * Filter resources where attribute contains the specified value.
+     *
+     * @param {string} attribute
+     * @param {string | string[]} value
+     * @returns {string}
+     */
     static contains: (attribute: string, value: string | string[]) => string;
+    /**
+     * Combine multiple queries using logical OR operator.
+     *
+     * @param {string[]} queries
+     * @returns {string}
+     */
     static or: (queries: string[]) => string;
+    /**
+     * Combine multiple queries using logical AND operator.
+     *
+     * @param {string[]} queries
+     * @returns {string}
+     */
     static and: (queries: string[]) => string;
 }
 

package/dist/query.d.ts

@@ -2,33 +2,193 @@ type QueryTypesSingle = string | number | boolean;
 type QueryTypesList = string[] | number[] | boolean[] | Query[];
 type QueryTypes = QueryTypesSingle | QueryTypesList;
 type AttributesTypes = string | string[];
+/**
+ * Helper class to generate query strings.
+ */
 declare class Query {
     method: string;
     attribute: AttributesTypes | undefined;
     values: QueryTypesList | undefined;
+    /**
+     * Constructor for Query class.
+     *
+     * @param {string} method
+     * @param {AttributesTypes} attribute
+     * @param {QueryTypes} values
+     */
     constructor(method: string, attribute?: AttributesTypes, values?: QueryTypes);
+    /**
+     * Convert the query object to a JSON string.
+     *
+     * @returns {string}
+     */
     toString(): string;
+    /**
+     * Filter resources where attribute is equal to value.
+     *
+     * @param {string} attribute
+     * @param {QueryTypes} value
+     * @returns {string}
+     */
     static equal: (attribute: string, value: QueryTypes) => string;
+    /**
+     * Filter resources where attribute is not equal to value.
+     *
+     * @param {string} attribute
+     * @param {QueryTypes} value
+     * @returns {string}
+     */
     static notEqual: (attribute: string, value: QueryTypes) => string;
+    /**
+     * Filter resources where attribute is less than value.
+     *
+     * @param {string} attribute
+     * @param {QueryTypes} value
+     * @returns {string}
+     */
     static lessThan: (attribute: string, value: QueryTypes) => string;
+    /**
+     * Filter resources where attribute is less than or equal to value.
+     *
+     * @param {string} attribute
+     * @param {QueryTypes} value
+     * @returns {string}
+     */
     static lessThanEqual: (attribute: string, value: QueryTypes) => string;
+    /**
+     * Filter resources where attribute is greater than value.
+     *
+     * @param {string} attribute
+     * @param {QueryTypes} value
+     * @returns {string}
+     */
     static greaterThan: (attribute: string, value: QueryTypes) => string;
+    /**
+     * Filter resources where attribute is greater than or equal to value.
+     *
+     * @param {string} attribute
+     * @param {QueryTypes} value
+     * @returns {string}
+     */
     static greaterThanEqual: (attribute: string, value: QueryTypes) => string;
+    /**
+     * Filter resources where attribute is null.
+     *
+     * @param {string} attribute
+     * @returns {string}
+     */
     static isNull: (attribute: string) => string;
+    /**
+     * Filter resources where attribute is not null.
+     *
+     * @param {string} attribute
+     * @returns {string}
+     */
     static isNotNull: (attribute: string) => string;
+    /**
+     * Filter resources where attribute is between start and end (inclusive).
+     *
+     * @param {string} attribute
+     * @param {string | number} start
+     * @param {string | number} end
+     * @returns {string}
+     */
     static between: (attribute: string, start: string | number, end: string | number) => string;
+    /**
+     * Filter resources where attribute starts with value.
+     *
+     * @param {string} attribute
+     * @param {string} value
+     * @returns {string}
+     */
     static startsWith: (attribute: string, value: string) => string;
+    /**
+     * Filter resources where attribute ends with value.
+     *
+     * @param {string} attribute
+     * @param {string} value
+     * @returns {string}
+     */
     static endsWith: (attribute: string, value: string) => string;
+    /**
+     * Specify which attributes should be returned by the API call.
+     *
+     * @param {string[]} attributes
+     * @returns {string}
+     */
     static select: (attributes: string[]) => string;
+    /**
+     * Filter resources by searching attribute for value.
+     * A fulltext index on attribute is required for this query to work.
+     *
+     * @param {string} attribute
+     * @param {string} value
+     * @returns {string}
+     */
     static search: (attribute: string, value: string) => string;
+    /**
+     * Sort results by attribute descending.
+     *
+     * @param {string} attribute
+     * @returns {string}
+     */
     static orderDesc: (attribute: string) => string;
+    /**
+     * Sort results by attribute ascending.
+     *
+     * @param {string} attribute
+     * @returns {string}
+     */
     static orderAsc: (attribute: string) => string;
+    /**
+     * Return results after documentId.
+     *
+     * @param {string} documentId
+     * @returns {string}
+     */
     static cursorAfter: (documentId: string) => string;
+    /**
+     * Return results before documentId.
+     *
+     * @param {string} documentId
+     * @returns {string}
+     */
     static cursorBefore: (documentId: string) => string;
+    /**
+     * Return only limit results.
+     *
+     * @param {number} limit
+     * @returns {string}
+     */
     static limit: (limit: number) => string;
+    /**
+     * Filter resources by skipping the first offset results.
+     *
+     * @param {number} offset
+     * @returns {string}
+     */
     static offset: (offset: number) => string;
+    /**
+     * Filter resources where attribute contains the specified value.
+     *
+     * @param {string} attribute
+     * @param {string | string[]} value
+     * @returns {string}
+     */
     static contains: (attribute: string, value: string | string[]) => string;
+    /**
+     * Combine multiple queries using logical OR operator.
+     *
+     * @param {string[]} queries
+     * @returns {string}
+     */
     static or: (queries: string[]) => string;
+    /**
+     * Combine multiple queries using logical AND operator.
+     *
+     * @param {string[]} queries
+     * @returns {string}
+     */
     static and: (queries: string[]) => string;
 }
 

package/dist/query.js

@@ -1,6 +1,13 @@
 'use strict';
 
 const _Query = class _Query {
+  /**
+   * Constructor for Query class.
+   *
+   * @param {string} method
+   * @param {AttributesTypes} attribute
+   * @param {QueryTypes} values
+   */
   constructor(method, attribute, values) {
     this.method = method;
     this.attribute = attribute;
@@ -12,6 +19,11 @@ const _Query = class _Query {
       }
     }
   }
+  /**
+   * Convert the query object to a JSON string.
+   *
+   * @returns {string}
+   */
   toString() {
     return JSON.stringify({
       method: this.method,
@@ -20,27 +32,172 @@ const _Query = class _Query {
     });
   }
 };
+/**
+ * Filter resources where attribute is equal to value.
+ *
+ * @param {string} attribute
+ * @param {QueryTypes} value
+ * @returns {string}
+ */
 _Query.equal = (attribute, value) => new _Query("equal", attribute, value).toString();
+/**
+ * Filter resources where attribute is not equal to value.
+ *
+ * @param {string} attribute
+ * @param {QueryTypes} value
+ * @returns {string}
+ */
 _Query.notEqual = (attribute, value) => new _Query("notEqual", attribute, value).toString();
+/**
+ * Filter resources where attribute is less than value.
+ *
+ * @param {string} attribute
+ * @param {QueryTypes} value
+ * @returns {string}
+ */
 _Query.lessThan = (attribute, value) => new _Query("lessThan", attribute, value).toString();
+/**
+ * Filter resources where attribute is less than or equal to value.
+ *
+ * @param {string} attribute
+ * @param {QueryTypes} value
+ * @returns {string}
+ */
 _Query.lessThanEqual = (attribute, value) => new _Query("lessThanEqual", attribute, value).toString();
+/**
+ * Filter resources where attribute is greater than value.
+ *
+ * @param {string} attribute
+ * @param {QueryTypes} value
+ * @returns {string}
+ */
 _Query.greaterThan = (attribute, value) => new _Query("greaterThan", attribute, value).toString();
+/**
+ * Filter resources where attribute is greater than or equal to value.
+ *
+ * @param {string} attribute
+ * @param {QueryTypes} value
+ * @returns {string}
+ */
 _Query.greaterThanEqual = (attribute, value) => new _Query("greaterThanEqual", attribute, value).toString();
+/**
+ * Filter resources where attribute is null.
+ *
+ * @param {string} attribute
+ * @returns {string}
+ */
 _Query.isNull = (attribute) => new _Query("isNull", attribute).toString();
+/**
+ * Filter resources where attribute is not null.
+ *
+ * @param {string} attribute
+ * @returns {string}
+ */
 _Query.isNotNull = (attribute) => new _Query("isNotNull", attribute).toString();
+/**
+ * Filter resources where attribute is between start and end (inclusive).
+ *
+ * @param {string} attribute
+ * @param {string | number} start
+ * @param {string | number} end
+ * @returns {string}
+ */
 _Query.between = (attribute, start, end) => new _Query("between", attribute, [start, end]).toString();
+/**
+ * Filter resources where attribute starts with value.
+ *
+ * @param {string} attribute
+ * @param {string} value
+ * @returns {string}
+ */
 _Query.startsWith = (attribute, value) => new _Query("startsWith", attribute, value).toString();
+/**
+ * Filter resources where attribute ends with value.
+ *
+ * @param {string} attribute
+ * @param {string} value
+ * @returns {string}
+ */
 _Query.endsWith = (attribute, value) => new _Query("endsWith", attribute, value).toString();
+/**
+ * Specify which attributes should be returned by the API call.
+ *
+ * @param {string[]} attributes
+ * @returns {string}
+ */
 _Query.select = (attributes) => new _Query("select", void 0, attributes).toString();
+/**
+ * Filter resources by searching attribute for value.
+ * A fulltext index on attribute is required for this query to work.
+ *
+ * @param {string} attribute
+ * @param {string} value
+ * @returns {string}
+ */
 _Query.search = (attribute, value) => new _Query("search", attribute, value).toString();
+/**
+ * Sort results by attribute descending.
+ *
+ * @param {string} attribute
+ * @returns {string}
+ */
 _Query.orderDesc = (attribute) => new _Query("orderDesc", attribute).toString();
+/**
+ * Sort results by attribute ascending.
+ *
+ * @param {string} attribute
+ * @returns {string}
+ */
 _Query.orderAsc = (attribute) => new _Query("orderAsc", attribute).toString();
+/**
+ * Return results after documentId.
+ *
+ * @param {string} documentId
+ * @returns {string}
+ */
 _Query.cursorAfter = (documentId) => new _Query("cursorAfter", void 0, documentId).toString();
+/**
+ * Return results before documentId.
+ *
+ * @param {string} documentId
+ * @returns {string}
+ */
 _Query.cursorBefore = (documentId) => new _Query("cursorBefore", void 0, documentId).toString();
+/**
+ * Return only limit results.
+ *
+ * @param {number} limit
+ * @returns {string}
+ */
 _Query.limit = (limit) => new _Query("limit", void 0, limit).toString();
+/**
+ * Filter resources by skipping the first offset results.
+ *
+ * @param {number} offset
+ * @returns {string}
+ */
 _Query.offset = (offset) => new _Query("offset", void 0, offset).toString();
+/**
+ * Filter resources where attribute contains the specified value.
+ *
+ * @param {string} attribute
+ * @param {string | string[]} value
+ * @returns {string}
+ */
 _Query.contains = (attribute, value) => new _Query("contains", attribute, value).toString();
+/**
+ * Combine multiple queries using logical OR operator.
+ *
+ * @param {string[]} queries
+ * @returns {string}
+ */
 _Query.or = (queries) => new _Query("or", void 0, queries.map((query) => JSON.parse(query))).toString();
+/**
+ * Combine multiple queries using logical AND operator.
+ *
+ * @param {string[]} queries
+ * @returns {string}
+ */
 _Query.and = (queries) => new _Query("and", void 0, queries.map((query) => JSON.parse(query))).toString();
 let Query = _Query;
 

package/dist/query.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/query.ts"],"names":[],"mappings":"AAKO,MAAM,SAAN,MAAM,OAAM;AAAA,EAKjB,YACE,QACA,WACA,QACA;AACA,SAAK,SAAS;AACd,SAAK,YAAY;AAEjB,QAAI,WAAW,QAAW;AACxB,UAAI,MAAM,QAAQ,MAAM,GAAG;AACzB,aAAK,SAAS;AAAA,MAChB,OAAO;AACL,aAAK,SAAS,CAAC,MAAM;AAAA,MACvB;AAAA,IACF;AAAA,EACF;AAAA,EAEA,WAAmB;AACjB,WAAO,KAAK,UAAU;AAAA,MACpB,QAAQ,KAAK;AAAA,MACb,WAAW,KAAK;AAAA,MAChB,QAAQ,KAAK;AAAA,IACf,CAAC;AAAA,EACH;AAmEF;AA/Fa,OA8BJ,QAAQ,CAAC,WAAmB,UACjC,IAAI,OAAM,SAAS,WAAW,KAAK,EAAE,SAAS;AA/BrC,OAiCJ,WAAW,CAAC,WAAmB,UACpC,IAAI,OAAM,YAAY,WAAW,KAAK,EAAE,SAAS;AAlCxC,OAoCJ,WAAW,CAAC,WAAmB,UACpC,IAAI,OAAM,YAAY,WAAW,KAAK,EAAE,SAAS;AArCxC,OAuCJ,gBAAgB,CAAC,WAAmB,UACzC,IAAI,OAAM,iBAAiB,WAAW,KAAK,EAAE,SAAS;AAxC7C,OA0CJ,cAAc,CAAC,WAAmB,UACvC,IAAI,OAAM,eAAe,WAAW,KAAK,EAAE,SAAS;AA3C3C,OA6CJ,mBAAmB,CAAC,WAAmB,UAC5C,IAAI,OAAM,oBAAoB,WAAW,KAAK,EAAE,SAAS;AA9ChD,OAgDJ,SAAS,CAAC,cACf,IAAI,OAAM,UAAU,SAAS,EAAE,SAAS;AAjD/B,OAmDJ,YAAY,CAAC,cAClB,IAAI,OAAM,aAAa,SAAS,EAAE,SAAS;AApDlC,OAsDJ,UAAU,CAAC,WAAmB,OAAwB,QAC3D,IAAI,OAAM,WAAW,WAAW,CAAC,OAAO,GAAG,CAAmB,EAAE,SAAS;AAvDhE,OAyDJ,aAAa,CAAC,WAAmB,UACtC,IAAI,OAAM,cAAc,WAAW,KAAK,EAAE,SAAS;AA1D1C,OA4DJ,WAAW,CAAC,WAAmB,UACpC,IAAI,OAAM,YAAY,WAAW,KAAK,EAAE,SAAS;AA7DxC,OA+DJ,SAAS,CAAC,eACf,IAAI,OAAM,UAAU,QAAW,UAAU,EAAE,SAAS;AAhE3C,OAkEJ,SAAS,CAAC,WAAmB,UAClC,IAAI,OAAM,UAAU,WAAW,KAAK,EAAE,SAAS;AAnEtC,OAqEJ,YAAY,CAAC,cAClB,IAAI,OAAM,aAAa,SAAS,EAAE,SAAS;AAtElC,OAwEJ,WAAW,CAAC,cACjB,IAAI,OAAM,YAAY,SAAS,EAAE,SAAS;AAzEjC,OA2EJ,cAAc,CAAC,eACpB,IAAI,OAAM,eAAe,QAAW,UAAU,EAAE,SAAS;AA5EhD,OA8EJ,eAAe,CAAC,eACrB,IAAI,OAAM,gBAAgB,QAAW,UAAU,EAAE,SAAS;AA/EjD,OAiFJ,QAAQ,CAAC,UACd,IAAI,OAAM,SAAS,QAAW,KAAK,EAAE,SAAS;AAlFrC,OAoFJ,SAAS,CAAC,WACf,IAAI,OAAM,UAAU,QAAW,MAAM,EAAE,SAAS;AArFvC,OAuFJ,WAAW,CAAC,WAAmB,UACpC,IAAI,OAAM,YAAY,WAAW,KAAK,EAAE,SAAS;AAxFxC,OA0FJ,KAAK,CAAC,YACX,IAAI,OAAM,MAAM,QAAW,QAAQ,IAAI,CAAC,UAAU,KAAK,MAAM,KAAK,CAAC,CAAC,EAAE,SAAS;AA3FtE,OA6FJ,MAAM,CAAC,YACZ,IAAI,OAAM,OAAO,QAAW,QAAQ,IAAI,CAAC,UAAU,KAAK,MAAM,KAAK,CAAC,CAAC,EAAE,SAAS;AA9F7E,IAAM,QAAN","sourcesContent":["type QueryTypesSingle = string | number | boolean;\nexport type QueryTypesList = string[] | number[] | boolean[] | Query[];\nexport type QueryTypes = QueryTypesSingle | QueryTypesList;\ntype AttributesTypes = string | string[];\n\nexport class Query {\n  method: string;\n  attribute: AttributesTypes | undefined;\n  values: QueryTypesList | undefined;\n\n  constructor(\n    method: string,\n    attribute?: AttributesTypes,\n    values?: QueryTypes\n  ) {\n    this.method = method;\n    this.attribute = attribute;\n\n    if (values !== undefined) {\n      if (Array.isArray(values)) {\n        this.values = values;\n      } else {\n        this.values = [values] as QueryTypesList;\n      }\n    }\n  }\n\n  toString(): string {\n    return JSON.stringify({\n      method: this.method,\n      attribute: this.attribute,\n      values: this.values,\n    });\n  }\n\n  static equal = (attribute: string, value: QueryTypes): string =>\n    new Query(\"equal\", attribute, value).toString();\n\n  static notEqual = (attribute: string, value: QueryTypes): string =>\n    new Query(\"notEqual\", attribute, value).toString();\n\n  static lessThan = (attribute: string, value: QueryTypes): string =>\n    new Query(\"lessThan\", attribute, value).toString();\n\n  static lessThanEqual = (attribute: string, value: QueryTypes): string =>\n    new Query(\"lessThanEqual\", attribute, value).toString();\n\n  static greaterThan = (attribute: string, value: QueryTypes): string =>\n    new Query(\"greaterThan\", attribute, value).toString();\n\n  static greaterThanEqual = (attribute: string, value: QueryTypes): string =>\n    new Query(\"greaterThanEqual\", attribute, value).toString();\n\n  static isNull = (attribute: string): string =>\n    new Query(\"isNull\", attribute).toString();\n\n  static isNotNull = (attribute: string): string =>\n    new Query(\"isNotNull\", attribute).toString();\n\n  static between = (attribute: string, start: string | number, end: string | number) =>\n    new Query(\"between\", attribute, [start, end] as QueryTypesList).toString();\n\n  static startsWith = (attribute: string, value: string): string =>\n    new Query(\"startsWith\", attribute, value).toString();\n\n  static endsWith = (attribute: string, value: string): string =>\n    new Query(\"endsWith\", attribute, value).toString();\n\n  static select = (attributes: string[]): string =>\n    new Query(\"select\", undefined, attributes).toString();\n\n  static search = (attribute: string, value: string): string =>\n    new Query(\"search\", attribute, value).toString();\n\n  static orderDesc = (attribute: string): string =>\n    new Query(\"orderDesc\", attribute).toString();\n\n  static orderAsc = (attribute: string): string =>\n    new Query(\"orderAsc\", attribute).toString();\n\n  static cursorAfter = (documentId: string): string =>\n    new Query(\"cursorAfter\", undefined, documentId).toString();\n\n  static cursorBefore = (documentId: string): string =>\n    new Query(\"cursorBefore\", undefined, documentId).toString();\n\n  static limit = (limit: number): string =>\n    new Query(\"limit\", undefined, limit).toString();\n\n  static offset = (offset: number): string =>\n    new Query(\"offset\", undefined, offset).toString();\n\n  static contains = (attribute: string, value: string | string[]): string =>\n    new Query(\"contains\", attribute, value).toString();\n\n  static or = (queries: string[]) =>\n    new Query(\"or\", undefined, queries.map((query) => JSON.parse(query))).toString();\n\n  static and = (queries: string[]) =>\n    new Query(\"and\", undefined, queries.map((query) => JSON.parse(query))).toString();\n}\n"]}
+{"version":3,"sources":["../src/query.ts"],"names":[],"mappings":"AAQO,MAAM,SAAN,MAAM,OAAM;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYjB,YACE,QACA,WACA,QACA;AACA,SAAK,SAAS;AACd,SAAK,YAAY;AAEjB,QAAI,WAAW,QAAW;AACxB,UAAI,MAAM,QAAQ,MAAM,GAAG;AACzB,aAAK,SAAS;AAAA,MAChB,OAAO;AACL,aAAK,SAAS,CAAC,MAAM;AAAA,MACvB;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,WAAmB;AACjB,WAAO,KAAK,UAAU;AAAA,MACpB,QAAQ,KAAK;AAAA,MACb,WAAW,KAAK;AAAA,MAChB,QAAQ,KAAK;AAAA,IACf,CAAC;AAAA,EACH;AAoNF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AA5Pa,OAiDJ,QAAQ,CAAC,WAAmB,UACjC,IAAI,OAAM,SAAS,WAAW,KAAK,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAlDrC,OA2DJ,WAAW,CAAC,WAAmB,UACpC,IAAI,OAAM,YAAY,WAAW,KAAK,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AA5DxC,OAqEJ,WAAW,CAAC,WAAmB,UACpC,IAAI,OAAM,YAAY,WAAW,KAAK,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAtExC,OA+EJ,gBAAgB,CAAC,WAAmB,UACzC,IAAI,OAAM,iBAAiB,WAAW,KAAK,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAhF7C,OAyFJ,cAAc,CAAC,WAAmB,UACvC,IAAI,OAAM,eAAe,WAAW,KAAK,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AA1F3C,OAmGJ,mBAAmB,CAAC,WAAmB,UAC5C,IAAI,OAAM,oBAAoB,WAAW,KAAK,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AApGhD,OA4GJ,SAAS,CAAC,cACf,IAAI,OAAM,UAAU,SAAS,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AA7G/B,OAqHJ,YAAY,CAAC,cAClB,IAAI,OAAM,aAAa,SAAS,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAtHlC,OAgIJ,UAAU,CAAC,WAAmB,OAAwB,QAC3D,IAAI,OAAM,WAAW,WAAW,CAAC,OAAO,GAAG,CAAmB,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAjIhE,OA0IJ,aAAa,CAAC,WAAmB,UACtC,IAAI,OAAM,cAAc,WAAW,KAAK,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AA3I1C,OAoJJ,WAAW,CAAC,WAAmB,UACpC,IAAI,OAAM,YAAY,WAAW,KAAK,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AArJxC,OA6JJ,SAAS,CAAC,eACf,IAAI,OAAM,UAAU,QAAW,UAAU,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AA9J3C,OAwKJ,SAAS,CAAC,WAAmB,UAClC,IAAI,OAAM,UAAU,WAAW,KAAK,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAzKtC,OAiLJ,YAAY,CAAC,cAClB,IAAI,OAAM,aAAa,SAAS,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAlLlC,OA0LJ,WAAW,CAAC,cACjB,IAAI,OAAM,YAAY,SAAS,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AA3LjC,OAmMJ,cAAc,CAAC,eACpB,IAAI,OAAM,eAAe,QAAW,UAAU,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AApMhD,OA4MJ,eAAe,CAAC,eACrB,IAAI,OAAM,gBAAgB,QAAW,UAAU,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AA7MjD,OAqNJ,QAAQ,CAAC,UACd,IAAI,OAAM,SAAS,QAAW,KAAK,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAtNrC,OA8NJ,SAAS,CAAC,WACf,IAAI,OAAM,UAAU,QAAW,MAAM,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AA/NvC,OAwOJ,WAAW,CAAC,WAAmB,UACpC,IAAI,OAAM,YAAY,WAAW,KAAK,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAzOxC,OAiPJ,KAAK,CAAC,YACX,IAAI,OAAM,MAAM,QAAW,QAAQ,IAAI,CAAC,UAAU,KAAK,MAAM,KAAK,CAAC,CAAC,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAlPtE,OA0PJ,MAAM,CAAC,YACZ,IAAI,OAAM,OAAO,QAAW,QAAQ,IAAI,CAAC,UAAU,KAAK,MAAM,KAAK,CAAC,CAAC,EAAE,SAAS;AA3P7E,IAAM,QAAN","sourcesContent":["type QueryTypesSingle = string | number | boolean;\nexport type QueryTypesList = string[] | number[] | boolean[] | Query[];\nexport type QueryTypes = QueryTypesSingle | QueryTypesList;\ntype AttributesTypes = string | string[];\n\n/**\n * Helper class to generate query strings.\n */\nexport class Query {\n  method: string;\n  attribute: AttributesTypes | undefined;\n  values: QueryTypesList | undefined;\n\n  /**\n   * Constructor for Query class.\n   *\n   * @param {string} method\n   * @param {AttributesTypes} attribute\n   * @param {QueryTypes} values\n   */\n  constructor(\n    method: string,\n    attribute?: AttributesTypes,\n    values?: QueryTypes\n  ) {\n    this.method = method;\n    this.attribute = attribute;\n\n    if (values !== undefined) {\n      if (Array.isArray(values)) {\n        this.values = values;\n      } else {\n        this.values = [values] as QueryTypesList;\n      }\n    }\n  }\n\n  /**\n   * Convert the query object to a JSON string.\n   *\n   * @returns {string}\n   */\n  toString(): string {\n    return JSON.stringify({\n      method: this.method,\n      attribute: this.attribute,\n      values: this.values,\n    });\n  }\n\n  /**\n   * Filter resources where attribute is equal to value.\n   *\n   * @param {string} attribute\n   * @param {QueryTypes} value\n   * @returns {string}\n   */\n  static equal = (attribute: string, value: QueryTypes): string =>\n    new Query(\"equal\", attribute, value).toString();\n\n  /**\n   * Filter resources where attribute is not equal to value.\n   *\n   * @param {string} attribute\n   * @param {QueryTypes} value\n   * @returns {string}\n   */\n  static notEqual = (attribute: string, value: QueryTypes): string =>\n    new Query(\"notEqual\", attribute, value).toString();\n\n  /**\n   * Filter resources where attribute is less than value.\n   *\n   * @param {string} attribute\n   * @param {QueryTypes} value\n   * @returns {string}\n   */\n  static lessThan = (attribute: string, value: QueryTypes): string =>\n    new Query(\"lessThan\", attribute, value).toString();\n\n  /**\n   * Filter resources where attribute is less than or equal to value.\n   *\n   * @param {string} attribute\n   * @param {QueryTypes} value\n   * @returns {string}\n   */\n  static lessThanEqual = (attribute: string, value: QueryTypes): string =>\n    new Query(\"lessThanEqual\", attribute, value).toString();\n\n  /**\n   * Filter resources where attribute is greater than value.\n   *\n   * @param {string} attribute\n   * @param {QueryTypes} value\n   * @returns {string}\n   */\n  static greaterThan = (attribute: string, value: QueryTypes): string =>\n    new Query(\"greaterThan\", attribute, value).toString();\n\n  /**\n   * Filter resources where attribute is greater than or equal to value.\n   *\n   * @param {string} attribute\n   * @param {QueryTypes} value\n   * @returns {string}\n   */\n  static greaterThanEqual = (attribute: string, value: QueryTypes): string =>\n    new Query(\"greaterThanEqual\", attribute, value).toString();\n\n  /**\n   * Filter resources where attribute is null.\n   *\n   * @param {string} attribute\n   * @returns {string}\n   */\n  static isNull = (attribute: string): string =>\n    new Query(\"isNull\", attribute).toString();\n\n  /**\n   * Filter resources where attribute is not null.\n   *\n   * @param {string} attribute\n   * @returns {string}\n   */\n  static isNotNull = (attribute: string): string =>\n    new Query(\"isNotNull\", attribute).toString();\n\n  /**\n   * Filter resources where attribute is between start and end (inclusive).\n   *\n   * @param {string} attribute\n   * @param {string | number} start\n   * @param {string | number} end\n   * @returns {string}\n   */\n  static between = (attribute: string, start: string | number, end: string | number): string =>\n    new Query(\"between\", attribute, [start, end] as QueryTypesList).toString();\n\n  /**\n   * Filter resources where attribute starts with value.\n   *\n   * @param {string} attribute\n   * @param {string} value\n   * @returns {string}\n   */\n  static startsWith = (attribute: string, value: string): string =>\n    new Query(\"startsWith\", attribute, value).toString();\n\n  /**\n   * Filter resources where attribute ends with value.\n   *\n   * @param {string} attribute\n   * @param {string} value\n   * @returns {string}\n   */\n  static endsWith = (attribute: string, value: string): string =>\n    new Query(\"endsWith\", attribute, value).toString();\n\n  /**\n   * Specify which attributes should be returned by the API call.\n   *\n   * @param {string[]} attributes\n   * @returns {string}\n   */\n  static select = (attributes: string[]): string =>\n    new Query(\"select\", undefined, attributes).toString();\n\n  /**\n   * Filter resources by searching attribute for value.\n   * A fulltext index on attribute is required for this query to work.\n   *\n   * @param {string} attribute\n   * @param {string} value\n   * @returns {string}\n   */\n  static search = (attribute: string, value: string): string =>\n    new Query(\"search\", attribute, value).toString();\n\n  /**\n   * Sort results by attribute descending.\n   *\n   * @param {string} attribute\n   * @returns {string}\n   */\n  static orderDesc = (attribute: string): string =>\n    new Query(\"orderDesc\", attribute).toString();\n\n  /**\n   * Sort results by attribute ascending.\n   *\n   * @param {string} attribute\n   * @returns {string}\n   */\n  static orderAsc = (attribute: string): string =>\n    new Query(\"orderAsc\", attribute).toString();\n\n  /**\n   * Return results after documentId.\n   *\n   * @param {string} documentId\n   * @returns {string}\n   */\n  static cursorAfter = (documentId: string): string =>\n    new Query(\"cursorAfter\", undefined, documentId).toString();\n\n  /**\n   * Return results before documentId.\n   *\n   * @param {string} documentId\n   * @returns {string}\n   */\n  static cursorBefore = (documentId: string): string =>\n    new Query(\"cursorBefore\", undefined, documentId).toString();\n\n  /**\n   * Return only limit results.\n   *\n   * @param {number} limit\n   * @returns {string}\n   */\n  static limit = (limit: number): string =>\n    new Query(\"limit\", undefined, limit).toString();\n\n  /**\n   * Filter resources by skipping the first offset results.\n   *\n   * @param {number} offset\n   * @returns {string}\n   */\n  static offset = (offset: number): string =>\n    new Query(\"offset\", undefined, offset).toString();\n\n  /**\n   * Filter resources where attribute contains the specified value.\n   *\n   * @param {string} attribute\n   * @param {string | string[]} value\n   * @returns {string}\n   */\n  static contains = (attribute: string, value: string | string[]): string =>\n    new Query(\"contains\", attribute, value).toString();\n\n  /**\n   * Combine multiple queries using logical OR operator.\n   *\n   * @param {string[]} queries\n   * @returns {string}\n   */\n  static or = (queries: string[]) =>\n    new Query(\"or\", undefined, queries.map((query) => JSON.parse(query))).toString();\n\n  /**\n   * Combine multiple queries using logical AND operator.\n   *\n   * @param {string[]} queries\n   * @returns {string}\n   */\n  static and = (queries: string[]) =>\n    new Query(\"and\", undefined, queries.map((query) => JSON.parse(query))).toString();\n}\n"]}