All files / lib/stack query.js

100% Statements 112/112
100% Branches 86/86
100% Functions 27/27
100% Lines 111/111
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465      3x   70x 37x 32x 32x 32x   5x         28x 28x 14x 12x 12x 12x 12x   2x         28x 7x 6x 6x 6x   1x         28x 17x 17x 18x 4x 14x 12x     17x 1x   16x   17x       56x 28x 24x 24x   4x         28x 14x 12x 12x   2x                                       14x 14x 14x 14x                 14x                   14x                 14x                   14x                   14x                   14x                   14x                 14x                 14x                 14x                 14x                   14x                   14x                 14x                 14x                                   14x                                   14x                       7x 6x   6x   1x         9x 8x 8x   1x                     2x 2x 2x 2x                   7x 6x 6x   1x                       7x 6x 6x   1x                     6x 6x                   7x 6x 6x   1x                       15x                                   8x 7x     7x 7x   1x                       7x 6x 6x   1x                     3x 3x 3x                     4x 4x 4x 4x 4x           9x 1x 8x       1x  
import * as Utils from './utils.js';
import Entry from './entry';
 
const _extend = {
    compare: function(type) {
        return function(key, value) {
            if (key && value && typeof key === 'string' && typeof value !== 'undefined') {
                this._query['query'][key] = this._query['query']['file_size'] || {};
                this._query['query'][key][type] = value;
                return this;
            } else {
                throw Error("Kindly provide valid parameters.");
            }
        };
    },
    contained: function(bool) {
        let type = (bool) ? '$in' : '$nin';
        return function(key, value) {
            if (key && value && typeof key === 'string' && Array.isArray(value)) {
                this._query['query'][key] = this._query['query'][key] || {};
                this._query['query'][key][type] = this._query['query'][key][type] || [];
                this._query['query'][key][type] = this._query['query'][key][type].concat(value);
                return this;
            } else {
                throw Error("Kindly provide valid parameters.");
            }
        };
    },
    exists: function(bool) {
        return function(key) {
            if (key && typeof key === 'string') {
                this._query['query'][key] = this._query['query'][key] || {};
                this._query['query'][key]['$exists'] = bool;
                return this;
            } else {
                throw Error("Kindly provide valid parameters.");
            }
        };
    },
    logical: function(type) {
        return function() {
            let _query = [];
            for (let i = 0, _i = arguments.length; i < _i; i++) {
                if (arguments[i] instanceof Query && arguments[i]._query.query) {
                    _query.push(arguments[i]._query.query);
                } else if (typeof arguments[i] === "object") {
                    _query.push(arguments[i]);
                }
            }
            if (this._query['query'][type]) {
                this._query['query'][type] = this._query['query'][type].concat(_query);
            } else {
                this._query['query'][type] = _query;
            }
            return this;
        };
    },
    sort: function(type) {
        return function(key) {
            if (key && typeof key === 'string') {
                this._query[type] = key;
                return this;
            } else {
                throw Error("Argument should be a string.");
            }
        };
    },
    pagination: function(type) {
        return function(value) {
            if (typeof value === 'number') {
                this._query[type] = value;
                return this;
            } else {
                throw Error("Argument should be a number.");
            }
        }
    }
};
 
/**
 * @summary
 * Creates an instance of `Query`.
 * @description
 * An initializer is responsible for creating Query object.
 * @example
 * <caption>Query instance creation.</caption>
 * let Query = Contentstack.Stack().ContentType('example').Query();
 * let assetQuery =  Contentstack.Stack().Assets().Query();
 * @ignore
 */
export default class Query extends Entry {
 
