@formant/ava 3.4.1-formant

package/lib/ckb/types.d.ts

@@ -0,0 +1,185 @@
+import * as constants from './constants';
+import type { Data, Specification } from '../common/types';
+/**
+ * TS type of standard IDs for each chart type.
+ *
+ * 图表 ID 的 TS 类型
+ *
+ * @public
+ */
+export type ChartId = (typeof constants.CHART_IDS)[number];
+/**
+ * TS type of chart families.
+ *
+ * 所有图表家族的 TS 类型
+ *
+ * @public
+ */
+export type Family = (typeof constants.FAMILIES)[number];
+/**
+ * TS type of analysis purposes.
+ *
+ * 所有分析目的的 TS 类型
+ *
+ * @public
+ */
+export type Purpose = (typeof constants.PURPOSES)[number];
+/**
+ * TS type of coordinate systems.
+ *
+ * 所有坐标系的 TS 类型
+ *
+ * @public
+ */
+export type CoordinateSystem = (typeof constants.COORDINATE_SYSTEMS)[number];
+/**
+ * TS type of graphic categories.
+ *
+ * 所有图形大类的 TS 类型
+ *
+ * @public
+ */
+export type GraphicCategory = (typeof constants.GRAPHIC_CATEGORIES)[number];
+/**
+ * TS type of shapes.
+ *
+ * 所有形状的 TS 类型
+ *
+ * @public
+ */
+export type Shape = (typeof constants.SHAPES)[number];
+/**
+ * TS type of level of measurements.
+ *
+ * 所有度量水平的 TS 类型
+ *
+ * @public
+ */
+export type LevelOfMeasurement = (typeof constants.LEVEL_OF_MEASUREMENTS)[number];
+/**
+ * TS type of A prerequisite for being able to plot data for a specific chart type.
+ *
+ * 能绘制出某图表的数据的先决条件，它的 TS 类型
+ *
+ * @public
+ */
+export type DataPrerequisite = {
+    /**
+     * Minimum Quantity:
+     * At least this many fields are required to draw a chart of this type.
+     *
+     * 最小数量：
+     * 至少要这么多字段才能绘制出对应图表类型
+     */
+    minQty: number;
+    /**
+     * Maximum Quantity:
+     * At most this many fields are required to draw a chart of this type.
+     * '*' stands for infinite.
+     *
+     * 最大数量：
+     * 超过这么多字段就不能或不适合绘制出对应图表类型
+     */
+    maxQty: number | '*';
+    /**
+     * Level of Measurements which the above quantities apply.
+     *
+     * 上述字段数量指的是这里定义的“度量水平”匹配的字段
+     */
+    fieldConditions: LevelOfMeasurement[];
+};
+/**
+ * TS type of channels.
+ *
+ * 所有通道的 TS 类型
+ *
+ * @public
+ */
+export type Channel = (typeof constants.CHANNELS)[number];
+/**
+ * TS type of recommend ratings.
+ *
+ * 所有推荐评级
+ *
+ * @public
+ * @see {@link ./constants.ts#RECOMMEND_RATINGS}
+ */
+export type RecommendRating = (typeof constants.RECOMMEND_RATINGS)[number];
+/**
+ * TS type of pure knowledge for a chart type.
+ * Pure means it is the original English version and not for custom chart types.
+ *
+ * 原装图表类型的信息结构的 TS 类型，非自定义图标类型。
+ *
+ * @public
+ */
+export type PureChartKnowledge = {
+    id: string;
+    name: string;
+    alias: string[];
+    family: Family[];
+    def: string;
+    purpose: Purpose[];
+    coord: CoordinateSystem[];
+    category: GraphicCategory[];
+    shape: Shape[];
+    dataPres: DataPrerequisite[];
+    channel: Channel[];
+    recRate: RecommendRating;
+};
+/**
+ * TS type of knowledge for a chart type.
+ * Could be in any language or values（string), or for custom chart types(with a `toSpec` function).
+ *
+ * 图表类型的信息结构的 TS 类型，可能是不同语言版本, 值和图表类型本身可能是自定义的。自定义图标应当包含 toSpec 方法。
+ *
+ * @public
+ */
+export type ChartKnowledge = {
+    id: string;
+    name: string;
+    alias: string[];
+    family: string[];
+    def: string;
+    purpose: string[];
+    coord: string[];
+    category: string[];
+    shape: string[];
+    dataPres: (Omit<DataPrerequisite, 'fieldConditions'> & {
+        fieldConditions: string[];
+    })[];
+    channel: string[];
+    recRate: string;
+    toSpec?: (data: Data, dataProps: any) => Specification | null;
+};
+/**
+ * TS type of pure CKB(Chart Knowledge Base).
+ * Pure means it is the original English version of CKB and without custom chart types.
+ *
+ * 整个图表知识库（CKB）的原装英文版本的 TS 类型，不带自定义图表类型。
+ *
+ * @public
+ */
+export type PureChartKnowledgeBase = Record<ChartId, PureChartKnowledge>;
+/**
+ * TS type of CKB(Chart Knowledge Base).
+ * Could be in any language or contain custom chart types.
+ *
+ * 整个图表知识库（CKB）的 TS 类型，可能是不同语言版本以及可以带自定义图表类型
+ *
+ * @public
+ */
+export type ChartKnowledgeBase = Record<string, ChartKnowledge>;
+/**
+ * Configuration to pick, omit and customize CKB.
+ * Priority: exclude > include, + custom.
+ *
+ * 用来摘选、剔除和自定义 CKB 的配置。
+ * 优先级逻辑是：先从原装 CKB 中剔除`exclude`的部分，然后在剩余的图表类型中摘选出`include`的部分，
+ * 最后额外加上自定义的图表类型。
+ */
+export type CkbConfig = {
+    exclude?: string[];
+    include?: string[];
+    custom?: ChartKnowledgeBase;
+};

