Merge branch 'main' of github.com:meilisearch/instant-meilisearch into bump-meilisearch-v0.24.0

Author: bidoubiwa

.github/release-draft-template.yml

@@ -8,11 +8,15 @@ version-resolver:
       - 'breaking-change'
   default: patch
 categories:
-  - title: 'Breaking changes ⚠️'
+  - title: '⚠️ Breaking changes'
     label: 'breaking-change'
+  - title: '🚀 Enhancements'
+    label: 'enhancement'
+  - title: '🐛 Bug Fixes'
+    label: 'bug'
+  - title: '🔒 Security'
+    label: 'security'
 template: |
-  ## Changes
-
   $CHANGES
 
   Thanks again to $CONTRIBUTORS! 🎉

.github/workflows/publish.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/setup-node@v2
         with:
           node-version: 12
           registry-url: https://registry.npmjs.org/

.github/workflows/test.yml

@@ -24,9 +24,9 @@ jobs:
             ./node_modules
           key: ${{ hashFiles('yarn.lock') }}
       - name: Setup node
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v2
         with:
-          node-version: '12.x'
+          node-version: "14.x"
       - name: Install dependencies
         run: yarn --dev && yarn --cwd ./playgrounds/vue
       - name: Run Browser tests
@@ -35,23 +35,26 @@ jobs:
           # Tests are only done on one playground to avoid long testing time
           start: yarn playground:vue
           env: playground=vue
-      - uses: actions/upload-artifact@v1
+      - uses: actions/upload-artifact@v2
         if: failure()
         with:
           name: cypress-screenshots
           path: cypress/screenshots
-      - uses: actions/upload-artifact@v1
+      - uses: actions/upload-artifact@v2
         if: failure()
         with:
           name: cypress-videos
           path: cypress/videos
 
   tests:
-    name: integration-tests
     runs-on: ubuntu-latest
-
+    strategy:
+      fail-fast: false
+      matrix:
+        node: ["12", "14", "16"]
+    name: integration-tests (Node.js ${{ matrix.node }})
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v2
       - name: Cache dependencies
         uses: actions/cache@v2
         with:
@@ -72,7 +75,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v2
       - name: Cache dependencies
         uses: actions/cache@v2
         with:

CONTRIBUTING.md

@@ -2,23 +2,12 @@
 
 First of all, thank you for contributing to MeiliSearch! The goal of this document is to provide everything you need to know in order to contribute to MeiliSearch and its different integrations.
 
