@ndla/ui 46.0.1 → 46.1.0

package/src/User/__tests__/parseUserObject-test.ts

@@ -1,316 +0,0 @@
-/**
- * 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 { FeideUserApiType } from '../apiTypes';
-import { parseUserObject } from '../parseUserObject';
-
-const feideUserLaerer: FeideUserApiType = {
-  cn: ['David LærerVGS Jonsen'],
-  displayName: 'David LærerVGS Jonsen',
-  eduPersonAffiliation: ['member', 'employee', 'faculty'],
-  eduPersonPrimaryAffiliation: 'employee',
-  eduPersonPrincipalName: 'david_laerervgs@spusers.feide.no',
-  givenName: ['David LærerVGS'],
-  mail: ['david_laerervgs@feide.no'],
-  sn: ['Jonsen'],
-  uid: ['david_laerervgs'],
-  groups: [
-    {
-      id: 'fc:org:spusers.feide.no',
-      displayName: 'Rogn fylkeskommune',
-      type: 'fc:org',
-      public: false,
-      membership: {
-        basic: 'admin',
-        affiliation: ['member', 'employee', 'faculty'],
-        primaryAffiliation: 'employee',
-        displayName: 'Akademisk ansatt',
-      },
-      orgType: ['higher_education', 'upper_secondary_owner', 'primary_and_lower_secondary_owner'],
-      norEduOrgNIN: 'NO956326503',
-      eduOrgLegalName: 'Rogn fylkeskommune',
-      mail: 'support@feide.no',
-    },
-    {
-      id: 'fc:org:spusers.feide.no:unit:NO956326504',
-      parent: 'fc:org:spusers.feide.no',
-      displayName: 'Lind VGS',
-      type: 'fc:org',
-      public: false,
-      membership: {
-        basic: 'member',
-        primarySchool: true,
-      },
-      orgType: ['primary_and_lower_secondary'],
-    },
-    {
-      id: 'fc:org:spusers.feide.no:unit:NO856326501',
-      parent: 'fc:org:spusers.feide.no',
-      displayName: 'Lerk VGS',
-      type: 'fc:org',
-      public: false,
-      membership: {
-        basic: 'member',
-        primarySchool: false,
-      },
-      orgType: ['primary_and_lower_secondary'],
-    },
-    {
-      id: 'fc:gogroup:spusers.feide.no:b:NO856326501:1sta:2000-07-01:2100-06-30',
-      displayName: 'Klasse 1STA',
-      type: 'fc:gogroup',
-      notBefore: '2000-06-30T22:00:00Z',
-      notAfter: '2100-06-30T23:00:00Z',
-      go_type: 'b',
-      parent: 'fc:org:spusers.feide.no:unit:NO856326501',
-      membership: {
-        basic: 'member',
-        affiliation: ['employee'],
-        displayName: 'Ansatt',
-      },
-      go_type_displayName: 'basisgruppe',
-    },
-    {
-      id: 'fc:gogroup:spusers.feide.no:a:NO856326501:1sta-lab1:2000-07-01:2100-06-30',
-      displayName: 'Laboratoriegruppe 1',
-      type: 'fc:gogroup',
-      notBefore: '2000-06-30T22:00:00Z',
-      notAfter: '2100-06-30T23:00:00Z',
-      go_type: 'a',
-      parent: 'fc:org:spusers.feide.no:unit:NO856326501',
-      membership: {
-        basic: 'member',
-        affiliation: ['employee'],
-        displayName: 'Ansatt',
-      },
-      go_type_displayName: 'other groups',
-    },
-    {
-      id: 'fc:gogroup:spusers.feide.no:a:NO856326501:1sta-lab2:2000-07-01:2100-06-30',
-      displayName: 'Laboratoriegruppe 2',
-      type: 'fc:gogroup',
-      notBefore: '2000-06-30T22:00:00Z',
-      notAfter: '2100-06-30T23:00:00Z',
-      go_type: 'a',
-      parent: 'fc:org:spusers.feide.no:unit:NO856326501',
-      membership: {
-        basic: 'member',
-        affiliation: ['employee'],
-        displayName: 'Ansatt',
-      },
-      go_type_displayName: 'other groups',
-    },
-    {
-      id: 'fc:gogroup:spusers.feide.no:u:NO856326501:1mat11-1map1:2000-07-01:2100-06-30',
-      displayName: 'Matematikk 1P',
-      type: 'fc:gogroup',
-      notBefore: '2000-06-30T22:00:00Z',
-      notAfter: '2100-06-30T23:00:00Z',
-      go_type: 'u',
-      parent: 'fc:org:spusers.feide.no:unit:NO856326501',
-      membership: {
-        basic: 'member',
-        affiliation: ['employee'],
-        displayName: 'Ansatt',
-      },
-      go_type_displayName: 'undervisningsgruppe',
-      grep: {
-        displayName: 'Mathematics 1P',
-        code: 'MAT1011',
-      },
-    },
-    {
-      id: 'fc:gogroup:spusers.feide.no:u:NO856326501:1mat13-1mat1:2000-07-01:2100-06-30',
-      displayName: 'Matematikk 1T',
-      type: 'fc:gogroup',
-      notBefore: '2000-06-30T22:00:00Z',
-      notAfter: '2100-06-30T23:00:00Z',
-      go_type: 'u',
-      parent: 'fc:org:spusers.feide.no:unit:NO856326501',
-      membership: {
-        basic: 'member',
-        affiliation: ['employee'],
-        displayName: 'Ansatt',
-      },
-      go_type_displayName: 'undervisningsgruppe',
-      grep: {
-        displayName: 'Mathematics 1T',
-        code: 'MAT1013',
-      },
-    },
-  ],
-  primarySchool: {
-    id: 'fc:org:spusers.feide.no:unit:NO956326504',
-    parent: 'fc:org:spusers.feide.no',
-    displayName: 'Lind VGS',
-    type: 'fc:org',
-    public: false,
-    membership: {
-      basic: 'member',
-      primarySchool: true,
-    },
-    orgType: ['primary_and_lower_secondary'],
-  },
-};
-
-describe('parseUserObject', () => {
-  it('Correctly parses Feide user', () => {
-    const expected = {
-      uid: ['david_laerervgs'],
-      displayName: 'David LærerVGS Jonsen',
-      mail: ['david_laerervgs@feide.no'],
-      eduPersonAffiliation: ['member', 'employee', 'faculty'],
-      grepCodes: [],
-      organizations: [
-        {
-          id: 'fc:org:spusers.feide.no',
-          displayName: 'Rogn fylkeskommune',
-          type: 'fc:org',
-          public: false,
-          membership: {
-            basic: 'admin',
-            affiliation: ['member', 'employee', 'faculty'],
-            primaryAffiliation: 'employee',
-            displayName: 'Akademisk ansatt',
-          },
-          orgType: ['higher_education', 'upper_secondary_owner', 'primary_and_lower_secondary_owner'],
-          norEduOrgNIN: 'NO956326503',
-          eduOrgLegalName: 'Rogn fylkeskommune',
-          mail: 'support@feide.no',
-          children: {
-            basic: [],
-            teaching: [],
-            other: [],
-          },
-        },
-        {
-          id: 'fc:org:spusers.feide.no:unit:NO956326504',
-          parent: 'fc:org:spusers.feide.no',
-          displayName: 'Lind VGS',
-          type: 'fc:org',
-          public: false,
-          membership: {
-            basic: 'member',
-            primarySchool: true,
-          },
-          orgType: ['primary_and_lower_secondary'],
-          children: {
-            basic: [],
-            teaching: [],
-            other: [],
-          },
-        },
-        {
-          id: 'fc:org:spusers.feide.no:unit:NO856326501',
-          parent: 'fc:org:spusers.feide.no',
-          displayName: 'Lerk VGS',
-          type: 'fc:org',
-          public: false,
-          membership: {
-            basic: 'member',
-            primarySchool: false,
-          },
-          orgType: ['primary_and_lower_secondary'],
-          children: {
-            basic: [
-              {
-                id: 'fc:gogroup:spusers.feide.no:b:NO856326501:1sta:2000-07-01:2100-06-30',
-                displayName: 'Klasse 1STA',
-                type: 'fc:gogroup',
-                notBefore: '2000-06-30T22:00:00Z',
-                notAfter: '2100-06-30T23:00:00Z',
-                go_type: 'b',
-                parent: 'fc:org:spusers.feide.no:unit:NO856326501',
-                membership: {
-                  basic: 'member',
-                  affiliation: ['employee'],
-                  displayName: 'Ansatt',
-                },
-                go_type_displayName: 'basisgruppe',
-              },
-            ],
-            teaching: [
-              {
-                id: 'fc:gogroup:spusers.feide.no:u:NO856326501:1mat11-1map1:2000-07-01:2100-06-30',
-                displayName: 'Matematikk 1P',
-                type: 'fc:gogroup',
-                notBefore: '2000-06-30T22:00:00Z',
-                notAfter: '2100-06-30T23:00:00Z',
-                go_type: 'u',
-                parent: 'fc:org:spusers.feide.no:unit:NO856326501',
-                membership: {
-                  basic: 'member',
-                  affiliation: ['employee'],
-                  displayName: 'Ansatt',
-                },
-                go_type_displayName: 'undervisningsgruppe',
-                grep: {
-                  displayName: 'Mathematics 1P',
-                  code: 'MAT1011',
-                },
-              },
-              {
-                id: 'fc:gogroup:spusers.feide.no:u:NO856326501:1mat13-1mat1:2000-07-01:2100-06-30',
-                displayName: 'Matematikk 1T',
-                type: 'fc:gogroup',
-                notBefore: '2000-06-30T22:00:00Z',
-                notAfter: '2100-06-30T23:00:00Z',
-                go_type: 'u',
-                parent: 'fc:org:spusers.feide.no:unit:NO856326501',
-                membership: {
-                  basic: 'member',
-                  affiliation: ['employee'],
-                  displayName: 'Ansatt',
-                },
-                go_type_displayName: 'undervisningsgruppe',
-                grep: {
-                  displayName: 'Mathematics 1T',
-                  code: 'MAT1013',
-                },
-              },
-            ],
-            other: [
-              {
-                id: 'fc:gogroup:spusers.feide.no:a:NO856326501:1sta-lab1:2000-07-01:2100-06-30',
-                displayName: 'Laboratoriegruppe 1',
-                type: 'fc:gogroup',
-                notBefore: '2000-06-30T22:00:00Z',
-                notAfter: '2100-06-30T23:00:00Z',
-                go_type: 'a',
-                parent: 'fc:org:spusers.feide.no:unit:NO856326501',
-                membership: {
-                  basic: 'member',
-                  affiliation: ['employee'],
-                  displayName: 'Ansatt',
-                },
-                go_type_displayName: 'other groups',
-              },
-              {
-                id: 'fc:gogroup:spusers.feide.no:a:NO856326501:1sta-lab2:2000-07-01:2100-06-30',
-                displayName: 'Laboratoriegruppe 2',
-                type: 'fc:gogroup',
-                notBefore: '2000-06-30T22:00:00Z',
-                notAfter: '2100-06-30T23:00:00Z',
-                go_type: 'a',
-                parent: 'fc:org:spusers.feide.no:unit:NO856326501',
-                membership: {
-                  basic: 'member',
-                  affiliation: ['employee'],
-                  displayName: 'Ansatt',
-                },
-                go_type_displayName: 'other groups',
-              },
-            ],
-          },
-        },
-      ],
-    };
-    const actual = parseUserObject(feideUserLaerer);
-    expect(actual).toEqual(expected);
-  });
-});

package/src/User/apiTypes.ts

@@ -1,84 +0,0 @@
-/**
- * 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.
- *
- */
-
-type OrgType =
-  | 'higher_education'
-  | 'primary_and_lower_secondary'
-  | 'primary_and_lower_secondary_owner'
-  | 'upper_secondary'
-  | 'upper_secondary_owner';
-
-export type AffiliationType = 'member' | 'student' | 'faculty' | 'staff' | 'affiliate' | 'employee';
-
-export interface FeideMembershipType {
-  basic: 'member' | 'admin' | 'owner'; // Basic membership role of user.
-  affiliation?: AffiliationType[];
-  primarySchool?: boolean;
-  primaryAffiliation?: AffiliationType;
-  displayName?: string;
-}
-
-interface FeideBaseGroup {
-  id: string;
-  type: 'fc:org' | 'fc:gogroup' | 'fc:grep';
-  displayName: string;
-  membership: FeideMembershipType;
-}
-
-export interface FeideOrg extends FeideBaseGroup {
-  type: 'fc:org';
-  orgType: OrgType[];
-  norEduOrgNIN?: string;
-  eduOrgLegalName?: string;
-  mail?: string;
-  parent?: string;
-  public: boolean;
-}
-
-export interface FeideGoGroup extends FeideBaseGroup {
-  type: 'fc:gogroup';
-  notBefore: string;
-  notAfter: string;
-  go_type: 'b' | 'u' | 'a';
-  parent: string;
-  go_type_displayName: string;
-  grep?: {
-    displayName: string;
-    code: string;
-  };
-}
-
-export interface FeideGrep extends FeideBaseGroup {
-  type: 'fc:grep';
-  code: string;
-  grep_type: 'aarstrinn' | 'fagkoder';
-  public: boolean;
-}
-
-export type FeideGroup = FeideOrg | FeideGoGroup | FeideGrep;
-
-export interface FeideUser {
-  cn: string[];
-  displayName: string;
-  eduPersonAffiliation: AffiliationType[];
-  eduPersonPrimaryAffiliation: AffiliationType;
-  eduPersonPrincipalName: string;
-  givenName: string[];
-  mail?: string[];
-  schacHomeOrganization?: string;
-  sn: string[];
-  uid: string[];
-  preferredLanguage?: string;
-  mobile?: string;
-}
-
-export interface FeideUserApiType extends FeideUser {
-  groups: FeideGroup[];
-  primarySchool?: FeideGroup;
-  baseOrg?: FeideGroup;
-}

