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

WIP next major #6382

Draft
wants to merge 14 commits into
base: master
Choose a base branch
from
Draft

WIP next major #6382

wants to merge 14 commits into from

Conversation

aymeric-giraudet
Copy link
Member

@aymeric-giraudet aymeric-giraudet commented Oct 8, 2024

Work in progress branch for the next major version of InstantSearch (and its dependent packages).

This includes:

  • Remove support for hogan.js templates
  • Remove deprecated widgets (places, answers, analytics, EXPERIMENTAL_configureRelatedItems, EXPERIMENTAL_dynamicWidgets)
  • Remove experimental functions (EXPERIMENTAL_use)
  • Remove deprecated helpers (insights, getInsightsAnonymousUserToken, highlight, reverseHighlight, snippet, reverseSnippet)
  • Remove deprecated functions in the helper
  • Remove code mods from InstantSearch.js (available from the instantsearch-codemods package)
  • Change browser targets
  • Migrate code from instantsearch.js to instantsearch-core
  • Use instantsearch-core instead of instantsearch.js in React InstantSearch and Vue InstantSearch

BREAKING CHANGE : Hogan.js and raw HTML templates will no longer work. `bindEvent` also removed.

---------

Co-authored-by: Haroen Viaene <[email protected]>
@Haroenv Haroenv added the 🚨 DO NOT MERGE for a pull request that is ready to review, but should not be merged yet label Oct 8, 2024
Copy link

codesandbox-ci bot commented Oct 8, 2024

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.

@Haroenv Haroenv added this to the instantsearch.js v5 milestone Oct 18, 2024
* fix(widgets): remove analytics widget

The analytics widget has long been deprecated, and is removed with the insights middleware as alternative. You can use the `onEvent` hook to use a different service.

BREAKING CHANGE: the analytics widget no longer exists

* !fixup stories
The places widget has long been deprecated, and is removed without replacement as no places service exists anymore.

As a userland solution if you're using the places widget, copy the removed `places.ts` file inside your own project and import it locally.

BREAKING CHANGE: the places widget no longer exists
The answers widget has long been deprecated, and is removed without replacement as no answers service exists anymore.

As a userland solution if you're using the answers widget, copy the removed answers files inside your own project and import it locally.

BREAKING CHANGE: the answers widget no longer exists
BREAKING CHANGE: the findAnswers in the helper no longer exists
Instead you can use `use` to add a middleware

BREAKING CHANGE: EXPERIMENTAL_use function is replaced with use function
babel.config.js Outdated Show resolved Hide resolved
* fix(methods): remove addDisjunctiveRefine

BREAKING CHANGE: addDisjunctiveRefine is replaced with addDisjunctiveFacetRefinement

* fix(methods): remove removeDisjunctiveRefine

BREAKING CHANGE: removeDisjunctiveRefine is replaced with removeDisjunctiveFacetRefinement

* fix(methods): remove addRefine

BREAKING CHANGE: addRefine is replaced with addFacetRefinement

* fix(methods): remove addExclude

BREAKING CHANGE: addExclude is replaced with addFacetExclusion

* fix(methods): remove removeRefine

BREAKING CHANGE: removeRefine is replaced with removeFacetRefinement

* fix(methods): remove removeExclude

BREAKING CHANGE: removeExclude is replaced with removeFacetExclusion

* fix(methods): remove toggleExclude

BREAKING CHANGE: toggleExclude is replaced with toggleFacetExclusion

* fix(methods): remove toggleRefine

BREAKING CHANGE: toggleRefine is replaced with toggleFacetRefinement

* fix(methods): remove toggleRefinement

BREAKING CHANGE: toggleRefinement is replaced with toggleFacetRefinement

* fix(methods): remove isExcluded, isDisjunctiveRefined, hasTag, isTagRefined

These methods are available from the SearchParameters / helper.state instead

BREAKING CHANGE: replace helper.isExcluded with helper.state.isExcludeRefined
BREAKING CHANGE: replace helper.isDisjunctiveRefined with helper.state.isDisjunctiveFacetRefined
BREAKING CHANGE: replace helper.hasTag with helper.state.isTagRefined
BREAKING CHANGE: replace helper.isTagRefined with helper.state.isTagRefined

* fix(methods): remove setCurrentPage

BREAKING CHANGE: setCurrentPage is replaced with setPage

* fix(methods): remove getCurrentPage

BREAKING CHANGE: getCurrentPage is replaced with getPage

* fix(methods): remove getFacetByName

BREAKING CHANGE: getFacetByName (on search results) is replaced by calling results.xxxfacets.find(f => f.name === name) yourself (where xxxfacets is facets, disjunctiveFacets or hierarchicalFacets depending on your use case)

* fix(methods): remove containsRefinement

BREAKING CHANGE: containsRefinement is removed. Instead check the length of the arguments directly.
The widgets (and connectors) EXPERIMENTAL_dynamicWidgets, EXPERIMENTAL_configureRelatedItems are removed, and replaced with their non-experimental version.

If you want to keep using the experimental behaviour of configure related items, you can copy the files from here into your project and continue using them.

BREAKING CHANGE: experimental configure related items is replace with related products
BREAKING CHANGE: experimental dynamic widgets is replaced with dynamic widgets
They are already in place in the instantsearch-codemods package

BREAKING CHANGE: use codemods from `instantsearch-codemods` instead of instantsearch.js
BREAKING CHANGE: remove instantsearch.highlight, instantsearch.reverseHighlight, instantsearch.snippet, instantsearch.reverseSnippet. Instead use the `components` available from a template
BREAKING CHANGE: remove instantsearch.insights, instead use sendEvent
BREAKING CHANGE: remove instantsearch.getInsightsAnonymousUserToken
* feat: introduce `instantsearch-core` package

* Apply suggestions from code review

Co-authored-by: Dhaya <[email protected]>

---------

Co-authored-by: Haroen Viaene <[email protected]>
Co-authored-by: Dhaya <[email protected]>
aymeric-giraudet and others added 3 commits November 5, 2024 11:33
* feat(babel): upgrade and set newer browser targets

* fix @babel/traverse security issue

* remove unused babel plugin

* dedupe lockfile

* add babel to vue-instantsearch

* exclude helper docs from eslint rule

---------

Co-authored-by: Haroen Viaene <[email protected]>
BREAKING CHANGE: __hitIndex is no longer populated
)

BREAKING CHANGE: if you are using any internal instantsearch.js functions, ensure to update to instantsearch-core to avoid duplication
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🚨 DO NOT MERGE for a pull request that is ready to review, but should not be merged yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants