Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/elastic/workplace-search-node
Elastic Workplace Search Official Node.js Client
https://github.com/elastic/workplace-search-node
api-client elastic elastic-enterprise-search elastic-workplace-search javascript node node-client search swiftype
Last synced: 3 months ago
JSON representation
Elastic Workplace Search Official Node.js Client
- Host: GitHub
- URL: https://github.com/elastic/workplace-search-node
- Owner: elastic
- License: apache-2.0
- Created: 2017-06-29T17:39:11.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-08-08T11:19:43.000Z (5 months ago)
- Last Synced: 2024-10-04T01:16:21.944Z (3 months ago)
- Topics: api-client, elastic, elastic-enterprise-search, elastic-workplace-search, javascript, node, node-client, search, swiftype
- Language: JavaScript
- Homepage: https://www.elastic.co/workplace-search
- Size: 87.9 KB
- Stars: 8
- Watchers: 29
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
> **⚠️ This client is deprecated ⚠️**
>
> As of Enterprise Search version 8.2.0, we are directing users to the new [Enterprise Search Node Client](https://github.com/elastic/enterprise-search-js) and
> deprecating this client.
>
> Our development effort on this project will be limited to bug fixes.
> All future enhancements will be focused on the Enterprise Search Node Client.
>
> Thank you! - Elastic
> A first-party Node.js client for [Elastic Workplace Search](https://www.elastic.co/workplace-search).
## Contents
- [Getting started](#getting-started-)
- [Usage](#usage)
- [FAQ](#faq-)
- [Contribute](#contribute-)
- [License](#license-)
---
## Getting started 🐣
With npm:
```bash
npm install @elastic/workplace-search-node
```
or clone locally:
```bash
git clone [email protected]:elastic/workplace-search-node.git
cd workplace-search-node
npm install
```
## Usage
Create a new instance of the Elastic Workplace Search Client with your access token:
```javascript
const WorkplaceSearchClient = require('@elastic/workplace-search-node')
const accessToken = '' // your access token
const client = new WorkplaceSearchClient(accessToken)
```
### Change API endpoint
```javascript
const client = new WorkplaceSearchClient(
accessToken,
'https://your-server.example.com/api/ws/v1'
)
```
### Indexing Documents
This example shows how to use the indexDocuments method:
```javascript
const contentSourceKey = '' // your content source key
const documents = [
{
id: 1234,
title: '5 Tips On Finding A Mentor',
body:
'The difference between a budding entrepreneur who merely shows promise and one who is already enjoying some success often comes down to mentoring.',
url: 'https://www.shopify.com/content/5-tips-on-finding-a-mentor'
},
{
id: 1235,
title: 'How to Profit from Your Passions',
body:
'Want to know the secret to starting a successful business? Find a void and fill it.',
url: 'https://www.shopify.com/content/how-to-profit-from-your-passions'
}
]
client
.indexDocuments(contentSourceKey, documents)
.then(results => {
// handle results
})
.catch(error => {
// handle error
})
```
### Destroying Documents
```javascript
const contentSourceKey = '' // your content source key
const documentIds = [1234, 1235]
client
.destroyDocuments(contentSourceKey, documentIds)
.then(destroyDocumentsResults => {
// handle destroy documents results
})
.catch(error => {
// handle error
})
```
### Listing all permissions
```javascript
const contentSourceKey = '' // your content source key
const pageParams = { currentPage: 2, pageSize: 20 } // optional argument
client
.listAllPermissions(contentSourceKey, pageParams)
.then(response => {
// handle response
})
.catch(error => {
// handle error
})
```
### Getting user permissions
```javascript
const contentSourceKey = '' // your content source key
const user = 'enterprise_search' // username
client
.getUserPermissions(contentSourceKey, user)
.then(response => {
// handle response
})
.catch(error => {
// handle error
})
```
### Updating user permissions
```javascript
const contentSourceKey = '' // your content source key
const user = 'enterprise_search' // username
const permissions = { permissions: ['permission1', 'permission2'] } // permissions to assign to the user
client
.updateUserPermissions(contentSourceKey, user, permissions)
.then(response => {
// handle response
})
.catch(error => {
// handle error
})
```
### Adding user permissions
```javascript
const contentSourceKey = '' // your content source key
const user = 'enterprise_search' // username
const permissions = { permissions: ['permission2'] } // permissions to add to the user
client
.addUserPermissions(contentSourceKey, user, permissions)
.then(response => {
// handle response
})
.catch(error => {
// handle error
})
```
### Remove user permissions
```javascript
const contentSourceKey = '' // your content source key
const user = 'enterprise_search' // username
const permissions = { permissions: ['permission2'] } //permissions to remove from the user
client
.removeUserPermissions(contentSourceKey, user, permissions)
.then(response => {
// handle response
})
.catch(error => {
// handle error
})
```
## Running tests
Run tests via npm:
```bash
$ npm test
```
## FAQ 🔮
### Where do I report issues with the client?
If something is not working as expected, please open an [issue](https://github.com/elastic/workplace-search-node/issues/new).
## Contribute 🚀
We welcome contributors to the project. Before you begin, a couple notes...
- Before opening a pull request, please create an issue to [discuss the scope of your proposal](https://github.com/elastic/workplace-search-node/issues).
- Please write simple code and concise documentation, when appropriate.
## License 📗
[Apache 2.0](https://github.com/elastic/workplace-search-node/blob/master/LICENSE.txt) © [Elastic](https://github.com/elastic)
Thank you to all the [contributors](https://github.com/elastic/workplace-search-node/graphs/contributors)!