@qfei-design/make-ai-assistant 0.2.8 → 0.2.10
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/PUBLIC_API.md +20 -27
- package/README.md +16 -29
- package/capabilities.json +36 -9
- package/dist/conversation-CZfbgCXd.js +1111 -0
- package/dist/conversation-Cvh-IVRV.cjs +1 -0
- package/dist/core/conversation-management.d.ts +212 -0
- package/dist/core/conversation.d.ts +34 -2
- package/dist/core/index.d.ts +2 -0
- package/dist/core/response-state.d.ts +8 -0
- package/dist/index.cjs +1 -1
- package/dist/index.mjs +4 -4
- package/dist/make-app/protocol.d.ts +27 -0
- package/dist/make-app/stream.d.ts +20 -0
- package/dist/make-app.cjs +1 -1
- package/dist/make-app.d.ts +46 -11
- package/dist/make-app.mjs +698 -259
- package/dist/make-console.cjs +1 -1
- package/dist/make-console.mjs +1 -1
- package/dist/react/conversation-controls.d.ts +15 -0
- package/dist/react/theme.d.ts +1 -1
- package/dist/react/use-attachments.d.ts +26 -0
- package/dist/react/use-conversation-manager.d.ts +35 -0
- package/dist/react.cjs +4 -4
- package/dist/react.mjs +1712 -747
- package/dist/sse.cjs +1 -1
- package/dist/sse.mjs +1 -1
- package/dist/styles.css +61 -10
- package/docs/backend-contract.md +8 -21
- package/docs/make-app-integration.md +80 -0
- package/examples/make-app/README.md +11 -0
- package/examples/make-app/index.html +5 -0
- package/examples/make-app/main.tsx +34 -0
- package/examples/make-app/style.css +4 -0
- package/examples/make-app/transport.ts +163 -0
- package/examples/make-app/vite.config.ts +7 -0
- package/package.json +10 -2
- package/recipes.json +36 -13
- package/dist/conversation-B7eGUXi-.js +0 -727
- package/dist/conversation-Cv1wdvCR.cjs +0 -1
package/dist/sse.cjs
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const b=require("./conversation-
|
|
1
|
+
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const b=require("./conversation-Cvh-IVRV.cjs"),S=1e6,u=e=>typeof e=="object"&&e!==null&&!Array.isArray(e),p=(e,t,r)=>{const a=Object.keys(e).find(s=>s.toLowerCase()===t.toLowerCase());a&&delete e[a],e[t]=r},A=e=>{const t={};return Array.isArray(e)?e.forEach(([r,a])=>p(t,r,a)):e&&typeof e.forEach=="function"?e.forEach((r,a)=>p(t,a,r)):e&&Object.entries(e).forEach(([r,a])=>p(t,r,a)),p(t,"Accept","text/event-stream"),p(t,"Content-Type","application/json"),t},I=(e,t)=>{if(!u(t))throw new Error("Invalid assistant SSE event: data");if(Object.prototype.hasOwnProperty.call(t,"type"))throw new Error("Invalid assistant SSE event: unsupported field");try{return b.parseAssistantEvent({...t,type:e})}catch(r){throw r instanceof Error&&r.message.startsWith("Invalid assistant event")?new Error(r.message.replace("Invalid assistant event","Invalid assistant SSE event")):r}},w=e=>{if(!e.trim())return;const t=e.split(`
|
|
2
2
|
`),r=t.find(n=>n.startsWith("event:"))?.slice(6).trim(),a=t.filter(n=>n.startsWith("data:")).map(n=>n.slice(5).trimStart()).join(`
|
|
3
3
|
`);if(t.some(n=>n.startsWith("event:")||n.startsWith("data:"))){if(!r||!a)throw new Error("Invalid assistant SSE event: missing event or data");try{return I(r,JSON.parse(a))}catch(n){throw n instanceof Error&&n.message.startsWith("Invalid assistant SSE event")?n:new Error("Invalid assistant SSE event: JSON")}}};async function*T(e,t,r=S){if(!e.body)throw new Error("当前运行环境无法读取 AI 助手流式响应");const a=e.body.getReader(),s=new TextDecoder;let n="",d=!1,h=!1,l;const c=()=>(l??=a.cancel().catch(o=>{console.error("[make-ai-assistant] SSE reader cancellation failed",{errorType:o instanceof Error?o.name:typeof o})}),l),f=()=>{c()};t?.addEventListener("abort",f,{once:!0});const m=o=>{const i=o.type==="error"||o.type==="run.cancelled"||o.type==="run.complete";return h||=i,i};try{for(;;){if(t?.aborted)throw new DOMException("Aborted","AbortError");const o=await a.read();if(t?.aborted)throw new DOMException("Aborted","AbortError");let i=s.decode(o.value,{stream:!o.done});d&&(i=`\r${i}`,d=!1),!o.done&&i.endsWith("\r")&&(i=i.slice(0,-1),d=!0),o.done&&d&&(i+="\r",d=!1),n+=i.replace(/\r\n|\r/g,`
|
|
4
4
|
`);let E=n.indexOf(`
|
package/dist/sse.mjs
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { l as b } from "./conversation-CZfbgCXd.js";
|
|
2
2
|
const S = 1e6, u = (e) => typeof e == "object" && e !== null && !Array.isArray(e), E = (e, t, r) => {
|
|
3
3
|
const a = Object.keys(e).find(
|
|
4
4
|
(s) => s.toLowerCase() === t.toLowerCase()
|
package/dist/styles.css
CHANGED
|
@@ -3,14 +3,14 @@
|
|
|
3
3
|
--make-ai-internal-accent-strong: var(--make-ai-theme-primary-hover, var(--make-ai-accent-strong, var(--make-color-primary-hover, color-mix(in srgb, var(--make-ai-internal-accent) 84%, var(--make-ai-internal-text)))));
|
|
4
4
|
--make-ai-internal-on-accent: var(--make-ai-theme-on-primary, var(--make-ai-on-accent, #fcfcff));
|
|
5
5
|
--make-ai-internal-accent-soft: var(--make-ai-accent-soft, color-mix(in srgb, var(--make-ai-internal-accent) 10%, var(--make-ai-internal-bg)));
|
|
6
|
-
--make-ai-internal-bg: #
|
|
6
|
+
--make-ai-internal-bg: var(--make-ai-theme-bg, var(--make-ai-bg, var(--make-color-bg, color-mix(in srgb, var(--make-ai-internal-accent) 2%, #fcfcff))));
|
|
7
7
|
--make-ai-internal-surface: #fff;
|
|
8
8
|
--make-ai-internal-surface-strong: #f1f4f9;
|
|
9
9
|
--make-ai-internal-text: #15233d;
|
|
10
10
|
--make-ai-internal-text-secondary: #738096;
|
|
11
11
|
--make-ai-internal-border: #dbe3ef;
|
|
12
|
-
--make-ai-internal-
|
|
13
|
-
--make-ai-internal-
|
|
12
|
+
--make-ai-internal-scrollbar-thumb: #9aa0a8;
|
|
13
|
+
--make-ai-internal-scrollbar-thumb-hover: #7b8490;
|
|
14
14
|
--make-ai-internal-success: var(--make-ai-success, var(--make-color-success, #1a9a61));
|
|
15
15
|
--make-ai-internal-warning: var(--make-ai-warning, var(--make-color-warning, #c77b00));
|
|
16
16
|
--make-ai-internal-danger: var(--make-ai-danger, var(--make-color-danger, #d04444));
|
|
@@ -280,7 +280,7 @@
|
|
|
280
280
|
|
|
281
281
|
.make-ai-assistant__header {
|
|
282
282
|
align-items: center;
|
|
283
|
-
background: var(--make-ai-internal-
|
|
283
|
+
background: var(--make-ai-internal-bg);
|
|
284
284
|
border-bottom: 1px solid var(--make-ai-internal-border);
|
|
285
285
|
display: grid;
|
|
286
286
|
gap: 8px;
|
|
@@ -682,10 +682,10 @@
|
|
|
682
682
|
}
|
|
683
683
|
|
|
684
684
|
.make-ai-assistant__message--user .make-ai-assistant__bubble {
|
|
685
|
-
background: var(--make-ai-internal-
|
|
686
|
-
border: 1px solid var(--make-ai-internal-
|
|
685
|
+
background: color-mix(in srgb, var(--make-ai-internal-accent) 4%, var(--make-ai-internal-bg));
|
|
686
|
+
border: 1px solid color-mix(in srgb, var(--make-ai-internal-accent) 7%, var(--make-ai-internal-border));
|
|
687
687
|
border-radius: 16px 5px 16px 16px;
|
|
688
|
-
color: var(--make-ai-internal-
|
|
688
|
+
color: color-mix(in srgb, var(--make-ai-internal-text) 82%, var(--make-ai-internal-accent));
|
|
689
689
|
font-size: var(--make-ai-internal-font-size-heading);
|
|
690
690
|
line-height: var(--make-ai-internal-line-height-heading);
|
|
691
691
|
padding: 10px 13px;
|
|
@@ -803,7 +803,7 @@
|
|
|
803
803
|
max-width: 100%;
|
|
804
804
|
overflow-x: auto;
|
|
805
805
|
overscroll-behavior-inline: contain;
|
|
806
|
-
scrollbar-color:
|
|
806
|
+
scrollbar-color: var(--make-ai-internal-scrollbar-thumb) transparent;
|
|
807
807
|
scrollbar-width: thin;
|
|
808
808
|
}
|
|
809
809
|
|
|
@@ -817,7 +817,7 @@
|
|
|
817
817
|
}
|
|
818
818
|
|
|
819
819
|
.make-ai-assistant__markdown-table-scroll::-webkit-scrollbar-thumb {
|
|
820
|
-
background:
|
|
820
|
+
background: var(--make-ai-internal-scrollbar-thumb);
|
|
821
821
|
background-clip: padding-box;
|
|
822
822
|
border: 1px solid transparent;
|
|
823
823
|
border-radius: 999px;
|
|
@@ -825,7 +825,7 @@
|
|
|
825
825
|
|
|
826
826
|
.make-ai-assistant__markdown-table-scroll:hover::-webkit-scrollbar-thumb,
|
|
827
827
|
.make-ai-assistant__markdown-table-scroll:focus-within::-webkit-scrollbar-thumb {
|
|
828
|
-
background:
|
|
828
|
+
background: var(--make-ai-internal-scrollbar-thumb-hover);
|
|
829
829
|
}
|
|
830
830
|
|
|
831
831
|
.make-ai-assistant__markdown-table {
|
|
@@ -1738,6 +1738,57 @@ button.make-ai-artifact__record:hover { background: var(--make-ai-internal-accen
|
|
|
1738
1738
|
}
|
|
1739
1739
|
}
|
|
1740
1740
|
|
|
1741
|
+
.make-ai-assistant__conversation-controls {
|
|
1742
|
+
border-bottom: 1px solid var(--make-ai-internal-border);
|
|
1743
|
+
flex: 0 0 auto;
|
|
1744
|
+
font-size: var(--make-ai-internal-font-size-meta);
|
|
1745
|
+
max-height: 240px;
|
|
1746
|
+
overflow: auto;
|
|
1747
|
+
padding: 8px 12px;
|
|
1748
|
+
}
|
|
1749
|
+
.make-ai-assistant__panel--managed { grid-template-rows: auto auto minmax(0, 1fr) auto; }
|
|
1750
|
+
.make-ai-assistant__panel--managed > .make-ai-assistant__conversation-controls { grid-row: 2; }
|
|
1751
|
+
.make-ai-assistant__panel--managed > .make-ai-assistant__body { grid-row: 3; }
|
|
1752
|
+
.make-ai-assistant__panel--managed > .make-ai-assistant__composer-region { grid-row: 4; }
|
|
1753
|
+
.make-ai-assistant__response-status { color: var(--make-ai-internal-text-secondary); font-size: var(--make-ai-internal-font-size-meta); }
|
|
1754
|
+
|
|
1755
|
+
.make-ai-assistant__conversation-list { max-height: 130px; overflow: auto; }
|
|
1756
|
+
.make-ai-assistant__conversation-row { display: flex; gap: 4px; margin-bottom: 4px; }
|
|
1757
|
+
.make-ai-assistant__conversation-row > button:first-child { flex: 1; min-width: 0; overflow: hidden; text-align: left; text-overflow: ellipsis; white-space: nowrap; }
|
|
1758
|
+
.make-ai-assistant__conversation-row > button[aria-pressed="true"] { background: var(--make-ai-internal-accent-soft); color: var(--make-ai-internal-accent); }
|
|
1759
|
+
.make-ai-assistant__conversation-actions { align-items: center; display: flex; flex-wrap: wrap; gap: 6px; padding-top: 8px; }
|
|
1760
|
+
.make-ai-assistant__conversation-actions input { flex: 1; min-width: 100px; }
|
|
1761
|
+
.make-ai-assistant__conversation-controls button,
|
|
1762
|
+
.make-ai-assistant__feedback button,
|
|
1763
|
+
.make-ai-assistant__attachment button,
|
|
1764
|
+
.make-ai-assistant__attachment-composer button {
|
|
1765
|
+
background: var(--make-ai-internal-surface);
|
|
1766
|
+
border: 1px solid var(--make-ai-internal-border);
|
|
1767
|
+
border-radius: 6px;
|
|
1768
|
+
color: inherit;
|
|
1769
|
+
cursor: pointer;
|
|
1770
|
+
font: inherit;
|
|
1771
|
+
padding: 4px 8px;
|
|
1772
|
+
}
|
|
1773
|
+
.make-ai-assistant__feedback { display: flex; flex-wrap: wrap; gap: 6px; font-size: var(--make-ai-internal-font-size-meta); }
|
|
1774
|
+
.make-ai-assistant__feedback button[aria-pressed="true"] { color: var(--make-ai-internal-accent); border-color: var(--make-ai-internal-accent); }
|
|
1775
|
+
.make-ai-assistant__feedback form { display: grid; flex-basis: 100%; gap: 6px; }
|
|
1776
|
+
.make-ai-assistant__feedback input,
|
|
1777
|
+
.make-ai-assistant__feedback textarea,
|
|
1778
|
+
.make-ai-assistant__conversation-actions input { border: 1px solid var(--make-ai-internal-border); border-radius: 6px; color: inherit; font: inherit; padding: 6px; width: 100%; }
|
|
1779
|
+
.make-ai-assistant__attachment { align-items: center; display: flex; flex-wrap: wrap; gap: 6px; padding: 8px; border: 1px solid var(--make-ai-internal-border); border-radius: 8px; font-size: var(--make-ai-internal-font-size-meta); }
|
|
1780
|
+
.make-ai-assistant__attachment img,
|
|
1781
|
+
.make-ai-assistant__attachment video { max-height: 260px; max-width: 100%; object-fit: contain; }
|
|
1782
|
+
.make-ai-assistant__attachment audio { max-width: 100%; }
|
|
1783
|
+
.make-ai-assistant__attachment-composer { font-size: var(--make-ai-internal-font-size-meta); max-height: 140px; overflow: auto; padding-bottom: 8px; }
|
|
1784
|
+
.make-ai-assistant__attachment-composer input { max-width: 100%; }
|
|
1785
|
+
.make-ai-assistant__attachment-composer ul { list-style: none; margin: 6px 0 0; padding: 0; }
|
|
1786
|
+
.make-ai-assistant__attachment-composer li { align-items: center; display: flex; flex-wrap: wrap; gap: 4px; padding: 4px 0; }
|
|
1787
|
+
.make-ai-assistant__conversation-controls button:focus-visible,
|
|
1788
|
+
.make-ai-assistant__feedback button:focus-visible,
|
|
1789
|
+
.make-ai-assistant__attachment button:focus-visible,
|
|
1790
|
+
.make-ai-assistant__attachment-composer button:focus-visible { outline: 2px solid var(--make-ai-internal-accent); outline-offset: 2px; }
|
|
1791
|
+
|
|
1741
1792
|
@media (prefers-reduced-motion: reduce) {
|
|
1742
1793
|
.make-ai-assistant__drawer,
|
|
1743
1794
|
.make-ai-assistant__launcher-orbit,
|
package/docs/backend-contract.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Make AI
|
|
1
|
+
# Make AI 助手后端配合合同
|
|
2
2
|
|
|
3
3
|
## Make Console 当前 Web 接口
|
|
4
4
|
|
|
@@ -26,28 +26,15 @@ Console BFF 与 Make App Browser API 的认证和资源模型不同,不能只
|
|
|
26
26
|
transport。平台包分别提供 `/make-console` 与 `/make-app` 两个入口,聊天 UI 与 Artifact
|
|
27
27
|
模板保持共享。
|
|
28
28
|
|
|
29
|
-
## Make App
|
|
29
|
+
## Make App 当前后端接入
|
|
30
30
|
|
|
31
|
-
Make App
|
|
32
|
-
下列语义操作,不定义或拼接任何部署路径:
|
|
31
|
+
Make App 通过 `/make-app` adapter 消费当前唯一契约。包提供 Chat 管理、历史、输入、输出、反馈、上传和原件的语义方法,实际 URL/身份与代理由宿主负责。完整接口映射与时序见 [接入说明](make-app-integration.md)。
|
|
33
32
|
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
| 订阅响应 | `{ chatId, responseId, cursor }` | 兼容 adapter 合同的 EventSource |
|
|
40
|
-
|
|
41
|
-
实际请求由宿主认证边界发起。URL、请求方法、Cookie、Ingress、Service 代理、租户与当前用户
|
|
42
|
-
解析都由宿主决定;浏览器不能读取或构造服务端凭证。宿主必须传递 `AbortSignal`,并在取消
|
|
43
|
-
后尽快停止尚未完成的请求。
|
|
44
|
-
|
|
45
|
-
当前事件包括 `run.started`、`response.delta`、`response.progress`、
|
|
46
|
-
`response.message`、`response.completed`、`response.failed` 和 `heartbeat`。
|
|
47
|
-
`response.message` 是完整文本替换,不是 delta。当前接口没有新建会话、远程取消和
|
|
48
|
-
Artifact;前端必须按能力降级,不应伪造这些能力。
|
|
49
|
-
Make App adapter 会在 `JSON.parse` 前限制单个 EventSource `data` 字符数,默认
|
|
50
|
-
1,000,000;历史恢复最多接受 200 条消息、1,000,000 字符正文和 500 个 Artifact。
|
|
33
|
+
宿主返回裸 JSON,204 没有 body,内容读取返回 Uint8Array。Chat 的 title/pinned 修改和删除使用 expectedRevision;创建和反馈使用稳定 requestId;发送使用稳定 messageId。历史从数值 cursor 正向读取,列表使用独立不透明游标。
|
|
34
|
+
|
|
35
|
+
SSE 使用 response.subscribed/state、output_item.added/output_text.delta/output_item.done、reset/snapshot 以及 completed/failed/cancelled。输出项身份与最终持久消息身份分离;生成完成后读历史对账,再提交反馈。快照覆盖已有视图;关闭订阅不会取消 Run,显式取消可能先返回 202,随后确认终态。
|
|
36
|
+
|
|
37
|
+
附件先完成分段上传,引用 ready 内容的长度/MIME/摘要后发送。模型媒体能力逐类验收,不能凭上传成功开放。当前 Make App 没有 Artifact 或重新生成的服务器语义,不发送未定义的 context/capabilities 扩展。
|
|
51
38
|
|
|
52
39
|
## 通用标准接口能力
|
|
53
40
|
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
# Make App 当前契约接入
|
|
2
|
+
|
|
3
|
+
本分支将现有 `/make-app` 入口原地接入当前个人多会话、反馈、附件和 item/part SSE 契约。没有协议版本选择,没有隐式定位单一会话,也不自动替宿主做登录。包版本发布号与业务协议无关。
|
|
4
|
+
|
|
5
|
+
## 宿主接线
|
|
6
|
+
|
|
7
|
+
从 `@qfei-design/make-ai-assistant/make-app` 导入 `createMakeAppAssistantTransport`,从 `/react` 导入 `MakeAiAssistant` 或 `AssistantPanel`。实现下面的语义回调;可复制 [宿主回调映射](../examples/make-app/transport.ts) 中的映射,替换为 POC 已有认证请求封装。所有 URL、Cookie 转发与服务端鉴权属于宿主。
|
|
8
|
+
|
|
9
|
+
| 宿主回调 | 作用与结果 |
|
|
10
|
+
|---|---|
|
|
11
|
+
| resolveScope(context) | 返回明确的 appKey、agentId、identityKey;用户或租户变化时 identityKey 必须改变 |
|
|
12
|
+
| listAgents | 产品内启用 Agent 数组的裸响应 |
|
|
13
|
+
| createChat | requestId 幂等创建;返回 Chat |
|
|
14
|
+
| listChats | 当前用户在产品/Agent 下的列表;返回 chats、nextCursor、hasMore |
|
|
15
|
+
| getChat / updateChat / deleteChat | 详情、title/pinned 更新、软删除;更新/删除带 expectedRevision |
|
|
16
|
+
| loadHistory | 指定 chatId 和数值 cursor;返回 messages、nextCursor、hasMore |
|
|
17
|
+
| sendMessage | 稳定 messageId;text 或 parts 二选一;返回 chatId、responseId、acceptedCursor |
|
|
18
|
+
| getResponse / cancelResponse | 权威快照、独立取消;取消可能返回仍 running 的快照与 cancelRequested=true |
|
|
19
|
+
| setFeedback | 持久助手 messageId、requestId、like/dislike/none,以及可选 reason/comment |
|
|
20
|
+
| startUpload / getUpload | 上传初始化与 completedParts 续传进度 |
|
|
21
|
+
| uploadPart / completeUpload | 从 0 编号的二进制分段,全部完成后获取 ready 内容引用 |
|
|
22
|
+
| readContent | 鉴权后原始 Uint8Array,不能把 contentRef 当公开 URL |
|
|
23
|
+
| eventSourceFactory | 以 chatId、responseId、cursor 创建带凭据的 EventSource;包负责关闭与重连 |
|
|
24
|
+
|
|
25
|
+
JSON 回调返回服务端裸对象,204 返回 void,内容返回 Uint8Array。不要在所有响应上统一解包 data 或 JSON.parse。每个异步回调都必须传递 AbortSignal。scopeKey 仅隔离浏览器内的状态,不能代替服务器授权。
|
|
26
|
+
|
|
27
|
+
会话查询和创建相互独立。`loadConversation(context,{threadId,cursor,signal})` 只恢复选中的会话,不隐式创建;UI 点击新建或首次主动发送才创建。公开返回的 `threadId` 对应 chatId,responseId 对应执行 Run。
|
|
28
|
+
|
|
29
|
+
## 包提供的交互
|
|
30
|
+
|
|
31
|
+
内置面板可列出、选择、新建会话,编辑标题、置顶/取消置顶、确认删除;改名/置顶/删除失败保留用户可见错误。修订冲突后读取最新详情,不自动换 revision 覆盖。
|
|
32
|
+
|
|
33
|
+
输入和重试保存稳定 UUID。多个输入可能对应同一 responseId;面板控制器在响应维度保持一个订阅,关闭面板继续保留当前 UI,切会话/身份或卸载只释放本地连接。停止按钮调用 cancelResponse,并等待终态;完成与取消竞争时接受服务端最终结果。
|
|
34
|
+
|
|
35
|
+
输出按 itemId/partId 归并,完整 done 文本覆盖增量。中间模型活动放在过程区域,不能充当最终可反馈消息。response.completed 后读取历史对账,切换到持久助手 messageId,再开放反馈。点踩说明提交失败保留表单,重新提交复用未知结果的原意图;撤销用 rating=none。
|
|
36
|
+
|
|
37
|
+
文件选择、拖拽和粘贴进入同一上传队列。分段大小读 partSize,重试先查 completedParts;未 ready 的附件不能发送。暂停/移除只影响本地任务和草稿,当前没有远程上传取消接口。附件卡片可鉴权下载和受控预览,不执行 HTML/SVG/脚本。
|
|
38
|
+
|
|
39
|
+
## 流式事件与恢复
|
|
40
|
+
|
|
41
|
+
公开流消费 `response.subscribed/state/output_item.added/output_text.delta/output_item.done/reset/snapshot/completed/failed/cancelled`。这些事件在 adapter 转换为 headless 的响应事件,不复用通用 SSE 的消息身份来猜最终答案。
|
|
42
|
+
|
|
43
|
+
公开 `AssistantEvent` 增加:
|
|
44
|
+
|
|
45
|
+
- response.accepted:输入受理与 responseId 关联。
|
|
46
|
+
- response.state、response.output_item.added、response.output_text.delta、response.output_item.done:运行状态和项级输出。
|
|
47
|
+
- response.snapshot:覆盖该响应已确认的输出视图。
|
|
48
|
+
- response.reconciled:持久消息对账。
|
|
49
|
+
- response.terminal:completed/failed/cancelled 终态。
|
|
50
|
+
|
|
51
|
+
`AssistantConversationState.responses` 保存各响应状态,activeRunId 只是当前活动响应的便利字段,不是唯一运行事实。终态后迟到增量不能重新打开响应。原有通用 SSE、Console、Mock 与 Artifact 公共入口仍各自归一化到同一 headless 合同。
|
|
52
|
+
|
|
53
|
+
EventSource.onerror 后先关闭旧实例,再由 adapter 从最后处理游标有界重连;不要同时设置第二套宿主重连循环。query cursor 优先于 Last-Event-ID。reset 后消费服务器快照;通道连续失败时切到权威快照。快照没有完整在途 token,也没有可直接切回 Redis 的水位,不能将任意旧 delta 追加到快照。
|
|
54
|
+
|
|
55
|
+
完成对账失败会报告恢复错误,不能被重连逻辑吞掉。普通断网与 HTTP/SSE 读取失败都不等同于业务 Run 已取消。
|
|
56
|
+
|
|
57
|
+
## 限制与未开放能力
|
|
58
|
+
|
|
59
|
+
| 事项 | 当前行为 |
|
|
60
|
+
|---|---|
|
|
61
|
+
| 输入 | 文本累计 8 KiB UTF-8;最多 32 个有序 parts;整体消息 JSON 64 KiB |
|
|
62
|
+
| 上传 | 单文件 64 MiB,分段当前 1 MiB;服务端按完整 Namespace 限流/限容量 |
|
|
63
|
+
| 历史 | cursor=-1 从最早事件正向扫描,limit 数底层事件;空可见页仍可 hasMore=true |
|
|
64
|
+
| 长历史 | 分页继续加载,有界展示最近加载的 200 条/正文预算;不会声称首个窗口是全部历史 |
|
|
65
|
+
| 模型媒体能力 | modelInputKinds 默认只有 text;逐类真实模型验收后由宿主开放 |
|
|
66
|
+
| 未完成上传 | 服务端当前 24 小时失效;无公开 abort/清理,容量不保证自动回收 |
|
|
67
|
+
| 下载 | 当前为 attachment/octet-stream,不承诺 Range/206;预览用本地受控 Blob |
|
|
68
|
+
| Artifact/页面上下文 | 通用能力保留;当前 Make App 请求不携带 context/capabilities,不从 Markdown 猜 Artifact |
|
|
69
|
+
| 重新生成 | 没有服务端替换语义,保持关闭;普通再次提问属于新消息 |
|
|
70
|
+
|
|
71
|
+
后端模型媒体适配未启用时,内部 LLM 可能返回 unsupported_media;公开消息先受理为 202 后再以 AI_RUN_FAILED 终止。前端不能依赖消息 POST 直接返回 422。
|
|
72
|
+
|
|
73
|
+
## 后续 POC 接手
|
|
74
|
+
|
|
75
|
+
1. 对接现有统一登录和 Service,完成所有语义回调;认证过期、产品/Agent/用户切换都重新核对。
|
|
76
|
+
2. 由宿主决定当前选中会话的 URL/持久化导航、草稿体验、Agent 入口和主题布局。刷新后可从包的列表选择历史会话恢复。
|
|
77
|
+
3. 用真实宿主验证未缓冲 SSE、断网重连、取消、修订冲突、反馈回显和附件字节;本地示例不是已部署 POC。
|
|
78
|
+
4. 经接手人检查后,按现有 GitLab CI 发布 alpha,再升级 POC 依赖。当前用户要求只交 feature 分支,本轮不发包、不部署 Dev。
|
|
79
|
+
|
|
80
|
+
完整字段说明以 agent-design 的 MakeAppProtocol/OpenAPI 与接口手册为准;交接飞书文档同时提供 17 项 HTTP 清单、请求示例、分支和本地验收结果。
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Make App 接入示例
|
|
2
|
+
|
|
3
|
+
本示例消费包的公开 `/react`、`/make-app` 和样式入口,展示 17 项语义回调如何连接宿主同源服务。所有 POC 复用包内会话、流式、反馈和上传状态,不复制其内部实现。
|
|
4
|
+
|
|
5
|
+
先在仓库根目录执行 `corepack pnpm build`,再执行 `corepack pnpm make-app:build`。输出在本目录的 dist,仅供宿主服务托管或本地验收;本例不处理登录、不读取 Token,也不提供生产 BFF。
|
|
6
|
+
|
|
7
|
+
宿主提供同源 `GET /runtime-config`,响应为 `{appKey, appName, agentId, identityKey}`;identityKey 是用户/租户变化时同步变化的非凭据缓存隔离键。该配置不构成服务器授权。生产 POC 应将示例 request 换成已有认证客户端,并沿现有 Service/Make Gateway 转发公共接口。
|
|
8
|
+
|
|
9
|
+
当前 Make App 后端只支持文本模型输入;示例的 modelInputKinds 为 `["text"]`。图片、文件、非实时音视频可先上传和查看原件,模型理解逐类验收后再配置开放。不要以文件上传成功判断模型已经支持。
|
|
10
|
+
|
|
11
|
+
详见 [接入说明](../../docs/make-app-integration.md)。正式发布仍由原仓库 GitLab CI 负责。
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
<!doctype html>
|
|
2
|
+
<html lang="zh-CN">
|
|
3
|
+
<head><meta charset="UTF-8" /><meta name="viewport" content="width=device-width, initial-scale=1.0" /><title>Make App 助手接入验收</title></head>
|
|
4
|
+
<body><div id="root"></div><script type="module" src="/main.tsx"></script></body>
|
|
5
|
+
</html>
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import { StrictMode } from "react";
|
|
2
|
+
import { createRoot } from "react-dom/client";
|
|
3
|
+
import { AssistantPanel } from "@qfei-design/make-ai-assistant/react";
|
|
4
|
+
import { createHostTransport, type Configuration } from "./transport";
|
|
5
|
+
import "@qfei-design/make-ai-assistant/styles.css";
|
|
6
|
+
import "./style.css";
|
|
7
|
+
|
|
8
|
+
const config: Configuration = await fetch("/runtime-config").then((response) =>
|
|
9
|
+
response.json(),
|
|
10
|
+
);
|
|
11
|
+
if (
|
|
12
|
+
![config.appKey, config.agentId, config.identityKey].every(
|
|
13
|
+
(value) => typeof value === "string" && value.length > 0,
|
|
14
|
+
)
|
|
15
|
+
)
|
|
16
|
+
throw new Error("缺少宿主产品、Agent 或身份配置");
|
|
17
|
+
const transport = createHostTransport(config);
|
|
18
|
+
createRoot(document.getElementById("root")!).render(
|
|
19
|
+
<StrictMode>
|
|
20
|
+
<main className="example-shell">
|
|
21
|
+
<p className="example-notice">本地接入验收 · 使用宿主配置的真实后端</p>
|
|
22
|
+
<AssistantPanel
|
|
23
|
+
context={{
|
|
24
|
+
app: { id: config.appKey, name: config.appName },
|
|
25
|
+
location: { pathname: "/" },
|
|
26
|
+
locale: "zh-CN",
|
|
27
|
+
timezone: "Asia/Shanghai",
|
|
28
|
+
}}
|
|
29
|
+
transport={transport}
|
|
30
|
+
suggestions={[]}
|
|
31
|
+
/>
|
|
32
|
+
</main>
|
|
33
|
+
</StrictMode>,
|
|
34
|
+
);
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
body { margin: 0; background: #f4f6f9; font-family: system-ui, sans-serif; }
|
|
2
|
+
.example-shell { margin: 20px auto; max-width: 880px; padding: 0 12px; }
|
|
3
|
+
.example-notice { color: #617086; font-size: 12px; }
|
|
4
|
+
.example-shell .make-ai-assistant__panel { background: white; border: 1px solid #dbe3ef; border-radius: 12px; height: calc(100dvh - 85px); min-height: 420px; }
|
|
@@ -0,0 +1,163 @@
|
|
|
1
|
+
import {
|
|
2
|
+
createMakeAppAssistantTransport,
|
|
3
|
+
type MakeAppAssistantEventSource,
|
|
4
|
+
type MakeAppAssistantEventSourceEvent,
|
|
5
|
+
} from "@qfei-design/make-ai-assistant/make-app";
|
|
6
|
+
export interface Configuration {
|
|
7
|
+
appKey: string;
|
|
8
|
+
appName: string;
|
|
9
|
+
agentId: string;
|
|
10
|
+
identityKey: string;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
export function createHostTransport(
|
|
14
|
+
config: Configuration,
|
|
15
|
+
fetcher: typeof fetch = fetch,
|
|
16
|
+
) {
|
|
17
|
+
const prefix = "/api/make/app/ai";
|
|
18
|
+
const id = encodeURIComponent;
|
|
19
|
+
const query = (values: Record<string, string | number | undefined>) =>
|
|
20
|
+
new URLSearchParams(
|
|
21
|
+
Object.entries(values)
|
|
22
|
+
.filter(
|
|
23
|
+
(entry): entry is [string, string | number] => entry[1] !== undefined,
|
|
24
|
+
)
|
|
25
|
+
.map(([key, value]) => [key, String(value)]),
|
|
26
|
+
).toString();
|
|
27
|
+
const request = async (
|
|
28
|
+
path: string,
|
|
29
|
+
init: RequestInit = {},
|
|
30
|
+
binary = false,
|
|
31
|
+
) => {
|
|
32
|
+
// 替换为 POC 已有的认证请求封装;本示例同样只访问宿主同源接口。
|
|
33
|
+
const response = await fetcher(prefix + path, {
|
|
34
|
+
credentials: "include",
|
|
35
|
+
...init,
|
|
36
|
+
});
|
|
37
|
+
if (!response.ok) {
|
|
38
|
+
const body = await response.json().catch(() => ({}));
|
|
39
|
+
throw Object.assign(new Error("请求未完成"), {
|
|
40
|
+
status: response.status,
|
|
41
|
+
code: body.code,
|
|
42
|
+
});
|
|
43
|
+
}
|
|
44
|
+
if (response.status === 204) return undefined;
|
|
45
|
+
return binary
|
|
46
|
+
? new Uint8Array(await response.arrayBuffer())
|
|
47
|
+
: response.json();
|
|
48
|
+
};
|
|
49
|
+
const json = (
|
|
50
|
+
method: string,
|
|
51
|
+
body: unknown,
|
|
52
|
+
signal?: AbortSignal,
|
|
53
|
+
): RequestInit => ({
|
|
54
|
+
method,
|
|
55
|
+
signal,
|
|
56
|
+
headers: { "Content-Type": "application/json" },
|
|
57
|
+
body: JSON.stringify(body),
|
|
58
|
+
});
|
|
59
|
+
return createMakeAppAssistantTransport({
|
|
60
|
+
resolveScope: () => ({
|
|
61
|
+
appKey: config.appKey,
|
|
62
|
+
agentId: config.agentId,
|
|
63
|
+
identityKey: config.identityKey,
|
|
64
|
+
}),
|
|
65
|
+
listAgents: (input, options) => request(`/agents?${query(input)}`, options),
|
|
66
|
+
listChats: (input, options) => request(`/chats?${query(input)}`, options),
|
|
67
|
+
createChat: (input, options) =>
|
|
68
|
+
request("/chats", json("POST", input, options.signal)),
|
|
69
|
+
getChat: ({ chatId }, options) => request(`/chats/${id(chatId)}`, options),
|
|
70
|
+
updateChat: ({ chatId, ...body }, options) =>
|
|
71
|
+
request(`/chats/${id(chatId)}`, json("PATCH", body, options.signal)),
|
|
72
|
+
deleteChat: async ({ chatId, expectedRevision }, options) => {
|
|
73
|
+
await request(`/chats/${id(chatId)}?${query({ expectedRevision })}`, {
|
|
74
|
+
method: "DELETE",
|
|
75
|
+
signal: options.signal,
|
|
76
|
+
});
|
|
77
|
+
},
|
|
78
|
+
loadHistory: ({ chatId, ...page }, options) =>
|
|
79
|
+
request(`/chats/${id(chatId)}/messages?${query(page)}`, options),
|
|
80
|
+
sendMessage: ({ chatId, ...body }, options) =>
|
|
81
|
+
request(
|
|
82
|
+
`/chats/${id(chatId)}/messages`,
|
|
83
|
+
json("POST", body, options.signal),
|
|
84
|
+
),
|
|
85
|
+
getResponse: ({ chatId, responseId }, options) =>
|
|
86
|
+
request(`/chats/${id(chatId)}/responses/${id(responseId)}`, options),
|
|
87
|
+
cancelResponse: ({ chatId, responseId }, options) =>
|
|
88
|
+
request(
|
|
89
|
+
`/chats/${id(chatId)}/responses/${id(responseId)}/cancel`,
|
|
90
|
+
json("POST", {}, options.signal),
|
|
91
|
+
),
|
|
92
|
+
setFeedback: ({ chatId, messageId, ...body }, options) =>
|
|
93
|
+
request(
|
|
94
|
+
`/chats/${id(chatId)}/messages/${id(messageId)}/feedback`,
|
|
95
|
+
json("PUT", body, options.signal),
|
|
96
|
+
),
|
|
97
|
+
startUpload: ({ chatId, ...body }, options) =>
|
|
98
|
+
request(
|
|
99
|
+
`/chats/${id(chatId)}/uploads`,
|
|
100
|
+
json("POST", body, options.signal),
|
|
101
|
+
),
|
|
102
|
+
getUpload: ({ chatId, uploadId }, options) =>
|
|
103
|
+
request(`/chats/${id(chatId)}/uploads/${id(uploadId)}`, options),
|
|
104
|
+
uploadPart: async ({ chatId, uploadId, part, bytes }, options) => {
|
|
105
|
+
await request(
|
|
106
|
+
`/chats/${id(chatId)}/uploads/${id(uploadId)}/parts/${part}`,
|
|
107
|
+
{
|
|
108
|
+
method: "PUT",
|
|
109
|
+
signal: options.signal,
|
|
110
|
+
headers: { "Content-Type": "application/octet-stream" },
|
|
111
|
+
body: new Uint8Array(bytes).buffer,
|
|
112
|
+
},
|
|
113
|
+
);
|
|
114
|
+
},
|
|
115
|
+
completeUpload: ({ chatId, uploadId }, options) =>
|
|
116
|
+
request(
|
|
117
|
+
`/chats/${id(chatId)}/uploads/${id(uploadId)}/complete`,
|
|
118
|
+
json("POST", {}, options.signal),
|
|
119
|
+
),
|
|
120
|
+
readContent: async ({ chatId, contentRef }, options) =>
|
|
121
|
+
request(`/chats/${id(chatId)}/content/${id(contentRef)}`, options, true),
|
|
122
|
+
eventSourceFactory: ({ chatId, responseId, cursor }, init) => {
|
|
123
|
+
const source = new EventSource(
|
|
124
|
+
`${prefix}/chats/${id(chatId)}/events?${query({ responseId, cursor })}`,
|
|
125
|
+
init,
|
|
126
|
+
);
|
|
127
|
+
type Listener = (event: MakeAppAssistantEventSourceEvent) => void;
|
|
128
|
+
const listeners = new Map<string, Map<Listener, EventListener>>();
|
|
129
|
+
const wrapped: MakeAppAssistantEventSource = {
|
|
130
|
+
get readyState() {
|
|
131
|
+
return source.readyState;
|
|
132
|
+
},
|
|
133
|
+
onerror: null,
|
|
134
|
+
addEventListener(type, listener) {
|
|
135
|
+
const receive: EventListener = (event) => {
|
|
136
|
+
const message = event as MessageEvent<unknown>;
|
|
137
|
+
if (typeof message.data === "string")
|
|
138
|
+
listener({
|
|
139
|
+
data: message.data,
|
|
140
|
+
lastEventId: message.lastEventId,
|
|
141
|
+
});
|
|
142
|
+
};
|
|
143
|
+
const group = listeners.get(type) ?? new Map();
|
|
144
|
+
group.set(listener, receive);
|
|
145
|
+
listeners.set(type, group);
|
|
146
|
+
source.addEventListener(type, receive);
|
|
147
|
+
},
|
|
148
|
+
removeEventListener(type, listener) {
|
|
149
|
+
const receive = listeners.get(type)?.get(listener);
|
|
150
|
+
if (receive) source.removeEventListener(type, receive);
|
|
151
|
+
listeners.get(type)?.delete(listener);
|
|
152
|
+
},
|
|
153
|
+
close() {
|
|
154
|
+
source.close();
|
|
155
|
+
},
|
|
156
|
+
};
|
|
157
|
+
source.onerror = (event) => wrapped.onerror?.(event);
|
|
158
|
+
return wrapped;
|
|
159
|
+
},
|
|
160
|
+
// 按实际模型验收开放类型;上传存储能力与模型理解能力独立。
|
|
161
|
+
modelInputKinds: ["text"],
|
|
162
|
+
});
|
|
163
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@qfei-design/make-ai-assistant",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.10",
|
|
4
4
|
"description": "Platform-wide Make AI Assistant contracts, React shell, and context-aware artifact templates.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"sideEffects": [
|
|
@@ -55,13 +55,21 @@
|
|
|
55
55
|
"recipes.json",
|
|
56
56
|
"capabilities.json",
|
|
57
57
|
"docs/artifact-v1.md",
|
|
58
|
-
"docs/backend-contract.md"
|
|
58
|
+
"docs/backend-contract.md",
|
|
59
|
+
"docs/make-app-integration.md",
|
|
60
|
+
"examples/make-app/main.tsx",
|
|
61
|
+
"examples/make-app/style.css",
|
|
62
|
+
"examples/make-app/README.md",
|
|
63
|
+
"examples/make-app/vite.config.ts",
|
|
64
|
+
"examples/make-app/index.html",
|
|
65
|
+
"examples/make-app/transport.ts"
|
|
59
66
|
],
|
|
60
67
|
"scripts": {
|
|
61
68
|
"test": "vitest run",
|
|
62
69
|
"typecheck": "tsc -p tsconfig.json --noEmit",
|
|
63
70
|
"build": "vite build && tsc -p tsconfig.build.json --emitDeclarationOnly && node scripts/copy-styles.mjs && node scripts/smoke-dist.mjs",
|
|
64
71
|
"gallery:build": "vite build --config examples/gallery/vite.config.ts",
|
|
72
|
+
"make-app:build": "vite build --config examples/make-app/vite.config.ts",
|
|
65
73
|
"sprint:init": "qfei-release sprint-init",
|
|
66
74
|
"release:init": "qfei-release release-init",
|
|
67
75
|
"publish:alpha": "qfei-release publish --channel alpha",
|
package/recipes.json
CHANGED
|
@@ -14,7 +14,10 @@
|
|
|
14
14
|
"AssistantTransport",
|
|
15
15
|
"ArtifactActionHandler"
|
|
16
16
|
],
|
|
17
|
-
"readNext": [
|
|
17
|
+
"readNext": [
|
|
18
|
+
"README.md",
|
|
19
|
+
"PUBLIC_API.md"
|
|
20
|
+
],
|
|
18
21
|
"commonMistakes": [
|
|
19
22
|
"Calling Make API directly from the UI",
|
|
20
23
|
"Passing Make tokens through the package",
|
|
@@ -32,7 +35,10 @@
|
|
|
32
35
|
"Service endpoint",
|
|
33
36
|
"Optional credentials and request headers"
|
|
34
37
|
],
|
|
35
|
-
"readNext": [
|
|
38
|
+
"readNext": [
|
|
39
|
+
"README.md",
|
|
40
|
+
"docs/backend-contract.md"
|
|
41
|
+
],
|
|
36
42
|
"commonMistakes": [
|
|
37
43
|
"Importing the SSE implementation from the headless root",
|
|
38
44
|
"Sending Make tokens from the browser",
|
|
@@ -41,20 +47,27 @@
|
|
|
41
47
|
},
|
|
42
48
|
{
|
|
43
49
|
"id": "make-app-browser-api",
|
|
44
|
-
"summary": "
|
|
50
|
+
"summary": "接入当前 Make App 多会话、反馈、类型化附件和 item/part SSE 合同。",
|
|
45
51
|
"use": [
|
|
46
52
|
"@qfei-design/make-ai-assistant/make-app:createMakeAppAssistantTransport"
|
|
47
53
|
],
|
|
48
54
|
"hostProvides": [
|
|
49
|
-
"
|
|
50
|
-
"
|
|
51
|
-
"
|
|
55
|
+
"明确 appKey/agentId/identityKey 的 resolveScope",
|
|
56
|
+
"17 项已认证语义回调及带凭据的 EventSource 工厂",
|
|
57
|
+
"实际模型已验收的 modelInputKinds"
|
|
58
|
+
],
|
|
59
|
+
"readNext": [
|
|
60
|
+
"README.md",
|
|
61
|
+
"PUBLIC_API.md",
|
|
62
|
+
"docs/backend-contract.md",
|
|
63
|
+
"docs/make-app-integration.md"
|
|
52
64
|
],
|
|
53
|
-
"readNext": ["README.md", "PUBLIC_API.md", "docs/backend-contract.md"],
|
|
54
65
|
"commonMistakes": [
|
|
55
|
-
"
|
|
56
|
-
"
|
|
57
|
-
"
|
|
66
|
+
"浏览器读写服务凭据",
|
|
67
|
+
"将 itemId 当作持久反馈 messageId",
|
|
68
|
+
"用关闭连接冒充远程取消",
|
|
69
|
+
"忽略空历史页的 hasMore",
|
|
70
|
+
"把上传成功视为模型理解成功"
|
|
58
71
|
]
|
|
59
72
|
},
|
|
60
73
|
{
|
|
@@ -68,7 +81,11 @@
|
|
|
68
81
|
"Credentialed Run EventSource factory",
|
|
69
82
|
"Current Make Console App context"
|
|
70
83
|
],
|
|
71
|
-
"readNext": [
|
|
84
|
+
"readNext": [
|
|
85
|
+
"README.md",
|
|
86
|
+
"PUBLIC_API.md",
|
|
87
|
+
"docs/backend-contract.md"
|
|
88
|
+
],
|
|
72
89
|
"commonMistakes": [
|
|
73
90
|
"Reading or copying zs_session in application code",
|
|
74
91
|
"Treating SSE as the durable source of truth",
|
|
@@ -88,7 +105,10 @@
|
|
|
88
105
|
"canRender predicate based on Artifact semantics and host context",
|
|
89
106
|
"Accessible React presentation"
|
|
90
107
|
],
|
|
91
|
-
"readNext": [
|
|
108
|
+
"readNext": [
|
|
109
|
+
"README.md",
|
|
110
|
+
"PUBLIC_API.md"
|
|
111
|
+
],
|
|
92
112
|
"commonMistakes": [
|
|
93
113
|
"Registering a business-specific template as a platform default",
|
|
94
114
|
"Using a backend component name as an executable import path",
|
|
@@ -106,7 +126,10 @@
|
|
|
106
126
|
"App context",
|
|
107
127
|
"Optional request-specific mock response"
|
|
108
128
|
],
|
|
109
|
-
"readNext": [
|
|
129
|
+
"readNext": [
|
|
130
|
+
"README.md",
|
|
131
|
+
"PUBLIC_API.md"
|
|
132
|
+
],
|
|
110
133
|
"commonMistakes": [
|
|
111
134
|
"Building a second mock-only component path",
|
|
112
135
|
"Putting POC business fixtures into platform default templates",
|