feat: composition #6437

e-krebs · 2024-11-14T17:27:28Z

Summary

This PR currently adds two things:

new compositionID optional parameter when initializing InstantSearch
- instantsearch({ compositionID: 'composition-2', searchClient });
new searchWithComposition method in AlgoliaSearchHelper to handle querying the composition API
also, since we have to use a root index component (automagically added) under the hood, ~~I had to adapt the AlgoliaSearchHelper signature to handle being initialized with an indexName vs. a compositionID~~
- ~~I made it so this is backward compatible~~
- ~~maybe there's a better way?~~
- we're using the index parameter internally to store the compositionID. The main reason for that is: this is the simplest way to be out of the box compatible with the sortBy widget

Result

~~I'm currently modifying the js > getting-started example.~~
A dedicated example will be added later.

packages/instantsearch.js/src/lib/InstantSearch.ts

examples/js/getting-started/package.json

Haroenv

looks good! I don't think this can be merged as-is, because it would make master non-runnable, but overall this is the way to go

examples/js/getting-started/src/app.js

package.json

packages/algoliasearch-helper/index.d.ts

packages/algoliasearch-helper/src/algoliasearch.helper.js

examples/js/getting-started/package.json

codesandbox-ci · 2024-11-19T10:17:01Z

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit d1818fb:

Sandbox	Source
example-instantsearch-getting-started	Configuration
example-react-instantsearch-getting-started	Configuration
example-react-instantsearch-next-app-dir-example	Configuration
example-react-instantsearch-next-routing-example	Configuration
example-vue-instantsearch-getting-started	Configuration

Haroenv

overall I think this is the way to go, but still think composition id isn't needed in the helper constructor if we assume index name === composition id (because you don't search if you compose instead)

bundlesize.config.json

packages/algoliasearch-helper/src/algoliasearch.helper.js

packages/instantsearch.js/src/widgets/index/index.ts

e-krebs · 2024-11-20T11:21:33Z

@Haroenv as discussed, this should be ready to merge but we won't merge for now (and instead use this as a base branch for the whole feature implementation) so I'm keeping the "do not merge" label

Haroenv

looks already cleaner, now just the sortBy to do and moving the state to the index (IMO)

packages/algoliasearch-helper/index.d.ts

packages/algoliasearch-helper/src/algoliasearch.helper.js

packages/instantsearch.js/src/lib/InstantSearch.ts

packages/algoliasearch-helper/index.d.ts

Haroenv · 2024-12-09T09:22:09Z

just as draft as while it's approved, we're not merging until you want a release

Co-authored-by: Haroen Viaene <[email protected]>

…out of the box

Co-authored-by: Haroen Viaene <[email protected]>

feat: forbid adding an index widget when on a composition-based implementation

* feat: make vue compatible with composition * chore: increase vue2 package size 🤏 * chore(lint): allow console.error * feedback: do not add warning

* feat: add support for disjunctive facets with Composition API * fix: no lambda * fix: no string template * Update requestBuilder.js Co-authored-by: Haroen Viaene <[email protected]> --------- Co-authored-by: Haroen Viaene <[email protected]>

* feat: add searchForCompositionFacetValues in the helper * feat: plug searchForFacetValues for Composition * fix: js syntax * fix: bundlesizes * Update packages/algoliasearch-helper/src/algoliasearch.helper.js Co-authored-by: Haroen Viaene <[email protected]> --------- Co-authored-by: Haroen Viaene <[email protected]>

