JSPM

cycle-graphql-most-driver

0.3.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • 0
  • Score
    100M100P100Q13285F
  • License MIT

A simple, Apollo-based, GraphQL driver to be used with Cycle's most-run

Package Exports

  • cycle-graphql-most-driver

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 (cycle-graphql-most-driver) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

This is a driver for all your pure-most Cycle apps (think Motorcycle) that talks to a GraphQL endpoint.

It uses Apollo Client underneath.

  • the graphql endpoint defaults to /graphql, but it can be changed by passing the endpoint='/something' option to makeGraphQLDriver;
  • withCredentials is enabled by default (and there's no way to change it);
  • to send custom headers with the GraphQL requests, it is possible to either
    • specify the headers through the headers={authorization: 'token xyz'} option to makeGraphQLDriver; or
    • emit an object with a key headers (example: {headers: {authorization: 'token xyz'}}) as an event in the stream that the driver is consuming.

Install

npm install --save cycle-graphql-most-driver

Use

import most from 'most'
import hold from '@most/hold'
import Cycle from '@cycle/most-run'
import {makeDOMDriver, h} from '@motorcycle/dom'
import {makeGraphQLDriver, gql} from 'cycle-graphql-most-driver'

Cycle.run(app, {
  DOM: makeDOMDriver('#container'),
  GRAPHQL: makeGraphQLDriver({
    endpoint: '/graphql',
    templates: {
      fetchItem: gql`
query fetchItem($id: ID!) {
  item($id) {
    id
    name
    description
    events {
      time
      value
    }
  }
}
      `,
      fetchAll: gql`
query {
  items {
    id, name
  }
}
      `,
      setItem: gql`
mutation setItem($id: ID!, $name: String, $desc: String) {
  setItem($id, $name, $desc) {
    id
  }
}
      `
    }
  })
})

function app ({DOM, GRAPHQL}) {
  let response$ = GRAPHQL
    .flatMap(r$ => r$
      .recoverWith(err => most.of({errors: [err.message]}))
    )
    .filter(({errors}) => {
      if (errors && errors.length) {
        console.log('errors:', errors)
        return false
      }
      return true
    })
    .map(({data}) => data)

  let itemList$ = response$.filter(data => data.items)

  let vtree$ = itemList$
    .map(items =>
      h('ul', items.map(item =>
        h('li', {props: {id: item.id}}, item.name)
      ))
    )

  return {
    DOM: vtree$,
    GRAPHQL: most.from([{
      query: 'fetchItems'
    }, {
      mutation: 'setItem',
      variables: {
        id: 123,
        name: 'an item',
        desc: 'this is an item'
      }
    }])
  }
}