@claspo/common 7.3.1-dev.4 → 7.4.0-nonlinear

package/src/document/Document.interface.ts

@@ -1,625 +0,0 @@
-import {AnyHiddenFieldSharedI} from './hidden-fields.interface';
-
-/**
- * Root document structure containing views and shared configuration.
- */
-export interface ClDocumentI {
-  /** Array of view components (pages/screens) */
-  views: ClBaseComponentI[];
-  /** Shared document configuration and styling */
-  shared: ClDocumentSharedI;
-}
-
-/**
- * Base interface for all component models in the document tree.
- */
-export interface ClBaseComponentI {
-  /** Unique component identifier */
-  id: string;
-  /** Position path in the component tree (array of indices) */
-  path: number[];
-  /** Component type identifier */
-  type: ClComponentType;
-  /** Component version string */
-  version: string;
-  /** Component properties and configuration */
-  props: ClBaseComponentPropsI;
-  /** Component name for registration */
-  name: string;
-  /** Display label (used for views) */
-  label?: string;
-  /** Child components */
-  children?: ClBaseComponentI[];
-  /** @internal Runtime reference to the rendered component instance */
-  componentRef?: any;
-  /** If true, clicking focuses the parent instead */
-  focusParentOnClick?: boolean;
-  /** If true, prevents drag-and-drop on this component */
-  preventDraggable?: boolean;
-  /** If true, removing this component removes children recursively */
-  recursiveRemove?: boolean;
-}
-
-/**
- * Enumeration of component types in the widget system.
- */
-export enum ClComponentType {
-  VIEW = 'VIEW',
-  CONTAINER = 'CONTAINER',
-  TEXT = 'TEXT',
-  INPUT = 'INPUT',
-  BUTTON = 'BUTTON',
-  IMAGE = 'IMAGE',
-  CONSENT = 'CONSENT',
-  COUNTDOWN_TIMER = 'COUNTDOWN_TIMER',
-  PROMO_CODE = 'PROMO_CODE',
-  MULTIPLE_INPUT = 'MULTIPLE_INPUT',
-  VIDEO = 'VIDEO',
-  SLIDER = 'SLIDER',
-  SLIDE = 'SLIDE',
-  SOCIAL = 'SOCIAL',
-  COLUMNS = 'COLUMNS',
-  COLUMN = 'COLUMN',
-  PRIZE_BASED_GAMING = 'PRIZE_BASED_GAMING',
-}
-
-/**
- * Component properties interface with styling, handlers, and content.
- */
-export interface ClBaseComponentPropsI {
-  /** Platform-specific styles (desktop/mobile) */
-  adaptiveStyles?: BaseComponentAdaptiveStylesI;
-  /** Environment-independent styles */
-  styles?: ClBaseComponentElementParamsI[];
-  /** Event handlers attached to the component */
-  handlers?: ClDocumentHandlerI[];
-  /** Content configuration (text, images, etc.) */
-  content?: any;
-  /** Form control configuration */
-  control?: any;
-  /** If true, component responds to viewport changes
-   * @internal
-   * */
-  isResponsive?: boolean;
-  /** If true, alignment options are restricted */
-  isAlignRestricted?: boolean;
-  /** If true, component floats above other content */
-  floating?: boolean;
-}
-
-/**
- * Platform-specific style configurations.
- */
-export interface BaseComponentAdaptiveStylesI {
-  /** Desktop viewport styles */
-  desktop: ClBaseComponentElementParamsI[];
-  /** Mobile viewport styles */
-  mobile: ClBaseComponentElementParamsI[];
-}
-
-/**
- * Element styling parameters for a single element within a component.
- */
-export interface ClBaseComponentElementParamsI {
-  /** Element identifier (e.g., 'host', 'button', 'label') */
-  element: string;
-  /** CSS style properties */
-  styleAttributes: ClComponentStyleAttributesI;
-  /** Styles applied on hover */
-  hoverStyleAttributes?: ClComponentStyleAttributesI;
-  /** Type of hover animation */
-  hoverAnimationType?: string;
-  /** Styles for placeholder text (inputs) */
-  placeholderStyleAttributes?: ClComponentStyleAttributesI;
-  /** Styles for list markers */
-  markerStyleAttributes?: ClComponentStyleAttributesI;
-  /** Additional element parameters */
-  params?: any;
-  /** CSS class names to apply */
-  classes?: string;
-}
-
-/**
- * Map of CSS style property names to values.
- */
-export interface ClComponentStyleAttributesI {
-  [key: string]: string;
-}
-
-/**
- * Event handler configuration for a component.
- */
-export interface ClDocumentHandlerI {
-  /** Type of event to handle */
-  type: ClDocumentHandlerType;
-  /** Actions to execute when event fires */
-  actions: ClDocumentActionI[];
-  /** Optional CSS selector for targeting child elements */
-  relativeSelector?: string;
-}
-
-/**
- * Enumeration of handler event types.
- */
-export enum ClDocumentHandlerType {
-  CLICK = 'CLICK',
-}
-
-/**
- * Action configuration for event handlers.
- * @typeParam T - Type of action parameters
- */
-export interface ClDocumentActionI<T = any> {
-  /** Action type identifier */
-  type: ClDocumentActionType;
-  /** Action-specific parameters */
-  params?: T;
-}
-
-/**
- * Enumeration of available action types.
- */
-export enum ClDocumentActionType {
-  SHOW_WIDGET = 'SHOW_WIDGET',
-  OPEN_LINK = 'OPEN_LINK',
-  SUBSCRIBE_CONTACT = 'SUBSCRIBE_CONTACT',
-  REQUEST = 'REQUEST',
-  CLOSE_WIDGET = 'CLOSE_WIDGET',
-  GO_TO_VIEW = 'GO_TO_VIEW',
-  GO_TO_PREVIOUS_VIEW = 'GO_TO_PREVIOUS_VIEW',
-  GO_TO_NEXT_VIEW = 'GO_TO_NEXT_VIEW',
-  CLICK = 'CLICK'
-}
-
-/**
- * Union type of all possible action parameter types.
- */
-export type ClDocumentActionParams = ClDocumentOpenLinkActionParamsI |
-  ClDocumentGoToViewActionParamsI |
-  ClDocumentGoToNextViewActionParamsI |
-  ClDocumentGoToPreviousViewActionParamsI |
-  ClDocumentCloseWidgetActionParamsI |
-  ClDocumentShowWidgetActionParamsI |
-  ClDocumentRequestActionParamsI;
-
-/**
- * Parameters for the OPEN_LINK action.
- */
-export interface ClDocumentOpenLinkActionParamsI {
-  /** URL to open */
-  link: string;
-  /** Target window for the link */
-  target: ClDocumentOpenLinkActionTarget;
-  /** If true, merge tags in the URL are processed */
-  tagsEnabled: boolean;
-  /** Additional tracking parameters */
-  trackClickParams?: { [key: string]: string };
-  /** Custom data to pass with the action */
-  customData?: string;
-  /** If true, counts as a conversion/target action */
-  countAsTargetAction?: boolean;
-}
-
-/**
- * Link target options.
- */
-export enum ClDocumentOpenLinkActionTarget {
-  /** Open in same window */
-  SELF = '_self',
-  /** Open in new tab/window */
-  BLANK = '_blank',
-}
-
-/**
- * Parameters for navigating to a specific view.
- */
-export interface ClDocumentGoToViewActionParamsI {
-  /** Target view identifier */
-  viewId: string;
-  /** If true, tracks the navigation click */
-  trackClick?: boolean;
-  /** Additional tracking parameters */
-  trackClickParams?: { [key: string]: string };
-  /** If true, counts as a conversion/target action */
-  countAsTargetAction?: boolean;
-}
-
-/**
- * Parameters for navigating to the next view.
- */
-export interface ClDocumentGoToNextViewActionParamsI {
-  /** If true, tracks the navigation click */
-  trackClick?: boolean;
-  /** Additional tracking parameters */
-  trackClickParams?: { [key: string]: string };
-}
-
-/**
- * Parameters for navigating to the previous view.
- */
-export interface ClDocumentGoToPreviousViewActionParamsI {
-  /** If true, tracks the navigation click */
-  trackClick?: boolean;
-  /** Additional tracking parameters */
-  trackClickParams?: { [key: string]: string };
-  /** If true, counts as a conversion/target action */
-  countAsTargetAction?: boolean;
-}
-
-/**
- * Parameters for closing the widget.
- */
-export interface ClDocumentCloseWidgetActionParamsI {
-  /** Additional tracking parameters */
-  trackClickParams?: { [key: string]: string };
-  /** If true, counts as a conversion/target action */
-  countAsTargetAction?: boolean;
-}
-
-/**
- * Parameters for showing another widget.
- */
-export interface ClDocumentShowWidgetActionParamsI {
-  /** Variant ID of the widget to show */
-  variantId?: number;
-  /** If true, closes current widget when showing the new one */
-  closeWidget?: boolean;
-  /** If true, counts as a conversion/target action */
-  countAsTargetAction?: boolean;
-}
-
-/**
- * Parameters for the request/submit action.
- */
-export interface ClDocumentRequestActionParamsI {
-  /** If true, counts as a conversion/target action */
-  countAsTargetAction?: boolean;
-}
-
-export enum DefaultSchemaTokens {
-  ACCENT = 'accent',
-}
-
-export type ThemeColorSchemaI = Record<string, string>;
-
-export interface ThemeI {
-  schema: ThemeColorSchemaI;
-}
-
-/**
- * Shared document configuration applied across all views.
- */
-export interface ClDocumentSharedI {
-  /** Font family for headers */
-  headerFontFamily: string;
-  /** Font family for body text */
-  textFontFamily: string;
-  /** Predefined text style classes */
-  textClasses: { [key: string]: ClDocumentSharedTextClassI };
-  /** Google Fonts to load */
-  googleFonts: string[];
-  /** Floating box layout configuration */
-  floatingBox?: ClFloatingBoxParamsI;
-  /** Floating bar layout configuration */
-  floatingBar?: ClFloatingBarParamsI;
-  /** Launcher configuration */
-  launcher?: ClLauncherParamsI;
-  /** Dialog/modal configuration */
-  dialog?: ClDialogParamsI;
-  /** Close button configuration */
-  closeIcon?: ClCloseButtonParamsI;
-  /** Active color schema name */
-  colorSchemaName?: string;
-  /** CSS custom properties (variables) */
-  cssVars?: ClDocumentCssVarsI;
-  /** Actual rendered sizes per view */
-  actualSize?: ClDocumentActualSizeI[];
-  /** Link styling parameters */
-  linkParams?: ClDocumentLinkParamsI;
-  /** Breakpoint width for mobile/desktop switch */
-  mobileBreakpointWidth?: number;
-  /** CSS z-index for the widget */
-  zIndex?: number;
-  /** Theme configuration */
-  theme?: ThemeI;
-  /** Apply styles and positions to the content inside an overlay. */
-  overlay?: ClDocumentOverlayI;
-  /** Hidden form fields whose values are resolved at runtime from a configured source (such as static value, data layer, URL, etc.) and submitted with the form. */
-  hiddenFields?: AnyHiddenFieldSharedI[];
-  /** Post-submit behavior: either run a configured action, or navigate to a view based on the backend response. */
-  submitActionParams?: ClSubmitActionParamsI;
-}
-
-export interface ClSubmitActionParamsI {
-  successViewId?: string | null;
-  errorViewId?: string | null;
-  alreadySubscribedViewId?: string | null;
-  runAction?: ClDocumentActionI | null;
-}
-
-export interface ClDocumentOverlayI {
-  /** Desktop positioning */
-  desktop: ClDocumentOverlayEnvironmentParamsI;
-  /** Mobile positioning */
-  mobile: ClDocumentOverlayEnvironmentParamsI;
-  /** Overlay styles */
-  styles: ClDocumentOverlayStylesI;
-}
-
-export interface ClDocumentOverlayEnvironmentParamsI {
-  /** Vertical position */
-  verticalPosition: ClWidgetVerticalPosition;
-  /** Horizontal position */
-  horizontalPosition: ClWidgetHorizontalPosition;
-  /** Vertical offset from position */
-  verticalOffset: string;
-  /** Horizontal offset from position */
-  horizontalOffset: string;
-}
-
-export interface ClDocumentOverlayStylesI {
-  /** Background color, gradient or image */
-  background: string;
-  /** Background blur or similar effects */
-  backdropFilter: string;
-  /** Whether the background image is sourced from an external URL */
-  externalBackgroundUrlSource?: boolean;
-}
-
-/**
- * Dialog/modal background configuration.
- */
-export interface ClDialogParamsI {
-  /** Background color or style */
-  background: string;
-}
-
-/**
- * Shared text style class definition.
- */
-export interface ClDocumentSharedTextClassI {
-  /** Unique class identifier */
-  id: string;
-  /** Display name of the class */
-  name: string;
-  /** If true, this is a header style */
-  isHeader: boolean;
-  /** CSS style attributes */
-  styleAttributes: any;
-  /** Placeholder text styles */
-  placeholderStyleAttributes?: any;
-}
-
-/**
- * Floating box positioning parameters.
- */
-export interface ClFloatingBoxParamsI {
-  /** Vertical position on desktop */
-  verticalPosition: ClWidgetVerticalPosition;
-  /** Horizontal position on desktop */
-  horizontalPosition: ClWidgetHorizontalPosition;
-  /** Vertical offset from position */
-  verticalOffset: string;
-  /** Horizontal offset from position */
-  horizontalOffset: string;
-  /** Mobile-specific positioning */
-  mobile: ClFloatingBoxEnvironmentParamsI;
-}
-
-/**
- * Vertical position options for widgets.
- */
-export enum ClWidgetVerticalPosition {
-  TOP = 'TOP',
-  CENTER = 'CENTER',
-  BOTTOM = 'BOTTOM',
-}
-
-/**
- * Horizontal position options for widgets.
- */
-export enum ClWidgetHorizontalPosition {
-  LEFT = 'LEFT',
-  CENTER = 'CENTER',
-  RIGHT = 'RIGHT',
-}
-
-/**
- * Environment-specific floating box positioning.
- */
-export interface ClFloatingBoxEnvironmentParamsI {
-  /** Vertical position */
-  verticalPosition: ClWidgetVerticalPosition;
-  /** Horizontal position */
-  horizontalPosition: ClWidgetHorizontalPosition;
-  /** Vertical offset from position */
-  verticalOffset: string;
-  /** Horizontal offset from position */
-  horizontalOffset: string;
-}
-
-/**
- * Floating bar positioning parameters.
- */
-export interface ClFloatingBarParamsI {
-  /** Desktop positioning */
-  desktop: ClFloatingBarEnvironmentParamsI;
-  /** Mobile positioning */
-  mobile: ClFloatingBarEnvironmentParamsI;
-}
-
-/**
- * Environment-specific floating bar positioning.
- */
-export interface ClFloatingBarEnvironmentParamsI {
-  /** Vertical position */
-  verticalPosition: ClWidgetVerticalPosition;
-  /** Horizontal position */
-  horizontalPosition: ClWidgetHorizontalPosition;
-  /** Vertical offset from position */
-  verticalOffset: string;
-  /** Horizontal offset from position */
-  horizontalOffset: string;
-}
-
-/**
- * Launcher widget configuration.
- */
-export interface ClLauncherParamsI {
-  /** Desktop positioning */
-  desktop: ClLauncherEnvironmentParamsI;
-  /** Mobile positioning */
-  mobile: ClLauncherEnvironmentParamsI;
-  /** Entry animation configuration */
-  entryAnimation: ClLauncherEntryAnimationI;
-  /** Loop animation configuration */
-  loopAnimation: ClLoopAnimationI;
-}
-
-/**
- * Environment-specific launcher positioning.
- */
-export interface ClLauncherEnvironmentParamsI {
-  /** Vertical position */
-  verticalPosition: ClWidgetVerticalPosition;
-  /** Horizontal position */
-  horizontalPosition: ClWidgetHorizontalPosition;
-  /** Vertical offset from position */
-  verticalOffset: string;
-  /** Horizontal offset from position */
-  horizontalOffset: string;
-}
-
-/**
- * Launcher entry animation configuration.
- */
-export interface ClLauncherEntryAnimationI {
-  /** Animation type or null for no animation */
-  type: ClLauncherEntryAnimationType | null;
-}
-
-/**
- * Launcher entry animation types.
- */
-export enum ClLauncherEntryAnimationType {
-  SLIDE_TO_TOP = 'SLIDE_TO_TOP',
-  SLIDE_TO_BOTTOM = 'SLIDE_TO_BOTTOM',
-  SLIDE_TO_LEFT = 'SLIDE_TO_LEFT',
-  SLIDE_TO_RIGHT = 'SLIDE_TO_RIGHT',
-}
-
-/**
- * Loop animation configuration.
- */
-export interface ClLoopAnimationI {
-  /** Animation type or null for no animation */
-  type: ClLoopAnimationType | null;
-  /** Animation-specific parameters */
-  params?: any;
-}
-
-/**
- * Available loop animation types.
- */
-export enum ClLoopAnimationType {
-  PULSE = 'PULSE',
-  VIBRATE = 'VIBRATE',
-  WOBBLE = 'WOBBLE',
-  SHAKE = 'SHAKE',
-  JELLO = 'JELLO',
-  BOUNCE = 'BOUNCE',
-  BLINK = 'BLINK',
-  FLICKER = 'FLICKER',
-  PING = 'PING',
-}
-
-/**
- * Close button configuration.
- */
-export interface ClCloseButtonParamsI {
-  /** Desktop close button settings */
-  desktop?: ClCloseButtonEnvironmentParamsI;
-  /** Mobile close button settings */
-  mobile?: ClCloseButtonEnvironmentParamsI;
-  /** View IDs where close button should be shown */
-  showOnViews?: string[];
-  /** If true, close button is enabled */
-  enabled?: boolean;
-}
-
-/**
- * Environment-specific close button configuration.
- */
-export interface ClCloseButtonEnvironmentParamsI extends ClIconEnvironmentParamsI {
-  /** Vertical offset from position */
-  verticalOffset: string;
-  /** Horizontal offset from position */
-  horizontalOffset: string;
-  /** Button width */
-  width: string;
-  /** Button height */
-  height: string;
-  /** Horizontal position */
-  horizontalPosition: ClCloseButtonHorizontalPosition;
-}
-
-/**
- * Icon configuration for buttons.
- */
-export interface ClIconEnvironmentParamsI {
-  /** Icon content (index for default, URL for custom) */
-  content: string;
-  /** If true, uses a default icon */
-  defaultIcon: boolean;
-  /** Icon color */
-  color?: string;
-  /** Icon size */
-  size?: number;
-}
-
-/**
- * Close button horizontal position options.
- */
-export enum ClCloseButtonHorizontalPosition {
-  LEFT = 'LEFT',
-  RIGHT = 'RIGHT',
-}
-
-/**
- * CSS custom properties (variables) map.
- */
-export interface ClDocumentCssVarsI {
-  [key: string]: string;
-}
-
-/**
- * Actual rendered size of a view.
- */
-export interface ClDocumentActualSizeI {
-  /** View identifier */
-  viewId: string;
-  /** Desktop dimensions */
-  desktop: ClDocumentEnvironmentActualSize;
-  /** Mobile dimensions */
-  mobile: ClDocumentEnvironmentActualSize;
-}
-
-/**
- * Environment-specific actual size dimensions.
- */
-export interface ClDocumentEnvironmentActualSize {
-  /** Width value */
-  width: string;
-  /** Height value */
-  height: string;
-}
-
-/**
- * Link styling parameters.
- */
-export interface ClDocumentLinkParamsI {
-  /** Link color */
-  color?: string;
-  /** If true, removes underline from links */
-  removeUnderline?: boolean;
-}