refactor(core): add non-breaking core package

jest.config.js

@@ -54,6 +54,9 @@ const config = {
     '^instantsearch.js$': '<rootDir>/packages/instantsearch.js/src/',
     '^instantsearch.js/es(.*)$': '<rootDir>/packages/instantsearch.js/src$1',
     '^instantsearch.js/(.*)$': '<rootDir>/packages/instantsearch.js/$1',
+    '^instantsearch-core$': '<rootDir>/packages/instantsearch-core/src/',
+    '^instantsearch-core/dist/es(.*)$':
+      '<rootDir>/packages/instantsearch-core/src$1',
     '^instantsearch-ui-components$':
       '<rootDir>/packages/instantsearch-ui-components/src/',
     '^instantsearch-ui-components/(.*)$':

packages/algolia-experiences/package.json

@@ -10,7 +10,8 @@
   ],
   "dependencies": {
     "algoliasearch": "5.1.1",
-    "instantsearch.js": "4.103.0"
+    "instantsearch.js": "4.103.0",
+    "instantsearch-core": "0.1.0"
   },
   "devDependencies": {
     "@instantsearch/testutils": "1.98.0"

packages/algolia-experiences/src/banner.tsx

@@ -4,11 +4,11 @@ import { cx } from 'instantsearch-ui-components';
 import { h, render } from 'preact';
 
 import type { Banner } from 'algoliasearch-helper';
+import type { HitsConnectorParams } from 'instantsearch-core';
 import type {
   ComponentProps,
   HitsClassNames,
 } from 'instantsearch-ui-components';
-import type { HitsConnectorParams } from 'instantsearch.js/es/connectors/hits/connectHits';
 
 export type BannerWidgetParams = {
   container: HTMLElement;

packages/algolia-experiences/src/render.tsx

@@ -1,5 +1,5 @@
 /** @jsx h */
-import { getPropertyByPath } from 'instantsearch.js/es/lib/utils';
+import { getPropertyByPath } from 'instantsearch-core';
 import { carousel } from 'instantsearch.js/es/templates';
 import { index, panel } from 'instantsearch.js/es/widgets';
 import { h, Fragment } from 'preact';
@@ -17,7 +17,7 @@ import type {
   TemplateText,
   TemplateWidgetTypes,
 } from './types';
-import type { Widget } from 'instantsearch.js';
+import type { Widget } from 'instantsearch-core';
 import type { ComponentChildren, JSX } from 'preact';
 
 export function injectStyles() {

packages/algolia-experiences/src/setup-instantsearch.ts

@@ -9,7 +9,7 @@ import { configToIndex, injectStyles } from './render';
 import { error } from './util';
 
 import type { Settings } from './get-information';
-import type { IndexWidget } from 'instantsearch.js';
+import type { IndexWidget } from 'instantsearch-core';
 
 declare global {
   interface Window {

packages/instantsearch-core/README.md

@@ -0,0 +1,3 @@
+# instantsearch-core
+
+Internal shared package for InstantSearch flavors. This package is published for dependency resolution and type resolution, but it is not intended for direct end-user use.

packages/instantsearch-core/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "instantsearch-core",
+  "version": "0.1.0",
+  "description": "Internal shared package for InstantSearch flavors. Not intended for direct use.",
+  "types": "dist/es/index.d.ts",
+  "main": "dist/cjs/index.js",
+  "module": "dist/es/index.js",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/es/index.d.ts",
+      "import": "./dist/es/index.js",
+      "require": "./dist/cjs/index.js"
+    }
+  },
+  "sideEffects": false,
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/algolia/instantsearch"
+  },
+  "author": {
+    "name": "Algolia, Inc.",
+    "url": "https://www.algolia.com"
+  },
+  "keywords": [
+    "algolia",
+    "instantsearch",
+    "search"
+  ],
+  "files": [
+    "README.md",
+    "dist"
+  ],
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "BABEL_ENV=es,rollup BUILD_FORMAT=esm rollup -c rollup.config.mjs && BABEL_ENV=rollup BUILD_FORMAT=cjs rollup -c rollup.config.mjs && yarn build:types",
+    "build:types": "tsc -p ./tsconfig.declaration.json --outDir ./dist/es",
+    "version": "./scripts/version.cjs",
+    "prepare": "yarn build",
+    "watch:es": "BABEL_ENV=es,rollup BUILD_FORMAT=esm rollup -c rollup.config.mjs --watch"
+  },
+  "dependencies": {
+    "@algolia/events": "^4.0.1",
+    "@swc/helpers": "0.5.18",
+    "@types/dom-speech-recognition": "^0.0.1",
+    "@types/qs": "^6.5.3",
+    "algoliasearch-helper": "3.29.1",
+    "qs": "^6.5.1",
+    "search-insights": "^2.17.2"
+  }
+}

