# schema-2.0

> Generator scripts for Schema repository for ObserveRTC

Latest version **2.0.0-beta.1** (published 2022-04-10) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install schema-2.0
pnpm add schema-2.0
yarn add schema-2.0
bun add schema-2.0
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0-beta.1 |
| Published | 2022-04-10 |
| First published | 2022-04-10 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 2.7 MB |
| Known vulnerabilities | 0 (+11 in 1 direct dependencies) |
| Install scripts | no |
| Author | Balazs Kreith |
| Maintainers | balazskreith |
| Keywords | observertc, schemas |

## Links

- npm: https://www.npmjs.com/package/schema-2.0
- npm.io page: https://npm.io/package/schema-2.0

## Dependencies (5)

- [avro-js](https://npm.io/package/avro-js.md) ^1.10.2
- [typedoc](https://npm.io/package/typedoc.md) ^0.22.12
- [argparse](https://npm.io/package/argparse.md) ^2.0.1
- [protobufjs](https://npm.io/package/protobufjs.md) ^6.11.2
- [json-schema-to-markdown](https://npm.io/package/json-schema-to-markdown.md) ^1.1.1

## Alternatives

- [@regle/core](https://npm.io/package/@regle/core.md) — 47.0K weekly downloads
- [typeof-arguments](https://npm.io/package/typeof-arguments.md) — 12.5K weekly downloads
- [@lokalise/projects-engine-contracts](https://npm.io/package/@lokalise/projects-engine-contracts.md) — 978 weekly downloads
- [@osjwnpm/nam-laboriosam-quibusdam](https://npm.io/package/@osjwnpm/nam-laboriosam-quibusdam.md) — 70 weekly downloads
- [@oridune/validator](https://npm.io/package/@oridune/validator.md) — 16 weekly downloads

## Recent versions

- 2.0.0-beta.1 (latest) — 2022-04-10

## README

## ObserveRTC Schemas

This repository contains schemas for ObserveRTC.

## Use the Schema

For npm projects:

```javascript
npm i @observertc/schemas
```

### Change the schema

#### Schema change requests

[Create an issue](https://github.com/ObserveRTC/schemas/issues/new?assignees=&labels=&template=schema-change-request.md) and state the request.

#### Create PR for schema changes

Discussion is good to request a schema, PR is better.
Step to create a PR (after you cloned the repo):
1. create your branch
2. change the [source of the schemas](/sources), `sources/version.txt`, trace the change in the `sources/CHANGELOG.md`.
3. Generate `npm-lib` typescripts (see below)
4. open the PR

### Generate npm-lib typescripts

To run the schema generator for npm-lib:

```javascript
  git clone https://github.com/observertc/schemas && \
  cd schemas && \
  npm i && \
  node index.js
```

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