    constructor(connection) {
        super();
        this._connection = connection;
        this._query = this._query;
        this._query['query'] = this._query['query'] || {};
        /**
         * @method lessThan
         * @description This method provides only the entries with values less than the specified value for a field.
         * @param {String} key - uid of the field that is to be taken into consideration
         * @param {*} value - The value used to match or compare
         * @example blogQuery.lessThan('created_at','2015-06-22')
         * @returns {Query}
         */
        this.lessThan = _extend.compare('$lt');
 
        /**
         * @method lessThanOrEqualTo
         * @description This method provides only the entries with values less than or equal to the specified value for a field.
         * @param {String} key - uid of the field that is to be taken into consideration
         * @param {*} value - The value used to match or compare
         * @example blogQuery.lessThanOrEqualTo('created_at','2015-03-12')
         * @returns {Query}
         */
        this.lessThanOrEqualTo = _extend.compare('$lte');
        /**
         * @method greaterThan
         * @description This method provides only the entries with values greater than the specified value for a field.
         * @param {String} key - uid of the field that is to be taken into consideration
         * @param {*} value - The value used to match or compare
         * @example blogQuery.greaterThan('created_at','2015-03-12')
         * @returns {Query}
         */
        this.greaterThan = _extend.compare('$gt');
 
        /**
         * @method greaterThanOrEqualTo
         * @description This method provides only the entries with values greater than or equal to the specified value for a field.
         * @param {String} key - uid of the field that is to be taken into consideration
         * @param {*} value - The value used to match or compare
         * @example blogQuery.greaterThanOrEqualTo('created_at', '2015-06-22')
         * @returns {Query}
         */
        this.greaterThanOrEqualTo = _extend.compare('$gte');
 
        /**
         * @method notEqualTo
         * @description This method provides only the entries with values not equal to the specified value for a field.
         * @param {String} key - uid of the field that is to be taken into consideration
         * @param {*} value - The value used to match or compare
         * @example blogQuery.notEqualTo('title','Demo')
         * @returns {Query}
         */
        this.notEqualTo = _extend.compare('$ne');
 
        /**
         * @method containedIn
         * @description This method provides only the entries with values matching the specified values for a field.
         * @param {String} key - uid of the field that is to be taken into consideration
         * @param {*} value - An array of values that are to be used to match or compare
         * @example blogQuery.containedIn('title', ['Demo', 'Welcome'])
         * @returns {Query}
         */
        this.containedIn = _extend.contained(true);
 
        /**
         * @method notContainedIn
         * @description This method provides only the entries that do not contain values matching the specified values for a field.
         * @param {String} key - uid of the field that is to be taken into consideration
         * @param {Array} value - An array of values that are to be used to match or compare
         * @example blogQuery.notContainedIn('title', ['Demo', 'Welcome'])
         * @returns {Query}
         */
        this.notContainedIn = _extend.contained(false);
 
        /**
         * @method exists
         * @description This method provides only the entries that contains the field matching the specified field uid.
         * @param {String} key - uid of the field that is to be taken into consideration
         * @example blogQuery.exists('featured')
         * @returns {Query}
         */
        this.exists = _extend.exists(true);
 
        /**
         * @method notExists
         * @description This method provides only the entries that do not contain the field matching the specified field uid.
         * @param {String} key - uid of the field that is to be taken into consideration
         * @example blogQuery.notExists('featured')
         * @returns {Query}
         */
        this.notExists = _extend.exists(false);
 
        /**
         * @method ascending
         * @description This parameter sorts the provided entries in the ascending order on the basis of the specified field.
         * @param {String} key - field uid based on which the ordering should be done
         * @example blogQuery.ascending('created_at')
         * @returns {Query}
         */
        this.ascending = _extend.sort('asc');
 
        /**
         * @method descending
         * @description This method sorts the provided entries in the descending order on the basis of the specified field.
         * @param {String} key - field uid based on which the ordering should be done.
         * @example blogQuery.descending('created_at')
         * @returns {Query}
         */
        this.descending = _extend.sort('desc');
 
        /**
         * @method beforeUid
         * @description This method provides only the entries before the specified entry id.
         * @param {String} uid - uid of the entry
         * @example blogQuery.beforeUid('blt1234567890abcdef')
         * @returns {Query}
         * @ignore
         */
        this.beforeUid = _extend.sort('before_uid');
 
        /**
         * @method afterUid
         * @description This method provides only the entries after the specified entry id.
         * @param {String} uid - uid of the entry
         * @example blogQuery.afterUid('blt1234567890abcdef')
         * @returns {Query}
         * @ignore
         */
        this.afterUid = _extend.sort('after_uid');
 
        /**
         * @method skip
         * @description This method skips the specified number of entries.
         * @param {Number} skip - number of entries to be skipped
         * @example blogQuery.skip(5)
         * @returns {Query}
         */
        this.skip = _extend.pagination('skip');
 
        /**
         * @method limit
         * @description This method limits the response by providing only the specified number of entries.
         * @param {Number} limit - number of entries to be present in the result(at most)
         * @example blogQuery.limit(10)
         * @returns {Query}
         */
        this.limit = _extend.pagination('limit');
 
        /**
         * @method or
         * @description This method performs the OR operation on the specified query objects and provides only the matching entries.
         * @param {object} queries - array of Query objects/raw queries to be taken into consideration
         * @example
         * <caption> .or with Query instances</caption>
         * let Query1 = Stack.ContentType('blog').Query().where('title', 'Demo')
         * let Query2 = Stack.ContentType('blog').Query().lessThan('comments', 10)
         * blogQuery.or(Query1, Query2)
         * @example
         * <caption> .or with raw queries</caption>
         * let Query1 = Stack.ContentType('blog').Query().where('title', 'Demo').getQuery()
         * let Query2 = Stack.ContentType('blog').Query().lessThan('comments', 10).getQuery()
         * blogQuery.or(Query1, Query2)
         * @returns {Query}
         */
        this.or = _extend.logical('$or');
 
        /**
         * @method and
         * @description This method performs the AND operation on the specified query objects and provides only the matching entries.
         * @param {object} queries - array of Query objects/raw queries to be taken into consideration
         * @example
         * <caption> .and with Query instances</caption>
         * let Query1 = Stack.ContentType('blog').Query().where('title', 'Demo')
         * let Query2 = Stack.ContentType('blog').Query().lessThan('comments', 10)
         * blogQuery.and(Query1, Query2)
         * @example
         * <caption> .and with raw queries</caption>
         * let Query1 = Stack.ContentType('blog').Query().where('title', 'Demo').getQuery()
         * let Query2 = Stack.ContentType('blog').Query().lessThan('comments', 10).getQuery()
         * blogQuery.and(Query1, Query2)
         * @returns {Query}
         */
        this.and = _extend.logical('$and');
    }
 
