Merge branch 'main' into expose-meilisearch-package

flevi29 · web-flow · commit ac6eb9043cff · 2024-01-18T12:28:12.000+02:00
diff --git a/.github/workflows/meilisearch-prototype-tests.yml b/.github/workflows/meilisearch-prototype-tests.yml
@@ -59,12 +59,12 @@ jobs:
           # Tests are only done on one playground to avoid long testing time
           start: yarn playground:autocomplete
           env: playground=local
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         if: failure()
         with:
           name: cypress-screenshots
           path: cypress/screenshots
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         if: failure()
         with:
           name: cypress-videos
@@ -99,12 +99,12 @@ jobs:
           # Tests are only done on one playground to avoid long testing time
           start: yarn playground:local-react
           env: playground=local
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         if: failure()
         with:
           name: cypress-screenshots
           path: cypress/screenshots
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         if: failure()
         with:
           name: cypress-videos
diff --git a/.github/workflows/pre-release-tests.yml b/.github/workflows/pre-release-tests.yml
@@ -57,12 +57,12 @@ jobs:
           # Tests are only done on one playground to avoid long testing time
           start: yarn playground:autocomplete
           env: playground=local
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         if: failure()
         with:
           name: cypress-screenshots
           path: cypress/screenshots
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         if: failure()
         with:
           name: cypress-videos
@@ -98,12 +98,12 @@ jobs:
           # Tests are only done on one playground to avoid long testing time
           start: yarn playground:local-react
           env: playground=local
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         if: failure()
         with:
           name: cypress-screenshots
           path: cypress/screenshots
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         if: failure()
         with:
           name: cypress-videos
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -50,12 +50,12 @@ jobs:
           # Tests are only done on one playground to avoid long testing time
           start: yarn playground:autocomplete
           env: playground=local
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         if: failure()
         with:
           name: cypress-screenshots
           path: cypress/screenshots
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         if: failure()
         with:
           name: cypress-videos
@@ -100,12 +100,12 @@ jobs:
           # Tests are only done on one playground to avoid long testing time
           start: yarn playground:local-react
           env: playground=local
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         if: failure()
         with:
           name: cypress-screenshots
           path: cypress/screenshots
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         if: failure()
         with:
           name: cypress-videos
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020-2022 Meili SAS
+Copyright (c) 2020-2024 Meili SAS
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/packages/instant-meilisearch/CHANGELOG.md b/packages/instant-meilisearch/CHANGELOG.md
@@ -1,6 +1,52 @@
 # @meilisearch/instant-meilisearch
 
