# @atlassian/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).

Latest version **1.1.3** (published 2020-03-20) · Apache-2.0 license · 0 weekly downloads

## Install

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

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.3 |
| Published | 2020-03-20 |
| First published | 2020-03-19 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 45.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | 1999-atlassian, akishore, amcculloch, atlassian-aui, bcytrowski, cdarroch, cwhittington, dboyd, dmorrow, doklovic, dwalker, gleal-atlassian, jmoynihan, jonycheung.atlassian, jvdl, macku, mdejongh, media-build-bot, mrzymski, mstaas, mszczepanski, mszpyra, plai1, prkb, r3d_f0x, sraj, tilwin_atlassian, wyasvoin, xqiu |

## Links

- npm: https://www.npmjs.com/package/@atlassian/json-ld-types
- npm.io page: https://npm.io/package/@atlassian/json-ld-types

## Dependencies (1)

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

## Recent versions

- 1.1.3 (latest) — 2020-03-20
- 1.1.2 — 2020-03-20
- 1.1.1 — 2020-03-20
- 1.1.0 — 2020-03-19

## 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).

### Usage

```typescript
import { JsonLd } from '@atlassian/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',
    },
};
```

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