@searchkit/api - npm Package Compare versions

Comparing version 4.7.1 to 4.7.2

package.json

 {
   "name": "@searchkit/api",
-  "version": "4.7.1",
+  "version": "4.7.2",
   "main": "./dist/index.js",
@@ -43,3 +43,3 @@ "module": "./dist/index.mjs",
   "dependencies": {
-    "searchkit": "^4.7.1"
+    "searchkit": "^4.7.2"
   },
@@ -46,0 +46,0 @@ "devDependencies": {

README.md

@@ -30,2 +30,7 @@ # Elasticsearch Search UI Components
 
+## Code Examples (on Github)
+* [Searchkit with Next.JS](https://github.com/searchkit/searchkit/tree/main/examples/with-ui-nextjs-react)
+* [Searchkit with Javascript](https://github.com/searchkit/searchkit/tree/main/examples/with-ui-instantsearchjs)
+* [Searchkit with Vue](https://github.com/searchkit/searchkit/tree/main/examples/with-ui-vue)
+
 ## Components Docs
@@ -40,4 +45,6 @@ * [Searchkit Instantsearch Components](https://www.searchkit.co/docs/components/refinements/refinement-list)
 ## Codesandbox Examples
-* [Searchkit with JS Widgets](https://codesandbox.io/s/searchkit-quick-start-js-widgets-4xopy5?file=/index.html)
-* [Searchkit with Vue](https://codesandbox.io/s/vue-example-3x7obs)
+* [Searchkit with JS Widgets](https://codesandbox.io/s/github/searchkit/searchkit/tree/main/examples/with-ui-instantsearchjs)
+* [Searchkit with Vue](https://codesandbox.io/s/github/searchkit/searchkit/tree/main/examples/with-ui-vue)
+* [Searchkit with Next.js](https://codesandbox.io/s/github/searchkit/searchkit/tree/main/examples/with-ui-nextjs-react)
+* [Proxy with Express.js](https://codesandbox.io/s/github/searchkit/searchkit/tree/main/examples/proxy-elasticsearch/with-express-typescript-esm)
 
@@ -49,3 +56,3 @@ ## Video Tutorials
 ## Tutorials
-* [Searchkit with Next.js](https://www.searchkit.co/tutorials)
+* [Searchkit with Next.js](https://www.searchkit.co/tutorials/with-nextjs)
 * [Searchkit with Availability Search](https://www.searchkit.co/tutorials/build-availability-search-ui)
@@ -139,3 +146,3 @@
 
-Searchkit compatible with all Instantsearch frameworks. Below is an example using react-instantsearch-dom.
+Searchkit compatible with all Instantsearch frameworks. Below is an example using react-instantsearch-hooks-web.
 
@@ -147,7 +154,16 @@ ```tsx
 // import your InstantSearch components
-import { InstantSearch, SearchBox, Hits, RefinementList, Pagination, NumericMenu } from 'react-instantsearch-dom';
+import { InstantSearch, SearchBox, Hits, RefinementList, Pagination, RangeInput } from 'react-instantsearch-hooks-web';
 
 const sk = new Searchkit({
   connection: {
-    host: 'http://localhost:9200'
+    host: 'http://localhost:9200',
+    // with an apiKey
+    // https://www.searchkit.co/docs/guides/setup-elasticsearch#connecting-with-api-key
+    // apiKey: '##########'
+    // with a username/password
+    // https://www.searchkit.co/docs/guides/setup-elasticsearch#connecting-with-usernamepassword
+    //auth: {
+    //  username: "elastic",
+    //  password: "changeme"
+    //}
   },
@@ -175,10 +191,3 @@ search_settings: {
       <RefinementList attribute="actors" searchable={true} limit={10} />
-      <NumericMenu
-        attribute="imdbrating"
-        items={[
-          { label: '5 - 7', start: 5, end: 7 },
-          { label: '7 - 9', start: 7, end: 9 },
-          { label: '>= 9', start: 9 },
-        ]}
-      />
+      <RangeInput attribute="imdbrating" />
     </div>
@@ -205,3 +214,3 @@ <div className="right-panel">
 // import your InstantSearch components
-import { InstantSearch, SearchBox, Hits, RefinementList, Pagination, NumericMenu } from 'react-instantsearch-dom';
+import { InstantSearch, SearchBox, Hits, RefinementList, Pagination, RangeInput } from 'react-instantsearch-hooks-web';
 
@@ -220,10 +229,3 @@ const searchClient = Client({
       <RefinementList attribute="actors" searchable={true} limit={10} />
-      <NumericMenu
-        attribute="imdbrating"
-        items={[
-          { label: '5 - 7', start: 5, end: 7 },
-          { label: '7 - 9', start: 7, end: 9 },
-          { label: '>= 9', start: 9 },
-        ]}
-      />
+      <RangeInput attribute="imdbrating" />
     </div>
@@ -270,2 +272,7 @@ <div className="right-panel">
 
+### Proxy Elasticsearch Quick Starts
+* [Searchkit with Next.js Functions](https://www.searchkit.co/docs/proxy-elasticsearch/with-next-js)
+* [Searchkit with Cloudflare Workers](https://www.searchkit.co/docs/proxy-elasticsearch/with-cloudflare-workers)
+* [Searchkit with Express.js](https://www.searchkit.co/docs/proxy-elasticsearch/with-express-js)
+
 ## Query Rules
@@ -305,3 +312,6 @@
 
+read more at [Query Rules](https://www.searchkit.co/docs/query-rules) docs.
+
 ### NPM Packages
+* Searchkit [Documentation](https://www.searchkit.co/docs/api-documentation/searchkit)
 * @searchkit/api [Documentation](https://www.searchkit.co/docs/api-documentation/api)
@@ -314,3 +324,3 @@ * @searchkit/instantsearch-client [Documentation](https://www.searchkit.co/docs/api-documentation/instantsearch-client)
 
-No you don't. You can use Searchkit API to proxy requests to Elasticsearch. The XHR requests will provide the search state to the Searchkit Node API, which will then transform the request into elasticsearch queries and perform them to Elasticsearch.
+Searchkit proxies requests to Elasticsearch.
 
@@ -317,0 +327,0 @@ Searchkit offers both options, either perform the search directly from the browser, or use the Searchkit API to proxy requests to Elasticsearch. Directly from the browser offers great developer experience & prototyping. Once you are ready to deploy, you can use the Searchkit API to proxy requests to Elasticsearch.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

21256

increased by4.89%

Number of lines in readme file

333

increased by3.1%

Dependency changes

• Updatedsearchkit@^4.7.2