package/lib/ckb/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/common/types.d.ts

@@ -0,0 +1,14 @@
+import { G2ChartSpec } from '../advisor/types';
+/**
+ * One row(record) of data in JSON.
+ */
+export type Datum = Record<string, any>;
+/**
+ * Rows(records) of data.
+ */
+export type Data = Datum[];
+/**
+ * Specification: declarative schema to describe a visualization.
+ */
+export type Specification = G2ChartSpec;
+export type ChartSpec = G2ChartSpec;

package/lib/common/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/data/analysis/field/index.d.ts

@@ -0,0 +1,79 @@
+import type { DateFieldInfo, FieldInfo, NumberFieldInfo, StringFieldInfo } from './types';
+/**
+ * Check if it is StringFieldInfo.
+ */
+export declare function isStringFieldInfo(x: FieldInfo): x is StringFieldInfo;
+/**
+ * Check if it is NumberFieldInfo.
+ */
+export declare function isNumberFieldInfo(x: FieldInfo): x is NumberFieldInfo;
+/**
+ * Check if it is DateFieldInfo.
+ */
+export declare function isDateFieldInfo(x: FieldInfo): x is DateFieldInfo;
+/**
+ * Checks if field is constant
+ * @param info - The {@link FieldInfo} to process
+ */
+export declare function isConst(info: FieldInfo): boolean;
+/**
+ * Checks if field is an ordinal.
+ * @param info - Field Info
+ */
+export declare function isOrdinal(info: FieldInfo): boolean;
+/**
+ * Checks if field is an unique.
+ * @param info - The {@link FieldInfo} to process
+ */
+export declare function isUnique(info: FieldInfo): boolean;
+/**
+ * Checks if field is discrete.
+ * @remarks
+ * @param info - The {@link FieldInfo} to process
+ */
+export declare function isDiscrete(info: FieldInfo): boolean;
+/**
+ * Checks if field is a continuous.
+ * @param info - The {@link FieldInfo} to process
+ */
+export declare function isContinuous(info: FieldInfo): boolean;
+/**
+ * Checks if field is an interval.
+ * @param info - The {@link FieldInfo} to process
+ */
+export declare function isInterval(info: FieldInfo): boolean;
+/**
+ * Checks if field is a nominal.
+ * @param info - The {@link FieldInfo} to process
+ */
+export declare function isNominal(info: FieldInfo): boolean;
+/**
+ * Checks if field is a time.
+ * @param info - Field Info
+ */
+export declare function isTime(info: FieldInfo): boolean;
+/**
+ * Analyze string field info.
+ * @param value - data
+ */
+export declare function analyzeString(value: string[]): Omit<StringFieldInfo, keyof FieldInfo>;
+/**
+ * Analyze number field info.
+ * @param value - data
+ */
+export declare function analyzeNumber(value: number[]): Omit<NumberFieldInfo, keyof FieldInfo>;
+/**
+ * Analyze date field info.
+ * @param value - data
+ */
+export declare function analyzeDate(value: (string | Date)[], isInteger?: boolean): Omit<DateFieldInfo, keyof FieldInfo>;
+/**
+ * Determine what type a value is, may be one of [integer float date string null].
+ */
+export declare function analyzeType(value: unknown, strictDatePattern?: boolean): 'null' | 'integer' | 'float' | 'date' | 'string';
+/**
+ * Analyze field info.
+ * @param value - data
+ * @public
+ */
+export declare function analyzeField(value: unknown[], strictDatePattern?: boolean): StringFieldInfo | NumberFieldInfo | DateFieldInfo;

