1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999 |
- "use strict";
- Object.defineProperty(exports, "__esModule", {
- value: true
- });
- exports.default = void 0;
- var _CoreManager = _interopRequireDefault(require("./CoreManager"));
- var _encode = _interopRequireDefault(require("./encode"));
- var _promiseUtils = require("./promiseUtils");
- var _ParseError = _interopRequireDefault(require("./ParseError"));
- var _ParseGeoPoint = _interopRequireDefault(require("./ParseGeoPoint"));
- var _ParseObject = _interopRequireDefault(require("./ParseObject"));
- var _OfflineQuery = _interopRequireDefault(require("./OfflineQuery"));
- var _LocalDatastoreUtils = require("./LocalDatastoreUtils");
- function _interopRequireDefault(e) {
- return e && e.__esModule ? e : {
- default: e
- };
- }
- /**
- * Converts a string into a regex that matches it.
- * Surrounding with \Q .. \E does this, we just need to escape any \E's in
- * the text separately.
- *
- * @param s
- * @private
- * @returns {string}
- */
- function quote(s) {
- return '\\Q' + s.replace('\\E', '\\E\\\\E\\Q') + '\\E';
- }
- /**
- * Extracts the class name from queries. If not all queries have the same
- * class name an error will be thrown.
- *
- * @param queries
- * @private
- * @returns {string}
- */
- function _getClassNameFromQueries(queries) {
- let className = null;
- queries.forEach(q => {
- if (!className) {
- className = q.className;
- }
- if (className !== q.className) {
- throw new Error('All queries must be for the same class.');
- }
- });
- return className;
- }
- /*
- * Handles pre-populating the result data of a query with select fields,
- * making sure that the data object contains keys for all objects that have
- * been requested with a select, so that our cached state updates correctly.
- */
- function handleSelectResult(data, select) {
- const serverDataMask = {};
- select.forEach(field => {
- const hasSubObjectSelect = field.indexOf('.') !== -1;
- if (!hasSubObjectSelect && !data.hasOwnProperty(field)) {
- // this field was selected, but is missing from the retrieved data
- data[field] = undefined;
- } else if (hasSubObjectSelect) {
- // this field references a sub-object,
- // so we need to walk down the path components
- const pathComponents = field.split('.');
- let obj = data;
- let serverMask = serverDataMask;
- pathComponents.forEach((component, index, arr) => {
- // add keys if the expected data is missing
- if (obj && !obj.hasOwnProperty(component)) {
- obj[component] = undefined;
- }
- if (obj && typeof obj === 'object') {
- obj = obj[component];
- }
- //add this path component to the server mask so we can fill it in later if needed
- if (index < arr.length - 1) {
- if (!serverMask[component]) {
- serverMask[component] = {};
- }
- serverMask = serverMask[component];
- }
- });
- }
- });
- if (Object.keys(serverDataMask).length > 0) {
- // When selecting from sub-objects, we don't want to blow away the missing
- // information that we may have retrieved before. We've already added any
- // missing selected keys to sub-objects, but we still need to add in the
- // data for any previously retrieved sub-objects that were not selected.
- const serverData = _CoreManager.default.getObjectStateController().getServerData({
- id: data.objectId,
- className: data.className
- });
- copyMissingDataWithMask(serverData, data, serverDataMask, false);
- }
- }
- function copyMissingDataWithMask(src, dest, mask, copyThisLevel) {
- //copy missing elements at this level
- if (copyThisLevel) {
- for (const key in src) {
- if (src.hasOwnProperty(key) && !dest.hasOwnProperty(key)) {
- dest[key] = src[key];
- }
- }
- }
- for (const key in mask) {
- if (dest[key] !== undefined && dest[key] !== null && src !== undefined && src !== null) {
- //traverse into objects as needed
- copyMissingDataWithMask(src[key], dest[key], mask[key], true);
- }
- }
- }
- function handleOfflineSort(a, b, sorts) {
- let order = sorts[0];
- const operator = order.slice(0, 1);
- const isDescending = operator === '-';
- if (isDescending) {
- order = order.substring(1);
- }
- if (order === '_created_at') {
- order = 'createdAt';
- }
- if (order === '_updated_at') {
- order = 'updatedAt';
- }
- if (!/^[A-Za-z][0-9A-Za-z_]*$/.test(order) || order === 'password') {
- throw new _ParseError.default(_ParseError.default.INVALID_KEY_NAME, `Invalid Key: ${order}`);
- }
- const field1 = a.get(order);
- const field2 = b.get(order);
- if (field1 < field2) {
- return isDescending ? 1 : -1;
- }
- if (field1 > field2) {
- return isDescending ? -1 : 1;
- }
- if (sorts.length > 1) {
- const remainingSorts = sorts.slice(1);
- return handleOfflineSort(a, b, remainingSorts);
- }
- return 0;
- }
- /**
- * Creates a new parse Parse.Query for the given Parse.Object subclass.
- *
- * <p>Parse.Query defines a query that is used to fetch Parse.Objects. The
- * most common use case is finding all objects that match a query through the
- * <code>find</code> method. for example, this sample code fetches all objects
- * of class <code>myclass</code>. it calls a different function depending on
- * whether the fetch succeeded or not.
- *
- * <pre>
- * var query = new Parse.Query(myclass);
- * query.find().then((results) => {
- * // results is an array of parse.object.
- * }).catch((error) => {
- * // error is an instance of parse.error.
- * });</pre></p>
- *
- * <p>a Parse.Query can also be used to retrieve a single object whose id is
- * known, through the get method. for example, this sample code fetches an
- * object of class <code>myclass</code> and id <code>myid</code>. it calls a
- * different function depending on whether the fetch succeeded or not.
- *
- * <pre>
- * var query = new Parse.Query(myclass);
- * query.get(myid).then((object) => {
- * // object is an instance of parse.object.
- * }).catch((error) => {
- * // error is an instance of parse.error.
- * });</pre></p>
- *
- * <p>a Parse.Query can also be used to count the number of objects that match
- * the query without retrieving all of those objects. for example, this
- * sample code counts the number of objects of the class <code>myclass</code>
- * <pre>
- * var query = new Parse.Query(myclass);
- * query.count().then((number) => {
- * // there are number instances of myclass.
- * }).catch((error) => {
- * // error is an instance of Parse.Error.
- * });</pre></p>
- *
- * @alias Parse.Query
- */
- class ParseQuery {
- /**
- * @property {string} className
- */
- /**
- * @param {(string | Parse.Object)} objectClass An instance of a subclass of Parse.Object, or a Parse className string.
- */
- constructor(objectClass) {
- if (typeof objectClass === 'string') {
- if (objectClass === 'User' && _CoreManager.default.get('PERFORM_USER_REWRITE')) {
- this.className = '_User';
- } else {
- this.className = objectClass;
- }
- } else if (objectClass instanceof _ParseObject.default) {
- this.className = objectClass.className;
- } else if (typeof objectClass === 'function') {
- const objClass = objectClass;
- if (typeof objClass.className === 'string') {
- this.className = objClass.className;
- } else {
- const obj = new objClass();
- this.className = obj.className;
- }
- } else {
- throw new TypeError('A ParseQuery must be constructed with a ParseObject or class name.');
- }
- this._where = {};
- this._watch = [];
- this._include = [];
- this._exclude = [];
- this._count = false;
- this._limit = -1; // negative limit is not sent in the server request
- this._skip = 0;
- this._readPreference = null;
- this._includeReadPreference = null;
- this._subqueryReadPreference = null;
- this._queriesLocalDatastore = false;
- this._localDatastorePinName = null;
- this._extraOptions = {};
- this._xhrRequest = {
- task: null,
- onchange: () => {}
- };
- this._comment = null;
- }
- /**
- * Adds constraint that at least one of the passed in queries matches.
- *
- * @param {Array} queries
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- _orQuery(queries) {
- const queryJSON = queries.map(q => {
- return q.toJSON().where;
- });
- this._where.$or = queryJSON;
- return this;
- }
- /**
- * Adds constraint that all of the passed in queries match.
- *
- * @param {Array} queries
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- _andQuery(queries) {
- const queryJSON = queries.map(q => {
- return q.toJSON().where;
- });
- this._where.$and = queryJSON;
- return this;
- }
- /**
- * Adds constraint that none of the passed in queries match.
- *
- * @param {Array} queries
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- _norQuery(queries) {
- const queryJSON = queries.map(q => {
- return q.toJSON().where;
- });
- this._where.$nor = queryJSON;
- return this;
- }
- /**
- * Helper for condition queries
- *
- * @param key
- * @param condition
- * @param value
- * @returns {Parse.Query}
- */
- _addCondition(key, condition, value) {
- if (!this._where[key] || typeof this._where[key] === 'string') {
- this._where[key] = {};
- }
- this._where[key][condition] = (0, _encode.default)(value, false, true);
- return this;
- }
- /**
- * Converts string for regular expression at the beginning
- *
- * @param string
- * @returns {string}
- */
- _regexStartWith(string) {
- return '^' + quote(string);
- }
- async _handleOfflineQuery(params) {
- _OfflineQuery.default.validateQuery(this);
- const localDatastore = _CoreManager.default.getLocalDatastore();
- const objects = await localDatastore._serializeObjectsFromPinName(this._localDatastorePinName);
- let results = objects.map((json, index, arr) => {
- const object = _ParseObject.default.fromJSON(json, false);
- if (json._localId && !json.objectId) {
- object._localId = json._localId;
- }
- if (!_OfflineQuery.default.matchesQuery(this.className, object, arr, this)) {
- return null;
- }
- return object;
- }).filter(object => object !== null);
- if (params.keys) {
- let keys = params.keys.split(',');
- keys = keys.concat(['className', 'objectId', 'createdAt', 'updatedAt', 'ACL']);
- results = results.map(object => {
- const json = object._toFullJSON();
- Object.keys(json).forEach(key => {
- if (!keys.includes(key)) {
- delete json[key];
- }
- });
- return _ParseObject.default.fromJSON(json, false);
- });
- }
- if (params.order) {
- const sorts = params.order.split(',');
- results.sort((a, b) => {
- return handleOfflineSort(a, b, sorts);
- });
- }
- let count; // count total before applying limit/skip
- if (params.count) {
- count = results.length; // total count from response
- }
- if (params.skip) {
- if (params.skip >= results.length) {
- results = [];
- } else {
- results = results.splice(params.skip, results.length);
- }
- }
- let limit = results.length;
- if (params.limit !== 0 && params.limit < results.length) {
- limit = params.limit;
- }
- results = results.splice(0, limit);
- if (typeof count === 'number') {
- return {
- results,
- count
- };
- }
- return results;
- }
- /**
- * Returns a JSON representation of this query.
- *
- * @returns {object} The JSON representation of the query.
- */
- toJSON() {
- const params = {
- where: this._where
- };
- if (this._watch.length) {
- params.watch = this._watch.join(',');
- }
- if (this._include.length) {
- params.include = this._include.join(',');
- }
- if (this._exclude.length) {
- params.excludeKeys = this._exclude.join(',');
- }
- if (this._select) {
- params.keys = this._select.join(',');
- }
- if (this._count) {
- params.count = 1;
- }
- if (this._limit >= 0) {
- params.limit = this._limit;
- }
- if (this._skip > 0) {
- params.skip = this._skip;
- }
- if (this._order) {
- params.order = this._order.join(',');
- }
- if (this._readPreference) {
- params.readPreference = this._readPreference;
- }
- if (this._includeReadPreference) {
- params.includeReadPreference = this._includeReadPreference;
- }
- if (this._subqueryReadPreference) {
- params.subqueryReadPreference = this._subqueryReadPreference;
- }
- if (this._hint) {
- params.hint = this._hint;
- }
- if (this._explain) {
- params.explain = true;
- }
- if (this._comment) {
- params.comment = this._comment;
- }
- for (const key in this._extraOptions) {
- params[key] = this._extraOptions[key];
- }
- return params;
- }
- /**
- * Return a query with conditions from json, can be useful to send query from server side to client
- * Not static, all query conditions was set before calling this method will be deleted.
- * For example on the server side we have
- * var query = new Parse.Query("className");
- * query.equalTo(key: value);
- * query.limit(100);
- * ... (others queries)
- * Create JSON representation of Query Object
- * var jsonFromServer = query.fromJSON();
- *
- * On client side getting query:
- * var query = new Parse.Query("className");
- * query.fromJSON(jsonFromServer);
- *
- * and continue to query...
- * query.skip(100).find().then(...);
- *
- * @param {QueryJSON} json from Parse.Query.toJSON() method
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- withJSON(json) {
- if (json.where) {
- this._where = json.where;
- }
- if (json.watch) {
- this._watch = json.watch.split(',');
- }
- if (json.include) {
- this._include = json.include.split(',');
- }
- if (json.keys) {
- this._select = json.keys.split(',');
- }
- if (json.excludeKeys) {
- this._exclude = json.excludeKeys.split(',');
- }
- if (json.count) {
- this._count = json.count === 1;
- }
- if (json.limit) {
- this._limit = json.limit;
- }
- if (json.skip) {
- this._skip = json.skip;
- }
- if (json.order) {
- this._order = json.order.split(',');
- }
- if (json.readPreference) {
- this._readPreference = json.readPreference;
- }
- if (json.includeReadPreference) {
- this._includeReadPreference = json.includeReadPreference;
- }
- if (json.subqueryReadPreference) {
- this._subqueryReadPreference = json.subqueryReadPreference;
- }
- if (json.hint) {
- this._hint = json.hint;
- }
- if (json.explain) {
- this._explain = !!json.explain;
- }
- if (json.comment) {
- this._comment = json.comment;
- }
- for (const key in json) {
- if (json.hasOwnProperty(key)) {
- if (['where', 'include', 'keys', 'count', 'limit', 'skip', 'order', 'readPreference', 'includeReadPreference', 'subqueryReadPreference', 'hint', 'explain', 'comment'].indexOf(key) === -1) {
- this._extraOptions[key] = json[key];
- }
- }
- }
- return this;
- }
- /**
- * Static method to restore Parse.Query by json representation
- * Internally calling Parse.Query.withJSON
- *
- * @param {string} className
- * @param {QueryJSON} json from Parse.Query.toJSON() method
- * @returns {Parse.Query} new created query
- */
- static fromJSON(className, json) {
- const query = new ParseQuery(className);
- return query.withJSON(json);
- }
- /**
- * Constructs a Parse.Object whose id is already known by fetching data from
- * the server. Unlike the <code>first</code> method, it never returns undefined.
- *
- * @param {string} objectId The id of the object to be fetched.
- * @param {object} options
- * Valid options are:<ul>
- * <li>useMasterKey: In Cloud Code and Node only, causes the Master Key to
- * be used for this request.
- * <li>sessionToken: A valid session token, used for making a request on
- * behalf of a specific user.
- * <li>context: A dictionary that is accessible in Cloud Code `beforeFind` trigger.
- * <li>json: Return raw json without converting to Parse.Object
- * </ul>
- * @returns {Promise} A promise that is resolved with the result when
- * the query completes.
- */
- get(objectId, options) {
- this.equalTo('objectId', objectId);
- const firstOptions = {};
- if (options && options.hasOwnProperty('useMasterKey')) {
- firstOptions.useMasterKey = options.useMasterKey;
- }
- if (options && options.hasOwnProperty('sessionToken')) {
- firstOptions.sessionToken = options.sessionToken;
- }
- if (options && options.hasOwnProperty('context') && typeof options.context === 'object') {
- firstOptions.context = options.context;
- }
- if (options && options.hasOwnProperty('json')) {
- firstOptions.json = options.json;
- }
- return this.first(firstOptions).then(response => {
- if (response) {
- return response;
- }
- const errorObject = new _ParseError.default(_ParseError.default.OBJECT_NOT_FOUND, 'Object not found.');
- return Promise.reject(errorObject);
- });
- }
- /**
- * Retrieves a list of ParseObjects that satisfy this query.
- *
- * @param {object} options Valid options
- * are:<ul>
- * <li>useMasterKey: In Cloud Code and Node only, causes the Master Key to
- * be used for this request.
- * <li>sessionToken: A valid session token, used for making a request on
- * behalf of a specific user.
- * <li>context: A dictionary that is accessible in Cloud Code `beforeFind` trigger.
- * <li>json: Return raw json without converting to Parse.Object
- * </ul>
- * @returns {Promise} A promise that is resolved with the results when
- * the query completes.
- */
- find(options) {
- options = options || {};
- const findOptions = {};
- if (options.hasOwnProperty('useMasterKey')) {
- findOptions.useMasterKey = options.useMasterKey;
- }
- if (options.hasOwnProperty('sessionToken')) {
- findOptions.sessionToken = options.sessionToken;
- }
- if (options.hasOwnProperty('context') && typeof options.context === 'object') {
- findOptions.context = options.context;
- }
- this._setRequestTask(findOptions);
- const controller = _CoreManager.default.getQueryController();
- const select = this._select;
- if (this._queriesLocalDatastore) {
- return this._handleOfflineQuery(this.toJSON());
- }
- return controller.find(this.className, this.toJSON(), findOptions).then(response => {
- var _response$results;
- // Return generic object when explain is used
- if (this._explain) {
- return response.results;
- }
- const results = (_response$results = response.results) === null || _response$results === void 0 ? void 0 : _response$results.map(data => {
- // In cases of relations, the server may send back a className
- // on the top level of the payload
- const override = response.className || this.className;
- if (!data.className) {
- data.className = override;
- }
- // Make sure the data object contains keys for all objects that
- // have been requested with a select, so that our cached state
- // updates correctly.
- if (select) {
- handleSelectResult(data, select);
- }
- if (options.json) {
- return data;
- } else {
- return _ParseObject.default.fromJSON(data, !select);
- }
- });
- const count = response.count;
- if (typeof count === 'number') {
- return {
- results,
- count
- };
- } else {
- return results;
- }
- });
- }
- /**
- * Retrieves a complete list of ParseObjects that satisfy this query.
- * Using `eachBatch` under the hood to fetch all the valid objects.
- *
- * @param {object} options Valid options are:<ul>
- * <li>batchSize: How many objects to yield in each batch (default: 100)
- * <li>useMasterKey: In Cloud Code and Node only, causes the Master Key to
- * be used for this request.
- * <li>sessionToken: A valid session token, used for making a request on
- * behalf of a specific user.
- * </ul>
- * @returns {Promise} A promise that is resolved with the results when
- * the query completes.
- */
- async findAll(options) {
- let result = [];
- await this.eachBatch(objects => {
- result = [...result, ...objects];
- }, options);
- return result;
- }
- /**
- * Counts the number of objects that match this query.
- *
- * @param {object} options
- * @param {boolean} [options.useMasterKey]
- * @param {string} [options.sessionToken]
- * Valid options are:<ul>
- * <li>useMasterKey: In Cloud Code and Node only, causes the Master Key to
- * be used for this request.
- * <li>sessionToken: A valid session token, used for making a request on
- * behalf of a specific user.
- * </ul>
- * @returns {Promise} A promise that is resolved with the count when
- * the query completes.
- */
- count(options) {
- options = options || {};
- const findOptions = {};
- if (options.hasOwnProperty('useMasterKey')) {
- findOptions.useMasterKey = options.useMasterKey;
- }
- if (options.hasOwnProperty('sessionToken')) {
- findOptions.sessionToken = options.sessionToken;
- }
- this._setRequestTask(findOptions);
- const controller = _CoreManager.default.getQueryController();
- const params = this.toJSON();
- params.limit = 0;
- params.count = 1;
- return controller.find(this.className, params, findOptions).then(result => {
- return result.count;
- });
- }
- /**
- * Executes a distinct query and returns unique values
- *
- * @param {string} key A field to find distinct values
- * @param {object} options
- * @param {string} [options.sessionToken] A valid session token, used for making a request on behalf of a specific user.
- * @returns {Promise} A promise that is resolved with the query completes.
- */
- distinct(key, options) {
- options = options || {};
- const distinctOptions = {
- useMasterKey: true
- };
- if (options.hasOwnProperty('sessionToken')) {
- distinctOptions.sessionToken = options.sessionToken;
- }
- this._setRequestTask(distinctOptions);
- const controller = _CoreManager.default.getQueryController();
- const params = {
- distinct: key,
- where: this._where,
- hint: this._hint
- };
- return controller.aggregate(this.className, params, distinctOptions).then(results => {
- return results.results;
- });
- }
- /**
- * Executes an aggregate query and returns aggregate results
- *
- * @param {(Array|object)} pipeline Array or Object of stages to process query
- * @param {object} options
- * @param {string} [options.sessionToken] A valid session token, used for making a request on behalf of a specific user.
- * @returns {Promise} A promise that is resolved with the query completes.
- */
- aggregate(pipeline, options) {
- options = options || {};
- const aggregateOptions = {
- useMasterKey: true
- };
- if (options.hasOwnProperty('sessionToken')) {
- aggregateOptions.sessionToken = options.sessionToken;
- }
- this._setRequestTask(aggregateOptions);
- const controller = _CoreManager.default.getQueryController();
- if (!Array.isArray(pipeline) && typeof pipeline !== 'object') {
- throw new Error('Invalid pipeline must be Array or Object');
- }
- if (Object.keys(this._where || {}).length) {
- if (!Array.isArray(pipeline)) {
- pipeline = [pipeline];
- }
- pipeline.unshift({
- $match: this._where
- });
- }
- const params = {
- pipeline,
- hint: this._hint,
- explain: this._explain,
- readPreference: this._readPreference
- };
- return controller.aggregate(this.className, params, aggregateOptions).then(results => {
- return results.results;
- });
- }
- /**
- * Retrieves at most one Parse.Object that satisfies this query.
- *
- * Returns the object if there is one, otherwise undefined.
- *
- * @param {object} options Valid options are:<ul>
- * <li>useMasterKey: In Cloud Code and Node only, causes the Master Key to
- * be used for this request.
- * <li>sessionToken: A valid session token, used for making a request on
- * behalf of a specific user.
- * <li>context: A dictionary that is accessible in Cloud Code `beforeFind` trigger.
- * <li>json: Return raw json without converting to Parse.Object
- * </ul>
- * @returns {Promise} A promise that is resolved with the object when
- * the query completes.
- */
- first(options = {}) {
- const findOptions = {};
- if (options.hasOwnProperty('useMasterKey')) {
- findOptions.useMasterKey = options.useMasterKey;
- }
- if (options.hasOwnProperty('sessionToken')) {
- findOptions.sessionToken = options.sessionToken;
- }
- if (options.hasOwnProperty('context') && typeof options.context === 'object') {
- findOptions.context = options.context;
- }
- this._setRequestTask(findOptions);
- const controller = _CoreManager.default.getQueryController();
- const params = this.toJSON();
- params.limit = 1;
- const select = this._select;
- if (this._queriesLocalDatastore) {
- return this._handleOfflineQuery(params).then(objects => {
- if (!objects[0]) {
- return undefined;
- }
- return objects[0];
- });
- }
- return controller.find(this.className, params, findOptions).then(response => {
- const objects = response.results;
- if (!objects[0]) {
- return undefined;
- }
- if (!objects[0].className) {
- objects[0].className = this.className;
- }
- // Make sure the data object contains keys for all objects that
- // have been requested with a select, so that our cached state
- // updates correctly.
- if (select) {
- handleSelectResult(objects[0], select);
- }
- if (options.json) {
- return objects[0];
- } else {
- return _ParseObject.default.fromJSON(objects[0], !select);
- }
- });
- }
- /**
- * Iterates over objects matching a query, calling a callback for each batch.
- * If the callback returns a promise, the iteration will not continue until
- * that promise has been fulfilled. If the callback returns a rejected
- * promise, then iteration will stop with that error. The items are processed
- * in an unspecified order. The query may not have any sort order, and may
- * not use limit or skip.
- *
- * @param {Function} callback Callback that will be called with each result
- * of the query.
- * @param {object} options Valid options are:<ul>
- * <li>batchSize: How many objects to yield in each batch (default: 100)
- * <li>useMasterKey: In Cloud Code and Node only, causes the Master Key to
- * be used for this request.
- * <li>sessionToken: A valid session token, used for making a request on
- * behalf of a specific user.
- * <li>context: A dictionary that is accessible in Cloud Code `beforeFind` trigger.
- * </ul>
- * @returns {Promise} A promise that will be fulfilled once the
- * iteration has completed.
- */
- eachBatch(callback, options) {
- options = options || {};
- if (this._order || this._skip || this._limit >= 0) {
- return Promise.reject('Cannot iterate on a query with sort, skip, or limit.');
- }
- const query = new ParseQuery(this.className);
- query._limit = options.batchSize || 100;
- query._include = [...this._include];
- query._exclude = [...this._exclude];
- if (this._select) {
- query._select = [...this._select];
- }
- query._hint = this._hint;
- query._where = {};
- for (const attr in this._where) {
- const val = this._where[attr];
- if (Array.isArray(val)) {
- query._where[attr] = val.map(v => {
- return v;
- });
- } else if (val && typeof val === 'object') {
- const conditionMap = {};
- query._where[attr] = conditionMap;
- for (const cond in val) {
- conditionMap[cond] = val[cond];
- }
- } else {
- query._where[attr] = val;
- }
- }
- query.ascending('objectId');
- const findOptions = {};
- if (options.hasOwnProperty('useMasterKey')) {
- findOptions.useMasterKey = options.useMasterKey;
- }
- if (options.hasOwnProperty('sessionToken')) {
- findOptions.sessionToken = options.sessionToken;
- }
- if (options.hasOwnProperty('context') && typeof options.context === 'object') {
- findOptions.context = options.context;
- }
- if (options.hasOwnProperty('json')) {
- findOptions.json = options.json;
- }
- let finished = false;
- let previousResults = [];
- return (0, _promiseUtils.continueWhile)(() => {
- return !finished;
- }, async () => {
- const [results] = await Promise.all([query.find(findOptions), Promise.resolve(previousResults.length > 0 && callback(previousResults))]);
- if (results.length >= query._limit) {
- query.greaterThan('objectId', results[results.length - 1].id);
- previousResults = results;
- } else if (results.length > 0) {
- await Promise.resolve(callback(results));
- finished = true;
- } else {
- finished = true;
- }
- });
- }
- /**
- * Iterates over each result of a query, calling a callback for each one. If
- * the callback returns a promise, the iteration will not continue until
- * that promise has been fulfilled. If the callback returns a rejected
- * promise, then iteration will stop with that error. The items are
- * processed in an unspecified order. The query may not have any sort order,
- * and may not use limit or skip.
- *
- * @param {Function} callback Callback that will be called with each result
- * of the query.
- * @param {object} options Valid options are:<ul>
- * <li>useMasterKey: In Cloud Code and Node only, causes the Master Key to
- * be used for this request.
- * <li>sessionToken: A valid session token, used for making a request on
- * behalf of a specific user.
- * <li>json: Return raw json without converting to Parse.Object
- * </ul>
- * @returns {Promise} A promise that will be fulfilled once the
- * iteration has completed.
- */
- each(callback, options) {
- return this.eachBatch(results => {
- let callbacksDone = Promise.resolve();
- results.forEach(result => {
- callbacksDone = callbacksDone.then(() => {
- return callback(result);
- });
- });
- return callbacksDone;
- }, options);
- }
- /**
- * Adds a hint to force index selection. (https://docs.mongodb.com/manual/reference/operator/meta/hint/)
- *
- * @param {(string|object)} value String or Object of index that should be used when executing query
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- hint(value) {
- if (typeof value === 'undefined') {
- delete this._hint;
- }
- this._hint = value;
- return this;
- }
- /**
- * Investigates the query execution plan. Useful for optimizing queries. (https://docs.mongodb.com/manual/reference/operator/meta/explain/)
- *
- * @param {boolean} explain Used to toggle the information on the query plan.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- explain(explain = true) {
- if (typeof explain !== 'boolean') {
- throw new Error('You can only set explain to a boolean value');
- }
- this._explain = explain;
- return this;
- }
- /**
- * Iterates over each result of a query, calling a callback for each one. If
- * the callback returns a promise, the iteration will not continue until
- * that promise has been fulfilled. If the callback returns a rejected
- * promise, then iteration will stop with that error. The items are
- * processed in an unspecified order. The query may not have any sort order,
- * and may not use limit or skip.
- *
- * @param {Function} callback Callback <ul>
- * <li>currentObject: The current Parse.Object being processed in the array.</li>
- * <li>index: The index of the current Parse.Object being processed in the array.</li>
- * <li>query: The query map was called upon.</li>
- * </ul>
- * @param {object} options Valid options are:<ul>
- * <li>useMasterKey: In Cloud Code and Node only, causes the Master Key to
- * be used for this request.
- * <li>sessionToken: A valid session token, used for making a request on
- * behalf of a specific user.
- * </ul>
- * @returns {Promise} A promise that will be fulfilled once the
- * iteration has completed.
- */
- async map(callback, options) {
- const array = [];
- let index = 0;
- await this.each(object => {
- return Promise.resolve(callback(object, index, this)).then(result => {
- array.push(result);
- index += 1;
- });
- }, options);
- return array;
- }
- /**
- * Iterates over each result of a query, calling a callback for each one. If
- * the callback returns a promise, the iteration will not continue until
- * that promise has been fulfilled. If the callback returns a rejected
- * promise, then iteration will stop with that error. The items are
- * processed in an unspecified order. The query may not have any sort order,
- * and may not use limit or skip.
- *
- * @param {Function} callback Callback <ul>
- * <li>accumulator: The accumulator accumulates the callback's return values. It is the accumulated value previously returned in the last invocation of the callback.</li>
- * <li>currentObject: The current Parse.Object being processed in the array.</li>
- * <li>index: The index of the current Parse.Object being processed in the array.</li>
- * </ul>
- * @param {*} initialValue A value to use as the first argument to the first call of the callback. If no initialValue is supplied, the first object in the query will be used and skipped.
- * @param {object} options Valid options are:<ul>
- * <li>useMasterKey: In Cloud Code and Node only, causes the Master Key to
- * be used for this request.
- * <li>sessionToken: A valid session token, used for making a request on
- * behalf of a specific user.
- * </ul>
- * @returns {Promise} A promise that will be fulfilled once the
- * iteration has completed.
- */
- async reduce(callback, initialValue, options) {
- let accumulator = initialValue;
- let index = 0;
- await this.each(object => {
- // If no initial value was given, we take the first object from the query
- // as the initial value and don't call the callback with it.
- if (index === 0 && initialValue === undefined) {
- accumulator = object;
- index += 1;
- return;
- }
- return Promise.resolve(callback(accumulator, object, index)).then(result => {
- accumulator = result;
- index += 1;
- });
- }, options);
- if (index === 0 && initialValue === undefined) {
- // Match Array.reduce behavior: "Calling reduce() on an empty array
- // without an initialValue will throw a TypeError".
- throw new TypeError('Reducing empty query result set with no initial value');
- }
- return accumulator;
- }
- /**
- * Iterates over each result of a query, calling a callback for each one. If
- * the callback returns a promise, the iteration will not continue until
- * that promise has been fulfilled. If the callback returns a rejected
- * promise, then iteration will stop with that error. The items are
- * processed in an unspecified order. The query may not have any sort order,
- * and may not use limit or skip.
- *
- * @param {Function} callback Callback <ul>
- * <li>currentObject: The current Parse.Object being processed in the array.</li>
- * <li>index: The index of the current Parse.Object being processed in the array.</li>
- * <li>query: The query filter was called upon.</li>
- * </ul>
- * @param {object} options Valid options are:<ul>
- * <li>useMasterKey: In Cloud Code and Node only, causes the Master Key to
- * be used for this request.
- * <li>sessionToken: A valid session token, used for making a request on
- * behalf of a specific user.
- * </ul>
- * @returns {Promise} A promise that will be fulfilled once the
- * iteration has completed.
- */
- async filter(callback, options) {
- const array = [];
- let index = 0;
- await this.each(object => {
- return Promise.resolve(callback(object, index, this)).then(flag => {
- if (flag) {
- array.push(object);
- }
- index += 1;
- });
- }, options);
- return array;
- }
- /* Query Conditions */
- /**
- * Adds a constraint to the query that requires a particular key's value to
- * be equal to the provided value.
- *
- * @param {string} key The key to check.
- * @param value The value that the Parse.Object must contain.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- equalTo(key, value) {
- if (key && typeof key === 'object') {
- Object.entries(key).forEach(([k, val]) => this.equalTo(k, val));
- return this;
- }
- if (typeof value === 'undefined') {
- return this.doesNotExist(key);
- }
- this._where[key] = (0, _encode.default)(value, false, true);
- return this;
- }
- /**
- * Adds a constraint to the query that requires a particular key's value to
- * be not equal to the provided value.
- *
- * @param {string} key The key to check.
- * @param value The value that must not be equalled.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- notEqualTo(key, value) {
- if (key && typeof key === 'object') {
- Object.entries(key).forEach(([k, val]) => this.notEqualTo(k, val));
- return this;
- }
- return this._addCondition(key, '$ne', value);
- }
- /**
- * Adds a constraint to the query that requires a particular key's value to
- * be less than the provided value.
- *
- * @param {string} key The key to check.
- * @param value The value that provides an upper bound.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- lessThan(key, value) {
- return this._addCondition(key, '$lt', value);
- }
- /**
- * Adds a constraint to the query that requires a particular key's value to
- * be greater than the provided value.
- *
- * @param {string} key The key to check.
- * @param value The value that provides an lower bound.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- greaterThan(key, value) {
- return this._addCondition(key, '$gt', value);
- }
- /**
- * Adds a constraint to the query that requires a particular key's value to
- * be less than or equal to the provided value.
- *
- * @param {string} key The key to check.
- * @param value The value that provides an upper bound.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- lessThanOrEqualTo(key, value) {
- return this._addCondition(key, '$lte', value);
- }
- /**
- * Adds a constraint to the query that requires a particular key's value to
- * be greater than or equal to the provided value.
- *
- * @param {string} key The key to check.
- * @param {*} value The value that provides an lower bound.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- greaterThanOrEqualTo(key, value) {
- return this._addCondition(key, '$gte', value);
- }
- /**
- * Adds a constraint to the query that requires a particular key's value to
- * be contained in the provided list of values.
- *
- * @param {string} key The key to check.
- * @param {Array<*>} value The values that will match.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- containedIn(key, value) {
- return this._addCondition(key, '$in', value);
- }
- /**
- * Adds a constraint to the query that requires a particular key's value to
- * not be contained in the provided list of values.
- *
- * @param {string} key The key to check.
- * @param {Array<*>} value The values that will not match.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- notContainedIn(key, value) {
- return this._addCondition(key, '$nin', value);
- }
- /**
- * Adds a constraint to the query that requires a particular key's value to
- * be contained by the provided list of values. Get objects where all array elements match.
- *
- * @param {string} key The key to check.
- * @param {Array} values The values that will match.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- containedBy(key, values) {
- return this._addCondition(key, '$containedBy', values);
- }
- /**
- * Adds a constraint to the query that requires a particular key's value to
- * contain each one of the provided list of values.
- *
- * @param {string} key The key to check. This key's value must be an array.
- * @param {Array} values The values that will match.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- containsAll(key, values) {
- return this._addCondition(key, '$all', values);
- }
- /**
- * Adds a constraint to the query that requires a particular key's value to
- * contain each one of the provided list of values starting with given strings.
- *
- * @param {string} key The key to check. This key's value must be an array.
- * @param {Array<string>} values The string values that will match as starting string.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- containsAllStartingWith(key, values) {
- if (!Array.isArray(values)) {
- values = [values];
- }
- const regexObject = values.map(value => {
- return {
- $regex: this._regexStartWith(value)
- };
- });
- return this.containsAll(key, regexObject);
- }
- /**
- * Adds a constraint for finding objects that contain the given key.
- *
- * @param {string} key The key that should exist.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- exists(key) {
- return this._addCondition(key, '$exists', true);
- }
- /**
- * Adds a constraint for finding objects that do not contain a given key.
- *
- * @param {string} key The key that should not exist
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- doesNotExist(key) {
- return this._addCondition(key, '$exists', false);
- }
- /**
- * Adds a regular expression constraint for finding string values that match
- * the provided regular expression.
- * This may be slow for large datasets.
- *
- * @param {string} key The key that the string to match is stored in.
- * @param {RegExp | string} regex The regular expression pattern to match.
- * @param {string} modifiers The regular expression mode.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- matches(key, regex, modifiers) {
- this._addCondition(key, '$regex', regex);
- if (!modifiers) {
- modifiers = '';
- }
- if (typeof regex !== 'string') {
- if (regex.ignoreCase) {
- modifiers += 'i';
- }
- if (regex.multiline) {
- modifiers += 'm';
- }
- }
- if (modifiers.length) {
- this._addCondition(key, '$options', modifiers);
- }
- return this;
- }
- /**
- * Adds a constraint that requires that a key's value matches a Parse.Query
- * constraint.
- *
- * @param {string} key The key that the contains the object to match the
- * query.
- * @param {Parse.Query} query The query that should match.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- matchesQuery(key, query) {
- const queryJSON = query.toJSON();
- queryJSON.className = query.className;
- return this._addCondition(key, '$inQuery', queryJSON);
- }
- /**
- * Adds a constraint that requires that a key's value not matches a
- * Parse.Query constraint.
- *
- * @param {string} key The key that the contains the object to match the
- * query.
- * @param {Parse.Query} query The query that should not match.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- doesNotMatchQuery(key, query) {
- const queryJSON = query.toJSON();
- queryJSON.className = query.className;
- return this._addCondition(key, '$notInQuery', queryJSON);
- }
- /**
- * Adds a constraint that requires that a key's value matches a value in
- * an object returned by a different Parse.Query.
- *
- * @param {string} key The key that contains the value that is being
- * matched.
- * @param {string} queryKey The key in the objects returned by the query to
- * match against.
- * @param {Parse.Query} query The query to run.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- matchesKeyInQuery(key, queryKey, query) {
- const queryJSON = query.toJSON();
- queryJSON.className = query.className;
- return this._addCondition(key, '$select', {
- key: queryKey,
- query: queryJSON
- });
- }
- /**
- * Adds a constraint that requires that a key's value not match a value in
- * an object returned by a different Parse.Query.
- *
- * @param {string} key The key that contains the value that is being
- * excluded.
- * @param {string} queryKey The key in the objects returned by the query to
- * match against.
- * @param {Parse.Query} query The query to run.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- doesNotMatchKeyInQuery(key, queryKey, query) {
- const queryJSON = query.toJSON();
- queryJSON.className = query.className;
- return this._addCondition(key, '$dontSelect', {
- key: queryKey,
- query: queryJSON
- });
- }
- /**
- * Adds a constraint for finding string values that contain a provided
- * string. This may be slow for large datasets.
- *
- * @param {string} key The key that the string to match is stored in.
- * @param {string} substring The substring that the value must contain.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- contains(key, substring) {
- if (typeof substring !== 'string') {
- throw new Error('The value being searched for must be a string.');
- }
- return this._addCondition(key, '$regex', quote(substring));
- }
- /**
- * Adds a constraint for finding string values that contain a provided
- * string. This may be slow for large datasets. Requires Parse-Server > 2.5.0
- *
- * In order to sort you must use select and ascending ($score is required)
- * <pre>
- * query.fullText('field', 'term');
- * query.ascending('$score');
- * query.select('$score');
- * </pre>
- *
- * To retrieve the weight / rank
- * <pre>
- * object->get('score');
- * </pre>
- *
- * You can define optionals by providing an object as a third parameter
- * <pre>
- * query.fullText('field', 'term', { language: 'es', diacriticSensitive: true });
- * </pre>
- *
- * @param {string} key The key that the string to match is stored in.
- * @param {string} value The string to search
- * @param {object} options (Optional)
- * @param {string} options.language The language that determines the list of stop words for the search and the rules for the stemmer and tokenizer.
- * @param {boolean} options.caseSensitive A boolean flag to enable or disable case sensitive search.
- * @param {boolean} options.diacriticSensitive A boolean flag to enable or disable diacritic sensitive search.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- fullText(key, value, options = {}) {
- options = options || {};
- if (!key) {
- throw new Error('A key is required.');
- }
- if (!value) {
- throw new Error('A search term is required');
- }
- if (typeof value !== 'string') {
- throw new Error('The value being searched for must be a string.');
- }
- const fullOptions = {};
- fullOptions.$term = value;
- for (const option in options) {
- switch (option) {
- case 'language':
- fullOptions.$language = options[option];
- break;
- case 'caseSensitive':
- fullOptions.$caseSensitive = options[option];
- break;
- case 'diacriticSensitive':
- fullOptions.$diacriticSensitive = options[option];
- break;
- default:
- throw new Error(`Unknown option: ${option}`);
- }
- }
- return this._addCondition(key, '$text', {
- $search: fullOptions
- });
- }
- /**
- * Method to sort the full text search by text score
- *
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- sortByTextScore() {
- this.ascending('$score');
- this.select(['$score']);
- return this;
- }
- /**
- * Adds a constraint for finding string values that start with a provided
- * string. This query will use the backend index, so it will be fast even
- * for large datasets.
- *
- * @param {string} key The key that the string to match is stored in.
- * @param {string} prefix The substring that the value must start with.
- * @param {string} modifiers The regular expression mode.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- startsWith(key, prefix, modifiers) {
- if (typeof prefix !== 'string') {
- throw new Error('The value being searched for must be a string.');
- }
- return this.matches(key, this._regexStartWith(prefix), modifiers);
- }
- /**
- * Adds a constraint for finding string values that end with a provided
- * string. This will be slow for large datasets.
- *
- * @param {string} key The key that the string to match is stored in.
- * @param {string} suffix The substring that the value must end with.
- * @param {string} modifiers The regular expression mode.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- endsWith(key, suffix, modifiers) {
- if (typeof suffix !== 'string') {
- throw new Error('The value being searched for must be a string.');
- }
- return this.matches(key, quote(suffix) + '$', modifiers);
- }
- /**
- * Adds a proximity based constraint for finding objects with key point
- * values near the point given.
- *
- * @param {string} key The key that the Parse.GeoPoint is stored in.
- * @param {Parse.GeoPoint} point The reference Parse.GeoPoint that is used.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- near(key, point) {
- if (!(point instanceof _ParseGeoPoint.default)) {
- // Try to cast it as a GeoPoint
- point = new _ParseGeoPoint.default(point);
- }
- return this._addCondition(key, '$nearSphere', point);
- }
- /**
- * Adds a proximity based constraint for finding objects with key point
- * values near the point given and within the maximum distance given.
- *
- * @param {string} key The key that the Parse.GeoPoint is stored in.
- * @param {Parse.GeoPoint} point The reference Parse.GeoPoint that is used.
- * @param {number} maxDistance Maximum distance (in radians) of results to return.
- * @param {boolean} sorted A Bool value that is true if results should be
- * sorted by distance ascending, false is no sorting is required,
- * defaults to true.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- withinRadians(key, point, maxDistance, sorted) {
- if (sorted || sorted === undefined) {
- this.near(key, point);
- return this._addCondition(key, '$maxDistance', maxDistance);
- } else {
- return this._addCondition(key, '$geoWithin', {
- $centerSphere: [[point.longitude, point.latitude], maxDistance]
- });
- }
- }
- /**
- * Adds a proximity based constraint for finding objects with key point
- * values near the point given and within the maximum distance given.
- * Radius of earth used is 3958.8 miles.
- *
- * @param {string} key The key that the Parse.GeoPoint is stored in.
- * @param {Parse.GeoPoint} point The reference Parse.GeoPoint that is used.
- * @param {number} maxDistance Maximum distance (in miles) of results to return.
- * @param {boolean} sorted A Bool value that is true if results should be
- * sorted by distance ascending, false is no sorting is required,
- * defaults to true.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- withinMiles(key, point, maxDistance, sorted) {
- return this.withinRadians(key, point, maxDistance / 3958.8, sorted);
- }
- /**
- * Adds a proximity based constraint for finding objects with key point
- * values near the point given and within the maximum distance given.
- * Radius of earth used is 6371.0 kilometers.
- *
- * @param {string} key The key that the Parse.GeoPoint is stored in.
- * @param {Parse.GeoPoint} point The reference Parse.GeoPoint that is used.
- * @param {number} maxDistance Maximum distance (in kilometers) of results to return.
- * @param {boolean} sorted A Bool value that is true if results should be
- * sorted by distance ascending, false is no sorting is required,
- * defaults to true.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- withinKilometers(key, point, maxDistance, sorted) {
- return this.withinRadians(key, point, maxDistance / 6371.0, sorted);
- }
- /**
- * Adds a constraint to the query that requires a particular key's
- * coordinates be contained within a given rectangular geographic bounding
- * box.
- *
- * @param {string} key The key to be constrained.
- * @param {Parse.GeoPoint} southwest
- * The lower-left inclusive corner of the box.
- * @param {Parse.GeoPoint} northeast
- * The upper-right inclusive corner of the box.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- withinGeoBox(key, southwest, northeast) {
- if (!(southwest instanceof _ParseGeoPoint.default)) {
- southwest = new _ParseGeoPoint.default(southwest);
- }
- if (!(northeast instanceof _ParseGeoPoint.default)) {
- northeast = new _ParseGeoPoint.default(northeast);
- }
- this._addCondition(key, '$within', {
- $box: [southwest, northeast]
- });
- return this;
- }
- /**
- * Adds a constraint to the query that requires a particular key's
- * coordinates be contained within and on the bounds of a given polygon.
- * Supports closed and open (last point is connected to first) paths
- *
- * Polygon must have at least 3 points
- *
- * @param {string} key The key to be constrained.
- * @param {Array} points Array of Coordinates / GeoPoints
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- withinPolygon(key, points) {
- return this._addCondition(key, '$geoWithin', {
- $polygon: points
- });
- }
- /**
- * Add a constraint to the query that requires a particular key's
- * coordinates that contains a ParseGeoPoint
- *
- * @param {string} key The key to be constrained.
- * @param {Parse.GeoPoint} point
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- polygonContains(key, point) {
- return this._addCondition(key, '$geoIntersects', {
- $point: point
- });
- }
- /* Query Orderings */
- /**
- * Sorts the results in ascending order by the given key.
- *
- * @param {(string|string[])} keys The key to order by, which is a
- * string of comma separated values, or an Array of keys, or multiple keys.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- ascending(...keys) {
- this._order = [];
- return this.addAscending.apply(this, keys);
- }
- /**
- * Sorts the results in ascending order by the given key,
- * but can also add secondary sort descriptors without overwriting _order.
- *
- * @param {(string|string[])} keys The key to order by, which is a
- * string of comma separated values, or an Array of keys, or multiple keys.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- addAscending(...keys) {
- if (!this._order) {
- this._order = [];
- }
- keys.forEach(key => {
- if (Array.isArray(key)) {
- key = key.join();
- }
- this._order = this._order.concat(key.replace(/\s/g, '').split(','));
- });
- return this;
- }
- /**
- * Sorts the results in descending order by the given key.
- *
- * @param {(string|string[])} keys The key to order by, which is a
- * string of comma separated values, or an Array of keys, or multiple keys.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- descending(...keys) {
- this._order = [];
- return this.addDescending.apply(this, keys);
- }
- /**
- * Sorts the results in descending order by the given key,
- * but can also add secondary sort descriptors without overwriting _order.
- *
- * @param {(string|string[])} keys The key to order by, which is a
- * string of comma separated values, or an Array of keys, or multiple keys.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- addDescending(...keys) {
- if (!this._order) {
- this._order = [];
- }
- keys.forEach(key => {
- if (Array.isArray(key)) {
- key = key.join();
- }
- this._order = this._order.concat(key.replace(/\s/g, '').split(',').map(k => {
- return '-' + k;
- }));
- });
- return this;
- }
- /* Query Options */
- /**
- * Sets the number of results to skip before returning any results.
- * This is useful for pagination.
- * Default is to skip zero results.
- *
- * @param {number} n the number of results to skip.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- skip(n) {
- if (typeof n !== 'number' || n < 0) {
- throw new Error('You can only skip by a positive number');
- }
- this._skip = n;
- return this;
- }
- /**
- * Sets the limit of the number of results to return. The default limit is 100.
- *
- * @param {number} n the number of results to limit to.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- limit(n) {
- if (typeof n !== 'number') {
- throw new Error('You can only set the limit to a numeric value');
- }
- this._limit = n;
- return this;
- }
- /**
- * Sets the flag to include with response the total number of objects satisfying this query,
- * despite limits/skip. Might be useful for pagination.
- * Note that result of this query will be wrapped as an object with
- * `results`: holding {ParseObject} array and `count`: integer holding total number
- *
- * @param {boolean} includeCount false - disable, true - enable.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- withCount(includeCount = true) {
- if (typeof includeCount !== 'boolean') {
- throw new Error('You can only set withCount to a boolean value');
- }
- this._count = includeCount;
- return this;
- }
- /**
- * Includes nested Parse.Objects for the provided key. You can use dot
- * notation to specify which fields in the included object are also fetched.
- *
- * You can include all nested Parse.Objects by passing in '*'.
- * Requires Parse Server 3.0.0+
- * <pre>query.include('*');</pre>
- *
- * @param {...string|Array<string>} keys The name(s) of the key(s) to include.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- include(...keys) {
- keys.forEach(key => {
- if (Array.isArray(key)) {
- this._include = this._include.concat(key);
- } else {
- this._include.push(key);
- }
- });
- return this;
- }
- /**
- * Includes all nested Parse.Objects one level deep.
- *
- * Requires Parse Server 3.0.0+
- *
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- includeAll() {
- return this.include('*');
- }
- /**
- * Restricts the fields of the returned Parse.Objects to include only the
- * provided keys. If this is called multiple times, then all of the keys
- * specified in each of the calls will be included.
- *
- * @param {...string|Array<string>} keys The name(s) of the key(s) to include.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- select(...keys) {
- if (!this._select) {
- this._select = [];
- }
- keys.forEach(key => {
- if (Array.isArray(key)) {
- this._select = this._select.concat(key);
- } else {
- this._select.push(key);
- }
- });
- return this;
- }
- /**
- * Restricts the fields of the returned Parse.Objects to all keys except the
- * provided keys. Exclude takes precedence over select and include.
- *
- * Requires Parse Server 3.6.0+
- *
- * @param {...string|Array<string>} keys The name(s) of the key(s) to exclude.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- exclude(...keys) {
- keys.forEach(key => {
- if (Array.isArray(key)) {
- this._exclude = this._exclude.concat(key);
- } else {
- this._exclude.push(key);
- }
- });
- return this;
- }
- /**
- * Restricts live query to trigger only for watched fields.
- *
- * Requires Parse Server 6.0.0+
- *
- * @param {...string|Array<string>} keys The name(s) of the key(s) to watch.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- watch(...keys) {
- keys.forEach(key => {
- if (Array.isArray(key)) {
- this._watch = this._watch.concat(key);
- } else {
- this._watch.push(key);
- }
- });
- return this;
- }
- /**
- * Changes the read preference that the backend will use when performing the query to the database.
- *
- * @param {string} readPreference The read preference for the main query.
- * @param {string} includeReadPreference The read preference for the queries to include pointers.
- * @param {string} subqueryReadPreference The read preference for the sub queries.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- readPreference(readPreference, includeReadPreference, subqueryReadPreference) {
- this._readPreference = readPreference;
- this._includeReadPreference = includeReadPreference || null;
- this._subqueryReadPreference = subqueryReadPreference || null;
- return this;
- }
- /**
- * Subscribe this query to get liveQuery updates
- *
- * @param {string} sessionToken (optional) Defaults to the currentUser
- * @returns {Promise<LiveQuerySubscription>} Returns the liveQuerySubscription, it's an event emitter
- * which can be used to get liveQuery updates.
- */
- async subscribe(sessionToken) {
- const currentUser = await _CoreManager.default.getUserController().currentUserAsync();
- if (!sessionToken) {
- sessionToken = currentUser ? currentUser.getSessionToken() || undefined : undefined;
- }
- const liveQueryClient = await _CoreManager.default.getLiveQueryController().getDefaultLiveQueryClient();
- if (liveQueryClient.shouldOpen()) {
- liveQueryClient.open();
- }
- const subscription = liveQueryClient.subscribe(this, sessionToken);
- return subscription.subscribePromise.then(() => {
- return subscription;
- });
- }
- /**
- * Constructs a Parse.Query that is the OR of the passed in queries. For
- * example:
- * <pre>var compoundQuery = Parse.Query.or(query1, query2, query3);</pre>
- *
- * will create a compoundQuery that is an or of the query1, query2, and
- * query3.
- *
- * @param {...Parse.Query} queries The list of queries to OR.
- * @static
- * @returns {Parse.Query} The query that is the OR of the passed in queries.
- */
- static or(...queries) {
- const className = _getClassNameFromQueries(queries);
- const query = new ParseQuery(className);
- query._orQuery(queries);
- return query;
- }
- /**
- * Constructs a Parse.Query that is the AND of the passed in queries. For
- * example:
- * <pre>var compoundQuery = Parse.Query.and(query1, query2, query3);</pre>
- *
- * will create a compoundQuery that is an and of the query1, query2, and
- * query3.
- *
- * @param {...Parse.Query} queries The list of queries to AND.
- * @static
- * @returns {Parse.Query} The query that is the AND of the passed in queries.
- */
- static and(...queries) {
- const className = _getClassNameFromQueries(queries);
- const query = new ParseQuery(className);
- query._andQuery(queries);
- return query;
- }
- /**
- * Constructs a Parse.Query that is the NOR of the passed in queries. For
- * example:
- * <pre>const compoundQuery = Parse.Query.nor(query1, query2, query3);</pre>
- *
- * will create a compoundQuery that is a nor of the query1, query2, and
- * query3.
- *
- * @param {...Parse.Query} queries The list of queries to NOR.
- * @static
- * @returns {Parse.Query} The query that is the NOR of the passed in queries.
- */
- static nor(...queries) {
- const className = _getClassNameFromQueries(queries);
- const query = new ParseQuery(className);
- query._norQuery(queries);
- return query;
- }
- /**
- * Change the source of this query to the server.
- *
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- fromNetwork() {
- this._queriesLocalDatastore = false;
- this._localDatastorePinName = null;
- return this;
- }
- /**
- * Changes the source of this query to all pinned objects.
- *
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- fromLocalDatastore() {
- return this.fromPinWithName(null);
- }
- /**
- * Changes the source of this query to the default group of pinned objects.
- *
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- fromPin() {
- return this.fromPinWithName(_LocalDatastoreUtils.DEFAULT_PIN);
- }
- /**
- * Changes the source of this query to a specific group of pinned objects.
- *
- * @param {string} name The name of query source.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- fromPinWithName(name) {
- const localDatastore = _CoreManager.default.getLocalDatastore();
- if (localDatastore.checkIfEnabled()) {
- this._queriesLocalDatastore = true;
- this._localDatastorePinName = name;
- }
- return this;
- }
- /**
- * Cancels the current network request (if any is running).
- *
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- cancel() {
- if (this._xhrRequest.task && typeof this._xhrRequest.task.abort === 'function') {
- this._xhrRequest.task._aborted = true;
- this._xhrRequest.task.abort();
- this._xhrRequest.task = null;
- this._xhrRequest.onchange = () => {};
- return this;
- }
- this._xhrRequest.onchange = () => this.cancel();
- return this;
- }
- _setRequestTask(options) {
- options.requestTask = task => {
- this._xhrRequest.task = task;
- this._xhrRequest.onchange();
- };
- }
- /**
- * Sets a comment to the query so that the query
- * can be identified when using a the profiler for MongoDB.
- *
- * @param {string} value a comment can make your profile data easier to interpret and trace.
- * @returns {Parse.Query} Returns the query, so you can chain this call.
- */
- comment(value) {
- if (value == null) {
- delete this._comment;
- return this;
- }
- if (typeof value !== 'string') {
- throw new Error('The value of a comment to be sent with this query must be a string.');
- }
- this._comment = value;
- return this;
- }
- }
- const DefaultController = {
- find(className, params, options) {
- const RESTController = _CoreManager.default.getRESTController();
- return RESTController.request('GET', 'classes/' + className, params, options);
- },
- aggregate(className, params, options) {
- const RESTController = _CoreManager.default.getRESTController();
- return RESTController.request('GET', 'aggregate/' + className, params, options);
- }
- };
- _CoreManager.default.setParseQuery(ParseQuery);
- _CoreManager.default.setQueryController(DefaultController);
- var _default = exports.default = ParseQuery;
|