neo-cmp-cli 1.8.3 → 1.8.6

package/template/neo-custom-cmp-template/docs/README.md

@@ -0,0 +1,244 @@
+## Open api 文档
+- [Open API 简介](https://doc.xiaoshouyi.com/#/proMan/workplaceDetailApi?url=%2F%2Fconcepts%2Fapi_apiIntroduction.html&id=1405&dir=output_1757929564205)。
+
+## Neo 自定义组件中可用的 open api 接口
+- [查询对象列表](https://doc.xiaoshouyi.com/#/proMan/workplaceDetailApi?url=%2F%2Fconcepts%2FpaasQueryObjectList.html&id=1405&dir=output_1757929564205&time=1758780224026): /rest/metadata/v2.0/xobjects/filter；
+- 查询标准对象列表: /rest/metadata/v2.0/xobjects/filter?custom=false&active=true；
+- 查询自定义对象列表: /rest/metadata/v2.0/xobjects/filter?custom=true&active=true；
+- [创建业务数据](https://doc.xiaoshouyi.com/#/proMan/workplaceDetailApi?url=%2F%2Fconcepts%2Fapi_paas_customObject_create.html&id=1405&dir=output_1757929564205&time=1758782257815): /rest/data/v2.0/xobjects/{xObjectApiKey};
+- [更新业务数据](https://doc.xiaoshouyi.com/#/proMan/workplaceDetailApi?url=%2F%2Fconcepts%2Fapi_paas_customObject_update.html&id=1405&dir=output_1757929564205&time=1758782321910): /rest/data/v2.0/xobjects/{xObjectApiKey}/{id};
+- [获取业务数据信息（单个数据）](https://doc.xiaoshouyi.com/#/proMan/workplaceDetailApi?url=%2F%2Fconcepts%2Fapi_paas_customObject_getBusinessDataInformation.html&id=1405&dir=output_1757929564205&time=1758781533725): /rest/data/v2.0/xobjects/{xObjectApiKey}/{id};
+- [查询接口（通用查询接口）](https://doc.xiaoshouyi.com/#/proMan/workplaceDetailApi?url=%2F%2Fconcepts%2Fapi_queryInterfaceDescription.html&id=1405&dir=output_1757929564205&time=1758784491846): /rest/data/v2/query;
+- [获取业务类型描述](https://doc.xiaoshouyi.com/?sso-domain=login-cd.xiaoshouyi.com#/proMan/workplaceDetailApi?url=%2F%2Fconcepts%2Fapi_paas_customObject_getBusinessTypeDescription.html&id=1405&dir=output_1757929564205&time=1758798530511): /rest/data/v2.0/xobjects/{xObjectApiKey}/busiType;
+- 更多可用接口见[文档](https://doc.xiaoshouyi.com/#/proMan/workplaceDetailApi?url=%2F%2Fconcepts%2Fapi_apiIntroduction.html&id=1405&dir=output_1757929564205)。
+
+## Open API 请求方法
+
+### 基础请求工具
+
+#### axiosFetcher
+基于 axios 封装的通用请求工具，支持 GET、POST、PATCH、DELETE 等请求方法。
+
+```typescript
+import axiosFetcher from '@/utils/axiosFetcher';
+
+// 基本用法
+const result = await axiosFetcher({
+  url: '/api/endpoint',
+  method: 'GET',
+  data: { key: 'value' },
+  headers: { 'Custom-Header': 'value' },
+  timeout: 30000
+});
+```
+
+**参数说明：**
+- `url`: 请求地址
+- `method`: 请求方法，默认为 'GET'
+- `data`: 请求数据，GET 请求会转为 params
+- `headers`: 请求头，默认包含 'Content-Type': 'application/json'
+- `timeout`: 超时时间，默认 30000ms
+
+### 业务对象相关接口
+
+#### 1. 查询业务对象数据列表 (queryXObjectData)
+使用通用查询接口获取业务对象数据，支持分页和排序。
+
+```typescript
+import { queryXObjectData } from '@/utils/queryObjectData';
+
+// 基本查询
+const result = await queryXObjectData({
+  xObjectApiKey: 'Contact', // 业务对象 API Key
+  fields: ['name', 'phone', 'email'], // 查询字段
+  page: 1, // 页码
+  pageSize: 10, // 每页数量
+  orderBy: 'name asc' // 排序条件（可选）
+});
+```
+
+**参数说明：**
+- `xObjectApiKey`: 业务对象的 API Key
+- `fields`: 需要查询的字段数组，会自动添加 'id' 字段
+- `page`: 页码，默认为 1
+- `pageSize`: 每页数量，默认为 10
+- `orderBy`: 排序条件，如 'name asc' 或 'createdTime desc'
+
+**返回结果：**
+```typescript
+{
+  code: 200,
+  result: {
+    // 查询结果数据
+    records: any[],
+    // 分页信息
+    totalSize: number, // 总个数
+  }
+}
+```
+
+#### 2. 获取业务类型列表 (getEntityTypeList)
+获取指定业务对象的业务类型列表。
+
+```typescript
+import { getEntityTypeList } from '@/utils/xobjects';
+
+const result = await getEntityTypeList('Contact', {
+  // 其他请求选项
+});
+```
+
+**参数说明：**
+- `xObjectApiKey`: 业务对象的 API Key
+- `options`: 可选的请求配置
+
+#### 3. 获取对象列表 (getEntityList)
+获取系统中的对象列表，支持标准对象和自定义对象。
+
+```typescript
+import { getEntityList } from '@/utils/xobjects';
+
+// 获取标准对象列表
+const standardObjects = await getEntityList({
+  custom: false, // 获取标准对象
+  active: true   // 仅获取有权限的对象
+});
+
+// 获取自定义对象列表
+const customObjects = await getEntityList({
+  custom: true,  // 获取自定义对象
+  active: true   // 仅获取有权限的对象
+});
+```
+
+**参数说明：**
+- `custom`: 是否获取自定义对象，false 为标准对象，true 为自定义对象
+- `active`: 是否仅获取有权限的对象，默认为 true
+
+#### 4. 创建业务数据 (createXObject)
+创建新的业务数据记录。
+
+```typescript
+import { createXObject } from '@/utils/xobjects';
+
+const result = await createXObject('Contact', {
+  method: 'POST',
+  data: {
+    name: '张三',
+    phone: '13800138000',
+    email: 'zhangsan@example.com'
+  }
+});
+```
+
+**参数说明：**
+- `xObjectApiKey`: 业务对象的 API Key
+- `options.data`: 要创建的数据对象
+- `options.method`: 请求方法，默认为 'GET'（建议使用 'POST'）
+
+#### 5. 更新业务数据 (updateXObject)
+更新指定的业务数据记录。
+
+```typescript
+import { updateXObject } from '@/utils/xobjects';
+
+const result = await updateXObject('Contact', '12345', {
+  method: 'PATCH',
+  data: {
+    name: '李四',
+    phone: '13900139000'
+  }
+});
+```
+
+**参数说明：**
+- `xObjectApiKey`: 业务对象的 API Key
+- `objectId`: 要更新的记录 ID
+- `options.data`: 要更新的数据对象
+- `options.method`: 请求方法，默认为 'PATCH'
+
+#### 6. 获取业务数据信息 (getXObject)
+获取指定业务数据记录的详细信息。
+
+```typescript
+import { getXObject } from '@/utils/xobjects';
+
+const result = await getXObject('Contact', '12345', {
+  // 其他请求选项
+});
+```
+
+**参数说明：**
+- `xObjectApiKey`: 业务对象的 API Key
+- `objectId`: 要获取的记录 ID
+- `options`: 可选的请求配置
+
+#### 7. 删除业务数据 (deleteXObject)
+删除指定的业务数据记录。
+
+```typescript
+import { deleteXObject } from '@/utils/xobjects';
+
+const result = await deleteXObject('Contact', '12345');
+```
+
+**参数说明：**
+- `xObjectApiKey`: 业务对象的 API Key
+- `objectId`: 要删除的记录 ID
+
+#### 8. 获取业务对象描述 (getXObjectDesc)
+获取业务对象的描述信息。
+
+```typescript
+import { getXObjectDesc } from '@/utils/xobjects';
+
+const result = await getXObjectDesc('Contact');
+```
+
+**参数说明：**
+- `xObjectApiKey`: 业务对象的 API Key
+
+### 使用示例
+
+```typescript
+import { 
+  queryXObjectData, 
+  createXObject, 
+  updateXObject, 
+  getXObject, 
+  deleteXObject 
+} from '@/utils/xobjects';
+
+// 查询联系人列表
+const contacts = await queryXObjectData({
+  xObjectApiKey: 'Contact',
+  fields: ['name', 'phone', 'email'],
+  page: 1,
+  pageSize: 20,
+  orderBy: 'createdTime desc'
+});
+
+// 创建新联系人
+const newContact = await createXObject('Contact', {
+  method: 'POST',
+  data: {
+    name: '王五',
+    phone: '13700137000',
+    email: 'wangwu@example.com'
+  }
+});
+
+// 更新联系人
+const updatedContact = await updateXObject('Contact', newContact.id, {
+  data: {
+    name: '王五（更新）'
+  }
+});
+
+// 获取联系人详情
+const contactDetail = await getXObject('Contact', newContact.id);
+
+// 删除联系人
+await deleteXObject('Contact', newContact.id);
+```
+

package/template/neo-custom-cmp-template/neo.config.js

@@ -0,0 +1,140 @@
+'use strict';
+const path = require('path');
+const fs = require('fs');
+
+// 统一路径解析
+function resolve(dir) {
+  return path.resolve(__dirname, dir);
+}
+
+// 包括生产和开发的环境配置信息
+module.exports = {
+  settings: {
+    enableESLint: false, // 调试模式是否开启ESLint，默认开启ESLint检测代码格式
+    enableESLintFix: false, // 是否自动修正代码格式，默认不自动修正
+    enableStyleLint: false, // 是否开启StyleLint，默认开启ESLint检测代码格式
+    enableStyleLintFix: false, // 是否需要StyleLint自动修正代码格式
+  },
+  webpack: {
+    target: ['web', 'es5'], // 指定目标环境为 web 和 es5，确保兼容性
+    resolve: {
+      // webpack的resolve配置
+      extensions: ['.js', '.jsx', '.ts', '.tsx', '.umd.js', '.min.js', '.json'], // 用于配置webpack在尝试过程中用到的后缀列表
+      alias: {
+        '@': resolve('src'),
+        $assets: resolve('src/assets'),
+        $public: resolve('public'),
+        $utils: resolve('src/utils'),
+      },
+    },
+    // sassResources中的sass文件会自动注入每一个sass文件中
+    sassResources: [
+      resolve('./src/assets/css/common.scss'),
+      resolve('./src/assets/css/mixin.scss'),
+    ],
+    // createDeclaration: true, // 打包时是否创建ts声明文件
+    ignoreNodeModules: false, // 打包时是否忽略 node_modules
+    // allowList: [], // ignoreNodeModules为true时生效
+    // projectDir: ['src'],
+    // template: resolve('./public/template.html'), // 自定义html模板
+    // plugins: [],
+    // babelPlugins: [],
+  },
+  // 用于添加 Neo 共享依赖模块的配置信息
+  /*
+  neoCommonModule: {
+    // exports: ['xxModule'], // 数组写法，用于导出当前自定义组件中的第三方依赖模块
+    exports: { // 对象写法，可用于导出自定义组件中的某个内容模块（需要使用绝对路径导出）
+      'xxModule': path.resolve('./src/components/xxModule'), // 导出 xx组件 或 xx模块
+    },
+    // remoteDeps: ['xxCmpType'], // 远程依赖组件，表示当前自定义组件会用到的依赖组件，需要和 externals 配合使用
+    // externals: ['xxModule'], // 自定义组件中需要剔除的模块，仅支持数组写法
+  },
+  */
+  preview: {
+    // 用于开启本地预览模式的相关配置信息
+    /*
+    【特别说明】以下配置项都自带默认值，非必填。如需自定义请自行配置。
+    entry: { // 根据 src/components 目录下的文件自动生成 entry 相关配置
+      // 本地预览自定义组件内容
+      index: './src/preview.jsx',
+    },
+    NODE_ENV: 'development',
+    port: 80, // 设置基础端口，如果被占用则自动寻找可用端口
+    assetsPublicPath: '/', // 设置静态资源的引用路径（根域名+路径）
+    assetsSubDirectory: '',
+    hostname: 'localhost',
+    proxyTable: {
+      '/apiTest': {
+        target: 'http://api-test.com.cn', // 不支持跨域的接口根地址
+        ws: true,
+        changeOrigin: true,
+      },
+    },
+    */
+  },
+  linkDebug: {
+    // 用于开启本地调试模式的相关配置信息
+    /*
+    【特别说明】以下配置项都自带默认值，非必填。如需自定义请自行配置。
+    entry: { // 根据 src/components 目录下的文件自动生成 entry 相关配置
+      // 外链调试（在线上页面设计器端预览自定义组件）
+      index: [
+        './src/components/xxCmp/register.ts',
+        './src/components/xxCmp/model.ts',
+      ],
+    },
+    NODE_ENV: 'development',
+    port: 80, // 设置基础端口，如果被占用则自动寻找可用端口
+    closeHotReload: true, // 是否关闭热更新
+    assetsPublicPath: '/', // 设置静态资源的引用路径（根域名+路径）
+    assetsSubDirectory: '',
+    hostname: 'localhost',
+    proxyTable: {
+      '/apiTest': {
+        target: 'http://api-test.com.cn', // 不支持跨域的接口根地址
+        ws: true,
+        changeOrigin: true,
+      },
+    }
+    */
+  },
+  // 授权码授权模式下的 NeoCRM 平台配置
+  neoConfig: {
+    authType: 'oauth2', // 授权类型，可选值：oauth2（默认）、password
+    neoBaseURL: 'https://crm-cd.xiaoshouyi.com', // 平台根地址（默认：https://crm.xiaoshouyi.com）
+    // 当 authType 为 oauth2 时，loginURL 配置项必填
+    loginURL: 'https://login-cd.xiaoshouyi.com/auc/oauth2/auth', // 登录授权 URL（默认：https://login.xiaoshouyi.com/auc/oauth2/auth）
+    tokenAPI: 'https://login-cd.xiaoshouyi.com/auc/oauth2/token', // Token 获取接口地址（默认：https://login.xiaoshouyi.com/auc/oauth2/token）
+  },
+  /*
+  // 密码授权模式下的 NeoCRM 平台配置
+  neoConfig: {
+    authType: 'password', // 授权类型，可选值：oauth2（默认）、password
+    neoBaseURL: 'https://crm-cd.xiaoshouyi.com', // 平台根地址（默认：https://crm.xiaoshouyi.com）
+    tokenAPI: 'https://login-cd.xiaoshouyi.com/auc/oauth2/token', // Token 获取接口地址（默认：https://login.xiaoshouyi.com/auc/oauth2/token）
+    // 当 authType 为 password 时，auth 配置项必填
+    auth: {
+      client_id: 'xx', // 客户端 ID，从创建连接器的客户端信息中获取（Client_Id）
+      client_secret: 'xxx', // 客户端秘钥，从创建连接器的客户端信息中获取（Client_Secret）
+      username: 'xx', // 用户在销售易系统中的用户名
+      // password 为 用户在销售易系统中的账号密码加上 8 位安全令牌。
+      // 例如，用户密码为 123456，安全令牌为 ABCDEFGH，则 password 的值应为 123456ABCDEFGH。
+      password: 'xx xx', // 用户账户密码 + 8 位安全令牌
+    },
+  },
+  */
+  pushCmp: {
+    // 用于构建并发布至 NeoCRM 的相关配置
+    /*
+    【特别说明】以下配置项都自带默认值，非必填。如需自定义请自行配置。
+    NODE_ENV: 'production',
+    entry: { // 根据 src/components 目录下的文件自动生成 entry 相关配置
+      InfoCardModel: './src/components/xxCmp/model.ts',
+      infoCard: './src/components/xxCmp/register.ts'
+    },
+    cssExtract: false, // 不额外提取css文件
+    assetsRoot: resolve('dist') // 上传指定目录下的脚本文件
+    */
+  },
+};

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

@@ -0,0 +1,66 @@
+{
+  "name": "neo-custom-cmp-template",
+  "version": "1.1.10",
+  "description": "neo自定义组件模板（react&ts技术栈）",
+  "framework": "react-ts",
+  "keywords": [
+    "自定义组件模板",
+    "react&ts技术栈",
+    "neo自定义组件"
+  ],
+  "author": "wibetter",
+  "license": "MIT",
+  "scripts": {
+    "preview": "neo preview",
+    "linkDebug": "neo linkDebug",
+    "pushCmp": "neo push cmp",
+    "pullCmp": "neo pull cmp",
+    "deleteCmp": "neo delete cmp",
+    "format": "prettier --write \"src/**/**/*.{js,jsx,ts,tsx,vue,scss,json}\""
+  },
+  "files": [
+    "dist/*"
+  ],
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged",
+      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
+    }
+  },
+  "lint-staged": {
+    "src/**/**/*.{js,jsx,ts,tsx,vue,scss,json}": [
+      "prettier --write"
+    ]
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://git@github.com:wibetter/neo-custom-cmp-template.git"
+  },
+  "bugs": {
+    "url": "https://github.com/wibetter/neo-custom-cmp-template/issues"
+  },
+  "dependencies": {
+    "neo-register": "^1.0.8",
+    "react": "^16.9.0",
+    "react-dom": "^16.9.0",
+    "axios": "^0.27.2",
+    "antd": "^4.9.4",
+    "lodash": "^4.17.21",
+    "neo-open-api": "^1.1.0"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^8.3.5",
+    "@commitlint/config-conventional": "^9.1.1",
+    "@types/react": "^16.9.11",
+    "@types/react-dom": "^16.9.15",
+    "@types/axios": "^0.14.0",
+    "neo-cmp-cli": "^1.8.0",
+    "husky": "^4.2.5",
+    "lint-staged": "^10.2.9",
+    "prettier": "^2.0.5"
+  },
+  "engines": {
+    "node": ">= 10.13.0",
+    "npm": ">= 6.4.1"
+  }
+}