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

@acusti/appsync-fetch

v0.15.1

Published

A lightweight node.js module for making requests to an AWS AppSync graphql API

Downloads

117

Readme

@acusti/appsync-fetch

latest version maintenance status downloads per month install size

appsync-fetch is a lightweight node.js module that uses @acusti/post to make requests to an AWS AppSync graphql API. It expands on @acusti/post’s API with an optional third argument for passing in AWS credentials, as well as the region. If AWS credentials aren’t provided, it uses the same algorithm as @aws-sdk/credential-providers’s fromEnv helper to get credentials from the standard AWS environment variables made available in lambdas. It then uses those credentials to construct the appropriate AWS SigV4 authorization headers for IAM-based authorization.

There are two primary reasons it’s worth using:

  1. it relies on the native node.js http/https modules for fetching (via @acusti/post) and on the native node.js crypto module for its cryptographic logic; this makes it way lighter weight than alternatives and results in faster start times in your lambdas
  2. its DX ergonomics are carefully tuned for interacting with AppSync GraphQL APIs

Usage

npm install @acusti/appsync-fetch
# or
yarn add @acusti/appsync-fetch

The package exports appsyncFetch, a function that takes similar arguments to window.fetch (note that method is always POST) and returns a promise. The promise is resolved with the parsed JSON version of the request’s response (i.e. return await response.json() when using the Fetch API), because that’s what you wanted anyways. It also sets all required headers, including AWS authorization headers, a Date header, and Content-Type.

In addition, the second argument can take a query property (string) and a variables property (object), which it will JSON.stringify into a valid GraphQL request body. You can also pass in body as a string directly, but if you pass in a query, the body will be overwritten (you will get a type error in typescript if you try to pass both).

The function also takes an optional third argument where you can manually pass in AWS credentials if you don’t wish to rely on the built-in credentials handling, which will extract credentials from environment variables via process.env. Usage is illustrated in the code example below.

And lastly, if the response is an error (4xx or 5xx), appsyncFetch will throw an Error object with the response HTTP error and message as the Error object message and with the following additional properties:

  • Error.response: the node.js response IncomingMessage object
  • Error.responseJSON: if the response body can be parsed as JSON, the JSON representation returned from calling JSON.parse() on it
  • Error.responseText: the response body as text
import { appsyncFetch } from '@acusti/appsync-fetch';

const appsyncURL = 'https://_.appsync-api.us-west-2.amazonaws.com/graphql';

// In its simplest usage, environment variables are used for authorization
const itemsResult = await appsyncFetch(appsyncURL, {
    query: `
        query ListItems {
            listItems {
                items {
                    id
                    text
                }
            }
        }`,
});
// itemsResult is the parsed JSON from the response, e.g.:
// const response = await fetch(...);
// const itemsResult = await response.json();

// You can also pass in variables
const createdItemResult = await appsyncFetch(appsyncURL, {
    query: `
        mutation CreateItem($input: CreateItemInput!) {
            createItem(input: $input) {
                id
            }
        }`,
    variables: {
        input: {
            text: 'Here is the text of a new item',
        },
    },
});

// You can also provide the authentication variables manually
const manualAuthenticationResult = await appsyncFetch(
    appsyncURL,
    { query: 'query {...}' },
    {
        accessKeyId,
        secretAccessKey,
        sessionToken,
    },
);

With TypeScript

You can pass in the expected data result from the GraphQL query as a generic to appsyncFetch. This works very well with the codegen GraphQL API types provided by AWS amplify:

import { ListItemsQuery } from 'API';

const itemsResult = await appsyncFetch<ListItemsQuery>(appsyncURL, {
    query: `
        query ListItems {
            listItems {
                items {
                    id
                    text
                }
            }
        }`,
});

The type of itemsResult will be { data?: ListItemsQuery, errors?: GraphQLResponseError[] }, where GraphQLResponseError is the shape of GraphQL errors returned by appsync as illustrated in the docs.