@formant/ava 3.4.1-formant

package/lib/ntv/generate/generateTextSpec.js

@@ -0,0 +1,160 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+/* eslint-disable no-console */
+var lodash_1 = require("lodash");
+var utils_1 = require("../../utils");
+var utils_2 = require("../utils");
+var utils_3 = require("./utils");
+var TextSpecGenerator = /** @class */ (function () {
+    function TextSpecGenerator(_a) {
+        var variable = _a.variable, structures = _a.structures, structureTemps = _a.structureTemps;
+        this.variable = variable;
+        this.structures = structures;
+        this.structureTemps = structureTemps;
+    }
+    TextSpecGenerator.prototype.generateTextPhrase = function (text) {
+        // TODO 是否需要判断 value 为 string ？？是否需要默认的数值格式化？—— 暂时先简单 toString 下
+        return { type: 'text', value: (0, lodash_1.toString)(text) };
+    };
+    TextSpecGenerator.prototype.generateVarPhrase = function (scopeVariable, path, value, metadata) {
+        // 没有 meta 的一律按普通文本处理
+        if (!metadata) {
+            return this.generateTextPhrase(value);
+        }
+        var varType = metadata.varType, formatter = metadata.formatter, extraCustomMeta = metadata.extraCustomMeta;
+        var formattedValue = (0, utils_3.getFormattedNumberValue)(varType, value, formatter);
+        // 声明 varType 的可能是 entity 也可能是 custom
+        if (varType) {
+            if ((0, utils_2.isEntityType)(varType)) {
+                return {
+                    type: 'entity',
+                    value: formattedValue,
+                    metadata: {
+                        entityType: varType,
+                        origin: (0, utils_1.isNumberLike)(value) ? value : undefined,
+                        assessment: (0, utils_3.getAssessment)(varType, value),
+                        generateVariableInfo: { scopeVariable: scopeVariable, path: path },
+                    },
+                };
+            }
+            var extra = extraCustomMeta === null || extraCustomMeta === void 0 ? void 0 : extraCustomMeta(this.variable, scopeVariable);
+            return {
+                type: 'custom',
+                value: formattedValue,
+                // TODO 完善自定义短语 metadata
+                metadata: tslib_1.__assign({ customType: varType, generateVariableInfo: { scopeVariable: scopeVariable, path: path } }, extra),
+            };
+        }
+        return this.generateTextPhrase((0, lodash_1.toString)(value));
+    };
+    // 只处理行数据拼接逻辑，表格数据
+    TextSpecGenerator.prototype.generateSentence = function (template, variable, variableMetaMap) {
+        var _this = this;
+        var phrases = [];
+        var templateStructure = (0, utils_3.templateStr2Structure)(template);
+        var _loop_1 = function (i) {
+            var _a = templateStructure[i], tempStrType = _a.type, tempStrValue = _a.value;
+            if (tempStrType === 'template') {
+                var targetTempId_1 = tempStrValue;
+                // get template info by template id
+                var templateInfo = this_1.structureTemps.find(function (_a) {
+                    var templateId = _a.templateId;
+                    return templateId === targetTempId_1;
+                });
+                if (templateInfo) {
+                    var template_1 = templateInfo.template, useVariable = templateInfo.useVariable, variableMetaMap_1 = templateInfo.variableMetaMap, limit = templateInfo.limit, _b = templateInfo.separator, separator_1 = _b === void 0 ? ',' : _b;
+                    var scopeArrayVariable_1 = (0, utils_3.getScopeVariableArray)(this_1.variable, variable, useVariable, limit);
+                    var subPhrases = scopeArrayVariable_1
+                        .map(function (v) { return _this.generateSentence(template_1, v, variableMetaMap_1); })
+                        .reduce(function (prev, curr, index) {
+                        var result = tslib_1.__spreadArray(tslib_1.__spreadArray([], tslib_1.__read(prev), false), tslib_1.__read(curr), false);
+                        if (index !== scopeArrayVariable_1.length - 1)
+                            result.push(_this.generateTextPhrase(separator_1));
+                        return result;
+                    }, []);
+                    phrases = phrases.concat.apply(phrases, tslib_1.__spreadArray([], tslib_1.__read(subPhrases), false));
+                }
+                else {
+                    console.warn("".concat(targetTempId_1, " is not exist"));
+                }
+            }
+            else if (tempStrType === 'variable') {
+                var key = tempStrValue;
+                var metadata = variableMetaMap === null || variableMetaMap === void 0 ? void 0 : variableMetaMap[key];
+                var value = (metadata === null || metadata === void 0 ? void 0 : metadata.getDisplayValue)
+                    ? (0, utils_3.getDisplayValue)(metadata === null || metadata === void 0 ? void 0 : metadata.getDisplayValue, this_1.variable, variable)
+                    : (0, utils_3.getByPath)(this_1.variable, variable, key);
+                phrases.push(this_1.generateVarPhrase(variable, key, value, tslib_1.__assign({}, metadata)));
+            }
+            else if (tempStrType === 'text') {
+                phrases.push(this_1.generateTextPhrase(tempStrValue));
+            }
+        };
+        var this_1 = this;
+        for (var i = 0; i < templateStructure.length; i += 1) {
+            _loop_1(i);
+        }
+        return phrases;
+    };
+    /**
+     * 生成段落
+     * 1. 当前支持段落类型 heading normal bullet
+     * 2. 生成段落个数取决于 variable 的类型：
+     *  2.1 非自带循环属性的段落（heading normal）遇到数组数据时自动循环多段；
+     *  2.2 自身循环段落（bullet）遇到非数组时只生成一个
+     * */
+    TextSpecGenerator.prototype.generateParagraphs = function (structure, variable) {
+        var _this = this;
+        if (variable === void 0) { variable = this.variable; }
+        var variableMetaMap = structure.variableMetaMap, template = structure.template, _a = structure.displayType, displayType = _a === void 0 ? 'paragraph' : _a, _b = structure.useVariable, useVariable = _b === void 0 ? '' : _b, limit = structure.limit, 
+        // 段落级别暂时用不到 separator
+        // separator,
+        bulletOrder = structure.bulletOrder, children = structure.children, className = structure.className;
+        var scopeArrayVariable = (0, utils_3.getScopeVariableArray)(this.variable, variable, useVariable, limit);
+        // TODO 接入更多类型
+        if (displayType === 'paragraph') {
+            return scopeArrayVariable.map(function (v) { return ({
+                type: 'normal',
+                phrases: _this.generateSentence(template, v, variableMetaMap),
+                className: className,
+            }); });
+        }
+        if (displayType === 'bullet') {
+            return [
+                {
+                    type: 'bullets',
+                    className: className,
+                    isOrder: bulletOrder,
+                    bullets: scopeArrayVariable.map(function (v) { return ({
+                        type: 'bullet-item',
+                        phrases: _this.generateSentence(template, v, variableMetaMap),
+                        subBullet: children
+                            ? _this.generateParagraphs(tslib_1.__assign(tslib_1.__assign({}, children), { displayType: 'bullet' }), v)[0]
+                            : undefined,
+                    }); }),
+                },
+            ];
+        }
+        return null;
+    };
+    TextSpecGenerator.prototype.generateSection = function () {
+        var _this = this;
+        return {
+            paragraphs: this.structures.reduce(function (prev, curr) {
+                return tslib_1.__spreadArray(tslib_1.__spreadArray([], tslib_1.__read(prev), false), tslib_1.__read(_this.generateParagraphs(curr)), false);
+            }, []),
+        };
+    };
+    TextSpecGenerator.prototype.generateNarrative = function () {
+        return {
+            // 当前只可能构建出一个 section
+            sections: [this.generateSection()],
+        };
+    };
+    return TextSpecGenerator;
+}());
+function generateTextSpec(params) {
+    return new TextSpecGenerator(params).generateNarrative();
+}
+exports.default = generateTextSpec;

