@01-edu/shared 1.1.0 → 1.1.2

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,73 @@ 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 = {})
+  const defautlAttrs = getDefaultAttrsEntries(object)
+  const filteredDefaultAttrs = defautlAttrs.filter(filterFn)
 
-  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)
+  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 = {})
+  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/graph.js

@@ -0,0 +1,96 @@
+const isCoreObj = (contentShape, coreKey) =>
+  typeof contentShape === 'object' && Object.keys(contentShape)[0] === coreKey
+const isSatteliteObj = (contentShape, satteliteKey) =>
+  typeof contentShape === 'object' &&
+  Object.values(contentShape)[0].some(sat => sat === satteliteKey)
+
+export const getCoreSattelites = (coreObject, objectsList) => {
+  const { key, parent } = coreObject
+  const objects = objectsList || Object.values(parent.children)
+  const sattelitesSection = parent.attrs.graph.innerCircle.find(
+    s => s.type === 'slice' && s.innerArc.contents.find(c => isCoreObj(c, key)),
+  )
+  if (!sattelitesSection) return []
+  const sattelitesObject = sattelitesSection.innerArc.contents.find(c =>
+    isCoreObj(c, key),
+  )
+  const sattelitesList = new Set(...Object.values(sattelitesObject))
+
+  return objects.filter(o => sattelitesList.has(o.key))
+}
+
+export const getCoreOfSattelite = (satteliteObject, objectsList) => {
+  const { key, parent } = satteliteObject
+  const objects = objectsList || Object.values(parent.children)
+  const sattelitesSection = parent.attrs.graph?.innerCircle?.find(
+    s =>
+      s.type === 'slice' &&
+      s.innerArc?.contents.find(c => isSatteliteObj(c, key)),
+  )
+  if (!sattelitesSection) return undefined
+  const coreObject = sattelitesSection.innerArc.contents.find(c =>
+    isSatteliteObj(c, key),
+  )
+
+  return objects.filter(o => o.key === Object.keys(coreObject)[0])
+}
+
+export const flatGraphContents = graph => [
+  ...(graph.centralPoint ? [graph.centralPoint] : []),
+  ...(graph.innerCircle || []).flatMap(section =>
+    section.type === 'slice'
+      ? [
+          ...(section.entryPoint ? [section.entryPoint] : []),
+          ...(section.innerArc?.contents || []).flatMap(c =>
+            typeof c === 'string' ? c : Object.entries(c)[0].flat(),
+          ),
+          ...(section.outerArcs || []).flatMap(arc => arc.contents || []),
+        ]
+      : section.contents,
+  ),
+  ...(graph.middleCircle || []).flatMap(arc => arc.contents || []),
+  ...(graph.outerCircle || []).flatMap(arc => arc.contents || []),
+]
+
+// WARNING: without central point (for linear graph, already destructured)
+export const flatAtomeAndCoreContents = graph => [
+  ...(graph.innerCircle || []).flatMap(section =>
+    section.type === 'slice'
+      ? [
+          ...(section.entryPoint ? [section.entryPoint] : []),
+          ...(section.innerArc?.contents || []).flatMap(c =>
+            typeof c === 'string' ? c : Object.keys(c)[0],
+          ),
+          ...(section.outerArcs || []).flatMap(arc => arc.contents || []),
+        ]
+      : section.contents,
+  ),
+  ...(graph.middleCircle || []).flatMap(arc => arc.contents || []),
+  ...(graph.outerCircle || []).flatMap(arc => arc.contents || []),
+]
+
+export const limitations = {
+  LINE: {
+    maxLinesCount: 6,
+    maxContentsCount: 7, // 7 contents max split along a single line
+  },
+  SLICE: {
+    maxSlicesCount: 4,
+    innerCircle: {
+      maxSubContentsCount: 5, // 5 sub-contents max by content
+      maxContentsCount: 30, // 30 contents max spread evenly over the number of inner cirlces of slices
+    },
+    outerArc: {
+      maxArcsCount: 2,
+      maxContentsCount: 10, // 10 contents max spread evenly over the 1 or 2 outer arcs
+    },
+  },
+  MIDDLE_CIRCLE: {
+    maxArcsCount: 8,
+    maxContentsCount: 70, // 70 contents max spread evenly over the number of arcs
+  },
+  OUTER_CIRCLE: {
+    maxArcsCount: 9,
+    maxContentsCount: 90, // 90 contents max spread evenly over the number of arcs
+  },
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@01-edu/shared",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "type": "module",
   "description": "",
   "scripts": {
@@ -13,6 +13,7 @@
     "./onboarding.js",
     "./attrs.js",
     "./attrs-defs.js",
+    "./graph.js",
     "./languages.js",
     "./definitions-checker.js",
     "./path.js",