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

@c-wiren/safe-router

v0.1.0

Published

Simple and safe web framework for Cloudflare Workers with built in validation using Zod

Downloads

2

Readme

safe-router

GitHub Workflow Status License npm

safe-router is a simple, safe, and fast web API framework. Create a safe API with minimal code. All needed types are created automatically.

About

Developing safe APIs can be complicated. While it seems easy to get started with a REST API, validation of URL parameters, queries, and request body makes things difficult quickly. And the result is rarely particularly readable.

safe-router is an opinionated framework. All requests are done with POST. All parameters are sent in the request body, and are validated automatically using Zod. A handler receives an object and returns an object. Any other interactions with the raw request are done in separate extensions to keep things tidy. The result is minimal code with maximum safety and simplicity.

Installation

npm install @c-wiren/safe-router zod

Examples

Define a function:

import App from '@c-wiren/safe-router';

const app = new App();

app.define('getUser', async c => {
  return { id: 0 };
});

Add Zod input type; it will be validated automatically and appear at c.params:

import App from '@c-wiren/safe-router';
import { z } from 'zod';

const app = new App();

app.define('getUser', z.object({ id: z.number() }), async c => {
  return { id: c.params.id };
});

Add an Environment type and access it at c.env:

type Bindings = { SECRET: string; };

const app = new App<Bindings>();

app.define('getSecret', async c => c.env.SECRET);

Handle errors easily:

app.define('getUser', async c => {
  const user = DB.getUser();
  if (user) { return user; }
  else { return c.ClientError('NotFound'); }
});

Or even easier:

app.define('getUser', async c => {
  const user = DB.getUser();
  return user ?? c.ClientError('NotFound');
});

Use typed error messages:

type ErrorMessage = 'NotFound' | 'Unknown';

const app = new App<Bindings, ErrorMessage>();

To keep things nice and tidy, handlers don't have access to the raw request. To access things such as headers, use an extension. The returned object is added to c.<EXTENSION_NAME>.

const withAuth = app.createExtension('auth', c => {
  const header = c.request.headers.get('Authentication');
  const user = getUserFromToken(header); // Placeholder function
  return { user };
});

app.define('getUser', [withAuth], async c => {
  return c.auth.user;
});