-- [Hacktoberfest](#hacktoberfest)
 - [Assumptions](#assumptions)
 - [How to Contribute](#how-to-contribute)
 - [Development Workflow](#development-workflow)
 - [Git Guidelines](#git-guidelines)
 - [Release Process (for internal team only)](#release-process-for-internal-team-only)
 
-## Hacktoberfest
-
-It's [Hacktoberfest month](https://blog.meilisearch.com/contribute-hacktoberfest-2021/)! 🥳
-
-🚀 If your PR gets accepted it will count into your participation to Hacktoberfest!
-
-✅ To be accepted it has either to have been merged, approved or tagged with the `hacktoberfest-accepted` label.
-
-🧐 Don't forget to check the [quality standards](https://hacktoberfest.digitalocean.com/resources/qualitystandards)! Low-quality PRs might get marked as `spam` or `invalid`, and will not count toward your participation in Hacktoberfest.
-
 ## Assumptions
 
 1. **You're familiar with [GitHub](https://github.com) and the [Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) (PR) workflow.**
@@ -91,14 +80,6 @@ yarn playground:html
 
 A playground is available to try out the [GeoSearch](./README.md/-geo-search) in `instant-meilisearch`.
 
-Unfortunately, for the moment, no online dataset is provided. Meaning that to make the playground work, you will have to set up your MeiliSearch accordingly to the playground needs.
-
-To do so follow these steps:
-
-1. Run a MeiliSeaerch instance. See [Setup](#setup) section to launch MeiliSearch with `Docker`. It is important to use the same `host` and `apikey` as provided in the `setup` section.
-2. Add the settings and the documents to your running MeiliSearch instance. We provide a script that does this automatically. Please run `node playgrounds/geo-javascript/setup/index.js`. Or you can look at the script to take inspiration!
-4. Run the playground!
-
 ```bash
 yarn playground:geo-javascript
 ```
@@ -128,7 +109,7 @@ Some notes on GitHub PRs:
 
 - [Convert your PR as a draft](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/changing-the-stage-of-a-pull-request) if your changes are a work in progress: no one will review it until you pass your PR as ready for review.<br>
   The draft PR can be very useful if you want to show that you are working on something and make your work visible.
-- The branch related to the PR must be **up-to-date with `main`** before merging. Fortunately, this project [integrates a bot](https://github.com/meilisearch/integration-guides/blob/main/guides/bors.md) to automatically enforce this requirement without the PR author having to do it manually.
+- The branch related to the PR must be **up-to-date with `main`** before merging. Fortunately, this project [integrates a bot](https://github.com/meilisearch/integration-guides/blob/main/resources/bors.md) to automatically enforce this requirement without the PR author having to do it manually.
 - All PRs must be reviewed and approved by at least one maintainer.
 - The PR title should be accurate and descriptive of the changes. The title of the PR will be indeed automatically added to the next [release changelogs](https://github.com/meilisearch/instant-meilisearch/releases/).
 
@@ -139,24 +120,24 @@ MeiliSearch tools follow the [Semantic Versioning Convention](https://semver.org
 ### Automation to Rebase and Merge the PRs <!-- omit in TOC -->
 
 This project integrates a bot that helps us manage pull requests merging.<br>
-_[Read more about this](https://github.com/meilisearch/integration-guides/blob/main/guides/bors.md)._
+_[Read more about this](https://github.com/meilisearch/integration-guides/blob/main/resources/bors.md)._
 
 ### Automated Changelogs <!-- omit in TOC -->
 
 This project integrates a tool to create automated changelogs.<br>
-_[Read more about this](https://github.com/meilisearch/integration-guides/blob/main/guides/release-drafter.md)._
+_[Read more about this](https://github.com/meilisearch/integration-guides/blob/main/resources/release-drafter.md)._
 
 ### How to Publish the Release <!-- omit in TOC -->
 
-⚠️ Before doing anything, make sure you got through the guide about [Releasing an Integration](https://github.com/meilisearch/integration-guides/blob/main/guides/integration-release.md).
+⚠️ Before doing anything, make sure you got through the guide about [Releasing an Integration](https://github.com/meilisearch/integration-guides/blob/main/resources/integration-release.md).
 
 Make a PR modifying the file [`package.json`](/package.json) with the right version.
 
 ```javascript
 "version": "X.X.X"
 ```
 
-Once the changes are merged on `main`, you can publish the current draft release via the [GitHub interface](https://github.com/meilisearch/instant-meilisearch/releases).
+Once the changes are merged on `main`, you can publish the current draft release via the [GitHub interface](https://github.com/meilisearch/instant-meilisearch/releases): on this page, click on `Edit` (related to the draft release) > update the description (be sure you apply [these recommandations](https://github.com/meilisearch/integration-guides/blob/main/resources/integration-release.md#writting-the-release-description)) > when you are ready, click on `Publish release`.
 
 GitHub Actions will be triggered and push the package to [npm](https://www.npmjs.com/package/@meilisearch/instant-meilisearch).
 

README.md

@@ -584,7 +584,7 @@ The `refinementList` widget is one of the most common widgets you can find in a
 
 - ✅ container: The CSS Selector or HTMLElement to insert the refinements. _required_
 - ✅ attribute: The facet to display _required_
-- ✅ operator: How to apply facets, "AND" or "OR"
+- ❌ operator: How to apply facets, "AND" or "OR". For the moment it only works with "AND"
 - ✅ limit: How many facet values to retrieve.
 - ✅ showMore: Whether to display a button that expands the number of items.
 - ✅ showMoreLimit: The maximum number of displayed items. Does not work when showMoreLimit > limit.

bors.toml

@@ -1,3 +1,8 @@
-status = ['integration-tests', 'style-check', 'cypress-run']
+status = [
+  'style-check',
+  'integration-tests (Node.js 12)',
+  'integration-tests (Node.js 14)',
+  'cypress-run'
+]
 # 1 hour timeout
 timeout-sec = 3600

package.json

@@ -54,11 +54,11 @@
     "url": "https://github.com/meilisearch/instant-meilisearch.git"
   },
   "dependencies": {
-    "meilisearch": "^0.22.1"
+    "meilisearch": "^0.22.3"
   },
   "devDependencies": {
-    "@babel/cli": "^7.15.7",
-    "@babel/core": "^7.15.8",
+    "@babel/cli": "^7.16.0",
+    "@babel/core": "^7.16.0",
     "@babel/preset-env": "^7.15.8",
     "@rollup/plugin-commonjs": "^17.1.0",
     "@rollup/plugin-node-resolve": "^11.2.0",
@@ -88,7 +88,7 @@
     "eslint-plugin-react": "^7.22.0",
     "eslint-plugin-standard": "^5.0.0",
     "eslint-plugin-vue": "^7.7.0",
-    "instantsearch.js": "^4.31.0",
+    "instantsearch.js": "^4.33.1",
     "jest": "^27.2.2",
     "jest-watch-typeahead": "^0.6.3",
     "prettier": "^2.0.0",

playgrounds/angular/src/app/app.component.ts

@@ -2,8 +2,8 @@ import { Component } from '@angular/core'
 import { instantMeiliSearch } from '../../../../src'
 
 const searchClient = instantMeiliSearch(
-  'https://demo-steam.meilisearch.com/',
-  '90b03f9c47d0f321afae5ae4c4e4f184f53372a2953ab77bca679ff447ecc15c'
+  'https://demos.meilisearch.com',
+  'dc3fedaf922de8937fdea01f0a7d59557f1fd31832cb8440ce94231cfdde7f25'
 )
 
 @Component({

playgrounds/geo-javascript/README.md

@@ -1,8 +1,8 @@
 # Javascript GeoSearch Playground
 
-To run this playground you will first have to set up your MeiliSearch accordingly to the playground needs. To do so please follow the steps in our [contributing guide](./CONTRIBUTING.md#-geo-search-playground).
+The provided Google Maps API Key is limited to 300 requests per day, so it might be down sometimes. In which case, 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`.
 
-The provided Google Maps Api Key is limited at 300 requests per day, so it might be down sometimes. In which case, 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`
+The same dataset is [downloadable here](https://github.com/meilisearch/datasets/tree/main/datasets/world_cities) if you want to try it out on your own MeiliSearch.
 
 ## Project setup
 

playgrounds/geo-javascript/index.html

@@ -16,11 +16,15 @@
 <body>
   <div class="ais-InstantSearch">
     <h1>MeiliSearch + InstantSearch.js</h1>
-    <h2>Search in European cities </h2>
+    <h2>Search in world cities </h2>
     <p>
-      This is a small dataset of 20 european cities around Lille in France.
+      This is a dataset of 32419 world cities with more than 10000 inhabitants.
     </p>
 
+    <div class="left-panel">
+      <div id="sort-by"></div>
+    </div>
+
     <div class="right-panel">
       <div id="searchbox" class="ais-SearchBox"></div>
       <div id="maps" style="height: 500px; width: 500px"></div>