@progress/sitefinity-nextjs-sdk/editor/renderer-contract-interfaces.d.ts

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 { WidgetBehavior } from './widget-framework/widget-editor-metadata';
import { WidgetModel } from './widget-framework/widget-model';
export interface RendererContract {
    getWidgetMetadata(args: GetWidgetMetadataArgs): Promise<ComponentMetadata>;
    renderWidget(args: RenderWidgetArgs): Promise<RenderResult>;
    getCategories(args: GetCategoriesArgs): Promise<Array<string>>;
    getWidgets(args: GetWidgetsArgs): Promise<TotalCountResult<Array<WidgetSection>>>;
}
export interface TotalCountResult<T> {
    dataItems: T;
    totalCount: number;
}
export interface RenderResult {
    element: HTMLElement;
    content: string;
    scripts: Array<Script>;
}
export interface Script {
    src: string;
    id: string;
}
export interface WidgetItem {
    name: string;
    title?: string;
    addWidgetTitle?: string;
    addWidgetName?: string;
    /** @deprecated Not used with the new look for widget selector introduced with Sitefinity 15.1 */
    thumbnailUrl?: string;
    iconName?: string;
    iconUrl?: string;
    initialProperties?: Array<{
        name: string;
        value: string;
    }>;
    widgetBehavior?: WidgetBehavior;
}
export interface WidgetSection {
    title: string;
    widgets: WidgetItem[];
}
export interface RenderWidgetArgs {
    dataItem: DataItem;
    siteId: string;
    model: WidgetModel<any>;
    token?: Token;
    segmentId?: string;
    widgetSegmentId?: string;
}
export interface GetCategoriesArgs {
    toolbox?: string;
}
export interface GetWidgetsArgs {
    category?: string;
    search?: string;
    toolbox?: string;
}
export interface GetWidgetMetadataArgs {
    widgetName: string;
}
export interface ComponentMetadata {
    Caption: string;
    Name: string;
    PropertyMetadata: SectionGroup[];
    PropertyMetadataFlat: PropertyMetadata[];
}
export interface PropertyMetadata {
    Name: string;
    Title: string;
    Type: string;
    DefaultValue: string;
    Properties: {
        [key: string]: any;
    };
}
export interface SectionGroup {
    Name: string;
    Sections: SectionData[];
}
export interface SectionData {
    Name: string;
    Title: string;
    Properties: Array<PropertyMetadata>;
}
export interface Token {
    type: string;
    value: string;
}
export interface DataItem {
    readonly provider: string;
    readonly culture: string;
    readonly key: string;
    readonly data: {
        [key: string]: any;
    };
}