search-ui-workplace-search-connector

Part of the Search UI project.

This Connector is used to connect Search UI to Elastic's Workplace Search API.

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

Usage

npm install --save @elastic/search-ui-workplace-search-connector

import WorkplaceSearchAPIConnector from "@elastic/search-ui-workplace-search-connector";

const connector = new WorkplaceSearchAPIConnector({
  kibanaBase: "https://search-ui-sandbox.kb.us-central1.gcp.cloud.es.io:9243",
  enterpriseSearchBase:
    "https://search-ui-sandbox.ent.us-central1.gcp.cloud.es.io",
  redirectUri: "http://localhost:3000",
  clientId: "8e495e40fc4e6acf515e557e634de39d4f727f7f60a3afed24a99ce316607c1e"
});

See the usage example in our sandbox app. The example uses a private Elastic Cloud deployment. Make sure to update the configuration values to use with your own Elastic Cloud deployment.

Authentication

The Workplace Search API requires authentication. This connector uses OAuth authentication. You can read more about that here and here.

Using this connector will populate two additional pieces of Application State:

isLoggedIn (boolean) - This can be used to determine whether or not a user is authenticated. Requests using this connector will only work if a user is authenticatied. If this is false, consider showing a "Login" link using the authorizeUrl state.

authorizeUrl (string) - This can be used to create a "Login" link for users to initiate OAuth authentication.

logout - (function) - This action can be used to log out user out of the search experience. Under the hood it 1) deletes the saved token from LocalStorage and 2) logs user out of Enterprise Search and Kibana to prevent the ability to get a new access token.

Classes

Typedefs

WorkplaceSearchAPIConnector

Kind: global class

new WorkplaceSearchAPIConnector(options)

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

next : function

Kind: global typedef

| Param | Type | Description | | ------------------- | ------------------- | ------------------------------ | | updatedQueryOptions | Object | The options to send to the API |

hook : function

Kind: global typedef

| Param | Type | Description | | ------------ | -------------------------- | ------------------------------------------------ | | queryOptions | Object | The options that are about to be sent to the API | | next | next | The options that are about to be sent to the API |

Options

Kind: global typedef

| Param | Type | Default | Description | | --------------------------------- | -------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | enterpriseSearchBase | string | | The publicly accessible url of the Enterprise Search deployment. | | kibanaBase | string | | The publicly accessible url for the Kibana deployment associated with the Enterprise Search deployment. Used for OAuth authentication. | | redirectUri | string | | The publicly accessible url of this Search UI deployment, which Kibana will redirect back to after successful OAuth authentication. Must match a URI as configured in the OAuth Application. | | clientId | string | | Client ID as generated when setting up the OAuth Application. | | beforeSearchCall | hook | (queryOptions,next)=>next(queryOptions) | A hook to amend query options before the request is sent to the API in a query on an "onSearch" event. | | beforeAutocompleteResultsCall | hook | (queryOptions,next)=>next(queryOptions) | A hook to amend query options before the request is sent to the API in a "results" query on an "onAutocomplete" event. | | beforeAutocompleteSuggestionsCall | hook | (queryOptions,next)=>next(queryOptions) | (Currently not supported as Workplace Search doesn't have a query suggestions API) A hook to amend query options before the request is sent to the API in a "suggestions" query on an "onAutocomplete" event. |