lxns-rhythm-api 0.1.1 → 0.1.3

package/README.md

@@ -1,28 +1,28 @@
-# lxns-sdk
+# lxns-rhythm-api
 
 一个用于访问 Lxns API 的轻量 TypeScript SDK。
 
 - 零运行时依赖（仅使用 `ky` 发起请求）。
 - 类型安全：根据传入的 token 自动在 `maimai` 命名空间上暴露 `public` / `dev` / `personal` 子 API。
-- 现代构建（ESM/CJS/类型声明）。
+- 现代构建
 
 ## 安装
 
 ```bash
 # npm
-npm i lxns-sdk
+npm i lxns-rhythm-api
 
 # pnpm
-pnpm add lxns-sdk
+pnpm add lxns-rhythm-api
 
 # yarn
-yarn add lxns-sdk
+yarn add lxns-rhythm-api
 ```
 
 ## 快速开始
 
 ```ts
-import { LxnsApiClient } from "lxns-sdk";
+import { LxnsApiClient } from "lxns-rhythm-api";
 
 // 无 token：仅可用 public API
 const client = new LxnsApiClient();
@@ -44,12 +44,6 @@ const me = await personalClient.maimai.personal.getPlayer();
 console.log(me);
 ```
 
-CommonJS 引用：
-
-```js
-const { LxnsApiClient } = require("lxns-sdk");
-```
-
 ## 配置项
 
 构造函数签名：
