neo-cmp-cli 1.13.13 → 1.13.16

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

@@ -1,167 +0,0 @@
-# entityTable__c 参考实现
-
-这是一个完整的实体数据表格组件示例，支持增删改查操作。开发新组件前参考此实现了解最佳实践。
-
-## 目录
-
-- [关键设计模式](#关键设计模式)
-- [组件代码](#组件代码)
-- [模型代码](#模型代码)
-- [样式代码](#样式代码)
-
-## 关键设计模式
-
-### 1. 使用 xObjectDataApi 配置项对接实体数据源
-
-模型中使用 `type: 'xObjectDataApi'` 配置项，让设计器提供实体选择和字段选择的 UI：
-
-```typescript
-propsSchema = [
-  {
-    type: 'xObjectDataApi',
-    name: 'xObjectDataApi',
-    label: '实体数据源',
-    value: {
-      xObjectApiKey: 'customContact__c',
-      fields: ['name', 'phone__c'],
-    },
-    custom: true,  // true 表示自定义实体
-  },
-];
-```
-
-组件通过 `this.props.xObjectDataApi` 获取配置，包含：
-- `xObjectApiKey`：实体 API Key
-- `fields`：选中的字段列表
-- `fieldDescList`：字段描述信息（平台自动注入）
-- `pageSize` / `page`：分页参数
-
-### 2. 动态获取字段描述
-
-通过 `xObject.getDesc()` 获取实体的字段元数据，用于动态生成表格列和表单：
-
-```typescript
-const resultData = await xObject.getDesc(xObjectApiKey);
-const fieldList = resultData.data.fields; // 包含 apiKey, label, type, required 等
-```
-
-### 3. 根据字段类型渲染表单控件
-
-根据 `field.type` 动态选择输入组件：
-- `picklist` → Select 单选
-- `multipicklist` → Select 多选
-- `textarea` → Input.TextArea
-- `datetime` / `date` / `time` → DatePicker
-- `int` / `float` → InputNumber
-- `entityType` → Select（业务类型列表）
-- 默认 → Input
-
-### 4. 声明组件函数（可执行动作）
-
-使用 `@NeoEvent.function` 装饰器声明可被其他组件调用的动作：
-
-```typescript
-@NeoEvent.function
-async loadData(page = 1, pageSize = 10) { ... }
-```
-
-模型中声明函数列表：
-
-```typescript
-functions = [
-  { apiKey: 'loadData', label: '刷新表格', helpTextKey: '刷新当前表格数据' },
-  {
-    apiKey: 'handleDelete', label: '删除记录', helpTextKey: '删除指定记录',
-    funcInParams: [
-      { apiKey: 'id', label: '记录ID', type: 'String', required: true },
-    ],
-  },
-];
-```
-
-### 5. 使用 panelSwitch 配置开关
-
-```typescript
-{ type: 'panelSwitch', name: 'showAddButton', label: '显示新增按钮' },
-```
-
-### 6. componentDidUpdate 响应配置变化
-
-当设计器中修改了 xObjectDataApi 配置时，组件需要重新加载数据：
-
-```typescript
-async componentDidUpdate(prevProps) {
-  if (xObjectApiKey !== prevXObjectApiKey || !isEqual(fields, prevFields)) {
-    await this.loadFieldList();
-    this.loadData(page, pageSize);
-  }
-}
-```
-
-## 组件代码
-
-```typescript
-// index.tsx 关键结构
-import { Table, Button, Space, Modal, Form, Input, Select, message, Popconfirm, Spin, Empty, Card } from 'antd';
-import { PlusOutlined, EditOutlined, DeleteOutlined, ReloadOutlined } from '@ant-design/icons';
-import { xObject } from 'neo-open-api';
-import { BaseCmp, NeoEvent } from 'neo-ui-common';
-
-interface EntityTableProps {
-  xObjectDataApi: {
-    xObjectApiKey: string;
-    fields: string[];
-    fieldDescList?: any[];
-    pageSize?: number;
-    page?: number;
-  };
-  showAddButton?: boolean;
-  showEditButton?: boolean;
-  showDeleteButton?: boolean;
-  className?: string;
-}
-
-// 组件继承 BaseCmp，实现 CRUD 操作
-// 使用 xObject.query / create / update / delete 对接平台数据
-// 使用 xObject.getDesc 获取字段元数据
-// 使用 xObject.getEntityTypeList 获取业务类型列表
-```
-
-## 模型代码
-
-```typescript
-// model.ts 关键配置
-export class EntityTableModel {
-  label = '实体数据表格';
-  description = '基于 XObject 的数据表格组件，支持增删改查操作';
-  targetPage = ['all'];
-  targetDevice = 'web';
-
-  defaultComProps = {
-    showAddButton: true,
-    showEditButton: true,
-    showDeleteButton: true,
-    xObjectDataApi: {
-      xObjectApiKey: 'customContact__c',
-      fields: ['name', 'phone__c'],
-    },
-  };
-
-  // 组件函数声明
-  functions = [
-    { apiKey: 'loadData', label: '刷新表格' },
-    { apiKey: 'handleDelete', label: '删除记录', funcInParams: [...] },
-  ];
-
-  propsSchema = [
-    { type: 'xObjectDataApi', name: 'xObjectDataApi', label: '实体数据源', custom: true },
-    { type: 'panelSwitch', name: 'showAddButton', label: '显示新增按钮' },
-    { type: 'panelSwitch', name: 'showEditButton', label: '显示编辑按钮' },
-    { type: 'panelSwitch', name: 'showDeleteButton', label: '显示删除按钮' },
-  ];
-}
-```
-
-## 样式代码
-
-组件根节点 class 为 `entityTable__c`（与目录名一致），使用 Card 包裹，包含响应式设计（768px / 576px 断点）。

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

@@ -1,38 +0,0 @@
-# 内置模板
-
-执行 `neo init` 时可选择以下模板，也可通过 `-t <类型> -n <名称>` 非交互创建。
-
-| 模板类型 | 说明 | 适用场景 |
-|----------|------|----------|
-| `neo-web-cmps` | Web 端列表组件模板 | 基础大列表、Picker 列表等 |
-| `neo-h5-cmps` | H5 端业务组件模板 | 全局搜索、数据列表、数据 Tabs、AI 对话页等 |
-| `neo` | 自定义业务组件模板 | 实体表单、实体详情、实体表格等 |
-| `neo-bi-cmps` | 数值指标组件模板 | 展示实体数据源中关键数值指标 |
-| `echarts` | ECharts 图表组件模板 | 基于 ECharts 的图表（地图场景用 `amap`） |
-| `antd` | Ant Design 组件模板 | 数据仪表板、搜索组件等 |
-| `amap` | 高德地图组件模板 | 基于高德地图 API 的地图组件 |
-| `vue2` | Vue2 组件模板 | 基于 Vue2 的组件 |
-
-## 选择建议
-
-- 需要实体数据 CRUD → `neo`
-- 需要图表可视化 → `echarts`
-- 需要地图展示 → `amap`
-- 需要丰富 UI 组件库 → `antd`
-- H5 移动端场景 → `neo-h5-cmps`
-- Web 端列表场景 → `neo-web-cmps`
-- BI 数值指标展示 → `neo-bi-cmps`
-- Vue 技术栈 → `vue2`
-
-## 非交互创建示例
-
-```bash
-neo init -t neo -n myBizCmp
-neo init -t echarts -n myChartCmp
-neo init -t antd -n myAntdCmp
-neo init -t amap -n myMapCmp
-neo init -t vue2 -n myVue2Cmp
-neo init -t neo-web-cmps -n myWebListCmp
-neo init -t neo-h5-cmps -n myH5Cmp
-neo init -t neo-bi-cmps -n myBiCmp
-```

package/template/neo-bi-cmps/docs/neo-frontend-dev/scripts/gen_entity_desc.py

@@ -1,69 +0,0 @@
-#!/usr/bin/env python3
-"""
-生成实体字段描述：通过 API 获取指定实体的字段信息，输出 <apiKey>.md
-用法: python3 gen_entity_desc.py <项目目录> <实体apiKey>
-示例: python3 gen_entity_desc.py NEOTrail investment__c
-"""
-import sys, os, json, urllib.request
-
-if len(sys.argv) < 3:
-    print("用法: python3 gen_entity_desc.py <项目目录> <实体apiKey>")
-    sys.exit(1)
-
-project_dir = sys.argv[1]
-api_key = sys.argv[2]
-token_path = os.path.join(project_dir, '.neo-cli/token.json')
-output_dir = os.path.join(project_dir, 'src/entity-model')
-
-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. 获取实体信息
-print("获取实体信息: %s ..." % api_key)
-try:
-    entity_data = api_get('/rest/metadata/v2.0/xobjects/' + api_key)
-    entity = entity_data.get('data', {}).get('records', {})
-    entity_label = entity.get('label', api_key)
-except Exception as e:
-    print("错误: 获取实体信息失败: %s" % e)
-    entity_label = api_key
-
-# 2. 获取字段列表
-print("获取字段列表 ...")
-try:
-    fields_data = api_get('/rest/metadata/v2.0/xobjects/' + api_key + '/items')
-    fields = fields_data.get('data', {}).get('records', [])
-except Exception as e:
-    print("错误: 获取字段列表失败: %s" % e)
-    sys.exit(1)
-
-# 3. 生成 <apiKey>.md
-os.makedirs(output_dir, exist_ok=True)
-
-lines = ['# %s (%s)' % (entity_label, api_key), '',
-    '| 字段名称 | API Key | 字段类型 | 是否标准字段 |',
-    '|----------|---------|----------|------------|']
-for f in fields:
-    fk = f.get('apiKey', '')
-    label = f.get('label', '')
-    ftype = f.get('type', '')
-    is_std = '是' if not fk.endswith('__c') else '否'
-    lines.append('| %s | %s | %s | %s |' % (label, fk, ftype, is_std))
-
-output_path = os.path.join(output_dir, api_key + '.md')
-with open(output_path, 'w', encoding='utf-8') as f:
-    f.write('\n'.join(lines))
-
-print("完成: %s (%s, %d 个字段)" % (output_path, entity_label, len(fields)))

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

@@ -1,87 +0,0 @@
-#!/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-frontend-dev/scripts/query_crm.py

@@ -1,65 +0,0 @@
-#!/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)