Skip to content

Path: Update buildCollectionItem helper #72

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vlaurin merged 1 commit into from
Jun 16, 2026
Merged

Path: Update buildCollectionItem helper #72

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions src/path/helpers.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,17 @@ export const build = (...parts) => parts.join(SEPARATOR);
*
* @param {string} collectionPath - Path to the collection
* @param {number | string} item - Index or ID of the item; undefined if item is not relevant (e.g. definition path)
* @returns {string} Path to the item
* @param {boolean} targetValue - Whether to target the item value or the item root, defaults to `true` for backward compatibility
* @returns {string} Path to the item root or value
*/
export const buildCollectionItem = (collectionPath, item) => {
return build(`${collectionPath}[${Number.isInteger(item) ? item : item ? 'id:' + item : ''}]`, 'value');
export const buildCollectionItem = (collectionPath, item, targetValue = true) => {
const itemPath = `${collectionPath}[${Number.isInteger(item) ? item : item ? 'id:' + item : ''}]`;

if (targetValue) {
return build(itemPath, 'value');
}

return itemPath;
};

/**
Expand Down
18 changes: 17 additions & 1 deletion src/path/helpers.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,25 @@ describe('buildCollectionItem', () => {
{collection: '$.collection', item: 'some-id', expected: '$.collection[id:some-id].value'},
{collection: '$.complex.collection', item: 'some-id', expected: '$.complex.collection[id:some-id].value'},
{collection: '$.complex.collection', item: undefined, expected: '$.complex.collection[].value'},
])('should build path: $expected', ({collection, item, expected}) => {
])('should build path to item value: $expected', ({collection, item, expected}) => {
expect(buildCollectionItem(collection, item)).toBe(expected);
});

test.each([
{collection: 'collection', item: 0, expected: 'collection[0]'},
{collection: '$.collection', item: 0, expected: '$.collection[0]'},
{collection: 'collection', item: '0', expected: 'collection[id:0]'},
{collection: '$.collection', item: '0', expected: '$.collection[id:0]'},
{collection: '$.collection', item: undefined, expected: '$.collection[]'},
{collection: '$.collection', item: null, expected: '$.collection[]'},
{collection: '$.complex.collection', item: '0', expected: '$.complex.collection[id:0]'},
{collection: 'collection', item: 'some-id', expected: 'collection[id:some-id]'},
{collection: '$.collection', item: 'some-id', expected: '$.collection[id:some-id]'},
{collection: '$.complex.collection', item: 'some-id', expected: '$.complex.collection[id:some-id]'},
{collection: '$.complex.collection', item: undefined, expected: '$.complex.collection[]'},
])('should build path to item root: $expected', ({collection, item, expected}) => {
expect(buildCollectionItem(collection, item, false)).toBe(expected);
});
});

describe('relative', () => {
Expand Down