neo-cmp-cli 1.13.11 → 1.13.13

package/template/neo-bi-cmps/docs/neo-backend-dev/scripts/gen_entitylist.py

@@ -0,0 +1,87 @@
+#!/usr/bin/env python3
+"""
+生成实体字典：下载 model.jar，解析实体列表，通过 API 获取 label，输出 entitylist.md
+用法: python3 gen_entitylist.py <项目目录>
+示例: python3 gen_entitylist.py NEOTrail
+"""
+import sys, os, json, zipfile, urllib.request
+
+if len(sys.argv) < 2:
+    print("用法: python3 gen_entitylist.py <项目目录>")
+    sys.exit(1)
+
+project_dir = sys.argv[1]
+token_path = os.path.join(project_dir, '.neo-cli/token.json')
+output_dir = os.path.join(project_dir, 'src/entity-model')
+jar_path = os.path.join(project_dir, 'model.jar')
+
+if not os.path.exists(token_path):
+    print("错误: 未找到 %s，请先执行 neo login" % token_path)
+    sys.exit(1)
+
+token = json.load(open(token_path))
+access_token = token['access_token']
+base_url = token['instance_uri'].rstrip('/')
+headers = {'Authorization': 'Bearer ' + access_token, 'Content-Type': 'application/json'}
+
+def api_get(path):
+    req = urllib.request.Request(base_url + path, method='GET')
+    for k, v in headers.items():
+        req.add_header(k, v)
+    return json.loads(urllib.request.urlopen(req).read().decode('utf-8'))
+
+# 1. 下载 model.jar
+print("下载 model.jar ...")
+jar_url_data = api_get('/rest/metadata/v2.0/scripts/packages/model/jar/url')
+jar_url = jar_url_data.get('data', {}).get('records', '')
+urllib.request.urlretrieve(jar_url, jar_path)
+print("已下载: %s" % jar_path)
+
+# 2. 解析 jar 获取实体列表
+with zipfile.ZipFile(jar_path, 'r') as z:
+    classes = [n for n in z.namelist() if n.endswith('.class') and '/model/' in n]
+
+jar_entities = {}
+for c in classes:
+    name = c.split('/')[-1].replace('.class', '')
+    apiKey = name[0].lower() + name[1:]
+    is_standard = not (name.endswith('__c') or name.endswith('__a'))
+    jar_entities[apiKey] = {'className': name, 'apiKey': apiKey, 'isStandard': is_standard, 'label': ''}
+
+# 3. 批量获取 label
+print("获取实体 label ...")
+label_map = {}
+for custom_flag in ['true', 'false']:
+    try:
+        data = api_get('/rest/metadata/v2.0/xobjects/filter?custom=%s&active=true' % custom_flag)
+        for r in data.get('data', {}).get('records', []):
+            label_map[r.get('apiKey', '')] = r.get('label', '')
+    except Exception as e:
+        print("警告: 获取实体列表失败 (custom=%s): %s" % (custom_flag, e))
+
+for ak, label in label_map.items():
+    if ak in jar_entities:
+        jar_entities[ak]['label'] = label
+
+# 4. 生成 entitylist.md
+entities = sorted(jar_entities.values(), key=lambda x: x['className'])
+standard = [e for e in entities if e['isStandard']]
+custom = [e for e in entities if not e['isStandard']]
+
+os.makedirs(output_dir, exist_ok=True)
+
+lines = ['# 实体字典', '',
+    '租户 ID: %s | 环境: %s' % (token.get('tenant_id', ''), base_url), '',
+    '共 %d 个实体（%d 个标准实体 + %d 个自定义实体）' % (len(entities), len(standard), len(custom)), '',
+    '| 实体名称 | API Key | 类型 |',
+    '|----------|---------|------|']
+for e in entities:
+    label = e['label'] if e['label'] else e['className']
+    etype = '标准' if e['isStandard'] else '自定义'
+    lines.append('| %s | %s | %s |' % (label, e['apiKey'], etype))
+
+output_path = os.path.join(output_dir, 'entitylist.md')
+with open(output_path, 'w', encoding='utf-8') as f:
+    f.write('\n'.join(lines))
+
+print("完成: %s (%d 个实体, %d 个 label)" % (output_path, len(entities), len(label_map)))