package/lib/ntv/generate/index.d.ts

@@ -0,0 +1,2 @@
+export { default as generateTextSpec } from './generateTextSpec';
+export type { Structure, StructureTemp, Variable } from './types';

package/lib/ntv/generate/index.js

@@ -0,0 +1,12 @@
+"use strict";
+/*
+ * generate text spec by structure and variable
+ * thx @Lobster377
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateTextSpec = void 0;
+var generateTextSpec_1 = require("./generateTextSpec");
+Object.defineProperty(exports, "generateTextSpec", { enumerable: true, get: function () { return __importDefault(generateTextSpec_1).default; } });

package/lib/ntv/generate/types.d.ts

@@ -0,0 +1,58 @@
+type StructureDisplayType = 'heading' | 'paragraph' | 'bullet';
+export type VariableMeta = Partial<{
+    /** 可能是 entityType 或者是 customType */
+    varType: string;
+    formatter: (value: any) => string;
+    /** 类似计算字段，行级别拼接 value 变量 */
+    getDisplayValue: string | ((globalVar: Variable, scopeVar: Variable) => string);
+    /** 其他自定义属性 */
+    extraCustomMeta: (globalVar: Variable, scopeVar: Variable) => Record<string, any>;
+}>;
+export type VariableMetaMap = Record<string, VariableMeta>;
+export type TemplateBase = {
+    /**
+     * template string
+     * -- use ${} 表示应用哪个变量
+     * -- use &{} 表示应用哪个模版，即 structureTemp 中的 templateId
+     */
+    template: string;
+    /** 分隔符，如果数据是数组，自动循环 */
+    separator?: string;
+    /** 列表循环 limit */
+    limit?: number;
+    /** 变量附加信息 */
+    variableMetaMap?: VariableMetaMap;
+    /** 通过类似 lodash get 变量路径访问变量 */
+    useVariable?: string;
+};
+/**
+ * @description narrative structure，会按顺序执行
+ * @example Structure[] like bellow:
+ * [
+ *    { template: "system &{s1}, includes &{s2} .", displayType: "paragraph" },
+ * ]
+ */
+export type Structure = TemplateBase & {
+    /**
+     * 展示段落类型
+     */
+    displayType?: StructureDisplayType;
+    /** 列表是否有序 */
+    bulletOrder?: boolean;
+    /** 用于嵌套列表 */
+    children?: Structure;
+    className?: string;
+};
+/**
+ * @description structure template，只有引用到才会按执行
+ * @example StructureTemp[] like bellow:
+ * [
+ *    { templateId: s1, template: "&{s1}", variableId: "var2" },
+ *    { templateId: s2, template: 'user ${name}, ${age[metric_name]} is ${age}', variableId: 'var1', displayType: 'phrase', separator: ', ' }
+ * ]
+ */
+export type StructureTemp = TemplateBase & {
+    templateId: string;
+};
+export type Variable = Record<string, any>;
+export {};

