@easyv/screen-cli 0.1.1 → 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -6
- package/bin/postinstall.js +9 -0
- package/dist/commands/component.js +37 -8
- package/dist/commands/skills.js +10 -41
- package/dist/commands/update.js +17 -0
- package/dist/config.js +5 -0
- package/dist/index.js +11 -2
- package/dist/package-info.js +17 -0
- package/dist/postinstall.js +15 -0
- package/dist/skills-install.js +68 -0
- package/dist/update-check.js +167 -0
- package/package.json +2 -1
- package/skills/easyv-component-dev/SKILL.md +7 -9
- package/skills/easyv-component-dev/references/assets.md +81 -0
- package/skills/easyv-component-dev/references/component-spec.md +23 -17
- package/skills/easyv-component-dev/references/configuration.md +655 -0
- package/skills/easyv-screen-build/SKILL.md +23 -9
- package/skills/easyv-screen-build/references/component-selection.md +182 -0
- package/skills/easyv-screen-edit/SKILL.md +4 -1
- package/skills/easyv-screen-shared/SKILL.md +1 -0
- package/spec/openapi.v1.yaml +151 -8
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
# 静态资源
|
|
2
|
+
|
|
3
|
+
图片、视频、音频、字体和模型都先上传,再把相对路径写进配置。组件渲染时用平台注入的 `window.appConfig.ASSETS_URL` 拼成可访问地址。
|
|
4
|
+
|
|
5
|
+
官方图片组件 `imageV2` 就是这个用法:配置项存相对路径,`<img>` 的 `src` 用 `window.appConfig.ASSETS_URL + componentUrl`。
|
|
6
|
+
|
|
7
|
+
## 上传
|
|
8
|
+
|
|
9
|
+
调用 OpenAPI 的 `uploadAsset`。`spec/openapi.v1.yaml` 里的 path 是 `/assets`,要接在服务前缀后面,完整请求是 `POST /api/easyv/open/v1/assets`。`multipart/form-data`,字段名是 `file`。调用方不指定存储路径,服务端生成 `spaces/{spaceId}/openapi-assets/{yyyyMM}/{随机名}{扩展名}`。
|
|
10
|
+
|
|
11
|
+
返回两个地址:
|
|
12
|
+
|
|
13
|
+
| 字段 | 含义 | 用在哪 |
|
|
14
|
+
| --- | --- | --- |
|
|
15
|
+
| `path` | 相对路径,对象存储的 key | 写入配置项的 `value` |
|
|
16
|
+
| `url` | 资源域名加 `path` 的绝对地址 | 当场预览。不写入配置 |
|
|
17
|
+
|
|
18
|
+
`path` 不以 `/` 开头,例如 `spaces/10/openapi-assets/202611/Ab3xYz9kQ2LmNoPq.png`。
|
|
19
|
+
|
|
20
|
+
允许的扩展名:`.png` `.jpg` `.jpeg` `.gif` `.webp` `.svg` `.bmp` `.ico` `.mp4` `.webm` `.mp3` `.wav` `.ttf` `.otf` `.woff` `.woff2` `.json` `.csv` `.txt`。大小上限以 `GET /meta` 的 `limits.assetMaxBytes` 为准,当前 20MB。空文件视为未上传。
|
|
21
|
+
|
|
22
|
+
## 配置项
|
|
23
|
+
|
|
24
|
+
`path` 写进组件 `main.json` 的配置项,`value` 填这个相对路径,`type` 用对应控件。
|
|
25
|
+
|
|
26
|
+
| 资源 | type | value |
|
|
27
|
+
| --- | --- | --- |
|
|
28
|
+
| 图片 | `image` | 相对路径 |
|
|
29
|
+
| 视频 | `video` | 相对路径 |
|
|
30
|
+
| 音频 | `audio` | 相对路径 |
|
|
31
|
+
| 模型 | `uploadModel` | 相对路径 |
|
|
32
|
+
| 其他文件 | `model` | 相对路径 |
|
|
33
|
+
|
|
34
|
+
`image` 与旧组件里的 `uploadImage` 是同一个上传控件。新组件用 `image`。`imageV2` 的配置项类型是 `uploadImage`,值同样是相对路径:`components/static-image/image/default.png`。
|
|
35
|
+
|
|
36
|
+
```json
|
|
37
|
+
{
|
|
38
|
+
"name": "url",
|
|
39
|
+
"displayName": "图片",
|
|
40
|
+
"type": "image",
|
|
41
|
+
"value": "spaces/10/openapi-assets/202611/Ab3xYz9kQ2LmNoPq.png"
|
|
42
|
+
}
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
`config.accept` 是字符串数组,写法与 HTML 文件输入的 `accept` 相同,用来收窄类型。不写时 `image`、`video`、`audio` 分别对应 `image/*`、`video/*`、`audio/*`。
|
|
46
|
+
|
|
47
|
+
配置面板预览时,平台自己用资源前缀拼 `value`。所以 `value` 里只放相对路径。
|
|
48
|
+
|
|
49
|
+
## 组件内拼接
|
|
50
|
+
|
|
51
|
+
`window.appConfig.ASSETS_URL` 由平台注入,是当前环境的资源前缀,末尾带 `/`。相对路径直接接在后面,中间不要再加 `/`。
|
|
52
|
+
|
|
53
|
+
`imageV2` 的取值:
|
|
54
|
+
|
|
55
|
+
```jsx
|
|
56
|
+
const dataUrl = data && data[0] && data[0].url
|
|
57
|
+
const componentUrl = configuration.chart.url
|
|
58
|
+
|
|
59
|
+
<img src={dataUrl || window.appConfig.ASSETS_URL + componentUrl} />
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
配置里的地址走 `window.appConfig.ASSETS_URL + path`。已经是 `http://` 或 `https://` 的地址原样使用,再拼一次会变成双前缀。
|
|
63
|
+
|
|
64
|
+
```jsx
|
|
65
|
+
function assetSrc(path) {
|
|
66
|
+
if (!path) return ''
|
|
67
|
+
if (/^https?:\/\//i.test(path)) return path
|
|
68
|
+
return window.appConfig.ASSETS_URL + path
|
|
69
|
+
}
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
视频、音频同样处理,例如 `<video src={assetSrc(configuration.chart.video)} />`。
|
|
73
|
+
|
|
74
|
+
## 配置和数据
|
|
75
|
+
|
|
76
|
+
| 来源 | 存什么 | 渲染 |
|
|
77
|
+
| --- | --- | --- |
|
|
78
|
+
| 配置项 `value` | 上传得到的 `path` | `window.appConfig.ASSETS_URL + path` |
|
|
79
|
+
| 静态数据或数据源字段 | 完整绝对地址 | 原样作为 `src` |
|
|
80
|
+
|
|
81
|
+
`imageV2` 优先用数据里的 `url`,没有数据时再用配置里的相对路径。绝对地址写在数据里可以显示,但域名绑死在上传时的环境,换环境导入导出后会失效。能上传并用相对路径的,写进配置项。
|
|
@@ -29,7 +29,7 @@ src/components/<module_name>/
|
|
|
29
29
|
|
|
30
30
|
### configuration
|
|
31
31
|
|
|
32
|
-
|
|
32
|
+
配置项数组。平台用它生成右侧配置面板,再按 `name` 归约成对象。组件从 `props.configuration` 读取,分组会变成嵌套对象。
|
|
33
33
|
|
|
34
34
|
```json
|
|
35
35
|
{
|
|
@@ -40,21 +40,7 @@ src/components/<module_name>/
|
|
|
40
40
|
}
|
|
41
41
|
```
|
|
42
42
|
|
|
43
|
-
|
|
44
|
-
`range` 滑块、`image` 图片、`boolean` 开关。下拉和单选的选项放在 `config.options`,
|
|
45
|
-
每项是 `{ "name": "显示名", "value": "值" }`。
|
|
46
|
-
|
|
47
|
-
分组用一个配置项包住子项:
|
|
48
|
-
|
|
49
|
-
```json
|
|
50
|
-
{
|
|
51
|
-
"name": "style",
|
|
52
|
-
"displayName": "样式",
|
|
53
|
-
"value": [
|
|
54
|
-
{ "name": "color", "displayName": "颜色", "value": "#3ba0ff", "type": "color" }
|
|
55
|
-
]
|
|
56
|
-
}
|
|
57
|
-
```
|
|
43
|
+
控件类型、`config`、分组、显隐规则和运行时取值见 [configuration.md](configuration.md)。图片、视频等资源的 `value` 存相对路径,拼接方式见 [assets.md](assets.md)。
|
|
58
44
|
|
|
59
45
|
### triggers
|
|
60
46
|
|
|
@@ -76,6 +62,25 @@ src/components/<module_name>/
|
|
|
76
62
|
}
|
|
77
63
|
```
|
|
78
64
|
|
|
65
|
+
只在 `main.json` 里声明不会生效。平台执行动作时,向 `document` 派发一个事件,组件必须自己监听并处理。事件名是 **动作的 `value`、下划线、组件实例 `id`** 拼起来的:动作 `setValue`、实例 id 为 `123` 时,事件名是 `setValue_123`。`id` 用 `props.id`,每个实例不同,所以监听名要带上它。
|
|
66
|
+
|
|
67
|
+
在 `useEffect` 里注册,卸载时移除。一个动作一个监听;多个动作就注册多个事件名。
|
|
68
|
+
|
|
69
|
+
事件上有两处参数,按动作声明方式取:
|
|
70
|
+
|
|
71
|
+
- `config` 里填的参数在 `e.data` 上,字段名就是 `config` 里的 `name`。上面的 `setValue` 读 `e.data.value`。
|
|
72
|
+
- 动作用 `useFnConfig` 声明数据函数时(交互里写一段 `return` 算出要传的值),结果在 `e.dynamicData` 上。
|
|
73
|
+
|
|
74
|
+
```jsx
|
|
75
|
+
useEffect(() => {
|
|
76
|
+
const onSetValue = (e) => {
|
|
77
|
+
if (e.data && e.data.value != null) setValue(e.data.value);
|
|
78
|
+
};
|
|
79
|
+
document.addEventListener(`setValue_${id}`, onSetValue, false);
|
|
80
|
+
return () => document.removeEventListener(`setValue_${id}`, onSetValue);
|
|
81
|
+
}, [id]);
|
|
82
|
+
```
|
|
83
|
+
|
|
79
84
|
## main.data.json
|
|
80
85
|
|
|
81
86
|
```json
|
|
@@ -113,7 +118,8 @@ export default function (props) {
|
|
|
113
118
|
- 根节点必须带 `className="__easyv-component"` 和 `id`。
|
|
114
119
|
- `data` 是当前数据,静态或来自数据源,按 `main.data.json` 的结构使用。
|
|
115
120
|
- `emit('<trigger>', payload)` 触发一个在 `triggers` 里声明的事件。
|
|
116
|
-
-
|
|
121
|
+
- `actions` 里声明的动作要监听 `document` 上的 `<value>_<id>`,见上面「actions」。
|
|
122
|
+
- 配置里的图片、视频等相对路径,渲染前拼上 `window.appConfig.ASSETS_URL`。数据里的绝对地址原样使用。见 [assets.md](assets.md)。
|
|
117
123
|
|
|
118
124
|
## 打包与发布
|
|
119
125
|
|