neo-cmp-cli 1.12.9 → 1.12.11

package/template/neo-web-cmps/src/components/entityGrid__c/model.ts

@@ -0,0 +1,180 @@
+/**
+ * @file 自定义组件对接编辑器的描述文件
+ */
+export class NeoEntityGridModel {
+  /**
+   * cmpType 为自定义组件名称，用于标识组件的唯一性
+   * 在构建时根据当前组件目录名称自动生成
+   */
+  // cmpType: string = 'entityList__c';
+
+  // 组件名称，用于设置在编辑器左侧组件面板中展示的名称
+  label: string = '基础大列表';
+
+  // 组件描述，用于设置在编辑器左侧组件面板中展示的描述
+  description: string = '数据列表示例: 基础大列表，支持搜索、排序、导出、分页等操作';
+
+  // 分类标签，用于设置在编辑器左侧组件面板哪个分类中展示
+  // tags: string[] = ['自定义组件'];
+
+  /**
+   * 用于设置组件支持的页面类型
+   *
+   * 当前 NeoCRM 平台存在的页面类型：
+   * all:	1	全页面
+   * entityFormPage:	4	实体表单页
+   * customPage:	6	自定义页面
+   */
+  // targetPage: string[] = ['all'];
+
+  /**
+   * 用于设置组件支持的终端类型
+   *
+   * 当前 NeoCRM 平台存在的终端类型：
+   * web:	网页端
+   * mobile: 移动端
+   */
+  targetDevice: string = 'web';
+
+  // 组件图标，用于设置在编辑器左侧组件面板中展示的图标
+  iconUrl: string = 'https://custom-widgets.bj.bcebos.com/table.svg';
+  // iconUrl = 'https://neo-widgets.bj.bcebos.com/favicon.png';
+
+  // 初次插入页面的默认属性数据
+  defaultComProps = {
+    objectApiKey: 'account',
+    funPermission: true, // 设计器添加时绕过职能权限检查，确保能正常渲染列表
+    hiddenHeader: false,
+    showView: true,
+    enableChangeView: true,
+    enableToolbar: true,
+    canCreate: true,
+    canImport: true,
+    withOrder: true,
+    withCheck: true,
+    editable: true,
+    disableSearch: false,
+    disableExport: false,
+    disablePagination: false,
+    paginationPageSize: 20,
+    autoHeight: false,
+    height: '500px',
+  };
+
+  /**
+   * 组件面板配置，用于生成编辑器右侧属性配置面板内容
+   */
+  propsSchema = [
+    {
+      type: 'xObjectEntityList',
+      name: 'objectApiKey',
+      label: '实体对象',
+    },
+    {
+      type: 'dataViewIdSelect',
+      name: 'defaultViewId',
+      xObjectApiKey: 'objectApiKey',
+      label: '列表视图',
+    },
+    {
+      type: 'panelSwitch',
+      name: 'hiddenHeader',
+      label: '隐藏头部',
+      defaultChecked: false,
+    },
+    {
+      type: 'panelSwitch',
+      name: 'disableSearch',
+      label: '禁用搜索',
+      defaultChecked: false,
+      hiddenOn: 'hiddenHeader',
+    },
+    {
+      type: 'panelSwitch',
+      name: 'showView',
+      label: '显示列表视图控制栏',
+      defaultChecked: true,
+      hiddenOn: 'hiddenHeader',
+    },
+    {
+      type: 'panelSwitch',
+      name: 'enableChangeView',
+      label: '支持列表视图切换',
+      defaultChecked: true,
+      hiddenOn: 'hiddenHeader',
+    },
+    {
+      type: 'panelSwitch',
+      name: 'enableToolbar',
+      label: '显示工具栏（含刷新、导出等）',
+      defaultChecked: true,
+      hiddenOn: 'hiddenHeader',
+    },
+    {
+      type: 'panelSwitch',
+      name: 'canCreate',
+      label: '支持新建',
+      defaultChecked: true,
+      hiddenOn: 'hiddenHeader',
+    },
+    {
+      type: 'panelSwitch',
+      name: 'canImport',
+      label: '支持导入',
+      defaultChecked: false,
+      hiddenOn: 'hiddenHeader',
+    },
+    {
+      type: 'panelSwitch',
+      name: 'disableExport',
+      label: '禁用导出',
+      defaultChecked: false,
+      hiddenOn: 'hiddenHeader',
+    },
+    {
+      type: 'panelSwitch',
+      name: 'withOrder',
+      label: '显示序号列',
+      defaultChecked: true,
+    },
+    {
+      type: 'panelSwitch',
+      name: 'withCheck',
+      label: '显示多选列',
+      defaultChecked: true,
+    },
+    {
+      type: 'panelSwitch',
+      name: 'editable',
+      label: '支持单元格编辑',
+      defaultChecked: true,
+    },
+    {
+      type: 'panelSwitch',
+      name: 'disablePagination',
+      label: '是否禁用分页',
+      defaultChecked: false,
+    },
+    {
+      type: 'panelNumber',
+      name: 'paginationPageSize',
+      label: '每页展示条数',
+      visibleOn: '!disablePagination',
+      value: 20,
+    },
+    {
+      type: 'panelSwitch',
+      name: 'autoHeight',
+      label: '高度自适应（根据父容器高度自动适配）',
+      defaultChecked: false,
+    },
+    {
+      type: 'panelInput',
+      name: 'height',
+      label: '高度',
+      visibleOn: '!autoHeight',
+    },
+  ];
+}
+
+export default NeoEntityGridModel;