    /**
     * @method where(equalTo)
     * @description This method provides only the entries matching the specified value for a field.
     * @param {String} key - uid of the field that is to be taken into consideration
     * @param {*} value - The value used to match or compare
     * @example blogQuery.where('title','Demo')
     * @returns {Query}
     */
    equalTo(key, value) {
        if (key && typeof key === 'string') {
            this._query['query'][key] = value;
 
            return this;
        } else {
            throw Error("Kindly provide valid parameters.");
        }
    }
 
    where(key, value) {
        if (key && typeof key === 'string') {
            this._query['query'][key] = value;
            return this;
        } else {
            throw Error("Kindly provide valid parameters.");
        }
    }
 
    /**
     * @method count
     * @description This method provides only the number of entries matching the specified filters.
     * @example blogQuery.count()
     * @returns {Query}
     */
    count() {
        this._query['count'] = true;
        let options = {content_type_uid :this.content_type_uid , params:this._query};
        options.action =  (this.type && this.type === 'asset') ?  "getAssets" : "getEntries"
        return this._connection.sendToParent('stackQuery', options).then(onData).catch(onError);
    }
 
    /**
     * @method query
     * @description This method used to set raw queries on Query instance.
     * @param {object} query - raw{json} queries to filter the entries in result set.
     * @returns {Query}
     */
    query(query) {
        if (typeof query === "object") {
            this._query['query'] = Utils.mergeDeep(this._query['query'], query);
            return this;
        } else {
            throw Error("Kindly provide valid parameters");
        }
    }
 
