@kiznavierr/kirara 1.0.1

package/.github/workflows/ci.yml

@@ -0,0 +1,46 @@
+name: Publish
+
+on:
+  push:
+    branches: [main]
+    paths: ["package.json"]
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x, 20.x]
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: "npm"
+      - run: npm ci
+      - run: npm run build
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20.x"
+          cache: "npm"
+          registry-url: "https://registry.npmjs.org"
+      - run: npm ci
+      - run: npm run build
+      - run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Kiznaiverr
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,72 @@
+# Kirara
+
+A TypeScript library for fetching Genshin Impact character data from the Enka API and generating card images using enka.cards. (HSR and ZZZ support coming soon)
+
+## Features
+
+- Fetch player profile data from Enka API
+- Retrieve list of character IDs
+- Generate image URLs for character cards
+- Download card images as Buffers
+- Support for customization options (language, substats, etc.)
+- Simple and modular design
+
+## Installation
+
+```bash
+npm install @kiznavierr/kirara
+```
+
+## Usage
+
+Import the library and create an instance:
+
+```typescript
+import { Kirara } from "@kiznavierr/kirara";
+
+const kirara = new Kirara();
+```
+
+Fetch player data:
+
+```typescript
+const playerData = await kirara.getPlayerData("856012067");
+console.log(playerData.playerInfo.nickname); // Output: Kiznavierr
+```
+
+Get list of character IDs:
+
+```typescript
+const avatars = await kirara.getAvatarList("856012067");
+console.log(avatars); // Output: ['10000047', '10000096', ...]
+```
+
+Generate image URL for the first character:
+
+```typescript
+const cardUrl = await kirara.generateDefaultCardUrl("856012067", {
+  lang: "en",
+});
+console.log(cardUrl); // Output: https://cards.enka.network/u/856012067/10000047/image?lang=en
+```
+
+Fetch image as Buffer:
+
+```typescript
+const imageBuffer = await kirara.generateDefaultCardImage("856012067");
+```
+
+```
+
+## API
+
+- `getPlayerData(uid: string)`: Fetch player data.
+- `getAvatarList(uid: string)`: Get list of avatar IDs.
+- `getDefaultAvatarId(uid: string)`: Get first avatar ID.
+- `generateCardUrl(uid: string, avatarId: string, options?)`: Generate image URL.
+- `generateCardImage(uid: string, avatarId: string, options?)`: Fetch image as Buffer.
+- `generateDefaultCardUrl(uid: string, options?)`: Generate URL for default avatar.
+- `generateDefaultCardImage(uid: string, options?)`: Fetch image for default avatar.
+
+
+```

package/dist/client/cardsClient.d.ts

@@ -0,0 +1,6 @@
+import { CardOptions } from "../types";
+export declare class CardsClient {
+    generateCardUrl(uid: string, avatarId: string, options?: CardOptions): string;
+    generateCardImage(uid: string, avatarId: string, options?: CardOptions): Promise<Buffer>;
+}
+//# sourceMappingURL=cardsClient.d.ts.map

package/dist/client/cardsClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cardsClient.d.ts","sourceRoot":"","sources":["../../src/client/cardsClient.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAEvC,qBAAa,WAAW;IACtB,eAAe,CACb,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,WAAW,GACpB,MAAM;IAmBH,iBAAiB,CACrB,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,MAAM,CAAC;CAKnB"}

package/dist/client/cardsClient.js

@@ -0,0 +1,36 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CardsClient = void 0;
+const axios_1 = __importDefault(require("axios"));
+class CardsClient {
+    generateCardUrl(uid, avatarId, options) {
+        let url = `https://cards.enka.network/u/${uid}/${avatarId}/image`;
+        if (options) {
+            const params = new URLSearchParams();
+            if (options.lang)
+                params.append("lang", options.lang);
+            if (options.substats !== undefined)
+                params.append("substats", options.substats.toString());
+            if (options.subsBreakdown !== undefined)
+                params.append("subsBreakdown", options.subsBreakdown.toString());
+            if (options.uid !== undefined)
+                params.append("uid", options.uid.toString());
+            if (options.hideNames !== undefined)
+                params.append("hideNames", options.hideNames.toString());
+            const query = params.toString();
+            if (query)
+                url += `?${query}`;
+        }
+        return url;
+    }
+    async generateCardImage(uid, avatarId, options) {
+        const url = this.generateCardUrl(uid, avatarId, options);
+        const response = await axios_1.default.get(url, { responseType: "arraybuffer" });
+        return Buffer.from(response.data);
+    }
+}
+exports.CardsClient = CardsClient;
+//# sourceMappingURL=cardsClient.js.map

