Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@nhost/stripe-graphql-js) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

⚠️ Work In Progress ⚠️

This package being actively worked on and is NOT stable!

@nhost/stripe-graphql-js

Stripe GraphQL API

npm npm

Stripe GraphQL API with Hasura Remote schemas.

Connect data in your database with data from Stripe, via GraphQL.

query {
  users {
    # User in your database
    id
    displayName
    userData {
      stripeCustomerId # Customer's Stripe Customer Id
      stripeCustomer {
        # Data from Stripe
        id
        name
        paymentMethods {
          id
          card {
            brand
            last4
          }
        }
      }
    }
  }
}

Install

npm install @nhost/stripe-graphql-js

Quick Start

Serverless Function Setup

Create a new Serverless Function functions/graphql/stripe.ts:

import { createStripeGraphQLServer } from '@nhost/stripe-graphql-js'

const server = createStripeGraphQLServer()

export default server

Test

Test the Stripe GraphQL API in the rowser:

http://localhost:1337/v1/functions/graphql/stripe

Remote Schema

Add the Stripe GraphQL API as a Remote Schema in Hasura.

URL: {{NHOST_BACKEND_URL}}/v1/functions/graphql/stripe

Permissions

Here's a minimal example without any custom permissions. Only requests using the x-hasura-admin-secret header will work:

const server = createStripeGraphQLServer()

For more granular permissions, you can pass an isAllowed function to the createStripeGraphQLServer. The isAllowed function takes a stripeCustomerId and context as parameters and runs every time the GraphQL server makes a request to Stripe to get or modify data for a specific Stripe customer.

Here is an example of an isAllowed function:

const isAllowed = (stripeCustomerId: string, context: Context) => {
  const { isAdmin, userClaims } = context

  // allow requests if it has a valid `x-hasura-admin-secret`
  if (isAdmin) {
    return true
  }

  // get user id
  const userId = userClaims['x-hasura-user-id']

  // check if user is signed in
  if (!userId) {
    return false;
  }

  // get more user information from the database
  const { user } = await gqlSDK.getUser({
    id: userId,
  });

  if (!user) {
    return false;
  }

  // check if the user is part of a workspace with the `stripeCustomerId`
  return user.workspaceMembers
    .some((workspaceMember) => {
      return workspaceMember.workspace.stripeCustomerId === stripeCustomerId;
    });
}

Context

The context object contains:

userClaims - verified JWT claims from the user's access token.
isAdmin - true if the request was made using a valid x-hasura-admin-secret header.
request - Fetch API Request object that represents the incoming HTTP request in platform-independent way. It can be useful for accessing headers to authenticate a user
query - the DocumentNode that was parsed from the GraphQL query string
operationName - the operation name selected from the incoming query
variables - the variables that were defined in the query
extensions - the extensions that were received from the client

Read more about the default context from GraphQL Yoga.

Development

Install dependencies:

pnpm install

Start the development server:

pnpm dev

Open GraphiQL:

http://0.0.0.0:4000/graphql