@lingxiteam/ebe-utils 0.0.1

package/README.md

@@ -0,0 +1,217 @@
+# 出码模块工具
+
+## cli
+
+### setup
+
+```bash
+eve setup
+```
+
+出码模块的后置处理，如拷贝静态文件等
+
+### move
+
+通过指定的入口文件，将该文件所有关联文件一起拷贝到指定产物目录下。用于将项目中的组件抽离出来成为一个独立的组件。减少人工抽离时，过多转移文件的问题。
+
+```bash
+eve move ./a/index.ts --o ./dist
+```
+
+以上表示，将 `./a/index.ts` 文件所有关联文件一起拷贝到 `./dist` 目录下。
+
+## 工具类
+
+### codeCreate
+
+一键出码
+
+```tsx
+import {
+  findBusiCompById,
+  findPageInstByVersionId,
+  getThemeCss,
+  qryAttrSpecPage,
+  qryPageCompAssetList,
+  qryPageInstListByAppId,
+  queryFrontendDatasourcePage,
+  queryFrontendHookList,
+  findApplication,
+} from '@/services/api';
+import { useEffect } from 'react';
+import { codeCreate, init } from '@lingxiteam/ebe-utils';
+
+const Page = () => {
+  useEffect(() => {
+    init();
+  }, []);
+
+  const onFinish = async (values: any) => {
+    await codeCreate({
+      appId: values.appId,
+      platform: values.platform ? 'APP' : 'PC',
+      baseUrl:
+        process.env.BASE_URL === 'http://10.10.179.140:8047/HJF/'
+          ? 'http://10.10.179.140:8048/HJF/'
+          : process.env.BASE_URL!,
+      services: {
+        findBusiCompById,
+        findPageInstByVersionId,
+        getThemeCss,
+        qryAttrSpecPage,
+        qryPageCompAssetList,
+        qryPageInstListByAppId,
+        queryFrontendDatasourcePage,
+        queryFrontendHookList,
+        findApplication,
+      },
+    });
+  };
+  return <></>;
+};
+
+export default Page;
+```
+
+#### clearLXPagesDSL
+
+使用内定规则清理 dsl，注意传入数据是一个页面 dsl 数组，如果仅有一个页面，可以传入 [page]
+
+```ts
+const clearPages = clearLXPagesDSL(pages);
+```
+
+for 开发
+
+在 constants.ts 中修改规则
+
+一个 key 对应一个规则，一般规则中需要存在 rule 函数，如果对象是数组，则必须存在 loopRule 和 loop
+
+```ts
+export interface IRule {
+  // 是否删除的判断规则，会根据
+  rule?: (props: IRulePrams) => any;
+  // 如果存在 loopRule 表示循环对象是一个数组，就根据 loop 中定义的规则清理 item，loop 中的 key 为 loopRule 返回值的判断依据
+  loopRule?: (item: any) => string;
+  loop?: IRulesType;
+}
+```
+
+rule 函数
+
+```ts
+export interface IRulePrams {
+  // 根据当前循环的数据 key，比如 data.a.c ,paths 为 ['data','a','c']
+  paths: string[];
+  // 此时循环中的值
+  value: any;
+  // 此时循环中的key
+  key: string;
+  // 提供的工具类，此时的值和data比较，如果是字符串相等则返回 true，如果对象和 data key-value 都相同的值会被删除，并返回清楚后的新对象
+  diffraction?: (data: any) => any;
+}
+({ paths, value, key, diffraction }) => any;
+```
+
+##### rule
+
+rule 函数可以返回 true 或者对象，如果返回 true 表示删除当前的对象，如果返回对象，则表示用新对象替换旧对象
+
+属性 diffraction 为提供的工具方法
+
+```ts
+const in = {
+    size: 'm',
+    title: 'hellp',
+    number: 123
+}
+
+const diff = {
+    size:'m',
+}
+const out = diffraction(diff);
+
+此时 out 为
+
+const in = {
+    title: 'hellp',
+    number: 123
+}
+
+以上逻辑表示当 in 中的值和 diff 中的值相等时，删除
+```
+
+一般用法为
+
+```ts
+const ruleObj = {
+  rule: ({ diffraction }) => {
+    // 当对象中的某个字为xxx的时候 delete value.xxx
+    const diff = {};
+    return diffraction(diff);
+  },
+};
+```
+
+##### loop & loopRule
+
+loopRule 传入数组 item 返回一个 key,比如常用到的 components 中要找到某个 组件类型。
+
+```ts
+export const lingxiDslRules: IRulesType = {
+  components: {
+    loopRule: (item) => item.compName,
+    loop: componentsRule,
+  },
+};
+```
+
+返回 compName 作为 loop 的 key
+
+```ts
+const components = [
+  { compName: 'A', title: 'A' },
+  { compName: 'C', title: 'C' },
+];
+
+const loop = {
+  A: {
+    rule: () => any,
+  },
+  C: {
+    rule: () => any,
+  },
+};
+```
+
+以上逻辑表示循环 components 当 item 的 compName 等于 A 时，执行 loop.A 的规则
+
+##### 高级技巧
+
+由于 rule 返回对象时，会覆盖旧的值，因此可以在 rule 中调用 removeObjectByRules 等方法来进一步实现内层的数据清理。
+
+比如 View 组件的 components 也需要清理，就可以如下使用
+
+```ts
+import { removeObjectByRules } from './index';
+import { IRulesType } from './types';
+const isTrue = {
+  rule: () => true,
+};
+const componentsRule: IRulesType = {
+  View: {
+    rule: ({ value, diffraction }) => {
+      if (value?.components) {
+        return removeObjectByRules(value, lingxiDslRules);
+      }
+    },
+  },
+};
+
+export const lingxiDslRules: IRulesType = {
+  components: {
+    loopRule: (item) => item.compName,
+    loop: componentsRule,
+  },
+};
+```

