402 lines
12 KiB
JavaScript
402 lines
12 KiB
JavaScript
'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;
|
|
if (values !== void 0) {
|
|
if (Array.isArray(values)) {
|
|
this.values = values;
|
|
} else {
|
|
this.values = [values];
|
|
}
|
|
}
|
|
}
|
|
/**
|
|
* Convert the query object to a JSON string.
|
|
*
|
|
* @returns {string}
|
|
*/
|
|
toString() {
|
|
return JSON.stringify({
|
|
method: this.method,
|
|
attribute: this.attribute,
|
|
values: this.values
|
|
});
|
|
}
|
|
};
|
|
/**
|
|
* 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();
|
|
/**
|
|
* Sort results randomly.
|
|
*
|
|
* @returns {string}
|
|
*/
|
|
_Query.orderRandom = () => new _Query("orderRandom").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();
|
|
/**
|
|
* 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) => _Query.lessThan("$createdAt", value);
|
|
/**
|
|
* Filter resources where document was created after date.
|
|
*
|
|
* @param {string} value
|
|
* @returns {string}
|
|
*/
|
|
_Query.createdAfter = (value) => _Query.greaterThan("$createdAt", value);
|
|
/**
|
|
* Filter resources where document was created between dates.
|
|
*
|
|
* @param {string} start
|
|
* @param {string} end
|
|
* @returns {string}
|
|
*/
|
|
_Query.createdBetween = (start, end) => _Query.between("$createdAt", start, end);
|
|
/**
|
|
* Filter resources where document was updated before date.
|
|
*
|
|
* @param {string} value
|
|
* @returns {string}
|
|
*/
|
|
_Query.updatedBefore = (value) => _Query.lessThan("$updatedAt", value);
|
|
/**
|
|
* Filter resources where document was updated after date.
|
|
*
|
|
* @param {string} value
|
|
* @returns {string}
|
|
*/
|
|
_Query.updatedAfter = (value) => _Query.greaterThan("$updatedAt", value);
|
|
/**
|
|
* Filter resources where document was updated between dates.
|
|
*
|
|
* @param {string} start
|
|
* @param {string} end
|
|
* @returns {string}
|
|
*/
|
|
_Query.updatedBetween = (start, end) => _Query.between("$updatedAt", start, end);
|
|
/**
|
|
* 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();
|
|
/**
|
|
* 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;
|
|
//# sourceMappingURL=out.js.map
|
|
//# sourceMappingURL=query.js.map
|