canvas-api-ts
Version:
Strongly typed canvas lms api
144 lines (143 loc) • 7.22 kB
JavaScript
;
var __assign = (this && this.__assign) || function () {
__assign = Object.assign || function(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
var __read = (this && this.__read) || function (o, n) {
var m = typeof Symbol === "function" && o[Symbol.iterator];
if (!m) return o;
var i = m.call(o), r, ar = [], e;
try {
while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
}
catch (error) { e = { error: error }; }
finally {
try {
if (r && !r.done && (m = i["return"])) m.call(i);
}
finally { if (e) throw e.error; }
}
return ar;
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.canvas = exports.mkHeader = void 0;
var auth_1 = require("../auth/auth");
var node_fetch_1 = __importDefault(require("node-fetch"));
var url_1 = __importDefault(require("url"));
function mkHeader(extra) {
if (extra === void 0) { extra = {}; }
return __assign({ "Authorization": "Bearer " + auth_1.getAuth().token }, extra);
}
exports.mkHeader = mkHeader;
function canvas(props) {
return __awaiter(this, void 0, void 0, function () {
var method, uriParams, param, extraHeaders, uri, headers, _a, url, config;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
method = props.method, uriParams = props.uriParams, param = props.param, extraHeaders = props.extraHeaders;
uri = uriParamsReplace(props.uri, uriParams !== null && uriParams !== void 0 ? uriParams : {});
headers = mkHeader(extraHeaders);
_a = __read((function () {
var base = auth_1.getAuth().url;
var url = url_1.default.resolve(base, uri);
switch (method) {
// build get url. not .env requires a full url with protocol,
// here we need to remove it to use url.,format.
case "GET": {
var hostname = base.split("https://").pop();
var url_2 = url_1.default.format({
protocol: "https",
hostname: hostname,
pathname: uri,
query: param,
});
return [url_2, { headers: headers }];
}
case "POST": {
return [url, { method: "post", body: JSON.stringify(param), headers: headers, }];
}
case "DELETE": {
return [url, { method: "delete", headers: headers, }];
}
case "PUT":
return [url, { method: "put", body: JSON.stringify(param), headers: headers, }];
default:
throw new Error("Wrong HTTP method " + method);
}
})(), 2), url = _a[0], config = _a[1];
return [4 /*yield*/, node_fetch_1.default(url, config)];
case 1: return [2 /*return*/, (_b.sent()).json()];
}
});
});
}
exports.canvas = canvas;
// replace api endpoint params with uriParams.
// throw an exceptoin when uriParams.length and number of endpoint params doesn't match up.
function uriParamsReplace(uri, uriParams) {
return uri.split("/").map(function (e) {
var _a;
if (e.startsWith(":")) {
var key = e.slice(1).trim();
var val = (_a = uriParams[key]) === null || _a === void 0 ? void 0 : _a.toString();
if (val !== undefined) {
return val;
}
throw new Error(""
+ ("Uri parameter is not matched with the api endpoint. " + uri + ", ")
+ ("no parameter corresponds to " + e + "."));
}
else if (e.startsWith("*")) { // combine full path.
var cdr = e.slice(1).trim();
return cdr.startsWith("/") ? cdr.slice(1) : cdr;
}
return e;
}).join("/");
}