npmpackage.info

@json-schema-tools/traverse

Traverse and optionally mutate a json schema and all it's subschema

1.10.4

Apache-2.0

TypeScript

1.13 kB

1,061,695 3.6

Installations

npm install @json-schema-tools/traverse

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

20.12.1

NPM Version

10.7.0 Score

89.6

Supply Chain

89.7

Quality

78.7

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

8

Total

801

Closed

683

Merged

110

Issues

Open

6

Total

12

Closed

6

Releases

1.10.4

Published on 07 May 2024

1.10.3

Published on 12 Mar 2024

1.10.2

Published on 11 Mar 2024

1.10.1

Published on 06 Oct 2022

1.10.0

Published on 05 Oct 2022

1.9.0

Published on 04 Oct 2022

View all 34 releases

Contributors

Unable to fetch Contributors

View all 4 contributors

Languages

TypeScript

Shell

JavaScript

TypeScript (97.79%)

Shell (1.16%)

JavaScript (1.05%)

Developer

json-schema-tools

Download Statistics

Total Downloads

1,061,695

Last Day

2,761

Last Week

10,354

Last Month

41,951

Last Year

628,489

GitHub Statistics

10 Stars

307 Commits

3 Forks

2 Watching

16 Branches

4 Contributors

Bundle Size

3.02 kB

Minified

1.13 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

1.10.4

Package Id

@json-schema-tools/traverse@1.10.4

Unpacked Size

25.78 kB

Size

8.08 kB

File Count

NPM Version

10.7.0

Node Version

20.12.1

Publised On

07 May 2024

Total Downloads

Cumulative downloads

Total Downloads

1,061,695

Last day

-4.3%

2,761

Compared to previous day

Last week

-15.7%

10,354

Compared to previous week

Last month

-1.5%

41,951

Compared to previous month

Last year

182.2%

628,489

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@json-schema-tools/meta-schema @types/jest @types/node @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint jest ts-jest typedoc typescript

Versions

JSON Schema Traverse

This package exports a method that will traverse a JSON-Schema, calling a "mutation" function for each sub schema found. It is useful for building tools to work with JSON Schemas.

Features

circular reference detection & handling
synchronous - doesn't touch the filesystem or make network requests.
easily perform schema mutations while traversing
optional mutability (toggle updating original schema object)
returns JSONPaths as it traverses

Getting Started

1npm install @json-schema-tools/traverse

1const traverse = require("@json-schema-tools/traverse").default;
2//import traverse from "@json-schema-tools/traverse"
3
4const mySchema = {
5  title: "baz",
6  type: "object",
7  properties: {
8    foo: {
9      title: "foo",
10      type: "array",
11      items: { type: "string" }
12    },
13    bar: {
14      title: "bar",
15      anyOf: [
16        { title: "stringerific", type: "string" },
17        { title: "numberoo", type: "number" }
18      ]
19    }
20  }
21};
22
23traverse(mySchema, (schemaOrSubschema) => {
24  console.log(schemaOrSubschema.title);
25});

API Docs

https://json-schema-tools.github.io/traverse/

Features Todo

unevaluatedItems (https://json-schema.org/draft/2019-09/json-schema-core.html#rfc.section.9.3.1.3)
unevaluatedProperties (https://json-schema.org/draft/2019-09/json-schema-core.html#rfc.section.9.3.2.4)
contains (https://json-schema.org/draft/2019-09/json-schema-core.html#rfc.section.9.3.1.4)
propertyNames (https://json-schema.org/draft/2019-09/json-schema-core.html#rfc.section.9.3.2.5)

Contributing

How to contribute, build and release are outlined in CONTRIBUTING.md, BUILDING.md and RELEASING.md respectively. Commits in this repository follow the CONVENTIONAL_COMMITS.md specification.

No vulnerabilities found.

10

Binary-Artifacts

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

10

Dangerous-Workflow

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

10

License

Determines if the project has defined a license.

8

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Token-Permissions

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

0

Code-Review

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

0

Maintained

Determines if the project is "actively maintained".

0

Pinned-Dependencies

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

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

SAST

Determines if the project uses static code analysis.

Score

3.6

/10

Last Scanned on 2025-01-27

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

Other packages similar to @json-schema-tools/traverse

@swenkerorg/sed-dolores

4.7.98

A code-generating [JSON Schema](https://json-schema.org/) validator that attempts to be reasonably secure.

@firanorg/mollitia-molestias-accusamus

10.13.142

[![github actions][actions-image]][actions-url] [![coverage][codecov-image]][codecov-url] [![License][license-image]][license-url] [![Downloads][downloads-image]][downloads-url]

@hishprorg/soluta-ullam

3.6.17

@hishprorg/soluta-ullam =========

@teamteanpm2024/ab-deserunt-culpa

1.2.4

> Generates Typescript/Javascript [decoders](https://decoders.cc) source code expressions from JSON schema specifications.