package/dist/client/cardsClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cardsClient.js","sourceRoot":"","sources":["../../src/client/cardsClient.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAG1B,MAAa,WAAW;IACtB,eAAe,CACb,GAAW,EACX,QAAgB,EAChB,OAAqB;QAErB,IAAI,GAAG,GAAG,gCAAgC,GAAG,IAAI,QAAQ,QAAQ,CAAC;QAClE,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;YACrC,IAAI,OAAO,CAAC,IAAI;gBAAE,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;YACtD,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS;gBAChC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;YACzD,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS;gBACrC,MAAM,CAAC,MAAM,CAAC,eAAe,EAAE,OAAO,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC,CAAC;YACnE,IAAI,OAAO,CAAC,GAAG,KAAK,SAAS;gBAC3B,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;YAC/C,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS;gBACjC,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;YAC3D,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;YAChC,IAAI,KAAK;gBAAE,GAAG,IAAI,IAAI,KAAK,EAAE,CAAC;QAChC,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IAED,KAAK,CAAC,iBAAiB,CACrB,GAAW,EACX,QAAgB,EAChB,OAAqB;QAErB,MAAM,GAAG,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QACzD,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,YAAY,EAAE,aAAa,EAAE,CAAC,CAAC;QACvE,OAAO,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;CACF;AAjCD,kCAiCC"}

package/dist/client/enkaClient.d.ts

@@ -0,0 +1,5 @@
+import { PlayerData } from "../types";
+export declare class EnkaClient {
+    getPlayerData(uid: string): Promise<PlayerData>;
+}
+//# sourceMappingURL=enkaClient.d.ts.map

package/dist/client/enkaClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"enkaClient.d.ts","sourceRoot":"","sources":["../../src/client/enkaClient.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtC,qBAAa,UAAU;IACf,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;CAKtD"}

package/dist/client/enkaClient.js

@@ -0,0 +1,16 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EnkaClient = void 0;
+const axios_1 = __importDefault(require("axios"));
+class EnkaClient {
+    async getPlayerData(uid) {
+        const url = `https://enka.network/api/uid/${uid}?info`;
+        const response = await axios_1.default.get(url);
+        return response.data;
+    }
+}
+exports.EnkaClient = EnkaClient;
+//# sourceMappingURL=enkaClient.js.map

package/dist/client/enkaClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enkaClient.js","sourceRoot":"","sources":["../../src/client/enkaClient.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAG1B,MAAa,UAAU;IACrB,KAAK,CAAC,aAAa,CAAC,GAAW;QAC7B,MAAM,GAAG,GAAG,gCAAgC,GAAG,OAAO,CAAC;QACvD,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,GAAG,CAAa,GAAG,CAAC,CAAC;QAClD,OAAO,QAAQ,CAAC,IAAI,CAAC;IACvB,CAAC;CACF;AAND,gCAMC"}

package/dist/game/index.d.ts

@@ -0,0 +1,4 @@
+export type Game = "genshin";
+export declare function getApiBaseUrl(game: Game): string;
+export declare function getCardsBaseUrl(game: Game): string;
+//# sourceMappingURL=index.d.ts.map

package/dist/game/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/game/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,IAAI,GAAG,SAAS,CAAC;AAE7B,wBAAgB,aAAa,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAEhD;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAElD"}

package/dist/game/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getApiBaseUrl = getApiBaseUrl;
+exports.getCardsBaseUrl = getCardsBaseUrl;
+function getApiBaseUrl(game) {
+    return "https://enka.network/api/uid";
+}
+function getCardsBaseUrl(game) {
+    return "https://cards.enka.network/u";
+}
+//# sourceMappingURL=index.js.map

package/dist/game/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/game/index.ts"],"names":[],"mappings":";;AAEA,sCAEC;AAED,0CAEC;AAND,SAAgB,aAAa,CAAC,IAAU;IACtC,OAAO,8BAA8B,CAAC;AACxC,CAAC;AAED,SAAgB,eAAe,CAAC,IAAU;IACxC,OAAO,8BAA8B,CAAC;AACxC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { Kirara } from "./kirara.js";
+export * from "./types";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,cAAc,SAAS,CAAC"}

package/dist/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Kirara = void 0;
+var kirara_js_1 = require("./kirara.js");
+Object.defineProperty(exports, "Kirara", { enumerable: true, get: function () { return kirara_js_1.Kirara; } });
+__exportStar(require("./types"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,yCAAqC;AAA5B,mGAAA,MAAM,OAAA;AACf,0CAAwB"}

package/dist/kirara.d.ts

@@ -0,0 +1,13 @@
+import { PlayerData, CardOptions } from "./types";
+export declare class Kirara {
+    private enkaClient;
+    private cardsClient;
+    getPlayerData(uid: string): Promise<PlayerData>;
+    getAvatarList(uid: string): Promise<string[]>;
+    getDefaultAvatarId(uid: string): Promise<string | null>;
+    generateCardUrl(uid: string, avatarId: string, options?: CardOptions): string;
+    generateCardImage(uid: string, avatarId: string, options?: CardOptions): Promise<Buffer>;
+    generateDefaultCardUrl(uid: string, options?: CardOptions): Promise<string | null>;
+    generateDefaultCardImage(uid: string, options?: CardOptions): Promise<Buffer | null>;
+}
+//# sourceMappingURL=kirara.d.ts.map

package/dist/kirara.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"kirara.d.ts","sourceRoot":"","sources":["../src/kirara.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAElD,qBAAa,MAAM;IACjB,OAAO,CAAC,UAAU,CAAoB;IACtC,OAAO,CAAC,WAAW,CAAqB;IAElC,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAI/C,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAO7C,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAK7D,eAAe,CACb,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,WAAW,GACpB,MAAM;IAIH,iBAAiB,CACrB,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,MAAM,CAAC;IAIZ,sBAAsB,CAC1B,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAKnB,wBAAwB,CAC5B,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;CAI1B"}

package/dist/kirara.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Kirara = void 0;
+const enkaClient_1 = require("./client/enkaClient");
+const cardsClient_1 = require("./client/cardsClient");
+class Kirara {
+    constructor() {
+        this.enkaClient = new enkaClient_1.EnkaClient();
+        this.cardsClient = new cardsClient_1.CardsClient();
+    }
+    async getPlayerData(uid) {
+        return this.enkaClient.getPlayerData(uid);
+    }
+    async getAvatarList(uid) {
+        const data = await this.getPlayerData(uid);
+        return data.playerInfo.showAvatarInfoList.map((avatar) => avatar.avatarId.toString());
+    }
+    async getDefaultAvatarId(uid) {
+        const avatars = await this.getAvatarList(uid);
+        return avatars.length > 0 ? avatars[0] : null;
+    }
+    generateCardUrl(uid, avatarId, options) {
+        return this.cardsClient.generateCardUrl(uid, avatarId, options);
+    }
+    async generateCardImage(uid, avatarId, options) {
+        return this.cardsClient.generateCardImage(uid, avatarId, options);
+    }
+    async generateDefaultCardUrl(uid, options) {
+        const avatarId = await this.getDefaultAvatarId(uid);
+        return avatarId ? this.generateCardUrl(uid, avatarId, options) : null;
+    }
+    async generateDefaultCardImage(uid, options) {
+        const avatarId = await this.getDefaultAvatarId(uid);
+        return avatarId ? this.generateCardImage(uid, avatarId, options) : null;
+    }
+}
+exports.Kirara = Kirara;
+//# sourceMappingURL=kirara.js.map

package/dist/kirara.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"kirara.js","sourceRoot":"","sources":["../src/kirara.ts"],"names":[],"mappings":";;;AAAA,oDAAiD;AACjD,sDAAmD;AAGnD,MAAa,MAAM;IAAnB;QACU,eAAU,GAAG,IAAI,uBAAU,EAAE,CAAC;QAC9B,gBAAW,GAAG,IAAI,yBAAW,EAAE,CAAC;IAiD1C,CAAC;IA/CC,KAAK,CAAC,aAAa,CAAC,GAAW;QAC7B,OAAO,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IAC5C,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,GAAW;QAC7B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CACvD,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAC3B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,GAAW;QAClC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;QAC9C,OAAO,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAChD,CAAC;IAED,eAAe,CACb,GAAW,EACX,QAAgB,EAChB,OAAqB;QAErB,OAAO,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC,GAAG,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED,KAAK,CAAC,iBAAiB,CACrB,GAAW,EACX,QAAgB,EAChB,OAAqB;QAErB,OAAO,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAAC,GAAG,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED,KAAK,CAAC,sBAAsB,CAC1B,GAAW,EACX,OAAqB;QAErB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;QACpD,OAAO,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACxE,CAAC;IAED,KAAK,CAAC,wBAAwB,CAC5B,GAAW,EACX,OAAqB;QAErB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;QACpD,OAAO,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC1E,CAAC;CACF;AAnDD,wBAmDC"}

package/dist/types/index.d.ts

@@ -0,0 +1,38 @@
+export type Game = "genshin";
+export interface Avatar {
+    avatarId: string;
+    level: number;
+    talentLevel?: number;
+    energyType?: number;
+}
+export interface PlayerInfo {
+    nickname: string;
+    level: number;
+    signature: string;
+    worldLevel: number;
+    nameCardId: number;
+    finishAchievementNum: number;
+    towerFloorIndex: number;
+    towerLevelIndex: number;
+    isShowAvatarTalent?: boolean;
+    theaterActIndex?: number;
+    theaterModeIndex?: number;
+    theaterStarIndex?: number;
+    fetterCount?: number;
+    towerStarIndex?: number;
+    stygianIndex?: number;
+    stygianSeconds?: number;
+    stygianId?: number;
+    showAvatarInfoList: Avatar[];
+}
+export interface PlayerData {
+    playerInfo: PlayerInfo;
+}
+export interface CardOptions {
+    lang?: string;
+    substats?: boolean;
+    subsBreakdown?: boolean;
+    uid?: boolean;
+    hideNames?: boolean;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,IAAI,GAAG,SAAS,CAAC;AAE7B,MAAM,WAAW,MAAM;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,EAAE,MAAM,CAAC;IACxB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,kBAAkB,EAAE,MAAM,EAAE,CAAC;CAC9B;AAED,MAAM,WAAW,UAAU;IACzB,UAAU,EAAE,UAAU,CAAC;CACxB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB"}

package/dist/types/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@kiznavierr/kirara",
+  "version": "1.0.1",
+  "description": "A TypeScript library for fetching character data from Enka API and generating card images using enka.cards. Supports Genshin Impact, Honkai: Star Rail, and Zenless Zone Zero.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "genshin",
+    "enka",
+    "api",
+    "cards",
+    "typescript"
+  ],
+  "author": "Kiznaiverr",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Kiznaiverr/kirara.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Kiznaiverr/kirara/issues"
+  },
+  "homepage": "https://github.com/Kiznaiverr/kirara#readme",
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "ts-node": "^10.9.0",
+    "typescript": "^5.0.0"
+  },
+  "dependencies": {
+    "axios": "^1.6.0"
+  }
+}

package/src/client/cardsClient.ts

@@ -0,0 +1,37 @@
+import axios from "axios";
+import { CardOptions } from "../types";
+
+export class CardsClient {
+  generateCardUrl(
+    uid: string,
+    avatarId: string,
+    options?: CardOptions,
+  ): string {
+    let url = `https://cards.enka.network/u/${uid}/${avatarId}/image`;
+    if (options) {
+      const params = new URLSearchParams();
+      if (options.lang) params.append("lang", options.lang);
+      if (options.substats !== undefined)
+        params.append("substats", options.substats.toString());
+      if (options.subsBreakdown !== undefined)
+        params.append("subsBreakdown", options.subsBreakdown.toString());
+      if (options.uid !== undefined)
+        params.append("uid", options.uid.toString());
+      if (options.hideNames !== undefined)
+        params.append("hideNames", options.hideNames.toString());
+      const query = params.toString();
+      if (query) url += `?${query}`;
+    }
+    return url;
+  }
+
+  async generateCardImage(
+    uid: string,
+    avatarId: string,
+    options?: CardOptions,
+  ): Promise<Buffer> {
+    const url = this.generateCardUrl(uid, avatarId, options);
+    const response = await axios.get(url, { responseType: "arraybuffer" });
+    return Buffer.from(response.data);
+  }
+}

package/src/client/enkaClient.ts

@@ -0,0 +1,10 @@
+import axios from "axios";
+import { PlayerData } from "../types";
+
+export class EnkaClient {
+  async getPlayerData(uid: string): Promise<PlayerData> {
+    const url = `https://enka.network/api/uid/${uid}?info`;
+    const response = await axios.get<PlayerData>(url);
+    return response.data;
+  }
+}

package/src/game/index.ts

@@ -0,0 +1,9 @@
+export type Game = "genshin";
+
+export function getApiBaseUrl(game: Game): string {
+  return "https://enka.network/api/uid";
+}
+
+export function getCardsBaseUrl(game: Game): string {
+  return "https://cards.enka.network/u";
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export { Kirara } from "./kirara.js";
+export * from "./types";

package/src/kirara.ts

@@ -0,0 +1,56 @@
+import { EnkaClient } from "./client/enkaClient";
+import { CardsClient } from "./client/cardsClient";
+import { PlayerData, CardOptions } from "./types";
+
+export class Kirara {
+  private enkaClient = new EnkaClient();
+  private cardsClient = new CardsClient();
+
+  async getPlayerData(uid: string): Promise<PlayerData> {
+    return this.enkaClient.getPlayerData(uid);
+  }
+
+  async getAvatarList(uid: string): Promise<string[]> {
+    const data = await this.getPlayerData(uid);
+    return data.playerInfo.showAvatarInfoList.map((avatar) =>
+      avatar.avatarId.toString(),
+    );
+  }
+
+  async getDefaultAvatarId(uid: string): Promise<string | null> {
+    const avatars = await this.getAvatarList(uid);
+    return avatars.length > 0 ? avatars[0] : null;
+  }
+
+  generateCardUrl(
+    uid: string,
+    avatarId: string,
+    options?: CardOptions,
+  ): string {
+    return this.cardsClient.generateCardUrl(uid, avatarId, options);
+  }
+
+  async generateCardImage(
+    uid: string,
+    avatarId: string,
+    options?: CardOptions,
+  ): Promise<Buffer> {
+    return this.cardsClient.generateCardImage(uid, avatarId, options);
+  }
+
+  async generateDefaultCardUrl(
+    uid: string,
+    options?: CardOptions,
+  ): Promise<string | null> {
+    const avatarId = await this.getDefaultAvatarId(uid);
+    return avatarId ? this.generateCardUrl(uid, avatarId, options) : null;
+  }
+
+  async generateDefaultCardImage(
+    uid: string,
+    options?: CardOptions,
+  ): Promise<Buffer | null> {
+    const avatarId = await this.getDefaultAvatarId(uid);
+    return avatarId ? this.generateCardImage(uid, avatarId, options) : null;
+  }
+}

package/src/types/index.ts

@@ -0,0 +1,41 @@
+export type Game = "genshin";
+
+export interface Avatar {
+  avatarId: string;
+  level: number;
+  talentLevel?: number;
+  energyType?: number;
+}
+
+export interface PlayerInfo {
+  nickname: string;
+  level: number;
+  signature: string;
+  worldLevel: number;
+  nameCardId: number;
+  finishAchievementNum: number;
+  towerFloorIndex: number;
+  towerLevelIndex: number;
+  isShowAvatarTalent?: boolean;
+  theaterActIndex?: number;
+  theaterModeIndex?: number;
+  theaterStarIndex?: number;
+  fetterCount?: number;
+  towerStarIndex?: number;
+  stygianIndex?: number;
+  stygianSeconds?: number;
+  stygianId?: number;
+  showAvatarInfoList: Avatar[];
+}
+
+export interface PlayerData {
+  playerInfo: PlayerInfo;
+}
+
+export interface CardOptions {
+  lang?: string;
+  substats?: boolean;
+  subsBreakdown?: boolean;
+  uid?: boolean;
+  hideNames?: boolean;
+}

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "commonjs",
+    "lib": ["ES2020"],
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist", "**/*.test.ts"]
+}