# @coveo/relay-event-types

> Typescript types for Coveo Events, intended to be used with the Relay package.

Latest version **21.5.0** (published 2026-10-09) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @coveo/relay-event-types
pnpm add @coveo/relay-event-types
yarn add @coveo/relay-event-types
bun add @coveo/relay-event-types
```

## Health

**Score 65/100 (B)** — status: active.

Positive: has types; no vulnerabilities; recently updated; high maintenance score; high quality score.

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 21.5.0 |
| Published | 2026-10-09 |
| First published | 2023-11-06 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 17.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Coveo |
| Maintainers | oa-npmcoveo |
| Keywords | Coveo, analytics, relay, event, types |

## Links

- npm: https://www.npmjs.com/package/@coveo/relay-event-types
- Repository: https://github.com/coveo/analytics_schema
- Homepage: https://github.com/coveo/analytics_schema#readme
- Issues: https://github.com/coveo/analytics_schema/issues
- npm.io page: https://npm.io/package/@coveo/relay-event-types

## Alternatives

- [async-exit-hook](https://npm.io/package/async-exit-hook.md) — 3.7M weekly downloads
- [evnty](https://npm.io/package/evnty.md) — 7.2K weekly downloads
- [eleventy-plugin-asciidoc](https://npm.io/package/eleventy-plugin-asciidoc.md) — 3.5K weekly downloads
- [@jswork/next-get2get](https://npm.io/package/@jswork/next-get2get.md) — 945 weekly downloads
- [@dashersw/axon](https://npm.io/package/@dashersw/axon.md) — 934 weekly downloads

## Recent versions

- 21.5.0 (latest) — 2026-10-09
- 21.4.0 — 2026-10-08
- 21.3.0 — 2026-09-30
- 21.2.1 — 2026-09-30
- 21.2.0 — 2026-09-28
- 21.1.0 — 2026-09-25
- 21.0.1 — 2026-09-24
- 21.0.0 — 2026-09-22
- 20.7.1 — 2026-09-18
- 20.7.0 — 2026-09-17
- 20.6.1 — 2026-09-04
- 20.6.0 — 2026-08-28
- 20.5.3 — 2026-08-27
- 20.5.2 — 2026-08-26
- 20.5.1 — 2026-08-25
- … 222 more at https://npm.io/package/@coveo/relay-event-types/versions

## README

# Coveo Relay Event Types

This package contains automatically generated TypeScript types for Coveo's Event Protocol, and is intended to be used in conjunction with the Relay client side package.

## Installation

Install using `npm install @coveo/relay-event-types`

## Usage

Import desired event type, e.g. for an `itemClick` event:

```
import { ItemClick } from "@coveo/relay-event-types";

const myClickEvent:ItemClick  = {
    searchUid: '2ce196c1-5859-42da-b051-63e77ae2b406',
    position: 2,
    itemMetadata: {
        uniqueFieldName: 'permanentid',
        uniqueFieldValue: 'XDSC-566782'
    }
}
```

---
_Source: https://npm.io/package/@coveo/relay-event-types · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._