Add GraphQL support

Author: mnovozhylov

CHANGES.md

@@ -1,5 +1,8 @@
 # Release History
 
+## 2.1.3
+* Add GraphQL support
+
 ## 2.1.2
 * Send Message to a Batch of Rooms API
 

example/example.js

@@ -25,6 +25,7 @@ var UpworkApi = require('node-upwork-oauth2') // use if package is installed via
 //  , Auth = require('../lib/routers/auth').Auth // uncomment to use inside current package/sources
   , Auth = require('node-upwork-oauth2/lib/routers/auth').Auth // use if package is installed via npm
   , Messages = require('node-upwork-oauth2/lib/routers/messages').Messages // use if package is installed via npm
+  , Graphql = require('node-upwork-oauth2/lib/routers/graphql').Graphql // use if package is installed via npm
   , rl = require('readline');
 
 // you can use your own client for OAuth2 (Authorization Code Grant) routine, just identify it here
@@ -92,6 +93,30 @@ function sendMessageToRoom(api, callback) {
   });
 }
 
+// send GraphQL query
+function sendGraphqlQuery(api, callback) {
+  // make a call
+  var graphql = new Graphql(api);
+  var params = {
+    'query': `query {
+      user {
+        id
+        nid
+        rid
+      }
+      organization {
+        id
+      }
+    }`,
+  };
+  graphql.execute(params, (error, httpStatus, data) => {
+    // check error and httpStatus if needed and run your own error handler
+    debug(httpStatus, 'response status');
+    debug(data, 'received response');
+    callback(data);
+  });
+}
+
 (function main() {
   // uncomment only if you want to use your own client
   // make sure you know what you're doing
@@ -100,6 +125,8 @@ function sendMessageToRoom(api, callback) {
 
   // use a predefined client for OAuth routine
   var api = new UpworkApi(config);
+  // GraphQL requests require X-Upwork-API-TenantId header, which can be setup using the following method
+  // api.setOrgUidHeader('1234567890'); // 	Organization UID
 
   if (!config.accessToken || !config.refreshToken) {
     // run authorization in case we haven't done it yet
@@ -133,6 +160,10 @@ function sendMessageToRoom(api, callback) {
         // do smth here with the data
 	console.log(data);
       });
+      sendGraphqlQuery(api, (data) => {
+        // do smth here with the data
+	console.log(data);
+      });
     });
   }
 })();

lib/api.js

@@ -90,3 +90,16 @@ exports.UpworkApi.prototype.setNewAccessTokenPair = function(tokenPair, callback
   debug('set access/refresh token');
   this.client.setNewAccessTokenPair(tokenPair, callback);
 }
+
+/**
+ * Configure X-Upwork-API-TenantId header
+ *
+ * @method setOrgUidHeader
+ * @param tenantId {String} Organization UID
+ * @param callback
+ * @async
+ */
+exports.UpworkApi.prototype.setOrgUidHeader = function(tenantId, callback) {
+  debug('setting organization uid header');
+  this.client.setOrgUidHeader(tenantId, callback);
+}

lib/client.js

@@ -33,6 +33,7 @@ function Client(config) {
   this.config = config;
   this.baseUrl = config.baseUrl;
   this.entryPoint = undefined;
+  this.tenantId = undefined;
 
   this.oauth2 = oauth2.create({
     client: {
@@ -136,8 +137,26 @@ Client.prototype.setAccessToken = function(callback) {
  */
 Client.prototype.setEntryPoint = function(entryPoint) {
   debug('updating entry point');
+  this.entryPoint = entryPoint;
   // a trick to support different entry points in node-upwork
-  this.baseUrl = this.baseUrl.replace(/\/api\//i, '/' + entryPoint + '/');
+  if (entryPoint === 'graphql') {
+    this.baseUrl = this.config.gqlUrl;
+  } else {
+    this.baseUrl = this.baseUrl.replace(/\/api\//i, '/' + entryPoint + '/');
+  }
+}
+
+/**
+ * Configure X-Upwork-API-TenantId header
+ *
+ * @method setOrgUidHeader
+ * @param tenantId {String} Organization UID
+ * @param callback
+ * @async
+ */
+Client.prototype.setOrgUidHeader = function(tenantId, callback) {
+  debug('setting organization uid header');
+  this.tenantId = tenantId;
 }
 
 /**
@@ -215,7 +234,9 @@ Client.prototype.sendRequest = function (method, url, params, callback) {
       _params = {qs: params};
       break;
     case 'POST':
-      _params = {formData: params};
+      if (this.entryPoint !== 'graphql') {
+        _params = {formData: params};
+      }
       break;
     default:
       _params = {formData: Object.assign(params, {http_method: method.toLowerCase()})};
@@ -232,6 +253,14 @@ Client.prototype.sendRequest = function (method, url, params, callback) {
       'User-Agent': UpworkLibraryUserAgent
     }
   };
+  // GraphQL support
+  if (this.entryPoint === 'graphql') {
+    if (this.tenantId !== undefined) {
+      _options.headers['X-Upwork-API-TenantId'] = this.tenantId;
+    }
+    _options.headers['Content-Type'] = 'application/json';
+    _options.body = JSON.stringify(params);
+  }
 
   request(Object.assign(_options, _params), (err, httpResponse, body) => {
     callback(err, httpResponse.statusCode, parseResponse(body));

lib/config.js

@@ -32,6 +32,7 @@ function Config(options) {
   this.tokenPath = '/api/v3/oauth2/token';
   this.tokenHost = 'https://www.upwork.com';
   this.baseUrl = this.tokenHost + '/api/';
+  this.gqlUrl = 'https://api.upwork.com/graphql';
 }
 
 module.exports = Config;

lib/routers/graphql.js

@@ -0,0 +1,45 @@
+/**
+ * Upwork auth library for using with public API by OAuth
+ *
+ * @package     UpworkAPI
+ * @since       12/20/2021
+ * @copyright   Copyright 2021(c) Upwork.com
+ * @author      Maksym Novozhylov <mnovozhilov@upwork.com>
+ * @license     Upwork's API Terms of Use {@link https://developers.upwork.com/api-tos.html}
+ */
+
+/**
+ * @module routes.graphql
+ */
+
+/**
+ * @property entryPoint
+ * @type String
+ * @default graphql
+ * @static
+ * @final
+ */
+var entryPoint = 'graphql';
+
+/**
+ * @class Graphql
+ * @constructor
+ */
+exports.Graphql = function(api) {
+  this.api = api;
+  this.api.epoint = entryPoint;
+  this.api.client.setEntryPoint(this.api.epoint);
+}
+
+/**
+ * Execute GraphQL request
+ *
+ * @method execute
+ * @param params {Hash} Parameters
+ * @param callback {String} Callback function
+ * @async
+ */
+exports.Graphql.prototype.execute = function(params, callback) {
+  debug('running request');
+  this.api.client.post('', params, callback);
+}

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@upwork/node-upwork-oauth2",
   "description": "Node.JS bindings for Upwork API (OAuth2)",
-  "version": "2.1.2",
+  "version": "2.1.3",
   "author": {
     "name": "Maksym Novozhylov",
     "email": "mnovozhilov@upwork.com"
@@ -34,7 +34,8 @@
     "test": "mocha --timeout 3500"
   },
   "devDependencies": {
-    "mocha": "~7.1.2"
+    "mocha": "~7.1.2",
+    "ansi-regex": ">=5.0.1"
   },
   "engines": {
     "node": "*"