WIP next major

.circleci/config.yml

@@ -69,6 +69,7 @@ workflows:
             branches:
               only:
                 - master
+                - next
       - helper docs:
           requires:
             - build
@@ -82,11 +83,12 @@ workflows:
             - examples
           matrix:
             parameters:
-              browser: [chrome, firefox, internet explorer]
+              browser: [chrome, firefox]
           filters:
             branches:
               only:
                 - master
+                - next
       - e2e tests router nextjs:
           context: fx-libraries
           requires:
@@ -95,6 +97,7 @@ workflows:
             branches:
               only:
                 - master
+                - next
       - release if needed:
           context: fx-libraries
           requires:
@@ -139,7 +142,7 @@ workflows:
             - examples
           matrix:
             parameters:
-              browser: [chrome, firefox, internet explorer]
+              browser: [chrome, firefox]
       - e2e tests router nextjs:
           context: fx-libraries
           requires:
@@ -180,6 +183,7 @@ jobs:
             - packages/vue-instantsearch/vue2
             - packages/vue-instantsearch/vue3
             - packages/instantsearch-ui-components/dist
+            - packages/instantsearch-core/dist
 
   test metadata:
     <<: *defaults

.codesandbox/ci.json

@@ -15,7 +15,8 @@
     "packages/react-instantsearch-nextjs",
     "packages/vue-instantsearch",
     "packages/instantsearch.css",
-    "packages/instantsearch-ui-components"
+    "packages/instantsearch-ui-components",
+    "packages/instantsearch-core"
   ],
   "node": "20"
 }

.eslintrc.js

