Benzene Extras

The collection of helpful utilities for a GraphQL Server. Not limited to benzene libraries!

Introduction

The GraphQL specification is meant to be extensible. For this reasons, there are many extensions to the specification such as:

Automatic persisted queries

Benzene is written to be unopinionated, so it avoids including such extensions. However, its extensibility enables us to integrate those ourselves. This way, Benzene can stay lightweight while supporting wide ranges of use cases.

Most of the modules in this package are written to be framework-agnostic, and most are usable outside of Benzene.

Modules

Errors

import { HTTPError } from "@benzene/extra";
 
throw new HTTPError(statusCode, "Some message", extensions);

Automatic persisted queries

See Automatic Persisted Queries with @benzene/extra.

import { makeAPQHandler } from "@benzene/extra";
 
const apq = makeAPQHandler();
// or use a custom cache
const apq = makeAPQHandler({
  cache: lru(1024),
});
 
const params = {
  query: undefined, // query not included
  extensions: {
    persistedQuery: {
      sha256Hash:
        "ec2e01311ab3b02f3d8c8c712f9e579356d332cd007ac4c1ea5df727f482f05f",
      version: 1,
    },
  },
};
 
const newParamsOrResult = await appHTTP(bodyOrQueryObject);
console.log(newParamsOrResult);
// If query is found:
// {
//   "query": "query { hello }",
//   "extensions": {
//     "persistedQuery": {
//       "sha256Hash": "ec2e01311ab3b02f3d8c8c712f9e579356d332cd007ac4c1ea5df727f482f05f",
//       "version": 1
//     }
//   }
// }
// Otherwise:
// {
//   "errors": [
//     {
//       "message": "PersistedQueryNotFound",
//       "extensions": { "code": "PERSISTED_QUERY_NOT_FOUND" },
//       "status": 200
//     }
//   ]
// }