-## 1.0.0
+## 0.14.0
+
+### Minor Changes
+
+- 5b6be19 & ed8b6a3: Added ability to override a selection of Meilisearch search parameters.
+
+  ⚠️ The returned value of the core `instantMeiliSearch` function has changed!
+
+  This change was necessary for the aforementioned ability to be implemented and
+  applied in a clean manner.
+  The necessary migration should be of minimal impact.
+
+  ### Migration
+
+  Change the following
+
+  ```js
+  // 1.
+  const client = instantMeiliSearch(/*...*/);
+  // 2.
+  const searchClient = instantMeiliSearch(/*...*/);
+  // 3.
+  instantsearch({
+    indexName: "movies",
+    searchClient: instantMeiliSearch(/*...*/),
+  });
+  ```
+
+  to the following
+
+  ```js
+  // 1.
+  const { searchClient: client } = instantMeiliSearch(/*...*/);
+  // 2.
+  const { searchClient } = instantMeiliSearch(/*...*/);
+  // 3.
+  instantsearch({
+    indexName: "movies",
+    searchClient: instantMeiliSearch(/*...*/).searchClient,
+  });
+  ```
+
+### Patch Changes
+
+- 06377ef: Fixes issue where backslashes ("\") and quotes (`"`) are not escaped in filters.
+
+## [DEPRECATED] 1.0.0
 
 ### Major Changes
 
diff --git a/packages/instant-meilisearch/__tests__/assets/games.json b/packages/instant-meilisearch/__tests__/assets/games.json
@@ -374,4 +374,4 @@
       "red"
     ]
   }
-]
+]
diff --git a/packages/instant-meilisearch/package.json b/packages/instant-meilisearch/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@meilisearch/instant-meilisearch",
-  "version": "1.0.0",
+  "version": "0.14.0",
   "private": false,
   "description": "The search client to use Meilisearch with InstantSearch.",
   "homepage": "https://github.com/meilisearch/meilisearch-js-plugins/tree/main/packages/instant-meilisearch",
@@ -78,4 +78,4 @@
     "tslib": "^2.6.1",
     "typescript": "^4.9.5"
   }
-}
+}
diff --git a/packages/instant-meilisearch/src/package-version.ts b/packages/instant-meilisearch/src/package-version.ts
@@ -1 +1 @@
-export const PACKAGE_VERSION = '1.0.0'
+export const PACKAGE_VERSION = '0.14.0'
diff --git a/playgrounds/angular/package.json b/playgrounds/angular/package.json
@@ -19,7 +19,7 @@
     "@angular/platform-browser": "~15.1.0",
     "@angular/platform-browser-dynamic": "~15.1.0",
     "@angular/router": "~15.1.0",
-    "@meilisearch/instant-meilisearch": "1.0.0",
+    "@meilisearch/instant-meilisearch": "0.14.0",
     "algoliasearch": "^4.17.2",
     "angular-instantsearch": "^4.4.1",
     "instantsearch.js": "^4.56.2",
@@ -39,4 +39,4 @@
   "browserslist": [
     "defaults"
   ]
-}
+}
diff --git a/playgrounds/autocomplete/assets/games.json b/playgrounds/autocomplete/assets/games.json
@@ -374,4 +374,4 @@
       "red"
     ]
   }
-]
+]
diff --git a/playgrounds/geo-javascript/package.json b/playgrounds/geo-javascript/package.json
@@ -12,7 +12,7 @@
   },
   "devDependencies": {
     "@babel/core": "^7.20.12",
-    "@meilisearch/instant-meilisearch": "1.0.0",
+    "@meilisearch/instant-meilisearch": "0.14.0",
     "eslint-config-meilisearch": "*"
   },
   "browserslist": [
@@ -22,4 +22,4 @@
   "dependencies": {
     "scriptjs": "^2.5.9"
   }
-}
+}
diff --git a/playgrounds/javascript/package.json b/playgrounds/javascript/package.json
@@ -18,6 +18,6 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "@meilisearch/instant-meilisearch": "1.0.0"
+    "@meilisearch/instant-meilisearch": "0.14.0"
   }
-}
+}
diff --git a/playgrounds/local-react/assets/games.json b/playgrounds/local-react/assets/games.json
@@ -374,4 +374,4 @@
       "red"
     ]
   }
-]
+]
diff --git a/playgrounds/local-react/package.json b/playgrounds/local-react/package.json
@@ -24,7 +24,7 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@meilisearch/instant-meilisearch": "1.0.0",
+    "@meilisearch/instant-meilisearch": "0.14.0",
     "instantsearch.css": "^8.0.0",
     "react": "^17.0.1",
     "react-dom": "^17.0.1",
@@ -39,4 +39,4 @@
     "cypress": "^8.6.0",
     "eslint-config-meilisearch": "*"
   }
-}
+}
diff --git a/playgrounds/react/package.json b/playgrounds/react/package.json
@@ -23,12 +23,12 @@
     "react": "^17.0.1",
     "react-dom": "^17.0.1",
     "react-instantsearch": "^7.1.0",
-    "@meilisearch/instant-meilisearch": "1.0.0"
+    "@meilisearch/instant-meilisearch": "0.14.0"
   },
   "devDependencies": {
     "@babel/core": "^7.13.1",
     "@babel/plugin-syntax-jsx": "^7.22.5",
     "@babel/preset-react": "^7.22.5",
     "eslint-config-meilisearch": "*"
   }
-}
+}
diff --git a/playgrounds/vue3-ts/package.json b/playgrounds/vue3-ts/package.json
@@ -12,7 +12,7 @@
     "test:types": "yarn tsc"
   },
   "dependencies": {
-    "@meilisearch/instant-meilisearch": "1.0.0",
+    "@meilisearch/instant-meilisearch": "0.14.0",
     "vue": "^3.2.45",
     "vue-instantsearch": "^4.10.8"
   },
@@ -23,4 +23,4 @@
     "vue-tsc": "^1.0.11",
     "eslint-config-meilisearch": "*"
   }
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -374,4 +374,4 @@`
`374`	`374`	`"red"`
`375`	`375`	`]`
`376`	`376`	`}`
`377`		`-]`
	`377`	`+]`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@meilisearch/instant-meilisearch",`
`3`		`- "version": "1.0.0",`
	`3`	`+ "version": "0.14.0",`
`4`	`4`	`"private": false,`
`5`	`5`	`"description": "The search client to use Meilisearch with InstantSearch.",`
`6`	`6`	`"homepage": "https://github.com/meilisearch/meilisearch-js-plugins/tree/main/packages/instant-meilisearch",`
`@@ -78,4 +78,4 @@`
`78`	`78`	`"tslib": "^2.6.1",`
`79`	`79`	`"typescript": "^4.9.5"`
`80`	`80`	`}`
`81`		`-}`
	`81`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-export const PACKAGE_VERSION = '1.0.0'`
	`1`	`+export const PACKAGE_VERSION = '0.14.0'`