Skip to content

Commit 69e5235

Browse files
meili-bors[bot]meili-botbidoubiwa
authored
Merge #236
236: Changes related to the next Meilisearch release (v0.28.0) r=bidoubiwa a=meili-bot This PR gathers the changes related to the next Meilisearch release (v0.28.0) so that this package is ready when the official release is out. ⚠️ This PR should NOT be merged until: - the next release of Meilisearch (v0.28.0) is out. - the [`docs-searchbar.js`](https://github.com/meilisearch/docs-searchbar.js) dependency has been released to be compatible with Meilisearch v0.28.0. Once the release is out, the upgrade of the `docs-searchbar.js` dependency might be committed to this branch. _This PR is auto-generated for the [pre-release week](https://github.com/meilisearch/integration-guides/blob/master/guides/pre-release-week.md) purpose._ _Related to this issue: https://github.com/meilisearch/integration-guides/issues/205_ Co-authored-by: meili-bot <[email protected]> Co-authored-by: cvermand <[email protected]>
2 parents cfdc605 + c9b79ef commit 69e5235

File tree

11 files changed

+37
-20
lines changed

11 files changed

+37
-20
lines changed

.eslintrc.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ module.exports = {
1616
PLACEHOLDER: 'readonly',
1717
LAYOUT: 'readonly',
1818
DEBUG: 'readonly',
19-
ENABLE_DARK_MODE: 'readonly'
19+
ENABLE_DARK_MODE: 'readonly',
20+
CLIENT_AGENTS: 'readonly'
2021
},
2122
parserOptions: {
2223
parser: 'babel-eslint',

MeiliSearchBox.vue

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ export default {
3030
hostUrl: HOST_URL,
3131
apiKey: API_KEY,
3232
indexUid: INDEX_UID,
33+
clientAgents: CLIENT_AGENTS,
3334
meilisearchOptions: {
3435
limit:
3536
MAX_SUGGESTIONS || this.$site.themeConfig.searchMaxSuggestions || 5,

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ You can also find an example in our [playground's `palette.styl` file](./playgro
139139

140140
## Compatibility with Meilisearch
141141

142-
This package only guarantees the compatibility with the [version v0.27.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.27.0).
142+
This package only guarantees the compatibility with the [version v0.28.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.28.0).
143143

144144
## Development Workflow and Contributing
145145

client_agents.js

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
const { version } = require('./package.json')
2+
3+
const constructClientAgents = (clientAgents = []) => {
4+
const vuepressAgents = `Meilisearch Vuepress (v${version})`
5+
6+
return clientAgents.concat(vuepressAgents)
7+
}
8+
9+
module.exports = {
10+
constructClientAgents
11+
}

index.js

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
const path = require('path')
22

3+
const { constructClientAgents } = require('./client_agents')
4+
35
module.exports = (options) => {
46
return {
57
alias: {
@@ -15,7 +17,8 @@ module.exports = (options) => {
1517
CROP_LENGTH: options.cropLength || 30,
1618
LAYOUT: options.layout || 'columns',
1719
DEBUG: options.debug || false,
18-
ENABLE_DARK_MODE: options.enableDarkMode || false
20+
ENABLE_DARK_MODE: options.enableDarkMode || false,
21+
CLIENT_AGENTS: constructClientAgents(options.clientAgents) || []
1922
}
2023
}
2124
}

jest.config.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ module.exports = {
1616
CROP_LENGTH: 30,
1717
LAYOUT: 'columns',
1818
DEBUG: false,
19-
ENABLE_DARK_MODE: false
19+
ENABLE_DARK_MODE: false,
20+
CLIENT_AGENTS: []
2021
}
2122
}

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
},
1212
"main": "index.js",
1313
"dependencies": {
14-
"docs-searchbar.js": "^2.1.1"
14+
"docs-searchbar.js": "^2.2.0"
1515
},
1616
"resolutions": {
1717
"yargs-parser": "^13.1.2"

playground/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"setup": "node setup.js"
1010
},
1111
"dependencies": {
12-
"meilisearch": "^0.25.0",
12+
"meilisearch": "^0.27.0",
1313
"vuepress": "^1.4.1",
1414
"vuepress-theme-default-prefers-color-scheme": "^2.0.0"
1515
}

playground/setup.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,6 @@ const { MeiliSearch } = require('meilisearch')
213213

214214
const response = await index.addDocuments(dataset)
215215

216-
const task = await client.waitForTask(response.uid)
216+
const task = await client.waitForTask(response.taskUid)
217217
console.log(task)
218218
})()

playground/yarn.lock

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4837,10 +4837,10 @@ [email protected]:
48374837
resolved "https://registry.yarnpkg.com/media-typer/-/media-typer-0.3.0.tgz#8710d7af0aa626f8fffa1ce00168545263255748"
48384838
integrity sha1-hxDXrwqmJvj/+hzgAWhUUmMlV0g=
48394839

4840-
meilisearch@^0.25.0:
4841-
version "0.25.0"
4842-
resolved "https://registry.yarnpkg.com/meilisearch/-/meilisearch-0.25.0.tgz#8e980fbdd36b9fe6ed606205e262418f21e64d84"
4843-
integrity sha512-TSIJTh5lva7WHBaoG3arNYQXuIAQkcD3BY09h2nHhjHS/wzxWKJM45x5bEC67Grw8zXihVqqmWty4a4ps4S+tg==
4840+
meilisearch@^0.27.0:
4841+
version "0.27.0"
4842+
resolved "https://registry.yarnpkg.com/meilisearch/-/meilisearch-0.27.0.tgz#8bd57ddb77b975f93e054cb977b951c488ece297"
4843+
integrity sha512-kZOZFIuSO7c6xRf+Y2/9/h6A9pl0sCl/G44X4KuaSwxGbruOZPhmxbeVEgLHBv4pUFvQ56rNVTA/2d/5GCU1YA==
48444844
dependencies:
48454845
cross-fetch "^3.1.5"
48464846

yarn.lock

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3760,13 +3760,13 @@ dns-txt@^2.0.2:
37603760
dependencies:
37613761
buffer-indexof "^1.0.0"
37623762

3763-
docs-searchbar.js@^2.1.1:
3764-
version "2.1.1"
3765-
resolved "https://registry.yarnpkg.com/docs-searchbar.js/-/docs-searchbar.js-2.1.1.tgz#ed9519c0f39a99ad9d231963245e4fc81edd994b"
3766-
integrity sha512-K9QkhpLUi8KRoEoI8Gz7dOAYHSPUZ0uB3qb0QkWsq9cU+FAMCZPQoePfN9TObTKcX95AYQUXHV2cgd1StHYWrg==
3763+
docs-searchbar.js@^2.2.0:
3764+
version "2.2.0"
3765+
resolved "https://registry.yarnpkg.com/docs-searchbar.js/-/docs-searchbar.js-2.2.0.tgz#e60eb0ee4f67853c41fdf7d3a4ef6ac7ac2c8027"
3766+
integrity sha512-rleKMiTkxG14M+6yt3+H8H0w/GKxWsNMinf4+zTVz9aVi04oJ8u37kktTiW3qkpPl9VQ7/i7Yv9wykukMqVxfw==
37673767
dependencies:
37683768
autocomplete.js "^0.38.1"
3769-
meilisearch "^0.25.0"
3769+
meilisearch "^0.27.0"
37703770
to-factory "^1.0.0"
37713771
zepto "^1.2.0"
37723772

@@ -6673,10 +6673,10 @@ [email protected]:
66736673
resolved "https://registry.yarnpkg.com/media-typer/-/media-typer-0.3.0.tgz#8710d7af0aa626f8fffa1ce00168545263255748"
66746674
integrity sha1-hxDXrwqmJvj/+hzgAWhUUmMlV0g=
66756675

6676-
meilisearch@^0.25.0:
6677-
version "0.25.0"
6678-
resolved "https://registry.yarnpkg.com/meilisearch/-/meilisearch-0.25.0.tgz#8e980fbdd36b9fe6ed606205e262418f21e64d84"
6679-
integrity sha512-TSIJTh5lva7WHBaoG3arNYQXuIAQkcD3BY09h2nHhjHS/wzxWKJM45x5bEC67Grw8zXihVqqmWty4a4ps4S+tg==
6676+
meilisearch@^0.27.0:
6677+
version "0.27.0"
6678+
resolved "https://registry.yarnpkg.com/meilisearch/-/meilisearch-0.27.0.tgz#8bd57ddb77b975f93e054cb977b951c488ece297"
6679+
integrity sha512-kZOZFIuSO7c6xRf+Y2/9/h6A9pl0sCl/G44X4KuaSwxGbruOZPhmxbeVEgLHBv4pUFvQ56rNVTA/2d/5GCU1YA==
66806680
dependencies:
66816681
cross-fetch "^3.1.5"
66826682

0 commit comments

Comments
 (0)