package/template/neo-web-cmps/src/components/entityGrid__c/style.scss

@@ -0,0 +1,13 @@
+:root {
+  --padding-bottom: 12px;
+}
+
+.entityGrid__c {
+  position: relative;
+  box-sizing: border-box;
+
+  /* border-bottom: 1px solid #ececec; */
+  // margin: 6px 12px;
+  padding: 6px var(--padding-bottom);
+  background-color: #fff;
+}

package/template/neo-web-cmps/src/utils/axiosFetcher.ts

@@ -0,0 +1,37 @@
+import axios from 'axios'; // https://www.axios-http.cn/docs/intro
+
+// 创建基于 axios 的 fetcher 函数
+const axiosFetcher = async (options: any) => {
+  try {
+    const config = {
+      ...options,
+      method: options?.method || 'GET',
+      data: options?.data || {},
+      headers: {
+        'Content-Type': 'application/json',
+        ...options?.headers,
+      },
+      timeout: options?.timeout || 30000,
+    };
+
+    if (config?.method === 'GET') {
+      config.params = options?.data || {};
+    }
+
+    const response = await axios(config);
+    return response?.data || {};
+  } catch (error) {
+    if (error.response) {
+      // 请求成功发出且服务器也响应了状态码，但状态代码超出了 2xx 的范围
+      console.error('接口请求报错 / 接口服务异常：', error.message);
+    } else if (error.request) {
+      // 请求已经成功发起，但没有收到响应
+      console.error('接口请求报错 / 接口未正常响应：', error.message);
+    } else {
+      console.error('接口请求报错:', error, '，请求参数:', options);
+    }
+    throw error;
+  }
+};
+
+export default axiosFetcher;

package/template/neo-web-cmps/src/utils/queryObjectData.ts

