salesforce-graphql

salesforce-graphql - Bringing the GraphQL query language to Salesforce

Getting Started

Installation

$ yarn add salesforce-graphql jsforce

Example

app.ts

import * as jsforce from 'jsforce';
import * as path from 'path';
import * as fs from 'fs';

import { GraphQLServer } from 'graphql-yoga';
import { Binding } from 'salesforce-graphql';

const schemaFile = path.join(__dirname, 'schema.graphql');
const typeDefs = fs.readFileSync(schemaFile, 'utf8');

const { USERNAME, PASSWORD } = process.env;

const resolvers = {
  Query: {
    Accounts: (parent, args, context, info) =>
      context.db.query({}, info).then(res => res.records),
    Account: (parent, args, context, info) =>
      context.db.query({}, info).then(res => res.records[0]),
    Contacts: (parent, args, context, info) =>
      context.db.query({}, info).then(res => res.records),
    Contact: (parentobj, args, context, info) =>
      context.db.query({}, info).then(res => res.records[0]),
  },
  Account: {
    Contacts: (parent, args, context, info) =>
      context.db.query({ AccountId: parent.Id }, info).then(res => res.records),
  },
  Contact: {
    Account: (parent, args, context, info) =>
      context.db.query({ Id: parent.AccountId }, info).then(res => res.records[0]),
  },
};

const conn = new jsforce.Connection({});

function init() {
  const db = new Binding({ conn });

  const server = new GraphQLServer({
    typeDefs,
    resolvers,
    context: req => ({ ...req, db }),
  });

  server.start({ playground: '/playground' }, ({ port }) =>
    console.log('Server is running on localhost:' + port)
  );
}

conn.login(USERNAME, PASSWORD, (err, userinfo) => init());

schema.graphql

type Query {
  Account(Id: ID!): Account
  Accounts(limit: Int): [Account]
  Contact(Id: ID!): Contact
  Contacts(limit: Int): [Contact]
}

type Account {
  Id: ID!
  IsDeleted: Boolean
  Name: String
  Type: String

  Contacts(limit: Int): [Contact]
}

type Contact {
  Id: ID!
  Account: Account
  AccountId: String
  LastName: String
  FirstName: String
  Salutation: String
  Name: String
}

When you are ready, start the GraphQL server:

$ yarn start

Head over to http://localhost:4000/playground to test with the following query:

{
  Account(Id: "001E000001KnMkTIAV") {
    Id
    Name
    Contacts(limit: 1) {
      Name
      AccountId
      Account {
        Name
      }
    }
  }
}

TODO

• Subscriptions
• Mutations
• Basically everything

References

• salesforce-graphql on NPM
• Learn more about GraphQL
• Salesforce REST API documentation

Extra

• Looking for new opportunities? Have a look at Mavens website!