@01-edu/shared 1.2.2 → 1.2.4

package/attrs-defs.js

@@ -2665,11 +2665,122 @@ const sharedRanksDefinitions = {
     }
   },
 }
+
+types.relatesToContent = Literal('', {
+  label: 'Content',
+  instruction:
+    'Select a child object to link this learning path status to. Each child can only be linked once.',
+  editable: true,
+  restrictive: true,
+  options: (object, value) => {
+    const learnPathStatus = object.attrs?.learnPathStatus
+      ?.flatMap(({ relatesTo }) => relatesTo)
+      .filter(v => v !== value)
+
+    const options = object.children ? Object.keys(object.children) : []
+    return !learnPathStatus
+      ? options
+      : options.filter(k => !learnPathStatus.includes(k))
+  },
+})
+
+types.relatesToArray = TypeObject({
+  label: 'Relates to',
+  instruction:
+    'Link one or more child objects to this learning path status. You can add multiple links by clicking the add button. If student did at least one he will have that status',
+  editable: true,
+  required: true,
+  restrictive: true,
+  value: (...args) => [
+    mapValues(types.relatesToArray.type, subDef =>
+      getDefaultValue(subDef, ...args),
+    ),
+  ],
+  type: [types.relatesToContent],
+})
+
+types.learnerPathStatusName = Literal('', {
+  label: 'Name',
+  editable: true,
+  required: true,
+  primary: true,
+})
+types.definitionRelatesTo = TypeObject({
+  label: 'Status Definition',
+  type: {
+    name: types.learnerPathStatusName,
+    milestone: Literal('', {
+      label: 'Hover description',
+      instruction:
+        'Text that appears when users hover over this item. Use this to provide additional context or helpful information.',
+      editable: true,
+    }),
+    relatesTo: types.relatesToArray,
+  },
+  check: (value, object) => {
+    const { relatesTo: currentRelatesTo, name } = value
+    const { learnPathStatus } = object.attrs
+    const previousValue = learnPathStatus.find(
+      ({ relatesTo }) =>
+        !(
+          currentRelatesTo.length !== relatesTo.length ||
+          currentRelatesTo.some((val, i) => val !== relatesTo[i])
+        ),
+    )
+    if (!previousValue) return
+
+    const isDifferent =
+      previousValue.relatesTo.length !== currentRelatesTo.length ||
+      previousValue.relatesTo.some((val, i) => val !== currentRelatesTo[i])
+
+    const hasSameKey = previousValue.name === name
+    if (!isDifferent && hasSameKey) return
+
+    const definitionsWithSameName = object.attrs.learnPathStatus?.find(
+      v => v.name === name,
+    )
+    if (definitionsWithSameName) {
+      throw Error(
+        `Name "${name}" is already set for a learner path status! A given name can only be attributed once.`,
+      )
+    }
+  },
+})
+
+const learnPathStatus = {
+  label: 'Learner Path Status',
+  instruction: 'List of Learner Status During Campus Steps',
+  editable: true,
+  restrictive: true,
+  value: (...args) => [
+    mapValues(types.learnPathStatus.type, subDef =>
+      getDefaultValue(subDef, ...args),
+    ),
+  ],
+  type: [types.definitionRelatesTo],
+  check: (definition, object) => {
+    if (!object.childrenRelation.length) {
+      throw Error('Must contain at least one relation')
+    }
+    if (!definition?.length || !Array.isArray(definition)) {
+      throw Error('Must be a non empty array')
+    }
+  },
+}
+
 attrs.ranksDefinitions = {
   module: sharedRanksDefinitions,
   piscine: sharedRanksDefinitions,
 }
 
+attrs.learnPathStatus = {
+  // the learn path status will define what the student is during the steps
+  // - applicant (user that registered to the platform and passed the onboarding steps, up until being accepted to participate on the selection piscine/program)
+  // - candidate (user that is participating on the selection piscine)
+  // - learner (user that succeeded on the selection piscine and is participating on the module event)
+  campus: learnPathStatus,
+}
+
 const sharedRegistrationDuration = {
   label: 'Registration duration (to an event)',
   required: true,
@@ -3742,13 +3853,16 @@ types.adminSelectionValidation = TypeObject({
       options: ['admin_selection'],
     }),
   },