package/lib/ntv/generate/types.js

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

package/lib/ntv/generate/utils.d.ts

@@ -0,0 +1,29 @@
+import type { Variable, VariableMeta } from './types';
+import type { EntityType } from '../schema';
+export type TemplateStructure = {
+    type: 'text' | 'variable' | 'template';
+    value: string;
+};
+/**
+ * simple path system
+ * if starts with '.', it's relative path
+ * // TODO 支持相对路径找到上级
+ * if starts with '..', it's can get prev level variable
+ * otherwise, it's absolute path
+ */
+export declare function getByPath(globalVar: Variable, scopeVar: Variable, path?: string): any;
+/**
+ * parse template string
+ *    Use $ for variable
+ *    Use & for template
+ * @example 'aaa ${key} &{temp1}'
+ *  => [{ type: 'text', value: 'aaa ' }, { type: 'variable', value: 'key' }, { type: 'template', value: 'temp1' }]
+ */
+export declare function templateStr2Structure(templateStr: string): TemplateStructure[];
+/** format any to array, and filter nil */
+export declare function formattedAsArray(variable: Variable): any[];
+export declare function getScopeVariableArray(globalVar: Variable, scopeVar: Variable, path: string, limit?: number): any[];
+export declare function getAssessment(entityType: EntityType, value: any): "positive" | "negative";
+export declare function getFormattedNumberValue(varType: string, value: any, formatter?: VariableMeta['formatter']): any;
+/** get phrase text */
+export declare function getDisplayValue(getDisplayValuePattern: VariableMeta['getDisplayValue'], globalVar: Variable, scopeVar: Variable): string;

