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

package/src/component-manifest/ComponentManifest.interface.ts

@@ -1,160 +0,0 @@
-import {ClBaseComponentI, ClBaseComponentPropsI, ClComponentType} from '../document/Document.interface';
-import {BaseContextMenuManifestModelI} from './ContextMenuManifest.interface';
-import {BaseFloatingControlManifestModelI} from './FloatingControlManifest.interface';
-import {PropertyPaneManifestI} from './PropertyPaneManifest.interface';
-
-/**
- * Component manifest defining component configuration, properties, and editor controls.
- */
-export interface ComponentManifestI {
-  /** Component name for registration */
-  name: string;
-  /** Component type identifier */
-  componentType: ClComponentType;
-  /** Component version */
-  version: string;
-  /** Context menu configuration for editor */
-  contextMenuModel: BaseContextMenuManifestModelI[];
-  /** Floating controls configuration for editor */
-  floatingControlsModel: BaseFloatingControlManifestModelI[];
-  /** Property pane configuration for editor */
-  propertyPaneModel: PropertyPaneManifestI;
-  /** Component event definitions
-   * @internal
-   * */
-  events: any;
-  /** Default component properties */
-  props: ClBaseComponentPropsI;
-  /** Component metadata for editor display */
-  metaDescription: ComponentManifestMetaDescriptionI;
-  /** Property pane for i18n settings */
-  i18nPropertyPaneModel?: PropertyPaneManifestI;
-  /** Property paths that support internationalization for multilingual content.
-   * The editor extracts values from these paths and sends them to an AI-based translator.
-   * The renderer then replaces the original values with the translated results using the same paths.
-   * @example
-   * [
-   *    "content,label",
-   *    "control,options,[id],label"
-   * ]
-   *
-   * Note: [id] extracts all object keys
-   * */
-  i18nPropPaths?: string[];
-  /** If true, clicking current component focuses it's parent component */
-  focusParentOnClick?: boolean;
-  /** If true, prevents drag operations for current component */
-  preventDraggable?: boolean;
-  /** If true, removes children when component is removed */
-  recursiveRemove?: boolean;
-  /** Translation strings by language. Used by components (e.g. error messages).
-   * @example
-   * {
-   * "en": {
-   *    "control,validation,validationErrors,REQUIRED": "Required field",
-   * },
-   * */
-  i18n?: ComponentManifestTranslationI;
-  /** Default child components */
-  children?: ClBaseComponentI[];
-  /** Field mapping types that component can handle */
-  mappingTypes?: ManifestMappingType[];
-  /** Element names that can receive focus and should be highlighted by the editor */
-  focusableElements?: string[];
-  /** Auto-contrast configuration for color adjustments */
-  autoContrast?: AutoContrastI[];
-  /** If true, keeps general tab open until user interacts */
-  keepGeneralTabOpenUntilInteracted?: boolean;
-  /** If true, component can be started externally */
-  isExternalStartCapable?: boolean;
-  /** If true, waits for resources to load before showing */
-  waitForResourcesLoad?: boolean;
-  /** Paths to properties containing resource URLs
-   * @internal
-   * */
-  resourcesPropPaths?: string[][];
-  /** @internal  */
-  syncEnabled?: boolean;
-  /** @internal  */
-  stylesImitationEnabled?: boolean;
-  /** Opens ClPropertyPaneManifestModelName.COMPONENT_OPTIONS when a component is added to the widget */
-  showComponentOptionsPropertyPaneOnInsert?: boolean;
-  /** Opens ClPropertyPaneManifestModelName.INTEGRATION_FIELD_MAPPING when a component is added to the widget */
-  showIntegrationFieldMappingPropertyPaneOnInsert?: boolean;
-}
-
-/**
- * Field mapping types for integration field configuration.
- */
-export enum ManifestMappingType {
-  TEXT = 'TEXT',
-  TEXT_AREA = 'TEXT_AREA',
-  INTEGER = 'INTEGER',
-  FLOAT = 'FLOAT',
-  SELECT = 'SELECT',
-  CHECKBOX_LIST = 'CHECKBOX_LIST',
-  CHECKBOX = 'CHECKBOX',
-  DATE = 'DATE',
-  DATE_TIME = 'DATE_TIME',
-}
-
-/**
- * Translation strings organized by language code.
- */
-export interface ComponentManifestTranslationI {
-  [languageCode: string]: ComponentManifestTranslationItemI;
-}
-
-/**
- * Translation items mapping property paths to translated values.
- */
-export interface ComponentManifestTranslationItemI {
-  [propPath: string]: string;
-}
-
-/**
- * Component metadata for editor display and sorting.
- */
-export interface ComponentManifestMetaDescriptionI {
-  /** Display labels by language */
-  label: ComponentManifestDescriptionLabelItemI;
-  /** Sort weight for ordering in component list */
-  sortWeight?: number;
-  /** Icon identifier for component */
-  icon?: string;
-}
-
-/**
- * Component labels by language code.
- */
-export interface ComponentManifestDescriptionLabelItemI {
-  [languageCode: string]: string;
-}
-
-/**
- * Auto-contrast configuration for automatic color adjustments.
- */
-export interface AutoContrastI {
-  /** Master color source */
-  master: AutoContrastMemberI;
-  /** Slave color to adjust */
-  slave: AutoContrastMemberI;
-  /** Property path to enabled flag */
-  enabledPropPath: string[];
-}
-
-/**
- * Member of an auto-contrast pair.
- */
-export interface AutoContrastMemberI {
-  /** Target element name */
-  element: string;
-  /** Element property name */
-  elementProp?: string;
-  /** Element sub-property name */
-  elementSubProp?: string;
-  /** Alternative property path */
-  propPath?: string[];
-  /** If true, color is dimmed */
-  dimmed?: boolean | null;
-}

