跳到主要内容

环境配置

1. 获取 SDK​

推荐通过 npm 安装或直接引入构建产物。

npm install @nianxie/nianxie-interaction-sdk

如果你使用脚本直引方式，请确认版本与业务代码一致，避免不同页面引用了不同 SDK 版本。

如果你使用 GitHub Package Registry，可使用以下安装命令：

npm install @nianxie/nianxie-interaction-sdk --@nianxie:registry=https://npm.pkg.github.com

最小接入要求：

  • 入口文件为 dist/index.html
  • 本地资源使用相对路径（如 ./assets/...）
  • 业务字段统一放在 extras

2. 配置工具​

建议至少准备以下两类工具：

  • 本地静态服务器：用于模拟正式资源路径（例如 index.html + Build/ 结构）。
  • 调试工具：浏览器 DevTools（Network / Console / Application）用于检查协议、资源加载、缓存与跨域问题。

推荐在本地调试时固定以下检查项：

  • ZIP 解包后根目录是否有 index.html。
  • 资源路径是否为相对路径（如 ./Build/...）。
  • 控制台是否按顺序出现协议日志（init -> ready -> start -> end）。

建议在 package.json 增加校验脚本，提交前自动检查：

{
  "scripts": {
    "nx:package": "npx nianxie-gate package",
    "nx:verify:runtime": "npx nianxie-gate verify-runtime",
    "nx:preflight": "npx nianxie-gate preflight",
    "nx:submit:prepare": "npx nianxie-gate submit-prepare"
  }
}

推荐执行顺序：

npm run nx:preflight
npm run nx:submit:prepare

补充参考链接（仓库内为简版说明）：