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

@triptyk/jsonapi-server

v0.1.2

Published

A json mockup server for multiple front-end

Downloads

6

Readme

JSONAP-TESTING-SERVER

A development server with an in-memory database supporting json-api specification.

Still WIP.

JSON models

You can provide json models that will be be automatically loaded into the fake database

{
  "projects": [
    {
      "id": "1",
      "title": "Project One",
      "details": "This is a sample project",
      "percentComplete": 20,
      "approved": false,
      "startDate": null,
      "targetDate": null,
      "completionDate": null,
      "customers#creator": "1",
      "customers#customers": [
        "1",
        "2"
      ]
    },
    {
      "id": "2",
      "title": "Project Two",
      "details": "This is a sample project",
      "percentComplete": 40,
      "approved": false,
      "startDate": null,
      "targetDate": null,
      "completionDate": null,
      "customers#creator": "2",
      "customers#customers": [
        "1",
        "2"
      ]
    },
    {
      "id": "3",
      "title": "Project Three",
      "details": "This is a sample project",
      "percentComplete": 60,
      "approved": false,
      "startDate": null,
      "targetDate": null,
      "completionDate": null,
      "customers#creator": "3",
      "customers#customers": [
        "1",
        "2"
      ]
    }
  ]
}

Relations

Relations are recognized this way : "<entityType>#<relationName>": "<id>",

    "customers#creator": "3",

The id can also be an array of ids :

    "customers#creators": ["3","2","1"],

:note: : the IDs MUST exist otherwise it will throw errors on startup

Relations are created two ways :

    "customers#creators": ["3","1"]

if your relation is in a projects.json file , customers will create a projectsCreators relationship on the projects entity side.

Notes

  • Only one to one , one to many and many to one are supported at the moment.
  • Querying deeper than first level relations is also WIP.

JSON-API

Supported features :

  • includes (1 level)

  • pagination

  • sorting

  • sparse fieldsets

  • filters

    • eq : <value>
    • noteq : <value>
  • creating entity

  • updating entity

  • deleting entity

Configuration

You can create a configuration file in config/configuration.json with these values , it will override the default configuration

{
    "pluralizeSerializers": false,
    "authEntity": "users",
    "convertCase": "kebab-case",
    "unconvertCase": "kebab-case",
    "port":8000,
    "jwtAuthKey":"patate",
    "jwtExpiration":2
}

Example

  import { JsonApiServer, Configuration } from "@triptyk/jsonapi-server";
  import { Request, Response, NextFunction } from "express";

  const server = new JsonApiServer();

  server.Router.use((req,res,next) => {
      console.log("Hello");
      next();
  });

  server.Router.route("/status") 
      .get((req: Request,res: Response,next: NextFunction) => {
          res.sendStatus(200);
      });

  server.register("data/projects.json");
  server.register("data/customers.json");
  server.register("data/users.json");

  server.setupServer().then((app) => {
      app.listen(Configuration.configuration.port,() => {
          console.log(`Mockup server running on port ${Configuration.configuration.port}`);
      });
  });