@semcore/d3-chart 2.2.4 → 2.3.0-1

package/lib/types/a11y/hints.d.ts

@@ -0,0 +1,99 @@
+import { SerializableDataType } from './insights';
+declare type DeepPartial<T> = T extends object ? {
+    [P in keyof T]?: DeepPartial<T[P]>;
+} : T;
+export declare type DataStructureHints = {
+    fields: {
+        verticalAxes: Set<string | number>;
+        horizontalAxes: Set<string | number>;
+        valueAxes: Set<string | number>;
+        values: Set<string | number>;
+    };
+    groups: Set<string | number>;
+    axesTitle: {
+        vertical: string | null;
+        horizontal: string | null;
+    };
+    titles: {
+        verticalAxes: {
+            [dataKey: string | number]: string;
+        };
+        getVerticalAxesTitle: null | ((dataKey: string | number) => string);
+        horizontalAxes: {
+            [dataKey: string | number]: string;
+        };
+        getHorizontalAxesTitle: null | ((dataKey: string | number) => string);
+        valuesAxes: {
+            [dataKey: string | number]: string;
+        };
+        getValueAxesTitle: null | ((dataKey: string | number) => string);
+    };
+    grid: {
+        verticalAxes: number | null;
+        horizontalAxes: number | null;
+    };
+    pointsDensity: {
+        verticalAxes: number;
+        horizontalAxes: number;
+    } | null;
+    dataType: SerializableDataType | null;
+};
+export declare type DataSummarizationConfig = {
+    trendTangens: {
+        static: number;
+        weak: number;
+        medium: number;
+        strong: number;
+    };
+    movingAverage: {
+        longSize: number | undefined;
+        shortSize: number | undefined;
+        notableDiff: number | undefined;
+    };
+    dataType: SerializableDataType | undefined;
+    clustersGridSize: number | undefined;
+    maxListSymbols: number;
+    datesWithTime: boolean | undefined;
+    clustersLimit: number;
+    valuesLimit: number;
+    groupsLimit: number;
+    disable: boolean;
+    override: string | undefined;
+};
+export declare type PartialDataSummarizationConfig = DeepPartial<DataSummarizationConfig>;
+export declare const makeDataHintsContainer: () => DataStructureHints;
+export declare const makeDataHintsHandlers: (mutableContainer: DataStructureHints) => {
+    specifyDataRowFields: (x?: string | undefined, y?: string | undefined, value?: string | undefined) => void;
+    setupGrid: (direction: 'vertical' | 'horizontal', size: number) => void;
+    establishDataType: (dataType: SerializableDataType) => void;
+    describeValueEntity: (dataKey: string | number, readableName: string) => void;
+    describeGroupedValues: (groupKey: string | number, dataKey: string | number) => void;
+    labelKey: (axes: 'vertical' | 'horizontal' | 'value', dataKey: string | number, label: string) => void;
+    addKeyLabelGetter: (axes: 'vertical' | 'horizontal' | 'value', getter: (dataKey: string | number) => string) => void;
+    setTitle: (describedDataAxes: 'vertical' | 'horizontal', title: string) => void;
+    setPointsDensity: (horizontalAxes: number, verticalAxes: number) => void;
+};
+export declare type DataHintsHandler = ReturnType<typeof makeDataHintsHandlers>;
+export declare const makeDataSummarizationConfig: (config?: {
+    trendTangens?: {
+        static?: number | undefined;
+        weak?: number | undefined;
+        medium?: number | undefined;
+        strong?: number | undefined;
+    } | undefined;
+    movingAverage?: {
+        longSize?: number | undefined;
+        shortSize?: number | undefined;
+        notableDiff?: number | undefined;
+    } | undefined;
+    dataType?: SerializableDataType | undefined;
+    clustersGridSize?: number | undefined;
+    maxListSymbols?: number | undefined;
+    datesWithTime?: boolean | undefined;
+    clustersLimit?: number | undefined;
+    valuesLimit?: number | undefined;
+    groupsLimit?: number | undefined;
+    disable?: boolean | undefined;
+    override?: string | undefined;
+} | undefined) => DataSummarizationConfig;
+export {};

package/lib/types/a11y/insights.d.ts

