**@claspo/editor** *** # @claspo/editor ## LayoutType ### Enumeration Members | Enumeration Member | Value | | ------ | ------ | | `BUILT_IN` | `"BUILT_IN"` | | `DETACHED` | `"DETACHED"` | | `FLOATING_BOX` | `"FLOATING_BOX"` | | `FLOATING_BAR` | `"FLOATING_BAR"` | | `LAUNCHER` | `"LAUNCHER"` | | `CONTENT_LOCKER` | `"CONTENT_LOCKER"` | *** ## WidgetType ### Enumeration Members | Enumeration Member | Value | | ------ | ------ | | `SUBSCRIPTION_FORM` | `"SUBSCRIPTION_FORM"` | | `INFORMER` | `"INFORMER"` | | `REQUEST_FORM` | `"REQUEST_FORM"` | | `LAUNCHER` | `"LAUNCHER"` | | `AGE_VERIFY` | `"AGE_VERIFY"` | | `TEASER` | `"TEASER"` | *** ## AsyncPatternType Async pattern type for API calls. ### Enumeration Members | Enumeration Member | Value | Description | | ------ | ------ | ------ | | `PROMISE` | `"PROMISE"` | Use Promise-based API calls | | `OBSERVABLE` | `"OBSERVABLE"` | Use Observable-based API calls (RxJS) | *** ## ContactMappingOptionType ### Enumeration Members | Enumeration Member | Value | | ------ | ------ | | `TEXT` | `"text"` | | `SELECT` | `"select"` | | `CHECKBOX` | `"checkbox"` | | `TEXT_AREA` | `"textarea"` | | `NUMBER` | `"number"` | | `DATE` | `"date"` | | `DATE_TIME` | `"datetime"` | | `BOOL` | `"bool"` | | `DECIMAL` | `"decimal"` | | `UNKNOWN` | `"unknown"` | *** ## ClPreviewEnvironment ### Enumeration Members | Enumeration Member | Value | | ------ | ------ | | `DESKTOP` | `"DESKTOP"` | | `MOBILE` | `"MOBILE"` | *** ## WidgetProjectConfigId ### Enumeration Members | Enumeration Member | Value | | ------ | ------ | | `ANNOYANCE_SAFEGUARD` | `"ANNOYANCE_SAFEGUARD"` | | `COUNTRY_CODES_PRIORITY` | `"COUNTRY_CODES_PRIORITY"` | | `CABINET_AB_TESTS` | `"CABINET_AB_TESTS"` | *** ## WidgetPublishStatus ### Enumeration Members | Enumeration Member | Value | | ------ | ------ | | `FOR_ALL` | `"FOR_ALL"` | | `PAUSED` | `"PAUSED"` | | `DEBUG` | `"DEBUG"` | *** ## TypeOfFilesFromCommonDir ### Enumeration Members | Enumeration Member | Value | | ------ | ------ | | `FORMS` | `"FORMS"` | | `CLOSE_ICON` | `"CLOSE_ICON"` | | `PROMOCODE_ICON` | `"PROMOCODE_ICON"` | | `GIFT_BOX_ICON` | `"GIFT_BOX_ICON"` | | `SCRATCH_CARD_ICON` | `"SCRATCH_CARD_ICON"` | | `FEEDBACK_ICON` | `"FEEDBACK_ICON"` | *** ## PrizePoolModelI ### Properties | Property | Type | | ------ | ------ | | `id` | `string` | | `sourceType` | `PrizeSourceType` | | `distributionType?` | `PrizeDistributionType` | | `options?` | [`PrizePoolOptionI`](#prizepooloptioni)[] | *** ## PrizePoolOptionI ### Properties | Property | Type | | ------ | ------ | | `valueType` | `PrizeOptionValueType` | | `value` | `string` | | `code` | `string` | | `weight` | `number` | | `id?` | `string` | | `config?` | `PrizeOptionConfigI` | *** ## EditorI Global ClaspoEditor interface exposed on window object. Use `window.ClaspoEditor` to access the editor API. ### Example ```typescript // Initialize editor window.ClaspoEditor.init(config, () => { console.log('Editor loaded'); }, () => { console.error('Editor failed to load'); }); // Save changes window.ClaspoEditor.save({ publishChanges: true }); // Destroy editor window.ClaspoEditor.destroy(); ``` ### Properties | Property | Type | Description | | ------ | ------ | ------ | | `init` | (`config`, `onLoaded?`, `onError?`) => `void` | Initialize the Claspo Editor. | | `destroy` | () => `void` | Destroy the editor instance and cleanup resources. Must be called before re-initializing the editor. | | `save` | (`params?`) => `void` | Save current editor state. | | `cancel` | () => `void` | Cancel editing and discard unsaved changes. | | `getComponentManifests` | () => `any`[] | Get all available component manifests. | | `getDocumentErrors` | () => `any`[] | Get current document validation errors. | *** ## EditorConfigI Main configuration object for initializing the Claspo Editor. ### See https://github.com/Claspo/claspo-plugin-starter-poc/blob/main/quickstart/public/editor.html ### Properties | Property | Type | Description | | ------ | ------ | ------ | | `containerElement` | `HTMLElement` | HTML element or CSS selector where the editor is embedded. Editors takes full width and full height of the element. It’s important to set a size of the element before editor initialization. Editor calculates actual element size and based on that it will calculate the size of it’s blocks. **Remarks** Required | | `countryCode` | `string` | Default country code for phone input components. **See** Code at https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements Default: `"US"` | | `theme` | [`EditorThemeI`](#editorthemei) | Theme configuration for the editor UI. | | `notificationHandlers` | [`EditorConfigNotificationHandlersI`](#editorconfignotificationhandlersi) | Custom notification handlers for editor messages **Default** `console.log will be used` | | `closeEditorCallback` | (`payload`) => `void` | Callback fired when Close button is clicked. Use this to handle editor closure and cleanup. | | `staticResourcesUrl` | `string` | Base URL for static resources (images, fonts, etc.). Must include trailing slash. **Example** ``"https://cdn.claspo.io/static/"`` | | `hostUrl` | `string` | Base URL for the host application. **Example** ``"https://app.claspo.io/"`` | | `availableComponentsPanel` | [`AvailableComponentsPanelConfigI`](#availablecomponentspanelconfigi) | Configuration for the left panel component selector | | `getRevisionPayloadCallback` | (`payload`) => [`CreateWidgetRevisionRequestI`](#createwidgetrevisionrequesti) | Callback to transform revision payload before saving | | `api` | [`EditorApiConfigI`](#editorapiconfigi) | HTTP API configuration for all editor operations | | `userInfo` | [`UserInfoI`](#userinfoi) | Current user identity and language preferences | | `projectConfigs?` | [`WidgetProjectConfigI`](#widgetprojectconfigi)[] | Project-level configurations | | `languagesForMultilingualVersions?` | [`WidgetLanguageI`](#widgetlanguagei)[] | Available languages for multilingual versions of the same widget **Default** `A set of popular languages will be used` | | `initialLoadErrorCallback?` | (`payload`) => `void` | Callback fired on initial data loading errors. If not provided, default error UI will be shown. | | `logo?` | [`EditorLogoI`](#editorlogoi) | Logo configuration displayed in top-left corner. **Example** ``{ imageUrl: 'https://example.com/logo.png', link: 'https://example.com' }`` | | `useContactFields?` | `boolean` | Enable contact fields mapping functionality. | | `localePatch?` | `any` | Override translations by language. **Example** ``'WIDGET_TYPE_FLOATING_BOX': { 'en': 'Floating Box', 'ru': 'Плавающее окно', 'uk': 'Плаваюче вікно', }`` | | `defaultLanguage?` | `string` | The defaultLanguage property serves as a fallback for localePatch when a translation for the user's language is missing. It does not control the editor UI language. **See** - https://docs.claspo.io/docs/localization - https://www.w3schools.com/tags/ref_language_codes.asp | | `showPropertyPaneSettingsInTabs?` | `boolean` | Show property pane settings in tabs layout or on single columns (tabs are hidden) | | `defaultAsyncPattern?` | [`AsyncPatternType`](#asyncpatterntype) | Default async pattern for API calls. `"PROMISE"` by default | | `authToken?` | `string` | Authentication token for editor API access | | `teaserFeatureConfig?` | [`TeaserFeatureConfigI`](#teaserfeatureconfigi) | Teaser feature configuration | | `googleFontsApiKey?` | `string` | Google Fonts API key for font loading | | `previewOpenedCallback?` | () => `void` | Callback fired when preview opens via header button | | `previewClosedCallback?` | () => `void` | Callback fired when preview closes from header button | | `disableImageEditor?` | `boolean` | Disable built-in image editor | | `disableLanguageSelect?` | `boolean` | Disable language selection dropdown at the navbar | | `disableAbilityToRemoveUploadedFiles?` | `boolean` | Prevent users from removing uploaded files | | `productKeyPrefix?` | `string` | Prefix for component tag name in order to resolve conflicts between different sources of components on the same page. | *** ## AvailableComponentsPanelConfigI Configuration for the left panel component selector. Defines which components are available for users to add to widgets. ### Properties | Property | Type | Description | | ------ | ------ | ------ | | `groups` | [`AvailableComponentsGroupI`](#availablecomponentsgroupi)[] | Groups of available components | | `showRequestComponentButton?` | `boolean` | Show "Request component" button at the bottom | *** ## AvailableComponentsGroupI Group of components in the available components panel. ### Properties | Property | Type | Description | | ------ | ------ | ------ | | `label` | `string` | Display label for the group | | `components` | [`AvailableComponentI`](#availablecomponenti)[] | Components in this group | *** ## AvailableComponentI Configuration for a single available component. ### Properties | Property | Type | Description | | ------ | ------ | ------ | | `componentName` | `string` | Component class name (e.g., "SysButtonComponent") | | `customIcon?` | `string` | Custom SVG icon URL | | `customLabel?` | `string` | Custom display label | | `fullWidthIcon?` | `boolean` | Display icon at full width | | `modelOverrides?` | `any` | Override default component model properties | | `dependentComponentNames?` | `string`[] | Components that will be added together with this one | *** ## UserContextI ### Properties | Property | Type | | ------ | ------ | | `domain?` | `string` | | `registrationType?` | `RegistrationType` | *** ## EditorLinksConfigI Configuration for external links shown in the editor. ### Properties | Property | Type | Description | | ------ | ------ | ------ | | `linkParameters?` | `string` | Link parameters template | | `readMoreAboutClickTrackingLink?` | `string` | "Read more" link for click tracking documentation | | `readMoreAboutOpenUrlLink?` | `string` | "Read more" link for Open URL action documentation | | `readMoreAboutCustomDataIosLink?` | `string` | "Read more" link for iOS custom data documentation | | `readMoreAboutCustomDataAndroidLink?` | `string` | "Read more" link for Android custom data documentation | | `externalLinks?` | `any` | Additional external links | | `eventsTypes?` | `any` | Event types configuration | | `domain?` | `string` | Default domain for links | *** ## EditorConfigNotificationHandlersI Custom notification handlers for editor messages. Implement these methods to integrate with your notification system. ### Example ```typescript const notificationHandlers: EditorConfigNotificationHandlersI = { success: (msg) => toast.success(msg), error: (msg) => toast.error(msg), warning: (msg) => toast.warning(msg), info: (msg) => toast.info(msg), hide: () => toast.dismiss() }; ``` ### Properties | Property | Type | Description | | ------ | ------ | ------ | | `success` | (`message`) => `void` | Show success notification | | `info` | (`message`) => `void` | Show info notification | | `warning` | (`message`) => `void` | Show warning notification | | `error` | (`message`) => `void` | Show error notification | | `hide` | () => `void` | Hide all notifications | *** ## ActionOptionsI Configuration for click action behavior in the editor. ### Properties | Property | Type | Description | | ------ | ------ | ------ | | `availableClickActions?` | `ClDocumentActionType`[] | List of available click actions for components | | `isDisplayingOpenLinkNewTabSwitch?` | `boolean` | Show "Open link in new tab" switch. | | `isDisplayingCustomData?` | `boolean` | Show custom data input fields | | `isAllowDeepLink?` | `boolean` | Allow deep link configuration | *** ## ColumnsOptionsI Configuration for columns component behavior. ### Properties | Property | Type | Description | | ------ | ------ | ------ | | `allowHideColumnOnMobile?` | `boolean` | Allow hiding individual columns on mobile view | *** ## TeaserFeatureConfigI Configuration for teaser (minimized widget) feature. ### Properties | Property | Type | Description | | ------ | ------ | ------ | | `enabled` | `boolean` | Enable teaser functionality | | `defaultDocumentModel` | [`ClDocumentI`](#cldocumenti) | Default document model for new teasers | | `enabledForLayouts?` | [`LayoutType`](#layouttype)[] | Layouts where teaser is available | | `availableComponentsPanel?` | [`AvailableComponentsPanelConfigI`](#availablecomponentspanelconfigi) | Component panel configuration for teaser editor | *** ## CloseEditorCallbackPayloadI Payload passed to [EditorConfigI.closeEditorCallback](#closeeditorcallback). ### Properties | Property | Type | Description | | ------ | ------ | ------ | | `variant` | [`WidgetVariantI`](#widgetvarianti) | Current widget variant data | *** ## GetRevisionPayloadCallbackPayloadI Payload passed to [EditorConfigI.getRevisionPayloadCallback](#getrevisionpayloadcallback). ### Properties | Property | Type | Description | | ------ | ------ | ------ | | `variant` | [`WidgetVariantI`](#widgetvarianti) | Current widget variant | | `appearances` | [`WidgetAppearanceI`](#widgetappearancei)[] | All widget appearances (desktop, mobile, etc.) | | `publishStatus` | [`WidgetPublishStatus`](#widgetpublishstatus) | Current publish status | *** ## InitialLoadErrorCallbackPayloadI Payload passed to [EditorConfigI.initialLoadErrorCallback](#initialloaderrorcallback). ### Properties | Property | Type | Description | | ------ | ------ | ------ | | `status` | `number` | HTTP status code of the failed request | *** ## EditorThemeI Simplified theme configuration for the Claspo Editor. This interface provides a streamlined API for external developers with only the essential customization options. ### Example ```typescript const theme: EditorThemeI = { primaryColor: '#F3492C', primaryFontFace: 'Montserrat, sans-serif', secondaryColor: '#ffffff', successColor: '#27C173', errorColor: '#E72324' }; ``` ### Properties | Property | Type | Description | | ------ | ------ | ------ | | `primaryColor` | `string` | Primary brand color used throughout the editor | | `primaryFontFace` | `string` | Main font family for the editor UI | | `secondaryColor?` | `string` | Secondary/background color | | `successColor?` | `string` | Success state color | | `warningColor?` | `string` | Warning state color | | `infoColor?` | `string` | Info state color | | `errorColor?` | `string` | Error state color | | `disabledFontColor?` | `string` | Disabled elements font color | | `primaryFontColor?` | `string` | Primary text color | | `secondaryFontColor?` | `string` | Secondary text color | | `buttonFontWeight?` | `string` | Button font weight | | `primaryButtonFontColor?` | `string` | Primary button text color | | `secondaryButtonFontColor?` | `string` | Secondary button text color | | `secondaryButtonBorderColor?` | `string` | Secondary button border color | | `secondaryButtonBorderWidth?` | `string` | Secondary button border width | | `buttonLoadingBackground?` | `string` | Button loading state background | | `buttonHeight?` | `string` | Button height | | `buttonPadding?` | `string` | Button padding | | `buttonPaddingWithIcon?` | `string` | Button padding when icon is present | | `inputLoadingBackground?` | `string` | Input loading state background | | `textInputDefaultBorderColor?` | `string` | Text input default border color | | `textInputDefaultBorderWidth?` | `string` | Text input default border width | | `textInputDefaultBackgroundColor?` | `string` | Text input default background color | | `textInputPadding?` | `string` | Text input padding | | `checkboxDefaultBorderColor?` | `string` | Checkbox default border color | | `checkboxDefaultBorderWidth?` | `string` | Checkbox default border width | | `checkboxDefaultBackgroundColor?` | `string` | Checkbox default background color | | `checkboxSelectedIconColor?` | `string` | Checkbox selected icon color | | `checkboxSize?` | `string` | Checkbox size | | `radioButtonDefaultBackgroundColor?` | `string` | Radio button default background color | | `switchDefaultBackgroundColor?` | `string` | Switch default background color | | `switchIconColor?` | `string` | Switch icon color | | `selectDefaultBorderColor?` | `string` | Select default border color | | `selectDefaultBorderWidth?` | `string` | Select default border width | | `selectDefaultBackgroundColor?` | `string` | Select default background color | | `selectPadding?` | `string` | Select padding | | `largeBorderRadius?` | `string` | Large border radius for rounded elements | | `smallBorderRadius?` | `string` | Small border radius for subtle rounding | | `contextMenuSelectedBackgroundColor?` | `string` | Context menu selected item background color | | `snackBarPositionTop?` | `string` | Snackbar position from top | | `snackBarPadding?` | `string` | Snackbar padding | | `darkerPrimaryColorKey?` | `string` | Darker shade of primary color (CSS value) | | `lighterPrimaryColor?` | `string` | Lighter shade of primary color | | `veryLightPrimaryColor?` | `string` | Very light shade of primary color (for backgrounds) | | `iconPickerColor?` | `string` | Icon picker accent color | | `notification?` | \{ `padding?`: `string`; `borderRadius?`: `string`; `boxShadow?`: `string`; `textColor?`: `string`; `warningBackgroundColor?`: `string`; `fontSize?`: `string`; \} | Notification theme settings | | `notification.padding?` | `string` | - | | `notification.borderRadius?` | `string` | - | | `notification.boxShadow?` | `string` | - | | `notification.textColor?` | `string` | - | | `notification.warningBackgroundColor?` | `string` | - | | `notification.fontSize?` | `string` | - | | `dialog?` | \{ `titleFontSize?`: `string`; `titleFontWeight?`: `string`; \} | Dialog theme settings | | `dialog.titleFontSize?` | `string` | - | | `dialog.titleFontWeight?` | `string` | - | | `checkbox?` | \{ `valueFontSize?`: `string`; `valueFontColor?`: `string`; \} | Checkbox component theme settings | | `checkbox.valueFontSize?` | `string` | - | | `checkbox.valueFontColor?` | `string` | - | | `select?` | \{ `filterBorderRadius?`: `string`; `filterPadding?`: `string`; `filterIconPadding?`: `string`; \} | Select filter theme settings | | `select.filterBorderRadius?` | `string` | - | | `select.filterPadding?` | `string` | - | | `select.filterIconPadding?` | `string` | - | | `input?` | \{ `labelMargin?`: `string`; `textInputTextareaPadding?`: `string`; `searchInputBackgroundIconColor?`: `string`; `searchInputBorderRadius?`: `string`; `searchInputIconColorActive?`: `string`; \} | Input field theme settings | | `input.labelMargin?` | `string` | - | | `input.textInputTextareaPadding?` | `string` | - | | `input.searchInputBackgroundIconColor?` | `string` | - | | `input.searchInputBorderRadius?` | `string` | - | | `input.searchInputIconColorActive?` | `string` | - | | `dropdown?` | \{ `borderRadius?`: `string`; `padding?`: `string`; `leftRightIndent?`: `string`; \} | Dropdown menu theme settings | | `dropdown.borderRadius?` | `string` | - | | `dropdown.padding?` | `string` | - | | `dropdown.leftRightIndent?` | `string` | - | | `editorOption?` | \{ `customPrizeImageSize?`: `string`; `borderDefaultColor?`: `string`; `borderClearButtonColor?`: `string`; `borderRadiusToggleButtons?`: `string`; `descriptionFontSize?`: `string`; `backgroundToggleButtonSelected?`: `string`; `backgroundToggleTextButtonSelected?`: `string`; `backgroundToggleButtonHover?`: `string`; `defaultBorder?`: `string`; \} | Editor option controls theme settings | | `editorOption.customPrizeImageSize?` | `string` | - | | `editorOption.borderDefaultColor?` | `string` | - | | `editorOption.borderClearButtonColor?` | `string` | - | | `editorOption.borderRadiusToggleButtons?` | `string` | - | | `editorOption.descriptionFontSize?` | `string` | - | | `editorOption.backgroundToggleButtonSelected?` | `string` | - | | `editorOption.backgroundToggleTextButtonSelected?` | `string` | - | | `editorOption.backgroundToggleButtonHover?` | `string` | - | | `editorOption.defaultBorder?` | `string` | - | | `editorPrizeOption?` | \{ `gridTemplateColumns?`: `string`; `decrementIncrementGap?`: `string`; `chancePseudoBorderRight?`: `string`; `customEsInputFormWidth?`: `string`; `confirmButtonBottomPadding?`: `string`; \} | Prize option editor theme settings | | `editorPrizeOption.gridTemplateColumns?` | `string` | - | | `editorPrizeOption.decrementIncrementGap?` | `string` | - | | `editorPrizeOption.chancePseudoBorderRight?` | `string` | - | | `editorPrizeOption.customEsInputFormWidth?` | `string` | - | | `editorPrizeOption.confirmButtonBottomPadding?` | `string` | - | | `dropzone?` | \{ `codeFont?`: `string`; \} | Dropzone/code editor theme settings | | `dropzone.codeFont?` | `string` | - | | `slidebar?` | \{ `padding?`: `string`; `margin?`: `string`; `titleFontSize?`: `string`; `titleFontWeight?`: `string`; \} | Slidebar/sidebar theme settings | | `slidebar.padding?` | `string` | - | | `slidebar.margin?` | `string` | - | | `slidebar.titleFontSize?` | `string` | - | | `slidebar.titleFontWeight?` | `string` | - | | `editorPanel?` | \{ `smallBorderRadius?`: `string`; `rewardsInputWidth?`: `string`; `errorNotificationBackgroundColor?`: `string`; `errorNotificationLeftPadding?`: `string`; `tabsBackgroundColor?`: `string`; `tabBackgroundColor?`: `string`; `tabsDeviceBackgroundColor?`: `string`; `tabHoverBackgroundColor?`: `string`; `tabHoverColor?`: `string`; `tabBorderRadius?`: `string`; `borderLeftWidthSelected?`: `string`; `borderTopWidthSelected?`: `string`; `borderRightWidthSelected?`: `string`; `borderBottomWidthSelected?`: `string`; `borderBottomWidth?`: `string`; `tabPadding?`: `string`; `tabHeaderPadding?`: `string`; `tabButtonPadding?`: `string`; `tabHeight?`: `string`; `tabGap?`: `string`; \} | Editor panel (tabs, property pane) theme settings | | `editorPanel.smallBorderRadius?` | `string` | - | | `editorPanel.rewardsInputWidth?` | `string` | - | | `editorPanel.errorNotificationBackgroundColor?` | `string` | - | | `editorPanel.errorNotificationLeftPadding?` | `string` | - | | `editorPanel.tabsBackgroundColor?` | `string` | - | | `editorPanel.tabBackgroundColor?` | `string` | - | | `editorPanel.tabsDeviceBackgroundColor?` | `string` | - | | `editorPanel.tabHoverBackgroundColor?` | `string` | - | | `editorPanel.tabHoverColor?` | `string` | - | | `editorPanel.tabBorderRadius?` | `string` | - | | `editorPanel.borderLeftWidthSelected?` | `string` | - | | `editorPanel.borderTopWidthSelected?` | `string` | - | | `editorPanel.borderRightWidthSelected?` | `string` | - | | `editorPanel.borderBottomWidthSelected?` | `string` | - | | `editorPanel.borderBottomWidth?` | `string` | - | | `editorPanel.tabPadding?` | `string` | - | | `editorPanel.tabHeaderPadding?` | `string` | - | | `editorPanel.tabButtonPadding?` | `string` | - | | `editorPanel.tabHeight?` | `string` | - | | `editorPanel.tabGap?` | `string` | - | | `editorInputs?` | \{ `selectDefaultAlignItems?`: `string`; `selectDefaultJustifyContent?`: `string`; `selectInputDefaultMinHeight?`: `string`; `selectInputDefaultLineHeight?`: `string`; `inputDefaultMinWidth?`: `string`; `inputSmallMinWidth?`: `string`; `selectBodyWidth?`: `string`; `searchInputBoxShadow?`: `string`; `searchInputBackgroundIconColor?`: `string`; `searchInputBorderRadius?`: `string`; `searchInputBackgroundActiveColor?`: `string`; `searchInputBorderActiveColorHover?`: `string`; `searchInputBackgroundActiveMargin?`: `string`; `selectTextParamsWidth?`: `string`; \} | Editor inputs theme settings | | `editorInputs.selectDefaultAlignItems?` | `string` | - | | `editorInputs.selectDefaultJustifyContent?` | `string` | - | | `editorInputs.selectInputDefaultMinHeight?` | `string` | - | | `editorInputs.selectInputDefaultLineHeight?` | `string` | - | | `editorInputs.inputDefaultMinWidth?` | `string` | - | | `editorInputs.inputSmallMinWidth?` | `string` | - | | `editorInputs.selectBodyWidth?` | `string` | - | | `editorInputs.searchInputBoxShadow?` | `string` | - | | `editorInputs.searchInputBackgroundIconColor?` | `string` | - | | `editorInputs.searchInputBorderRadius?` | `string` | - | | `editorInputs.searchInputBackgroundActiveColor?` | `string` | - | | `editorInputs.searchInputBorderActiveColorHover?` | `string` | - | | `editorInputs.searchInputBackgroundActiveMargin?` | `string` | - | | `editorInputs.selectTextParamsWidth?` | `string` | - | *** ## ResolvedDataI Data returned by [EditorApiConfigI.getWidgetData](#getwidgetdata). Contains all information needed to initialize the editor. ### Properties | Property | Type | Description | | ------ | ------ | ------ | | `widgetData` | [`ResolvedWidgetDataI`](#resolvedwidgetdatai) | Main widget data | | `teaserData` | [`ResolvedWidgetDataI`](#resolvedwidgetdatai) | Teaser (minimized widget) data, if enabled | | `linkedWidgets` | [`WidgetsListItemI`](#widgetslistitemi)[] | List of widgets that can be linked | | `prizePools?` | [`PrizePoolModelI`](#prizepoolmodeli)[] | Prize pools for gamification widgets | *** ## ResolvedWidgetDataI Widget-specific data within [ResolvedDataI](#resolveddatai). ### Properties | Property | Type | Description | | ------ | ------ | ------ | | `variant` | [`WidgetVariantDtoI`](#widgetvariantdtoi) | Widget variant (form) data | | `appearances` | [`WidgetAppearanceI`](#widgetappearancei)[] | All appearances (desktop, mobile, etc.) | | `latestRevision` | [`WidgetRevisionI`](#widgetrevisioni) | Latest saved revision | | `currentRevision` | [`WidgetRevisionI`](#widgetrevisioni) | Currently loaded revision | | `publishStatus` | [`WidgetPublishStatus`](#widgetpublishstatus) | Current publish status | *** ## DataToSaveI Data passed to [EditorApiConfigI.saveWidgetData](#savewidgetdata). Contains both original and modified data for comparison. ### Properties | Property | Type | Description | | ------ | ------ | ------ | | `widgetData` | [`WidgetDataToSaveI`](#widgetdatatosavei) | Main widget data to save | | `teaserData` | [`WidgetDataToSaveI`](#widgetdatatosavei) | Teaser data to save, if enabled | | `pristineConfigs` | [`WidgetProjectConfigI`](#widgetprojectconfigi)[] | Original project configs (for comparison) | | `updatedConfigs` | [`WidgetProjectConfigI`](#widgetprojectconfigi)[] | Modified project configs | | `publishChanges` | `boolean` | Whether to publish changes immediately | *** ## WidgetDataToSaveI Widget-specific data within [DataToSaveI](#datatosavei). ### Properties | Property | Type | Description | | ------ | ------ | ------ | | `pristineAppearances` | [`WidgetAppearanceI`](#widgetappearancei)[] | Original appearances (for comparison) | | `updatedAppearances` | [`WidgetAppearanceI`](#widgetappearancei)[] | Modified appearances | | `pristineVariant` | [`WidgetVariantI`](#widgetvarianti) | Original variant (for comparison) | | `updatedVariant` | [`WidgetVariantI`](#widgetvarianti) | Modified variant | | `publishStatus` | [`WidgetPublishStatus`](#widgetpublishstatus) | Current publish status | *** ## EditorApiConfigI HTTP API configuration for all editor operations. All methods can return either Promise or Observable based on [EditorConfigI.defaultAsyncPattern](#defaultasyncpattern). ### Example ```typescript const api: EditorApiConfigI = { getWidgetData: () => fetch('/api/widget').then(r => r.json()), saveWidgetData: (data) => fetch('/api/widget', { method: 'POST', body: JSON.stringify(data) }), // ... other methods }; ``` ### Methods #### createWidgetPrizePool() ```ts createWidgetPrizePool(body): | Observable<{ id: string; }> | Promise<{ id: string; }>; ``` Create a new prize pool for gamification ##### Parameters | Parameter | Type | | ------ | ------ | | `body` | [`PrizePoolModelI`](#prizepoolmodeli) | ##### Returns \| `Observable`\<\{ `id`: `string`; \}\> \| `Promise`\<\{ `id`: `string`; \}\> #### updateWidgetPrizeOptions() ```ts updateWidgetPrizeOptions(payload): Promise | Observable; ``` Update prize options in a prize pool ##### Parameters | Parameter | Type | | ------ | ------ | | `payload` | [`UpdateWidgetPrizeOptionsPayloadI`](#updatewidgetprizeoptionspayloadi) | ##### Returns `Promise`\<`void`\> \| `Observable`\<`void`\> ### Properties | Property | Type | Description | | ------ | ------ | ------ | | `getWidgetData` | () => \| `Observable`\<[`ResolvedDataI`](#resolveddatai)\> \| `Promise`\<[`ResolvedDataI`](#resolveddatai)\> | Fetch initial widget data for editor initialization | | `saveWidgetData` | (`data`) => `Promise`\<`void`\> \| `Observable`\<`void`\> | Save widget data (appearances, variant, configs) | | `getWidgetAppearances` | (`payload`) => \| `Observable`\<[`WidgetAppearanceI`](#widgetappearancei)[]\> \| `Promise`\<[`WidgetAppearanceI`](#widgetappearancei)[]\> | Fetch appearances for a specific widget | | `createWidgetRevision` | (`payload`) => \| `Observable`\<[`CreateWidgetRevisionResponseI`](#createwidgetrevisionresponsei)\> \| `Promise`\<[`CreateWidgetRevisionResponseI`](#createwidgetrevisionresponsei)\> | Create a new widget revision (save point) | | `getWidgetsList` | (`params`) => \| `Observable`\<[`BaseListDtoI`](#baselistdtoi)\<[`WidgetsListItemI`](#widgetslistitemi)\>\> \| `Promise`\<[`BaseListDtoI`](#baselistdtoi)\<[`WidgetsListItemI`](#widgetslistitemi)\>\> | Fetch list of widgets for linking | | `getFilesFromCommonDir` | (`payload`) => \| `Observable`\<\{ `url`: `string`; \}[]\> \| `Promise`\<\{ `url`: `string`; \}[]\> | Get files from common directory (icons, backgrounds, etc.) | | `removeFile` | (`payload`) => `Promise`\<`void`\> \| `Observable`\<`void`\> | Remove an uploaded file | | `getImageLibrary` | (`params`) => \| `Observable`\<[`ImageLibraryResponseDtoI`](#imagelibraryresponsedtoi)\> \| `Promise`\<[`ImageLibraryResponseDtoI`](#imagelibraryresponsedtoi)\> | Fetch images from the image library | | `getUserImages` | (`params`) => \| `Observable`\<[`UserImagesResponseDtoI`](#userimagesresponsedtoi)\> \| `Promise`\<[`UserImagesResponseDtoI`](#userimagesresponsedtoi)\> | Fetch user-uploaded images | | `uploadImage` | (`payload`) => \| `Observable`\<\{ `url`: `string`; \}\> \| `Promise`\<\{ `url`: `string`; \}\> | Upload an image file | | `uploadImageByUrl` | (`payload`) => \| `Observable`\<\{ `url`: `string`; \}\> \| `Promise`\<\{ `url`: `string`; \}\> | Upload an image from URL | | `copyImageByUrl` | (`payload`) => \| `Observable`\<\{ `url`: `string`; \}\> \| `Promise`\<\{ `url`: `string`; \}\> | Copy an image by URL to widget storage | | `translate` | (`params`) => \| `Observable`\<\{ `response`: [`TranslateRequestJsonI`](#translaterequestjsoni); \}\> \| `Promise`\<\{ `response`: [`TranslateRequestJsonI`](#translaterequestjsoni); \}\> | Translate text content | | `getContactMappingOptions` | () => \| `Observable`\<[`ClContactMappingOptionI`](#clcontactmappingoptioni)[]\> \| `Promise`\<[`ClContactMappingOptionI`](#clcontactmappingoptioni)[]\> | Fetch available contact mapping options | | `getContactFieldGroups?` | () => \| `Observable`\<[`EsAdditionalFieldsListI`](#esadditionalfieldslisti)[]\> \| `Promise`\<[`EsAdditionalFieldsListI`](#esadditionalfieldslisti)[]\> | Fetch contact field groups | | `createWidget?` | (`payload`) => \| `Observable`\<[`CreateWidgetResponseI`](#createwidgetresponsei)\> \| `Promise`\<[`CreateWidgetResponseI`](#createwidgetresponsei)\> | Create a new widget | *** ## GetWidgetAppearancesPayloadI Payload for [EditorApiConfigI.getWidgetAppearances](#getwidgetappearances). ### Properties | Property | Type | Description | | ------ | ------ | ------ | | `widgetId` | `number` | Widget ID | | `variantId` | `number` | Variant ID | *** ## CreateWidgetRevisionPayloadI Payload for [EditorApiConfigI.createWidgetRevision](#createwidgetrevision). ### Extends - [`CreateWidgetRevisionRequestI`](#createwidgetrevisionrequesti) ### Properties | Property | Type | Description | Inherited from | | ------ | ------ | ------ | ------ | | `widgetId` | `number` | Widget ID | - | | `revisionId` | `string` | Revision ID | - | | `changesSaved` | `boolean` | - | [`CreateWidgetRevisionRequestI`](#createwidgetrevisionrequesti).[`changesSaved`](#changessaved-1) | | `payload` | `WidgetRevisionPayloadI` | - | [`CreateWidgetRevisionRequestI`](#createwidgetrevisionrequesti).[`payload`](#payload-1) | *** ## GetFilesFromCommonDirPayloadI Payload for [EditorApiConfigI.getFilesFromCommonDir](#getfilesfromcommondir). ### Properties | Property | Type | Description | | ------ | ------ | ------ | | `type?` | [`TypeOfFilesFromCommonDir`](#typeoffilesfromcommondir) | Type of files to retrieve (icons, backgrounds, etc.) | *** ## RemoveFilePayloadI Payload for [EditorApiConfigI.removeFile](#removefile). ### Properties | Property | Type | Description | | ------ | ------ | ------ | | `fileUrl` | `string` | URL of the file to remove | | `widgetId` | `number` | Widget ID that owns the file | *** ## UploadImagePayloadI Payload for [EditorApiConfigI.uploadImage](#uploadimage). ### Properties | Property | Type | Description | | ------ | ------ | ------ | | `file` | `FormData` | FormData containing the image file | | `widgetId` | `number` | Widget ID to associate the image with | | `type?` | `string` | Optional image type category | *** ## UploadImageByUrlPayloadI Payload for [EditorApiConfigI.uploadImageByUrl](#uploadimagebyurl). ### Properties | Property | Type | Description | | ------ | ------ | ------ | | `imageUrl` | `string` | URL of the image to upload | | `widgetId` | `number` | Widget ID to associate the image with | *** ## CopyImageByUrlPayloadI Payload for [EditorApiConfigI.copyImageByUrl](#copyimagebyurl). ### Properties | Property | Type | Description | | ------ | ------ | ------ | | `imageUrl` | `string` | URL of the image to copy | | `widgetId` | `number` | Widget ID to associate the copied image with | | `type?` | [`TypeOfFilesFromCommonDir`](#typeoffilesfromcommondir) | Type category for the copied image | *** ## UpdateWidgetPrizeOptionsPayloadI Payload for [EditorApiConfigI.updateWidgetPrizeOptions](#updatewidgetprizeoptions). ### Properties | Property | Type | Description | | ------ | ------ | ------ | | `poolId` | `string` | Prize pool ID | | `options` | [`PrizePoolOptionI`](#prizepooloptioni)[] | Updated prize options | *** ## SetAutoTranslatePayloadI Payload for EditorApiConfigI.setAutoTranslate. ### Properties | Property | Type | Description | | ------ | ------ | ------ | | `enabled` | `boolean` | Enable or disable auto-translation | *** ## GetTemplatePayloadI Payload for EditorApiConfigI.getTemplate. ### Properties | Property | Type | Description | | ------ | ------ | ------ | | `templateId` | `number` | Template ID to fetch | *** ## CreateWidgetResponseI Response from [EditorApiConfigI.createWidget](#createwidget). ### Properties | Property | Type | Description | | ------ | ------ | ------ | | `variant` | [`WidgetVariantI`](#widgetvarianti) | Created widget variant | | `appearances` | [`WidgetAppearanceI`](#widgetappearancei)[] | Created widget appearances | *** ## EditorLogoI Logo configuration for the editor header. ### Example ```typescript const logo: EditorLogoI = { imageUrl: 'https://example.com/logo.png', link: 'https://example.com' }; ``` ### Properties | Property | Type | Description | | ------ | ------ | ------ | | `imageUrl` | `string` | URL of the logo image | | `link?` | `string` | Optional link URL when logo is clicked | *** ## ClContactMappingOptionI Contact mapping option for form field mapping. Used to map form inputs to contact fields in CDP. ### Properties | Property | Type | Description | | ------ | ------ | ------ | | `name` | `string` | Unique identifier for the mapping option | | `label` | `string` | Display label for the option | | `group` | `string` | Group name for categorization | | `isDedupe` | `boolean` | Whether this field is used for deduplication | | `isCustom` | `boolean` | Whether this is a custom field | | `type?` | [`ContactMappingOptionType`](#contactmappingoptiontype) | Type of contact mapping | | `values?` | `string`[] | Predefined values for select-type fields | | `options?` | [`ContactMappingOptionLimitsI`](#contactmappingoptionlimitsi) | Additional options and limits | | `isNew?` | `boolean` | Flag indicating this is a newly created field | | `additionalFieldType?` | `EsAdditionalFieldType` | Type of additional field (for custom fields) | *** ## BaseListDtoI ### Type Parameters | Type Parameter | | ------ | | `T` | ### Properties | Property | Type | | ------ | ------ | | `totalCount` | `number` | | `items` | `T`[] | *** ## UserInfoI ### Properties | Property | Type | | ------ | ------ | | `userId` | `number` | | `userName` | `string` | | `language` | `string` | *** ## ContactMappingOptionLimitsI ### Properties | Property | Type | | ------ | ------ | | `MAX_VALUE?` | `number` | | `MIN_VALUE?` | `number` | | `ANNUAL?` | `boolean` | *** ## ClDocumentI ### Extends - `ClDocumentI` ### Properties | Property | Type | Overrides | Inherited from | | ------ | ------ | ------ | ------ | | `views` | `ClBaseComponentI`[] | - | `CommonDocumentI.views` | | `shared` | `ClDocumentSharedI` | `CommonDocumentI.shared` | - | *** ## WidgetProjectConfigI ### Properties | Property | Type | | ------ | ------ | | `id` | [`WidgetProjectConfigId`](#widgetprojectconfigid) | | `value` | `string` | *** ## WidgetsListItemI ### Properties | Property | Type | | ------ | ------ | | `id` | `number` | | `name` | `string` | | `publishStatus` | [`WidgetPublishStatus`](#widgetpublishstatus) | | `createdDate` | `string` | | `updatedDate` | `string` | | `variantIds` | `number`[] | | `config` | [`WidgetVariantDtoI`](#widgetvariantdtoi) | *** ## WidgetModelI ### Properties | Property | Type | | ------ | ------ | | `id` | `number` | | `name` | `string` | | `publishStatus` | [`WidgetPublishStatus`](#widgetpublishstatus) | | `createdDate` | `string` | | `updatedDate` | `string` | | `variants` | [`WidgetVariantDtoI`](#widgetvariantdtoi)[] | | `config` | [`WidgetVariantDtoI`](#widgetvariantdtoi) | *** ## WidgetVariantDtoI ### Properties | Property | Type | | ------ | ------ | | `formId` | `number` | | `id` | `number` | | `config` | `WidgetVariantConfigDtoI` | | `appearances` | `WidgetAppearanceBriefI`[] | | `linkedToVariantId` | `number` | | `type` | [`WidgetType`](#widgettype) | | `revision?` | `string` | | `publishedRevision?` | `string` | *** ## WidgetAppearanceI ### Properties | Property | Type | Description | | ------ | ------ | ------ | | `id` | `string` \| `number` | - | | `origin` | `boolean` | - | | `language` | `string` | - | | `translations` | `string` | - | | `document` | `string` | stringified JSON {id: object} where id is node's id | | `sync` | `string` | - | | `themeConsumers?` | `string` | - | | `consents?` | `object` | - | | `revision?` | `string` | - | | `publishedRevision?` | `string` | - | *** ## WidgetLanguageI ### Properties | Property | Type | | ------ | ------ | | `languageCode` | `string` | | `name` | `string` | | `localisation` | `MessageLanguageLocalisationI` | *** ## WidgetVariantI ### Properties | Property | Type | | ------ | ------ | | `formId` | `number` | | `id` | `number` | | `config` | `WidgetVariantConfigI` | | `appearances` | `WidgetAppearanceBriefI`[] | | `linkedToVariantId` | `number` | | `type` | [`WidgetType`](#widgettype) | | `revision` | `string` | | `publishedRevision` | `string` | *** ## EsAdditionalFieldsListI ### Properties | Property | Type | | ------ | ------ | | `id` | `number` | | `name` | `string` | | `personalisationKey` | `string` | | `fields` | `EsAdditionalFieldI`[] | *** ## BaseFormsListRequestParamsI ### Properties | Property | Type | | ------ | ------ | | `layoutTypes?` | [`LayoutType`](#layouttype)[] | | `order?` | `BaseListOrderOption` | | `search?` | `string` | | `offset?` | `number` | | `limit?` | `number` | | `sort?` | `BaseListSortOption` | | `types?` | [`WidgetType`](#widgettype)[] | | `projectId?` | `number` | | `filters?` | `FormListRequestFilter` | | `publishStatus?` | [`WidgetPublishStatus`](#widgetpublishstatus) | | `publishDateFrom?` | `string` | | `publishDateTo?` | `string` | | `withDeleted?` | `boolean` | | `analyticsDateFrom?` | `string` | | `analyticsDateTo?` | `string` | *** ## CreateFormParamsI ### Properties | Property | Type | | ------ | ------ | | `name` | `string` | | `variant` | `CreateFormParamsVariantI` | | `publishStatus?` | [`WidgetPublishStatus`](#widgetpublishstatus) | *** ## TranslateRequestI ### Properties | Property | Type | | ------ | ------ | | `json` | [`TranslateRequestJsonI`](#translaterequestjsoni) | | `sourceLanguage` | `string` | | `targetLanguage` | `string` | *** ## TranslateRequestJsonI ### Properties | Property | Type | | ------ | ------ | | `widgetTranslations` | `LanguageTranslateState` | | `teaserTranslations?` | `LanguageTranslateState` | *** ## CreateWidgetRevisionRequestI ### Extended by - [`CreateWidgetRevisionPayloadI`](#createwidgetrevisionpayloadi) ### Properties | Property | Type | | ------ | ------ | | `changesSaved` | `boolean` | | `payload` | `WidgetRevisionPayloadI` | *** ## CreateWidgetRevisionResponseI ### Properties | Property | Type | | ------ | ------ | | `uuid` | `string` | *** ## WidgetRevisionI ### Properties | Property | Type | | ------ | ------ | | `uuid` | `string` | | `createdDate` | `string` | | `widgetId` | `number` | | `userId` | `number` | | `published` | `boolean` | | `changesSaved` | `boolean` | | `payload` | `WidgetRevisionPayloadI` | *** ## ImageLibraryRequestParamsI ### Properties | Property | Type | | ------ | ------ | | `search` | `string` | | `useCache` | `boolean` | | `page` | `number` | | `limit` | `number` | | `type` | `ImageLibraryType` | *** ## ImageLibraryResponseDtoI ### Properties | Property | Type | | ------ | ------ | | `data` | `ImageLibraryItemI`[] | | `fromCache` | `boolean` | | `source` | `string` | | `total` | `number` | *** ## UserImagesRequestParamsI ### Properties | Property | Type | | ------ | ------ | | `page` | `number` | | `limit` | `number` | | `type?` | `string` | *** ## UserImagesResponseDtoI ### Properties | Property | Type | | ------ | ------ | | `items` | `UserImageItemI`[] | | `total` | `number` |