UNPKG

@smart-consulting/lattice-services

Version:

Collection of common types and functions for connecting to Lattice services

360 lines (359 loc) 15 kB
"use strict"; 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.prototype.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 }; }; var _a; Object.defineProperty(exports, "__esModule", { value: true }); exports.removeUser = exports.ERROR_REMOVE_USER = exports.inviteUserToTeam = exports.getMemberList = exports.ERROR_GET_MEMBER = exports.getActiveTeam = exports.updateTeamAssigns = exports.getTeamList = exports.buildAuthUrl = exports.getProfile = exports.AUTH_USER_PROFILE_ROUTE = void 0; var axios_1 = __importDefault(require("axios")); var t = __importStar(require("io-ts")); var Either_1 = require("fp-ts/lib/Either"); var corgisAuth0Namespace = 'https://wsp-lattice.io/'; var corgisAuth0PermissionsNamespace = 'https://wsp-lattice.io/user_authorization'; var userPermissionsType = t.partial({ corgis: t.array(t.string), adminservice: t.array(t.string), }); var userPermissionsObjectType = t.interface({ permissions: userPermissionsType, }); var userProfileFromServer = t.interface((_a = { aud: t.string, exp: t.number }, _a[corgisAuth0Namespace] = t.interface({ team: t.string, }), _a[corgisAuth0PermissionsNamespace] = userPermissionsObjectType, _a.iat = t.number, _a.iss = t.string, _a.name = t.string, _a.nickname = t.string, _a.nonce = t.string, _a.picture = t.string, _a.sub = t.string, _a.updated_at = t.string, _a)); var ioTeamConfig = t.interface({ _id: t.string, name: t.string, description: t.string, members: t.union([t.array(t.string), t.undefined]), }); var ioTeamMember = t.interface({ email: t.string, email_verified: t.boolean, user_id: t.string, picture: t.string, nickname: t.string, updated_at: t.string, created_at: t.string, name: t.string, app_metadata: t.interface({}), last_login: t.union([t.string, t.null]), logins_count: t.union([t.number, t.null]), }); var ioTeamMemberTotal = t.interface({ total: t.number, users: t.array(t.union([ioTeamMember, t.undefined])), }); var ioTeamResponse = t.interface({ status: t.string, detail: t.string, }); exports.AUTH_USER_PROFILE_ROUTE = '/user-profile'; function getProfile() { return __awaiter(this, void 0, void 0, function () { var response, decoded; return __generator(this, function (_a) { switch (_a.label) { case 0: return [4 /*yield*/, axios_1.default.get(exports.AUTH_USER_PROFILE_ROUTE, { withCredentials: true, })]; case 1: response = _a.sent(); decoded = userProfileFromServer.decode(response.data); if (Either_1.isRight(decoded)) { return [2 /*return*/, { name: decoded.right.name, nickname: decoded.right.nickname, picture: decoded.right.picture, sub: decoded.right.sub, team: decoded.right[corgisAuth0Namespace].team, permissions: decoded.right[corgisAuth0PermissionsNamespace].permissions, }]; } throw new Error("Invalid user profile: " + JSON.stringify(decoded.left)); } }); }); } exports.getProfile = getProfile; /** * Build a tcs URL based on the host and api version. * Prepends the AUTH_SERVICE_HOST environment variable to the URL * * @param route - The absolute route path for the URL. Must begin with a '/'. EG: '/health' * @param version - The API version for the host. Defaults to version 1 * * @returns The full URL to use as an XHR request */ function buildAuthUrl(route, version) { if (version === void 0) { version = 3; } if (!route.startsWith('/')) { throw new Error("Invalid use of buildAuthUrl. Route must start with '/'"); } return process.env.AUTH_SERVICE_HOST + "/v" + version + route; } exports.buildAuthUrl = buildAuthUrl; /** * Generic wrapper around Axios.get() and io-ts. * @param decoder io-ts decoder function * @param url request URL * @param config Axios request config */ function getData(decoder, url, config) { return __awaiter(this, void 0, void 0, function () { var resp, decoded; return __generator(this, function (_a) { switch (_a.label) { case 0: return [4 /*yield*/, axios_1.default.get(url, config)]; case 1: resp = _a.sent(); decoded = decoder(resp.data); if (Either_1.isRight(decoded)) { return [2 /*return*/, decoded.right]; } return [2 /*return*/, undefined]; } }); }); } /** * Retain team list from auth service * @param userID : Auth0 User ID */ function getTeamList(userID) { return __awaiter(this, void 0, void 0, function () { var route, data; return __generator(this, function (_a) { switch (_a.label) { case 0: route = "/teams/" + userID; return [4 /*yield*/, getData(t.array(ioTeamConfig).decode, buildAuthUrl(route), { withCredentials: true, })]; case 1: data = _a.sent(); if (data) { return [2 /*return*/, data]; } throw new Error('Failed to retain team list'); } }); }); } exports.getTeamList = getTeamList; /** * Update active (current) team in Auth service * @param userID : Auth0 user ID * @param teamId : UUID of new current team */ function updateTeamAssigns(userID, teamId) { return __awaiter(this, void 0, void 0, function () { var partialURL, response; return __generator(this, function (_a) { switch (_a.label) { case 0: partialURL = "/teams/" + userID + "/" + teamId; return [4 /*yield*/, axios_1.default.patch(buildAuthUrl(partialURL), {}, { withCredentials: true })]; case 1: response = _a.sent(); if (response.statusText === 'OK') { return [2 /*return*/, true]; } throw new Error('Error updating reference teams'); } }); }); } exports.updateTeamAssigns = updateTeamAssigns; /** * Retain active (current) team of the user * @param userID : Auth0 user ID */ function getActiveTeam(userID) { return __awaiter(this, void 0, void 0, function () { var route, data; return __generator(this, function (_a) { switch (_a.label) { case 0: route = "/teams/" + userID + "/active-team"; return [4 /*yield*/, getData(ioTeamConfig.decode, buildAuthUrl(route), { withCredentials: true })]; case 1: data = _a.sent(); if (data) { return [2 /*return*/, data]; } throw new Error('Error retaining active team'); } }); }); } exports.getActiveTeam = getActiveTeam; exports.ERROR_GET_MEMBER = new Error('Error decoding team members response'); /** * Retrieve list of members from given team in Auth service * @param teamID : Team ID string * @param per_page : Optional number of items to be displayed on each page * @param page : Optional page number */ function getMemberList(teamID, per_page, page) { return __awaiter(this, void 0, void 0, function () { var route, data, err_1; return __generator(this, function (_a) { switch (_a.label) { case 0: route = "/teams/members/" + teamID + "?page=" + (page ? page : 1) + "&per_page=" + (per_page ? per_page : 25); _a.label = 1; case 1: _a.trys.push([1, 3, , 4]); return [4 /*yield*/, getData(ioTeamMemberTotal.decode, buildAuthUrl(route), { withCredentials: true, })]; case 2: data = _a.sent(); if (data) { return [2 /*return*/, data]; } return [3 /*break*/, 4]; case 3: err_1 = _a.sent(); return [2 /*return*/, err_1.response]; case 4: throw exports.ERROR_GET_MEMBER; } }); }); } exports.getMemberList = getMemberList; /** * Check if given user email belongs to specified team. * Return relevant response status/message if user is successfully found or later added to the team; * otherwise, return error response. * @param email : string - User email value * @param teamId : string - Team ID value * @param connection : string - Optional Auth0 connection value */ function inviteUserToTeam(email, teamId, connection) { return __awaiter(this, void 0, void 0, function () { var route, res, err_2; return __generator(this, function (_a) { switch (_a.label) { case 0: route = "/teams/invite_to/" + teamId + "?email=" + email + (connection ? '&connection=' + connection : ''); _a.label = 1; case 1: _a.trys.push([1, 3, , 4]); return [4 /*yield*/, axios_1.default.get(buildAuthUrl(route), { withCredentials: true })]; case 2: res = _a.sent(); return [2 /*return*/, res]; case 3: err_2 = _a.sent(); return [2 /*return*/, err_2.response]; case 4: return [2 /*return*/]; } }); }); } exports.inviteUserToTeam = inviteUserToTeam; exports.ERROR_REMOVE_USER = new Error('Error removing user; unknown response'); /** * Remove given user from specified team. * Return relevant response status/message if user is successfully removed from the team; * otherwise, either return error response or throw error to client log * @param teamId : string - Team ID value * @param userId : string - User ID value e.g. Auth0|xxx */ function removeUser(teamId, userId) { return __awaiter(this, void 0, void 0, function () { var route, res, decoded, err_3; return __generator(this, function (_a) { switch (_a.label) { case 0: route = "/teams/members/" + teamId + "?user_id=" + userId; _a.label = 1; case 1: _a.trys.push([1, 3, , 4]); return [4 /*yield*/, axios_1.default.delete(buildAuthUrl(route), { withCredentials: true })]; case 2: res = _a.sent(); decoded = ioTeamResponse.decode(res.data); if (Either_1.isRight(decoded)) { return [2 /*return*/, decoded.right]; } return [3 /*break*/, 4]; case 3: err_3 = _a.sent(); return [2 /*return*/, err_3.response]; case 4: throw exports.ERROR_REMOVE_USER; } }); }); } exports.removeUser = removeUser;