caccl-api/lib/index.js

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

"use strict";
var __importDefault = (this && this.__importDefault) || function (mod) {
    return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
// Import shared helpers
var genVisitEndpoint_1 = __importDefault(require("./shared/genVisitEndpoint"));
// Import endpoint categories
var ECatAccount_1 = __importDefault(require("./endpoints/ECatAccount"));
var ECatConversation_1 = __importDefault(require("./endpoints/ECatConversation"));
var ECatCourse_1 = __importDefault(require("./endpoints/ECatCourse"));
var ECatOther_1 = __importDefault(require("./endpoints/ECatOther"));
var ECatUser_1 = __importDefault(require("./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
 */
var initAPI = function (opts) {
    if (opts === void 0) { opts = {}; }
    // Initialize defaults
    var processedDefaults = {
        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
    var visitEndpoint = (0, genVisitEndpoint_1.default)(processedDefaults);
    // Create a new API instance
    var api = {};
    // Create a pack of info that's used to initialize each endpoint category
    var initPack = {
        visitEndpoint: visitEndpoint,
        api: api,
        defaultCourseId: opts.defaultCourseId,
    };
    // Initialize and add endpoint categories
    api.account = new ECatAccount_1.default(initPack);
    api.conversation = new ECatConversation_1.default(initPack);
    api.course = new ECatCourse_1.default(initPack);
    api.other = new ECatOther_1.default(initPack);
    api.user = new ECatUser_1.default(initPack);
    // Return api instance
    return api;
};
exports.default = initAPI;
//# sourceMappingURL=index.js.map