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

router-ai

v1.1.0

Published

route, validator, controller, service and model creator

Downloads

3

Readme

Install npm package

npm i router-ai

Start with

const Router = require("router-ai");

Initialize the router

let router = new Router({
  api: "web",
  dir: "build",
  extra: true
});

Add routes to the router

router.addRoute({
  name: "Name-of-the-route",
  schema: [Mongoose Schema],
  routes: [RouteObj]
});

router.addRoute({
  name: "second-route",
  schema: [second-route - Mongoose Schema],
  routes: [RouteObj]
});

Finally Stop the router

router.stop();

RouteObj Description:

{
  method: "Method of the route",
  route: "route name",
  model: "get", // select one ["get", "add", "update", "delete"] model of database
  dataName: "name of the response",
  code: 200, // Status code
  body: {
    valid: `{
      limit: Joi.number().required(),
      skip: Joi.number().optional()
    }`, // Validating the request with Joi validator Object
    have: `{ limit, skip }`, // what's in the request body or query
    todo: `{
      limit,
      skip,
      project: {
        _id: 0,
        __v: 0
      }
    }`, // what to do with the request
  },
}

Example :

const Router = require("router-ai");

let router = new Router({
  api: "web",
  dir: "build",
  extra: true
});

router.addRoute({
  name: "live-score",
  schema: [
    `{
    active: {type: "boolean", require: true}
  }`,
  ],
  routes: [
    {
      method: "get",
      route: "list",
      model: "get",
      dataName: "scores",
      code: 200,
      body: {
        have: `{
          limit,
          skip
        }`,
        todo: `{
          limit,
          skip,
          project: {
            _id: 0,
            __v: 0
          }
        }`,
      },
    },
    {
      method: "post",
      route: "add",
      model: "add",
      middlewares: ["checkToken"],
      dataName: "score",
      code: 201,
      body: {
        valid: `{
          active: Joi.boolean().required()
        }`,
      },
    },
    {
      method: "post",
      route: "update",
      model: "update",
      middlewares: ["checkToken"],
      dataName: "score",
      code: 200,
      body: {
        valid: `{
          id: Joi.string().length(24).required(),
          active: Joi.boolean().optional()
        }`,
        have: `{
          id,
          active
        }`,
        todo: `{
          query: {
            _id: mongoose.objectId(id)
          },
          update : {
            set: {
              active
            }
          }
        }`,
      },
    },
    {
      method: "post",
      route: "delete",
      model: "delete",
      middlewares: ["checkToken"],
      dataName: "score",
      code: 214,
      body: {
        have: `{
          id
        }`,
        todo: "id",
      },
    },
  ],
});

router.addRoute({
  name: "poll",
  schema: [
    `{
    active: {type: "boolean", require: true}
  }`,
  ],
  routes: [
    {
      method: "get",
      route: "list",
      model: "get",
      dataName: "scores",
      code: 200,
      body: {
        have: `{
          limit,
          skip
        }`,
        todo: `{
          limit,
          skip,
          project: {
            _id: 0,
            __v: 0
          }
        }`,
      },
    },
  ],
});

router.stop();

Additionally, Postman collection you can find in the routes folder named as "index.test.json"