…acetValues (#6506) * example * clean: revert temporary examples change * fix: query & searchQuery where mixed * fix: rebase error

e-krebs added the 🚨　DO NOT MERGE for a pull request that is ready to review, but should not be merged yet label Nov 14, 2024

e-krebs self-assigned this Nov 14, 2024

e-krebs requested a review from Haroenv November 18, 2024 11:36

Haroenv reviewed Nov 18, 2024

View reviewed changes

packages/instantsearch.js/src/lib/InstantSearch.ts Outdated Show resolved Hide resolved

examples/js/getting-started/package.json Outdated Show resolved Hide resolved

e-krebs requested a review from Haroenv November 18, 2024 16:37

Haroenv reviewed Nov 19, 2024

View reviewed changes

e-krebs force-pushed the feat/composition branch 3 times, most recently from 37c1d4a to 7b6e05b Compare November 19, 2024 11:27

e-krebs requested a review from Haroenv November 19, 2024 11:38

e-krebs marked this pull request as ready for review November 19, 2024 11:38

Haroenv reviewed Nov 19, 2024

View reviewed changes

bundlesize.config.json Outdated Show resolved Hide resolved

Haroenv requested review from a team, dhayab and sarahdayan and removed request for a team November 19, 2024 12:31

e-krebs requested a review from Haroenv November 19, 2024 14:28

Haroenv reviewed Nov 20, 2024

View reviewed changes

packages/algoliasearch-helper/src/algoliasearch.helper.js Outdated Show resolved Hide resolved

packages/instantsearch.js/src/widgets/index/index.ts Outdated Show resolved Hide resolved

Haroenv reviewed Nov 20, 2024

View reviewed changes

packages/instantsearch.js/src/lib/InstantSearch.ts Show resolved Hide resolved

Haroenv reviewed Nov 20, 2024

View reviewed changes

packages/algoliasearch-helper/index.d.ts Outdated Show resolved Hide resolved

Haroenv approved these changes Nov 20, 2024

View reviewed changes

Haroenv approved these changes Nov 21, 2024

View reviewed changes

e-krebs mentioned this pull request Dec 3, 2024

feat: make composition compatible with vue #6458

Merged

Haroenv marked this pull request as draft December 9, 2024 09:21

e-krebs added 2 commits January 2, 2025 15:01

first tentative implementation

f1722d9

example

9586345

e-krebs and others added 19 commits January 2, 2025 15:01

fix: don't remove this

5b1941f

chore: better example + a TODO

a02cfff

fix: wording

b903d56

clean: revert temporary examples change

cad571e

fix: better syntax to avoid destructuring

2bf8b2f

fix: make CI pass

876aae0

fix: update bundle sizes

272d10b

fix: round up bundle sizes

5ee422a

chore: use SearchParameters to handle composition ID

2667e0b

fix: rollback to initial naming

566621c

fix: apply suggestions from code review

71374c2

Co-authored-by: Haroen Viaene <[email protected]>

chore: use index internally (vs. compositionID) so that sortBy works …

8d6397f

…out of the box

chore: better comment

3156481

Update packages/algoliasearch-helper/index.d.ts

9d9cbd5

Co-authored-by: Haroen Viaene <[email protected]>

chore: no need to delete facets & maxValuesPerFacet anymore 🎉

7fcd98b

chore: don't allow index widget when in composition mode (#6459)

38bf887

feat: forbid adding an index widget when on a composition-based implementation

feat: make composition compatible with vue (#6458)

f982c9f

* feat: make vue compatible with composition * chore: increase vue2 package size 🤏 * chore(lint): allow console.error * feedback: do not add warning

e-krebs force-pushed the feat/composition branch from 3ce2711 to 0db51c5 Compare January 2, 2025 14:02

e-krebs added 2 commits January 2, 2025 15:02

fix: update year in snapshot

0db51c5

fix: query & searchQuery where mixed when using searchForCompositionF…

d1818fb

…acetValues (#6506) * example * clean: revert temporary examples change * fix: query & searchQuery where mixed * fix: rebase error

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: composition #6437

feat: composition #6437

e-krebs commented Nov 14, 2024 •

edited

Loading

Haroenv left a comment

codesandbox-ci bot commented Nov 19, 2024 •

edited

Loading

Haroenv left a comment

e-krebs commented Nov 20, 2024

Haroenv left a comment

Haroenv commented Dec 9, 2024

feat: composition #6437

Are you sure you want to change the base?

feat: composition #6437

Conversation

e-krebs commented Nov 14, 2024 • edited Loading

Haroenv left a comment

Choose a reason for hiding this comment

codesandbox-ci bot commented Nov 19, 2024 • edited Loading

Haroenv left a comment

Choose a reason for hiding this comment

e-krebs commented Nov 20, 2024

Haroenv left a comment

Choose a reason for hiding this comment

Haroenv commented Dec 9, 2024

e-krebs commented Nov 14, 2024 •

edited

Loading

codesandbox-ci bot commented Nov 19, 2024 •

edited

Loading