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

@maticoapp/matico_spec

v0.1.1

Published

The MaticoSpec defines how we specify an MaticoApp, from what panes should be on what pages to what datasets should be loaded and from where. The specification is written in Rust to ensure that we have a strickly specified and typechecked specification. M

Downloads

3

Readme

MaticoSpec

The MaticoSpec defines how we specify an MaticoApp, from what panes should be on what pages to what datasets should be loaded and from where. The specification is written in Rust to ensure that we have a strickly specified and typechecked specification. Most users and developers will interact with the spec using language specific tools built on top of the rust code. For example, when building a frontend cpplication, the spec produces TypescriptTypes for each of it's components along with a WASM based validation function for each. See below for exampels

Building the spec for use in Rust

To build the specification library for use in Rust, first install Rust, then run

cargo build 

Testing

We are working on expanding the test suite around the specification. To run the existing tests, simply run

cargo test 

Building the WASM library

To generate the javacsript module that allows you to interact with the spec in javascript, you will first need to install wasm-pack, then run

wasm-pack build --scope=maticoapp

this will produce a pkg directory with the javascript module.

Using the javascript / wasm module

To use the module you will need to

  1. Add @maticoapp/matico_spec to your project dependencies
yarn add @maticoapp/matico_spec 

then import the WASM module. This might vary a little dending on what build system you are using. You can see an example of how to do this in the MaticoComponents project in the useValidator hook

import { useEffect, useState } from 'react'

export const useValidator = () => {
  const [validator, setValidator] = useState<any>(null)
  const [validatorReady, setValidatorReady] = useState<boolean>(false)
  const [error, setError] = useState<any | undefined>(undefined)

  useEffect(() => {
    let f = async () => {
      try {
        const wasm = await import( /*webpackChunkName:"spec"*/ '@maticoapp/matico_spec');
        setValidator(wasm)
        setValidatorReady(true)
      } catch (err) {
        setError(`failed to load wasm: ${err}`)
        console.log("unexpected error in load wasm ", err);
      }
    };
    f();
  }, []);
  return { validator, validatorReady, error }

You can also just install @maticoapp/matico_components and use the hook directly.