@@ -0,0 +1,112 @@
+import axiosFetcher from '$utils/axiosFetcher';
+
+/**
+ * 这里存放通用查询类 Open API
+ */
+
+/** 将 where 规范为 SQL 片段：字符串直接使用；数组用 and 拼接各条件 */
+function normalizeWhere(where: unknown): string {
+  if (where == null || where === '') {
+    return '';
+  }
+  if (typeof where === 'string') {
+    return where.trim();
+  }
+  if (Array.isArray(where)) {
+    return where
+      .map((part) => (part == null ? '' : String(part).trim()))
+      .filter(Boolean)
+      .join(' and ');
+  }
+  return '';
+}
+
+// 获取业务对象数据列表
+export const queryXObjectData = async (options?: any) => {
+  const apiUrl = '/rest/data/v2/query';
+  const curOptions = options || {};
+  const xObjectApiKey = curOptions.xObjectApiKey || '';
+  const fields = curOptions.fields || [];
+  const page = curOptions.page || 1;
+  const pageSize = curOptions.pageSize || 10;
+
+  // 自动添加 objectId 字段
+  if (!fields.includes('id')) {
+    fields.push('id');
+  }
+
+  // 计算分页偏移量
+  const offset = (page - 1) * pageSize;
+
+  // 构建 SQL 查询
+  let querySql = `select ${fields.join(',')} from ${xObjectApiKey}`;
+
+  // 添加排序条件（如果有的话）
+  if (curOptions.orderBy) {
+    querySql += ` order by ${curOptions.orderBy}`;
+  }
+
+  /**
+   * 添加过滤条件（如果有的话）
+   * 支持的操作符包括：=、!=、like、not like、not in、is not null、is null、>、<、<>、>=、<=、in、between ... and ...。
+   * 对于 =、like 和 in 有以下说明：
+   *   “=” 作为字符串的条件时，表示精确匹配。例如，查询条件 city = '北京'，将返回 city 字段值严格等于 "北京" 的所有记录。
+   *   "like" 作为字符串的条件时，需要使用"%" 通配符进行模糊匹配。例如，city like‘北京%'，将返回 city 字段值以 "北京" 开头的所有记录。
+   *         目前仅支持将通配符“%” 放到已知内容之后的查询方式，例如，不支持 city like ‘% 北京'的查询方式。
+   *         当 SQL 查询中包含“%”等特殊字符时，需要对 SQL 进行 URL 编码处理。
+   * 支持"in"，但不包括子查询。
+   * 支持的逻辑运算符包括：and、or。
+   *
+   * `where` 可为字符串，或字符串数组（多项默认以 and 连接，等价于手写 `a and b`）。
+   */
+  const whereClause = normalizeWhere(curOptions.where);
+  console.log('whereClause:', whereClause);
+  if (whereClause) {
+    querySql += ` where ${whereClause}`;
+  }
+
+  if (curOptions.page || curOptions.pageSize) {
+    // 添加分页限制
+    querySql += ` limit ${pageSize} offset ${offset}`;
+  }
+
+  try {
+    const config = {
+      url: apiUrl,
+      method: 'GET',
+      data: {
+        q: querySql,
+      },
+    };
+
+    const resultData = await axiosFetcher(config);
+
+    if (resultData.code === 200) {
+      const { records, totalSize } = resultData.result || {};
+      return {
+        status: true,
+        code: resultData.code,
+        msg: resultData.msg || '获取业务对象数据列表成功',
+        totalSize,
+        data: records || [],
+      };
+    }
+
+    return {
+      status: false,
+      code: resultData.code,
+      msg: resultData.msg || '获取业务对象数据列表失败',
+      data: [],
+    };
+  } catch (error) {
+    console.error('获取业务对象数据列表失败:', error);
+
+    return {
+      status: false,
+      msg: error.msg || error.message || '获取业务对象数据列表失败',
+      data: [],
+    };
+  }
+};
+
+export default queryXObjectData;

package/template/neo-web-cmps/src/utils/xobjects.ts

@@ -0,0 +1,167 @@
+import { Toast } from 'antd-mobile';
+import axiosFetcher from './axiosFetcher';
+
+// 获取业务类型列表
+export const getEntityTypeList = async (
+  xObjectApiKey: string,
+  options?: any,
+) => {
+  const curOptions = options || {};
+  const apiUrl = `/rest/data/v2.0/xobjects/${xObjectApiKey}/busiType`;
+  try {
+    const config = {
+      ...curOptions,
+      url: apiUrl,
+      method: 'GET',
+    };
+
+    const result = await axiosFetcher(config);
+    return result;
+  } catch (error) {
+    console.error('获取业务类型失败:', error);
+    Toast.fail('获取业务类型失败。');
+    return {};
+  }
+};
+
+// 获取对象列表
+export const getEntityList = async (options?: any) => {
+  const curOptions = options || {};
+  const custom = curOptions.custom || false; // 默认获取标准对象列表
+  const active = curOptions.active || true; // 仅获取有权限的对象
+  const apiUrl = `/rest/metadata/v2.0/xobjects/filter?custom=${custom}&active=${active}`;
+  try {
+    const config = {
+      ...curOptions,
+      url: apiUrl,
+      method: 'GET',
+    };
+
+    const result = await axiosFetcher(config);
+    return result;
+  } catch (error) {
+    console.error('获取对象列表失败:', error);
+    Toast.fail('获取对象列表失败。');
+    return {};
+  }
+};
+
+// 创建业务数据
+export const createXObject = async (xObjectApiKey: string, options: any) => {
+  const curOptions = options || {};
+  const apiUrl = `/rest/data/v2.0/xobjects/${xObjectApiKey}`;
+  const formData = curOptions.data || {};
+  try {
+    const config = {
+      ...options,
+      url: apiUrl,
+      method: curOptions.method || 'GET',
+      data: {
+        data: formData,
+      },
+    };
+
+    const result = await axiosFetcher(config);
+    return result;
+  } catch (error) {
+    console.error('创建业务数据失败:', error);
+    Toast.fail('创建业务数据失败');
+    throw error;
+  }
+};
+
+// 获取业务对象描述
+export const getXObjectDesc = async (xObjectApiKey: string, options?: any) => {
+  const curOptions = options || {};
+  const apiUrl = `/rest/data/v2.0/xobjects/${xObjectApiKey}/description`;
+  try {
+    const config = {
+      ...options,
+      url: apiUrl,
+      method: curOptions.method || 'GET',
+    };
+
+    const result = await axiosFetcher(config);
+    return result;
+  } catch (error) {
+    console.error('获取业务对象描述:', error);
+    Toast.fail('获取业务对象描述失败');
+    throw error;
+  }
+};
+
+// 更新业务数据
+export const updateXObject = async (
+  xObjectApiKey: string,
+  objectId: string,
+  options: any,
+) => {
+  const curOptions = options || {};
+  const apiUrl = `/rest/data/v2.0/xobjects/${xObjectApiKey}/${objectId}`;
+  const formData = curOptions.data || {};
+  try {
+    const config = {
+      ...curOptions,
+      url: apiUrl,
+      method: curOptions.method || 'PATCH',
+      data: {
+        data: formData,
+      },
+    };
+
+    const result = await axiosFetcher(config);
+    return result;
+  } catch (error) {
+    console.error('更新业务数据失败:', error);
+    Toast.fail('更新业务数据失败');
+    throw error;
+  }
+};
+
+// 获取业务数据信息
+export const getXObject = async (
+  xObjectApiKey: string,
+  objectId: string,
+  options?: any,
+) => {
+  const curOptions = options || {};
+  const apiUrl = `/rest/data/v2.0/xobjects/${xObjectApiKey}/${objectId}`;
+  try {
+    const config = {
+      ...curOptions,
+      url: apiUrl,
+      method: curOptions.method || 'GET',
+    };
+
+    const result = await axiosFetcher(config);
+    return result;
+  } catch (error) {
+    console.error('获取业务数据信息失败:', error);
+    Toast.fail('获取业务数据信息失败');
+    throw error;
+  }
+};
+
+// 删除业务数据
+export const deleteXObject = async (
+  xObjectApiKey: string,
+  objectId: string,
+  options?: any,
+) => {
+  const curOptions = options || {};
+  const apiUrl = `/rest/data/v2.0/xobjects/${xObjectApiKey}/${objectId}`;
+  try {
+    const config = {
+      ...curOptions,
+      url: apiUrl,
+      method: curOptions.method || 'DELETE',
+    };
+
+    const result = await axiosFetcher(config);
+    return result;
+  } catch (error) {
+    console.error('删除业务数据:', error);
+    Toast.fail('删除业务数据失败');
+    throw error;
+  }
+};

