@leatop/ai-agent-iframe 0.0.0-stage → 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Lollipope
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,101 @@
-# Temporary Holding Version
+# @leatop/ai-agent-iframe
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Leatop CDP AI Agent 的 **iframe 轻量版**悬浮入口组件。
+只负责「悬浮机器人图标 + 全屏/半屏 iframe 容器 + 与子应用 postMessage 通信」，不含本地对话渲染逻辑，包体很小。
+
+## 1. 安装
+
+```bash
+pnpm add @leatop/ai-agent-iframe
+```
+
+
+
+- `vue` `^3.5`
+- `element-plus` `^2.11`（组件内部使用了 `el-icon` / `el-tag`，**需宿主全局注册 Element Plus**：`app.use(ElementPlus)`）
+- `axios` `^1.6`、`qs` `^6.12`（内部请求封装使用）
+
+## 2. 运行时配置
+
+组件初始化时读取 `window.globalConfig`，请在被引入前注入（例如 `public/config.js`）：
+
+```js
+window.globalConfig = {
+  // 生成 ticket 的接口前缀（不配则默认 '/api/'）
+  AiAgentApi: '/yyjc/api/',
+  // true：从 cookie 取 token；false/不配：从 localStorage 取 'cdp-token'
+  sessionCookie: true,
+};
+```
+
+## 3. 在页面中使用
+
+```ts
+// main.ts / 项目入口：引入组件样式（只需一次）
+import '@leatop/ai-agent-iframe/style.css';
+```
+
+```vue
+<script setup>
+// 推荐：局部注册（与 @leatop/ai-agent 的用法一致）
+import AIagent from '@leatop/ai-agent-iframe';
+</script>
+
+<template>
+  <!-- 建议放在 NavBar 右侧，父容器 z-index 需高于导航 -->
+  <AIagent
+    v-if="showAiagent"
+    :ai-iframe-src="aiIframeSrc"
+    :login-key="loginKey"
+    :user-info="userInfo"
+    @openTab="onOpenTab"
+    @openAI="onOpenAI"
+    @child-message="onChildMessage"
+  />
+</template>
+```
+
+如果想全局注册（`app.use(AIagent)`），组件名是 `AiagentBox`，模板中需写成 `<AiagentBox />`。
+
+## 4. Props
+
+| 名称 | 类型 | 默认值 | 说明 |
+| --- | --- | --- | --- |
+| `aiIframeSrc` | `string` | `''` | 子应用地址 **origin**（如 `https://ai.example.com`），同时用于 `postMessage` 的 `targetOrigin` 校验 |
+| `loginKey` | `string` | `''` | 调用 `/odm/openApi/generateToken` 换取 ticket 的凭证 |
+| `userInfo` | `object` | `{}` | 用户信息，握手后通过 `postMessage` 推给子应用 |
+
+## 5. Events
+
+| 名称 | 参数 | 说明 |
+| --- | --- | --- |
+| `openTab` | `tabId: number` | 点击「AI通问 / AI问策 / AI问数」菜单项，`0/1/2` |
+| `openAI` | — | 点击悬浮机器人图标 |
+| `child-message` | `data: any` | 子应用 `postMessage` 上抛的消息 |
+
+## 6. iframe 通信协议
+
+父页面 → 子页面（`window.postMessage(payload, aiIframeSrc)`）：
+
+```ts
+{ userId: 123, tab: 'home', filters: { status: 'all' }, tabId?: number }
+```
+
+子页面就绪后需向父页面发送：
+
+```ts
+window.parent.postMessage({ type: 'CHILD_READY' }, parentOrigin);
+```
+
+父页面收到 `CHILD_READY` 后才会全量同步一次参数；`tabId` 变化时也会增量推送，且**不会重载 iframe**。
+
+## 7. 开发 / 构建
+
+```bash
+pnpm dev        # 本地调试
+pnpm build      # 产出 dist/ai-agent-iframe.mjs、ai-agent-iframe.cjs、index.d.ts、style.css
+pnpm type-check # 类型检查
+```
+
+> 发布必须使用 `pnpm publish`：入口 `main/module/types/exports` 在发布时由 `publishConfig` 覆盖为 `dist/`，
+> 该覆盖能力仅 pnpm 支持，`scripts/prepack-check.mjs` 会在 `prepack` 阶段校验。