package/template/neo-bi-cmps/docs/neo-backend-dev/scripts/query_crm.py

@@ -0,0 +1,65 @@
+#!/usr/bin/env python3
+"""
+查询 CRM 系统数据工具。借助当前项目的登录状态执行 SQL 查询。
+用法: python3 query_crm.py <项目目录> "<SQL查询语句>"
+示例: python3 query_crm.py 临时验证 "SELECT id, opportunityName, amount FROM opportunity LIMIT 10"
+"""
+import os, json, urllib.request, urllib.error, sys
+
+if len(sys.argv) < 3:
+    print("用法: python3 query_crm.py <项目目录> \"<SQL查询语句>\"")
+    sys.exit(1)
+
+project_dir = sys.argv[1]
+sql = sys.argv[2]
+token_path = os.path.join(project_dir, '.neo-cli/token.json')
+
+if not os.path.exists(token_path):
+    print("错误: 未找到 %s，请先执行 neo login" % token_path)
+    sys.exit(1)
+
+token = json.load(open(token_path))
+access_token = token['access_token']
+base_url = token['instance_uri'].rstrip('/')
+
+print("执行查询: %s\n" % sql)
+
+url = base_url + '/rest/data/v2/query'
+encoded_sql = urllib.request.quote(sql)
+full_url = url + '?q=' + encoded_sql
+
+req = urllib.request.Request(full_url, method='GET')
+req.add_header('Authorization', 'Bearer ' + access_token)
+req.add_header('Content-Type', 'application/json')
+
+try:
+    resp = urllib.request.urlopen(req)
+    data = json.loads(resp.read().decode('utf-8'))
+
+    records = data.get('result', data.get('data', {})).get('records', [])
+    total = data.get('result', data.get('data', {})).get('totalSize', len(records) if isinstance(records, list) else 0)
+
+    if isinstance(records, list) and len(records) > 0:
+        # 提取字段名
+        fields = list(records[0].keys()) if isinstance(records[0], dict) else []
+        
+        # 打印表头
+        header = ' | '.join(str(f) for f in fields)
+        print(header)
+        print('-' * len(header))
+        
+        # 打印数据
+        for r in records:
+            if isinstance(r, dict):
+                row = ' | '.join(str(r.get(f, '')) for f in fields)
+                print(row)
+        
+        print("\n共 %s 条记录" % total)
+    else:
+        print("无数据")
+        print("原始响应: %s" % json.dumps(data, ensure_ascii=False)[:1000])
+
+except urllib.error.HTTPError as e:
+    print("请求失败 HTTP %d: %s" % (e.code, e.read().decode('utf-8')[:500]))
+except Exception as e:
+    print("异常: %s" % e)

package/template/neo-bi-cmps/docs/neo-backend-dev/scripts/uninstall_server_script.py

