citeright-sdk-js
Version:
An SDK to connect to the CiteRight API.
229 lines (228 loc) • 10.8 kB
JavaScript
"use strict";
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 };
}
};
Object.defineProperty(exports, "__esModule", { value: true });
var axios_1 = require("axios");
var querystring_1 = require("querystring");
var APIAgent = /** @class */ (function () {
function APIAgent(apiServerUrl, clientIdentifier, clientIdentifierPassword, fixedHeaders) {
if (fixedHeaders === void 0) { fixedHeaders = {}; }
this.apiServerUrl = apiServerUrl;
this.clientIdentifier = clientIdentifier;
this.clientIdentifierPassword = clientIdentifierPassword;
this.fixedHeaders = fixedHeaders;
}
/**
* Any time after firing the login() method on this SDK, you should be able to inspect this.isLoggedIn() to verify
* that login was successful.
*
* @returns {boolean}
*/
APIAgent.prototype.isLoggedIn = function () {
return !!this.oAuthTokenResponse;
};
/**
* Use this function to reconstitute a user's logged in session.
*
* @param {string} oauthToken
*/
APIAgent.prototype.reloadFromLoginToken = function (oauthToken) {
this.oAuthTokenResponse = JSON.parse(oauthToken);
return this.oAuthTokenResponse.user;
};
/**
* This is used to extract a stringified version of the login token that can later be used in reloadFromLoginToken.
* This is used when a user's login needs to survive a reload of the environment it is loaded in (like a browser).
* @returns {string}
*/
APIAgent.prototype.getLoginToken = function () {
return JSON.stringify(this.oAuthTokenResponse);
};
/**
* Attempt authentication against our API and store a token that the user can use for future authenticated requests
* using oAuth.
*
* @param {string} email
* @param {string} password
*/
APIAgent.prototype.login = function (email, password) {
return __awaiter(this, void 0, void 0, function () {
var data, auth, response, oAuthTokenResponse, err_1;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
data = { username: email, password: password, grant_type: 'password' };
auth = {
password: this.clientIdentifierPassword,
username: this.clientIdentifier,
};
_a.label = 1;
case 1:
_a.trys.push([1, 3, , 4]);
return [4 /*yield*/, axios_1.default.request({
auth: auth,
baseURL: this.apiServerUrl,
data: querystring_1.stringify(data),
headers: this.fixedHeaders,
method: 'POST',
url: '/auth',
})];
case 2:
response = _a.sent();
oAuthTokenResponse = response.data;
this.oAuthTokenResponse = oAuthTokenResponse;
return [2 /*return*/, oAuthTokenResponse.user];
case 3:
err_1 = _a.sent();
this.oAuthTokenResponse = undefined;
//tslint:disable
// console.error("Error found in HTTP request", err);
if (err_1.response && err_1.response.data) {
throw err_1.response.data;
}
else {
throw err_1;
}
return [3 /*break*/, 4];
case 4: return [2 /*return*/];
}
});
});
};
/**
* Perform an un-authenticated request to the API using POST. Note that although the request does not contain user
* auth, we still send the client identifier.
*
* @param url
* @param method
* @param data
* @param apiUrl
* @returns {Promise<T>}
*/
APIAgent.prototype.executeUnauthenticatedAPICall = function (url, method, data, apiUrl) {
return __awaiter(this, void 0, void 0, function () {
var auth, response, err_2;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
auth = {
password: this.clientIdentifierPassword,
username: this.clientIdentifier,
};
_a.label = 1;
case 1:
_a.trys.push([1, 3, , 4]);
return [4 /*yield*/, axios_1.default.request({
auth: auth,
baseURL: apiUrl ? apiUrl : this.apiServerUrl,
data: method.toUpperCase() === 'GET' ? querystring_1.stringify(data) : data,
headers: this.fixedHeaders,
method: method,
url: url,
})];
case 2:
response = _a.sent();
return [2 /*return*/, response.data];
case 3:
err_2 = _a.sent();
throw err_2.response.data;
case 4: return [2 /*return*/];
}
});
});
};
/**
* Perform an authenticated request to our API server that has data sent as a JSON object in the post body
*
* @param {string} url
* @param {string} method
* @param {object} data
* @param apiUrl
* @returns {Promise<T>}
*/
APIAgent.prototype.executeAuthenticatedApiCall = function (url, method, data, apiUrl) {
return __awaiter(this, void 0, void 0, function () {
var headers, response, err_3;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
if (!this.isLoggedIn()) {
throw new Error('You must be logged in to execute this API call');
}
headers = __assign(__assign({}, this.fixedHeaders), { Authorization: 'Bearer ' + this.oAuthTokenResponse.accessToken, 'Content-Type': 'application/json', UserId: this.oAuthTokenResponse.user.id });
_a.label = 1;
case 1:
_a.trys.push([1, 3, , 4]);
return [4 /*yield*/, axios_1.default.request({
baseURL: apiUrl ? apiUrl : this.apiServerUrl,
data: data,
headers: headers,
method: method,
url: url,
})];
case 2:
response = _a.sent();
return [2 /*return*/, response.data];
case 3:
err_3 = _a.sent();
throw err_3.response.data;
case 4: return [2 /*return*/];
}
});
});
};
APIAgent.prototype.logout = function () {
var _this = this;
return new Promise(function (resolve) {
_this.oAuthTokenResponse = undefined;
resolve();
});
};
return APIAgent;
}());
exports.APIAgent = APIAgent;