ssb-schema-definitions

v3.2.1

standardised schema definitions for JSON validation of ssb references For more information about how to use this package see README

Latest version published 4 years ago

License: MIT

NPM

GitHub

Package Health Score

43 / 100

security
Security review needed
popularity
Limited
maintenance
Inactive
community
Limited

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
3.2.1	\|	07/2020	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.1.0	\|	06/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.1.0	\|	03/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.3.0	\|	10/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.2.0	\|	08/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (30)

GitHub Stars: 3
Forks: 1
Contributors: 4

Direct Usage Popularity

The npm package ssb-schema-definitions receives a total of 30 downloads a week. As such, we scored ssb-schema-definitions popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package ssb-schema-definitions, we found that it has been starred 3 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: Yes
Contributors: 4
Funding: No

This project has seen only 10 or less contributors.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 3
Open PR: 5
Last Release: 4 years ago
Last Commit: 4 years ago

Further analysis of the maintenance status of ssb-schema-definitions based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for ssb-schema-definitions is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 6 years
Dependencies: 2 Direct
Versions: 27
Install Size: 24.5 kB
Dist-tags: 1
# of Files: 19
Maintainers: 6
TS Typings: No

ssb-schema-definitions has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

SSB Schema Definitions

Standardised schema definitions for SSB messages when using is-my-json-valid.

Example Usage

const Definitions = require('ssb-schema-definitions')
const Validator = require('is-my-json-valid')

const schema = {
  $schema: 'https://json-schema.org/schema#',
  type: 'object',
  required: ['type', 'tangles'],
  properties: {
    type: {
      type: 'string',
      pattern: '^profile/.*$'
    },
    preferredName: { type: 'string' },
    avatarImage: { $ref: '#/definitions/image' }, // &lt;&lt; reference a definition
    tangles: {
      group: { $ref: '#/definitions/tangle/any' },
      profile: { $ref: '#/definitions/tangle/root' }
    },
    recps: { $ref: '#/definitions/recipients/box2' }
  },
  additionalProperties: false,
  definitions: Definitions() // attach the definitions
}

const isValid = Validator(schema)

// isValid(msgContent) =&gt; Boolean
// isValid.errors =&gt; null | [Errors]

API

`Definitions() => Object`

The definitions is a getter (function) so that you can pull it and mutate it awithout getting into trouble.

To see what definitions are available check out index.js.

You can also see examples of how to use most of the definitions in the tests/ folder. At time of writing there's good test coverage here for fields:

contentWarning
image
mentions
tangle
tombstone
recps (box1, box2/ envelope)

ssb-schema-definitions dependencies

lodash.clone ssb-ref

ssb-schema-definitions development dependencies

is-my-json-valid ssb-keys tap-spec tape

FAQs

What is ssb-schema-definitions?

standardised schema definitions for JSON validation of ssb references. Visit Snyk Advisor to see a full health score report for ssb-schema-definitions, including popularity, security, maintenance & community analysis.

Is ssb-schema-definitions popular?

The npm package ssb-schema-definitions receives a total of 30 weekly downloads. As such, ssb-schema-definitions popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is ssb-schema-definitions well maintained?

We found indications that ssb-schema-definitions is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is ssb-schema-definitions safe to use?

While scanning the latest version of ssb-schema-definitions, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 17 November-2024, at 04:43 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP