lxns-rhythm-api 0.1.2 → 0.1.4

package/README.md

@@ -1,4 +1,4 @@
-# lxns-sdk
+# lxns-rhythm-api
 
 一个用于访问 Lxns API 的轻量 TypeScript SDK。
 
@@ -10,19 +10,19 @@
 
 ```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();
@@ -69,6 +69,11 @@ new LxnsApiClient(options?: {
 
 > 注意：`baseURL` 默认值为 `https://maimai.lxns.net/api/v0/`。
 
+## TODO
+
+- [ ] 支持 Chuni API
+- [x] 支持 Maimai API
+
 ## API 概览
 
 - `maimai.public`

package/dist/index.d.ts

@@ -184,6 +184,7 @@ interface CollectionGenre {
 type FCType = "app" | "ap" | "fcp" | "fc";
 type FSType = "fsdp" | "fsd" | "fsp" | "fs" | "sync";
 type RateType = "sssp" | "sss" | "ssp" | "ss" | "sp" | "s" | "aaa" | "aa" | "a" | "bbb" | "bb" | "b" | "c" | "d";
+type AssetType = "icon" | "plate" | "frame" | "jacket" | "music";
 interface Score {
     /** 曲目 ID */
     id: number;
@@ -254,6 +255,7 @@ interface Frame extends Collection {
 }
 
 type models_Alias = Alias;
+type models_AssetType = AssetType;
 type models_BuddyNotes = BuddyNotes;
 type models_Collection = Collection;
 type models_CollectionGenre = CollectionGenre;
@@ -280,7 +282,7 @@ type models_SongType = SongType;
 type models_Trophy = Trophy;
 type models_Version = Version;
 declare namespace models {
-  export { type models_Alias as Alias, type models_BuddyNotes as BuddyNotes, type models_Collection as Collection, type models_CollectionGenre as CollectionGenre, type models_CollectionRequired as CollectionRequired, type models_CollectionRequiredSong as CollectionRequiredSong, type models_FCType as FCType, type models_FSType as FSType, type models_Frame as Frame, type models_Genre as Genre, type models_Icon as Icon, models_LevelIndex as LevelIndex, type models_NamePlate as NamePlate, type models_Notes as Notes, type models_Player as Player, type models_RateType as RateType, type models_RatingTrend as RatingTrend, type models_Score as Score, type models_SimpleScore as SimpleScore, type Song$1 as Song, type models_SongDifficulties as SongDifficulties, type models_SongDifficulty as SongDifficulty, type models_SongDifficultyUtage as SongDifficultyUtage, type models_SongType as SongType, type models_Trophy as Trophy, type models_Version as Version };
+  export { type models_Alias as Alias, type models_AssetType as AssetType, type models_BuddyNotes as BuddyNotes, type models_Collection as Collection, type models_CollectionGenre as CollectionGenre, type models_CollectionRequired as CollectionRequired, type models_CollectionRequiredSong as CollectionRequiredSong, type models_FCType as FCType, type models_FSType as FSType, type models_Frame as Frame, type models_Genre as Genre, type models_Icon as Icon, models_LevelIndex as LevelIndex, type models_NamePlate as NamePlate, type models_Notes as Notes, type models_Player as Player, type models_RateType as RateType, type models_RatingTrend as RatingTrend, type models_Score as Score, type models_SimpleScore as SimpleScore, type Song$1 as Song, type models_SongDifficulties as SongDifficulties, type models_SongDifficulty as SongDifficulty, type models_SongDifficultyUtage as SongDifficultyUtage, type models_SongType as SongType, type models_Trophy as Trophy, type models_Version as Version };
 }
 
 interface SongList {
@@ -513,9 +515,13 @@ type Simplify<T> = {
     [K in keyof T]: T[K];
 } & {};
 type IfDefined<T, Then, Else = {}> = [T] extends [NonNullable<T>] ? Then : Else;
-type MaiMaiOf<O extends Flags> = Simplify<{
+type MaiMai = {
     public: MaimaiPublicApi;
-} & IfDefined<O["devAccessToken"], {
+    dev?: MaimaiDevApi;
+    personal?: MaimaiPersonalApi;
+    getAsset: (type: AssetType, id: number) => Promise<Buffer>;
+};
+type MaiMaiOf<O extends Flags> = Simplify<Omit<MaiMai, "dev" | "personal"> & IfDefined<O["devAccessToken"], {
     dev: MaimaiDevApi;
 }> & IfDefined<O["personalAccessToken"], {
     personal: MaimaiPersonalApi;

package/dist/index.js

@@ -334,7 +334,14 @@ var LxnsApiClient = class {
       }
     }) : void 0;
     const maimai = {
-      public: new MaimaiPublicApi(httpPublic)
+      public: new MaimaiPublicApi(httpPublic),
+      getAsset: async (type, id) => {
+        return Buffer.from(
+          await ky.get(
+            `https://assets2.lxns.net/maimai/${type}/${id + (type === "music" ? ".mp3" : ".png")}`
+          ).arrayBuffer()
+        );
+      }
     };
     if (httpDev) {
       maimai.dev = new MaimaiDevApi(httpDev);

package/package.json

@@ -2,7 +2,7 @@
   "name": "lxns-rhythm-api",
   "description": "A simple SDK for lxns api.",
   "author": "amatsuka <amatsukamao@qq.com>",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "repository": {
     "type": "git",
     "url": "https://github.com/wsyzxjn/lxns-rhythm-api.git"
@@ -19,10 +19,19 @@
     "README.md",
     "LICENSE"
   ],
+  "packageManager": "pnpm@10.16.1",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "scripts": {
+    "lint": "eslint --ext .ts,.js src",
+    "prettier": "prettier --write 'src/**/*.ts'",
+    "test": "tsx tests/index.ts",
+    "build": "tsup",
+    "build:production": "cross-env NODE_ENV=production tsup",
+    "prepublishOnly": "pnpm run prettier && pnpm run build"
+  },
   "devDependencies": {
     "@types/node": "^24.5.1",
     "@typescript-eslint/eslint-plugin": "^8.44.0",
@@ -37,12 +46,5 @@
   },
   "dependencies": {
     "ky": "^1.10.0"
-  },
-  "scripts": {
-    "lint": "eslint --ext .ts,.js src",
-    "prettier": "prettier --write 'src/**/*.ts'",
-    "test": "tsx tests/index.ts",
-    "build": "tsup",
-    "build:production": "cross-env NODE_ENV=production tsup"
   }
-}
+}