package/src/component-manifest/ContextMenuManifest.interface.ts

@@ -1,52 +0,0 @@
-import {ClComponentType} from '../document/Document.interface';
-
-/**
- * Base interface for context menu manifest items.
- */
-export interface BaseContextMenuManifestModelI {
-  /** Item type (group or control) */
-  type: ContextMenuManifestModelType;
-  /** Predefined control name */
-  name?: ContextMenuManifestModelName;
-  /** Property path in component model */
-  propPath?: string[];
-  /** Target element name */
-  element?: string;
-  /** Element property name */
-  elementProp?: string;
-  /** Element sub-property name */
-  elementSubProp?: string;
-  /** Child menu items */
-  children?: BaseContextMenuManifestModelI[];
-}
-
-/**
- * Context menu item types.
- */
-export enum ContextMenuManifestModelType {
-  /** Group container for menu items */
-  GROUP = 'GROUP',
-  /** Individual control item */
-  CONTROL = 'CONTROL',
-}
-
-/**
- * Predefined context menu control names.
- */
-export enum ContextMenuManifestModelName {
-  FOCUS_PARENT_COMPONENT = 'FOCUS_PARENT_COMPONENT',
-  COMPONENT_OPERATIONS = 'COMPONENT_OPERATIONS',
-  BRING_BACK_FORWARD = 'BRING_BACK_FORWARD',
-}
-
-export interface GroupContextMenuManifestModelI extends BaseContextMenuManifestModelI {
-  children: BaseContextMenuManifestModelI[];
-}
-
-export interface FocusParentComponentContextMenuManifestModelI extends BaseContextMenuManifestModelI {
-  params?: FocusParentComponentContextMenuManifestParamsI;
-}
-
-export interface FocusParentComponentContextMenuManifestParamsI {
-  hideForEntryType: ClComponentType;
-}

package/src/component-manifest/DisplayCondition.interface.ts

@@ -1,65 +0,0 @@
-import {WidgetType} from '../WidgetType';
-import {LayoutType} from '../LayoutType';
-import {ClBaseComponentI, ClBaseComponentPropsI, ClComponentType} from '../document/Document.interface';
-import {ComponentManifestI} from './ComponentManifest.interface';
-
-/** Callback that determines whether a property pane control should be displayed */
-export type DisplayConditionCallbackI = (sdk: DisplayConditionSdkI) => boolean;
-
-/**
- * SDK provided to display condition callbacks, giving access to
- * widget context, component data, and document utilities.
- */
-export interface DisplayConditionSdkI {
-  /** Current widget type (e.g., popup, embedded) */
-  widgetType: WidgetType;
-  /** Current layout type */
-  layoutType: LayoutType;
-  /** Facade for the currently selected component */
-  component: DisplayConditionComponentFacadeI;
-  /** Editor configuration object */
-  editorConfig: any;
-  /** The component view (tree node) being evaluated */
-  componentView: ClBaseComponentI;
-  /** All views (pages) in the document */
-  views: ClBaseComponentI[];
-  /** All registered component manifests */
-  manifests: ComponentManifestI[];
-  /** Utility methods for querying the document tree */
-  documentUtils: DisplayConditionDocumentUtilsServiceI;
-}
-
-/**
- * Read-only facade exposing component metadata and navigation
- * within display condition callbacks.
- */
-export interface DisplayConditionComponentFacadeI {
-  /** Unique component identifier */
-  id: string;
-  /** Component type (e.g., button, input) */
-  type: ClComponentType;
-  /** Position path in the component tree */
-  path: number[];
-  /** Whether the component is a floating element */
-  floating: boolean;
-  /** Returns the component's props */
-  getProps: () => ClBaseComponentPropsI;
-  /** Returns the component's child components */
-  getChildren: () => ClBaseComponentI[];
-  /** Returns the parent component facade, or null if root */
-  getParent: () => DisplayConditionComponentFacadeI | null;
-}
-
-/**
- * Utility service for searching and querying components within the document tree.
- */
-export interface DisplayConditionDocumentUtilsServiceI {
-  /** Finds components matching any of the given types */
-  findComponentsByTypes(componentsTree: ClBaseComponentI[], types: ClComponentType[]): ClBaseComponentI[];
-  /** Finds components matching the given name */
-  findComponentsByName(componentsTree: ClBaseComponentI[], name: string): ClBaseComponentI[];
-  /** Finds components matching any of the given names */
-  findComponentsByNames(componentsTree: ClBaseComponentI[], names: string[]): ClBaseComponentI[];
-  /** Returns external start-gaming components based on manifest configuration */
-  getExternalStartGamingComponents(componentsTree: ClBaseComponentI[], manifests: ComponentManifestI[]): ClBaseComponentI[];
-}

