14.md (9833B)
1 # PR #14 Bump meilisearch from 0.23.0 to 0.24.0 2 3 - **Status:** merged 4 - **Author:** @dependabot[bot] 5 - **Created:** 2022-01-20T19:14:24Z 6 - **Branch:** dependabot/npm_and_yarn/meilisearch-0.24.0 → main 7 - **Merged:** 2022-01-20T21:11:41Z 8 - **Labels:** dependencies, javascript 9 - **Diff:** [14.diff](./14.diff) 10 11 --- 12 13 Bumps [meilisearch](https://github.com/meilisearch/meilisearch-js) from 0.23.0 to 0.24.0. 14 <details> 15 <summary>Release notes</summary> 16 <p><em>Sourced from <a href="https://github.com/meilisearch/meilisearch-js/releases">meilisearch's releases</a>.</em></p> 17 <blockquote> 18 <h2>v0.24.0 🌻</h2> 19 <p>This package version is compatible with <a href="https://github.com/meilisearch/MeiliSearch/releases/tag/v0.25.0">MeiliSearch v0.25.0</a> 🎉</p> 20 <h2>⚠️ Breaking changes</h2> 21 <ul> 22 <li>This package is only compatible with <a href="https://github.com/meilisearch/MeiliSearch/releases/tag/v0.25.0">MeiliSearch v0.25.0</a> and later, but not with v0.24.0 and older. Be sure you are using at least MeiliSearch v0.24.0 or newer before doing the upgrade. 23 Why isn't it compatible? 24 <ul> 25 <li>MeiliSearch v0.25.0 uses <code>Authorization</code> header instead of <code>X-Meili-API-Key</code></li> 26 <li>MeiliSearch v0.25.0 has a new API regarding the updates that have been renamed into tasks. More details in the following points</li> 27 </ul> 28 </li> 29 <li>Changes related to the new task API (<a href="https://github-redirect.dependabot.com/meilisearch/meilisearch-js/issues/1123">#1123</a>) <a href="https://github.com/bidoubiwa"><code>@bidoubiwa</code></a> Check out the <a href="https://docs.meilisearch.com/reference/api/tasks.html#tasks">task API references</a> and the <a href="https://docs.meilisearch.com/learn/advanced/asynchronous_operations.html#asynchronous-operations">asynchronous tasks guide</a> 30 <ul> 31 <li><code>createIndex</code>, <code>updateIndex</code> and <code>deleteIndex</code> are now asynchrone regarding MeiliSearch and do not return a <code>Index</code> instance anymore, but a task object. Please use <code>index()</code> method instead.</li> 32 <li>Rename <code>index.get_all_update_status</code> into <code>index.tasks</code></li> 33 <li>Rename <code>index.get_update_status</code> into <code>index.task</code></li> 34 <li><code>wait_for_pending_update</code> is renamed into <code>wait_for_task</code> and is accessible from <code>index</code> and from <code>client</code></li> 35 </ul> 36 </li> 37 <li>Remove <code>getOrCreateIndex</code> method (<a href="https://github-redirect.dependabot.com/meilisearch/meilisearch-js/issues/1125">#1125</a>) <a href="https://github.com/bidoubiwa"><code>@bidoubiwa</code></a></li> 38 <li>Remove <code>deleteIndexIfExists</code> method (<a href="https://github-redirect.dependabot.com/meilisearch/meilisearch-js/issues/1124">#1124</a>) <a href="https://github.com/bidoubiwa"><code>@bidoubiwa</code></a></li> 39 <li><code>client.getKeys()</code> does not return an object of keys, but an array of keys. Check out <a href="https://docs.meilisearch.com/reference/api/keys.html#keys">keys API references</a>.</li> 40 </ul> 41 <h2>🚀 Enhancements</h2> 42 <ul> 43 <li>Add API keys methods (<a href="https://github-redirect.dependabot.com/meilisearch/meilisearch-js/issues/1123">#1123</a>) <a href="https://github.com/bidoubiwa"><code>@bidoubiwa</code></a> 44 <ul> 45 <li><code>client.createKey()</code></li> 46 <li><code>client.updateKey()</code></li> 47 <li><code>client.deleteKey()</code></li> 48 <li><code>client.getKey()</code></li> 49 </ul> 50 </li> 51 </ul> 52 <p>Check out the <a href="https://docs.meilisearch.com/reference/features/security.html#security-and-permissions">documentation guide</a>.</p> 53 <ul> 54 <li>Add new methods <code>client.getTasks()</code> and <code>client.getTask()</code></li> 55 </ul> 56 <p>Thanks again to <a href="https://github.com/bidoubiwa"><code>@bidoubiwa</code></a>, <a href="https://github.com/alallema"><code>@alallema</code></a> and <a href="https://github.com/curquiza"><code>@curquiza</code></a> ! 🎉</p> 57 <h2>v0.24.0-beta.1</h2> 58 <p>This package version is compatible with <a href="https://github.com/meilisearch/MeiliSearch/releases/tag/v0.25.0rc3">MeiliSearch v0.25.0.rc3</a> 🎉</p> 59 <h2>⚠️ Breaking changes</h2> 60 <ul> 61 <li>Wrap keys results inside <code>results</code> object <a href="https://github-redirect.dependabot.com/meilisearch/meilisearch-js/issues/1132">#1132</a></li> 62 </ul> 63 <p>Thanks again to <a href="https://github.com/bidoubiwa"><code>@bidoubiwa</code></a>! 🎉</p> 64 <h2>v0.24.0-beta.0</h2> 65 <p>This package version is compatible with <a href="https://github.com/meilisearch/MeiliSearch/releases/tag/v0.25.0rc3">MeiliSearch v0.25.0.rc3</a> 🎉</p> 66 <h2>⚠️ Breaking changes</h2> 67 <ul> 68 <li>Changes related to the next MeiliSearch release (v0.24.0) (<a href="https://github-redirect.dependabot.com/meilisearch/meilisearch-js/issues/1108">#1108</a>)</li> 69 <li>Change update API to task API <a href="https://github-redirect.dependabot.com/meilisearch/meilisearch-js/issues/1123">#1123</a></li> 70 <li>Remove deleteIfExists method <a href="https://github-redirect.dependabot.com/meilisearch/meilisearch-js/issues/1124">#1124</a></li> 71 <li>Remove get or create index <a href="https://github-redirect.dependabot.com/meilisearch/meilisearch-js/issues/1125">#1125</a></li> 72 <li>Change key methods <a href="https://github-redirect.dependabot.com/meilisearch/meilisearch-js/issues/1123">#1123</a></li> 73 </ul> 74 <!-- raw HTML omitted --> 75 </blockquote> 76 <p>... (truncated)</p> 77 </details> 78 <details> 79 <summary>Commits</summary> 80 <ul> 81 <li><a href="https://github.com/meilisearch/meilisearch-js/commit/fbc87a4282114999eff3a62c4ff5969d888601a5"><code>fbc87a4</code></a> Merge <a href="https://github-redirect.dependabot.com/meilisearch/meilisearch-js/issues/1129">#1129</a></li> 82 <li><a href="https://github.com/meilisearch/meilisearch-js/commit/0f9765565f2ac581f6342c5ee1ec3455497fe568"><code>0f97655</code></a> build(deps-dev): bump <code>@rollup/plugin-node-resolve</code> from 13.0.6 to 13.1.3</li> 83 <li><a href="https://github.com/meilisearch/meilisearch-js/commit/aeb195d8e9bf9c6256d4d0ba7353a1840d1b2c49"><code>aeb195d</code></a> Merge <a href="https://github-redirect.dependabot.com/meilisearch/meilisearch-js/issues/1116">#1116</a> <a href="https://github-redirect.dependabot.com/meilisearch/meilisearch-js/issues/1120">#1120</a> <a href="https://github-redirect.dependabot.com/meilisearch/meilisearch-js/issues/1122">#1122</a></li> 84 <li><a href="https://github.com/meilisearch/meilisearch-js/commit/59e86d746e40c051de0688a9aee376293337fcae"><code>59e86d7</code></a> Merge <a href="https://github-redirect.dependabot.com/meilisearch/meilisearch-js/issues/1104">#1104</a></li> 85 <li><a href="https://github.com/meilisearch/meilisearch-js/commit/13380a6a1249dbde43fe2a9b81fa8434e6ed0a4c"><code>13380a6</code></a> Merge <a href="https://github-redirect.dependabot.com/meilisearch/meilisearch-js/issues/1108">#1108</a></li> 86 <li><a href="https://github.com/meilisearch/meilisearch-js/commit/45e329c60ec78fb9ebd953c79bd962a9f8e37097"><code>45e329c</code></a> Update tests/env/node/search_example.js</li> 87 <li><a href="https://github.com/meilisearch/meilisearch-js/commit/6d6e676eb5179e082d7520374a478968e3063823"><code>6d6e676</code></a> Update src/lib/indexes.ts</li> 88 <li><a href="https://github.com/meilisearch/meilisearch-js/commit/e58b509f07e3fdbf69e748da4e630d9297c6c162"><code>e58b509</code></a> Update src/lib/indexes.ts</li> 89 <li><a href="https://github.com/meilisearch/meilisearch-js/commit/63a83b08a7eb3cd059a1252bc4069f66385f0f66"><code>63a83b0</code></a> Update src/lib/indexes.ts</li> 90 <li><a href="https://github.com/meilisearch/meilisearch-js/commit/e2dd900e17413ac6827eddfb00cc85c9f19fd85e"><code>e2dd900</code></a> Update src/lib/indexes.ts</li> 91 <li>Additional commits viewable in <a href="https://github.com/meilisearch/meilisearch-js/compare/v0.23.0...v0.24.0">compare view</a></li> 92 </ul> 93 </details> 94 <br /> 95 96 97 [](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) 98 99 Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. 100 101 [//]: # (dependabot-automerge-start) 102 [//]: # (dependabot-automerge-end) 103 104 --- 105 106 <details> 107 <summary>Dependabot commands and options</summary> 108 <br /> 109 110 You can trigger Dependabot actions by commenting on this PR: 111 - `@dependabot rebase` will rebase this PR 112 - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it 113 - `@dependabot merge` will merge this PR after your CI passes on it 114 - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it 115 - `@dependabot cancel merge` will cancel a previously requested merge and block automerging 116 - `@dependabot reopen` will reopen this PR if it is closed 117 - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually 118 - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) 119 - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) 120 - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) 121 122 123 </details> 124 125 126 ## Comments 127 128 ### @MTRNord — 2022-01-20T20:22:56Z 129 130 @dependabot rebase 131 132 ### @MTRNord — 2022-01-20T20:59:26Z 133 134 @dependabot rebase 135