# @sap-ux/odata-vocabularies

> Supported OASIS and SAP vocabularies

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

## Install

```sh
npm install @sap-ux/odata-vocabularies
pnpm add @sap-ux/odata-vocabularies
yarn add @sap-ux/odata-vocabularies
bun add @sap-ux/odata-vocabularies
```

## Health

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

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

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 1.1.3 |
| Published | 2026-10-16 |
| First published | 2023-11-21 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=22.x |
| Dependencies | 1 |
| Unpacked size | 902.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 159 |
| Author | @SAP/ux-tools-team |
| Maintainers | tqueck, kranthie.sap, sap_extncrepos, sap-ospo-admin, devinea |

## Links

- npm: https://www.npmjs.com/package/@sap-ux/odata-vocabularies
- Repository: https://github.com/SAP/open-ux-tools
- Issues: https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Aodata-vocabularies
- npm.io page: https://npm.io/package/@sap-ux/odata-vocabularies

## Dependencies (1)

- [@sap-ux/odata-annotation-core-types](https://npm.io/package/@sap-ux/odata-annotation-core-types.md) 1.0.4

## Recent versions

- 1.1.3 (latest) — 2026-10-16
- 1.1.2 — 2026-09-22
- 1.1.1 — 2026-08-25
- 1.1.0 — 2026-08-06
- 1.0.5 — 2026-07-22
- 1.0.4 — 2026-07-03
- 1.0.3 — 2026-07-03
- 1.0.2 — 2026-06-23
- 1.0.1 — 2026-06-04
- 1.0.0 — 2026-05-30
- 0.5.1 — 2026-05-20
- 0.5.0 — 2026-05-15
- 0.4.31 — 2026-04-30
- 0.4.30 — 2026-03-30
- 0.4.29 — 2026-03-16
- … 46 more at https://npm.io/package/@sap-ux/odata-vocabularies/versions

## README

[![Changelog](https://img.shields.io/badge/changelog-8A2BE2)](https://github.com/SAP/open-ux-tools/blob/main/packages/odata-vocabularies/CHANGELOG.md) [![Github repo](https://img.shields.io/badge/github-repo-blue)](https://github.com/SAP/open-ux-tools/tree/main/packages/odata-vocabularies)

# [`@sap-ux/odata-vocabularies`](https://github.com/SAP/open-ux-tools/tree/main/packages/odata-vocabularies)

Library that contains the most recent copies of the OData vocabularies authored by OASIS and SAP

## Supported Vocabularies
[OASIS Vocabularies](https://oasis-tcs.github.io/odata-vocabularies)
* Aggregation
* Authorization
* Core
* Capabilities
* Measures
* Temporal
* Repeatability
* Validation
* JSON

[SAP Vocabularies](https://sap.github.io/odata-vocabularies) 
* Analytics
* Auditing
* CodeList
* Common
* Communication
* DataIntegration
* DirectEdit
* Graph
* Hierarchy
* HTML5
* ODM
* PDF
* PersonalData
* Session
* Support
* UI

## Maintaining Vocabularies

Use the `odata-vocabularies-sync` skill (`.agents/skills/odata-vocabularies-sync/SKILL.md`) via an AI agent:

- No argument — update all existing vocabularies to their latest published versions
- With a JSON URL (must end in `.json`, XML is not supported) — register a new vocabulary, then update all

## Local testing in tools-suite

To test local changes to this package inside the XML annotation language server of `tools-suite`, use [yalc](https://github.com/wclr/yalc). `pnpm link` does not work there because the language server is an esbuild bundle and dependencies are resolved at build time.

**Quick reference — after every change:**
```bash
# in open-ux-tools/packages/odata-vocabularies
pnpm --filter @sap-ux/odata-vocabularies build
yalc push

# in tools-suite root
yalc add @sap-ux/odata-vocabularies
yarn build:scope sap-ux-annotation-modeler-extension
# restart the Extension Host in VS Code
```

## Installation
Npm
`npm install --save @sap-ux/odata-vocabularies`

Yarn
`yarn add @sap-ux/odata-vocabularies`

Pnpm
`pnpm add @sap-ux/odata-vocabularies`


## Usage

1. Import the needed functions in your modules

    ```typescript
    import { VocabularyService } from '@sap-ux/odata-vocabularies';
    ```

## Vocabulary API
The vocabulary API is implemented via class VocabularyService and currently exposes the following functions:

* checkTermApplicability

* getComplexType
* getComplexTypeProperty
* getDerivedTypeNames
* getDocumentation
* getTerm
* getTermsForTargetKinds
* getType
* getVocabularies
* getVocabulary
* getVocabularyNamespace

---
_Source: https://npm.io/package/@sap-ux/odata-vocabularies · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._