# @ghentcdh/annotation-api

Latest version **0.0.1-alpha.26** (published 2026-10-21) · 0 weekly downloads

## Install

```sh
npm install @ghentcdh/annotation-api
pnpm add @ghentcdh/annotation-api
yarn add @ghentcdh/annotation-api
bun add @ghentcdh/annotation-api
```

## Health

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

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score.

Warnings: low downloads; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.0.1-alpha.26 |
| Published | 2026-10-21 |
| First published | 2026-06-24 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 233.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 0 |
| Maintainers | flamsens, joren_gcdh, bo_firepeak |

## Links

- npm: https://www.npmjs.com/package/@ghentcdh/annotation-api
- Repository: https://github.com/GhentCDH/annotation-editor
- npm.io page: https://npm.io/package/@ghentcdh/annotation-api

## Dependencies (1)

- [@ghentcdh/crouton-api](https://npm.io/package/@ghentcdh/crouton-api.md) 0.0.1-alpha.88

## Recent versions

- 0.0.1-alpha.26 (latest) — 2026-10-21
- 0.0.1-alpha.13 (alpha) — 2026-09-22
- 0.0.1-alpha.25 — 2026-10-05
- 0.0.1-alpha.24 — 2026-10-01
- 0.0.1-alpha.23 — 2026-10-01
- 0.0.1-alpha.22 — 2026-10-01
- 0.0.1-alpha.21 — 2026-10-01
- 0.0.1-alpha.20 — 2026-10-01
- 0.0.1-alpha.19 — 2026-10-01
- 0.0.1-alpha.18 — 2026-10-01
- 0.0.1-alpha.17 — 2026-10-01
- 0.0.1-alpha.16 — 2026-10-01
- 0.0.1-alpha.15 — 2026-09-23
- 0.0.1-alpha.14 — 2026-09-22
- 0.0.1-alpha.10 — 2026-07-10
- … 7 more at https://npm.io/package/@ghentcdh/annotation-api/versions

## README

[![Build](https://github.com/GhentCDH/annotation-editor/actions/workflows/merge-request.yml/badge.svg)](https://github.com/GhentCDH/annotation-editor/actions/workflows/merge-request.yml)
[![Publish](https://github.com/GhentCDH/annotation-editor/actions/workflows/publish.yml/badge.svg)](https://github.com/GhentCDH/annotation-editor/actions/workflows/publish.yml)
[![Publish Docs](https://github.com/GhentCDH/annotation-editor/actions/workflows/publish-docs.yml/badge.svg)](https://github.com/GhentCDH/annotation-editor/actions/workflows/publish-docs.yml)
[![annotation-core](https://img.shields.io/npm/v/@ghentcdh/annotation-core.svg?label=annotation-core)](https://www.npmjs.com/package/@ghentcdh/annotation-core)
[![annotation-api](https://img.shields.io/npm/v/@ghentcdh/annotation-api.svg?label=annotation-api)](https://www.npmjs.com/package/@ghentcdh/annotation-api)
[![annotation-vue](https://img.shields.io/npm/v/@ghentcdh/annotation-vue.svg?label=annotation-vue)](https://www.npmjs.com/package/@ghentcdh/annotation-vue)
[![Docs](https://img.shields.io/badge/docs-ghentcdh.github.io-blue)](https://ghentcdh.github.io/annotation-editor/)

# Annotation Editor

Monorepo for W3C-compliant annotation editing. Provides a NestJS API module for serving annotation definitions, a shared core library for types and validation, and a Vue 3 editor component for creating and managing annotations on text sources.

**Documentation:** https://ghentcdh.github.io/annotation-editor/

## Packages

| Package                     | Description                                                            |
|-----------------------------|------------------------------------------------------------------------|
| `@ghentcdh/annotation-core` | Shared types, Zod schemas, and configuration utilities                 |
| `@ghentcdh/annotation-vue`  | Vue 3 annotation editor and preview components (bundled, ready to use) |
| `@ghentcdh/annotation-api`  | NestJS module for serving annotation definitions                       |

## Getting started

See the [documentation](https://ghentcdh.github.io/annotation-editor/) for installation, configuration, and usage guides.

## Architecture

```
┌─────────────────────┐
│  annotation-vue     │  Vue 3 editor + preview components
│  (frontend)         │
└────────┬────────────┘
         │ uses types from
┌────────▼────────────┐
│  annotation-core    │  Shared types, Zod schemas, config
└────────┬────────────┘
         │ used by
┌────────▼────────────┐
│  annotation-api     │  NestJS module (serves definitions)
│  (backend)          │
└─────────────────────┘
```

- **annotation-core** — shared dependency used by both frontend and backend
- **annotation-api** — loads annotation definitions from JSON files and serves them via REST
- **annotation-vue** — renders sources and annotations, provides CRUD UI using the W3C annotation standard via `@ghentcdh/w3c-utils`

## Development

```bash
# Install dependencies
pnpm install

# Lint
pnpm nx affected -t lint --base=origin/main

# Test
pnpm nx affected -t test --base=origin/main

# Type check
pnpm nx affected -t typecheck --base=origin/main
```

---

## License

MIT — see [LICENSE](./LICENSE).

## Credits

Bo Vandersteene, Ghent University.

Development by [Ghent Centre for Digital Humanities — Ghent University](https://www.ghentcdh.ugent.be/). Funded by the [GhentCDH research projects](https://www.ghentcdh.ugent.be/projects).

<img src="https://www.ghentcdh.ugent.be/ghentcdh_logo_blue_text_transparent_bg_landscape.svg" alt="GhentCDH" width="500">

---
_Source: https://npm.io/package/@ghentcdh/annotation-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._