package/src/component-manifest/FloatingControlManifest.interface.ts

@@ -1,89 +0,0 @@
-import {PropPathConditionCallbackI} from './PropPathCondition.interface';
-
-/**
- * Base interface for floating control manifest items.
- * Floating controls appear around selected components in the editor.
- */
-export interface BaseFloatingControlManifestModelI {
-  type: FloatingControlManifestModelType;
-  name?: FloatingControlManifestModelName;
-  propPath?: string[];
-  element?: string;
-  elementProp?: string;
-  elementSubProp?: string;
-  /** Callback that dynamically resolves the property path based on component context */
-  propPathCondition?: PropPathConditionCallbackI;
-  /** Child controls */
-  children?: BaseFloatingControlManifestModelI[];
-  /** Control-specific parameters */
-  params?: any;
-}
-
-/**
- * Floating control item types.
- */
-export enum FloatingControlManifestModelType {
-  /** Group container for controls */
-  GROUP = 'GROUP',
-  /** Individual control */
-  CONTROL = 'CONTROL',
-}
-
-/**
- * Predefined floating control names.
- */
-export enum FloatingControlManifestModelName {
-  SIZE = 'SIZE',
-  MARGIN = 'MARGIN',
-  PARENT_ALIGNMENT = 'PARENT_ALIGNMENT',
-  CONTAINER_PADDING = 'CONTAINER_PADDING',
-  SLIDES_MANAGEMENT = 'SLIDES_MANAGEMENT',
-  COLUMNS_PROPORTIONS = 'COLUMNS_PROPORTIONS',
-  VIEW_SWITCHER = 'VIEW_SWITCHER',
-  ROTATION = 'ROTATION',
-}
-
-export interface GroupFloatingControlManifestModelI extends BaseFloatingControlManifestModelI {
-  children: BaseFloatingControlManifestModelI[];
-}
-
-export interface SizeFloatingControlManifestModelI extends BaseFloatingControlManifestModelI {
-  params?: {
-    width?: SizeDimensionFloatingControlManifestParamsI;
-    height?: SizeDimensionFloatingControlManifestParamsI;
-    rotation?: RotationFloatingControlManifestParamsI;
-  };
-}
-
-export interface SizeDimensionFloatingControlManifestParamsI {
-  hide?: boolean;
-  getValueFromElement?: string;
-  minValue?: number;
-  element?: string;
-  elementProp?: string;
-  propPath?: string;
-}
-
-export interface RotationFloatingControlManifestParamsI {
-  element?: string;
-  elementProp?: string;
-}
-
-export interface ColumnsProportionsFloatingControlManifestModelI extends BaseFloatingControlManifestModelI {
-  params?: ColumnsProportionsFloatingControlManifestParamsI;
-}
-
-export interface ColumnsProportionsFloatingControlManifestParamsI {
-  parent?: boolean;
-}
-
-export interface ViewSwitcherFloatingControlsManifestModelI extends BaseFloatingControlManifestModelI {
-  params: {
-    views: ViewSwitcherFloatingControlsManifestViewI[];
-  }
-}
-
-export interface ViewSwitcherFloatingControlsManifestViewI {
-  label: string;
-  value: string;
-}

package/src/component-manifest/PropPathCondition.interface.ts

@@ -1,4 +0,0 @@
-import {DisplayConditionSdkI} from './DisplayCondition.interface';
-
-/** Callback that dynamically resolves the property path for a control based on component context */
-export type PropPathConditionCallbackI = (sdk: DisplayConditionSdkI) => object;