@01-edu/shared 1.2.1 → 1.2.3

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,
@@ -2789,7 +2900,17 @@ relationAttrs.requirements = {
     project: sharedContentRequirementsForMainAttr,
     piscine: sharedContentRequirementsForMainAttr,
   },
-  campus: { piscine: sharedContentRequirementsForMainAttr },
+  campus: {
+    piscine: {
+      // TODO: once we start the build the new feature it will no longer be hidden
+      hidden: true,
+      ...sharedContentRequirementsForMainAttr,
+    },
+    module: {
+      hidden: true,
+      ...sharedContentRequirementsForMainAttr,
+    },
+  },
   // should be open to any content: implementation to be checked when needed
   // TODO: add exercise, raid, exam, quest
 }

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.1",
+  "version": "1.2.3",
   "type": "module",
   "description": "",
   "scripts": {

package/toolbox.js

@@ -215,6 +215,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]