@wibetter/json-utils 6.0.1 → 6.0.2

package/dist/types/data/initSchemaEntity/JSONSchema.d.ts

@@ -0,0 +1,60 @@
+/** 新版JSONSchema一级字段项
+ * 【字段属性说明】
+ *  title：字段项的label值
+ *  properties：存放所有的子字段数据内容
+ *  type：用于标识字段项的展示类型（input、date、data-time、url、textarea 等）
+ *  readOnly：字段项可设置是否可编辑
+ *  required：存放所有子字段的key值，用于验证子字段项是否存在，同时required可充当排序功能
+ *  propertyOrder：按序存放所有子字段的key值（排序功能）
+ * */
+export declare const initJSONSchemaData: {
+    type: string;
+    title: string;
+    properties: {
+        func: {
+            type: string;
+            title: string;
+            properties: {
+                a: {
+                    title: string;
+                    type: string;
+                    default: string;
+                    description: string;
+                    placeholder: string;
+                    isRequired: boolean;
+                };
+            };
+            propertyOrder: string[];
+        };
+        style: {
+            type: string;
+            title: string;
+            properties: {
+                b: {
+                    title: string;
+                    type: string;
+                    default: string;
+                    description: string;
+                    placeholder: string;
+                };
+            };
+            propertyOrder: string[];
+        };
+        data: {
+            type: string;
+            title: string;
+            properties: {
+                c: {
+                    title: string;
+                    type: string;
+                    default: string;
+                    description: string;
+                    placeholder: string;
+                    isRequired: boolean;
+                };
+            };
+            propertyOrder: string[];
+        };
+    };
+    propertyOrder: string[];
+};

package/dist/types/data/initSchemaEntity/Json.d.ts

@@ -0,0 +1,6 @@
+export declare const initJsonData: {
+    title: string;
+    type: string;
+    default: string;
+    description: string;
+};

package/dist/types/data/initSchemaEntity/Number.d.ts

@@ -0,0 +1,8 @@
+export declare const initNumberData: {
+    type: string;
+    title: string;
+    default: number;
+    minimum: number;
+    maximum: number;
+    description: string;
+};

package/dist/types/data/initSchemaEntity/Object.d.ts

@@ -0,0 +1,24 @@
+/** Object字段项
+ * 【字段属性说明】
+ *  title：字段项的label值
+ *  properties：存放所有的子字段数据内容
+ *  type：用于标识字段项的展示类型（input、date、data-time、url、textarea 等）
+ *  readOnly：字段项可设置是否可编辑
+ *  required：存放所有子字段的key值，用于验证子字段项是否存在，同时required可充当排序功能
+ *  propertyOrder：按序存放所有子字段的key值（排序功能）
+ * */
+export declare const initObjectData: {
+    type: string;
+    title: string;
+    description: string;
+    properties: {
+        a: {
+            type: string;
+            title: string;
+            default: string;
+            description: string;
+            placeholder: string;
+        };
+    };
+    propertyOrder: string[];
+};

package/dist/types/data/initSchemaEntity/PaddingMargin.d.ts

@@ -0,0 +1,38 @@
+/** padding-margin 字段项
+ * 【字段属性说明】
+ *  title：字段项的label值
+ *  properties：存放所有的子字段数据内容
+ *  type：用于标识字段项的展示类型（input、date、data-time、url、textarea 等）
+ *  readOnly：字段项可设置是否可编辑
+ *  required：存放所有子字段的key值，用于验证子字段项是否存在，同时required可充当排序功能
+ *  propertyOrder：按序存放所有子字段的key值（排序功能）
+ * */
+export declare const initPaddingMarginData: {
+    type: string;
+    title: string;
+    isContainer: boolean;
+    properties: {
+        margin: {
+            title: string;
+            type: string;
+            default: string;
+            description: string;
+        };
+        padding: {
+            title: string;
+            type: string;
+            default: string;
+            description: string;
+        };
+        quantity: {
+            type: string;
+            default: string;
+            options: {
+                label: string;
+                value: string;
+            }[];
+            title: string;
+        };
+    };
+    propertyOrder: string[];
+};

package/dist/types/data/initSchemaEntity/Quantity.d.ts

