Breaking: Version 2 improvements (fixes #29)

[oliverfoster]

fixes #29

Fix

• Reverted changes to broken intersection queries

Update

• isAvailableInHierarchy to account for detached models
• sets sorted by .order
• removed the word raw throughout and changed for more accurate names, availableComponents etc
• removed the word sub throughout, from subset, and changed for more accurate names, set, getSet.., etc
• generally refactor code so that logic is more distinct and easier to read
• split scoringset into interactionset, lifecycleset and scoringset
• adaptmodelset extends interactionset,
• lifecycleset extends interactionset
• isolate the compatibility layer
• automatically assign set ids
• formalise State and Objective apis
• formalise lifecycle phases and triggers for init, restore, start, reset, restart, visit, leave and update, fully integrating adapt-contrib-modifiers
• add order for lifecycle elements so that adapt-contrib-banking, adapt-contrib-randomise and adapt-contrib-scoringAssessment can execute in order, ordering sets appropriately
• separate utility functions into appropriate files
• add jsdocs throughout

New

• added multiple functions to account for detached models
• added TotalSets to replace the set behaviour on the main Adapt.scoring API
• document INTERSECTION_QUERY.md
• document LIFECYCLE.md

Breaking

• Almost every function has been renamed or moved

[cahirodoherty-learningpool]

Conflicts need resolved on this

[joe-replin]

Moved to resolve conflicts and brought in the logging improvements from #26

[danielghost]

Not all sets have a single model, so resetting one of these will not reset all intersected sets. Should any set without a parent model actually allow a reset anyway?

[oliverfoster]

What happens when you give a parent model to your sets that currently have no parent model?

[danielghost]

Adding a parent model to something like a BucketSet, which is configured on the course model, will cause all sets with this parent to reset, even if those sets models don't intersect any other models (excluding course) associated with the set being reset. This prevents the ability to only reset one set configured at the course level.

Suggest amending the logic to match the TODO comment and use:

const sets = filterSetsByIntersectingModels(getAllSets(), set.models);

[oliverfoster]

We should talk about this.

[oliverfoster]

26cd9d3

This is quite a big change and not what was in the to-do comment. It looks like you've done intersecting sets, which also include ancestors.