@evergis/react 4.0.58 → 4.0.61

package/dist/components/Dashboard/types.d.ts

@@ -6,6 +6,31 @@ import { CircleLayerSpecification, FillLayerSpecification, LineLayerSpecificatio
 import { AttributeFormatConfigurationDc, AttributeType, EqlRequestDc, FeatureDc, OgcGeometryType, PagedFeaturesListDc, PositionDc, QueryLayerServiceInfoDc, RemoteTaskStatus, StringSubType, AttributesConfigurationDc } from '@evergis/api';
 import { FeatureAttributeValue, EditGeometryType, ThemeName } from '../../types';
 import { InnerContainerProps } from './containers/DataSourceInnerContainer/types';
+export * from './componentTypes';
+export * from './branded';
+/** Список допустимых типов диаграммы. `as const` даёт runtime-доступ для dropdown-ов. */
+export declare const CHART_TYPES: readonly ["bar", "line", "pie", "stack"];
+export type ChartType = (typeof CHART_TYPES)[number];
+/** Выравнивание текста/блоков. */
+export declare const ALIGNMENTS: readonly ["left", "center", "right"];
+export type Alignment = (typeof ALIGNMENTS)[number];
+/** Режим отображения коллекций. */
+export declare const VIEW_MODES: readonly ["grid", "list"];
+export type ViewMode = (typeof VIEW_MODES)[number];
+/**
+ * CSS-длина для `fontSize`/etc. Template literal type ловит грубые ошибки вроде
+ * `fontSize: "fourteen"`, при этом пропускает корректные `"1rem"`, `"14px"`, `"100%"`, ...
+ *
+ * Применяется как **opt-in** для нового кода; ConfigOptions.fontSize пока остаётся `string`
+ * ради совместимости с legacy-конфигами.
+ */
+export type CssLength = `${number}rem` | `${number}px` | `${number}em` | `${number}%`;
+export type DesignToken = `var(--${string})`;
+export type FontSizeToken = CssLength | DesignToken | "larger" | "smaller";
+/** CSS-цвет — рамочная проверка, не валидирует hex-формат полностью. */
+export type CssColor = `#${string}` | `rgb(${string})` | `rgba(${string})` | `hsl(${string})` | `hsla(${string})` | `var(--${string})` | "transparent" | "currentColor" | "inherit";
+/** Расширение файла одной строкой: `".csv"`, `".csv,.txt"`. */
+export type FileExtensions = `.${string}` | `.${string},${string}`;
 export interface DashboardsProps {
     zIndex?: CSSProperties["zIndex"];
 }
@@ -63,119 +88,186 @@ export interface CustomFeatureSelect {
         layout?: FillLayerSpecification["layout"];
     };
 }