package/bin/ebe.js

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+process.title = 'ebe';
+// Use magic to suppress node deprecation warnings
+// See: https://github.com/nodejs/node/blob/master/lib/internal/process/warning.js#L77
+// @ts-ignore
+process.noDeprecation = '1';
+require('../lib/node/cli');

package/es/constants.d.ts

@@ -0,0 +1,2 @@
+import { IRulesType } from './types';
+export declare const lingxiDslRules: IRulesType;

package/es/constants.js

@@ -0,0 +1,183 @@
+import { removeObjectByRules } from "./index";
+var isTrue = {
+  rule: function rule() {
+    return true;
+  }
+};
+var componentsRule = {
+  View: {
+    rule: function rule(_ref) {
+      var value = _ref.value,
+        diffraction = _ref.diffraction;
+      if (value !== null && value !== void 0 && value.components) {
+        return removeObjectByRules(value, lingxiDslRules);
+      }
+    }
+  },
+  TabPane: {
+    rule: function rule(_ref2) {
+      var value = _ref2.value,
+        diffraction = _ref2.diffraction;
+      if (value !== null && value !== void 0 && value.components) {
+        return removeObjectByRules(value, lingxiDslRules);
+      }
+    }
+  },
+  Tabs: {
+    rule: function rule(_ref3) {
+      var value = _ref3.value,
+        diffraction = _ref3.diffraction;
+      if (value !== null && value !== void 0 && value.components) {
+        return removeObjectByRules(value, lingxiDslRules);
+      }
+    }
+  },
+  Card: {
+    rule: function rule(_ref4) {
+      var value = _ref4.value,
+        diffraction = _ref4.diffraction;
+      if (value !== null && value !== void 0 && value.components) {
+        return removeObjectByRules(value, lingxiDslRules);
+      }
+    }
+  },
+  Condition: {
+    rule: function rule(_ref5) {
+      var value = _ref5.value,
+        diffraction = _ref5.diffraction;
+      if (value !== null && value !== void 0 && value.components) {
+        return removeObjectByRules(value, lingxiDslRules);
+      }
+    }
+  },
+  Collapse: {
+    rule: function rule(_ref6) {
+      var value = _ref6.value,
+        diffraction = _ref6.diffraction;
+      if (value !== null && value !== void 0 && value.components) {
+        return removeObjectByRules(value, lingxiDslRules);
+      }
+    }
+  },
+  Layout: {
+    rule: function rule(_ref7) {
+      var value = _ref7.value,
+        diffraction = _ref7.diffraction;
+      if (value !== null && value !== void 0 && value.components) {
+        return removeObjectByRules(value, lingxiDslRules);
+      }
+    }
+  },
+  Icon: {
+    rule: function rule(_ref8) {
+      var diffraction = _ref8.diffraction;
+      return diffraction === null || diffraction === void 0 ? void 0 : diffraction({
+        props: {
+          name: '图标'
+        }
+      });
+    }
+  },
+  Button: {
+    rule: function rule(_ref9) {
+      var diffraction = _ref9.diffraction;
+      return diffraction === null || diffraction === void 0 ? void 0 : diffraction({
+        props: {
+          classification: 'default',
+          flowProcessResult: 'common',
+          size: 'default',
+          type: 'default',
+          shape: 'default',
+          btnIcon: 'none',
+          loading: function loading(data) {
+            return data.loading === false;
+          },
+          ghost: false,
+          block: false,
+          iconPosition: function iconPosition(data) {
+            return data.hasIcon !== true;
+          }
+        }
+      });
+    }
+  },
+  Text: {
+    rule: function rule(_ref10) {
+      var diffraction = _ref10.diffraction;
+      return diffraction === null || diffraction === void 0 ? void 0 : diffraction({
+        props: {
+          showHtml: false
+        }
+      });
+    }
+  },
+  Table: {
+    // rule: ({ value }) => {
+    //   return {
+    //     ...value,
+    //     props: removeObjectByRules(value.props, {
+    //       columns: {
+    //         loopRule: (item) => 'item',
+    //         loop: {
+    //           item: {
+    //             customRendering: {
+    //               rule: ({ value }: any) => {
+    //                 return value === 'undefined';
+    //               },
+    //             },
+    //             editContent:{
+    //               rule: ({ value }: any) => {
+    //                 return value.edittype === 'remove';
+    //               },
+    //             },
+    //           } as IRulesType,
+    //         },
+    //       },
+    //     }),
+    //   };
+    // },
+    rule: function rule(_ref11) {
+      var diffraction = _ref11.diffraction;
+      var value = diffraction === null || diffraction === void 0 ? void 0 : diffraction({
+        props: {
+          tableTitle: function tableTitle(value) {
+            return value.showHead !== false;
+          },
+          showHead: false,
+          showSizeChanger: false,
+          showQuickJumper: false,
+          dataSourceLoading: false,
+          showTotal: false,
+          page: false,
+          isFlexColumn: false,
+          checkLoosed: false,
+          fixedAction: false,
+          headExtends: function headExtends(value) {
+            return Array.isArray(value.headExtends) && value.headExtends.length === 0;
+          },
+          extend: function extend(value) {
+            return Array.isArray(value.extend) && value.extend.length === 0;
+          },
+          headBtnNum: 3
+        }
+      });
+      return value;
+    }
+  }
+};
+export var lingxiDslRules = {
+  editorVersion: isTrue,
+  createdEditorVersion: isTrue,
+  terminalType: isTrue,
+  platformType: isTrue,
+  imgInfoList: isTrue,
+  defaultVersionId: isTrue,
+  currentPageVersionId: isTrue,
+  previewValidVersionId: isTrue,
+  components: {
+    loopRule: function loopRule(item) {
+      return item.compName;
+    },
+    loop: componentsRule
+  }
+};