@@ -168,6 +168,7 @@ const config = {
         '@typescript-eslint/no-unnecessary-type-assertion': 'error',
         '@typescript-eslint/method-signature-style': 'error',
         '@typescript-eslint/unbound-method': 'error',
+        'import/no-unresolved': ['error'],
       },
     },
     {
@@ -214,21 +215,11 @@ const config = {
       rules: {
         'no-restricted-syntax': [
           'error',
-          {
-            selector: '[async=true]',
-            message:
-              'The polyfill for async/await is very large, which is why we use promise chains',
-          },
           {
             selector: 'ForInStatement',
             message:
               'for..in loops iterate over the entire prototype chain, which is virtually never what you want. Use Object.{keys,values,entries}, and iterate over the resulting array.',
           },
-          {
-            selector: 'ForOfStatement',
-            message:
-              'iterators/generators require regenerator-runtime, which is too heavyweight for this guide to allow them. Separately, loops should be avoided in favor of array iterations.',
-          },
           {
             selector: 'LabeledStatement',
             message:
@@ -242,6 +233,23 @@ const config = {
         ],
       },
     },
+    {
+      files: 'packages/**/*',
+      excludedFiles: [
+        '*.test.*',
+        '**/__tests__/**',
+        '**/stories/**',
+        'packages/algoliasearch-helper/documentation-src/**',
+      ],
+      plugins: ['compat'],
+      extends: ['plugin:compat/recommended'],
+      env: {
+        browser: true,
+      },
+      settings: {
+        lintAllEsApis: true,
+      },
+    },
     // Disable stricter rules introduced for the next versions of the libraries.
     {
       files: [
@@ -265,7 +273,10 @@ const config = {
       },
     },
     {
-      files: ['packages/instantsearch.js/src/**/*'],
+      files: [
+        'packages/instantsearch.js/src/**/*',
+        'packages/instantsearch-core/src/**/*',
+      ],
       excludedFiles: [
         '**/__tests__/**/*',
         'packages/instantsearch.js/src/widgets/**/*',

babel.config.js

@@ -18,7 +18,7 @@ module.exports = (api) => {
   if (isTest) {
     targets.node = true;
   } else {
-    targets.browsers = ['last 2 versions', 'ie >= 9'];
+    targets.browsers = require('./package.json').browserslist;
   }
 
   const testPlugins = [
@@ -61,42 +61,6 @@ module.exports = (api) => {
         ],
       },
     ],
-    // this plugin is used to test if we need polyfills, not to actually insert them
-    // only UMD, since cjs & esm have false positives due to imports
-    isUMD && [
-      'polyfill-es-shims',
-      {
-        method: 'usage-global',
-        targets: {
-          ie: 11,
-        },
-        shouldInjectPolyfill(name, defaultShouldInject) {
-          const exclude = [
-            // false positives (we access these from objects only)
-            'Array.prototype.item',
-            'String.prototype.item',
-            'Array.prototype.values',
-            'Function.prototype.name',
-
-            // we require polyfills for this already
-            'Array.prototype.includes',
-
-            // false positive (babel doesn't know types)
-            // this is actually only called on arrays
-            'String.prototype.includes',
-
-            // false positive (spread)
-            'Object.getOwnPropertyDescriptors',
-          ];
-          if (defaultShouldInject && !exclude.includes(name)) {
-            throw new Error(
-              `Usage of a builtin which isn't allowed to be polyfilled: ${name}`
-            );
-          }
-          return false;
-        },
-      },
-    ],
   ]);
 
   return {
@@ -142,6 +106,19 @@ module.exports = (api) => {
           ],
         ],
       },
+      {
+        test: 'packages/instantsearch-core',
+        plugins: [
+          [
+            '@babel/plugin-transform-runtime',
+            {
+              corejs: false,
+              helpers: true,
+              regenerator: false,
+            },
+          ],
+        ],
+      },
     ],
     // jsx is transpiled, so the comment should no longer be present in the final files
     shouldPrintComment: (value) => !value.startsWith('* @jsx'),

examples/js/algolia-experiences/package.json

@@ -13,7 +13,7 @@
     "instantsearch.css": "8.5.1"
   },
   "devDependencies": {
-    "@babel/core": "7.15.5",
+    "@babel/core": "7.25.9",
     "@parcel/core": "2.10.0",
     "@parcel/packager-raw-url": "2.10.0",
     "@parcel/transformer-webmanifest": "2.10.0",

examples/js/calendar-widget/package.json

@@ -13,7 +13,7 @@
     "instantsearch.js": "4.77.3"
   },
   "devDependencies": {
-    "@babel/core": "7.15.5",
+    "@babel/core": "7.25.9",
     "@parcel/packager-raw-url": "2.10.0",
     "@parcel/transformer-webmanifest": "2.10.0",
     "parcel": "2.10.0"

examples/js/e-commerce-umd/package.json

@@ -14,7 +14,7 @@
     "instantsearch.js": "4.77.3"
   },
   "devDependencies": {
-    "@babel/core": "7.15.5",
+    "@babel/core": "7.25.9",
     "@parcel/core": "2.10.0",
     "@parcel/packager-raw-url": "2.10.0",
     "@parcel/transformer-webmanifest": "2.10.0",

examples/js/e-commerce-umd/polyfills.js

@@ -1,6 +1,6 @@
 /*
  * Polyfill service v3.111.0
- * For detailed credits and licence information see https://polyfill.io.
+ * For detailed credits and license information see https://polyfill.io.
  *
  * Features requested: Array.prototype.find,Array.prototype.findIndex,Array.prototype.includes,Object.assign,Object.entries,Promise,default
  *

examples/js/e-commerce-umd/src/app.ts

@@ -3,3 +3,11 @@ import { attachEventListeners } from './ui';
 
 search.start();
 attachEventListeners();
+
+declare global {
+  interface Window {
+    search: typeof search;
+  }
+}
+
+window.search = search;

examples/js/e-commerce-umd/src/routing.ts

@@ -80,7 +80,6 @@ function getCategoryName(slug: string): string {
 const originalWindowTitle = document.title;
 
 const router = window.instantsearch.routers.history<RouteState>({
-  cleanUrlOnDispose: false,
   windowTitle({ category, query }) {
     const queryTitle = query ? `Results for "${query}"` : '';
 
@@ -89,10 +88,10 @@ const router = window.instantsearch.routers.history<RouteState>({
       .join(' | ');
   },
 
-  createURL({ qsModule, routeState, location }): string {
-    const { protocol, hostname, port = '', pathname, hash } = location;
+  createURL({ qsModule, routeState, currentURL }): string {
+    const { protocol, hostname, port = '', pathname, hash } = currentURL;
     const portWithPrefix = port === '' ? '' : `:${port}`;
-    const urlParts = location.href.match(/^(.*?)\/search/);
+    const urlParts = currentURL.href.match(/^(.*?)\/search/);
     const baseUrl =
       (urlParts && urlParts[0]) ||
       `${protocol}//${hostname}${portWithPrefix}${pathname}search`;
@@ -156,12 +155,14 @@ const router = window.instantsearch.routers.history<RouteState>({
     return `${baseUrl}/${categoryPath}${queryString}${hash}`;
   },
 
-  parseURL({ qsModule, location }): RouteState {
-    const pathnameMatches = location.pathname.match(/search\/(.*?)\/?$/);
+  parseURL({ qsModule, currentURL }): RouteState {
+    const pathnameMatches = currentURL.pathname.match(/search\/(.*?)\/?$/);
     const category = getCategoryName(
       (pathnameMatches && pathnameMatches[1]) || ''
     );
-    const queryParameters = qsModule.parse(location.search.slice(1));
+    const queryParameters = qsModule.parse(currentURL.search, {
+      ignoreQueryPrefix: true,
+    });
     const {
       query = '',
       page = 1,

examples/js/e-commerce-umd/src/widgets/Products.ts

@@ -51,8 +51,9 @@ export const products = hits<Hit>({
         </article>
       `;
     },
-    empty(results, { html }) {
-      const hasRefinements = results.getRefinements().length > 0;
+    empty(_, { html }) {
+      const hasRefinements =
+        window.search.renderState.instant_search.clearRefinements?.canRefine;
       const description = hasRefinements
         ? 'Try to reset your applied filters.'
         : 'Please try another query.';

examples/js/e-commerce/package.json

@@ -14,7 +14,7 @@
     "instantsearch.js": "4.77.3"
   },
   "devDependencies": {
-    "@babel/core": "7.15.5",
+    "@babel/core": "7.25.9",
     "@parcel/core": "2.10.0",
     "@parcel/packager-raw-url": "2.10.0",
     "@parcel/transformer-webmanifest": "2.10.0",

examples/js/e-commerce/polyfills.js

@@ -1,6 +1,6 @@
 /*
  * Polyfill service v3.111.0
- * For detailed credits and licence information see https://polyfill.io.
+ * For detailed credits and license information see https://polyfill.io.
  *
  * Features requested: Array.prototype.find,Array.prototype.findIndex,Array.prototype.includes,Object.assign,Object.entries,Promise,default
  *

examples/js/e-commerce/src/app.ts

@@ -5,3 +5,11 @@ import 'instantsearch.css/themes/reset.css';
 
 search.start();
 attachEventListeners();
+
+declare global {
+  interface Window {
+    search: typeof search;
+  }
+}
+
+window.search = search;

examples/js/e-commerce/src/routing.ts

@@ -82,7 +82,6 @@ function getCategoryName(slug: string): string {
 const originalWindowTitle = document.title;
 
 const router = historyRouter<RouteState>({
-  cleanUrlOnDispose: false,
   windowTitle({ category, query }) {
     const queryTitle = query ? `Results for "${query}"` : '';
 
@@ -91,10 +90,10 @@ const router = historyRouter<RouteState>({
       .join(' | ');
   },
 
-  createURL({ qsModule, routeState, location }): string {
-    const { protocol, hostname, port = '', pathname, hash } = location;
+  createURL({ qsModule, routeState, currentURL }): string {
+    const { protocol, hostname, port = '', pathname, hash } = currentURL;
     const portWithPrefix = port === '' ? '' : `:${port}`;
-    const urlParts = location.href.match(/^(.*?)\/search/);
+    const urlParts = currentURL.href.match(/^(.*?)\/search/);
     const baseUrl =
       (urlParts && urlParts[0]) ||
       `${protocol}//${hostname}${portWithPrefix}${pathname}search`;
@@ -158,12 +157,14 @@ const router = historyRouter<RouteState>({
     return `${baseUrl}/${categoryPath}${queryString}${hash}`;
   },
 
-  parseURL({ qsModule, location }): RouteState {
-    const pathnameMatches = location.pathname.match(/search\/(.*?)\/?$/);
+  parseURL({ qsModule, currentURL }): RouteState {
+    const pathnameMatches = currentURL.pathname.match(/search\/(.*?)\/?$/);
     const category = getCategoryName(
       (pathnameMatches && pathnameMatches[1]) || ''
     );
-    const queryParameters = qsModule.parse(location.search.slice(1));
+    const queryParameters = qsModule.parse(currentURL.search, {
+      ignoreQueryPrefix: true,
+    });
     const {
       query = '',
       page = 1,

examples/js/e-commerce/src/widgets/Products.ts

@@ -51,8 +51,9 @@ export const products = hits<Hit>({
         </article>
       `;
     },
-    empty(results, { html }) {
-      const hasRefinements = results.getRefinements().length > 0;
+    empty(_, { html }) {
+      const hasRefinements =
+        window.search.renderState.instant_search.clearRefinements?.canRefine;
       const description = hasRefinements
         ? 'Try to reset your applied filters.'
         : 'Please try another query.';

examples/js/getting-started/package.json

@@ -14,7 +14,7 @@
     "instantsearch.js": "4.77.3"
   },
   "devDependencies": {
-    "@babel/core": "7.15.5",
+    "@babel/core": "7.25.9",
     "@parcel/core": "2.10.0",
     "@parcel/packager-raw-url": "2.10.0",
     "@parcel/transformer-webmanifest": "2.10.0",

examples/js/media/package.json

@@ -15,7 +15,7 @@
     "instantsearch.js": "4.77.3"
   },
   "devDependencies": {
-    "@babel/core": "7.15.5",
+    "@babel/core": "7.25.9",
     "@parcel/core": "2.10.0",
     "@parcel/packager-raw-url": "2.10.0",
     "@parcel/transformer-webmanifest": "2.10.0",