package/template/neo-web-cmps/tsconfig.json

@@ -0,0 +1,39 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "target": "esnext",
+    "module": "esnext",
+    "allowJs": false,
+    "jsx": "react", // preserve
+    "declaration": false,
+    "noEmit": false,
+    "importHelpers": true,
+    "isolatedModules": false,
+    "strict": false,
+    "noImplicitAny": true,
+    "strictNullChecks": true,
+    "noImplicitThis": true,
+    "noUnusedLocals": false,
+    "noImplicitReturns": true,
+    "moduleResolution": "node",
+    "baseUrl": "./",
+    "paths": {
+      "@": [
+        "./src"
+      ]
+    },
+    "typeRoots": [
+      "./@types",
+      "./node_modules/@types"
+    ],
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "include": [
+    "src"
+  ],
+  "exclude": [
+    "node_modules"
+  ]
+}

package/template/react-custom-cmp-template/package.json

@@ -45,7 +45,7 @@
   "devDependencies": {
     "@commitlint/cli": "^18.0.0",
     "@commitlint/config-conventional": "^18.0.0",
-    "neo-cmp-cli": "^1.12.9",
+    "neo-cmp-cli": "^1.12.11",
     "husky": "^4.2.5",
     "lint-staged": "^10.2.9",
     "prettier": "^2.0.5"

package/template/react-ts-custom-cmp-template/package.json

@@ -47,7 +47,7 @@
     "@commitlint/config-conventional": "^18.0.0",
     "@types/react": "^16.9.11",
     "@types/react-dom": "^16.9.15",
-    "neo-cmp-cli": "^1.12.9",
+    "neo-cmp-cli": "^1.12.11",
     "husky": "^4.2.5",
     "lint-staged": "^10.2.9",
     "prettier": "^2.0.5"

package/template/vue2-custom-cmp-template/package.json

@@ -45,7 +45,7 @@
   "devDependencies": {
     "@commitlint/cli": "^18.0.0",
     "@commitlint/config-conventional": "^18.0.0",
-    "neo-cmp-cli": "^1.12.9",
+    "neo-cmp-cli": "^1.12.11",
     "husky": "^4.2.5",
     "lint-staged": "^10.2.9",
     "prettier": "^2.0.5",