package/lib/ntv/generate/utils.js

@@ -0,0 +1,96 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDisplayValue = exports.getFormattedNumberValue = exports.getAssessment = exports.getScopeVariableArray = exports.formattedAsArray = exports.templateStr2Structure = exports.getByPath = void 0;
+var lodash_1 = require("lodash");
+var utils_1 = require("../../utils");
+/**
+ * simple path system
+ * if starts with '.', it's relative path
+ * // TODO 支持相对路径找到上级
+ * if starts with '..', it's can get prev level variable
+ * otherwise, it's absolute path
+ */
+function getByPath(globalVar, scopeVar, path) {
+    if (!path)
+        return scopeVar;
+    if ((0, lodash_1.startsWith)(path, '.'))
+        return (0, lodash_1.get)(scopeVar, path.slice(1));
+    return (0, lodash_1.get)(globalVar, path);
+}
+exports.getByPath = getByPath;
+/**
+ * parse template string
+ *    Use $ for variable
+ *    Use & for template
+ * @example 'aaa ${key} &{temp1}'
+ *  => [{ type: 'text', value: 'aaa ' }, { type: 'variable', value: 'key' }, { type: 'template', value: 'temp1' }]
+ */
+function templateStr2Structure(templateStr) {
+    // eslint-disable-next-line no-useless-escape
+    var splitReg = /([\$|&]{.*?})/;
+    var varReg = /\${(.*?)}/;
+    var tempReg = /&{(.*?)}/;
+    return templateStr
+        .split(splitReg)
+        .filter(function (str) { return str; })
+        .map(function (str) {
+        var _a, _b;
+        var templateId = (_a = tempReg.exec(str)) === null || _a === void 0 ? void 0 : _a[1];
+        if (templateId)
+            return { value: templateId, type: 'template' };
+        var varName = (_b = varReg.exec(str)) === null || _b === void 0 ? void 0 : _b[1];
+        if (varName)
+            return { value: varName, type: 'variable' };
+        return { value: str, type: 'text' };
+    });
+}
+exports.templateStr2Structure = templateStr2Structure;
+/** format any to array, and filter nil */
+function formattedAsArray(variable) {
+    if ((0, lodash_1.isUndefined)(variable))
+        return [];
+    return (0, lodash_1.isArray)(variable) ? variable : [variable];
+}
+exports.formattedAsArray = formattedAsArray;
+function getScopeVariableArray(globalVar, scopeVar, path, limit) {
+    return (0, lodash_1.slice)(formattedAsArray(getByPath(globalVar, scopeVar, path)), 0, limit);
+}
+exports.getScopeVariableArray = getScopeVariableArray;
+function getAssessment(entityType, value) {
+    if (!(0, utils_1.isNumberLike)(value))
+        return undefined;
+    if (entityType === 'delta_value' || entityType === 'ratio_value') {
+        if (value > 0)
+            return 'positive';
+        if (value < 0)
+            return 'negative';
+    }
+    return undefined;
+}
+exports.getAssessment = getAssessment;
+function getFormattedNumberValue(varType, value, formatter) {
+    if (!(0, utils_1.isNumberLike)(value))
+        return value;
+    if (varType === 'delta_value' || varType === 'ratio_value') {
+        return formatter ? formatter(Math.abs(value)) : (0, utils_1.dataFormat)(Math.abs(value));
+    }
+    if (varType === 'proportion') {
+        return formatter ? formatter(Math.abs(value)) : "".concat((0, utils_1.dataFormat)(value * 100), "%");
+    }
+    return formatter ? formatter(value) : (0, utils_1.dataFormat)(value);
+}
+exports.getFormattedNumberValue = getFormattedNumberValue;
+/** get phrase text */
+function getDisplayValue(getDisplayValuePattern, globalVar, scopeVar) {
+    if ((0, lodash_1.isString)(getDisplayValuePattern)) {
+        // 用字符串表示使用变量拼接短语文字内容，这里进行变量替换，eg '${city} = ${value}' => '北京 = 1000'
+        // Use a string to represent the text content of the phrase using variables to splice，eg '${city} = ${value}' => 'Beijing = 1000'
+        return (0, lodash_1.replace)(getDisplayValuePattern, /\${(.*?)}/g, function (match) {
+            var _a;
+            var varName = (_a = /\${(.*?)}/.exec(match)) === null || _a === void 0 ? void 0 : _a[1];
+            return varName ? getByPath(globalVar, scopeVar, varName) : '';
+        });
+    }
+    return getDisplayValuePattern(globalVar, scopeVar);
+}
+exports.getDisplayValue = getDisplayValue;

package/lib/ntv/index.d.ts

@@ -0,0 +1,4 @@
+export * from './types';
+export { ENTITY_TYPES } from './schema';
+export * from './utils';
+export { generateTextSpec } from './generate';

package/lib/ntv/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateTextSpec = exports.ENTITY_TYPES = void 0;
+var tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./types"), exports);
+var schema_1 = require("./schema");
+Object.defineProperty(exports, "ENTITY_TYPES", { enumerable: true, get: function () { return schema_1.ENTITY_TYPES; } });
+tslib_1.__exportStar(require("./utils"), exports);
+var generate_1 = require("./generate");
+Object.defineProperty(exports, "generateTextSpec", { enumerable: true, get: function () { return generate_1.generateTextSpec; } });

package/lib/ntv/schema/common.d.ts

@@ -0,0 +1,17 @@
+import type { Properties } from 'csstype';
+/** common props for block ele and inline ele */
+export type CommonProps = {
+    styles?: Properties;
+    className?: string;
+    key?: string;
+};
+/** basic block element structure, used for extends */
+export type CustomBlockElement = CommonProps & {
+    customType: string;
+    [key: string]: unknown;
+};
+/** custom phrase metadata */
+export type CustomMetaData = {
+    customType: string;
+    [key: string]: unknown;
+};

package/lib/ntv/schema/common.js

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

package/lib/ntv/schema/index.d.ts

@@ -0,0 +1,4 @@
+export * from './common';
+export * from './structure';
+export * from './paragraph';
+export * from './phrase';

package/lib/ntv/schema/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./common"), exports);
+tslib_1.__exportStar(require("./structure"), exports);
+tslib_1.__exportStar(require("./paragraph"), exports);
+tslib_1.__exportStar(require("./phrase"), exports);

package/lib/ntv/schema/paragraph.d.ts

@@ -0,0 +1,34 @@
+import type { PhraseSpec } from './phrase';
+import type { CommonProps, CustomBlockElement } from './common';
+export type ParagraphSpec = HeadingParagraphSpec | TextParagraphSpec | BulletsParagraphSpec | DividerParagraphSpec | CustomBlockElement;
+export type HeadingParagraphSpec = CommonProps & {
+    type: 'heading1' | 'heading2' | 'heading3' | 'heading4' | 'heading5' | 'heading6';
+    phrases: PhraseSpec[];
+};
+/**
+ * indents 段落缩紧
+ */
+export type ParagraphIndent = {
+    /** 缩进类型：参考 word 排版，包括：首行缩紧、左缩进、右缩进、 悬挂缩进（情况较少，暂不支持） */
+    type: 'first-line' | 'left' | 'right';
+    /** 缩进值，支持 css text-indent 值，比如 12px 20% 2em */
+    length: string;
+};
+export type TextParagraphSpec = CommonProps & {
+    type: 'normal';
+    phrases: PhraseSpec[];
+    indents?: ParagraphIndent[];
+};
+export type DividerParagraphSpec = CommonProps & {
+    type: 'divider';
+};
+export type BulletsParagraphSpec = CommonProps & {
+    type: 'bullets';
+    isOrder: boolean;
+    bullets: BulletItemSpec[];
+};
+export type BulletItemSpec = CommonProps & {
+    type: 'bullet-item';
+    phrases: PhraseSpec[];
+    subBullet?: BulletsParagraphSpec;
+};

package/lib/ntv/schema/paragraph.js

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

package/lib/ntv/schema/phrase.d.ts

@@ -0,0 +1,70 @@
+import { Variable } from '../generate/types';
+import { CustomMetaData, CommonProps } from './common';
+export type PhraseSpec = TextPhraseSpec | EntityPhraseSpec | EscapePhraseSpec | FormulaPhraseSpec | ImagePhraseSpec | CustomPhraseSpec<CustomMetaData>;
+export type TextPhraseSpec = CommonProps & {
+    type: 'text';
+    value: string;
+    bold?: boolean;
+    italic?: boolean;
+    underline?: boolean;
+    url?: string;
+};
+export type ImagePhraseSpec = CommonProps & {
+    type: 'image';
+    value: string;
+    alt?: string;
+};
+/**
+ * escape character 支持转义字符
+ */
+export type EscapePhraseSpec = CommonProps & {
+    type: 'escape';
+    value: string;
+};
+/**
+ * math formula
+ */
+export type FormulaPhraseSpec = CommonProps & {
+    type: 'formula';
+    value: string;
+};
+export type EntityPhraseSpec = CommonProps & {
+    type: 'entity';
+    value?: string;
+    metadata?: EntityMetaData;
+};
+export type CustomPhraseSpec<P extends CustomMetaData = CustomMetaData> = CommonProps & {
+    type: 'custom';
+    value?: string;
+    metadata?: P;
+};
+export type ValueAssessment = 'positive' | 'negative' | 'equal';
+export declare const ENTITY_TYPES: readonly ["metric_name", "metric_value", "other_metric_value", "contribute_ratio", "delta_value", "ratio_value", "trend_desc", "dim_value", "time_desc", "proportion"];
+export type EntityType = (typeof ENTITY_TYPES)[number];
+export type EntityMetaData = {
+    /**
+     * entity type, 实体类型标记
+     * */
+    entityType: EntityType;
+    /**
+     * assessment up or down, used for derived value
+     * 衍生指标评估参数，指定上涨或者下跌
+     * */
+    assessment?: ValueAssessment;
+    /**
+     * original data, 原始数据
+     * */
+    origin?: number;
+    /**
+     * detail data, 明细数据，用于弹框展示
+     */
+    detail?: unknown;
+    /** source id of the variable, to access the variable info from variableSourceMap */
+    /**
+     * generate variable info, 通过模版拼接工具函数生成过程中得到的变量信息
+     */
+    generateVariableInfo?: {
+        scopeVariable: Variable;
+        path: string;
+    };
+};

package/lib/ntv/schema/phrase.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ENTITY_TYPES = void 0;
+exports.ENTITY_TYPES = [
+    /**
+     * @description main indicator value 主指标名
+     * @example DAU
+     * */
+    'metric_name',
+    /**
+     * @description main indicator name 主指标值
+     * @example 1.23 million
+     * */
+    'metric_value',
+    /**
+     * @description other indicator value 其他指标值
+     * @example
+     * */
+    'other_metric_value',
+    /**
+     * @description contribution ratio 贡献度
+     * @example 23%
+     * */
+    'contribute_ratio',
+    /**
+     * @description delate value 变化值
+     * @example -1.2
+     * */
+    'delta_value',
+    /**
+     * @description ratio value 变化率
+     * @example +23%
+     * */
+    'ratio_value',
+    /**
+     * @description trend description 趋势描述
+     * @example up/down
+     * */
+    'trend_desc',
+    /**
+     * @description dimension value 维值
+     * @example sex = man
+     * */
+    'dim_value',
+    /**
+     * @description time description 时间描述
+     * @example 2021-11-19
+     * */
+    'time_desc',
+    /**
+     * @description proportion 占比
+     * @example 20%
+     * */
+    'proportion',
+];

package/lib/ntv/schema/structure.d.ts

@@ -0,0 +1,18 @@
+import type { CommonProps, CustomBlockElement } from './common';
+import type { PhraseSpec } from './phrase';
+import type { ParagraphSpec } from './paragraph';
+export type NarrativeTextSpec = CommonProps & {
+    headline?: HeadlineSpec;
+    sections?: SectionSpec[];
+};
+export type HeadlineSpec = CommonProps & {
+    type: 'headline';
+    phrases: PhraseSpec[];
+};
+export type StandardSectionSpec = {
+    paragraphs?: ParagraphSpec[];
+};
+export type SectionSpec = (StandardSectionSpec | CustomBlockElement) & CommonProps;
+export type NestedParagraphSpec = CommonProps & {
+    children: (ParagraphSpec | NestedParagraphSpec)[];
+};

package/lib/ntv/schema/structure.js

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

package/lib/ntv/types.d.ts

@@ -0,0 +1,2 @@
+export type { NarrativeTextSpec, HeadlineSpec, SectionSpec, StandardSectionSpec, ParagraphSpec, HeadingParagraphSpec, TextParagraphSpec, BulletsParagraphSpec, BulletItemSpec, CustomBlockElement, NestedParagraphSpec, PhraseSpec, TextPhraseSpec, EntityPhraseSpec, EscapePhraseSpec, FormulaPhraseSpec, CustomPhraseSpec, ValueAssessment, EntityType, EntityMetaData, CustomMetaData, } from './schema';
+export type { Structure, StructureTemp, Variable } from './generate';

package/lib/ntv/types.js

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

package/lib/ntv/utils/index.d.ts

@@ -0,0 +1 @@
+export * from './isSpecType';

package/lib/ntv/utils/index.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./isSpecType"), exports);

package/lib/ntv/utils/isSpecType.d.ts

@@ -0,0 +1,17 @@
+import { EntityType } from '../schema';
+import type { SectionSpec, ParagraphSpec, CustomBlockElement, StandardSectionSpec, TextParagraphSpec, BulletsParagraphSpec, HeadingParagraphSpec, PhraseSpec, CustomPhraseSpec, EntityPhraseSpec, TextPhraseSpec, EscapePhraseSpec, FormulaPhraseSpec, DividerParagraphSpec, ImagePhraseSpec } from '../schema';
+export declare function isCustomSection(spec: SectionSpec): spec is CustomBlockElement;
+export declare function isCustomParagraph(spec: ParagraphSpec): spec is CustomBlockElement;
+export declare function isStandardSection(spec: SectionSpec): spec is StandardSectionSpec;
+export declare function isTextParagraph(spec: ParagraphSpec): spec is TextParagraphSpec;
+export declare function isBulletParagraph(spec: ParagraphSpec): spec is BulletsParagraphSpec;
+export declare function isDividerParagraph(spec: ParagraphSpec): spec is DividerParagraphSpec;
+export declare function getHeadingWeight(pType: string): number;
+export declare function isHeadingParagraph(spec: ParagraphSpec): spec is HeadingParagraphSpec;
+export declare function isCustomPhrase(spec: PhraseSpec): spec is CustomPhraseSpec;
+export declare function isEntityType(type: any): type is EntityType;
+export declare function isEntityPhrase(spec: PhraseSpec): spec is EntityPhraseSpec;
+export declare function isTextPhrase(spec: PhraseSpec): spec is TextPhraseSpec;
+export declare function isEscapePhrase(spec: PhraseSpec): spec is EscapePhraseSpec;
+export declare function isFormulaPhrase(spec: PhraseSpec): spec is FormulaPhraseSpec;
+export declare function isImagePhrase(spec: PhraseSpec): spec is ImagePhraseSpec;