@kth/api-call/discovery.js

Node.js module to make JSON calls against APIs.

/* eslint-disable func-names */
/* eslint-disable no-use-before-define */
/**
 * Class to handle OpenIDConnect discovery through .well-known
 */
const api = require('./api')

module.exports = (function () {
  console.warn('⚠️ @kth/api-call/discovery is deprecated and will be removed ⚠️')

  /**
   * Factory function to hide class instantiation.
   *
   * @param config the configuration object
   * @returns {Discovery}
   */
  function factory(config) {
    return new Discovery(config)
  }

  /**
   * Discovery class constructor.
   *
   * @param config the configuration object. Must contain host and path.
   * @constructor
   */
  function Discovery(config) {
    this.config = config || {}
  }

  /**
   * Method to run OpenIDConnect discovery.
   * @param onDiscovered callback on when discovery was successful
   * @param onError callback on when error occurred during discovery
   */
  Discovery.prototype.discover = function (onDiscovered, onError) {
    // Begin by fetching data from the discovery endpoint
    getDiscoveryData(
      this.config,
      discoveryData => {
        if (!discoveryData.jwks_uri) {
          onError('jwkEndpoint missing from OIDC discovery data')
        }

        // If discovery went OK, fetch the jwk endpoint data
        getJwkData(
          discoveryData.jwks_uri,
          jwkData => {
            onDiscovered(discoveryData, jwkData)
          },
          err => {
            onError(err)
          }
        )
      },
      err => {
        onError(err)
      }
    )
  }

  /**
   * Makes an API call to the OpenIDConnect providers discovery endpoint and
   * fetches the data as json.
   * @param config the Discovery class configuration
   * @param onSuccess callback for when discovery fetching is successful
   * @param onError callback for when an error occurs during discovery fetching
   */
  function getDiscoveryData(config, onSuccess, onError) {
    const discoveryApi = api({
      host: config.host,
      path: config.path,
    })
    discoveryApi.request(onSuccess, onError)
  }

  /**
   * Makes an API call to the jwk_endpoint on the OpenIDConnect provider.
   *
   * @param jwksUri the uri for the jwk_endpoint (complete with host and path)
   * @param onSuccess callback for when jwk endpoint fetching was successful
   * @param onError callback for when an error occurs during jwk endpoint fetching
   */
  function getJwkData(jwksUri, onSuccess, onError) {
    const parsedJwkEndpoint = new URL(jwksUri)
    const jwkDiscovery = api({
      host: parsedJwkEndpoint.host,
      path: parsedJwkEndpoint.pathname,
    })

    jwkDiscovery.request(onSuccess, onError)
  }

  /**
   * Module exposes the factory method.
   */
  return factory
})()