@claspo/common 7.3.1-dev.1 → 7.3.1-dev.2

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

@@ -0,0 +1,65 @@
+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

@@ -0,0 +1,89 @@
+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

@@ -0,0 +1,4 @@
+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;