-export interface ConfigOptions {
-    innerTemplateName?: ContainerTemplate;
+/**
+ * Доменная группировка опций конфига.
+ *
+ * Идея — разбить flat-интерфейс {@link ConfigOptions} (100+ полей) на тематические миксины:
+ * Layout, Typography, Chart, Visual, ... — чтобы `<Name>Options` можно было собирать через
+ * `Pick<ConfigLayoutOptions, ...>` и сразу видеть «характер компонента».
+ *
+ * `ConfigOptions` остаётся плоским fallback-объединением всех доменов (extends всех миксинов),
+ * поэтому существующий код, использующий `Pick<ConfigOptions, ...>`, продолжает работать.
+ *
+ * Поля с пометкой ⚠️ entity-ref — это runtime-связи (`chartId`, `tabId`, `filterName`, ...),
+ * концептуально принадлежат домену {@link ConfigEntityRefOptions} и могут получить branded types.
+ */
+/** Размеры и раскладка. */
+export interface ConfigLayoutOptions {
+    width?: number;
+    height?: number;
+    padding?: number;
+    radius?: number;
+    cornerRadius?: number;
+    column?: boolean;
+    twoColumns?: boolean;
+    align?: Alignment;
+    center?: boolean;
     innerTemplateStyle?: CSSProperties;
-    position?: PositionDc;
-    themeName?: ThemeName;
-    relatedDataSources?: ConfigRelatedDataSource[];
-    relatedAttributes?: ConfigRelatedAttribute[];
-    relatedResources?: ConfigRelatedResource[];
-    statusColors?: Record<RemoteTaskStatus, string>;
-    chartType?: "bar" | "line" | "pie" | "stack";
-    layerNames?: string[];
-    layerName?: string;
-    geometryType?: OgcGeometryType | EditGeometryType;
-    fileExtensions?: string;
-    parentResourceId?: string;
-    srid?: string;
-    title?: string;
-    label?: string;
     withPadding?: boolean;
     withDivider?: boolean;
-    dotSnapping?: boolean;
     bottomBlur?: boolean;
-    tagView?: boolean;
-    simple?: boolean;
-    downloadById?: string;
-    separator?: string;
-    lineBreak?: string;
-    image?: string;
+    noMargin?: boolean;
+    maxTextWidth?: number;
+    barWidth?: number;
+    barHeight?: number;
+}
+/** Типографика и цвета. */
+export interface ConfigTypographyOptions {
+    fontSize?: string;
+    fontColor?: string;
     bgColor?: string;
+    backgroundColor?: string;
+    primaryColor?: string;
+    defaultColor?: string;
     noBg?: boolean;
-    center?: boolean;
-    fontColor?: string;
-    fontSize?: string;
-    placeholder?: string;
-    step?: number;
-    limit?: number;
-    radius?: number;
-    cornerRadius?: number;
-    padding?: number;
-    trim?: boolean;
-    twoColumns?: boolean;
-    inlineUnits?: boolean;
-    noUnits?: boolean;
-    noEmptyOption?: boolean;
-    noMargin?: boolean;
+    colors?: string[];
+    colorAttribute?: string;
+    statusColors?: Record<RemoteTaskStatus, string>;
+}
+/** Поведение «раскрытия». */
+export interface ConfigExpandableOptions {
+    expandable?: boolean;
+    expanded?: boolean;
+    expandLength?: number;
+}
+/** Связь с источником данных. */
+export interface ConfigDataSourceBindingOptions {
+    /** ⚠️ entity-ref: имя источника. */
+    relatedDataSource?: string;
+    relatedDataSources?: ConfigRelatedDataSource[];
+    relatedAttributes?: ConfigRelatedAttribute[];
+    relatedResources?: ConfigRelatedResource[];
+    responseFilters?: Record<string, string>;
+    hideIfEmptyDataSource?: string;
+}
+/** Опции графика. */
+export interface ConfigChartOptions {
+    chartType?: ChartType;
+    /** ⚠️ entity-ref: ссылка на ChartContainer по id. */
     chartId?: string;
+    markers?: BarChartMarker[] | string;
+    showLabels?: boolean;
+    showMarkers?: number;
     showTotal?: boolean;
     totalWord?: string;
     totalAttribute?: string;
-    hideTitle?: boolean;
-    width?: number;
-    height?: number;
-    barWidth?: number;
-    barHeight?: number;
-    showLabels?: boolean;
-    showMarkers?: number;
-    markers?: BarChartMarker[] | string;
+    dotSnapping?: boolean;
     drawMinMax?: boolean;
-    attributes?: string[];
-    attributesExclude?: string[];
-    useProjectHiddenAttributes?: boolean;
-    colors?: string[];
-    defaultColor?: string;
-    primaryColor?: string;
+    angle?: number;
+}
+/** Иконки/изображения. */
+export interface ConfigVisualOptions {
+    icon?: IconTypesKeys;
+    iconAttribute?: string;
+    image?: string;
+    overlay?: string;
+    onlyIcon?: boolean;
+    bigIcon?: boolean;
+    big?: boolean;
+    tagView?: boolean;
+}
+/** Текст/заголовок. */
+export interface ConfigTextDisplayOptions {
+    title?: string;
+    label?: string;
+    placeholder?: string;
+    hideTitle?: boolean;
+    simple?: boolean;
     maxLength?: number;
-    maxValue?: number | Date;
-    minValue?: number | Date;
-    withTime?: boolean;
-    multiSelect?: boolean;
-    variants?: IOption[] | ChipOption[];
+    separator?: string;
+    lineBreak?: string;
+}
+/** Список/коллекция. */
+export interface ConfigCollectionOptions {
     shownItems?: number;
     otherItems?: number;
-    angle?: number;
-    resolution?: number;
     orderByValue?: boolean;
     orderByTitle?: boolean;
-    expandable?: boolean;
-    expanded?: boolean;
-    expandLength?: number;
-    wrap?: boolean;
-    icon?: IconTypesKeys;
-    iconUrl?: string;
-    big?: boolean;
-    bigIcon?: boolean;
-    onlyIcon?: boolean;
+    viewMode?: ViewMode;
     hideEmpty?: boolean;
-    hideIfEmptyDataSource?: string;
-    innerValue?: boolean;
-    groupTooltip?: boolean;
-    tabId?: string;
-    column?: boolean;
-    relatedDataSource?: string;
-    responseFilters?: Record<string, string>;
+    limit?: number;
+}
+/** Карта/слои. */
+export interface ConfigMapLayerOptions {
+    /** ⚠️ entity-ref: имя слоя. */
+    layerName?: string;
+    /** ⚠️ entity-ref: имена слоёв. */
+    layerNames?: string[];
+    geometryType?: OgcGeometryType | EditGeometryType;
+    baseMapName?: string;
+    baseMapSettings?: Record<string, BaseMapSettings>;
+    expandedLayers?: boolean;
+    customFeatureSelect?: CustomFeatureSelect;
+    pitch?: number;
+    bearing?: number;
+    srid?: string;
+    maxZoomTo?: number;
+    position?: PositionDc;
+    resolution?: number;
+}
+/** Контролы редактирования / фильтры. */
+export interface ConfigEditOptions {
     control?: ConfigControl;
     controls?: ConfigControl[];
+    /** ⚠️ entity-ref на ConfigFilter. */
     filterName?: string;
+    /** ⚠️ entity-ref на ConfigFilter. */
     searchFilterName?: string;
-    colorAttribute?: string;
-    iconAttribute?: string;
-    maxTextWidth?: number;
-    backgroundColor?: string;
-    align?: "left" | "center" | "right";
-    pitch?: number;
-    bearing?: number;
-    projection?: string;
-    baseMapName?: string;
-    baseMapSettings?: Record<string, BaseMapSettings>;
-    expandedLayers?: boolean;
+    variants?: IOption[] | ChipOption[];
+    multiSelect?: boolean;
+    withTime?: boolean;
+    step?: number;
+    minValue?: number | Date;
+    maxValue?: number | Date;
+    noEmptyOption?: boolean;
+    fileExtensions?: string;
+}
+/** Ссылки на сущности по id/name. */
+export interface ConfigEntityRefOptions {
+    chartId?: string;
     modalId?: string;
+    tabId?: string;
+    filterName?: string;
+    searchFilterName?: string;
+    layerName?: string;
+    layerNames?: string[];
+    relatedDataSource?: string;
+    parentResourceId?: string;
+    downloadById?: string;
+}
+/** Прочее — поля без явного домена, обычно широкого назначения. */
+export interface ConfigMiscOptions {
+    innerTemplateName?: ContainerTemplate;
+    themeName?: ThemeName;
     url?: string;
-    maxZoomTo?: number;
-    customFeatureSelect?: CustomFeatureSelect;
-    viewMode?: "grid" | "list";
+    inlineUnits?: boolean;
+    noUnits?: boolean;
+    attributes?: string[];
+    useProjectHiddenAttributes?: boolean;
+    innerValue?: boolean;
+    groupTooltip?: boolean;
+    wrap?: boolean;
+    modalId?: string;
+    tabId?: string;
+    downloadById?: string;
+    parentResourceId?: string;
+}
+/**
+ * Flat-объединение всех доменных миксинов. Существующие места, использующие
+ * `Pick<ConfigOptions, ...>`, продолжают работать. Для нового кода предпочтительно делать
+ * `Pick<Config<Domain>Options, ...>` — это лучше документирует, к какому домену относится опция.
+ */
+export interface ConfigOptions extends ConfigLayoutOptions, ConfigTypographyOptions, ConfigExpandableOptions, ConfigDataSourceBindingOptions, ConfigChartOptions, ConfigVisualOptions, ConfigTextDisplayOptions, ConfigCollectionOptions, ConfigMapLayerOptions, ConfigEditOptions, ConfigMiscOptions {
 }
 export interface ConfigDataSource {
     name: string;
@@ -291,9 +383,23 @@ export interface ConfigContainer {
     header?: ConfigContainerHeader;
 }
 export type FilterType = "checkbox" | "rangeNumber" | "rangeDate" | "text" | "dropdown" | "barChart" | "chips";
+/**
+ * Литеральный union значений {@link ConfigContainerChild.type}.
+ *
+ * Делится на две группы:
+ * - text/attribute-рендеры (обрабатываются в `utils/getElementValue.tsx`): `"text"`, `"attributeAlias"`,
+ *   `"attributeValue"`, `"attributeUnits"`, `"attributeDescription"`, `"layerName"`.
+ * - элементы-компоненты (`elements/registry.ts`): `"control"`, `"image"`, `"slideshow"`, `"svg"`,
+ *   `"icon"`, `"tooltip"`, `"tags"`, `"link"`, `"button"`, `"camera"`, `"chart"`, `"legend"`,
+ *   `"markdown"`, `"uploader"`, `"modal"`.
+ *
+ * Slot-id (`"alias"`, `"value"`, `"units"`, ...) сюда **не относится** — это значения поля
+ * `id`, см. parent-specific child-типы.
+ */
+export type ConfigElementType = "text" | "attributeAlias" | "attributeValue" | "attributeUnits" | "attributeDescription" | "layerName" | "control" | "image" | "slideshow" | "svg" | "icon" | "tooltip" | "tags" | "link" | "button" | "camera" | "chart" | "legend" | "markdown" | "uploader" | "modal";
 export interface ConfigContainerChild extends Partial<ConfigContainer> {
     id?: string;
-    type?: string;
+    type?: ConfigElementType;
     templateName?: ContainerTemplate | HeaderTemplate;
     value?: string | number;
     defaultValue?: string | number;
@@ -346,7 +452,7 @@ export declare enum ContainerTemplate {
 export declare enum HeaderTemplate {
     Default = "Default",
     Slideshow = "Slideshow",
-    Gradient = "Gradient"
+    Background = "Background"
 }
 export interface GetRenderElementProps extends Omit<ContainerProps, "renderElement"> {
     expandedContainers?: Record<string, boolean>;
@@ -419,4 +525,3 @@ export type ClientFeatureAttribute = {
     stringFormat?: AttributeFormatConfigurationDc;
     clientData?: unknown;
 };
-export {};