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

apollo-persisted-graphql

v0.1.0

Published

A build tool for generating persisted queries and use the queries in both client and server

Downloads

4

Readme

Apollo Persisted GraphQL

apollo-persisted-graphql is a build tool that generates static persisted queries for GraphQL that can be used in both client and server side.

It reads GraphQL queries from source directory and extracts query documents from .graphql files. Make sure each file MUST contains only one query document. This tool generates hash ID for each query and merge all the hash-query map to a JSON file. This JSON file can be used as whitelisting map for both client and server side.

Installation

npm install --save apollo-persisted-graphql

Setup and Usage

There's three steps to complete the setup.

  1. Generate persisted queries
  2. Client side setup
  3. Server side setup

Generate persisted queries

The tool has a binary file called apollo-persisted-graphql. Run the binary as follows. Make sure each file must contain only one query document

apollo-persisted-graphql -s <source_directory> -d <destination_file>

This command will generate a JSON file which can be used in both client and server end.

Client side setup

This package wraps apollo-link-persisted-queries in the client side and replace the hash with the generated hashId.

import { createPersistedQueries } from "apollo-persisted-graphql";
import { createHttpLink } from "apollo-link-http";
import { InMemoryCache } from "apollo-cache-inmemory";
import ApolloClient from "apollo-client";
const queryMap = require("./your_query_map.json");

const link = createPersistedQueries(queryMap)
  .concat(createHttpLink({ uri: "/graphql" }));

const client = new ApolloClient({
  cache: new InMemoryCache(),
  link: link,
});

Server side setup

This package works as a middleware for apollo-server-express server.

import * as express from "express";
import { ApolloServer } from "apollo-server-express";
import { mapRequestPersistedQueries } from "apollo-persisted-graphql";
const queryMap = require("./your_query_map.json");

const app = express();
app.use(mapRequestPersistedQueries(queryMap));

const server = new ApolloServer();
server.applyMiddleware({ app });

app.listen({port, host }, () =>
console.log(`🚀 Server ready at ${host}:${port}${server.graphqlPath}`));