sw-api-js/lib/swapi.js

Star Wars API wrapper for Node and the browser.

'use strict';

require('core-js/es6/promise'); // Polyfill for backwards compatibility
var request = require('superagent'); // XHR requests for browser and Node

(function () {

  var HOST = 'http://swapi.co/api/';

  /*
   * Request data from SW API
   */
  function makeRequest(url) {
    return new Promise(function (resolve, reject) {
      request.get(url).responseType('json').type('application/json').accept('application/json').end(function (err, res) {
        if (err) {
          reject(err);
        } else {
          resolve(res.body);
        }
      });
    });
  }

  /*
   * Recursive function to get objects from all pages
   */
  function getAll(url, collection) {
    // Initialise array
    collection = typeof collection === 'undefined' ? [] : collection;

    return makeRequest(url).then(function (data) {
      // Add each item to array
      var length = data.results.length;
      for (var i = 0; i < length; ++i) {
        collection.push(data.results[i]);
      }

      if (data.next === null) {
        // Return on final page
        return collection;
      } else {
        return getAll(data.next, collection);
      }
    }).catch(function (err) {
      throw err;
    });
  }

  /*
   * Wrapper to return Promise with error handling
   */
  function getData(url) {
    return makeRequest(url).then(function (data) {
      return data;
    }).catch(function (err) {
      throw err;
    });
  }

  /*
   * Convert parameters for API
   */
  function parseOptions(options) {
    if (options.path.indexOf(HOST) !== -1) {
      // Get complete URL
      return getData(options.path);
    } else if (typeof options.value === 'undefined') {
      // Get all results
      return getAll(HOST + options.path + '/');
    } else if (typeof options.value === 'string') {
      // Get search results (paged or all)
      if (options.format === 'paged') {
        return getData(HOST + options.path + '/?search=' + options.value);
      } else {
        return getAll(HOST + options.path + '/?search=' + options.value);
      }
    } else {
      // Get results by ID (paged or single)
      if (options.format === 'paged') {
        return getData(HOST + options.path + '/?page=' + options.value);
      } else {
        return getData(HOST + options.path + '/' + options.value);
      }
    }
  }

  /*
   * Sanitize input parameter types and reject Promise if invalid
   */
  function sanitizeOptions(options) {
    // Set to base URL on empty parameters
    options.path = typeof options.path === 'undefined' ? HOST : options.path;

    if (typeof options.path !== 'string') {
      // Reject if input path isn't a string
      return Promise.reject().catch(function () {
        throw new TypeError('Path must be a string.');
      });
    } else if (typeof options.value !== 'undefined' && (typeof options.value !== 'string' && typeof options.value !== 'number' || typeof options.value === 'number' && options.value % 1 !== 0)) {
      // Reject if input value isn't a string or integer
      return Promise.reject().catch(function () {
        throw new TypeError('Value must be a string or number.');
      });
    } else if (typeof options.format !== 'undefined' && options.format !== 'paged') {
      // Reject if input format is invalid
      return Promise.reject().catch(function () {
        throw new Error('Invalid format parameter.');
      });
    } else {
      // All is well, continue!
      return parseOptions(options);
    }
  }

  /*
   * Export the module
   */
  var swapi = function swapi(path, value, format) {
    return sanitizeOptions({ path: path, value: value, format: format });
  };

  module.exports = swapi;
})();