内部 SDK

有关更深入的文档,请查阅 SDK 架构和内部 SDK 项目的 README

要求

  • Rust 最新稳定版本 -(建议通过 rustup 安装)

  • NodeJS 和 NPM。

更多信息请参阅工具和库页面。

设置说明

  1. 克隆存储库:

    git clone https://github.com/bitwarden/sdk-internal.git
    cd sdk
  2. 安装依赖:

    npm ci

构建 SDK

SDK 为不同的平台构建,每个平台都有自己的构建说明。有关如何为特定平台构建的更多信息,请参阅不同 crate 的 readme:

请注意,每个平台都有自己的依赖项,它们需要在构建之前安装。如果遇到任何问题,请务必再次检查 readme。

链接 SDK 到客户端

在修改 SDK 之后,测试客户端应用程序中的更改可能是有益的。为此,您需要更新客户端应用程序中的 SDK 引用。

这些说明假设您有一个类似以下目录结构:

sdk/
clients/
ios/
android/

网页客户端

网页客户端使用 NPM 将 SDK 作为依赖项安装。NPM 提供了专门的 link 命令,用于将软件包临时替换为本地版本。

npm link ../sdk-internal/crates/bitwarden-wasm-internal/npm

移动端

Android

  1. 在本地 Maven 仓库中构建和发布 SDK:

    ../sdk-internal/crates/bitwarden-uniffi/kotlin/publish-local.sh
  2. user.properties 文件中设置用户属性 localSdk=true

iOS

使用设置为 true 的 LOCAL_SDK 环境变量运行 bootstrap 脚本,以使用本地 SDK 构建:

LOCAL_SDK=true ./Scripts/bootstrap.sh

最后更新于