npmpackage.info

Gathering detailed insights and metrics for @oada/formats

Other packages similar to @oada/formats

@oada/formats-server

4.0.0

OADA formats server plugins

@oada/types

4.0.0

TypeScript type definitions for OADA formats

@oada/media-types

4.0.0

OADA formats media type resolution

oada-formats

1.5.2

Format defintions, schemas, validators, and models for data.

Gathering detailed insights and metrics for @oada/formats

@oada/formats - 4.1.0 | npmpackage.info

@oada/formats

Simplified approach to OADA formats that actually uses JSON Schema

4.1.0

MIT

TypeScript

35.00 kB

3.2

Installations

npm install @oada/formats

Developer Guide

BETA

Typescript

No

Module System

ESM

Pull Requests

Open

29

Total

75

Closed

26

Merged

20

Issues

Open

3

Total

6

Closed

3

Releases

Unable to fetch releases

Languages

TypeScript

Ruby

EJS

HTML

Perl

TypeScript (99.67%)

Ruby (0.17%)

EJS (0.09%)

HTML (0.04%)

Perl (0.03%)

Developer

OADA

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

3 Stars

298 Commits

1 Forks

11 Watchers

44 Branches

10 Contributors

Updated on Jul 01, 2024

Maintainers

View All 10 Contributors

Package Meta Information

Latest Version

4.1.0

Package Id

@oada/formats@4.1.0

Unpacked Size

35.00 kB

Size

10.33 kB

File Count

Published on

Apr 05, 2024

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@apidevtools/json-schema-ref-parser @oada/media-types @oada/schemas ajv ajv-formats ajv-formats-draft2019 axios tslib

Dev Dependencies

@ava/typescript @types/debug @types/mkdirp @types/node @types/yargs ava c8 debug jsonschema8 mkdirp yargs

OADA Formats

This is a mono-repo for all things relating to OADA formats. It uses yarn workspaces. The purpose of this repo is to act as an inventory of known OADA API and ag data formats. These formats are represented as JSON Schema.

Schemas

The JSON Schema files are publicly available from https://formats.openag.io/. The $id of our schemas is also the URL at which it is available for download (i.e., if you configure your JSON Schema tool to resolve $refs via HTTP, you can reference our schemas with no further effort.). This makes the schemas/formats useful to any of the many environments which have JSON Schema implementations available.

A caveat about schema files

To have TypeScript sanity check the formats of our schemas for us, we wrap our JSON Schemas in TypeScript modules.

1// Somewhat opinionated TypeScript type definitions for JSON Schema
2import type { JSONSchema8 as Schema } from 'jsonschema8';
3
4const schema: Schema = {
5  /* The actual JSON Schema */
6};
7
8/**
9 * Simply exports an object of the schema,
10 * but now TS understands what it is and how it should look.
11 */
12export = schema;

The original intention was to simply have JSON files of the JSON Schema, but the convenience of having TypeScript check our schemas for us motivated this compromise. The published versions of the schemas have this wrapping removed and are pure JSON Schema.

Adding formats

All that is needed to add a format is to create a new .schema.ts file within schemas which exports valid JSON Schema. You can easily add the file for your new format with hygen:

1hygen format new your/format/name

Testing formats

Our test suite will automatically sanity-check all formats (including your new ones). Schemas are (among other checks) checked against the meta-schema, and expected to match any examples they have.

You are strongly encouraged to add examples to your new formats. Additionally, if you create a .schema.spec.cts file for your format, any mocha tests in it will run with the test suite.

JavaScript/TypeScript libraries

This project is chiefly a collection of pure JSON Schema schemata, but there are also node libraries for utilizing the schemas in TypeScript/JavaScript under packages.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

7

SAST

Determines if the project uses static code analysis.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/OADA/formats/codeql-analysis.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/OADA/formats/codeql-analysis.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:53: update your workflow using https://app.stepsecurity.io/secureworkflow/OADA/formats/codeql-analysis.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:67: update your workflow using https://app.stepsecurity.io/secureworkflow/OADA/formats/codeql-analysis.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lerna-canary-dev.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/OADA/formats/lerna-canary-dev.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lerna-canary-dev.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/OADA/formats/lerna-canary-dev.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lerna-canary-dev.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/OADA/formats/lerna-canary-dev.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lerna-canary-dev.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/OADA/formats/lerna-canary-dev.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nodejs.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/OADA/formats/nodejs.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nodejs.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/OADA/formats/nodejs.yml/master?enable=pin
Info: 0 out of 10 GitHub-owned GitHubAction dependencies pinned

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

3.2

/10

Last Scanned on 2025-07-14

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More