Gathering detailed insights and metrics for @oada/formats-server
Gathering detailed insights and metrics for @oada/formats-server
Simplified approach to OADA formats that actually uses JSON Schema
Installations
npm install @oada/formats-serverDeveloper Guide
BETA
Typescript
No
Module System
ESM
Releases
Unable to fetch releases
Languages
5
TypeScript
Ruby
EJS
HTML
Perl
TypeScript (99.67%)
Ruby (0.17%)
EJS (0.09%)
HTML (0.04%)
Perl (0.03%)
Developer
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
3 Stars
298 Commits
1 Forks
11 Watchers
44 Branches
10 Contributors
Updated on Jul 01, 2024
Maintainers
8
Package Meta Information
Latest Version
4.0.0
Package Id
@oada/formats-server@4.0.0
Unpacked Size
12.77 kB
Size
4.67 kB
File Count
20
Published on
Apr 05, 2024
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
2
Peer Dependencies
3
Dev Dependencies
6
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.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
SAST tool detected but not run on all commits
Details
- Info: SAST configuration detected: CodeQL
- Warn: 0 commits out of 2 are checked with a SAST tool
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
Found 0/28 approved changesets -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/codeql-analysis.yml:1
- Warn: no topLevel permission defined: .github/workflows/lerna-canary-dev.yml:1
- Warn: no topLevel permission defined: .github/workflows/nodejs.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
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
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
32 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-cr5q-6q9f-rq6q
- Warn: Project is vulnerable to: GHSA-j6gc-792m-qgm2
- Warn: Project is vulnerable to: GHSA-pj73-v5mw-pm9j
- Warn: Project is vulnerable to: GHSA-5w6v-399v-w3cc
- Warn: Project is vulnerable to: GHSA-mrxw-mxhj-p664
- Warn: Project is vulnerable to: GHSA-r95h-9x8f-r3f7
- Warn: Project is vulnerable to: GHSA-vvfq-8hwr-qm4m
- Warn: Project is vulnerable to: GHSA-xc9x-jj77-9p9j
- Warn: Project is vulnerable to: GHSA-2rxp-v6pw-ch6m
- Warn: Project is vulnerable to: GHSA-4xqq-m2hx-25v8
- Warn: Project is vulnerable to: GHSA-5866-49gr-22v4
- Warn: Project is vulnerable to: GHSA-r55c-59qm-vjw6
- Warn: Project is vulnerable to: GHSA-vg3r-rm7w-2xgh
- Warn: Project is vulnerable to: GHSA-vmwr-mc7x-5vc3
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
- Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q
- Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38
- Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc
- Warn: Project is vulnerable to: GHSA-8hc4-vh64-cxmj
- Warn: Project is vulnerable to: GHSA-jr5f-v2jv-69x6
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-ghr5-ch3p-vcr6
- Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h
- Warn: Project is vulnerable to: GHSA-rrr8-f88r-h8q6
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Score
3.2
/10
Last Scanned on 2025-07-07
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