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.

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

fix(atomic): use getter instead of fn #4396

Merged
merged 2 commits into from
Sep 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,12 @@ import {
StorageItems,
} from '../../../utils/local-storage-utils';
import {updateBreakpoints} from '../../../utils/replace-breakpoint';
import {isFocusingOut, once, randomID} from '../../../utils/utils';
import {
isFocusingOut,
once,
randomID,
spreadProperties,
} from '../../../utils/utils';
import {SearchBoxWrapper} from '../../common/search-box/search-box-wrapper';
import {SearchTextArea} from '../../common/search-box/search-text-area';
import {SubmitButton} from '../../common/search-box/submit-button';
Expand Down Expand Up @@ -330,11 +335,11 @@ export class AtomicCommerceSearchBox
private get suggestionBindings(): SearchBoxSuggestionsBindings<
SearchBox | StandaloneSearchBox
> {
return {
...this.bindings,
...this.suggestionManager.partialSuggestionBindings,
...this.partialSuggestionBindings,
};
return spreadProperties(
this.bindings,
this.suggestionManager.partialSuggestionBindings,
this.partialSuggestionBindings
);
}

private get partialSuggestionBindings(): Pick<
Expand All @@ -345,14 +350,38 @@ export class AtomicCommerceSearchBox
| 'numberOfQueries'
| 'clearFilters'
> {
return {
...this.bindings,
id: this.id,
isStandalone: () => !!this.redirectionUrl,
searchBoxController: () => this.searchBox,
numberOfQueries: this.numberOfQueries,
clearFilters: this.clearFilters,
};
return Object.defineProperties(
{...this.bindings},
{
id: {
get: () => this.id,
enumerable: true,
},
searchBoxController: {
get: () => this.searchBox,
enumerable: true,
},
isStandalone: {
get: () => !!this.redirectionUrl,
enumerable: true,
},
numberOfQueries: {
get: () => this.numberOfQueries,
enumerable: true,
},
clearFilters: {
get: () => this.clearFilters,
enumerable: true,
},
}
) as unknown as Pick<
SearchBoxSuggestionsBindings<SearchBox | StandaloneSearchBox>,
| 'id'
| 'isStandalone'
| 'searchBoxController'
| 'numberOfQueries'
| 'clearFilters'
>;
}