package/es/index.d.ts

@@ -0,0 +1,64 @@
+import { IRulePrams, IRulesType } from './types';
+export * from './types';
+export declare const clearAppInfo: (appInfo: Record<string, any>, includes?: string[]) => Record<string, any>;
+export declare const clearProps: (data: any, diff: any) => any;
+export declare const getNewDataByRules: (value: any, rule: (props: IRulePrams) => any, path: string[]) => any;
+export declare const removeObjectByRules: (data: any, rules: IRulesType, paths?: string[]) => any;
+export declare const treeForEach: (tree: any, callback: (item: any, root: boolean) => void, options?: {
+    children: string;
+}) => void;
+export declare const getPageDsls: (resultObjects: any[]) => any[];
+export declare function findAllItem<T = any>(target: T[], callback: (item: T, index: number, list: T[]) => boolean, itemHash: any): void;
+export declare function findItem<T = any>(target: T[], callback: (item: T, index: number, list: T[]) => boolean): T | null;
+export declare const cleanTree: (tree: any, fields: any) => any;
+export declare const clearLXPagesDSL: (pages: any[]) => any[];
+interface CodeServices {
+    qryAttrSpecPage: (data: any) => Promise<any>;
+    qryPageInstListByAppId: (data: any) => Promise<any>;
+    queryFrontendHookList: (data: any) => Promise<any>;
+    getThemeCss: (data: any) => Promise<any>;
+    qryPageCompAssetList: (data: any) => Promise<any>;
+    queryFrontendDatasourcePage: (data: any) => Promise<any>;
+    findPageInstByVersionId: (data: any) => Promise<any>;
+    findBusiCompById: (data: any) => Promise<any>;
+    findApplication: (params: {
+        appId: string;
+    }) => Promise<any>;
+}
+interface CodeOptions {
+    appId: string;
+    baseUrl: string;
+    platform: string;
+    services: CodeServices;
+    onProgress: (data: {
+        log: string;
+        progress: number;
+    }) => void;
+}
+export declare const setWorkerJsUrl: (url: string) => void;
+export declare const init: () => Promise<void>;
+export declare const fetchData: ({ appId, services, platform, baseUrl, onProgress, }: CodeOptions) => Promise<{
+    options: {
+        platform: string;
+        appId: string;
+        pageIdMapping: any;
+        busiCompMapping: any;
+        compAssetList: any;
+        baseUrl: string;
+        appConfig: {
+            frontendHookList: any;
+        };
+        attrSpecPage: any;
+        themeCss: string;
+        models: Record<string, any>;
+        appInfo: Record<string, any>;
+    };
+    cleanedTree: any;
+}>;
+export declare const codeCreate: ({ appId, services, platform, baseUrl, onProgress, }: CodeOptions) => Promise<{
+    success: boolean;
+    msg?: undefined;
+} | {
+    msg: unknown;
+    success: boolean;
+}>;