CideBird JS SDK

CideBird JS SDK 是一个用于处理认证和授权的轻量级SDK。

安装

# pnpm (推荐)
pnpm add cidebird-js-sdk

# npm
npm install cidebird-js-sdk

# yarn
yarn add cidebird-js-sdk

使用方法

初始化SDK

import { CodeBirdSDK } from 'cidebird-js-sdk';

const sdk = new CodeBirdSDK({
  serverUrl: 'https://your-auth-server.com',
  clientId: 12345,
  redirectPath: '/callback', // 可选，默认为 '/callback'
  signinPath: '/api/signin', // 可选，默认为 '/api/signin'
});

登录

// 重定向到登录页面
await sdk.login();

处理回调

// 在回调页面初始化SDK
await sdk.init();

获取用户信息

const userInfo = await sdk.getUserInfo();
if (userInfo) {
  console.log('User:', userInfo);
}

检查认证状态

if (sdk.isAuthenticated()) {
  console.log('用户已登录');
}

登出

await sdk.logout();

API文档

CodeBirdSDK

构造函数

constructor(config: SdkConfig)

配置参数：

• serverUrl: 认证服务器URL
• clientId: 客户端ID
• redirectPath: 回调路径（可选，默认为'/callback'）
• signinPath: 登录API路径（可选，默认为'/api/signin'）

方法

• init(): 初始化SDK，处理认证回调
• login(): 重定向到登录页面
• logout(): 登出当前用户
• isAuthenticated(): 检查用户是否已认证
• getUserInfo(): 获取当前用户信息

开发

# 安装依赖
pnpm install

# 构建
pnpm build

# 运行测试
pnpm test

# 代码检查
pnpm lint

项目结构

src/
├── core/           # 核心SDK实现
│   └── sdk.ts
├── types/          # 类型定义
│   └── index.ts
├── utils/          # 工具函数
│   └── auth.ts
├── constants/      # 常量定义
│   └── index.ts
└── index.ts        # 入口文件

许可证

MIT