neo-cmp-cli 1.8.0 → 1.8.2

package/README.md

@@ -243,9 +243,93 @@ module.exports = {
 
 ### 3. 使用平台实体数据源
 
-可使用 OpenAPI SDK 对接平台实体数据源，详细使用方法见 [neo-open-api](https://www.npmjs.com/package/neo-open-api)。
+可在自定义组件中使用 OpenAPI SDK 对接平台实体数据源，详细使用方法见 [neo-open-api](https://www.npmjs.com/package/neo-open-api)。
+
+```typescript
+import { xObject } from 'neo-open-api';
+
+// 查询联系人列表
+const {data: contacts} = await xObject.query({
+  xObjectApiKey: 'Contact',
+  fields: ['name', 'phone', 'email'],
+  page: 1,
+  pageSize: 20,
+  orderBy: 'createdAt desc'
+});
+
+// 创建新联系人
+const {data: newContact} = await xObject.create('Contact', {
+  data: {
+    name: '王五',
+    phone: '13700137000',
+    email: 'wangwu@example.com'
+  }
+});
+
+// 更新联系人
+const {data: updatedContact} = await xObject.update('Contact', newContact.id, {
+  data: {
+    name: '王五（更新）'
+  }
+});
+
+// 获取联系人详情
+const {data: contactDetail} = await xObject.get('Contact', newContact.id);
+
+// 删除联系人
+await xObject.delete('Contact', newContact.id);
+```
+
+
+### 4. 使用平台自定义API
+
+可在自定义组件中使用 OpenAPI SDK 对接平台自定义API，详细使用方法见 [neo-open-api](https://www.npmjs.com/package/neo-open-api)。
+
+```typescript
+import { customApi } from 'neo-open-api';
+
+// 基本用法
+const result = await customApi.run({
+  apiUrl: '/rest/custom/api/endpoint', // 自定义API地址
+  methodType: 'POST', // 请求方法，如 'GET', 'POST', 'PUT', 'DELETE' 等（可选，默认为 'POST'）
+  data: { // 请求数据
+    key1: 'value1',
+    key2: 'value2'
+  }
+});
+```
+
+**参数说明：**
+- `apiUrl`: 自定义API的完整地址（必填）
+- `methodType` 或 `method`: 请求方法，默认为 'POST'
+- `data`: 请求数据对象，会被包装在 `data` 字段中发送
+
+**返回结果：**
+```typescript
+{
+  status: boolean, // 返回 true 表示执行成功
+  code: number | string, // 返回码
+  msg: string, // 一般用于返回错误信息
+  data: any // API返回的数据
+}
+```
+
+**使用示例：**
+```typescript
+import { customApi } from 'neo-open-api';
+
+// 执行自定义API
+const result = await customApi.run({
+  apiUrl: '/rest/custom/api/processData',
+  methodType: 'POST',
+  data: {
+    param1: 'value1',
+    param2: 'value2'
+  }
+});
+```
 
-### 4. 默认复用平台第三方依赖
+### 5. 默认复用平台第三方依赖
 
 自定义组件构建过程中默认会剔除掉平台已有依赖模块（比如 antd、echarts、axios、lodash 等），确保自定义组件构建后的资源体积较小。
 
@@ -276,7 +360,7 @@ module.exports = {
 
 > **注意**：自定义组件中请使用依赖包支持的版本，如版本不匹配运行时可能出现异常。
 
-### 5. 本地调试自定义组件
+### 6. 本地调试自定义组件
 
 #### 步骤 1：启动外链调试模式
 
@@ -294,7 +378,7 @@ neo linkDebug
 
 页面设计器开启 debug 模式后，左侧会展示**外部链接**管理面板。将第 1 步生成的「外链脚本地址」添加进来，即可在此页面设计器 / 组件物料面板中看到对应自定义组件。
 
-### 6. 发布自定义组件至 NeoCRM
+### 7. 发布自定义组件至 NeoCRM
 
 执行 `neo push cmp` 即可构建并发布自定义组件至 NeoCRM 平台，其构建后资源也会上传到 NeoCRM 平台端提供的 CDN 中。
 
@@ -342,7 +426,7 @@ A: 请检查 `neo.config.js` 文件中是否配置了 `neoConfig.auth`，确保
 
 发布成功后，即可在对应租户环境下的页面设计器和表单设计器中使用此自定义组件。
 
-### 7. 拉取线上自定义组件至本地项目
+### 8. 拉取线上自定义组件至本地项目
 
 执行 `neo pull cmp` 即可从 NeoCRM 平台拉取自定义组件源码到当前项目。该命令会将线上自定义组件的源码下载并解析到当前项目的 `src/components` 目录下。
 
@@ -370,7 +454,7 @@ neo pull cmp -n xxCmp
 - 如果组件源码中包含新增的依赖包，拉取完成后会提示执行 `npm install` 或 `yarn install`
 - zip 源文件会保留在 `.neo-cli/zip-source` 目录下，可手动删除
 
-### 8. 删除线上自定义组件
+### 9. 删除线上自定义组件
 
 执行 `neo delete cmp` 即可从 NeoCRM 平台删除指定的自定义组件。该命令会删除平台上的自定义组件，删除后该组件将无法在页面设计器和表单设计器中使用。
 
@@ -397,7 +481,7 @@ neo delete cmp -n xxCmp
 - ⚠️ **影响范围**：删除组件后，所有使用该组件的页面和表单将受到影响，请确保没有正在使用的场景
 - 💡 **建议先备份**：删除前建议先使用 `neo pull cmp` 拉取组件源码到本地进行备份
 
-### 9. 发布自定义组件至 CDN
+### 10. 发布自定义组件至 CDN
 
 执行 `neo publish2oss` 即可构建对应自定义组件，并自动将构建后资源上传到对象存储（OSS）中。
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "neo-cmp-cli",
-  "version": "1.8.0",
-  "description": "前端脚手架：自定义组件开发工具，支持react 和 vue2.0技术栈。",
+  "version": "1.8.2",
+  "description": "Neo 自定义组件开发工具，支持react 和 vue2.0技术栈。",
   "keywords": [
     "neo-cli",
     "自定义组件开发工具"
@@ -34,10 +34,10 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://git@github.com:wibetter/neo-cmp-cli.git"
+    "url": "https://github.com/xsy-neoui/neo-cmp-cli.git"
   },
   "bugs": {
-    "url": "https://github.com/wibetter/neo-cmp-cli/issues"
+    "url": "https://github.com/xsy-neoui/neo-cmp-cli/issues"
   },
   "dependencies": {
     "adm-zip": "^0.5.10",

package/src/template/antd-custom-cmp-template/src/components/dataDashboard/model.ts

@@ -17,9 +17,9 @@ export class DataDashboardModel {
   // 分类标签，用于设置在编辑器左侧组件面板哪个分类中展示（可设置多个分类标签）
   // tags: string[] = ['仪表板'];
 
-  /** 
+  /**
    * 用于设置组件支持的页面类型
-   * 
+   *
    * 当前 NeoCRM 平台存在的页面类型：
    * all:	1	全页面
    * indexPage:	2	首页

package/src/template/antd-custom-cmp-template/src/components/infoCard/model.ts

@@ -17,9 +17,9 @@ export class InfoCardModel {
   // 分类标签，用于设置在编辑器左侧组件面板哪个分类中展示（可设置多个分类标签）
   // tags: string[] = ['自定义组件'];
 
-  /** 
+  /**
    * 用于设置组件支持的页面类型
-   * 
+   *
    * 当前 NeoCRM 平台存在的页面类型：
    * all:	1	全页面
    * indexPage:	2	首页