private get searchBoxOptions(): SearchBoxOptions {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -178,10 +178,10 @@ export class AtomicCommerceSearchBoxInstantProducts
content: <InstantItemShowAllButton i18n={this.bindings.i18n} />,
onSelect: () => {
this.bindings.clearSuggestions();
this.bindings
.searchBoxController()
.updateText(this.instantProducts.state.query);
this.bindings.searchBoxController().submit();
this.bindings.searchBoxController.updateText(
this.instantProducts.state.query
);
this.bindings.searchBoxController.submit();
},
});
}
Expand Down Expand Up @@ -228,7 +228,7 @@ export class AtomicCommerceSearchBoxInstantProducts
private onSuggestedQueryChange() {
if (
!this.bindings.getSuggestionElements().length &&
!this.bindings.searchBoxController().state.value
!this.bindings.searchBoxController.state.value
) {
console.warn(
"There doesn't seem to be any query suggestions configured. Make sure to include either an atomic-commerce-search-box-query-suggestions or atomic-commerce-search-box-recent-queries in your search box in order to see some instant products."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -87,16 +87,15 @@ export class AtomicCommerceSearchBoxQuerySuggestions {
}

private renderItems(): SearchBoxSuggestionElement[] {
const hasQuery = this.bindings.searchBoxController().state.value !== '';
const hasQuery = this.bindings.searchBoxController.state.value !== '';
const max = hasQuery ? this.maxWithQuery : this.maxWithoutQuery;
return this.bindings
.searchBoxController()
.state.suggestions.slice(0, max)
return this.bindings.searchBoxController.state.suggestions
.slice(0, max)
.map((suggestion) => this.renderItem(suggestion));
}

private renderItem(suggestion: Suggestion) {
const hasQuery = this.bindings.searchBoxController().state.value !== '';
const hasQuery = this.bindings.searchBoxController.state.value !== '';
const partialItem = getPartialSearchBoxSuggestionElement(
suggestion,
this.bindings.i18n
Expand All @@ -115,9 +114,7 @@ export class AtomicCommerceSearchBoxQuerySuggestions {
</QuerySuggestionContainer>
),
onSelect: () => {
this.bindings
.searchBoxController()
.selectSuggestion(suggestion.rawValue);
this.bindings.searchBoxController.selectSuggestion(suggestion.rawValue);
},
};
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ export class AtomicCommerceSearchBoxRecentQueries {
return [];
}

const query = this.bindings.searchBoxController().state.value;
const query = this.bindings.searchBoxController.state.value;
const hasQuery = query !== '';
const max = hasQuery ? this.maxWithQuery : this.maxWithoutQuery;
const filteredQueries = this.recentQueriesList.state.queries
Expand Down Expand Up @@ -157,7 +157,7 @@ export class AtomicCommerceSearchBoxRecentQueries {
}

private renderItem(value: string): SearchBoxSuggestionElement {
const query = this.bindings.searchBoxController().state.value;
const query = this.bindings.searchBoxController.state.value;
const partialItem = getPartialRecentQueryElement(value, this.bindings.i18n);
return {
...partialItem,
Expand All @@ -169,9 +169,9 @@ export class AtomicCommerceSearchBoxRecentQueries {
),

onSelect: () => {
if (this.bindings.isStandalone()) {
this.bindings.searchBoxController().updateText(value);
this.bindings.searchBoxController().submit();
if (this.bindings.isStandalone) {
this.bindings.searchBoxController.updateText(value);
this.bindings.searchBoxController.submit();
return;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -141,11 +141,11 @@ export type SearchBoxSuggestionsBindings<
/**
* Whether the search box is [standalone](https://docs.coveo.com/en/atomic/latest/usage/ssb/).
*/
isStandalone(): boolean;
isStandalone: boolean;
/**
* The search box headless controller.
*/
searchBoxController(): SearchBoxController;
searchBoxController: SearchBoxController;
/**
* The number of queries to display when the user interacts with the search box.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,12 @@ import {
StorageItems,
} from '../../../utils/local-storage-utils';
import {updateBreakpoints} from '../../../utils/replace-breakpoint';
import {isFocusingOut, once, randomID} from '../../../utils/utils';
import {
isFocusingOut,
once,
randomID,
spreadProperties,
} from '../../../utils/utils';
import {SearchBoxWrapper} from '../../common/search-box/search-box-wrapper';
import {SearchTextArea} from '../../common/search-box/search-text-area';
import {SubmitButton} from '../../common/search-box/submit-button';
Expand Down Expand Up @@ -329,11 +334,11 @@ export class AtomicSearchBox implements InitializableComponent<Bindings> {
private get suggestionBindings(): SearchBoxSuggestionsBindings<
SearchBox | StandaloneSearchBox
> {
return {
...this.bindings,
...this.suggestionManager.partialSuggestionBindings,
...this.partialSuggestionBindings,
};
return spreadProperties(
this.bindings,
this.suggestionManager.partialSuggestionBindings,
this.partialSuggestionBindings
);
}

private get partialSuggestionBindings(): Pick<
Expand All @@ -344,14 +349,38 @@ export class AtomicSearchBox implements InitializableComponent<Bindings> {
| 'numberOfQueries'
| 'clearFilters'
> {
return {
...this.bindings,
id: this.id,
isStandalone: () => !!this.redirectionUrl,
searchBoxController: () => this.searchBox,
numberOfQueries: this.numberOfQueries,
clearFilters: this.clearFilters,
};
return Object.defineProperties(
{...this.bindings},
louis-bompart marked this conversation as resolved.
Show resolved Hide resolved
{
id: {
get: () => this.id,
enumerable: true,
},
searchBoxController: {
get: () => this.searchBox,
enumerable: true,
},
isStandalone: {
get: () => !!this.redirectionUrl,
enumerable: true,
},
numberOfQueries: {
get: () => this.numberOfQueries,
enumerable: true,
},
clearFilters: {
get: () => this.clearFilters,
enumerable: true,
},
}
) as unknown as Pick<
SearchBoxSuggestionsBindings<SearchBox | StandaloneSearchBox>,
| 'id'
| 'isStandalone'
| 'searchBoxController'
| 'numberOfQueries'
| 'clearFilters'
>;
}

private get searchBoxOptions(): SearchBoxOptions {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -180,10 +180,10 @@ export class AtomicSearchBoxInstantResults implements InitializableComponent {
content: <InstantItemShowAllButton i18n={this.bindings.i18n} />,
onSelect: () => {
this.bindings.clearSuggestions();
this.bindings
.searchBoxController()
.updateText(this.instantResults.state.q);
this.bindings.searchBoxController().submit();
this.bindings.searchBoxController.updateText(
this.instantResults.state.q
);
this.bindings.searchBoxController.submit();
},
});
}
Expand Down Expand Up @@ -225,7 +225,7 @@ export class AtomicSearchBoxInstantResults implements InitializableComponent {
private onSuggestedQueryChange() {
if (
!this.bindings.getSuggestionElements().length &&
!this.bindings.searchBoxController().state.value
!this.bindings.searchBoxController.state.value
) {
console.warn(
"There doesn't seem to be any query suggestions configured. Make sure to include either an atomic-search-box-query-suggestions or atomic-search-box-recent-queries in your search box in order to see some instant results."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,16 +92,15 @@ export class AtomicSearchBoxQuerySuggestions {
}

private renderItems(): SearchBoxSuggestionElement[] {
const hasQuery = this.bindings.searchBoxController().state.value !== '';
const hasQuery = this.bindings.searchBoxController.state.value !== '';
const max = hasQuery ? this.maxWithQuery : this.maxWithoutQuery;
return this.bindings
.searchBoxController()
.state.suggestions.slice(0, max)
return this.bindings.searchBoxController.state.suggestions
.slice(0, max)
.map((suggestion) => this.renderItem(suggestion));
}

private renderItem(suggestion: Suggestion) {
const hasQuery = this.bindings.searchBoxController().state.value !== '';
const hasQuery = this.bindings.searchBoxController.state.value !== '';
const partialItem = getPartialSearchBoxSuggestionElement(
suggestion,
this.bindings.i18n
Expand All @@ -120,9 +119,7 @@ export class AtomicSearchBoxQuerySuggestions {
</QuerySuggestionContainer>
),
onSelect: () => {
this.bindings
.searchBoxController()
.selectSuggestion(suggestion.rawValue);
this.bindings.searchBoxController.selectSuggestion(suggestion.rawValue);
},
};
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ export class AtomicSearchBoxRecentQueries {
return [];
}

const query = this.bindings.searchBoxController().state.value;
const query = this.bindings.searchBoxController.state.value;
const hasQuery = query !== '';
const max = hasQuery ? this.maxWithQuery : this.maxWithoutQuery;
const filteredQueries = this.recentQueriesList.state.queries
Expand Down Expand Up @@ -155,7 +155,7 @@ export class AtomicSearchBoxRecentQueries {
}

private renderItem(value: string): SearchBoxSuggestionElement {
const query = this.bindings.searchBoxController().state.value;
const query = this.bindings.searchBoxController.state.value;
const partialItem = getPartialRecentQueryElement(value, this.bindings.i18n);
return {
...partialItem,
Expand All @@ -167,9 +167,9 @@ export class AtomicSearchBoxRecentQueries {
),

onSelect: () => {
if (this.bindings.isStandalone()) {
this.bindings.searchBoxController().updateText(value);
this.bindings.searchBoxController().submit();
if (this.bindings.isStandalone) {
this.bindings.searchBoxController.updateText(value);
this.bindings.searchBoxController.submit();
return;
}

Expand Down
20 changes: 20 additions & 0 deletions packages/atomic/src/utils/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -250,3 +250,23 @@ export function aggregate<V, K extends PropertyKey>(
<Record<K, V[] | undefined>>{}
);
}

/**
* Similar as a classic spread, but preserve all characteristics of properties (e.g. getter/setter).
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/assign#description
* for an explanation why (spread & assign work similarly).
* @param objects the objects to "spread" together
* @returns the spread result
*/
export function spreadProperties<Output extends object = {}>(
...objects: object[]
) {
const returnObject = {};
for (const obj of objects) {
Object.defineProperties(
returnObject,
Object.getOwnPropertyDescriptors(obj)
);
}
return returnObject as Output;
}
Loading