@paraview/auth-sdk

一个功能强大的身份认证 SDK，支持多种登录方式和多因素认证 (MFA)。

✨ 特性

- 🔐 多种登录方式：支持密码、OAuth、CAS 等登录方式
- 🛡️ 多因素认证 (MFA)：支持 OTP、SMS、Radius 等 MFA 方法
- 🌐 跨平台支持：支持浏览器、Node.js、React 等多种环境
- 📦 多种模块格式：提供 ES6、CommonJS、UMD 等多种格式
- 🔧 灵活配置：支持自定义端点、请求头等配置
- 📝 TypeScript 支持：完整的 TypeScript 类型定义
- 🚀 易于使用：简洁的 API 设计，快速集成

📦 安装

``bash
npm install @paraview/auth-sdk
`

🚀 快速开始

$3

`javascript
import { createAuthSDK } from '@paraview/auth-sdk';

// 初始化 SDK
const authSDK = createAuthSDK({
baseURL: 'https://your-api-server.com',
timeout: 10000
});

// 用户登录
const loginResult = await authSDK.login({
type: 'password',
username: 'user@example.com',
password: 'password123'
});

if (loginResult.success) {
console.log('登录成功:', loginResult.userInfo);

// 如果需要 MFA 验证
if (loginResult.requiresMFA) {
const mfaResult = await authSDK.verifyMFA({
code: '123456',
methodType: 'OTP'
});
console.log('MFA 验证结果:', mfaResult);
}
}
`

$3

`tsx
import React, { useState } from 'react';
import { createAuthSDK } from '@paraview/auth-sdk';

const authSDK = createAuthSDK({
baseURL: 'https://your-api-server.com'
});

function LoginComponent() {
const [user, setUser] = useState(null);

const handleLogin = async (credentials) => {
try {
const result = await authSDK.login(credentials);
if (result.success) {
setUser(result.userInfo);
}
} catch (error) {
console.error('登录失败:', error);
}
};

return (


`typescript
interface SDKConfig {
baseURL: string; // API 服务器地址
timeout?: number; // 请求超时时间 (ms)
apiKey?: string; // API 密钥
headers?: Record; // 自定义请求头
endpoints?: { // 自定义端点配置
passwordLogin?: EndpointConfig;
oauthLogin?: EndpointConfig;
mfaVerify?: EndpointConfig;
// ... 更多端点配置
};
}
`

$3

#### 🔐 用户认证

`typescript
// 登录
login(request: LoginRequest): Promise

// 登出
logout(sessionId?: string): Promise>
`

#### 🛡️ 多因素认证 (MFA)

`typescript
// MFA 验证
verifyMFA(request: MFAVerificationRequest): Promise

// 绑定 MFA 方法
bindMFA(request: MFABindRequest): Promise

// 解绑 MFA 方法
unbindMFA(request: MFAUnbindRequest): Promise

// 获取用户 MFA 方法
getMFAMethods(userId: string): Promise>

// 获取用户绑定信息
getUserBindings(userId: string): Promise>

// 获取可用认证方法
getAvailableAuthMethods(): Promise>
`

$3

支持多种登录方式：

`typescript
interface LoginRequest {
type: 'password' | 'oauth' | 'oauth_callback' | 'cas' | 'cas_validate';

// 密码登录
username?: string;
password?: string;

// OAuth 登录
provider?: 'google' | 'github' | 'microsoft' | 'facebook' | 'custom';
redirectUri?: string;
state?: string;
scopes?: string[];

// CAS 登录
service?: string;
casServerUrl?: string;

// 自定义端点
customEndpoint?: string;
customMethod?: 'GET' | 'POST';
}
`

$3

支持多种 MFA 方法：

- OTP (One-Time Password): 基于时间的一次性密码
- SMS: 短信验证码
- Radius: Radius 服务器认证

🌐 多环境支持

$3

`html



`

$3

`javascript
// ES Modules
import { createAuthSDK } from '@paraview/auth-sdk';

// CommonJS
const { createAuthSDK } = require('@paraview/auth-sdk');
`

$3

`javascript
import { createAuthSDK } from '@paraview/auth-sdk';

const authSDK = createAuthSDK({
baseURL: process.env.REACT_APP_API_URL
});
`

🔧 高级配置

$3

`javascript
const sdk = createAuthSDK({
baseURL: 'https://api.example.com',
endpoints: {
passwordLogin: { url: '/custom/login', method: 'POST' },
mfaVerify: { url: '/custom/mfa/verify', method: 'POST' },
logout: { url: '/custom/logout', method: 'DELETE' }
}
});
`

$3

`javascript
const sdk = createAuthSDK({
baseURL: 'https://api.example.com',
headers: {
'Authorization': 'Bearer your-token',
'X-Client-Version': '1.0.0',
'X-Custom-Header': 'custom-value'
}
});
`

$3

`javascript
try {
const result = await authSDK.login(credentials);
if (result.success) {
// 处理成功情况
console.log('登录成功:', result.userInfo);
} else {
// 处理业务逻辑错误
console.error('登录失败:', result.message);
}
} catch (error) {
// 处理网络错误、系统错误等
if (error.code === 'NETWORK_ERROR') {
console.error('网络错误:', error.message);
} else if (error.code === 'TIMEOUT') {
console.error('请求超时:', error.message);
} else {
console.error('未知错误:', error.message);
}
}
`

📖 示例代码

查看 examples/ 目录获取完整的使用示例：

- examples/sdk-demo.html - 浏览器直接使用示例
- examples/node-demo.cjs - Node.js CommonJS 示例
- examples/node-demo.mjs - Node.js ES Module 示例
- examples/es6-demo.js - ES6 模块示例
- examples/react-demo.tsx - React 组件示例

🛠️ 开发

$3

`bash


安装依赖

`bash


运行 Node.js 示例

📄 许可证

MIT

🤝 贡献

欢迎提交 Issue 和 Pull Request！

📞 支持

如果您在使用过程中遇到问题，请通过以下方式联系我们：

- 提交 Issue
- 发送邮件至：support@example.com