@progress/sitefinity-nextjs-sdk/editor/widget-framework/widget-registry.js

Provides OOB widgets developed using the Next.js framework, which includes an abstraction layer for Sitefinity communication. Additionally, it offers an expanded API, typings, and tools for further development and integration.

import { EntityMetadataGenerator } from '@progress/sitefinity-widget-designers-sdk';
export function initRegistry(widgetRegistry) {
    const widgets = Object.keys(widgetRegistry.widgets);
    widgets.forEach(widgetKey => {
        const widgetRegistration = widgetRegistry.widgets[widgetKey];
        if (widgetRegistration.entity == null && widgetRegistration.designerMetadata == null) {
            throw new Error(`There should be either entity or designer metadata provided for ${widgetKey} widget`);
        }
        const metadata = EntityMetadataGenerator.extractMetadata(widgetRegistration.entity);
        addViewChoices(widgetRegistration, metadata);
        if (!widgetRegistration.entity) {
            return;
        }
        const editorMetadata = widgetRegistration.editorMetadata;
        if (metadata && editorMetadata) {
            if (editorMetadata.Name) {
                metadata.Name = editorMetadata.Name;
            }
            if (editorMetadata.Title) {
                metadata.Caption = editorMetadata.Title ?? editorMetadata.Name;
            }
            if (editorMetadata.Toolbox === 'Forms') {
                const propertyMetadataFlat = metadata.PropertyMetadataFlat;
                const initialProperties = widgetRegistration.editorMetadata?.InitialProperties;
                if (propertyMetadataFlat && initialProperties) {
                    const labelProperty = propertyMetadataFlat.find(prop => prop.Name === 'Label' && prop.DefaultValue);
                    if (labelProperty) {
                        initialProperties['Label'] = labelProperty.DefaultValue;
                    }
                }
            }
        }
        widgetRegistration.designerMetadata = metadata;
        delete widgetRegistration.entity;
    });
    return widgetRegistry;
}
function addViewChoices(widgetRegistration, metadata) {
    if (!(widgetRegistration.templates || widgetRegistration.views) || !metadata) {
        return;
    }
    const propertyMetadataFlat = metadata.PropertyMetadata.flatMap(pm => pm.Sections.flatMap(s => s.Properties));
    // TODO: implement a regex in the @ViewSelector to filter views based on it. See the impl in .NetCore renderer for reference
    const viewSelectorsProps = propertyMetadataFlat.filter(p => p.Type === 'viewSelector' && p.Name !== 'SfDetailViewName');
    const SfDetailViewNameProp = propertyMetadataFlat.find(p => p.Name === 'SfDetailViewName');
    viewSelectorsProps.forEach(x => addChoices(x, widgetRegistration, (viewName) => !viewName.toLowerCase().startsWith('details.')));
    addChoices(SfDetailViewNameProp, widgetRegistration, (viewName) => viewName.toLowerCase().startsWith('details.'));
    if (metadata.PropertyMetadataFlat) {
        metadata.PropertyMetadataFlat = propertyMetadataFlat;
    }
}
function addChoices(property, widgetRegistration, viewFilter) {
    if (!property) {
        return;
    }
    let defaultViews = [];
    if (property.Properties['Meta_Choices']) {
        defaultViews = JSON.parse(property.Properties['Meta_Choices']);
    }
    let views = widgetRegistration.views || {};
    // Fallback for deprecated 'templates' props. Remove this code once the prop is removed.
    if (widgetRegistration.templates) {
        views = { ...views, ...widgetRegistration.templates };
    }
    const customViews = Object.keys(views).filter(viewFilter).map(viewName => {
        const resultView = {
            Title: viewName,
            Name: viewName,
            Value: viewName,
            Icon: null
        };
        const view = views[viewName];
        if (typeof view === 'object') {
            resultView.Title = view.Title;
        }
        return resultView;
    });
    const uniqueViews = getUniqueViewChoices([...customViews, ...defaultViews]);
    property.Properties = {
        ...property.Properties,
        'Meta_Choices': JSON.stringify(uniqueViews),
        'Meta_Choices_AllowMultiple': 'False'
    };
}
function getUniqueViewChoices(choices) {
    const uniqueViews = [];
    choices.forEach(view => {
        const isPresent = uniqueViews.some((uView) => uView.Value === view.Value);
        if (!isPresent) {
            uniqueViews.push(view);
        }
    });
    return uniqueViews;
}