apollo-upload-client

What is apollo-upload-client?

The apollo-upload-client package is a client for Apollo GraphQL that enables file uploads via GraphQL mutations. It extends Apollo Client to support file uploads using the GraphQL multipart request specification.

What are apollo-upload-client's main functionalities?

File Upload

This feature allows you to upload files via GraphQL mutations. The code sample demonstrates how to set up an Apollo Client with the upload link and perform a file upload mutation.

const { ApolloClient, InMemoryCache, HttpLink } = require('@apollo/client');
const { createUploadLink } = require('apollo-upload-client');

const link = createUploadLink({ uri: 'http://localhost:4000/graphql' });

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

const UPLOAD_FILE = gql`
  mutation($file: Upload!) {
    uploadFile(file: $file) {
      url
    }
  }
`;

const file = new File(['foo'], 'foo.txt', {
  type: 'text/plain',
});

client.mutate({
  mutation: UPLOAD_FILE,
  variables: { file }
}).then(response => {
  console.log(response.data.uploadFile.url);
});

Other packages similar to apollo-upload-client

apollo-link-rest

This package allows you to call REST endpoints from Apollo Client. While it does not specifically handle file uploads, it can be used to integrate RESTful file upload endpoints with Apollo Client.

graphql-request

A minimal GraphQL client that supports file uploads via the multipart request specification. It is more lightweight compared to apollo-upload-client and can be used in environments where a full Apollo Client setup is not required.

README

apollo-upload-client

An Apollo Link for Apollo Client that allows FileList, File, Blob or ReactNativeFile instances within query or mutation variables and sends GraphQL multipart requests.

Setup

Install with npm:

npm install apollo-upload-client

If you use Apollo Boost, migrate to a manual Apollo Client setup.

Initialize Apollo Client with a terminating Apollo Link using createUploadLink.

Also ensure the GraphQL server implements the GraphQL multipart request spec and that uploads are handled correctly in resolvers.

Usage

Use FileList, File, Blob or ReactNativeFile instances anywhere within query or mutation variables to send a GraphQL multipart request.

See also the example API and client.

FileList

const gql = require('graphql-tag')
const { Mutation } = require('react-apollo')

const UploadFiles = () => (
  <Mutation
    mutation={gql`
      mutation($files: [Upload!]!) {
        uploadFiles(files: $files) {
          success
        }
      }
    `}
  >
    {mutate => (
      <input
        type="file"
        multiple
        required
        onChange={({ target: { validity, files } }) =>
          validity.valid && mutate({ variables: { files } })
        }
      />
    )}
  </Mutation>
)

File

const gql = require('graphql-tag')
const { Mutation } = require('react-apollo')

const UploadFile = () => (
  <Mutation
    mutation={gql`
      mutation($file: Upload!) {
        uploadFile(file: $file) {
          success
        }
      }
    `}
  >
    {mutate => (
      <input
        type="file"
        required
        onChange={({
          target: {
            validity,
            files: [file]
          }
        }) => validity.valid && mutate({ variables: { file } })}
      />
    )}
  </Mutation>
)

Blob

const gql = require('graphql-tag')

// Apollo Client instance.
const client = require('./client')

const file = new Blob(['Foo.'], { type: 'text/plain' })

// Optional, defaults to `blob`.
file.name = 'bar.txt'

client.mutate({
  mutation: gql`
    mutation($file: Upload!) {
      uploadFile(file: $file) {
        success
      }
    }
  `,
  variables: { file }
})

Support

• Node.js v6.10+
• Browsers >1% usage
• React Native

API

Table of contents

• class ReactNativeFile
  • Examples
• function createUploadLink
  • See
  • Examples
• type FetchOptions
  • See
• type ReactNativeFileSubstitute
  • See
  • Examples

class ReactNativeFile

Used to mark a React Native File substitute. It’s too risky to assume all objects with uri, type and name properties are files to extract. Re-exported from extract-files for convenience.

Parameter	Type	Description
file	ReactNativeFileSubstitute	A React Native File substitute.

Examples

A React Native file that can be used in query or mutation variables.

const { ReactNativeFile } = require('apollo-upload-client')

const file = new ReactNativeFile({
  uri: uriFromCameraRoll,
  name: 'a.jpg',
  type: 'image/jpeg'
})

function createUploadLink

Creates a terminating Apollo Link capable of file uploads. Options match createHttpLink.

Parameter	Type	Description
options	Object	Options.
options.uri	string? = /graphql	GraphQL endpoint URI.
options.fetch	function?	fetch implementation to use, defaulting to the fetch global.
options.fetchOptions	FetchOptions?	fetch options; overridden by upload requirements.
options.credentials	string?	Overrides options.fetchOptions.credentials.
options.headers	Object?	Merges with and overrides options.fetchOptions.headers.
options.includeExtensions	boolean? = false	Toggles sending extensions fields to the GraphQL server.

Returns: ApolloLink — A terminating Apollo Link capable of file uploads.

See

• GraphQL multipart request spec.
• apollo-link on GitHub.

Examples

A basic Apollo Client setup.

const { ApolloClient } = require('apollo-client')
const { InMemoryCache } = require('apollo-cache-inmemory')
const { createUploadLink } = require('apollo-upload-client')

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

type FetchOptions

GraphQL request fetch options.

Type: Object

Property	Type	Description
headers	Object	HTTP request headers.
credentials	string?	Authentication credentials mode.

See

• Polyfillable fetch options.

type ReactNativeFileSubstitute

A React Native File substitute.

Type: Object

Property	Type	Description
uri	String	Filesystem path.
name	String?	File name.
type	String?	File content type.

See

• extract-files docs.
• React Native FormData polyfill source.

Examples

A camera roll file.

{
  uri: uriFromCameraRoll,
  name: 'a.jpg',
  type: 'image/jpeg'
}

Changelog

9.0.0

Major

• Made apollo-link a dependency, instead of a peer dependency.
• Removed the package module entry and the "ESM" build, which was .js and not proper native ESM for Node.js via .mjs as Apollo dependencies don’t support it.

Minor

• Updated Babel, removing the @babel/runtime dependency.
• Package marked side-effect free for bundlers and tree-shaking.

Patch

• Updated dependencies.
• Use the new extract-files API.
• Use jsdoc-md to generate readme API docs from source JSDoc, which has been improved.
• Readme examples updated to use the react-apollo Mutation component instead of the graphql decorator.
• Readme examples use CJS instead of ESM as this project does not support native ESM (due to a lack of support in Apollo dependencies) and we shouldn’t assume everyone uses Babel.
• Updated package description.
• Added package tags.
• Added a package test:size script, using size-limit to guarantee < 1 KB CJS bundle sizes.
• Lint .yml files.
• Refactored package scripts and removed the npm-run-all dev dependency.
• Removed a temporary workaround for a fixed Babel CLI bug.
• Ensure the readme Travis build status badge only tracks master branch.
• Use Badgen for the readme npm version badge.