package/lib/data/analysis/field/index.js

@@ -0,0 +1,355 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.analyzeField = exports.analyzeType = exports.analyzeDate = exports.analyzeNumber = exports.analyzeString = exports.isTime = exports.isNominal = exports.isInterval = exports.isContinuous = exports.isDiscrete = exports.isUnique = exports.isOrdinal = exports.isConst = exports.isDateFieldInfo = exports.isNumberFieldInfo = exports.isStringFieldInfo = void 0;
+var statistics_1 = require("../../statistics");
+var utils_1 = require("../../utils");
+/**
+ * Check if it is StringFieldInfo.
+ */
+function isStringFieldInfo(x) {
+    return x.recommendation === 'string';
+}
+exports.isStringFieldInfo = isStringFieldInfo;
+/**
+ * Check if it is NumberFieldInfo.
+ */
+function isNumberFieldInfo(x) {
+    return x.recommendation === 'integer' || x.recommendation === 'float';
+}
+exports.isNumberFieldInfo = isNumberFieldInfo;
+/**
+ * Check if it is DateFieldInfo.
+ */
+function isDateFieldInfo(x) {
+    return x.recommendation === 'date';
+}
+exports.isDateFieldInfo = isDateFieldInfo;
+/**
+ * Checks if field is constant
+ * @param info - The {@link FieldInfo} to process
+ */
+function isConst(info) {
+    return info.distinct === 1;
+}
+exports.isConst = isConst;
+/**
+ * Checks if field is an ordinal.
+ * @param info - Field Info
+ */
+function isOrdinal(info) {
+    var rawData = info.rawData, recommendation = info.recommendation;
+    if (recommendation !== 'string')
+        return false;
+    if (isConst(info))
+        return false;
+    var list = rawData.filter(function (item) { return !(0, utils_1.isNil)(item) && (0, utils_1.isBasicType)(item); });
+    if (list.length === 0)
+        return false;
+    var start = null;
+    var end = null;
+    var startIndex = -1;
+    var endIndex = -1;
+    var through = true;
+    while (through) {
+        var through_1 = true;
+        for (var i = 0; i < list.length; i += 1) {
+            var item = list[i];
+            var char = item[startIndex + 1];
+            if (start === null || i === 0)
+                start = char;
+            if (char !== start) {
+                through_1 = false;
+                break;
+            }
+        }
+        if (!through_1)
+            break;
+        startIndex += 1;
+    }
+    through = true;
+    while (through) {
+        var through_2 = true;
+        for (var i = 0; i < list.length; i += 1) {
+            var item = list[i];
+            var char = item[item.length - 1 - (endIndex + 1)];
+            if (end === null || i === 0)
+                end = char;
+            if (char !== end) {
+                through_2 = false;
+                break;
+            }
+        }
+        if (!through_2)
+            break;
+        endIndex += 1;
+    }
+    var patterns = [/\d+/, /(零|一|二|三|四|五|六|七|八|九|十)+/, /(一|二|三|四|五|六|日)/, /^[a-z]$/, /^[A-Z]$/];
+    if (startIndex === -1 && endIndex === -1)
+        return false;
+    var arr = list.map(function (item) {
+        return item.slice(startIndex === -1 ? 0 : startIndex + 1, endIndex === -1 ? undefined : item.length - endIndex - 1);
+    });
+    var _loop_1 = function (i) {
+        var p = patterns[i];
+        var notMatch = arr.some(function (item) { return !p.test(item); });
+        if (!notMatch)
+            return { value: true };
+    };
+    for (var i = 0; i < patterns.length; i += 1) {
+        var state_1 = _loop_1(i);
+        if (typeof state_1 === "object")
+            return state_1.value;
+    }
+    return false;
+}
+exports.isOrdinal = isOrdinal;
+/**
+ * Checks if field is an unique.
+ * @param info - The {@link FieldInfo} to process
+ */
+function isUnique(info) {
+    return info.distinct === info.count;
+}
+exports.isUnique = isUnique;
+/**
+ * Checks if field is discrete.
+ * @remarks
+ * @param info - The {@link FieldInfo} to process
+ */
+function isDiscrete(info) {
+    return info.recommendation === 'integer';
+}
+exports.isDiscrete = isDiscrete;
+/**
+ * Checks if field is a continuous.
+ * @param info - The {@link FieldInfo} to process
+ */
+function isContinuous(info) {
+    return info.recommendation === 'float';
+}
+exports.isContinuous = isContinuous;
+/**
+ * Checks if field is an interval.
+ * @param info - The {@link FieldInfo} to process
+ */
+function isInterval(info) {
+    return info.recommendation === 'integer' || info.recommendation === 'float';
+}
+exports.isInterval = isInterval;
+/**
+ * Checks if field is a nominal.
+ * @param info - The {@link FieldInfo} to process
+ */
+function isNominal(info) {
+    if (info.recommendation === 'boolean')
+        return true;
+    if (info.recommendation === 'string')
+        return !isOrdinal(info);
+    return false;
+}
+exports.isNominal = isNominal;
+/**
+ * Checks if field is a time.
+ * @param info - Field Info
+ */
+function isTime(info) {
+    return info.recommendation === 'date';
+}
+exports.isTime = isTime;
+/**
+ * Analyze string field info.
+ * @param value - data
+ */
+function analyzeString(value) {
+    var lenArray = value.map(function (item) { return item.length; });
+    return {
+        maxLength: (0, statistics_1.max)(lenArray),
+        minLength: (0, statistics_1.min)(lenArray),
+        meanLength: (0, statistics_1.mean)(lenArray),
+        containsChar: value.some(function (item) { return /[A-z]/.test(item); }),
+        containsDigit: value.some(function (item) { return /[0-9]/.test(item); }),
+        containsSpace: value.some(function (item) { return /\s/.test(item); }),
+    };
+}
+exports.analyzeString = analyzeString;
+/**
+ * Analyze number field info.
+ * @param value - data
+ */
+function analyzeNumber(value) {
+    return {
+        minimum: (0, statistics_1.min)(value),
+        maximum: (0, statistics_1.max)(value),
+        mean: (0, statistics_1.mean)(value),
+        percentile5: (0, statistics_1.quantile)(value, 5),
+        percentile25: (0, statistics_1.quantile)(value, 25),
+        percentile50: (0, statistics_1.quantile)(value, 50),
+        percentile75: (0, statistics_1.quantile)(value, 75),
+        percentile95: (0, statistics_1.quantile)(value, 95),
+        sum: (0, statistics_1.sum)(value),
+        variance: (0, statistics_1.variance)(value),
+        standardDeviation: (0, statistics_1.standardDeviation)(value),
+        zeros: value.filter(function (item) { return item === 0; }).length,
+    };
+}
+exports.analyzeNumber = analyzeNumber;
+/**
+ * Analyze date field info.
+ * @param value - data
+ */
+function analyzeDate(value, isInteger) {
+    if (isInteger === void 0) { isInteger = false; }
+    var list = value.map(function (item) {
+        if (isInteger) {
+            var str = "".concat(item);
+            if (str.length === 8)
+                return new Date("".concat(str.substring(0, 4), "/").concat(str.substring(4, 2), "/").concat(str.substring(6, 2))).getTime();
+        }
+        return new Date(item).getTime();
+    });
+    return {
+        minimum: value[(0, statistics_1.minIndex)(list)],
+        maximum: value[(0, statistics_1.maxIndex)(list)],
+    };
+}
+exports.analyzeDate = analyzeDate;
+/**
+ * Determine what type a value is, may be one of [integer float date string null].
+ */
+function analyzeType(value, strictDatePattern) {
+    if ((0, utils_1.isNil)(value))
+        return 'null';
+    if ((0, utils_1.isNumber)(value)) {
+        if ((0, utils_1.isInteger)(value))
+            return 'integer';
+        return 'float';
+    }
+    // 优先识别日期类型，避免字符型日期被判断成字符
+    if ((0, utils_1.isDate)(value) || (0, utils_1.isDateString)(value, strictDatePattern))
+        return 'date';
+    if ((0, utils_1.isString)(value)) {
+        if ((0, utils_1.isNumberString)(value)) {
+            if (value.includes('.'))
+                return 'float';
+            return 'integer';
+        }
+    }
+    return 'string';
+}
+exports.analyzeType = analyzeType;
+/**
+ * Analyze field info.
+ * @param value - data
+ * @public
+ */
+function analyzeField(value, strictDatePattern) {
+    var list = value.map(function (item) { return ((0, utils_1.isNil)(item) ? null : item); });
+    var valueMap = (0, statistics_1.valueMap)(list);
+    var recommendation;
+    var nonNullArray = valueMap.null ? list.filter(function (item) { return item !== null; }) : list;
+    var typeArray = list.map(function (item) { return analyzeType(item, strictDatePattern); });
+    var types = Object.keys((0, statistics_1.valueMap)(typeArray)).filter(function (item) { return item !== 'null'; });
+    // generate recommendation
+    switch (types.length) {
+        case 0:
+            recommendation = 'null';
+            break;
+        case 1:
+            recommendation = types[0];
+            // an integer field may be a date field
+            if (recommendation === 'integer') {
+                var data = list.filter(function (item) { return item !== null; });
+                if (data.map(function (num) { return "".concat(num); }).every(function (str) { return (0, utils_1.isDateString)(str); })) {
+                    recommendation = 'date';
+                }
+            }
+            break;
+        case 2:
+            if ((types.includes('integer') || types.includes('date')) && types.includes('float')) {
+                recommendation = 'float';
+                break;
+            }
+            if (types.includes('integer') && types.includes('date')) {
+                // an integer field may be a date field
+                var data = list.filter(function (item) { return item !== null; });
+                if (data.map(function (num) { return "".concat(num); }).every(function (str) { return (0, utils_1.isDateString)(str); })) {
+                    recommendation = 'date';
+                }
+                else {
+                    recommendation = 'integer';
+                }
+                break;
+            }
+            recommendation = 'string';
+            break;
+        default:
+            recommendation = 'string';
+    }
+    var uniqueArray = (0, utils_1.unique)(nonNullArray);
+    var fieldInfo = {
+        count: value.length,
+        distinct: uniqueArray.length,
+        type: types.length <= 1 ? types[0] || 'null' : 'mixed',
+        recommendation: recommendation,
+        missing: valueMap.null || 0,
+        rawData: value,
+        valueMap: valueMap,
+    };
+    if (types.length > 1) {
+        var meta_1 = {};
+        var restNotNullArray_1 = nonNullArray;
+        types.forEach(function (item) {
+            if (item === 'date') {
+                meta_1.date = analyzeField(restNotNullArray_1.filter(function (item) { return (0, utils_1.isDateString)(item); }), strictDatePattern);
+                restNotNullArray_1 = restNotNullArray_1.filter(function (item) { return !(0, utils_1.isDateString)(item); });
+            }
+            else if (item === 'integer') {
+                meta_1.integer = analyzeField(restNotNullArray_1.filter(function (item) { return (0, utils_1.isIntegerString)(item) && !(0, utils_1.isDateString)(item); }), strictDatePattern);
+                restNotNullArray_1 = restNotNullArray_1.filter(function (item) { return !(0, utils_1.isIntegerString)(item); });
+            }
+            else if (item === 'float') {
+                meta_1.float = analyzeField(restNotNullArray_1.filter(function (item) { return (0, utils_1.isFloatString)(item) && !(0, utils_1.isDateString)(item); }), strictDatePattern);
+                restNotNullArray_1 = restNotNullArray_1.filter(function (item) { return !(0, utils_1.isFloatString)(item); });
+            }
+            else if (item === 'string') {
+                meta_1.string = analyzeField(restNotNullArray_1.filter(function (item) { return analyzeType(item, strictDatePattern) === 'string'; }));
+                restNotNullArray_1 = restNotNullArray_1.filter(function (item) { return analyzeType(item, strictDatePattern) !== 'string'; });
+            }
+        });
+        fieldInfo.meta = meta_1;
+    }
+    if (fieldInfo.distinct === 2 && fieldInfo.recommendation !== 'date') {
+        // temporarily threshold
+        if (list.length >= 100) {
+            fieldInfo.recommendation = 'boolean';
+        }
+        else if ((0, utils_1.isBoolean)(uniqueArray, true)) {
+            fieldInfo.recommendation = 'boolean';
+        }
+    }
+    if (recommendation === 'string') {
+        Object.assign(fieldInfo, analyzeString(nonNullArray.map(function (item) { return "".concat(item); })));
+    }
+    if (recommendation === 'integer' || recommendation === 'float') {
+        Object.assign(fieldInfo, analyzeNumber(nonNullArray.map(function (item) { return item * 1; })));
+    }
+    if (recommendation === 'date') {
+        Object.assign(fieldInfo, analyzeDate(nonNullArray, fieldInfo.type === 'integer'));
+    }
+    var levelOfMeasurements = [];
+    if (isNominal(fieldInfo))
+        levelOfMeasurements.push('Nominal');
+    if (isOrdinal(fieldInfo))
+        levelOfMeasurements.push('Ordinal');
+    if (isInterval(fieldInfo))
+        levelOfMeasurements.push('Interval');
+    if (isDiscrete(fieldInfo))
+        levelOfMeasurements.push('Discrete');
+    if (isContinuous(fieldInfo))
+        levelOfMeasurements.push('Continuous');
+    if (isTime(fieldInfo))
+        levelOfMeasurements.push('Time');
+    fieldInfo.levelOfMeasurements = levelOfMeasurements;
+    return fieldInfo;
+}
+exports.analyzeField = analyzeField;