Dynamic Module Availability

This extension, Dynamic Module Availability, empowers administrators within Brightspot to configure, on a per-site basis, a curated list of modules accessible for each content type, seamlessly organizing them into distinct style groups for enhanced customization.

• Prerequisites
• Installation
• Usage
• Documentation
• Versioning
• Contributing
• Local Development
• License

Prerequisites

This extension requires an instance of Brightspot (version 4.5.15 or later) and access to the project source code.

Installation

Gradle:

api 'com.brightspot:dynamic-module-availability:1.0.0'

Maven:

<dependency>
    <groupId>com.brightspot</groupId>
    <artifactId>dynamic-module-availability</artifactId>
    <version>1.0.0</version>
</dependency>

Substitute 1.0.0 for the desired version found on the releases list.

Usage

To opt in to this behavior, replace the StyleEmbeddedContentCreator class in any @ToolUi.EmbeddedContentCreatorClass(StyleEmbeddedContentCreator.class) annotations with the new content creator class StyleGroupEmbeddedContentCreator:

public class MyContentType extends Content {

    @ToolUi.EmbeddedContentCreatorClass(StyleGroupEmbeddedContentCreator.class)
    private List<ModuleType> contents;
}

Now, while editing the contents field on MyContentType, users will encounter the innovative Embedded Content Creator, revealing only the modules configured in the respective sites and settings.

Optionally

If you want to restrict the types that are available in the CuratedStyleGroup, implement CuratedStyleGroupTypesProvider on a new concrete class and define the ObjectType internal names.

Example:

package brightspot.theme;

import java.util.Arrays;
import java.util.List;
import java.util.stream.Collectors;

import brightspot.genericpage.GenericPage;
import brightspot.homepage.Homepage;
import com.psddev.dari.db.ObjectType;
import com.psddev.dari.db.Record;

public class ProjectCuratedStyleGroupTypesProvider implements CuratedStyleGroupTypesProvider {

    private static final List<Class<? extends Record>> CURATED_TYPES = Arrays.asList(
            GenericPage.class,
            Homepage.class);

    @Override
    public List<String> getCuratedStyleGroupTypes() {
        return CURATED_TYPES.stream()
                .map(ObjectType::getInstance)
                .map(ObjectType::getInternalName)
                .collect(Collectors.toList());
    }
}

Documentation

• Javadocs

Versioning

The version numbers for this extension will strictly follow Semantic Versioning.

Contributing

If you have feedback, suggestions or comments on this open-source platform extension, please feel free to make them publicly on the issues tab here.

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Local Development

Assuming you already have a local Brightspot instance up and running, you can test this extension by running the following command from this project's root directory to install a SNAPSHOT to your local Maven repository:

./gradlew publishToMavenLocal

Next, ensure your project's build.gradle file contains

repositories {
    mavenLocal()
}

Then, add the following to your project's build.gradle file:

dependencies {
    api 'com.brightspot:dynamic-module-availability:1.0.0-SNAPSHOT'
}

Finally, compile your project and run your local Brightspot instance.

License

See: LICENSE.