2024-10-17 21:31:23 +03:00

233 lines
5.4 KiB
JavaScript

'use strict';
var each = require('foreach');
module.exports = api;
/**
* Convenience wrapper around the api.
* Calls `.get` when called with an `object` and a `pointer`.
* Calls `.set` when also called with `value`.
* If only supplied `object`, returns a partially applied function, mapped to the object.
*
* @param {Object} obj
* @param {String|Array} pointer
* @param value
* @returns {*}
*/
function api (obj, pointer, value) {
// .set()
if (arguments.length === 3) {
return api.set(obj, pointer, value);
}
// .get()
if (arguments.length === 2) {
return api.get(obj, pointer);
}
// Return a partially applied function on `obj`.
var wrapped = api.bind(api, obj);
// Support for oo style
for (var name in api) {
if (api.hasOwnProperty(name)) {
wrapped[name] = api[name].bind(wrapped, obj);
}
}
return wrapped;
}
/**
* Lookup a json pointer in an object
*
* @param {Object} obj
* @param {String|Array} pointer
* @returns {*}
*/
api.get = function get (obj, pointer) {
var refTokens = Array.isArray(pointer) ? pointer : api.parse(pointer);
for (var i = 0; i < refTokens.length; ++i) {
var tok = refTokens[i];
if (!(typeof obj == 'object' && tok in obj)) {
throw new Error('Invalid reference token: ' + tok);
}
obj = obj[tok];
}
return obj;
};
/**
* Sets a value on an object
*
* @param {Object} obj
* @param {String|Array} pointer
* @param value
*/
api.set = function set (obj, pointer, value) {
var refTokens = Array.isArray(pointer) ? pointer : api.parse(pointer),
nextTok = refTokens[0];
if (refTokens.length === 0) {
throw Error('Can not set the root object');
}
for (var i = 0; i < refTokens.length - 1; ++i) {
var tok = refTokens[i];
if (typeof tok !== 'string' && typeof tok !== 'number') {
tok = String(tok)
}
if (tok === "__proto__" || tok === "constructor" || tok === "prototype") {
continue
}
if (tok === '-' && Array.isArray(obj)) {
tok = obj.length;
}
nextTok = refTokens[i + 1];
if (!(tok in obj)) {
if (nextTok.match(/^(\d+|-)$/)) {
obj[tok] = [];
} else {
obj[tok] = {};
}
}
obj = obj[tok];
}
if (nextTok === '-' && Array.isArray(obj)) {
nextTok = obj.length;
}
obj[nextTok] = value;
return this;
};
/**
* Removes an attribute
*
* @param {Object} obj
* @param {String|Array} pointer
*/
api.remove = function (obj, pointer) {
var refTokens = Array.isArray(pointer) ? pointer : api.parse(pointer);
var finalToken = refTokens[refTokens.length -1];
if (finalToken === undefined) {
throw new Error('Invalid JSON pointer for remove: "' + pointer + '"');
}
var parent = api.get(obj, refTokens.slice(0, -1));
if (Array.isArray(parent)) {
var index = +finalToken;
if (finalToken === '' && isNaN(index)) {
throw new Error('Invalid array index: "' + finalToken + '"');
}
Array.prototype.splice.call(parent, index, 1);
} else {
delete parent[finalToken];
}
};
/**
* Returns a (pointer -> value) dictionary for an object
*
* @param obj
* @param {function} descend
* @returns {}
*/
api.dict = function dict (obj, descend) {
var results = {};
api.walk(obj, function (value, pointer) {
results[pointer] = value;
}, descend);
return results;
};
/**
* Iterates over an object
* Iterator: function (value, pointer) {}
*
* @param obj
* @param {function} iterator
* @param {function} descend
*/
api.walk = function walk (obj, iterator, descend) {
var refTokens = [];
descend = descend || function (value) {
var type = Object.prototype.toString.call(value);
return type === '[object Object]' || type === '[object Array]';
};
(function next (cur) {
each(cur, function (value, key) {
refTokens.push(String(key));
if (descend(value)) {
next(value);
} else {
iterator(value, api.compile(refTokens));
}
refTokens.pop();
});
}(obj));
};
/**
* Tests if an object has a value for a json pointer
*
* @param obj
* @param pointer
* @returns {boolean}
*/
api.has = function has (obj, pointer) {
try {
api.get(obj, pointer);
} catch (e) {
return false;
}
return true;
};
/**
* Escapes a reference token
*
* @param str
* @returns {string}
*/
api.escape = function escape (str) {
return str.toString().replace(/~/g, '~0').replace(/\//g, '~1');
};
/**
* Unescapes a reference token
*
* @param str
* @returns {string}
*/
api.unescape = function unescape (str) {
return str.replace(/~1/g, '/').replace(/~0/g, '~');
};
/**
* Converts a json pointer into a array of reference tokens
*
* @param pointer
* @returns {Array}
*/
api.parse = function parse (pointer) {
if (pointer === '') { return []; }
if (pointer.charAt(0) !== '/') { throw new Error('Invalid JSON pointer: ' + pointer); }
return pointer.substring(1).split(/\//).map(api.unescape);
};
/**
* Builds a json pointer from a array of reference tokens
*
* @param refTokens
* @returns {string}
*/
api.compile = function compile (refTokens) {
if (refTokens.length === 0) { return ''; }
return '/' + refTokens.map(api.escape).join('/');
};