richie-education 2.25.0-b2.dev129 → 2.25.0-b2.dev131

package/cunningham.cjs

@@ -68,6 +68,10 @@ module.exports = {
         button: {
           'font-family': 'Montserrat',
         },
+        dashboardListAvatar: {
+          saturation: 30,
+          lightness: 55,
+        },
       },
     },
   },

package/js/api/lms/dummy.ts

@@ -2,7 +2,7 @@ import { AuthenticationBackend, LMSBackend } from 'types/commonDataProps';
 import { Maybe, Nullable } from 'types/utils';
 import { User } from 'types/User';
 import { APILms } from 'types/api';
-import { Enrollment, OpenEdXEnrollment } from 'types';
+import { UnknownEnrollment, OpenEdXEnrollment } from 'types';
 import { location } from 'utils/indirection/window';
 import { CURRENT_JOANIE_DEV_DEMO_USER, RICHIE_USER_TOKEN } from 'settings';
 import { base64Decode } from 'utils/base64Parser';
@@ -139,7 +139,7 @@ const API = (APIConf: LMSBackend | AuthenticationBackend): APILms => {
           }
           resolve(null);
         }),
-      isEnrolled: async (enrollment: Maybe<Nullable<Enrollment>>) =>
+      isEnrolled: async (enrollment: Maybe<Nullable<UnknownEnrollment>>) =>
         new Promise((resolve) => resolve(!!(enrollment as OpenEdXEnrollment)?.is_active)),
       set: (url: string, user: User): Promise<boolean> =>
         new Promise((resolve) => {

package/js/api/lms/openedx-hawthorn.ts

@@ -7,7 +7,7 @@ import { APILms, APIOptions } from 'types/api';
 import { location } from 'utils/indirection/window';
 import { handle } from 'utils/errors/handle';
 import { EDX_CSRF_TOKEN_COOKIE_NAME } from 'settings';
-import { Enrollment, OpenEdXEnrollment } from 'types';
+import { UnknownEnrollment, OpenEdXEnrollment } from 'types';
 import { HttpError, HttpStatusCode } from 'utils/errors/HttpError';
 
 /**
@@ -88,7 +88,7 @@ const API = (APIConf: AuthenticationBackend | LMSBackend, options?: APIOptions):
           throw new HttpError(response.status, response.statusText);
         });
       },
-      isEnrolled: async (enrollment: Maybe<Nullable<Enrollment>>) => {
+      isEnrolled: async (enrollment: Maybe<Nullable<UnknownEnrollment>>) => {
         return new Promise((resolve) => resolve(!!(enrollment as OpenEdXEnrollment)?.is_active));
       },
       set: async (url: string, user: User): Promise<boolean> => {

package/js/types/api.ts

@@ -1,6 +1,6 @@
 import { Maybe, Nullable } from 'types/utils';
 import { User } from 'types/User';
-import { Enrollment } from 'types';
+import { UnknownEnrollment } from 'types';
 
 export interface APIListRequestParams {
   [key: string]: Maybe<string | string[]>;
@@ -23,12 +23,12 @@ export interface APIAuthentication {
 }
 
 export interface APIEnrollment {
-  get(url: string, user: Nullable<User>): Promise<Nullable<Enrollment>>;
-  isEnrolled(enrollment: Maybe<Nullable<Enrollment>>): Promise<Maybe<boolean>>;
+  get(url: string, user: Nullable<User>): Promise<Nullable<UnknownEnrollment>>;
+  isEnrolled(enrollment: Maybe<Nullable<UnknownEnrollment>>): Promise<Maybe<boolean>>;
   set(
     url: string,
     user: User,
-    enrollment?: Maybe<Nullable<Enrollment>>,
+    enrollment?: Maybe<Nullable<UnknownEnrollment>>,
     isActive?: boolean,
   ): Promise<boolean>;
   meta?: {

package/js/types/index.ts

@@ -69,5 +69,4 @@ export interface OpenEdXEnrollment {
  * Use an unknown type to make sure we do not depend on any LMS-specific fields
  * on enrollment objects, just use HTTP response codes.
  */
-// TODO(rlecellier): rename into UnknownEnrollment
-export type Enrollment = unknown;
+export type UnknownEnrollment = unknown;

package/js/utils/StringHelper/index.ts

@@ -1,4 +1,5 @@
 import { Maybe, Nullable } from 'types/utils';
+import { tokens } from 'utils/cunningham-tokens';
 
 export class StringHelper {
   static isString(input: any): boolean {
@@ -19,4 +20,22 @@ export class StringHelper {
       .join('')
       .toUpperCase();
   }
+
+  static toColor(
+    string: string,
+    saturation = tokens.themes.default.components.dashboardListAvatar.saturation,
+    lightness = tokens.themes.default.components.dashboardListAvatar.lightness,
+  ): string {
+    let hash = 0;
+    for (let i = 0; i < string.length; i++) {
+      // eslint-disable-next-line no-bitwise
+      hash = string.charCodeAt(i) + ((hash << 5) - hash);
+      // eslint-disable-next-line no-bitwise
+      hash &= hash;
+    }
+
+    const hue = hash % 360;
+
+    return `hsl(${hue}, ${saturation}%, ${lightness}%)`;
+  }
 }

package/js/utils/cunningham-tokens.ts

@@ -0,0 +1,202 @@
+export const tokens = {
+  themes: {
+    default: {
+      theme: {
+        colors: {
+          'secondary-text': '#555F6B',
+          'secondary-100': '#eff8ff',
+          'secondary-200': '#eaf3fd',
+          'secondary-300': '#e2ebf5',
+          'secondary-400': '#c0c9d3',
+          'secondary-500': '#a3abb4',
+          'secondary-600': '#79818a',
+          'secondary-700': '#656c75',
+          'secondary-800': '#454d55',
+          'secondary-900': '#242b32',
+          'info-text': '#FFFFFF',
+          'info-100': '#EBF2FC',
+          'info-200': '#8CB5EA',
+          'info-300': '#5894E1',
+          'info-400': '#377FDB',
+          'info-500': '#055FD2',
+          'info-600': '#0556BF',
+          'info-700': '#044395',
+          'info-800': '#033474',
+          'info-900': '#022858',
+          'greyscale-100': '#FAFAFB',
+          'greyscale-200': '#F3F4F4',
+          'greyscale-300': '#E7E8EA',
+          'greyscale-400': '#C2C6CA',
+          'greyscale-500': '#9EA3AA',
+          'greyscale-600': '#79818A',
+          'greyscale-700': '#555F6B',
+          'greyscale-800': '#303C4B',
+          'greyscale-900': '#0C1A2B',
+          'greyscale-000': '#FFFFFF',
+          'primary-100': '#ffcad1',
+          'primary-200': '#f19597',
+          'primary-300': '#e86a6f',
+          'primary-400': '#f2444b',
+          'primary-500': '#f72c30',
+          'primary-600': '#e81f2f',
+          'primary-700': '#d60f29',
+          'primary-800': '#c90022',
+          'primary-900': '#bb0014',
+          'success-100': '#EFFCD3',
+          'success-200': '#DBFAA9',
+          'success-300': '#BEF27C',
+          'success-400': '#A0E659',
+          'success-500': '#76D628',
+          'success-600': '#5AB81D',
+          'success-700': '#419A14',
+          'success-800': '#2C7C0C',
+          'success-900': '#1D6607',
+          'warning-100': '#FFF8CD',
+          'warning-200': '#FFEF9B',
+          'warning-300': '#FFE469',
+          'warning-400': '#FFDA43',
+          'warning-500': '#FFC805',
+          'warning-600': '#DBA603',
+          'warning-700': '#B78702',
+          'warning-800': '#936901',
+          'warning-900': '#7A5400',
+          'danger-100': '#F4B0B0',
+          'danger-200': '#EE8A8A',
+          'danger-300': '#E65454',
+          'danger-400': '#E13333',
+          'danger-500': '#DA0000',
+          'danger-600': '#C60000',
+          'danger-700': '#9B0000',
+          'danger-800': '#780000',
+          'danger-900': '#5C0000',
+          'primary-text': '#FFFFFF',
+          'success-text': '#FFFFFF',
+          'warning-text': '#FFFFFF',
+          'danger-text': '#FFFFFF',
+          black: '#090909',
+          'dark-grey': '#232323',
+          charcoal: '#29303b',
+          'slate-grey': '#686868',
+          'battleship-grey': '#686f7a',
+          'light-grey': '#d2d2d2',
+          silver: '#d5dbe0',
+          azure2: '#eceff1',
+          smoke: '#fdfdfd',
+          white: '#ffffff',
+          denim: '#0067b7',
+          firebrick6: '#f72c30',
+          'purplish-grey': '#726c74',
+          grey32: '#525151',
+          grey59: '#969696',
+          grey87: '#dfdfdf',
+          indianred3: '#df484b',
+          midnightblue: '#141b2c',
+          mantis: '#76ce68',
+        },
+        font: {
+          sizes: {
+            h1: '1.75rem',
+            h2: '1.375rem',
+            h3: '1.125rem',
+            h4: '0.8125rem',
+            h5: '0.625rem',
+            h6: '0.5rem',
+            l: '1rem',
+            m: '0.8125rem',
+            s: '0.6875rem',
+          },
+          weights: {
+            thin: 200,
+            light: 300,
+            regular: 400,
+            medium: 500,
+            bold: 600,
+            extrabold: 700,
+            black: 800,
+          },
+          families: { base: 'Hind', accent: 'Montserrat' },
+          letterSpacings: {
+            h1: 'normal',
+            h2: 'normal',
+            h3: 'normal',
+            h4: 'normal',
+            h5: '1px',
+            h6: 'normal',
+            l: 'normal',
+            m: 'normal',
+            s: 'normal',
+          },
+        },
+        spacings: { xl: '4rem', l: '3rem', b: '1.625rem', s: '1rem', t: '0.5rem', st: '0.25rem' },
+        transitions: {
+          'ease-in': 'cubic-bezier(0.32, 0, 0.67, 0)',
+          'ease-out': 'cubic-bezier(0.33, 1, 0.68, 1)',
+          'ease-in-out': 'cubic-bezier(0.65, 0, 0.35, 1)',
+          duration: '250ms',
+        },
+        breakpoints: { xs: 0, sm: '576px', md: '768px', lg: '992px', xl: '1200px', xxl: '1400px' },
+      },
+      components: {
+        button: { 'font-family': 'Montserrat' },
+        dashboardListAvatar: {
+          // hsl saturation range: 0, 100
+          saturation: 30,
+          // hsl lightness range: 0, 100
+          lightness: 55,
+        },
+      },
+    },
+    dark: {
+      theme: {
+        colors: {
+          'greyscale-100': '#182536',
+          'greyscale-200': '#303C4B',
+          'greyscale-300': '#555F6B',
+          'greyscale-400': '#79818A',
+          'greyscale-500': '#9EA3AA',
+          'greyscale-600': '#C2C6CA',
+          'greyscale-700': '#E7E8EA',
+          'greyscale-800': '#F3F4F4',
+          'greyscale-900': '#FAFAFB',
+          'greyscale-000': '#0C1A2B',
+          'primary-100': '#3B4C62',
+          'primary-200': '#4D6481',
+          'primary-300': '#6381A6',
+          'primary-400': '#7FA5D5',
+          'primary-500': '#8CB5EA',
+          'primary-600': '#A3C4EE',
+          'primary-700': '#C3D8F4',
+          'primary-800': '#DDE9F8',
+          'primary-900': '#F4F8FD',
+          'success-100': '#EEF8D7',
+          'success-200': '#D9F1B2',
+          'success-300': '#BDE985',
+          'success-400': '#A0E25D',
+          'success-500': '#76D628',
+          'success-600': '#5BB520',
+          'success-700': '#43941A',
+          'success-800': '#307414',
+          'success-900': '#225D10',
+          'warning-100': '#F7F3D5',
+          'warning-200': '#F0E5AA',
+          'warning-300': '#E8D680',
+          'warning-400': '#E3C95F',
+          'warning-500': '#D9B32B',
+          'warning-600': '#BD9721',
+          'warning-700': '#9D7B1C',
+          'warning-800': '#7E6016',
+          'warning-900': '#684D12',
+          'danger-100': '#F8D0D0',
+          'danger-200': '#F09898',
+          'danger-300': '#F09898',
+          'danger-400': '#ED8585',
+          'danger-500': '#E96666',
+          'danger-600': '#DD6666',
+          'danger-700': '#C36666',
+          'danger-800': '#AE6666',
+          'danger-900': '#9D6666',
+        },
+      },
+    },
+  },
+};

package/js/utils/test/factories/richie.ts

@@ -2,14 +2,7 @@ import { faker } from '@faker-js/faker';
 import { User } from 'types/User';
 import { APIBackend } from 'types/api';
 import { CommonDataProps } from 'types/commonDataProps';
-import {
-  CourseRun,
-  CourseRunDisplayMode,
-  CourseState,
-  CourseStateTextEnum,
-  Enrollment,
-  Priority,
-} from 'types';
+import { CourseRun, CourseRunDisplayMode, CourseState, CourseStateTextEnum, Priority } from 'types';
 import { Course } from 'types/Course';
 import { FactoryHelper } from 'utils/test/factories/helper';
 import { factory } from './factories';
@@ -142,15 +135,6 @@ export const CourseRunFactoryFromPriority = (priority: Priority) => {
   });
 };
 
-export const EnrollmentFactory = factory<Enrollment>(() => {
-  return {
-    id: faker.string.uuid(),
-    created_at: faker.date.past().toISOString(),
-    user: faker.string.uuid(),
-    course_run: faker.string.uuid(),
-  };
-});
-
 export const UserFactory = factory<User>(() => ({
   access_token: faker.lorem.word(12),
   full_name: faker.person.fullName(),

package/js/widgets/Dashboard/components/DashboardAvatar/index.tsx

@@ -12,11 +12,13 @@ export interface DashboardAvatarProps {
   title: string;
   image?: Nullable<JoanieFile>;
   variant?: DashboardAvatarVariantEnum;
+  backgroundColor?: string;
 }
 
 export const DashboardAvatar = ({
   title,
   image,
+  backgroundColor,
   variant = DashboardAvatarVariantEnum.DEFAULT,
 }: DashboardAvatarProps) => {
   return (
@@ -25,6 +27,7 @@ export const DashboardAvatar = ({
       className={c('dashboard__avatar', {
         'dashboard__avatar--square': variant === DashboardAvatarVariantEnum.SQUARE,
       })}
+      style={{ backgroundColor }}
     >
       {image ? (
         <img

package/js/widgets/Dashboard/components/DashboardListAvatar/index.stories.tsx

@@ -0,0 +1,134 @@
+import { Meta, StoryObj } from '@storybook/react';
+import { PropsWithChildren } from 'react';
+import { tokens } from 'utils/cunningham-tokens';
+import DashboardListAvatar from '.';
+
+export default {
+  component: DashboardListAvatar,
+} as Meta<typeof DashboardListAvatar>;
+
+type Story = StoryObj<typeof DashboardListAvatar>;
+
+const names = [
+  'Misty Lesch',
+  'Jo Schoen',
+  'Ida Goyette',
+  'Robin Carroll',
+  'Dr. Natalie Kutch',
+  'Warren Schiller',
+  'Mr. Delbert Rogahn',
+  'Neal Kshlerin',
+  'Virginia Kuhlman',
+  'Robert Baumbach',
+  'Kenneth Okuneva',
+  'Joe Raynor',
+  'Edmond Hegmann',
+  'Jaime Huels',
+  'Marcos Schaden',
+  'Antoinette Dietrich',
+  'Lynn Jast',
+  'Mrs. Edith Schamberger',
+  'Dr. Leo Huels',
+  'Lena Wilkinson',
+  'Corey Schmidt',
+  'Constance Wyman',
+  'Stacy Nolan-Rempel',
+  'Jo Rowe',
+  'Mike Swift',
+  'Yvonne Kutch V',
+  'Norma Bahringer-Wiegand I',
+  'Randy Berge-Goldner',
+  'Gayle Denesik',
+  'Kristina Stracke',
+  'Kenneth Greenholt',
+  'Margarita Bergstrom',
+  'Kim Herman DDS',
+  'Beatrice Rodriguez',
+  'Lori Balistreri',
+  'Priscilla Dietrich-Frami',
+  'Mr. Laurence Welch',
+  'Harold Pollich',
+  'Percy Grimes',
+  'Colin Ryan',
+  'Maxine Bogisich I',
+  'Vernon Hamill',
+  'Ms. Eva Gusikowski',
+  'Mrs. Phyllis Swaniawski',
+  'Bobbie Kilback',
+  'Dr. Roberto Bayer',
+  'Pam Waters-Ankunding',
+  'Gabriel White DVM',
+  'Danny Little',
+  'Leonard Ratke',
+  'Jeremy Nicolas',
+  'Ora Macejkovic PhD',
+  'Jacquelyn Kuhlman',
+  'Hattie Satterfield',
+  'Tricia Heaney-Jacobson',
+  'Mamie Smitham',
+  'Cedric Collins',
+  'Myrtle Oberbrunner IV',
+  'Olga Bernier Sr.',
+  'Isaac Reichel-Zieme MD',
+];
+
+const DashboardListAvatarList = ({ title, children }: PropsWithChildren<{ title: string }>) => {
+  return (
+    <div>
+      <h2 style={{ marginBottom: '1em' }}>{title}</h2>
+      <div
+        style={{
+          display: 'grid',
+          gap: '1rem',
+          gridTemplateColumns: 'repeat(15, minmax(max-content, 1fr))',
+        }}
+      >
+        {children}
+      </div>
+    </div>
+  );
+};
+
+export const Default: Story = {
+  render: () => {
+    const colorSettingList = [
+      {
+        title: `Current: saturation ${tokens.themes.default.components.dashboardListAvatar.saturation}, lightness: ${tokens.themes.default.components.dashboardListAvatar.lightness}`,
+        saturation: tokens.themes.default.components.dashboardListAvatar.saturation,
+        lightness: tokens.themes.default.components.dashboardListAvatar.lightness,
+      },
+      {
+        title: 'saturation 50, lightness: 55',
+        saturation: 50,
+        lightness: 55,
+      },
+      {
+        title: 'saturation 40, lightness: 55',
+        saturation: 40,
+        lightness: 55,
+      },
+      {
+        title: 'saturation 35, lightness: 55',
+        saturation: 35,
+        lightness: 55,
+      },
+      {
+        title: 'saturation 30, lightness: 55',
+        saturation: 30,
+        lightness: 55,
+      },
+    ];
+
+    return (
+      <div style={{ display: 'flex', flexDirection: 'column', gap: '2em' }}>
+        {colorSettingList.map(({ title, ...colorSetting }) => (
+          <DashboardListAvatarList title={title}>
+            {names.map((name) => (
+              <DashboardListAvatar title={name} {...colorSetting} />
+            ))}
+          </DashboardListAvatarList>
+        ))}
+      </div>
+    );
+  },
+};

package/js/widgets/Dashboard/components/DashboardListAvatar/index.tsx

@@ -1,9 +1,20 @@
+import { StringHelper } from 'utils/StringHelper';
 import { DashboardAvatar, DashboardAvatarProps } from '../DashboardAvatar';
 
-const DashboardListAvatar = (props: DashboardAvatarProps) => {
+interface DashboardListAvatarProps extends DashboardAvatarProps {
+  saturation?: number;
+  lightness?: number;
+}
+
+const DashboardListAvatar = ({
+  saturation,
+  lightness,
+  ...avatarProps
+}: DashboardListAvatarProps) => {
+  const backgroundColor = StringHelper.toColor(avatarProps.title, saturation, lightness);
   return (
     <div className="dashboard-list-avatar__container">
-      <DashboardAvatar {...props} />
+      <DashboardAvatar {...avatarProps} backgroundColor={backgroundColor} />
     </div>
   );
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "richie-education",
-  "version": "2.25.0-b2.dev129",
+  "version": "2.25.0-b2.dev131",
   "description": "A CMS to build learning portals for Open Education",
   "main": "sandbox/manage.py",
   "scripts": {
@@ -17,7 +17,7 @@
     "watch-ts": "yarn build-ts --watch",
     "storybook": "storybook dev -p 6006",
     "build-storybook": "storybook build",
-    "build-theme": "cunningham -g scss -o scss/vendors && cunningham -g css -o scss/vendors/css"
+    "build-theme": "cunningham -g scss -o scss/vendors && cunningham -g css -o scss/vendors/css -g ts -o js/utils/"
   },
   "repository": {
     "type": "git",

package/scss/vendors/cunningham-tokens.scss

@@ -156,6 +156,10 @@ $themes: (
       'button': (
         'font-family': Montserrat,
       ),
+      'dashboardListAvatar': (
+        'saturation': 30,
+        'lightness': 55,
+      ),
     ),
   ),
   'dark': (