@@ -0,0 +1,48 @@
+#!/usr/bin/env python3
+"""
+卸载服务端代码包。
+用法: python3 uninstall_server_script.py <项目目录> <Java包名> [--force]
+示例: python3 uninstall_server_script.py NEOTrail other.xsy.account
+      python3 uninstall_server_script.py NEOTrail other.xsy.account --force
+"""
+import os, json, urllib.request, urllib.error, sys
+
+if len(sys.argv) < 3:
+    print("用法: python3 uninstall_server_script.py <项目目录> <Java包名> [--force]")
+    sys.exit(1)
+
+project_dir = sys.argv[1]
+java_package = sys.argv[2]
+force = '--force' in sys.argv
+token_path = os.path.join(project_dir, '.neo-cli/token.json')
+
+if not os.path.exists(token_path):
+    print("错误: 未找到 %s，请先执行 neo login" % token_path)
+    sys.exit(1)
+
+token = json.load(open(token_path))
+access_token = token['access_token']
+base_url = token['instance_uri'].rstrip('/')
+
+# 卸载代码包
+force_str = 'true' if force else 'false'
+print("卸载代码包: %s (force=%s) ..." % (java_package, force_str))
+url = base_url + '/rest/metadata/v2.0/scripts/packages/installations/' + urllib.request.quote(java_package) + '?force=' + force_str
+req = urllib.request.Request(url, method='DELETE')
+req.add_header('Authorization', access_token)
+
+try:
+    resp = urllib.request.urlopen(req)
+    data = json.loads(resp.read().decode('utf-8'))
+    code = data.get('code', '')
+    if code in ('200', '000000'):
+        print("卸载成功")
+    elif code == '290030':
+        print("有任务正在运行，请使用 --force 强制卸载")
+        sys.exit(1)
+    else:
+        print("卸载失败: %s" % data.get('msg', code))
+        sys.exit(1)
+except urllib.error.HTTPError as e:
+    print("请求失败 HTTP %d: %s" % (e.code, e.read().decode('utf-8')[:500]))
+    sys.exit(1)

package/template/neo-bi-cmps/docs/neo-backend-dev/scripts/update_model_jar.py

@@ -0,0 +1,49 @@
+#!/usr/bin/env python3
+"""
+更新 model.jar：触发服务端重新编译并下载最新的 model.jar。
+用法: python3 update_model_jar.py <项目目录>
+示例: python3 update_model_jar.py NEOTrail
+"""
+import os, json, urllib.request, urllib.error, sys
+
+if len(sys.argv) < 2:
+    print("用法: python3 update_model_jar.py <项目目录>")
+    sys.exit(1)
+
+project_dir = sys.argv[1]
+token_path = os.path.join(project_dir, '.neo-cli/token.json')
+jar_path = os.path.join(project_dir, 'model.jar')
+
+if not os.path.exists(token_path):
+    print("错误: 未找到 %s，请先执行 neo login" % token_path)
+    sys.exit(1)
+
+token = json.load(open(token_path))
+access_token = token['access_token']
+base_url = token['instance_uri'].rstrip('/')
+
+# 1. 触发编译并获取下载地址
+print("触发 model.jar 编译 ...")
+url = base_url + '/rest/metadata/v2.0/scripts/packages/model/jar'
+req = urllib.request.Request(url, data=b'', method='POST')
+req.add_header('Authorization', access_token)
+
+try:
+    resp = urllib.request.urlopen(req)
+    data = json.loads(resp.read().decode('utf-8'))
+    if data.get('code') != '200':
+        print("编译失败: %s" % data.get('msg', ''))
+        sys.exit(1)
+    jar_url = data.get('data', {}).get('records', '')
+    if not jar_url:
+        print("错误: 未获取到下载地址")
+        sys.exit(1)
+    print("编译成功，下载地址: %s" % jar_url[:80])
+except urllib.error.HTTPError as e:
+    print("请求失败 HTTP %d: %s" % (e.code, e.read().decode('utf-8')[:500]))
+    sys.exit(1)
+
+# 2. 下载 model.jar
+print("下载 model.jar ...")
+urllib.request.urlretrieve(jar_url, jar_path)
+print("完成: %s (%d bytes)" % (jar_path, os.path.getsize(jar_path)))

package/template/neo-bi-cmps/docs/neo-frontend-dev/SKILL.md

