adapt-contrib-resources: add contentObject specific resources

[oliverfoster]

Subject of the issue

Currently resources are global, it would be nice to be able to add contentObject specific resources.

Please +1 if you agree that this would be a nice feature.

[moloko]

I had to implement this on a project recently, did it as a new extension (adapt-pageSpecificResources) that extended the behaviour of the core resources extension - the below should still be mostly useful to whoever picks this up

function setupPageSpecificResources(resourcesData) {

    var resourcesModel = new Backbone.Model(resourcesData);
    var resourcesCollection = new Backbone.Collection(resourcesModel.get('_resourcesItems'));

    /**
     * Return the list of resources. If the resources are opened from the main menu, return the entire list
     * If opened from a page, only return resources associated with that page or resources that have no page
     * association defined.
     * @return Backbone.Collection
     */
    function getResourcesCollection() {
        if (Adapt.location._currentLocation === 'course') {
            return resourcesCollection;
        }

        var filteredResources = resourcesCollection.filter(function(resource) {
            var showOnPages = resource.get('_showOnPages');
            if (!showOnPages || showOnPages.length === 0) return true;

            return (showOnPages.indexOf(Adapt.location._currentId) > -1);
        });

        return new Backbone.Collection(filteredResources);
    }

    Adapt.on('pageSpecificResources:showResources', function() {
        Adapt.drawer.triggerCustomView(new ResourcesView({
            model: resourcesModel,
            collection: getResourcesCollection()
        }).$el);
    });

}

[moloko]

Sample JSON:

{
    "_type": "media",
    "title": "Global resource",
    "description": "A YouTube video",
    "_link": "https://youtu.be/mDa42EkgO1A",
    "_forceDownload": false,
    "_showOnPages": []
},
{
    "_type": "link",
    "title": "Page 1 Resource 1",
    "description": "Kineo Website",
    "_link": "https://www.kineo.com",
    "_forceDownload": false,
    "_showOnPages": [
        "5d7101e56169ab34ad379af6"
    ]
},
{
    "_type": "link",
    "title": "Page 1 Resource 2",
    "description": "Adapt website",
    "_link": "https://www.adaptlearning.org",
    "_forceDownload": false,
    "_showOnPages": [
        "5d7101e56169ab34ad379af6"
    ]
},
{
    "_type": "link",
    "title": "Page 1, 2 & 3 Resource",
    "description": "Adapt YouTube Channel",
    "_link": "https://www.youtube.com/channel/UCW8SlSFuCc--B66Gf9fAEcQ",
    "_forceDownload": false,
    "_showOnPages": [
        "5d70fa886169ab34ad3799e3",
        "5d70fa886169ab34ad3799e4",
        "5d70fa886169ab34ad3799e6"
    ]
}

[paul-mediakitchen]

Be good if you can still access the global resources but somehow highlight the content specific resources - just a thought otherwise it may be confusing to the user

[github-actions]

🎉 This issue has been resolved in version 5.3.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