@coveo/headless
Advanced tools
[](https://badge.fury.io/js/@coveo%2Fheadless)
Using the library: Coveo Headless Library Official Documentation.
The @coveo/headless package exposes several entry points.
The entry point from which you will import Coveo Headless resources depends on the engine type you are using:
| Engine type | Entry point |
|---|---|
| Search engine | @coveo/headless |
| Search SSR engine | @coveo/headless/ssr |
| CaseAssist engine | @coveo/headless/case-assist |
| Commerce engine | @coveo/headless/commerce |
| Commerce SSR engine | @coveo/headless/ssr-commerce |
| Insight engine | @coveo/headless/insight |
| Recommendation engine | @coveo/headless/recommendation |
Once you have cloned the repo, follow the instructions in the top-level README.md to install dependencies and link packages.
To start the project in development mode, run:
npm run dev
To build the library for production, run:
npm run build
To run the unit tests, run:
npm test
To run the unit tests and watch, run:
npm run test:watch
To use @coveo/headless locally, you have to build the package by running:
npm run build
The headless project intensively uses "Redux" along with "Redux Toolkit", so prior knowledge is necessary.
The base of the /src folder should only contain exports.
/app contains app-wide setup: Redux store, root reducer, middlewares.
/state contains interfaces for the various application states.
/features has folders that each owns the functionalities of a feature, which is a subpart of the redux state. Following the "ducks pattern", those files contain Redux slices & reducers that define the state shape. Each feature folder has a file with actions that can be exported with the project.
/controllers contains all the headless controllers in folders. Those controllers are exported and used to provide abstraction from the store's features by being closer to the actual UI controllers of a customer's application.
/utils contains common useful utilities.
/api contains everything regarding api calls.
/test contains test mocks.
Please see the contributor guide for guidance.
Please see the contributor guide for guidance.
FAQs
[](https://badge.fury.io/js/@coveo%2Fheadless)
The npm package @coveo/headless receives a total of 15,962 weekly downloads. As such, @coveo/headless popularity was classified as popular.
We found that @coveo/headless demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 16 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.