@@ -0,0 +1,138 @@
+---
+name: neo-frontend-dev
+description: Neo 前端自定义组件开发技能，基于 neo-cmp-cli 工具链。当用户需要：(1) 创建 Neo 自定义组件项目，(2) 开发前端自定义组件（React/AntD），(3) 配置组件模型（propsSchema、事件、动作），(4) 使用 neo-open-api 对接实体数据源或自定义 API，(5) 发布/拉取/删除前端组件，(6) 修改系统中已有的前端组件，(7) 获取和查询实体模型时，使用此技能。
+---
+
+# Neo 前端自定义组件开发
+
+基于 neo-cmp-cli 工具链，辅助完成 NeoCRM 平台前端自定义组件的开发全流程。
+
+## 前置条件
+
+- 已全局安装 neo-cmp-cli：`npm i -g neo-cmp-cli`
+- Node.js 环境
+
+## 重要约定
+
+- 组件目录名必须以 `__c` 结尾（如 `helloNeo__c`）
+- `neo login -e production` 默认登录生产环境。执行登录前必须询问用户要登录到哪个环境。环境参数：`production`、`gray`、`sandbox`、`cd`、`tencentuat`、`custom`
+- `neo login` 执行后自动打开浏览器授权，轮询 `.neo-cli/token.json` 确认登录成功
+- 执行 push/pull/delete 时直接执行，未登录失败后再询问环境并登录重试
+
+## 核心工作流
+
+### 1. 创建项目
+
+如果用户未指定项目名称，先询问。未指定路径则告知默认位置并询问是否修改。
+
+```bash
+neo create project -n <项目名称>
+```
+
+项目创建后将 `neo.config.js` 中 `neoConfig` 改为正式环境：
+```javascript
+neoConfig: {
+  neoBaseURL: 'https://crm.xiaoshouyi.com',
+  loginURL: 'https://login.xiaoshouyi.com/auc/oauth2/auth',
+  tokenURL: 'https://login.xiaoshouyi.com/auc/oauth2/token',
+},
+```
+
+### 2. 登录租户
+
+项目创建后，先询问用户要登录到哪个环境（默认 production），执行登录：
+```bash
+neo login -e <env>
+```
+轮询 `.neo-cli/token.json` 确认登录成功。
+
+### 3. 安装依赖
+
+登录成功后，安装前端依赖（开发前端组件前必须执行）：
+```bash
+cd <项目目录>
+npm install
+```
+
+### 4. 创建组件
+
+```bash
+neo create cmp --name <组件名称>
+```
+
+也可手动在 `src/components/` 下创建目录（目录名以 `__c` 结尾）。
+
+### 5. 组件开发
+
+开发前参考 [references/entityTable-example.md](references/entityTable-example.md) 了解最佳实践。
+
+核心文件：`index.tsx`（渲染逻辑）+ `model.ts`（设计器配置）
+
+开发组件时，如果用户没有明确要求可配置属性，model.ts 中的 `propsSchema` 和 `defaultComProps` 留空即可，不要主动添加可配置属性。
+
+详细指南见 [references/component-dev.md](references/component-dev.md)。
+
+### 6. 查看效果
+
+当前暂不支持本地预览，提示用户发布到租户后在自定义页面中查看。
+
+### 7. 授权与发布
+
+授权配置详见 [references/auth-config.md](references/auth-config.md)。
+
+```bash
+neo login -e production
+neo push cmp --name <组件名称>
+neo pull cmp --name <组件名称>
+neo delete cmp --name <组件名称>
+neo logout
+```
+
+## 修改系统中已有组件
+
+1. 本地没有则自动 `neo pull cmp --name <组件名称>`，拉取后自动读取代码
+2. 询问用户修改哪个组件
+3. 执行修改，参考 [references/entityTable-example.md](references/entityTable-example.md)
+4. 自动递增版本号并发布，修改完成后主动询问是否发布
+
+## 获取实体模型
+
+### 生成实体字典
+```bash
+python3 scripts/gen_entitylist.py <项目目录>
+```
+
+### 查询实体字段
+1. 在 `src/entity-model/entitylist.md` 中查找匹配实体
+2. 检查 `src/entity-model/<apiKey>.md` 是否存在
+3. 不存在则运行：`python3 scripts/gen_entity_desc.py <项目目录> <apiKey>`
+
+### 平台 API 参考
+
+所有 API 携带 `Authorization: Bearer <access_token>`。
+- 获取 model.jar：`GET /rest/metadata/v2.0/scripts/packages/model/jar/url`
+- 获取实体列表：`GET /rest/metadata/v2.0/xobjects/filter?custom=<true|false>&active=true`
+- 获取实体字段：`GET /rest/metadata/v2.0/xobjects/<apiKey>/items`
+
+## 命令速查
+
+| 命令 | 说明 |
+|------|------|
+| `neo create project` | 创建空项目 |
+| `neo create cmp` | 创建组件 |
+| `neo login -e <env>` / `neo logout` | 登录/登出 |
+| `neo push cmp` | 发布组件 |
+| `neo pull cmp` | 拉取组件 |
+| `neo delete cmp` | 删除组件 |
+
+## 注意事项
+
+- 组件目录名以 `__c` 结尾，根节点 class 名与目录名一致
+- 构建时自动剔除平台预置依赖（antd 4.9.4、react 16.x 等）
+- 发布时自动添加样式隔离
+- 当前暂不支持本地预览，需发布后查看
+- 自定义 API 的调用路径是 `/rest/data/v2.0/scripts/api/{baseUrl}/{path}`，不是 `/rest/custom/v2.0/`
+- `customApi.run` 返回的 `result.data` 可能是 JSON 字符串，需要 `typeof === 'string'` 时 `JSON.parse`
+- 开发涉及业务对象的功能前，必须先通过 `gen_entity_desc.py` 获取实体的真实字段模型
+- 可使用 `query_crm.py` 工具验证数据查询：`python3 scripts/query_crm.py <项目目录> "<SQL>"`
+- 平台预置依赖版本列表见 [references/component-dev.md](references/component-dev.md)