@@ -75,6 +69,11 @@ new LxnsApiClient(options?: {
 
 > 注意：`baseURL` 默认值为 `https://maimai.lxns.net/api/v0/`。
 
+## TODO
+
+- [ ] 支持 Chuni API
+- [x] 支持 Maimai API
+
 ## API 概览
 
 - `maimai.public`

package/package.json

@@ -2,15 +2,14 @@
   "name": "lxns-rhythm-api",
   "description": "A simple SDK for lxns api.",
   "author": "amatsuka <amatsukamao@qq.com>",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "repository": {
     "type": "git",
     "url": "https://github.com/wsyzxjn/lxns-rhythm-api.git"
   },
   "exports": {
     ".": {
-      "import": "./dist/index.js",
-      "require": "./dist/index.cjs"
+      "import": "./dist/index.js"
     },
     "./package.json": "./package.json"
   },
@@ -21,7 +20,7 @@
     "LICENSE"
   ],
   "type": "module",
-  "main": "./dist/index.cjs",
+  "main": "./dist/index.js",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "devDependencies": {

package/dist/index.cjs

@@ -1,383 +0,0 @@
-"use strict";
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/index.ts
-var index_exports = {};
-__export(index_exports, {
-  LxnsApiClient: () => LxnsApiClient,
-  MaimaiModels: () => models_exports
-});
-module.exports = __toCommonJS(index_exports);
-
-// src/apis/maimai/models.ts
-var models_exports = {};
-__export(models_exports, {
-  LevelIndex: () => LevelIndex
-});
-var LevelIndex = /* @__PURE__ */ ((LevelIndex2) => {
-  LevelIndex2[LevelIndex2["BASIC"] = 0] = "BASIC";
-  LevelIndex2[LevelIndex2["ADVANCED"] = 1] = "ADVANCED";
-  LevelIndex2[LevelIndex2["EXPERT"] = 2] = "EXPERT";
-  LevelIndex2[LevelIndex2["MASTER"] = 3] = "MASTER";
-  LevelIndex2[LevelIndex2["RE_MASTER"] = 4] = "RE_MASTER";
-  return LevelIndex2;
-})(LevelIndex || {});
-
-// src/client/LxnsApiCLient.ts
-var import_ky = __toESM(require("ky"), 1);
-
-// src/apis/maimai/entities/Song.ts
-var LevelArray = [
-  "basic",
-  "advanced",
-  "expert",
-  "master",
-  "remaster"
-];
-function convertDifficulty(difficulty) {
-  return difficulty.reduce(
-    (acc, cur) => {
-      acc[LevelArray[cur.difficulty]] = cur;
-      return acc;
-    },
-    {}
-  );
-}
-var Song = class {
-  id;
-  title;
-  artist;
-  genre;
-  version;
-  bpm;
-  difficulties;
-  locked;
-  disabled;
-  rights;
-  constructor(song) {
-    this.id = song.id;
-    this.title = song.title;
-    this.artist = song.artist;
-    this.genre = song.genre;
-    this.version = song.version;
-    this.bpm = song.bpm;
-    this.difficulties = song.difficulties;
-    this.locked = song.locked ?? false;
-    this.disabled = song.disabled ?? false;
-    this.rights = song.rights;
-  }
-  get standard() {
-    if (this.difficulties.standard.length === 0) return null;
-    return convertDifficulty(this.difficulties.standard);
-  }
-  get dx() {
-    if (this.difficulties.dx.length === 0) return null;
-    return convertDifficulty(this.difficulties.dx);
-  }
-  get utage() {
-    if (!this.difficulties.utage) return null;
-    return convertDifficulty(this.difficulties.utage);
-  }
-};
-
-// src/apis/maimai/public.ts
-var MaimaiPublicApi = class {
-  constructor(http) {
-    this.http = http;
-  }
-  /**
-   * 获取歌曲列表
-   * @param version 版本，不填写遵循api默认行为
-   * @param notes 是否包含谱面信息，不填写遵循api默认行为
-   * @returns 歌曲列表
-   */
-  async getSongList(version, notes) {
-    return this.http.get("song/list?", { searchParams: { version, notes } }).json();
-  }
-  /**
-   * 获取歌曲信息
-   * @param id 歌曲 ID
-   * @returns 歌曲信息
-   */
-  async getSong(id) {
-    const songInfo = await this.http.get(`song/${id}`).json();
-    return new Song(songInfo);
-  }
-  /**
-   * 获取歌曲别名列表
-   * @returns 歌曲别名列表
-   */
-  async getAliasList() {
-    return this.http.get("alias/list").json();
-  }
-  /**
-   * 获取收藏品列表
-   * @param collectionType trophy | icon | plate | frame
-   * @param options.version 版本，不填写遵循api默认行为
-   * @param options.required 是否包含曲目需求，默认值为 false
-   * @returns 收藏品列表
-   */
-  async getCollectionList(collectionType, options) {
-    const collectionMap = {
-      trophy: "trophies",
-      icon: "icons",
-      plate: "plates",
-      frame: "frames"
-    };
-    return this.http.get(`${collectionType}/list`, { searchParams: { ...options } }).json().then((res) => res[collectionMap[collectionType]]);
-  }
-  /**
-   * 获取收藏品信息
-   * @param collectionType trophy | icon | plate | frame
-   * @param id 收藏品 ID
-   * @param options.version 版本，不填写遵循api默认行为
-   * @returns 收藏品信息
-   */
-  async getCollectionInfo(collectionType, id, options) {
-    return this.http.get(`${collectionType}/${id}`, { searchParams: { ...options } }).json();
-  }
-  /**
-   * 获取收藏品分类列表
-   * @param options.version 版本，不填写遵循api默认行为
-   * @returns 收藏品分类列表
-   */
-  async getCollectionGenreList(options) {
-    return this.http.get("collection-genre/list", { searchParams: { ...options } }).json();
-  }
-  /**
-   * 获取收藏品分类信息
-   * @param id 收藏品分类 ID
-   * @param options.version 版本，不填写遵循api默认行为
-   * @returns 收藏品分类信息
-   */
-  async getCollectionGenreInfo(id, options) {
-    return this.http.get(`collection-genre/${id}`, { searchParams: { ...options } }).json();
-  }
-};
-
-// src/apis/maimai/dev.ts
-var MaimaiDevApi = class {
-  constructor(http) {
-    this.http = http;
-  }
-  /**
-   * 创建或修改玩家信息
-   * @param body 玩家信息
-   * @returns 玩家信息
-   */
-  async postPlayer(body) {
-    return this.http.post("player", { json: body }).json();
-  }
-  /**
-   * 获取玩家信息（通过好友码）
-   * @param friendCode 好友码
-   * @returns 玩家信息
-   */
-  async getPlayer(friendCode) {
-    return this.http.get(`player/${friendCode}`).json();
-  }
-  /**
-   * 获取玩家信息（通过 QQ 号）
-   * @param qq QQ 号
-   * @returns 玩家信息
-   */
-  async getPlayerByQQ(qq) {
-    return this.http.get(`player/qq/${qq}`).json();
-  }
-  /**
-   * 获取 Best 50（standard 35 + dx 15）
-   * @param friendCode 好友码
-   * @returns Best 50
-   */
-  async getBests(friendCode) {
-    return this.http.get(`player/${friendCode}/bests`).json();
-  }
-  /**
-   * 获取 AP 50
-   * @param friendCode 好友码
-   * @returns AP 50
-   */
-  async getApBests(friendCode) {
-    return this.http.get(`player/${friendCode}/bests/ap`).json();
-  }
-  /**
-   * 获取 Recent 50（仅增量爬取可用）
-   * @param friendCode 好友码
-   * @returns Recent 50
-   */
-  async getRecents(friendCode) {
-    return this.http.get(`player/${friendCode}/recents`).json();
-  }
-  /**
-   * 获取玩家缓存的所有最佳成绩（简化）
-   * @param friendCode 好友码
-   * @returns BestScoreList
-   */
-  async getAllBestScores(friendCode) {
-    return this.http.get(`player/${friendCode}/scores`).json();
-  }
-  /**
-   * 成绩上传热力图（YYYY-MM-DD -> 数量）
-   * @param friendCode 好友码
-   * @returns Heatmap
-   */
-  async getHeatmap(friendCode) {
-    return this.http.get(`player/${friendCode}/heatmap`).json();
-  }
-  /**
-   * DX Rating 趋势
-   * @param friendCode 好友码
-   * @returns TrendList
-   */
-  async getTrend(friendCode) {
-    return this.http.get(`player/${friendCode}/trend`).json();
-  }
-  /**
-   * 成绩游玩历史记录（仅返回带有 play_time 的成绩）
-   * @param friendCode 好友码
-   * @returns 游玩历史记录
-   */
-  async getScoreHistory(friendCode) {
-    return this.http.get(`player/${friendCode}/score/history`).json();
-  }
-  /**
-   * 获取玩家收藏品进度
-   * @param friendCode 好友码
-   * @param collectionType 收藏品类型
-   * @param collectionId 收藏品 ID
-   * @returns 收藏品进度
-   */
-  async getCollectionProgress(friendCode, collectionType, collectionId) {
-    return this.http.get(`player/${friendCode}/${collectionType}/${collectionId}`).json();
-  }
-  /**
-   * 上传玩家成绩
-   * @param friendCode 好友码
-   * @param scores 成绩列表
-   * @returns 上传结果
-   */
-  async postScores(friendCode, scores) {
-    const body = { scores };
-    return this.http.post(`player/${friendCode}/scores`, { json: body }).json();
-  }
-  /**
-   * 通过 NET 的 HTML 源代码上传玩家数据
-   * @param friendCode 好友码
-   * @param htmlSource HTML 源代码
-   * @returns 上传结果
-   */
-  async postHtml(friendCode, htmlSource) {
-    return this.http.post(`player/${friendCode}/html`, {
-      body: htmlSource,
-      headers: { "content-type": "text/plain" }
-    }).json();
-  }
-};
-
-// src/apis/maimai/personal.ts
-var MaimaiPersonalApi = class {
-  constructor(http) {
-    this.http = http;
-  }
-  /**
-   * 获取玩家信息
-   * GET /api/v0/user/maimai/player
-   * @returns PlayerInfo
-   */
-  async getPlayer() {
-    return this.http.get("player").json();
-  }
-  /**
-   * 获取玩家所有成绩
-   * GET /api/v0/user/maimai/player/scores
-   * @returns PlayerScores
-   */
-  async getScores() {
-    return this.http.get("scores").json();
-  }
-  /**
-   * 上传玩家成绩
-   * POST /api/v0/user/maimai/player/scores
-   * @param scores 成绩列表
-   * @returns 上传结果
-   */
-  async postScores(scores) {
-    const body = { scores };
-    return this.http.post("scores", { json: body }).json();
-  }
-};
-
-// src/client/LxnsApiCLient.ts
-var LxnsApiClient = class {
-  config = {
-    baseURL: "https://maimai.lxns.net/api/v0/"
-  };
-  /**
-   * maimai API
-   */
-  maimai;
-  constructor(config) {
-    this.config = {
-      baseURL: config?.baseURL ?? this.config.baseURL,
-      personalAccessToken: config?.personalAccessToken,
-      devAccessToken: config?.devAccessToken
-    };
-    const { baseURL, devAccessToken, personalAccessToken } = this.config;
-    const httpPublic = import_ky.default.create({
-      prefixUrl: new URL("maimai/", baseURL)
-    });
-    const httpDev = devAccessToken ? import_ky.default.create({
-      prefixUrl: new URL("maimai/", baseURL),
-      headers: {
-        Authorization: devAccessToken
-      }
-    }) : void 0;
-    const httpPersonal = personalAccessToken ? import_ky.default.create({
-      prefixUrl: new URL("user/maimai/", baseURL),
-      headers: {
-        "X-User-Token": personalAccessToken
-      }
-    }) : void 0;
-    const maimai = {
-      public: new MaimaiPublicApi(httpPublic)
-    };
-    if (httpDev) {
-      maimai.dev = new MaimaiDevApi(httpDev);
-    }
-    if (httpPersonal) {
-      maimai.personal = new MaimaiPersonalApi(httpPersonal);
-    }
-    this.maimai = maimai;
-  }
-};
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  LxnsApiClient,
-  MaimaiModels
-});