packages/instantsearch-core/rollup.config.mjs

@@ -0,0 +1,36 @@
+import {
+  createESMConfig,
+  createCJSConfig,
+  collectSourceEntries,
+} from '../../scripts/build/rollup.base.mjs';
+import pkg from './package.json' with { type: 'json' };
+
+const moduleInput = collectSourceEntries();
+const isESM = process.env.BUILD_FORMAT === 'esm';
+const isCJS = process.env.BUILD_FORMAT === 'cjs';
+
+const configs = [];
+
+if (isESM || (!isESM && !isCJS)) {
+  configs.push(
+    createESMConfig({
+      input: moduleInput,
+      pkg,
+      outputDir: 'dist/es',
+      preserveModules: true,
+    })
+  );
+}
+
+if (isCJS || (!isESM && !isCJS)) {
+  configs.push(
+    createCJSConfig({
+      input: moduleInput,
+      pkg,
+      outputDir: 'dist/cjs',
+      preserveModules: true,
+    })
+  );
+}
+
+export default configs;

packages/instantsearch-core/scripts/version.cjs

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+
+const version = require('../package.json').version;
+
+fs.writeFileSync(
+  path.resolve(__dirname, '../src/version.ts'),
+  `export default '${version}';\n`
+);

packages/instantsearch.js/src/lib/__tests__/InstantSearch-test.tsx → packages/instantsearch-core/src/__tests__/instantsearch-test.tsx

@@ -14,23 +14,22 @@ import { wait } from '@instantsearch/testutils/wait';
 import originalHelper from 'algoliasearch-helper';
 import { h, render, createRef } from 'preact';
 
-import { createRenderOptions, createWidget } from '../../../test/createWidget';
-import { connectSearchBox, connectPagination } from '../../connectors';
-import { createInsightsMiddleware } from '../../middlewares';
-import { index } from '../../widgets';
-import InstantSearch from '../InstantSearch';
-import { noop, warning } from '../utils';
-import version from '../version';
+import { createRenderOptions, createWidget } from '../../test/createWidget';
+import { connectSearchBox, connectPagination } from '../connectors';
+import InstantSearch from '../instantsearch';
+import { noop, warning } from '../lib/utils';
+import { createInsightsMiddleware } from '../middlewares';
+import { index } from '../widgets';
 
 import type {
   PaginationConnectorParams,
   PaginationWidgetDescription,
-} from '../../connectors/pagination/connectPagination';
+} from '../connectors';
 import type {
   SearchBoxWidgetDescription,
   SearchBoxConnectorParams,
-} from '../../connectors/search-box/connectSearchBox';
-import type { UiState, Widget, IndexWidget } from '../../types';
+} from '../connectors';
+import type { UiState, Widget, IndexWidget } from '../types';
 import type { RefObject } from 'preact';
 
 type SearchBoxWidgetInstance = Widget<
@@ -375,22 +374,6 @@ For more information, visit https://www.algolia.com/doc/guides/getting-insights-
 });
 
 describe('InstantSearch', () => {
-  it('calls addAlgoliaAgent', () => {
-    const searchClient = createSearchClient({
-      addAlgoliaAgent: jest.fn(),
-    });
-
-    // eslint-disable-next-line no-new
-    new InstantSearch({
-      indexName: 'indexName',
-      searchClient,
-    });
-
-    expect(searchClient.addAlgoliaAgent).toHaveBeenCalledTimes(1);
-    expect(searchClient.addAlgoliaAgent).toHaveBeenCalledWith(
-      `instantsearch.js (${version})`
-    );
-  });
 
   it('does not call algoliasearchHelper', () => {
     // eslint-disable-next-line no-new