caccl-api/src/index.ts

A class that defines a set of smart Canvas endpoints that actually behave how you'd expect them to.

// Import shared types
import APIConfig from './shared/types/APIConfig';
import API from './types/API';
import InitPack from './shared/types/InitPack';

// Import shared helpers
import genVisitEndpoint from './shared/genVisitEndpoint';

// Import endpoint categories
import ECatAccount from './endpoints/ECatAccount';
import ECatConversation from './endpoints/ECatConversation';
import ECatCourse from './endpoints/ECatCourse';
import ECatOther from './endpoints/ECatOther';
import ECatUser from './endpoints/ECatUser';

/**
 * Initialize api
 * @author Gabe Abrams
 * @param [opts] object containing all defaults
 * @param [opts.numRetries=3] default number of retries per request
 * @param [opts.itemsPerPage=100] default number of items to request
 *   per page
 * @param [opts.canvasHost=canvas.instructure.com] default hostname of
 *   the Canvas instance to interact with
 * @param [opts.pathPrefix] default path prefix to prepend to all
 *   requests
 * @param [opts.accessToken] default access token to add to all
 *   requests
 * @param [opts.authenticityToken] default authenticity token to
 *   add to all requests no matter what
 * @param [opts.defaultCourseId] default courseId to add to use if no courseId
 *   is provided to course-specific requests
 */
const initAPI = (
  opts: {
    numRetries?: number
    itemsPerPage?: number,
    canvasHost?: string,
    pathPrefix?: string,
    accessToken?: string,
    authenticityToken?: string,
    defaultCourseId?: number,
  } = {},
) => {
  // Initialize defaults
  const processedDefaults: APIConfig = {
    numRetries: (opts.numRetries || 3),
    itemsPerPage: (opts.itemsPerPage || 100),
    canvasHost: (opts.canvasHost || 'canvas.instructure.com'),
    pathPrefix: (opts.pathPrefix || ''),
    accessToken: (opts.accessToken || undefined),
    authenticityToken: (opts.authenticityToken || undefined),
  };

  // Generate a visitEndpoint function
  const visitEndpoint = genVisitEndpoint(processedDefaults);

  // Create a new API instance
  const api: API = ({} as API);

  // Create a pack of info that's used to initialize each endpoint category
  const initPack: InitPack = {
    visitEndpoint,
    api,
    defaultCourseId: opts.defaultCourseId,
  };

  // Initialize and add endpoint categories
  api.account = new ECatAccount(initPack);
  api.conversation = new ECatConversation(initPack);
  api.course = new ECatCourse(initPack);
  api.other = new ECatOther(initPack);
  api.user = new ECatUser(initPack);

  // Return api instance
  return api;
};

export default initAPI;