package/src/User/index.ts

@@ -1,21 +0,0 @@
-/**
- * Copyright (c) 2021-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 { UserInfo } from './UserInfo';
-import type {
-  AffiliationType,
-  FeideGoGroup,
-  FeideGroup,
-  FeideOrg,
-  FeideUserApiType,
-  FeideMembershipType,
-  FeideUser,
-} from './apiTypes';
-
-export { UserInfo };
-export type { AffiliationType, FeideGoGroup, FeideGroup, FeideOrg, FeideUserApiType, FeideMembershipType, FeideUser };

package/src/User/parseUserObject.ts

@@ -1,89 +0,0 @@
-/**
- * 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 groupBy from 'lodash/groupBy';
-import { FeideGoGroup, FeideGrep, FeideGroup, FeideOrg, FeideUserApiType } from './apiTypes';
-
-type GoGroupType = 'basic' | 'teaching' | 'other';
-
-/**
- * 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
- */
-const goGroupTypeMap: Record<'a' | 'b' | 'u', GoGroupType> = {
-  a: 'other',
-  b: 'basic',
-  u: 'teaching',
-};
-
-/**
- * @param groups GoGroups to be mapped to specific GoGroupType
- * @returns GoGroups mapped to GoGroupType. basic, teaching and other..
- */
-const createGroupings = (groups: FeideGoGroup[]) => {
-  return groups.reduce<Record<GoGroupType, FeideGoGroup[]>>(
-    (acc, curr) => {
-      const 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.
- */
-const parseOrgs = (groups: FeideGroup[]) => {
-  const [roots, children, grep] = groups.reduce<[FeideOrg[], FeideGoGroup[], FeideGrep[]]>(
-    (acc, curr) => {
-      if (curr.type === 'fc:org') {
-        return [acc[0].concat(curr), acc[1], acc[2]];
-      } else if (curr.type === 'fc:gogroup') {
-        return [acc[0], acc[1].concat(curr), acc[2]];
-      } else {
-        return [acc[0], acc[1], acc[2].concat(curr)];
-      }
-    },
-    [[], [], []],
-  );
-
-  const childrenByParentId = groupBy(children, (c) => c.parent);
-  const rootsWithChildren = roots.map((root) => ({ ...root, children: childrenByParentId[root.id] ?? [] }));
-
-  return {
-    grepCodes: grep,
-    roots: rootsWithChildren.map((root) => ({
-      ...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.
- */
-export const parseUserObject = (user: FeideUserApiType) => {
-  const { roots, grepCodes } = parseOrgs(user.groups);
-
-  return {
-    uid: user.uid,
-    eduPersonAffiliation: user.eduPersonAffiliation,
-    displayName: user.displayName,
-    mail: user.mail,
-    organizations: roots,
-    grepCodes,
-  };
-};