xcoobee-sdk/src/xcoobee/api/EventsApi.js

The XcooBee SDK is a facility to abstract lower level calls and implement standard behaviors. The XcooBee team is providing this to improve the speed of implementation and show the best practices while interacting with XcooBee.

const { decryptWithEncryptedPrivateKey, initializeOpenpgp } = require('../core/EncryptionUtils');
const ApiUtils = require('./ApiUtils');

/**
 *
 * @param {string} apiUrlRoot - The root of the API URL.
 * @param {ApiAccessToken} apiAccessToken - A valid API access token.
 * @param {string} userCursor - The user's cursor.
 * @param {string} [privateKey] - The armored, encrypted private key.
 * @param {string} [passphrase] - The passphrase to decrypt the encrypted private key.
 * @param {string} [after] - Fetch data after this cursor.
 * @param {number} [first] - The maximum count to fetch.
 *
 * @returns {Promise<Object>} - The result.
 * @property {Event[]} data - A page of events.
 * @property {Object} page_info - The page information.
 * @property {boolean} page_info.has_next_page - Flag indicating whether there is
 *   another page of data to may be fetched.
 * @property {string} page_info.end_cursor - The end cursor.
 *
 * @throws {XcooBeeError}
 */
const getEvents = (apiUrlRoot, apiAccessToken, userCursor, privateKey, passphrase, after = null, first = null) => {
  const query = `
    query getEvents($userCursor: String!, $after: String, $first: Int) {
      events(user_cursor: $userCursor, after: $after, first: $first) {
        data {
          event_id
          reference_cursor
          reference_type
          owner_cursor
          topic
          event_type
          payload
          hmac
          date_c
          response {
            channel
            status
            response
          }
        }
        page_info {
          end_cursor
          has_next_page
        }
      }
    }
  `;
  return ApiUtils.createClient(apiUrlRoot, apiAccessToken).request(query, {
    after,
    first,
    userCursor,
  })
    .then(async (response) => {
      const { events } = response;

      // If a private key and its passphrase are supplied, then decrypt payload for SDK
      // user.
      if (privateKey && passphrase) {
        await initializeOpenpgp();

        events.data = await Promise.all(events.data.map(async (event) => {
          const payload = await decryptWithEncryptedPrivateKey(
            event.payload,
            privateKey,
            passphrase
          );
          return {
            ...event,
            payload,
          };
        }));
      }

      return events;
    })
    .catch((err) => {
      throw ApiUtils.transformError(err);
    });
};

/**
 *
 * @param {string} apiUrlRoot - The root of the API URL.
 * @param {ApiAccessToken} apiAccessToken - A valid API access token.
 * @param {string} topic - Topic, where event should be sent.
 *
 * @returns {Promise<Object>} - The result.
 * @property {Event} result - Test event data.
 *
 * @throws {XcooBeeError}
 */
const triggerEvent = (apiUrlRoot, apiAccessToken, topic) => {
  const query = `
    mutation sendTestEvent($topic: String) {
      send_test_event(topic: $topic) {
        topic
        payload
        hmac
      }
    }
  `;
  return ApiUtils.createClient(apiUrlRoot, apiAccessToken).request(query, {
    topic,
  })
    .then((response) => response.send_test_event)
    .catch((err) => {
      throw ApiUtils.transformError(err);
    });
};

/**
 *
 * @param {string} apiUrlRoot - The root of the API URL.
 * @param {ApiAccessToken} apiAccessToken - A valid API access token.
 * @param {number[]} eventIds - Ids of events, that should be deleted.
 *
 * @returns {Promise<Object>} - The result.
 * @property {Event} result - Deleted events data.
 *
 * @throws {XcooBeeError}
 */
const deleteEvents = (apiUrlRoot, apiAccessToken, eventIds) => {
  const query = `
    mutation deleteEvents($ids: [Int] ){
      delete_events(event_ids: $ids){
          event_id
      }
    }
  `;
  return ApiUtils.createClient(apiUrlRoot, apiAccessToken).request(query, {
    ids: eventIds,
  })
    .then((response) => response.delete_events)
    .catch((err) => {
      throw ApiUtils.transformError(err);
    });
};

module.exports = {
  getEvents,
  triggerEvent,
  deleteEvents,
};