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

@graft/server

v5.4.2

Published

Server tools for massively maintainable GraphQL

Downloads

3

Readme

@graft/server

Graft includes a set of server tools, including a convenience wrapper for Express called withGraft. By default, you can get up and running with a minimal configuration and Graft will use a set of sensible defaults.

Installation

yarn add @graft/server

Usage

To quickly get up and running, install Graft Server and some local dependencies:

yarn add @graft/server express morgan

Then define a Graft config:

import {GraftConfig} from '@graft/server'

async function pgSettings(req: IncomingMessage) {
  const sub = req.user && req.user.sub

  return {
    'jwt.claims.sub': sub,
    role: 'app_user',
  }
}

const getGraphQLContext = async (req: IncomingMessage) => ({
  user: req.user,
})

const plugins = []

const config: GraftConfig = {
  postgraphile: {
    appendPlugins: plugins,
    additionalGraphQLContextFromRequest: getGraphQLContext,
    pgSettings: pgSettings,
    retryOnInitFail: true,
  },
  jwt: {
    audience: Auth.audience,
    issuer: Auth.issuer,
    algorithms: ['RS256'],
    credentialsRequired: false,
  },
  jwks: {
    jwksUri: Auth.jwksUri,
  },
  cors: {
    allowedHeaders: Server.corsHeaders,
  },
  database: {
    url: Database.url,
  },
}

Then, define an Express app and run it with Graft's helpers (which we'll place in src/Server.ts for the purpose of this example):

import express from 'express'
import morgan from 'morgan'
import {withGraft, run} from '@graft/server'

export function start() {
  const app = express()
    .disable('x-powered-by')
    .use(morgan(process.env.NODE_ENV === 'development' ? 'dev' : 'combined'))
    .get('/', (_req, res) => {
      res.send('ok')
    })

  run(withGraft(app, config), 4000)
}

if (require.main === module) {
  start()
}

Since we're using TypeScript, install the dev dependency ts-node:

yarn add --dev ts-node

Finish up with a "dev" script in your package.json file:

{
  "script": {
    "dev": "NODE_ENV=development ts-node --transpile-only src/Server.ts"
  }
}

In the example above, we used port 4000, so run yarn dev and visit http://localhost:4000/graphql to see the default Playground interface.

Graft will use PostGraphile to introspect your PostgreSQL database and auto-generate a very useful default interface for managing data in your tables and columns.

Schema

To find helpers for managing your database schema with Knex, take a look at the @graft/knex package.

Utils

To find helpers for working with PostGraphile and implementing business logic for your server, take a look at the utils folder.