-  label: 'Admin selection evaluation',
+  label: 'Admin selection',
+  description: 'Admins manually select which submissions move forward.',
 })
 
 const getTesterImage = ({ attrs }) =>
   attrs.language && `ghcr.io/01-edu/test-${attrs.language}`
 types.testerValidation = TypeObject({
-  label: 'Tester evaluation',
+  label: 'Automatic testing',
+  description:
+    'The solution submitted by the user will be automatically tested and a result will immediately be available.',
   type: {
     type: Literal('tester', {
       required: true,
@@ -3838,11 +3952,11 @@ const sharedTypesForm = {
   ...Functions({ 'README in audit folder': getAuditPath }),
 }
 types.adminAuditValidationDelay = Literal(0, {
-  label: 'Delay',
+  label: 'Audit duration',
   editable: true,
   required: true,
   instruction:
-    'Time allowed to complete the audit before it expires. "0s" equals no delay.', // TODO: convert to MS'
+    'Time that the admins have to complete an audit before it expires', // TODO: convert to MS
 })
 types.adminAuditValidationRequired = Literal(1, {
   label: 'Number required',
@@ -3862,7 +3976,8 @@ types.adminAuditValidationRatio = Literal(1, {
 })
 
 types.adminAuditValidation = TypeObject({
-  label: 'Admin audit evaluation',
+  label: 'Admin audit',
+  description: 'Only admins can evaluate this content.',
   type: {
     type: Literal('admin_audit', {
       required: true,
@@ -3886,10 +4001,11 @@ types.adminAuditValidation = TypeObject({
 })
 
 types.userAuditValidationDelay = Literal((2 * WEEK) / MIN, {
-  label: 'Delay',
+  label: 'Audit duration',
   required: true,
   editable: true,
-  instruction: 'Time allowed to complete the audit before it expires', // TODO: convert to MS
+  instruction:
+    'Time that the users have to complete an audit before it expires', // TODO: convert to MS
 })
 types.userAuditValidationRequired = Literal(5, {
   label: 'Number required',
@@ -3911,10 +4027,11 @@ types.userAuditValidationRatio = Literal(2, {
 })
 
 types.matchInfluence = TypeObject({
-  label: 'Match Algorithm Influence',
+  label: 'Audit Attribution Influence',
   editable: true,
   required: true,
-  instruction: 'Adjust weights in the Match algorithm',
+  instruction:
+    'Adjust the weights in the match algorithm to influence how audits are attributed',
   type: {
     auditsRatio: Literal(2.0, {
       label: 'Current Audit Ratio',
@@ -3940,7 +4057,9 @@ types.matchInfluence = TypeObject({
 })
 
 types.userAuditValidation = TypeObject({
-  label: 'User audit evaluation',
+  label: 'User audit',
+  description:
+    'Users will be assigned as auditors to peer-review the project submission. You can customise the rules of audit attribution and requirements for the group to succeed.',
   type: {
     type: Literal('user_audit', {
       required: true,
@@ -3967,19 +4086,23 @@ types.userAuditValidation = TypeObject({
       editable: true,
       type: 'array',
       label: 'Pre questions',
-      instruction: 'List of questions that appears before the main audit',
+      instruction:
+        'Define a set of questions that appear before the main audit. Go to “edit & preview” mode to visualize the question content',
     },
     postQuestions: {
       editable: true,
       type: 'array',
       label: 'Post questions',
-      instruction: 'List of questions that appears after the main audit',
+      instruction:
+        'Define a set of questions that appear after the main audit. Go to “edit & preview” mode to visualize the question content',
     },
   },
 })
 
 types.raidAuditorValidation = TypeObject({
-  label: 'User audit evaluation (dedicated for event)',
+  label: 'Dedicated auditors for event',
+  description:
+    'Define a list of users that will audit the content. This list is created on each event related to this content, and needs to be available before the event ends.',
   type: {
     type: Literal('dedicated_auditors_for_event', {
       required: true,
@@ -4002,8 +4125,8 @@ types.raidAuditorValidation = TypeObject({
 })
 
 const sharedValidations = {
-  label: 'Evaluated by',
-  instruction: 'List of evaluations to complete in order',
+  label: 'Evaluations required',
+  instruction: 'Define the evaluation methods for this content',
   check: value => {
     if (!value.length) throw Error('must have at least one element')
   },

package/attrs.js

@@ -37,7 +37,8 @@ const typeChecker = (defs, value, object, key) => {
   check?.(value, object, key)
 
   if (options) {
-    const opts = typeof options === 'function' ? options(object) : options
+    const opts =
+      typeof options === 'function' ? options(object, value) : options
     if (opts.length === 1) {
       if (opts[0] !== value) {
         throw Error(`${key} must be ${opts[0]} but was ${value}`)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@01-edu/shared",
-  "version": "1.2.2",
+  "version": "1.2.4",
   "type": "module",
   "description": "",
   "scripts": {

package/toolbox.js

@@ -64,12 +64,6 @@ export const handleKeyDownEvent = args => {
   }
 }
 
-export const swap = (arr, i, j) => {
-  const newArr = [...arr] // don’t mutate the original
-  ;[newArr[i], newArr[j]] = [newArr[j], newArr[i]]
-  return newArr
-}
-
 export const last = array => array[array.length - 1]
 
 export const upperFirst = str =>
@@ -215,6 +209,16 @@ export const toDateFormatWithTime = (d, separator = 'T') => {
 
   return `${toDateFormat(date)}${separator}${hh}:${mm}`
 }
+
+export const toPermanentDateFormatWithTime = (d, separator = 'T') => {
+  const date = toDate(d)
+  const hh = String(date.getHours()).padStart(2, '0')
+  const mm = String(date.getMinutes()).padStart(2, '0')
+  const month = (date.getMonth() + 1).toString().padStart(2, '0')
+  const day = date.getDate().toString().padStart(2, '0')
+
+  return `${date.getFullYear()}-${month}-${day}${separator}${hh}:${mm}`
+}
 export const displayDateTime = dateTime => toDateFormatWithTime(dateTime, ' | ')
 
 export const getMonthName = month => monthNames[month]