npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@map-colonies/mc-model-types

v17.13.4

Published

json schemas for validations and generated ts models

Downloads

3,826

Readme

mc-models

this project is used to serve json schemas for input validation and generate matching types to use in typescript projects.

please note the node this was developed using node 12 and wont work with old versions of node.

package includes:

  • generated typescript types for map colonies shared models
  • json schema files for model validation

package usage:

the package can be installed with npm install @map-colonies/mc-model-types. the schemas for the validation are in the package, in order to use it for validation the schema files must be accessed directly.

building the package:

run npm install to install project dependencies.

to create local package tgz file run npm pack after the build

Schema structure

added schemas should be written according to the fallowing rule:

  • $ref to other files must be relative path.
  • types will be generated only for files that ends with ".base.json".
  • all schemas must be under tge "Schema" directory.
  • in order to prevent duplicates types generation (this will cause code generation to fail) and allow easier modification the schemas should be split to multiple files:
    • ".base.json" file with properties definitions.
    • ".json" file for every variation of the model with $ref to the base file and "required" definition.

template property type can be overridden in generated ts type by adding "tsType" attribute (for typescript types that are not valid in json schema)

for template example see Schema/LayerMetadata.

testing the yaml schemas

all the yaml schemas can be validated by running npm run lint:openapi

note that due to the limitions of the linter configuration the lint will result in The field `paths` must be present on this level error for every schema file, any other error should be fixed