npmpackage.info

Gathering detailed insights and metrics for @stoplight/json-schema-sampler

Other packages similar to @stoplight/json-schema-sampler

openapi-sampler

1.6.0

Tool for generation samples based on OpenAPI payload/response schema

@stoplight/better-ajv-errors

1.0.3

JSON Schema validation for Human

@stoplight/json-schema-viewer

4.16.3

A beautiful React component for viewing JSON Schema

@stoplight/spectral-ruleset-migrator

1.11.1

This project serves as a converter between the legacy ruleset format and a new one. It's used internally, albeit it can be used externally too, also in browsers.

Gathering detailed insights and metrics for @stoplight/json-schema-sampler

@stoplight/json-schema-sampler

0.3.0

NOASSERTION

JavaScript

10,251,866 2.5

Installations

npm install @stoplight/json-schema-sampler

Pull Requests

Open

15

Total

40

Closed

5

Merged

20

Issues

Open

3

Total

3

Closed

0

Releases

Unable to fetch releases

Developer

stoplightio

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

Yes

Node Version

16.20.1

NPM Version

8.19.4 Statistics

8 Stars

145 Commits

2 Forks

15 Watching

20 Branches

58 Contributors

Updated on 27 Feb 2024

Languages

JavaScript (99.9%)

HTML (0.1%)

Total Downloads

Cumulative downloads

Total Downloads

10,251,866

Last day

0.7%

23,883

Compared to previous day

Last week

10.8%

125,927

Compared to previous week

Last month

16.1%

519,809

Compared to previous month

Last year

60.7%

4,829,957

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

@stoplight/json-schema-sampler

It's a fork of openapi-sampler by Redocly, with focus on supporting JSON Schema Draft 7.

Tool for generation samples based on JSON Schema Draft 7.

Features

Deterministic (given a particular input, will always produce the same output)
Supports compound keywords: allOf, oneOf, anyOf, if/then/else
Supports additionalProperties
Uses default, const, enum and examples where possible
Good array support: supports contains, minItems, maxItems, and tuples (items as an array)
Supports minLength, maxLength, min, max, exclusiveMinimum, exclusiveMaximum
Supports the following string formats:
- email
- idn-email
- password
- date-time
- date
- time
- ipv4
- ipv6
- hostname
- idn-hostname
- uri
- uri-reference
- uri-template
- iri
- iri-reference
- uuid
- json-pointer
- relative-json-pointer
- regex
Infers schema type automatically following same rules as json-schema-faker
Support for $ref resolving

Installation

Install using npm

npm install @stoplight/json-schema-sampler --save

or using yarn

yarn add @stoplight/json-schema-sampler

Then require it in your code:

1const JSONSchemaSampler = require('@stoplight/json-schema-sampler');

Usage

`JSONSchemaSampler.sample(schema, [options], [spec])`

schema (required) - object A JSON Schema Draft 7 document.
options (optional) - object Available options:
- skipNonRequired - boolean Don't include non-required object properties not specified in required property of the schema object
- skipReadOnly - boolean Don't include readOnly object properties
- skipWriteOnly - boolean Don't include writeOnly object properties
- quiet - boolean Don't log console warning messages
- maxSampleDepth - number Max depth sampler should traverse
doc - the whole schema where the schema is taken from. Might be useful when the schema passed is only a portion of the whole schema and $refs aren't resected. doc must not contain any external references

Example

1const JSONSchemaSampler = require('@stoplight/json-schema-sampler');
2JSONSchemaSampler.sample({
3  type: 'object',
4  properties: {
5    a: {type: 'integer', minimum: 10},
6    b: {type: 'string', format: 'password', minLength: 10},
7    c: {type: 'boolean', readOnly: true}
8  }
9}, {skipReadOnly: true});
10// { a: 10, b: 'pa$$word_q' }

No vulnerabilities found.

10

Binary-Artifacts

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

9

License

Determines if the project has defined a license.

4

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

CII-Best-Practices

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

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

73 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
Warn: Project is vulnerable to: GHSA-wg6g-ppvx-927h
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-897m-rjf5-jp39
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-qr4m-jcvc-3382
Warn: Project is vulnerable to: GHSA-434g-2637-qmqr
Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m
Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw
Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p
Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
Warn: Project is vulnerable to: GHSA-j4f2-536g-r55m
Warn: Project is vulnerable to: GHSA-r7qp-cfhv-p84w
Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h
Warn: Project is vulnerable to: GHSA-2j2x-2gpw-g8fm
Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
Warn: Project is vulnerable to: GHSA-4q6p-r6v2-jvc5
Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
Warn: Project is vulnerable to: GHSA-6xrf-q977-5vgc
Warn: Project is vulnerable to: GHSA-v5vg-g7rq-363w
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-7x7c-qm48-pq9c
Warn: Project is vulnerable to: GHSA-rc3x-jf5g-xvc5
Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
Warn: Project is vulnerable to: GHSA-82v2-mx6x-wq7q
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m / GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp
Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr
Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7
Warn: Project is vulnerable to: GHSA-fxwf-4rqh-v8g3
Warn: Project is vulnerable to: GHSA-25hc-qcg6-38wj
Warn: Project is vulnerable to: GHSA-xfhh-g9f5-x4m4
Warn: Project is vulnerable to: GHSA-qm95-pgcg-qqfq
Warn: Project is vulnerable to: GHSA-cqmj-92xf-r6r9
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-mgfv-m47x-4wqp
Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-72mh-269x-7mh5
Warn: Project is vulnerable to: GHSA-h4j5-c7cj-74xg
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp

Score

2.5

/10

Last Scanned on 2024-11-18

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 @stoplight/json-schema-sampler

Other packages similar to @stoplight/json-schema-sampler

@stoplight/json-schema-sampler

Installations

Pull Requests

15

40

5

20

Issues

3

3

0

Releases

Unable to fetch releases

Developer

stoplightio

Developer Guide

CommonJS

Yes

16.20.1

8.19.4

Statistics

Languages

Total Downloads

10,251,866

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

@stoplight/json-schema-sampler

Features

Installation

Usage

JSONSchemaSampler.sample(schema, [options], [spec])

Example

10

9

4

0

0

0

0

0

0

2.5

/10

`JSONSchemaSampler.sample(schema, [options], [spec])`