Changes related to the next Meilisearch release (v1.11.0)

.changeset/config.json

@@ -10,7 +10,6 @@
   "ignore": [
     "@meilisearch/geo-playground",
     "@meilisearch/vanilla-playground",
-    "@meilisearch/angular-playground",
     "@meilisearch/vue3-ts-playground",
     "@meilisearch/react-playground",
     "@meilisearch/local-react-playground",

.gitignore

@@ -72,8 +72,8 @@ typings/
 .env
 .env.test
 
-# parcel-bundler cache (https://parceljs.org/)
-.cache
+# parcel cache (https://parceljs.org/)
+.parcel-cache
 
 # Next.js build output
 .next
@@ -123,6 +123,4 @@ dist
 data.ms
 .turbo
 
-.angular
-
 .idea

CONTRIBUTING.md

@@ -108,7 +108,7 @@ yarn playground:html
 An additional playground is provided to test out the [GeoSearch](./packages/instant-meilisearch#-geo-search).
 
 ```bash
-yarn playground:geo-javascript
+yarn playground:geosearch
 ```
 
 Note: If the Google Maps stopped working, please create a new [Google Api Key](https://developers.google.com/maps/documentation/javascript/get-api-key) and add it in the `.env` file at the root of the playground: `/playgrounds/geo-javascript`

package.json

@@ -13,7 +13,6 @@
   "scripts": {
     "playground:geosearch": "turbo run dev --filter=@meilisearch/geo-playground --parallel",
     "playground:vanilla": "turbo run dev --filter=@meilisearch/vanilla-playground --parallel",
-    "playground:angular": "turbo run dev --filter=@meilisearch/angular-playground --parallel",
     "playground:vue3": "turbo run dev --filter=@meilisearch/vue3-ts-playground --parallel",
     "playground:react": "turbo run dev --filter=@meilisearch/react-playground --parallel",
     "playground:local-react": "turbo run dev --filter=@meilisearch/local-react-playground --parallel",
@@ -37,12 +36,17 @@
     "@testing-library/jest-dom": "^5.16.5",
     "@types/jest": "^29.5.1",
     "@types/jest-diff": "^24.3.0",
-    "parcel-bundler": "^1.12.5",
-    "turbo": "^1.10.12"
+    "parcel": "^2.12.0",
+    "turbo": "^2.1.3"
   },
   "dependencies": {
     "@changesets/cli": "^2.26.1",
     "instantsearch.css": "^8.0.0"
   },
+  "alias": {
+    "node:crypto": false,
+    "node:buffer": false,
+    "node:process": false
+  },
   "packageManager": "yarn@1.22.22"
 }

packages/autocomplete-client/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @meilisearch/autocomplete-client
 
+## 0.4.0
+
+### Minor Changes
+
+- 26e7cfd: - update `meilisearch` js client
+  - update `parcel` and `turbo`
+  - get rid of angular playground tests, as [angular-instantsearch got deprecated](https://www.algolia.com/blog/algolia/migrating-from-angular-instantsearch/)
+
+### Patch Changes
+
+- Updated dependencies [26e7cfd]
+  - @meilisearch/instant-meilisearch@0.21.0
+
 ## 0.3.0
 
 ### Minor Changes

packages/autocomplete-client/jest.config.js

@@ -11,9 +11,8 @@ module.exports = {
   projects: [
     {
       globals: {
-        'ts-jest': {
-          tsconfig: 'tsconfig.test.json',
-        },
+        'ts-jest': { tsconfig: 'tsconfig.test.json' },
+        fetch: globalThis.fetch,
       },
       preset: 'ts-jest',
       displayName: 'dom',
@@ -22,9 +21,8 @@ module.exports = {
     },
     {
       globals: {
-        'ts-jest': {
-          tsconfig: 'tsconfig.test.json',
-        },
+        'ts-jest': { tsconfig: 'tsconfig.test.json' },
+        fetch: globalThis.fetch,
       },
       preset: 'ts-jest',
       displayName: 'node',

packages/autocomplete-client/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meilisearch/autocomplete-client",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "private": false,
   "description": "The search client to use Meilisearch with autocomplete.js.",
   "homepage": "https://github.com/meilisearch/meilisearch-js-plugins/tree/main/packages/autocomplete-client",

packages/autocomplete-client/src/package-version.ts

@@ -1 +1 @@
-export const PACKAGE_VERSION = '0.3.0'
+export const PACKAGE_VERSION = '0.4.0'

packages/autocomplete-client/tsconfig.test.json

@@ -6,6 +6,5 @@
   },
   "include": [
     "./**/*"
-  ],
-  "exclude": ["playgrounds/angular"]
+  ]
 }

packages/eslint-config-meilisearch/CHANGELOG.md

@@ -0,0 +1,9 @@
+# eslint-config-meilisearch
+
+## 0.0.1
+
+### Patch Changes
+
+- 26e7cfd: - update `meilisearch` js client
+  - update `parcel` and `turbo`
+  - get rid of angular playground tests, as [angular-instantsearch got deprecated](https://www.algolia.com/blog/algolia/migrating-from-angular-instantsearch/)

packages/eslint-config-meilisearch/index.js

@@ -57,7 +57,6 @@ module.exports = {
         browser: true, // for jest/puppeteer tests in tests/env/express
         context: true, // for jest/puppeteer tests in tests/env/express
         jestPuppeteer: true, // for jest/puppeteer tests in tests/env/express
-        jasmine: true, // for angular e2e tests in playground/angular
       },
       extends: [
         'standard',
@@ -120,7 +119,6 @@ module.exports = {
         browser: true, // for jest/puppeteer tests in tests/env/express
         context: true, // for jest/puppeteer tests in tests/env/express
         jestPuppeteer: true, // for jest/puppeteer tests in tests/env/express
-        jasmine: true, // for angular e2e tests in playground/angular
       },
       extends: [
         'standard',

packages/eslint-config-meilisearch/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-meilisearch",
-  "version": "0.0.0",
+  "version": "0.0.1",
   "main": "index.js",
   "license": "MIT",
   "private": true,

packages/instant-meilisearch/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @meilisearch/instant-meilisearch
 
+## 0.21.1
+
+### Patch Changes
+
+- 1e7bf78: Fix wrong "meilisearch" client being imported in UMD bundle.
+
+## 0.21.0
+
+### Minor Changes
+
+- 26e7cfd: - update `meilisearch` js client
+  - update `parcel` and `turbo`
+  - get rid of angular playground tests, as [angular-instantsearch got deprecated](https://www.algolia.com/blog/algolia/migrating-from-angular-instantsearch/)
+
+## 0.20.1
+
+### Patch Changes
+
+- fa02104: Don't write objectID property if it already exists when adapting geosearch.
+
+## 0.20.0
+
+### Minor Changes
+
+- 1885691: Update meilisearch version to v0.42.0
+
 ## 0.19.3
 
 ### Patch Changes

packages/instant-meilisearch/README.md

@@ -44,10 +44,66 @@ NB: If you don't have any Meilisearch instance running and containing your data,
 - [⚡ Supercharge your Meilisearch experience](#-supercharge-your-meilisearch-experience)
 - [🔧 Installation](#-installation)
 - [🎬 Usage](#-usage)
+  - [Basic](#basic)
+  - [Parameters](#parameters)
 - [💅 Customization](#-customization)
+  - [Placeholder Search](#placeholder-search)
+  - [Finite Pagination](#finite-pagination)
+  - [Primary key](#primary-key)
+  - [Keep zero facets](#keep-zero-facets)
+  - [Request Config](#request-config)
+  - [Custom HTTP client](#custom-http-client)
+  - [Meilisearch search parameters](#meilisearch-search-parameters)
+  - [Modify Meilisearch search parameters](#modify-meilisearch-search-parameters)
 - [🪡 Example with InstantSearch](#-example-with-instantsearch)
+- [More Documentation](#more-documentation)
 - [🤖 Compatibility with Meilisearch and InstantSearch](#-compatibility-with-meilisearch-and-instantsearch)
-- [📜 API Resources](#-api-resources)
+- [📜 API resources](#-api-resources)
+  - [Table Of Widgets](#table-of-widgets)
+  - [✅ InstantSearch](#-instantsearch)
+  - [✅ Index](#-index)
+  - [✅ SearchBox](#-searchbox)
+  - [✅ Configure](#-configure)
+  - [❌ ConfigureRelatedItems](#-configurerelateditems)
+  - [Panel](#panel)
+  - [❌ Autocomplete](#-autocomplete)
+  - [✅ Voice Search](#-voice-search)
+  - [✅ Insight](#-insight)
+  - [✅ Middleware](#-middleware)
+  - [✅ renderState](#-renderstate)
+  - [✅ Hits](#-hits)
+  - [✅ InfiniteHits](#-infinitehits)
+  - [✅ Highlight](#-highlight)
+  - [✅ Snippet](#-snippet)
+  - [✅ Geo Search](#-geo-search)
+    - [Requirements](#requirements)
+  - [Usage](#usage)
+  - [❌ Answers](#-answers)
+  - [✅ RefinementList](#-refinementlist)
+  - [✅ HierarchicalMenu](#-hierarchicalmenu)
+    - [Hierarchical Menu Usage](#hierarchical-menu-usage)
+  - [✅ RangeSlider](#-rangeslider)
+  - [✅ Menu](#-menu)
+  - [✅ currentRefinements](#-currentrefinements)
+  - [✅ RangeInput](#-rangeinput)
+  - [✅ MenuSelect](#-menuselect)
+  - [✅ ToggleRefinement](#-togglerefinement)
+  - [✅ NumericMenu](#-numericmenu)
+  - [✅ RatingMenu](#-ratingmenu)
+  - [✅ ClearRefinements](#-clearrefinements)
+  - [✅ Pagination](#-pagination)
+  - [✅ HitsPerPage](#-hitsperpage)
+  - [✅ Breadcrumb](#-breadcrumb)
+  - [✅ Stats](#-stats)
+  - [❌ Analytics](#-analytics)
+  - [❌ QueryRuleCustomData](#-queryrulecustomdata)
+  - [❌ QueryRuleContext](#-queryrulecontext)
+  - [✅ SortBy](#-sortby)
+    - [Sort formula](#sort-formula)
+    - [Relevancy](#relevancy)
+    - [Example](#example)
+  - [❌ RelevantSort](#-relevantsort)
+  - [✅ Routing](#-routing)
 - [⚙️ Development Workflow and Contributing](#️-development-workflow-and-contributing)
 
 ## 📖 Documentation

packages/instant-meilisearch/jest.config.js

@@ -10,9 +10,8 @@ module.exports = {
   projects: [
     {
       globals: {
-        'ts-jest': {
-          tsconfig: 'tsconfig.test.json',
-        },
+        'ts-jest': { tsconfig: 'tsconfig.test.json' },
+        fetch: globalThis.fetch,
       },
       preset: 'ts-jest',
       displayName: 'dom',
@@ -22,9 +21,8 @@ module.exports = {
     },
     {
       globals: {
-        'ts-jest': {
-          tsconfig: 'tsconfig.test.json',
-        },
+        'ts-jest': { tsconfig: 'tsconfig.test.json' },
+        fetch: globalThis.fetch,
       },
       preset: 'ts-jest',
       displayName: 'node',

packages/instant-meilisearch/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meilisearch/instant-meilisearch",
-  "version": "0.19.3",
+  "version": "0.21.1",
   "private": false,
   "description": "The search client to use Meilisearch with InstantSearch.",
   "homepage": "https://github.com/meilisearch/meilisearch-js-plugins/tree/main/packages/instant-meilisearch",
@@ -50,7 +50,7 @@
     "templates"
   ],
   "dependencies": {
-    "meilisearch": "^0.41.0"
+    "meilisearch": "^0.44.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.22.9",
@@ -78,4 +78,4 @@
     "tslib": "^2.6.1",
     "typescript": "^4.9.5"
   }
-}
+}

packages/instant-meilisearch/rollup.config.js

@@ -38,7 +38,6 @@ const ROLLUP_OPTIONS = [
   // browser-friendly IIFE build
   {
     input: INPUT, // directory to transpilation of typescript
-    external: ['cross-fetch', 'cross-fetch/polyfill'],
     output: {
       name: 'window',
       extend: true,
@@ -55,11 +54,7 @@ const ROLLUP_OPTIONS = [
     },
     plugins: [
       ...COMMON_PLUGINS,
-      nodeResolve({
-        mainFields: ['jsnext', 'browser', 'main'],
-        preferBuiltins: true,
-        browser: true,
-      }),
+      nodeResolve({ exportConditions: ['browser'] }),
       commonjs(),
       babel(),
       // json(),

packages/instant-meilisearch/src/adapter/search-response-adapter/__tests__/geo-adapter.test.ts

@@ -49,4 +49,29 @@ describe('Geopoint adapter', () => {
     expect(adaptedHits[1]._formatted._geoloc).toBeUndefined()
     expect(adaptedHits[1]._formatted._geo).toBeUndefined()
   })
+
+  test('hits with _geoloc field should not overwrite `objectID` property', () => {
+    const hits = [
+      {
+        objectID: '2',
+        id: 2,
+        _geo: {
+          lat: 1,
+          lng: 2,
+        },
+        _formatted: {
+          _geo: {
+            lat: 1,
+            lng: 2,
+          },
+        },
+      },
+    ]
+
+    const adaptedHits = adaptGeoResponse(hits)
+
+    expect(adaptedHits[0]._geoloc).toEqual(hits[0]._geo)
+    expect(adaptedHits[0]._geo).toEqual(hits[0]._geo)
+    expect(adaptedHits[0].objectID).toEqual(hits[0].objectID)
+  })
 })

packages/instant-meilisearch/src/adapter/search-response-adapter/geo-reponse-adapter.ts

@@ -7,12 +7,16 @@ export function adaptGeoResponse(hits: any[]): Array<Record<string, any>> {
     const objectID = `${i + Math.random() * 1000000}`
     if (hits[i]._geo) {
       hits[i]._geoloc = hits[i]._geo
-      hits[i].objectID = objectID
+      if (!hits[i].objectID) {
+        hits[i].objectID = objectID
+      }
     }
 
     if (hits[i]._formatted?._geo) {
       hits[i]._formatted._geoloc = hits[i]._formatted._geo
-      hits[i]._formatted.objectID = objectID
+      if (!hits[i]._formatted.objectID) {
+        hits[i]._formatted.objectID = objectID
+      }
     }
   }
   return hits

packages/instant-meilisearch/src/package-version.ts

@@ -1 +1 @@
-export const PACKAGE_VERSION = '0.19.3'
+export const PACKAGE_VERSION = '0.21.1'

packages/instant-meilisearch/tsconfig.test.json

@@ -1,10 +1,9 @@
 {
   "extends": "./tsconfig.json",
   "compilerOptions": {
-    "suppressImplicitAnyIndexErrors": true,
+    "suppressImplicitAnyIndexErrors": true
   },
   "include": [
     "./**/*"
-  ],
-  "exclude": ["playgrounds/angular"]
+  ]
 }