canvas-api-ts
Version:
Strongly typed canvas lms api
173 lines (172 loc) • 8.31 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 __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
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 __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.fileUploadConfirm = exports.fileUploadViaPost = exports.uploadAFile = void 0;
var File = __importStar(require("./file"));
var requestBuidler_1 = require("../request/requestBuidler");
var form_data_1 = __importDefault(require("form-data"));
var node_fetch_1 = __importDefault(require("node-fetch"));
var utils_1 = require("../utils");
/**
* upload a file to canvas.
* This function implement the entire process of canvas upload policy.
* @param folderId the folder id.
* @param file the binary representation of the file.
* @param config config for "/api/v1/folders/:folder_id/files" endpoint.
* @return a Promise of confirmed response from canvas server.
*/
function uploadAFile(folderId, fileContent, config) {
return __awaiter(this, void 0, void 0, function () {
var _a, upload_url, upload_params, confirmUrl, confirmedMsg;
return __generator(this, function (_b) {
switch (_b.label) {
case 0: return [4 /*yield*/, File.uploadAFileENDPOINT(folderId, config)];
case 1:
_a = _b.sent(), upload_url = _a.upload_url, upload_params = _a.upload_params;
return [4 /*yield*/, fileUploadViaPost(upload_url, {
file: fileContent,
key: upload_params.key,
})];
case 2:
confirmUrl = _b.sent();
return [4 /*yield*/, fileUploadConfirm(confirmUrl)];
case 3:
confirmedMsg = _b.sent();
return [2 /*return*/, confirmedMsg];
}
});
});
}
exports.uploadAFile = uploadAFile;
/**
* post bianry value
* @param url where we post our data to. It's a url string received from
* UploadAFileENDPOINT endpoint request.
* @param config contains key get from UploadAFileENDPOINT request and
* binary file content.
* note the file is mandatory.
* @return confirm url
*/
function fileUploadViaPost(url, config) {
return __awaiter(this, void 0, void 0, function () {
var form;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
if (!utils_1.isValidURL(url)) {
throw new Error(""
+ ("Problem with " + url + " when performing canvas file upload policy.\n")
+ "More information please check canvas lms api website");
}
form = new form_data_1.default();
if (typeof config.key === "string") {
form.append('key', config.key);
}
form.append('file', config.file);
return [4 /*yield*/, node_fetch_1.default(url, {
method: "post",
body: form,
headers: __assign({}, requestBuidler_1.mkHeader())
})];
case 1: return [2 /*return*/, (_a.sent()).json()];
}
});
});
}
exports.fileUploadViaPost = fileUploadViaPost;
/**
* confirm data is uploaded
* @param url the url string returned from `fileUploadViaPost`. The url is
* used to confirm if file is uploaded.
* Note, if the previous response has status 3xx this confirmation is
* necessary for file to be stored.
* @return confirmed message
*/
function fileUploadConfirm(url) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
if (!utils_1.isValidURL(url)) {
throw new Error(""
+ ("Problem with " + url + " when confirming canvas file upload.\n")
+ "More information please check canvas lms api website");
}
return [4 /*yield*/, node_fetch_1.default(url, {
method: 'post',
headers: __assign(__assign({}, requestBuidler_1.mkHeader()), { "Content-Length": 0 })
})];
case 1: return [2 /*return*/, (_a.sent()).json()];
}
});
});
}
exports.fileUploadConfirm = fileUploadConfirm;