package/template/neo-bi-cmps/docs/neo-frontend-dev/references/auth-config.md

@@ -0,0 +1,77 @@
+# 授权配置
+
+与 NeoCRM 平台交互（push/pull/delete）前需配置授权。
+
+## 方式一：OAuth2 登录授权（推荐）
+
+```bash
+neo login
+```
+
+执行流程：
+1. 自动打开浏览器访问授权页面（如未自动打开，命令行会输出 URL，手动复制到浏览器）
+2. 输入 NeoCRM 账号密码并选择租户（此处选择的租户即为后续 push/pull/delete 的目标租户）
+3. 授权成功后自动跳转回本地
+4. Token 自动保存到项目目录的 `.neo-cli/token.json`
+
+> 此步骤需要用户在浏览器中手动完成，AI 无法自动执行。
+
+Token 有效期：
+- access_token：2 小时（过期前 5 分钟自动刷新）
+- refresh_token：30 天（过期需重新 `neo login`）
+
+登出：`neo logout`（清除本地 token）
+
+### 自定义环境配置
+
+在 `neo.config.js` 中配置（`neo login` 选择「自定义环境」时生效）：
+
+```javascript
+module.exports = {
+  neoConfig: {
+    neoBaseURL: 'https://crm-xx.xiaoshouyi.com',
+    loginURL: 'https://login-xx.xiaoshouyi.com/auc/oauth2/auth',
+    tokenURL: 'https://login-xx.xiaoshouyi.com/auc/oauth2/token',
+  },
+}
+```
+
+> 注意：Token 接口字段名在不同 CLI 版本中可能为 `tokenAPI` 或 `tokenURL`，两者等价。`neo init` 生成的模板中使用 `tokenURL`。
+
+## 方式二：密码授权
+
+在 `neo.config.js` 中配置：
+
+```javascript
+module.exports = {
+  neoConfig: {
+    neoBaseURL: 'https://crm-cd.xiaoshouyi.com',
+    tokenAPI: 'https://login-cd.xiaoshouyi.com/auc/oauth2/token',
+    authType: 'password',
+    auth: {
+      client_id: '<从连接器客户端信息获取>',
+      client_secret: '<从连接器客户端信息获取>',
+      username: '<销售易系统用户名>',
+      password: '<账号密码 + 8位安全令牌，直接拼接>'
+    },
+  },
+}
+```
+
+获取方式：
+- client_id / client_secret：通过 [销售易文档中心](https://doc.xiaoshouyi.com) 创建连接器获取
+- 安全令牌：销售易文档中心 → OAuth安全认证 → 密码模式 → 获取令牌
+
+## 两种模式对比
+
+| 特性 | OAuth2 | 密码模式 |
+|------|--------|---------|
+| 安全性 | 高（无需存储密码） | 较低 |
+| Token 有效期 | 2 小时（自动刷新） | 永不过期 |
+| 推荐程度 | ⭐⭐⭐⭐⭐ | ⭐⭐⭐ |
+
+## 常见问题
+
+- 浏览器无法自动打开：命令行会输出授权 URL，手动复制到浏览器
+- Token 刷新失败：refresh_token 过期（30 天），重新 `neo login`
+- 授权后未跳回 redirect_uri：可能被浏览器插件（如 Neo UI Extension）影响，关闭后重试

package/template/neo-bi-cmps/docs/neo-frontend-dev/references/component-dev.md

@@ -0,0 +1,205 @@
+# 组件开发指南
+
+## 目录
+
+- [组件模型配置](#组件模型配置)
+- [使用平台实体数据源](#使用平台实体数据源)
+- [使用平台自定义 API](#使用平台自定义-api)
+- [添加事件与动作](#添加事件与动作)
+- [平台预置依赖](#平台预置依赖)
+- [样式隔离](#样式隔离)
+
+## 组件模型配置
+
+组件目录名必须以 `__c` 结尾（如 `helloNeocrm__c`），这是 NeoCRM 平台的命名约定。CLI 会自动扫描 `src/components/` 下的子目录，以目录名作为组件标识，`index.ts/.tsx/.js/.jsx` 作为组件入口，`model.[tj]s` 作为模型文件。
+
+组件模型文件（`model.ts`）定义组件在页面设计器中的配置信息：
+
+| 属性 | 默认值 | 说明 |
+|------|--------|------|
+| cmpType | 自动生成（组件目录名） | 组件唯一标识 |
+| label | - | 设计器面板中展示的名称 |
+| description | - | 设计器面板中展示的描述 |
+| iconUrl | - | 设计器面板中展示的图标 |
+| tags | ['自定义组件'] | 分类标签 |
+| exposedToDesigner | true | 是否在设计器中可见 |
+| enableDuplicate | true | 是否允许多次使用 |
+| targetPage | ['all'] | 适配的页面类型 |
+| targetObject | ['all'] | 支持的实体类型 |
+| targetApplication | ['all'] | 支持的应用类型 |
+| targetDevice | 'all' | 支持的设备类型 |
+| defaultComProps | - | 初次插入页面的默认属性 |
+| propsSchema | - | 定义可配置属性面板 |
+
+targetPage 可选值：`all`、`indexPage`、`entityListPage`、`entityFormPage`、`entityDetailPage`、`customPage`、`bizPage`
+
+propsSchema 配置项类型参考 [neo-register](https://www.npmjs.com/package/neo-register)。
+
+## 使用平台实体数据源
+
+通过 `neo-open-api` 的 `xObject` 对接平台实体数据：
+
+```typescript
+import { xObject } from 'neo-open-api';
+
+// 查询
+const { data } = await xObject.query({
+  xObjectApiKey: 'Contact',
+  fields: ['name', 'phone', 'email'],
+  page: 1,
+  pageSize: 20,
+  orderBy: 'createdAt desc'
+});
+
+// 创建
+const { data: newRecord } = await xObject.create('Contact', {
+  data: { name: '张三', phone: '13800138000' }
+});
+
+// 更新
+await xObject.update('Contact', recordId, {
+  data: { name: '张三（更新）' }
+});
+
+// 获取详情
+const { data: detail } = await xObject.get('Contact', recordId);
+
+// 删除
+await xObject.delete('Contact', recordId);
+```
+
+## 使用平台自定义 API
+
+通过 `neo-open-api` 的 `customApi` 调用自定义接口：
+
+```typescript
+import { customApi } from 'neo-open-api';
+
+const result = await customApi.run({
+  apiUrl: '/rest/custom/api/endpoint',
+  methodType: 'POST',  // 可选，默认 POST
+  data: { key1: 'value1' }
+});
+// result: { status: boolean, code, msg, data }
+```
+
+## 添加事件与动作
+
+### 可触发事件
+
+1. 组件中用 `@NeoEvent.dispatch` 声明事件方法：
+
+```typescript
+// @ts-ignore
+import { NeoEvent } from 'neo-ui-common';
+
+@NeoEvent.dispatch
+onSubmit() {
+  console.log('触发表单提交事件');
+}
+```
+
+2. 模型中声明事件列表：
+
+```typescript
+events = [
+  {
+    apiKey: 'onSubmit',       // 与组件方法名一致
+    label: '提交表单后',
+    helpText: '表单提交后触发该事件',
+  },
+];
+```
+
+### 可执行动作（组件函数）
+
+1. 组件中用 `@NeoEvent.function` 声明动作方法：
+
+```typescript
+// @ts-ignore
+import { NeoEvent } from 'neo-ui-common';
+
+@NeoEvent.function
+async loadData(page = 1, pageSize = 10) {
+  // 加载数据逻辑
+}
+```
+
+2. 模型中声明函数列表：
+
+```typescript
+functions = [
+  {
+    apiKey: 'loadData',
+    label: '刷新表格',
+    helpTextKey: '刷新当前表格数据',
+  },
+  {
+    apiKey: 'handleDelete',
+    label: '删除记录',
+    helpTextKey: '删除指定记录',
+    funcInParams: [
+      { apiKey: 'id', label: '记录ID', type: 'String', required: true },
+    ],
+  },
+];
+```
+
+### 广播事件（不推荐）
+
+优先使用上述声明式事件/动作。如确需广播：
+
+```typescript
+// @ts-ignore
+import { NeoEvent } from 'neo-ui-common';
+
+// 触发
+NeoEvent.broadcast('eventName', data);
+
+// 监听
+NeoEvent.listen('eventName', (eventData) => { /* ... */ });
+```
+
+## 平台预置依赖
+
+构建时自动剔除以下依赖（平台已预置，组件中直接 import 即可）：
+
+| 依赖包 | 版本 |
+|--------|------|
+| react / react-dom | ^16.13.1 |
+| mobx | ^6.3.0 |
+| mobx-react | ^7.0.0 |
+| mobx-state-tree | ^5.4.0 |
+| echarts | 5.4.2 |
+| antd | 4.9.4 |
+| antd-mobile | 2.3.4 |
+| @ant-design/icons | ^4.8.0 |
+| axios | ^0.27.2 |
+| lodash | ^4.17.21 |
+| classnames | ^2.3.2 |
+| qs | ^6.11.0 |
+| neo-ui-component-web | ^1.0.0 |
+| neo-ui-common | ^1.0.0 |
+| neo-open-api | ^1.1.9 |
+| amis | ^1.1.5 |
+| video-react | 0.14.1 |
+
+> 组件中使用的版本需与平台预置版本匹配，否则运行时可能异常。
+
+## 样式隔离
+
+发布和 linkDebug 时自动给组件添加样式隔离（处理 `(index|style).(scss|less)` 文件）。
+
+要求：组件根节点的 class 名需与组件目录名一致（如组件目录为 `helloNeocrm__c`，则根节点 class 应为 `helloNeocrm__c`），否则根节点样式失效。
+
+Sass 注意事项：样式隔离处理时，scss 中使用 `/` 做除法会触发 Dart Sass 2.0 废弃警告，建议改用 `math.div()` 或 `calc()`。
+
+关闭样式隔离：在 `neo.config.js` 中设置：
+
+```javascript
+module.exports = {
+  webpack: {
+    disableAutoAddStyleScope: true
+  }
+}
+```