sa-guide-sdk

系统智能指引嵌入 SDK（浏览器端），用于在业务系统中展示首次访问引导、多步骤操作指引等。

当前版本：1.3.70（SDK 主版本 v1）

安装

npm install @beibei3030630/[email protected]

Nuxt + Arktos（推荐）

只需在 nuxt.config.js 配置模块与两项业务参数。模块会自动复制浏览器资源、在客户端启动 SDK，并从 Arktos 当前用户读取工号和姓名：

export default {
  modules: ['@beibei3030630/sa-guide-sdk/nuxt'],
  saGuide: {
    apiBase: 'http://sa.example.com/system-assistant',
    appKey: 'ehr',
  },
}

快速接入

方式 A：unpkg / jsDelivr CDN（推荐）

<script src="https://unpkg.com/@beibei3030630/[email protected]/dist/v1/bootstrap.js"></script>
<script>
  window.SA_API_BASE = 'https://api.example.com/system-assistant';
  window.SA_APP_KEY = 'your_app_key';
  window.SA_EMP_CODE = '800451';
  SystemAssistantBootstrap.start();
</script>

方式 B：拷贝到静态目录（Vite / Webpack）

将 node_modules/@beibei3030630/sa-guide-sdk/dist/v1/ 下所有文件复制到项目的 public/sa-guide-sdk/：

<script src="/sa-guide-sdk/bootstrap.js"></script>
<script>
  window.SA_API_BASE = 'https://api.example.com/system-assistant';
  window.SA_APP_KEY = 'your_app_key';
  SystemAssistantBootstrap.start();
</script>

Vite 示例（vite-plugin-static-copy）：

import { viteStaticCopy } from 'vite-plugin-static-copy'

export default {
  plugins: [
    viteStaticCopy({
      targets: [{ src: 'node_modules/@beibei3030630/sa-guide-sdk/dist/v1/*', dest: 'sa-guide-sdk' }],
    }),
  ],
}

方式 C：手动加载核心 SDK

若已自行加载样式与渲染器，可直接引 sdk.js：

<script src="/sa-guide-sdk/guide-popup-styles.js"></script>
<script src="/sa-guide-sdk/guide-renderer.js"></script>
<script src="/sa-guide-sdk/sdk.js"></script>
<script>
  SystemAssistant.bootstrap({
    appKey: 'your_app_key',
    apiBase: 'https://api.example.com/system-assistant',
    watchIframe: true,
  });
</script>

配置项

| 全局变量 / 参数 | 说明 | |----------------|------| | SA_API_BASE | 指引 API 根地址，如 https://api.example.com/system-assistant | | SA_APP_KEY | 应用标识（必填） | | SA_EMP_CODE | 员工工号 | | SA_USER_NAME | 用户姓名 | | SA_SDK_BASE | SDK 脚本目录（可选，默认从 bootstrap.js 所在 URL 推断） | | SA_WATCH_IFRAME | 是否监听 iframe 弹窗，默认 true |

SystemAssistantBootstrap.start(config) 也支持同名 camelCase 字段覆盖全局变量。

包内容

dist/v1/
├── bootstrap.js           # 推荐入口
├── guide-popup-styles.js  # 14 种弹出样式
├── guide-renderer.js      # 多布局渲染器
└── sdk.js                 # 运行时核心

发布（维护者）

源码位于 packages/sa-guide-sdk/src/v1/（locator/ / snapshot/ / shared/ 分目录，sdk.js 由 concat 生成；SSOT 版本见本目录 package.json）：

cd packages/sa-guide-sdk

# 1. 更新 package.json version
# 2. 同步常量、拼接 sdk.js、拷贝 dist
npm run build

# 3. 登录 npmjs.com 并发布
npm login
npm publish

布局说明见 docs/SDK_LAYOUT.md。

许可证

MIT