npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@elastic/search-ui-elasticsearch-connector

v1.21.5

Published

A Search UI connector for Elasticsearch

Downloads

18,801

Readme

search-ui-elasticsearch-connector

Part of the Search UI project.

This Connector is used to connect Search UI directly to Elasticsearch.

⚠️ Elasticsearch connector for Search UI is currently in technical preview status. It is not ready for production use. ⚠️

Usage

npm install --save @elastic/search-ui-elasticsearch-connector
import ElasticsearchAPIConnector from "@elastic/search-ui-elasticsearch-connector";

const connector = new ElasticsearchAPIConnector({
  cloud: {
    id: "<elastic-cloud-id>"
  },
  index: "search-ui-examples", // index name where the search documents are contained
  apiKey: "apiKeyExample" // Optional. apiKey used to authorize a connection to Elasticsearch instance.
  // This key will be visible to everyone so ensure its setup with restricted privileges.
  // See Authentication section for more details.
});

ElasticsearchAPIConnector

Kind: global class

new ElasticsearchAPIConnector(options)

| Param | Type | | ------- | -------------------------------- | | options | Options |

Options

Kind: global typedef

| Param | Type | Default | Description | | ------ | ------------------- | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | | cloud | Object | { id: string } | Elastic cloud configuration. Can be found in your cloud deployment dashboard. | | host | string | | Elasticsearch host. | | index | string | | Index name for where the search documents are contained in | | apiKey | string | | Optional. Credential thats setup within Kibana's UI. see kibana API keys guide. |

Query Configuration Requirements

  • search_fields object is required with all fields you want to search by.

Connection & Authentication

This connector will talk to the elasticsearch instance directly from the browser. This requires further additional steps to keep your Elasticsearch instance secure as possible. You have the following options available to you to keep any sensitive data protected

Proxy the _search API call through your API

This envolves building an API route that will proxy the elasticsearch call through your API. During the proxy, you are able to:

  • Ability to add any additional authentication headers / keys as you proxy the request through the API and to Elasticsearch.
  • Update the elasticsearch query request to add any filters to filter restricted documents
  • Application performance monitoring of functionality
  • Your own user based authentication for your API
  • Add a caching layer between the API and Elasticsearch

To do this, provide the host to be the location of the API. Example host: "https://search.acme.co/search", index: "movies". In this example, you would need to implement a POST endpoint for https://search.acme.co/search/movies/_search . When the connector performs a network request, the Elasticsearch Query DSL will be contained within the body.

Use an Elasticsearch api-key

You can restrict access to indices via an api-key. See kibana API keys guide