    /**
     * @method tags
     * @description The "tags" parameter allows you to specify an array of tags to search objects.
     * @param {Array} values - tags
     * @example blogQuery.tags(['technology', 'business'])
     * @returns {Query}
     */
    tags(values) {
        if (Array.isArray(values)) {
            this._query['tags'] = values;
            return this;
        } else {
            throw Error("Kindly provide valid parameters");
        }
    }
 
    /**
     * @method includeCount
     * @description This method also includes the total number of entries returned in the response.
     * @example blogQuery.includeCount()
     * @returns {Query}
     */
    includeCount() {
        this._query['include_count'] = true;
        return this;
    }
 
    /**
     * @method AddParam
     * @description This method includes query parameter in query.
     * @example blogQuery.addParam('include_count', 'true')
     * @returns {Query}
     */
    addParam(key, value) {
        if (key && value && typeof key === 'string' && typeof value === 'string') {
                this._query[key] = value;
                return this;
        } else {
            throw Error("Kindly provide valid parameters.");
        }
    }
 
    /**
     * @method getQuery
     * @summary returns the raw query which can be used for futher calls(.and/.or).
     * @description This method provides raw{json} queries based on the filters applied on Query objet.
     * @example blogQuery.where('title','Demo').getQuery()
     * @returns {Query}
     */
    getQuery() {
        return this._query.query;
    }
 
    /**
     * @method regex
     * @description This method provides only the entries matching the regular expression for the specified field.
     * @param {String} key - Uid of the field that is to be taken into consideration
     * @param {*} value - The value used to match or compare
     * @param {String} [options] - match or compare value in entry
     * @example
     * <caption> .regex without options</caption>
     * blogQuery.regex('title','^Demo')
     * @example
     * <caption> .regex with options</caption>
     * blogQuery.regex('title','^Demo', 'i')
     * @returns {Query}
     */
    regex(key, value, options) {
        if (key && value && typeof key === 'string' && typeof value === 'string') {
            this._query['query'][key] = {
                $regex: value
            };
            if (options) this._query['query'][key]['$options'] = options;
            return this;
        } else {
            throw Error("Kindly provide valid parameters.");
        }
    }
 
    /**
     * @method search
     * @description This method is used to search data in entries.
     * @param {string} value - value to search in entries
     * @example blogQuery.search('Welcome to demo')
     * @returns {Query}
     */
    search(value) {
        if (value && typeof value === 'string') {
            this._query['typeahead'] = value;
            return this;
        } else {
            throw Error("Kindly provide valid parameters.");
        }
    }
 
    /**
     * @method find
     * @description Provides all the entries which satisfied the query specified.
     * @example
     * blogQuery.find()
     */
    find() {
        let options = {content_type_uid :this.content_type_uid , params:this._query};
    	options.action =  (this.type && this.type === 'asset') ?  "getAssets" : "getEntries"
        return this._connection.sendToParent('stackQuery', options).then(onData).catch(onError);
    }
 
    /**
     * @method findOne
     * @description Provides the single entry from the resultset.
     * @example
     * blogQuery.findOne()
     */
    findOne() {
 
    	this.singleEntry = true;
        this._query.limit = 1;
        let options = {content_type_uid :this.content_type_uid , params:this._query};
    	options.action =  (this.type && this.type === 'asset') ?  "getAssets" : "getEntries"
        return this._connection.sendToParent('stackQuery', options).then(onData).catch(onError);
    }
 
}
 
function onData(data) {
  if (typeof (data.data) === "string")
    return Promise.reject(data.data)
  return Promise.resolve(data.data)
}
 
function onError(error) {
  return Promise.reject(error)
}