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

@cleartax/apollo-server-plugin-introspection-auth

v1.1.0

Published

An Apollo Server plugin to allow introspection only via authenticated requests

Downloads

1,317

Readme

@cleartax/apollo-server-plugin-introspection-auth

An apollo plugin to secure introspection queries with token based authentication.


npm (scoped) NPM David code style: prettier

Installation

Install the plugin as dependency.

npm install -S @cleartax/apollo-server-plugin-introspection-auth

apollo-server is a peer-dependency for this package.

If you haven't already, install it via:-

npx install-peerdeps @cleartax/apollo-server-plugin-introspection-auth

Usage

When instantiating ApolloServer, pass the following options:-

const apolloServer = new ApolloServer({
  //...
  introspection: true,
  plugins: [
    ApolloServerIntrospectionAuth({
        type: 'header-token',
        name: 'x-app-introspect-auth', // custom header name
        value: ['<valid-auth-token>'], // valid header values
      }),
  ];
});

Note: Ideally, you would want to add this configuration for non-development environments only. In which case, you can add the options conditionally. The following example illustrates adding it for higher environments in apollo-server-express:-

// this example uses `apollo-server-express`
import { ApolloServerExpressConfig, ApolloServer } from 'apollo-server-express';
import ApolloServerIntrospectionAuth from '@cleartax/apollo-server-plugin-introspection-auth';

let options: ApolloServerExpressConfig = {
  // ...
  // your default apollo server express config
};

// add this configuration for NON-development environments
if (process.env.NODE_ENV === 'production') {
  options = {
    ...options,
    playground: false, // turn off playground in production
    introspection: true, // configure apollo to allow introspection
    plugins: plugins.concat([
      // add the plugin to check for authentication on introspection queries
      ApolloServerIntrospectionAuth({
          type: 'header-token',
          name: 'x-app-introspect-auth', // header name
          value: ['<valid-auth-token>'], // valid header values
        }),
    ]);
  }
}

const apolloServer = new ApolloServer(options);

References

Inspired from this implementation in apollographql/apollo-server#1933.

  1. Apollo GraphQL
  2. Apollo Graph Manager