Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 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 | 22x 22x 160x 160x 160x 85x 15x 163x 163x 1x 1x 163x 164x 164x 164x 164x 492x 6x 164x 4x 160x 1x 1x 2x 2x 85x 1x 1x 5x 5x 9x 12x 11x 3x 6x 8x 211x 84x 211x 2x 1x 1x 1x 2x 22x | "use strict";
const _ = require("lodash");
const RequestDefinition = require("./RequestDefinition");
/**
* Base object of the OData resources
*
* @class Resource
*/
class Resource {
/**
* Creates an instance of <code>Resource</code>.
* @param {Agent} agent instance of the Agent class @see Agent.js
* @param {Object} defaults default parameters for the resource, based on the class
* @memberof Resource
*/
constructor(agent, defaults = {}) {
var normalizedDefaults = this.checkDefaults(
this.normalizeDefaults(defaults)
);
Object.defineProperty(this, "agent", {
value: agent,
writable: false,
});
Object.defineProperty(this, "_defaults", {
value: normalizedDefaults,
writable: false,
});
}
/**
* Gets new instance of default values.
*
* @returns {object} new default values instance
*
* @memberof Resource
* @protected
*/
getDefaults() {
return _.cloneDeep(this._defaults);
}
/**
* Resets current default request.
*
* @memberof Resource
* @protected
*/
reset() {
this._requestDefinition = undefined;
}
/**
* Normalize default parameters to adding mandatory properties
*
* @param {Object} defaults which need to be normalized
*
* @returns {Object} normalized default parameters
*
* @memberof Resource
*/
normalizeDefaults(defaults) {
let defaultsCopy = _.cloneDeep(defaults);
if (defaultsCopy.hasOwnProperty("raw")) {
defaultsCopy._isRaw = defaultsCopy.raw;
delete defaultsCopy.raw;
}
return _.assign(
{
_headers: {},
_isRaw: false,
_query: {},
},
defaultsCopy
);
}
/**
* Check default parameters used by the Resource class
*
* @param {Object} defaults which need to be checked
*
* @returns {Object} default parameteres for chaining
*
* @memberof Resource
*/
checkDefaults(defaults) {
let errors = _.chain([
{
test: () => {
return !_.isPlainObject(_.get(defaults, "_query"));
},
message: "The default parameter query is not plain object.",
},
{
test: () => {
return !_.isPlainObject(_.get(defaults, "_headers"));
},
message: "The default parameter headers is not plain object.",
},
{
test: () => {
return !_.isBoolean(_.get(defaults, "_isRaw"));
},
message: "The default raw parameter is not Boolean.",
},
])
.filter((check) => check.test())
.map((check) => check.message)
.value();
if (errors.length > 0) {
throw new Error(errors.join("\n"));
}
return defaults;
}
// see RequestDefinition.parameter
parameter(parameterName, parameterValue) {
this.defaultRequest.parameter(parameterName, parameterValue);
return this;
}
// see RequestDefinition.parameters
parameters(parameters) {
this.defaultRequest.parameters(parameters);
return this;
}
/**
* Create new request definnition object for this entity.
*
* @returns {RequestDefinition} request definition
* @memberof QueryableResource
*/
request() {
return new RequestDefinition(this, this.getDefaults());
}
/**
* Set additional header for the OData request to the resource
*
* @param {String} key name of the header
* @param {String} value value of the header
*
* @return {Resource} itself for the chaining
*
* @memberof Resource
*/
header(key, value) {
this.defaultRequest.header(key, value);
return this;
}
/**
* After the call of the method the superagent response is resolved instead
* of the plain objects
*
* @return {Resource} itself for the chaining
*
* @memberof Resource
*/
raw() {
this.defaultRequest.raw();
return this;
}
/**
* Get query parameter from the entity set query structure.
*
* @param {String} name name of the parameter
*
* @return {String} current value of the query parameter
*
* @memberof Resource
*/
getQueryParameter(name) {
return this.defaultRequest.getQueryParameter(name);
}
/**
* Set query parameter to the get entity set list request
* You can use the function instead of the specific methods
* like search or top, but you have to follow the OData protocol.
* @see https://www.odata.org/getting-started/basic-tutorial/
* Particular function like top or search contains additionals
* value checks, but queryParameter just pass value to the
*
* @param {String} name name of the parameter
* @param {Any} [value] parameter value is optional, if it is
*
* @return {Resource} itself for the chaining
*
* @memberof Resource
*/
setQueryParameter(name, value) {
this.defaultRequest.setQueryParameter(name, value);
return this;
}
/**
* Set query parameter to the get entity set list request.
*
* @alias setQueryParameter
*
* @param {String} name name of the parameter
* @param {Any} [value] parameter value is optional, if it is
*
* @return {Resource} itself for the chaining
*
* @memberof Resource
*/
queryParameter() {
return this.setQueryParameter.apply(this, arguments);
}
/**
* Convert query defined by queryParameter method to query part of URL
*
* @param {Object} defaultQueryParameters the default parameters which is replaced by this.defaultRequest.query
*
* @return {String} query part of the url based on the this.defaultRequest.query and defaultQueryParameters
*
* @memberof Resource
*/
urlQuery(defaultQueryParameters = {}) {
return _.chain(
_.assign({}, defaultQueryParameters, this.defaultRequest._query)
)
.map((value, key) => {
return `${key}=${value}`;
})
.sortBy()
.join("&")
.value();
}
/**
* Gets (persistent) OData request definition for this entity set.
*
* @readonly
* @private
*
* @returns {RequestDefinition} Request definition for this entity set
*
* @memberof Resource
*/
get defaultRequest() {
if (!this._requestDefinition) {
this._requestDefinition = this.request();
}
return this._requestDefinition;
}
/**
* Wraps batch requeswt createion
*
* @param {function} call main call to batch
* @param {Batch} batchObject destination fo the request defined by call patameter
* @returns {Promise} promise which resolved when request is received from backend
*
* @private
* @memberof QueryableResource
*/
_handleBatchCall(call, batchObject) {
let promise;
if (batchObject && this.agent.batchManager.has(batchObject)) {
promise = call().promise;
this.reset();
} else {
promise = Promise.reject(
new Error("Batch object is not registered in batch manager.")
);
}
return promise;
}
}
module.exports = Resource;
|