@ndla/ui 13.2.0 → 14.0.0

package/lib/User/index.d.ts

@@ -6,4 +6,8 @@
  *
  */
 import AuthModal from './AuthModal';
+import { UserInfo } from './UserInfo';
+import type { FeideGoGroup, FeideGroup, FeideOrg, FeideUserApiType } from './apiTypes';
+export { UserInfo };
+export type { FeideGoGroup, FeideGroup, FeideOrg, FeideUserApiType };
 export default AuthModal;

package/lib/User/index.js

@@ -3,10 +3,18 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+Object.defineProperty(exports, "UserInfo", {
+  enumerable: true,
+  get: function get() {
+    return _UserInfo.UserInfo;
+  }
+});
 exports["default"] = void 0;
 
 var _AuthModal = _interopRequireDefault(require("./AuthModal"));
 
+var _UserInfo = require("./UserInfo");
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
 
 /**

package/lib/User/parseUserObject.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Copyright (c) 2022-present, NDLA.
+ *
+ * This source code is licensed under the GPLv3 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { FeideGoGroup, FeideUserApiType } from './apiTypes';
+declare type GoGroupType = 'basic' | 'teaching' | 'other';
+/**
+ * @param user A user object coming from the API
+ * @returns A user object parsed in a presentable way to be handled by i.e UserInfo component.
+ */
+export declare const parseUserObject: (user: FeideUserApiType) => {
+    uid: string[];
+    primaryAffiliation: string;
+    displayName: string;
+    mail: string[] | undefined;
+    organizations: {
+        children: Record<GoGroupType, FeideGoGroup[]>;
+        type: "fc:org";
+        orgType: ("higher_education" | "primary_and_lower_secondary" | "primary_and_lower_secondary_owner" | "upper_secondary" | "upper_secondary_owner")[];
+        norEduOrgNIN?: string | undefined;
+        eduOrgLegalName?: string | undefined;
+        mail?: string | undefined;
+        parent?: string | undefined;
+        public: boolean;
+        id: string;
+        displayName: string;
+        membership: import("./apiTypes").FeideMembershipType;
+    }[];
+};
+export {};

package/lib/User/parseUserObject.js

@@ -0,0 +1,105 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.parseUserObject = void 0;
+
+var _lodash = require("lodash");
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
+
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
+
+function _iterableToArrayLimit(arr, i) { if (typeof Symbol === "undefined" || !(Symbol.iterator in Object(arr))) return; var _arr = []; var _n = true; var _d = false; var _e = undefined; try { for (var _i = arr[Symbol.iterator](), _s; !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
+
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
+
+/**
+ * The keys come from:
+ *  https://docs.feide.no/reference/apis/groups_api/groups_data_model/primary_and_secondary_education_groups.html?highlight=gogroup#specific-attributes-for-fc-gogroup
+ */
+var goGroupTypeMap = {
+  a: 'other',
+  b: 'basic',
+  u: 'teaching'
+};
+/**
+ * @param groups GoGroups to be mapped to specific GoGroupType
+ * @returns GoGroups mapped to GoGroupType. basic, teaching and other..
+ */
+
+var createGroupings = function createGroupings(groups) {
+  return groups.reduce(function (acc, curr) {
+    var type = goGroupTypeMap[curr.go_type];
+    if (!acc[type]) return acc;
+    acc[type] = acc[type].concat(curr);
+    return acc;
+  }, {
+    basic: [],
+    teaching: [],
+    other: []
+  });
+};
+/**
+ * @param groups GoGroups to be mapped to root/child relations.
+ * @returns An object containing root groups mapped with children.
+ */
+
+
+var parseOrgs = function parseOrgs(groups) {
+  var _groups$reduce = groups.reduce(function (acc, curr) {
+    if (curr.type === 'fc:org') {
+      return [acc[0].concat(curr), acc[1]];
+    } else {
+      return [acc[0], acc[1].concat(curr)];
+    }
+  }, [[], []]),
+      _groups$reduce2 = _slicedToArray(_groups$reduce, 2),
+      roots = _groups$reduce2[0],
+      children = _groups$reduce2[1];
+
+  var childrenByParentId = (0, _lodash.groupBy)(children, function (c) {
+    return c.parent;
+  });
+  var rootsWithChildren = roots.map(function (root) {
+    var _childrenByParentId$r;
+
+    return _objectSpread(_objectSpread({}, root), {}, {
+      children: (_childrenByParentId$r = childrenByParentId[root.id]) !== null && _childrenByParentId$r !== void 0 ? _childrenByParentId$r : []
+    });
+  });
+  return rootsWithChildren.map(function (root) {
+    return _objectSpread(_objectSpread({}, root), {}, {
+      children: createGroupings(root.children)
+    });
+  });
+};
+/**
+ * @param user A user object coming from the API
+ * @returns A user object parsed in a presentable way to be handled by i.e UserInfo component.
+ */
+
+
+var parseUserObject = function parseUserObject(user) {
+  var orgs = parseOrgs(user.groups);
+  return {
+    uid: user.uid,
+    primaryAffiliation: user.eduPersonPrimaryAffiliation,
+    displayName: user.displayName,
+    mail: user.mail,
+    organizations: orgs
+  };
+};
+
+exports.parseUserObject = parseUserObject;