# @atlaskit/json-ld-types

> A set of types for the Atlassian Object Vocabulary

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

## Install

```sh
npm install @atlaskit/json-ld-types
pnpm add @atlaskit/json-ld-types
yarn add @atlaskit/json-ld-types
bun add @atlaskit/json-ld-types
```

## Health

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

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

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 2.1.0 |
| Published | 2026-10-16 |
| First published | 2025-03-25 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 39.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Atlassian Pty Ltd |
| Maintainers | atlassianartifactteam |

## Links

- npm: https://www.npmjs.com/package/@atlaskit/json-ld-types
- Repository: https://bitbucket.org/atlassian/atlassian-frontend-monorepo
- Homepage: https://bitbucket.org/atlassian/atlassian-frontend-monorepo#readme
- Issues: https://bitbucket.org/atlassian/atlassian-frontend-monorepo/issues
- npm.io page: https://npm.io/package/@atlaskit/json-ld-types

## Dependencies (2)

- [schema-dts](https://npm.io/package/schema-dts.md) ^0.5.1
- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.0.0

## Recent versions

- 2.1.0 (latest) — 2026-10-16
- 2.0.1 — 2026-08-05
- 2.0.0 — 2026-06-16
- 1.5.1 — 2026-06-01
- 1.5.0 — 2026-05-21
- 1.4.1 — 2025-08-25
- 1.4.0 — 2025-06-30
- 1.3.0 — 2025-06-26
- 1.2.0 — 2025-04-24
- 1.1.0 — 2025-04-08
- 1.0.0 — 2025-03-25

## README

# JSON-LD Types

A set of types for the Atlassian Object Vocabulary defined at
[Atlassian Object Vocabulary](https://product-fabric.atlassian.net/wiki/spaces/SL/pages/460753040/Atlassian+Object+Vocabulary+JSON-LD).

Detailed docs and example usage can be found [here](https://atlaskit.atlassian.com/packages/linking-platform/json-ld-types).


### Usage

```typescript
import { JsonLd } from '@atlaskit/json-ld-types';

const file: JsonLd.Object<JsonLd.Meta.Granted, JsonLd.Data.TextDocument> = {
    meta: {
        access: 'granted',
        visibility: 'restricted',
        auth: [],
        definitionId: 'confluence-object-provider',
    },
    data: {
        '@context': {
            '@vocab': 'https://www.w3.org/ns/activitystreams#',
            atlassian: 'https://schema.atlassian.com/ns/vocabulary#',
            schema: 'http://schema.org/',
        },
        generator: {
            '@type': 'Application',
            '@id': 'https://www.atlassian.com/#Confluence',
            name: 'Confluence',
        },
        '@type': ['Document', 'schema:TextDigitalDocument'],
        url: 'https://product-fabric.atlassian.net/wiki/spaces/SL/pages/876610663/Github+Object+provider',
        name: 'Github Object provider',
        summary: 'This page is within the Smart Links space',
    },
};
```

Owned by Bandicoots team #help-twg-integrations-and-linking

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