@@ -0,0 +1,54 @@
+import { DataStructureHints, DataSummarizationConfig } from './hints';
+export declare type TrendNode = {
+    type: 'trend';
+    priority: number;
+    change: {
+        from: number;
+        to: number;
+        strength: 'strong-reduction' | 'reduction' | 'weak-reduction' | 'static' | 'weak-growth' | 'growth' | 'strong-growth';
+    };
+    from: unknown;
+    to: unknown;
+    dataKey: string | number;
+};
+export declare type GeneralTrendNode = Omit<TrendNode, 'type'> & {
+    type: 'general-trend';
+};
+export declare type ComparisonNode = {
+    type: 'comparison';
+    label?: string;
+    priority: number;
+    values: {
+        value: unknown;
+        label: string;
+    }[];
+};
+declare type ClusterRelativeSize = 'significantly-smaller' | 'smaller' | 'slightly-smaller' | 'average' | 'slightly-bigger' | 'bigger' | 'significantly-bigger';
+export declare type ClusterNode = {
+    type: 'cluster';
+    priority: number;
+    size: number;
+    labels: unknown[];
+    center: {
+        x: number;
+        xLabel: string | number;
+        y: number;
+        yLabel: string | number;
+    };
+    relativeSize: ClusterRelativeSize;
+};
+export declare type Insight = TrendNode | GeneralTrendNode | ComparisonNode | ClusterNode;
+export declare type SerializableDataType = 'time-series' | 'points-cloud' | 'values-set' | 'grouped-values';
+export declare type AnalyzedData = {
+    insights: Insight[];
+    dataType: SerializableDataType;
+    dataRange: {
+        from: string | number | Date;
+        to: string | number | Date;
+        label: string | number | null;
+    }[];
+    dataTitle: string | null;
+    entitiesCount: number;
+};
+export declare const extractDataInsights: (data: Record<string, unknown>[] | Record<string, unknown>, hints: DataStructureHints, config: DataSummarizationConfig) => AnalyzedData;
+export {};

package/lib/types/a11y/intl.d.ts

@@ -0,0 +1,8 @@
+import { IntlShape } from '@formatjs/intl';
+import { translations as defaultTranslations } from './translations/view/translations';
+export declare type Intl = IntlShape<typeof defaultTranslations[keyof typeof defaultTranslations]>;
+export declare const getIntl: (locale: string, translations?: {
+    [locale: string]: {
+        [message: string]: string;
+    };
+}) => Intl;

package/lib/types/a11y/locale.d.ts

@@ -0,0 +1,3 @@
+export declare const normalizeLocale: (providedLocale: string, translations?: {
+    [locale: string]: {};
+}) => string | null;

package/lib/types/a11y/serialize.d.ts

@@ -0,0 +1,16 @@
+import { AnalyzedData } from './insights';
+import { DataSummarizationConfig } from './hints';
+import { Intl } from './intl';
+export declare const formatValue: (intl: Intl, value: unknown, { siblingsTimeMark, maxListSymbols, datesWithTime, }?: {
+    siblingsTimeMark?: unknown;
+    maxListSymbols?: number | undefined;
+    datesWithTime?: boolean | undefined;
+}) => string;
+export declare const serialize: ({ insights, dataType, dataRange, dataTitle, entitiesCount }: AnalyzedData, { datesWithTime, maxListSymbols, clustersLimit, valuesLimit, groupsLimit, }: DataSummarizationConfig, { locale, translations, }: {
+    locale: string;
+    translations?: {
+        [locale: string]: {
+            [messageId: string]: string;
+        };
+    } | undefined;
+}) => string | null;

package/lib/types/a11y/summarize.d.ts

@@ -0,0 +1,2 @@
+import { DataStructureHints, DataSummarizationConfig } from './hints';
+export declare const summarize: (data: Record<string, unknown>[] | Record<string, unknown>, hints: DataStructureHints, config: DataSummarizationConfig, locale: NavigatorLanguage['language']) => string | null;

package/lib/types/a11y/translations/module/translations.d.ts

@@ -0,0 +1,5 @@
+export declare const translations: {
+    [locale: string]: {
+        [message: string]: string;
+    };
+};

package/lib/types/a11y/translations/view/translations.d.ts

@@ -0,0 +1,5 @@
+export declare const translations: {
+    [locale: string]: {
+        [message: string]: string;
+    };
+};

package/lib/types/utils.d.ts

@@ -25,3 +25,4 @@ export declare const roundedPath: (x: number, y: number, w: number, h: number, r
 export declare const getBandwidth: <Scale extends ScaleBand<{}>>(scale: Scale) => number;
 export declare const memoize: <Func extends (...args: any[]) => any>(func: Func) => Func;
 export declare const measureText: (text: string, fontSize?: number | undefined) => number;
+export declare const uniqueId: (prefix?: string) => string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@semcore/d3-chart",
   "description": "SEMRush D3 Chart Component",
-  "version": "2.2.4",
+  "version": "2.3.0-1",
   "main": "lib/cjs/index.js",
   "module": "lib/es6/index.js",
   "typings": "lib/types/index.d.ts",
@@ -13,6 +13,7 @@
     "test": "jest"
   },
   "dependencies": {
+    "@formatjs/intl": "2.3.0",
     "@semcore/animation": "^1",
     "@semcore/flex-box": "^4",
     "@semcore/popper": "^4.9",