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 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 44x 44x 44x 44x 44x 44x 44x 44x 44x 44x 7x 7x 37x 37x 37x 44x 1x 1x 1x 1x 1x 1x 28x 28x 28x 28x 28x 44x 15x 15x 15x 15x 15x 15x 15x 15x 28x 28x 28x 44x 5x 5x 44x 9x 9x 1x 1x 44x 12x 1x 1x 11x 14x 2x 2x 15x 15x 15x 15x 15x 44x 1x 1x 1x 1x 1x | /**
* @license Apache-2.0
*
* Copyright (c) 2026 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
'use strict';
// MODULES //
var isArray = require( '@stdlib/assert/is-array' );
var isPlainObject = require( '@stdlib/assert/is-plain-object' );
var hasOwnProp = require( '@stdlib/assert/has-own-property' );
var format = require( '@stdlib/string/format' );
var parse = require( '@stdlib/utils/json-pointer/parse' );
var isSafeToken = require( '@stdlib/utils/json-pointer/base/assert/is-safe-token' );
var resolveToken = require( '@stdlib/utils/json-pointer/base/resolve-token' );
// MAIN //
/**
* Resolves a JSON Pointer against a document and returns the target, key, and value.
*
* ## Notes
*
* - Implements resolution per RFC 6901.
* - An empty string pointer refers to the root of the document.
* - The `-` token on the last segment of a pointer targeting an array resolves to the array's length (i.e., past-the-end index).
* - Tokens `__proto__`, `constructor`, and `prototype` are rejected to prevent prototype pollution.
*
* @param {(Object|Array)} document - JSON document
* @param {string} pointer - JSON Pointer string
* @throws {TypeError} first argument must be an object or array
* @throws {TypeError} second argument must be a string
* @throws {Error} pointer must resolve to an existing location in the document
* @throws {Error} tokens must not be prototype pollution vectors
* @throws {RangeError} array index must be within bounds
* @returns {Object} result object
*
* @example
* var out = resolve( { 'foo': [ 'bar', 'baz' ] }, '/foo/0' );
* // returns { 'target': [ 'bar', 'baz' ], 'key': 0, 'value': 'bar' }
*
* @example
* var out = resolve( { 'foo': 'bar' }, '/foo' );
* // returns { 'target': { 'foo': 'bar' }, 'key': 'foo', 'value': 'bar' }
*
* @example
* var out = resolve( { 'foo': 'bar' }, '' );
* // returns { 'target': null, 'key': null, 'value': { 'foo': 'bar' } }
*/
function resolve( document, pointer ) {
var current;
var tokens;
var token;
var last;
var key;
var idx;
var i;
if ( !isPlainObject( document ) && !isArray( document ) ) {
throw new TypeError( format( 'invalid argument. First argument must be an object or an array. Value: `%s`.', document ) );
}
tokens = parse( pointer );
// An empty pointer refers to the root:
if ( tokens.length === 0 ) {
return {
'target': null,
'key': null,
'value': document
};
}
current = document;
last = tokens.length - 1;
// Traverse all tokens except the last to find the target:
for ( i = 0; i < last; i++ ) {
token = tokens[ i ];
if ( !isSafeToken( token ) ) {
throw new Error( format( 'invalid argument. Pointer contains an unsafe token. Value: `%s`.', token ) );
}
if ( isArray( current ) ) {
idx = resolveToken( current, token );
if ( idx >= current.length ) {
throw new RangeError( format( 'invalid argument. Array index out of bounds. Index: `%d`. Length: `%d`.', idx, current.length ) );
}
current = current[ idx ];
} else if ( isPlainObject( current ) ) {
if ( !hasOwnProp( current, token ) ) {
throw new Error( format( 'invalid argument. Pointer references a nonexistent property. Value: `%s`.', token ) );
}
current = current[ token ];
} else {
throw new TypeError( format( 'invalid argument. Pointer references a non-traversable value. Value: `%s`.', token ) );
}
}
// Handle the last token to determine the final key and value:
token = tokens[ last ];
if ( !isSafeToken( token ) ) {
throw new Error( format( 'invalid argument. Pointer contains an unsafe token. Value: `%s`.', token ) );
}
if ( isArray( current ) ) {
key = resolveToken( current, token );
if ( token !== '-' && key >= current.length ) {
throw new RangeError( format( 'invalid argument. Array index out of bounds. Index: `%d`. Length: `%d`.', key, current.length ) );
}
} else if ( isPlainObject( current ) ) {
if ( !hasOwnProp( current, token ) ) {
throw new Error( format( 'invalid argument. Pointer references a nonexistent property. Value: `%s`.', token ) );
}
key = token;
} else {
throw new TypeError( format( 'invalid argument. Pointer references a non-traversable value. Value: `%s`.', token ) );
}
return {
'target': current,
'key': key,
'value': current[ key ]
};
}
// EXPORTS //
module.exports = resolve;
|