Skip to content
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

feat(highlighting): support array syntax for nested attributes #418

Merged
merged 6 commits into from
Jan 29, 2021
Merged

feat(highlighting): support array syntax for nested attributes #418

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2d9c215
Implement Array syntax for highlighting attributes and fix `parseAlgo…
shortcuts Jan 28, 2021
612d188
Increase bundle size
shortcuts Jan 28, 2021
c880d2a
Add tests for attributes containing dots and improve warning description
shortcuts Jan 28, 2021
5357f19
Update documentation for `highligh` functions
shortcuts Jan 28, 2021
001b377
Update packages/website/docs/highlightHit.md
shortcuts Jan 28, 2021
7f9a2f6
Fix wording in docs
shortcuts Jan 29, 2021
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
6 changes: 3 additions & 3 deletions bundlesize.config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@
},
{
"path": "packages/autocomplete-js/dist/umd/index.production.js",
"maxSize": "13.5 kB"
"maxSize": "13.65 kB"
},
{
"path": "packages/autocomplete-preset-algolia/dist/umd/index.production.js",
"maxSize": "1.5 kB"
"maxSize": "1.75 kB"
},
{
"path": "packages/autocomplete-plugin-algolia-insights/dist/umd/index.production.js",
Expand All @@ -22,7 +22,7 @@
},
{
"path": "packages/autocomplete-plugin-query-suggestions/dist/umd/index.production.js",
"maxSize": "2.5 kB"
"maxSize": "2.8 kB"
}
]
}
2 changes: 1 addition & 1 deletion packages/autocomplete-js/src/highlight.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import { AutocompleteRenderer } from './types';

type HighlightItemParams<TItem> = {
hit: TItem;
attribute: keyof TItem;
attribute: keyof TItem | string[];
tagName?: string;
createElement?: AutocompleteRenderer['createElement'];
};
Expand Down
2 changes: 1 addition & 1 deletion packages/autocomplete-preset-algolia/src/highlight/ParseAlgoliaHitParams.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
export type ParseAlgoliaHitParams<TItem> = {
hit: TItem;
attribute: keyof TItem;
attribute: keyof TItem | string[];
};
204 changes: 185 additions & 19 deletions ...ages/autocomplete-preset-algolia/src/highlight/__tests__/parseAlgoliaHitHighlight.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,26 +25,104 @@ describe('parseAlgoliaHitHighlight', () => {
},
},
})
).toMatchInlineSnapshot(`
Array [
Object {
"isHighlighted": true,
"value": "He",
},
Object {
"isHighlighted": false,
"value": "llo t",
},
Object {
"isHighlighted": true,
"value": "he",
).toEqual([
{
isHighlighted: true,
value: 'He',
},
{
isHighlighted: false,
value: 'llo t',
},
{
isHighlighted: true,
value: 'he',
},
{
isHighlighted: false,
value: 're',
},
]);
});

test('returns the highlighted parts of the hit with an array attribute', () => {
expect(
parseAlgoliaHitHighlight({
attribute: ['title'],
hit: {
objectID: '1',
title: 'Hello there',
_highlightResult: {
title: {
value:
'__aa-highlight__He__/aa-highlight__llo t__aa-highlight__he__/aa-highlight__re',
matchLevel: 'partial',
matchedWords: [],
fullyHighlighted: false,
},
},
},
Object {
"isHighlighted": false,
"value": "re",
})
).toEqual([
{
isHighlighted: true,
value: 'He',
},
{
isHighlighted: false,
value: 'llo t',
},
{
isHighlighted: true,
value: 'he',
},
{
isHighlighted: false,
value: 're',
},
]);
});

test('returns the highlighted parts of the hit with a nested array attribute', () => {
expect(
parseAlgoliaHitHighlight({
attribute: ['hierarchy', 'lvl0'],
hit: {
objectID: '1',
hierarchy: {
lvl0: 'Hello there',
},
_highlightResult: {
hierarchy: {
lvl0: {
value:
'__aa-highlight__He__/aa-highlight__llo t__aa-highlight__he__/aa-highlight__re',
matchLevel: 'partial',
matchedWords: [],
fullyHighlighted: false,
},
},
},
},
]
`);
})
).toEqual([
{
isHighlighted: true,
value: 'He',
},
{
isHighlighted: false,
value: 'llo t',
},
{
isHighlighted: true,
value: 'he',
},
{
isHighlighted: false,
value: 're',
},
]);
});

test('returns the attribute value if the attribute cannot be highlighted', () => {
Expand Down Expand Up @@ -113,7 +191,95 @@ describe('parseAlgoliaHitHighlight', () => {
},
});
}).toWarnDev(
'[Autocomplete] The attribute "_highlightResult.description.value" does not exist on the hit. Did you set it in `attributesToHighlight`?' +
'[Autocomplete] The attribute path ["description"] does not exist on the hit. Did you set it in `attributesToHighlight`?' +
shortcuts marked this conversation as resolved.
Show resolved Hide resolved
'\nSee https://www.algolia.com/doc/api-reference/api-parameters/attributesToHighlight/'
);
});

test('returns empty parts if the array attribute does not exist', () => {
expect(
parseAlgoliaHitHighlight({
attribute: ['description'],
hit: {
objectID: '1',
title: 'Hello there',
_snippetResult: {
title: {
value:
'__aa-highlight__He__/aa-highlight__llo t__aa-highlight__he__/aa-highlight__re',
},
},
},
})
).toEqual([]);
});

test('warns if the array attribute cannot be highlighted', () => {
expect(() => {
parseAlgoliaHitHighlight({
attribute: ['description'],
hit: {
objectID: '1',
title: 'Hello there',
description: 'Welcome all',
_highlightResult: {
title: {
value:
'__aa-highlight__He__/aa-highlight__llo t__aa-highlight__he__/aa-highlight__re',
matchLevel: 'partial',
matchedWords: [],
fullyHighlighted: false,
},
},
},
});
}).toWarnDev(
'[Autocomplete] The attribute path ["description"] does not exist on the hit. Did you set it in `attributesToHighlight`?' +
'\nSee https://www.algolia.com/doc/api-reference/api-parameters/attributesToHighlight/'
);
});

test('returns empty parts if the nested array attribute does not exist', () => {
expect(
parseAlgoliaHitHighlight({
attribute: ['title', 'description'],
hit: {
objectID: '1',
title: 'Hello there',
_snippetResult: {
title: {
value:
'__aa-highlight__He__/aa-highlight__llo t__aa-highlight__he__/aa-highlight__re',
},
},
},
})
).toEqual([]);
});

test('warns if the nested array attribute cannot be highlighted', () => {
expect(() => {
parseAlgoliaHitHighlight({
attribute: ['title', 'description'],
hit: {
objectID: '1',
title: 'Hello there',
description: 'Welcome all',
_highlightResult: {
title: {
noDescription: {
value:
'__aa-highlight__He__/aa-highlight__llo t__aa-highlight__he__/aa-highlight__re',
matchLevel: 'partial',
matchedWords: [],
fullyHighlighted: false,
},
},
},
},
});
}).toWarnDev(
'[Autocomplete] The attribute path ["title","description"] does not exist on the hit. Did you set it in `attributesToHighlight`?' +
'\nSee https://www.algolia.com/doc/api-reference/api-parameters/attributesToHighlight/'
);
});
Expand Down
Loading