redoc/lib/utils/JsonPointer.ts
2016-06-12 20:44:34 +03:00

79 lines
2.1 KiB
TypeScript

'use strict';
import JsonPointerLib from 'json-pointer';
const origParse = JsonPointerLib.parse;
/**
* Wrapper for JsonPointer. Provides common operations
*/
export class JsonPointer {
/**
* returns last JsonPointer token
* if level > 1 returns levels last (second last/third last)
* @example
* // returns subpath
* JsonPointerHelper.baseName('/path/0/subpath')
* // returns foo
* JsonPointerHelper.baseName('/path/foo/subpath', 2)
*/
static baseName(pointer, level=1) {
let tokens = JsonPointer.parse(pointer);
return tokens[tokens.length - (level)];
}
/**
* returns dirname of pointer
* if level > 1 returns corresponding dirname in the hierarchy
* @example
* // returns /path/0
* JsonPointerHelper.dirName('/path/0/subpath')
* // returns /path
* JsonPointerHelper.dirName('/path/foo/subpath', 2)
*/
static dirName(pointer, level=1) {
let tokens = JsonPointer.parse(pointer);
return JsonPointerLib.compile(tokens.slice(0, tokens.length - level));
}
/**
* overridden JsonPointer original parse to take care of prefixing '#' symbol
* that is not valid JsonPointer
*/
static parse(pointer) {
let ptr = pointer;
if (ptr.charAt(0) === '#') {
ptr = ptr.substring(1);
}
return origParse(ptr);
}
/**
* Creates a JSON pointer path, by joining one or more tokens to a base path.
*
* @param {string} base - The base path
* @param {string|string[]} tokens - The token(s) to append (e.g. ["name", "first"])
* @returns {string}
*/
static join(base, tokens) {
// TODO: optimize
let baseTokens = JsonPointer.parse(base);
let resTokens = baseTokens.concat(tokens);
return JsonPointerLib.compile(resTokens);
}
static get(object: Object, pointer:string) {
return JsonPointerLib.get(object, pointer);
}
static compile(tokens: string[]) {
return JsonPointerLib.compile(tokens);
}
static escape(pointer: string) {
return JsonPointerLib.escape(pointer);
}
}
JsonPointerLib.parse = JsonPointer.parse;
Object.assign(JsonPointer, JsonPointerLib);
export default JsonPointer;