@@ -0,0 +1,34 @@
+/** quantity字段项
+ * 【字段属性说明】
+ *  title：字段项的label值
+ *  properties：存放所有的子字段数据内容
+ *  type：用于标识字段项的展示类型（input、date、data-time、url、textarea 等）
+ *  readOnly：字段项可设置是否可编辑
+ *  required：存放所有子字段的key值，用于验证子字段项是否存在，同时required可充当排序功能
+ *  propertyOrder：按序存放所有子字段的key值（排序功能）
+ * */
+export declare const initQuantityData: {
+    type: string;
+    title: string;
+    isContainer: boolean;
+    properties: {
+        unit: {
+            type: string;
+            title: string;
+            default: number;
+            minimum: number;
+            maximum: number;
+            description: string;
+        };
+        quantity: {
+            type: string;
+            default: string;
+            options: {
+                label: string;
+                value: string;
+            }[];
+            title: string;
+        };
+    };
+    propertyOrder: string[];
+};

package/dist/types/data/initSchemaEntity/Radio.d.ts

@@ -0,0 +1,9 @@
+export declare const initRadioData: {
+    type: string;
+    title: string;
+    options: {
+        label: string;
+        value: string;
+    }[];
+    description: string;
+};

package/dist/types/data/initSchemaEntity/Select.d.ts

@@ -0,0 +1,9 @@
+export declare const initSelectData: {
+    type: string;
+    title: string;
+    options: {
+        label: string;
+        value: string;
+    }[];
+    description: string;
+};

package/dist/types/data/initSchemaEntity/TextEditor.d.ts

@@ -0,0 +1,7 @@
+export declare const initTextEditorData: {
+    type: string;
+    title: string;
+    default: string;
+    description: string;
+    placeholder: string;
+};

package/dist/types/data/initSchemaEntity/Textarea.d.ts

@@ -0,0 +1,7 @@
+export declare const initTextareaData: {
+    type: string;
+    title: string;
+    default: string;
+    description: string;
+    placeholder: string;
+};

package/dist/types/data/initSchemaEntity/Time.d.ts

@@ -0,0 +1,7 @@
+export declare const initTimeData: {
+    type: string;
+    title: string;
+    default: string;
+    description: string;
+    placeholder: string;
+};

package/dist/types/data/initSchemaEntity/URL.d.ts

@@ -0,0 +1,7 @@
+export declare const initURLData: {
+    type: string;
+    title: string;
+    default: string;
+    description: string;
+    placeholder: string;
+};

package/dist/types/function/getExpectType.d.ts

@@ -0,0 +1,2 @@
+export declare function getExpectType(type: string): string;
+export declare function registerExpectType(type: string, valType: string): void;

package/dist/types/function/getJsonDataByKeyRoute.d.ts

@@ -0,0 +1,8 @@
+/**
+ * getJSONDataByKeyRoute: 根据key值路径获取对应的json数据
+ * 【方法参数说明】
+ * keyRoute: key值索引路径
+ * targetJsonDataObj: json数据对象
+ * useObjClone: 是否进行深拷贝，避免影响原有数据。（默认不进行深拷贝）
+ */
+export declare function getJsonDataByKeyRoute(keyRoute: string, targetJsonDataObj: any, useObjClone?: boolean): any;

package/dist/types/function/getSchemaByIndexRoute.d.ts

@@ -0,0 +1,8 @@
+/**
+ * getSchemaByIndexRoute: 根据index索引路径获取对应的schema数据
+ * 【方法参数说明】
+ * indexRoute: index索引路径
+ * targetJsonSchemaObj: schema数据对象
+ * useObjClone: 是否进行深拷贝，避免影响原有数据。（默认不进行深拷贝）
+ */
+export declare function getSchemaByIndexRoute(indexRoute: string | number, targetJsonSchemaObj: any, useObjClone?: boolean): any;

package/dist/types/function/getSchemaByKeyRoute.d.ts

@@ -0,0 +1,8 @@
+/**
+ * getSchemaByKeyRoute: 根据key值路径获取对应的schema数据
+ * 【方法参数说明】
+ * keyRoute: key值路径
+ * targetJsonSchemaObj: schema数据对象
+ * useObjClone: 是否进行深拷贝，避免影响原有数据。（默认不进行深拷贝）
+ */
+export declare function getSchemaByKeyRoute(keyRoute: string, targetJsonSchemaObj: any, useObjClone?: boolean): any;

package/dist/types/function/indexRoute2keyRoute.d.ts

@@ -0,0 +1,7 @@
+/**
+ * indexRoute2keyRoute：根据index索引路径获取对应的key值路径
+ * 【方法参数说明】
+ * indexRoute: index索引路径
+ * targetJsonSchemaObj: schema数据对象
+ * */
+export declare function indexRoute2keyRoute(indexRoute: string | number, targetJsonSchemaObj: any): string;

package/dist/types/function/json2schema.d.ts

@@ -0,0 +1,4 @@
+/**
+ * 根据jsonData生成一份对应的jsonSchema
+ * */
+export declare function json2schema(jsonData: any): {};

package/dist/types/function/json2treeData.d.ts

@@ -0,0 +1,8 @@
+/**
+ *  DataRoute转真实数据路径
+ * */
+export declare function dataRoute2dataPath(dataRoute: string, baseDataPath: string): string;
+/**
+ *  mockData转treeData（供antd的TreeSelect使用）
+ * */
+export declare function json2treeData(mockData: any, parentDataRoute: string): any[];

package/dist/types/function/keyRoute2indexRoute.d.ts

@@ -0,0 +1,7 @@
+/**
+ * keyRoute2indexRoute：根据key值路径获取对应的index索引路径
+ * 【方法参数说明】
+ * keyRoute: key值路径
+ * targetJsonSchemaObj: schema数据对象
+ * */
+export declare function keyRoute2indexRoute(keyRoute: string, targetJsonSchemaObj: any): string;

package/dist/types/function/metaElemAnalyzer.d.ts

@@ -0,0 +1,2 @@
+/** 主方法 */
+export declare function metaElemAnalyzer(curJsonSchemaObj: any, analyzerResult: any): any;

package/dist/types/function/oldSchemaToNewSchema.d.ts

@@ -0,0 +1,2 @@
+export declare function oldSchemaToNewSchemaV1(oldSchema: any): any;
+export declare function oldSchemaToNewSchema(oldSchema: any): any;

package/dist/types/function/schema2conditionValue.d.ts

@@ -0,0 +1,4 @@
+/**
+ * 收集当前schema中的所有条件子字段，根据其数值拼接成对应的 conditionValue
+ */
+export declare function schema2conditionValue(jsonSchema: any, jsonData: any): string;

package/dist/types/function/schema2json.d.ts

@@ -0,0 +1,5 @@
+/**
+ * 根据jsonSchema和旧版的jsonData生成一份对应的jsonData
+ * 备注：使用旧版数据，以便进行新旧数据融合
+ * */
+export declare function schema2json(jsonSchema: any, jsonData: any): {};

package/dist/types/function/schemaMetaList.d.ts

@@ -0,0 +1 @@
+export declare const schemaMetaList: any;

package/dist/types/main.d.ts

@@ -0,0 +1,74 @@
+/**
+ * json-utils: json工具集合
+ * 【提供的工具方法清单】
+ *
+ * 【12个主要的json工具方法】
+ * getJsonDataByKeyRoute: 根据key索引路径获取对应的数值
+ * getSchemaByIndexRoute: 根据index索引路径获取对应的schema数据
+ * getSchemaByKeyRoute: 根据key值路径获取对应的schema数据
+ * indexRoute2keyRoute: 根据index索引路径获取对应的key值路径
+ * keyRoute2indexRoute：根据key值路径获取对应的index索引路径
+ * json2schema: 根据json数据内容获取对应的schema数据
+ * oldSchemaToNewSchema: 旧版jsonSchema转新版jsonSchema
+ * schema2json: 根据schema数据内容生成一份对应的json数据
+ * schemaMetaList: 当前JSON数据可视化提供的元数据清单
+ * metaElemAnalyzer: 根据当前的json和对应的schema，统计当前json里面用到的元数据情况
+ *
+ * 【其他较小的json工具方法】
+ *
+ * 【json数据内容相关的操作方法】
+ * getParentKeyRoute: 获取父元素的key路径值
+ * getParentKeyRoute_CurKey: 获取父元素的key路径值和当前key
+ *
+ * 【schema相关的操作方法】
+ * isEmptySchema: 判断是否为空的Schema
+ * isNewSchemaData: 判断是否是最新版的schema数据
+ * isContainerSchema: 判断是否是容器类型元素，用于确认是否能添加子元素
+ * isStructuredSchema: 判断是否是结构化schema数据（一级schema为object类型，其所有二级schema为object类型）
+ * isSameParent: 判断是否是同一个父元素
+ * getCurPosition: 判断当前元素在目标元素的位置 前 or 后（根据当前元素的位置和目标元素的位置）
+ * getParentIndexRoute: 获取父元素的路径值
+ * getNextIndexRoute: 获取下一个兄弟元素的路径值
+ * getParentIndexRoute_CurIndex: 获取父元素的路径值和当前index
+ * moveForward: 将当前路径值向前移动一位
+ * moveBackward: 将当前路径值向后移动一位
+ *
+ * 【纯工具方法】
+ * objClone: js对象数据深拷贝，避免数据联动
+ * isEqual: 对比两个json数据是否相等
+ * hasProperties: 判断当前属性是否存在(识别数值为false、0、null)
+ *
+ * 【基础元数据类型判断】
+ * isURL
+ * isString
+ * isNumber
+ * isBoolean
+ * isDateStr
+ * isDateTimeStr
+ * isTimeStr
+ * isArray
+ * isSelect
+ * isObject
+ * isQuantity
+ * isColor
+ * isFunction
+ */
+export * from './function/getJsonDataByKeyRoute';
+export * from './function/getSchemaByIndexRoute';
+export * from './function/getSchemaByKeyRoute';
+export * from './function/indexRoute2keyRoute';
+export * from './function/keyRoute2indexRoute';
+export * from './function/json2schema';
+export * from './function/metaElemAnalyzer';
+export * from './function/oldSchemaToNewSchema';
+export * from './function/schema2json';
+export * from './function/schemaMetaList';
+export * from './function/json2treeData';
+export * from './function/getExpectType';
+export * from './function/schema2conditionValue';
+export * from './utils/index';
+export * from './utils/jsonData';
+export * from './utils/jsonSchema';
+export * from './utils/typeof';
+export * from './data/KeyWordList';
+export * from './data/TypeDataList';

package/dist/types/utils/index.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 获取 URL 上的所有参数
+ * 例如：比如当前页面的地址为 xx?a1=123 则 urlParse() => {a1: 123}
+ */
+export declare function urlParse(): {};
+/**
+ * 转换成 URL 上的参数字符串
+ * @param {*} urlParams
+ * 例如：{a1: 123} => a1=123
+ */
+export declare function urlStringify(urlParams: any): string;
+/** js对象数据深拷贝，避免数据联动 */
+export declare function objClone(targetObj: any): any;
+/** 对比两个json数据是否相等 */
+export declare function isEqual(targetObj: any, nextTargetObj: any): boolean;
+export declare function isEqualByIdT(targetObj: any, nextTargetObj: any): boolean;
+/** 判断当前属性是否存在
+ * 备注：要识别boolean类型的数值 */
+export declare function hasProperties(targetProperties: any): boolean;
+export declare function truncate(str: string, paramConfig: any): string;
+/**
+ * 支持属性表达式
+ */
+export declare function evalExpression(expressionStr: string, data: any): string | false;

package/dist/types/utils/jsonData.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 获取父元素的key路径值
+ */
+export declare function getParentKeyRoute(curKeyRoute: string): string;
+/**
+ * 获取父元素的key路径值和当前key
+ */
+export declare function getParentKeyRoute_CurKey(curKeyRoute: string): [string, string];

package/dist/types/utils/jsonSchema.d.ts

@@ -0,0 +1,55 @@
+/**
+ * JSONSchema(json格式)对象的通用操作方法【非响应式数据操作方法集合】
+ */
+/** 判断是否为空的Schema
+ * 包括 通用schema和组件配置专用的schema
+ * */
+export declare function isEmptySchema(targetJsonSchema: any): boolean;
+/**
+ *  判断是否是最新版的schema数据
+ *  备注：确保当前schema数据是通过@wibetter/json-schema-editor生成的
+ * */
+export declare function isNewSchemaData(schemaData: any): boolean;
+/** 判断是否是容器类型元素
+ *  容器类型字段：object数值类型
+ *  主要用于判断当前元素点击新增时是添加子元素还是添加兄弟节点，容器类型点击新增时则添加子节点。
+ *  备注：array类型字段只有固定的一个items属性，不能新增其他子元素。
+ * */
+export declare function isContainerSchema(curSchema: any): boolean;
+/** 判断是否是结构化的schema数据，
+ *  判定条件：一级schema为object类型，其所有二级schema也为object类型
+ * */
+export declare function isStructuredSchema(jsonSchema: any): boolean;
+/**
+ * 判断是否是同一个父元素
+ * 备注：用于判断两个元素是否在同一个父级容器中
+ */
+export declare function isSameParent(curIndex: string, targetIndex: string): boolean;
+/**
+ * 判断当前元素在目标元素的位置 前 or 后（根据当前元素的位置和目标元素的位置）
+ */
+export declare function getCurPosition(curIndex: string, targetIndex: string): string;
+/**
+ * 获取父元素的路径值
+ */
+export declare function getParentIndexRoute(curIndexRoute: string | number): string;
+/**
+ * 获取下一个兄弟元素的路径值
+ */
+export declare function getNextIndexRoute(curIndexRoute: string | number): string;
+/**
+ * 获取父元素的路径值和当前index
+ */
+export declare function getParentIndexRoute_CurIndex(curIndexRoute: string | number): string[];
+/**
+ * 将当前路径值向前移动一位
+ */
+export declare function moveForward(curIndexRoute: string | number): any;
+/**
+ * 将当前路径值向后移动一位
+ */
+export declare function moveBackward(curIndexRoute: string | number): any;
+/**
+ * 获取第一个选项值
+ */
+export declare function getDefaultOptionVal(jsonSchema: any, multiple?: boolean): any;

package/dist/types/utils/typeof.d.ts

@@ -0,0 +1,32 @@
+export declare function isURL(s: any): boolean;
+export declare function isString(o: any): boolean;
+export declare function isNumber(value: any): boolean;
+export declare function isBoolean(o: any): boolean;
+export declare function isDateStr(dateStr: string): boolean;
+export declare function isDateTimeStr(dateStr: string): boolean;
+export declare function isTimeStr(dateStr: string): boolean;
+/**
+ *  判断是否是数组类型
+ * */
+export declare function isArray(curObj: any): boolean;
+/**
+ *  判断是否是select多选类型(基础类型的array)
+ *  select类型一定是一个array类型
+ * */
+export declare function isSelect(curObj: any): boolean;
+/**
+ *  判断是否是对象类型
+ * */
+export declare function isObject(curObj: any): boolean;
+/**
+ *  判断是否是单位类型
+ * */
+export declare function isQuantity(val: string): boolean;
+/**
+ *  判断是否是颜色值
+ * */
+export declare function isColor(colorVal: string): boolean;
+/**
+ *  判断是否是函数类型
+ * */
+export declare function isFunction(curObj: any): boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wibetter/json-utils",
-  "version": "6.0.1",
+  "version": "6.0.2",
   "description": "提供JSON相关的各类工具方法，比如schema转json、json转schema、json元数据分析等",
   "keywords": [
     "json工具包",
@@ -14,6 +14,7 @@
   "license": "MIT",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",
+  "types": "dist/main.d.ts",
   "scripts": {
     "build2lib": "akfun build2lib && npm run build2esm",
     "build2esm": "akfun build2esm -n=index"
@@ -29,11 +30,13 @@
     "url": "https://github.com/wibetter/json-utils/issues"
   },
   "dependencies": {
-    "lodash": "^4.17.21",
-    "qs": "^6.13.1"
+    "lodash": "^4.17.23",
+    "qs": "^6.14.1"
   },
   "devDependencies": {
-    "akfun": "^5.0.1"
+    "@types/lodash": "^4.17.20",
+    "@types/qs": "^6.9.12",
+    "akfun": "^5.1.19"
   },
   "engines": {
     "node": ">= 10.13.0",