lxns-rhythm-api 0.1.9 → 0.1.11

package/README.md

@@ -1,5 +1,7 @@
 # lxns-rhythm-api
 
+[![npm](https://img.shields.io/npm/v/lxns-rhythm-api.svg)](https://www.npmjs.com/package/lxns-rhythm-api)
+
 一个面向 [落雪咖啡屋查分器](https://maimai.lxns.net/) 的 TypeScript SDK，当前支持 `maimai` 与 `chunithm`。
 
 ## 特性
@@ -72,6 +74,45 @@ const jacket = await client.maimai.getAsset("jacket", 114);
 const icon = await client.chunithm.getAsset("icon", 1);
 ```
 
+## OAuth 流程
+
+```ts
+import { LxnsOAuthClient } from "lxns-rhythm-api";
+
+const client = new LxnsOAuthClient({
+  clientId: "<your-client-id>",
+  redirectURI: "https://example.com/callback",
+  clientSecret: "<your-client-secret>", // PKCE 可不传
+});
+
+// 1) 生成授权链接，跳转给用户
+const authorizeURL = client.createAuthorizeURL({
+  scope: ["read_user_profile", "read_player"],
+  state: "nonce", // 可选
+  codeChallenge: "<code-challenge>", // PKCE 可选
+  codeChallengeMethod: "S256",
+});
+
+// 2) 回调拿到 code 后换 token
+const token = await client.exchangeCodeForToken({
+  code: "<auth-code>",
+  codeVerifier: "<code-verifier>", // PKCE 模式传这个
+});
+
+// 3) 用 access_token 创建授权态客户端
+const authorized = client.createAuthorizedClient(token.access_token);
+
+// 4) 调用 OAuth 用户接口和 personal 接口
+const profile = await authorized.user.getProfile();
+const maimaiPlayer = await authorized.maimai.getPlayer();
+const chunithmPlayer = await authorized.chunithm.getPlayer();
+
+// 5) 刷新 token
+const nextToken = await client.refreshAccessToken({
+  refreshToken: token.refresh_token,
+});
+```
+
 ## 错误处理
 
 SDK 会将 API 错误统一抛为 `LxnsApiError`。
@@ -112,6 +153,7 @@ try {
 ```ts
 import {
   LxnsApiClient,
+  LxnsOAuthClient,
   LxnsApiError,
   isLxnsApiError,
   MaimaiModels,
@@ -123,6 +165,8 @@ import {
 
 - [Lxns maimai API](https://maimai.lxns.net/docs/api/maimai)
 - [Lxns chunithm API](https://maimai.lxns.net/docs/api/chunithm)
+- [Lxns OAuth API](https://maimai.lxns.net/docs/api/oauth)
+- [Lxns OAuth 接入指南](https://maimai.lxns.net/docs/oauth-guide)
 
 ## 构建与测试
 

package/dist/chunk-D7D4PA-g.mjs

@@ -0,0 +1,13 @@
+//#region \0rolldown/runtime.js
+var __defProp = Object.defineProperty;
+var __exportAll = (all, no_symbols) => {
+	let target = {};
+	for (var name in all) __defProp(target, name, {
+		get: all[name],
+		enumerable: true
+	});
+	if (!no_symbols) __defProp(target, Symbol.toStringTag, { value: "Module" });
+	return target;
+};
+//#endregion
+export { __exportAll as t };