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

@codehubby/cozyapi

v1.1.1

Published

CozyAPI: Simplify Your HTTP Server with Decorators.

Downloads

2

Readme

CozyAPI: Simplify Your HTTP Server

  • 💜 Simplify Your Api Servers
  • 💜 Use Decorators (currently using Babel)
  • 💜 Generated OpenAPI.json for easy Swagger Setup

A https://hub.codehubby.com package to radically simplify your HTTP API setup using decorators.

CozyAPI after successful install

app.js:

import CozyApi from 'cozyapi'
const app = new CozyApi()

class MyApi {
    @app.get('/')
    async hello() {
         return {message: "Hello world! 🙏🏻🙌"}
    }
    @app.post('/')
    async postMeSomething(postData) {
         return {postData}
    }
    @app.post('/items/{item_id}')
    async postMeSomeItem(item_id, postData) {
         return {item_id, postData}
    }
}

Enabling Decorators in Pure JavaScript (2023-05)

You need a .babelrc file with the following contents:

{
  "presets": [
    ["@babel/env", {
      "targets": {
        "node": "current"
      }
    }]
  ],
  "plugins": [
    ["@babel/plugin-proposal-decorators", { version: "2023-01" }],
    "@babel/plugin-proposal-class-static-block",
    "@babel/plugin-proposal-class-properties",
    "@babel/plugin-proposal-object-rest-spread",
  ]
}

As well as a build script in your package.json and babel packages and run npm install after you updated your package.json file:

  "scripts": {
    "build": "babel *.js -d dist",
    "build-scripts": "babel ./scripts/*.js -d dist/scripts # (optional for custom /scripts folder)",
    "start": "npm run build && node dist/app.js"
  },
  "devDependencies": {
    "@babel/cli": "^7.21.5",
    "@babel/core": "^7.21.8",
    "@babel/plugin-proposal-class-static-block": "^7.21.0",
    "@babel/plugin-proposal-decorators": "^7.21.0",
    "@babel/plugin-syntax-top-level-await": "^7.14.5",
    "@babel/preset-env": "^7.21.5"
  }

Don't forget to run npm install after editing your package.json ;)!

OpenAPI + Swagger API

CozyApi automately generated an openapi.json file which you can use in a swagger api configuration such as this:

app.js:

import express from 'express';
import bodyParser from 'body-parser';
import swaggerUi from 'swagger-ui-express';
import fs from 'fs';

const app = express();
const port = 3000;

// Parse JSON bodies
app.use(bodyParser.json());

// Read the OpenAPI JSON file
const openapiDocument = JSON.parse(fs.readFileSync('./openapi.json', 'utf8'));

// Configure Swagger UI with dark layout

const swaggerUiOptions = {
  customCss: '.swagger-ui .topbar { background-color: #333; } body,.swagger-ui { background:#999;color:grey; }',
  customSiteTitle: 'My API Documentation',
};

// Serve Swagger UI at root endpoint
app.use('/', swaggerUi.serve, swaggerUi.setup(openapiDocument, swaggerUiOptions));

// Start the server
app.listen(port, () => {
  console.log(`Swagger UI server listening at http://localhost:${port}`);
});

.