@01-edu/shared 1.1.1 → 1.1.3

package/attrs-defs.js

@@ -63,7 +63,7 @@ const firstOfGroup = (a, _i, children) => {
 }
 
 const getObjectPath = object => {
-  const core = getCoreOfSattelite(object)
+  const [core] = getCoreOfSattelite(object) || []
   if (!core) return object.name
   // special case only for projects with a core requirement set
   // const coreName = getCoreName(object)
@@ -919,7 +919,7 @@ relationAttrs.difficultyMod = {
 
 const getName = ({ name }) => name
 const getProjectName = object => {
-  const core = getCoreOfSattelite(object)
+  const [core] = getCoreOfSattelite(object) || []
   if (!core) return object.name
   // only for projects with a core, and which name starts by the core name:
   // remove the core name from the name to avoid repetition
@@ -4114,6 +4114,72 @@ relationAttrs.week = {
   },
 }
 
+const checkRaidLimitation = ({ object, value }) => {
+  const raids = Object.values(object.parent.children).filter(
+    ({ type, key }) => key !== object.key && type === 'raid',
+  )
+  for (const { attrs } of raids) {
+    if (attrs.branch === value) {
+      throw Error('Raids should have their unique branch')
+    }
+  }
+}
+const checkBranchLimitation = ({ object, value, limit = 9 }) => {
+  const contentInBranch = Object.values(object.parent.children).filter(
+    ({ key, attrs }) => key !== object.key && attrs.branch === value,
+  )
+  // + 1 for the current branch being added
+  if (contentInBranch.length + 1 > limit) {
+    throw Error(`The limit of content in a branch is ${limit}`)
+  }
+}
+
+const sharedBranchOptions = {
+  label: 'Base Branch',
+  instruction: 'From 1 to 4',
+  description: 'Changing branch can disrupt the piscine timeline.',
+  required: true,
+  editable: true,
+}
+
+const getBranchOptions = (object, limit = 9) => {
+  const branchCounts = {}
+  for (const child of Object.values(object.parent.children || {})) {
+    const branch = child.attrs.branch
+    branchCounts[branch] = (branchCounts[branch] || 0) + 1
+  }
+  const allBranches = [1, 2, 3, 4]
+  return allBranches.filter(branch => (branchCounts[branch] || 0) < limit)
+}
+
+const sharedBranch = Literal(1, {
+  ...sharedBranchOptions,
+  options: getBranchOptions,
+  check: (value, object) => {
+    checkNumberInBetween(value, 1, 4)
+    checkBranchLimitation({ object, value })
+  },
+})
+
+const raidSharedBranch = Literal(1, {
+  ...sharedBranchOptions,
+  options: [1, 2, 3, 4],
+  check: (value, object) => {
+    checkNumberInBetween(value, 1, 4)
+    checkRaidLimitation({ object, value })
+    checkBranchLimitation({ object, value })
+  },
+})
+relationAttrs.branch = {
+  piscine: {
+    quest: sharedBranch,
+    project: sharedBranch,
+    raid: raidSharedBranch,
+    sharedBranch,
+    exam: sharedBranch,
+  },
+}
+
 const sharedZeroXpIndex = Literal(0, {
   required: true,
   private: true,

package/attrs.js

@@ -344,42 +344,77 @@ const expandAttr = (key, value, defs, object, getUser) => {
   }
 }
 
-export const expandAttrs = (object, getUser) => {
+// same as the `expandDynamicAttrs` this function would resolve dynamic attributes
+// the special use of this function is that we can resolve certain attributes
+// by providing a filter function
+export const partialExpandDynamicAttrs = (object, getUser, filterFn) => {
   if (!object.children) return (object.children = {})
+  if (!Object.keys(object.children).length) return
 
-  for (const [key, defs] of getDefaultAttrsEntries(object)) {
-    if (object.attrs[key] === null) {
-      console.warn(`value is null for ${object.name} - ${key} - ${object.id}`)
-    }
-    expandAttr(key, object.attrs, defs, object, getUser)
+  const defautlAttrs = getDefaultAttrsEntries(object)
+  const filteredDefaultAttrs = defautlAttrs.filter(filterFn)
+
+  processAttributes(filteredDefaultAttrs, object, getUser)
+  let prev
+  for (const child of Object.values(object.children)) {
+    child.parent = object
+    prev && (prev.next = child) && (child.prev = prev)
+    prev = child
+
+    const childDefaultAttrs = getDefaultAttrsEntries(child)
+    const childRelAttrs = getDefaultRelAttrsEntries(object.type, child.type)
+    const [filteredChildAttrs, filteredRelAttrs] = [
+      childDefaultAttrs.filter(filterFn),
+      childRelAttrs.filter(filterFn),
+    ]
+
+    // apply missing default functions
+    // a function can only be missing if it require the user,
+    // the event or current time
+    processAttributes(filteredChildAttrs, child, getUser)
+    processAttributes(filteredRelAttrs, child, getUser)
+    partialExpandDynamicAttrs(child, getUser, filterFn)
   }
+}
 
+// this function allows us to resolve dynamic attributes
+// by converting them into functions that can be re-evaluated
+// this enables attributes to return updated values when re-checked
+// without requiring additional api queries
+// so the result can be recalculated as needed
+export const expandDynamicAttrs = (object, getUser) => {
+  if (!object.children) return (object.children = {})
+  if (!Object.keys(object.children).length) return
+
+  const defautlAttrs = getDefaultAttrsEntries(object)
+
+  processAttributes(defautlAttrs, object, getUser)
   let prev
   for (const child of Object.values(object.children)) {
     child.parent = object
     prev && (prev.next = child) && (child.prev = prev)
     prev = child
 
+    const childDefaultAttrs = getDefaultAttrsEntries(child)
+    const childRelAttrs = getDefaultRelAttrsEntries(object.type, child.type)
+
     // apply missing default functions
     // a function can only be missing if it require the user,
     // the event or current time
-    for (const [key, defs] of getDefaultAttrsEntries(child)) {
-      if (child.attrs[key] === null) {
-        console.warn(`value is null for ${child.name} - ${key} - ${child.id}`)
-      }
-      expandAttr(key, child.attrs, defs, child, getUser)
-    }
-    for (const [key, defs] of getDefaultRelAttrsEntries(
-      object.type,
-      child.type,
-    )) {
-      if (child.attrs[key] === null) {
-        console.warn(`value is null for ${child.name} - ${key} - ${child.id}`)
-      }
-      expandAttr(key, child.attrs, defs, child, getUser)
-    }
+    processAttributes(childDefaultAttrs, child, getUser)
+    processAttributes(childRelAttrs, child, getUser)
+    expandDynamicAttrs(child, getUser)
+  }
+}
 
-    expandAttrs(child, getUser)
+const processAttributes = (attrEntries, targetObject, getUser) => {
+  for (const [key, defs] of attrEntries) {
+    if (targetObject.attrs[key] === null) {
+      console.warn(
+        `value is null for ${targetObject.name} - ${key} - ${targetObject.id}`,
+      )
+    }
+    expandAttr(key, targetObject.attrs, defs, targetObject, getUser)
   }
 }
 

package/package.json

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