Authsome JS SDK

轻量级 OAuth2/OIDC 客户端 SDK，支持授权流程、Token 交换、用户信息获取和登出。基于 lottie-web 实现加载动画，无 React 依赖。

安装

pnpm install

构建

pnpm build

开发

监听模式自动重新构建：

pnpm dev

Commit 规范

项目使用 commitlint 强制 Conventional Commits 格式，与 semantic-release 配合使用。

格式：<type>: <subject>

| type | 说明 | |------|------| | feat | 新功能 | | fix | 修复 bug | | docs | 文档 | | style | 格式 | | refactor | 重构 | | perf | 性能优化 | | test | 测试 | | build | 构建/依赖 | | ci | CI 配置 | | chore | 其他 |

示例：feat: 新增 refreshToken 方法、fix: 修复登录超时

发布到 npm

使用 semantic-release 自动管理版本，基于 Conventional Commits 规范决定版本号。

分支与版本对应

| 分支 | 发布版本 | npm tag | 版本规则 | |------|----------|---------|----------| | dev | 1.0.0-alpha.1 | alpha | 由 commit 决定 base 版本 | | qa | 1.0.0-beta.1 | beta | 同上 | | main | 1.0.0 | latest| Patch/Minor/Major 由 commit 决定 |

Conventional Commits 与版本

| Commit 类型 | 版本变化 | 示例 | |-------------|----------|------| | fix: | Patch (0.0.1 → 0.0.2) | fix: 修复登录超时 | | feat: | Minor (0.0.1 → 0.1.0) | feat: 新增登出方法 | | feat!: 或 BREAKING CHANGE: | Major (0.0.1 → 1.0.0) | feat!: 重构 API |

GitLab CI/CD 变量配置

在 GitLab 项目 Settings → CI/CD → Variables 中配置：

| 变量 | 说明 | |------|------| | NPM_TOKEN | npm 发布 Token（推荐） | | NPM_USER + NPM_PASSWORD | 或使用用户名密码 | | GITLAB_TOKEN | 用于将版本变更推送回仓库（需 write_repository 权限） |

创建 GITLAB_TOKEN：Settings → Access tokens → 创建 Project Access Token，勾选 write_repository。