sekai-calculator 0.4.0 → 0.4.1

package/README.md

@@ -7,4 +7,21 @@ This project is fully developed with TypeScript, while reducing `any` as possibl
 Both ECMAScript Module `index.mjs` and CommonJS `index.cjs` are provided with types `index.d.ts` for TypeScript.
 
 ## Quick Start
-W.I.P.
+### Install
+This package has been released in [npm](https://www.npmjs.com/package/sekai-calculator).
+```shell
+# npm
+npm i sekai-calculator
+# yarn
+yarn add sekai-calculator
+# pnpm
+pnpm add sekai-calculator
+```
+### Usage
+Example is written in TypeScript.
+
+A `DataProvider` implementation is required for providing `UserData`, `MasterData` and `MusicMeta`.
+Basically, `UserArea`, `UserCard`, `UserCharacter` and `UserHonor` are required in `UserData`.
+```typescript
+// W.I.P.
+```

package/dist/index.cjs

@@ -554,11 +554,14 @@ class BaseDeckRecommend {
         }
         return afterFilter;
     }
-    static findBestCards(cardDetails, scoreFunc, limit = 1, isChallengeLive = false, member = 5, deckCards = [], deckCharacters = []) {
+    static findBestCards(cardDetails, scoreFunc, limit = 1, isChallengeLive = false, member = 5, honorBonus = 0, deckCards = [], deckCharacters = []) {
         if (deckCards.length === member) {
             const score = scoreFunc(deckCards);
+            const deckDetail = DeckCalculator.getDeckDetailByCards(deckCards, honorBonus);
             return [{
                     score,
+                    power: deckDetail.power,
+                    eventBonus: deckDetail.eventBonus,
                     deckCards
                 }];
         }
@@ -579,7 +582,7 @@ class BaseDeckRecommend {
             if (CardCalculator.isCertainlyLessThan(card, preCard))
                 continue;
             preCard = card;
-            const result = BaseDeckRecommend.findBestCards(cardDetails, scoreFunc, limit, isChallengeLive, member, [...deckCards, card], [...deckCharacters, card.characterId]);
+            const result = BaseDeckRecommend.findBestCards(cardDetails, scoreFunc, limit, isChallengeLive, member, honorBonus, [...deckCards, card], [...deckCharacters, card.characterId]);
             ans = [...ans, ...result].sort((a, b) => b.score - a.score);
             if (ans.length > limit)
                 ans = ans.slice(0, limit);
@@ -593,7 +596,7 @@ class BaseDeckRecommend {
         let cardDetails = (isChallengeLive || eventId === 0) ? cards : BaseDeckRecommend.filterCard(cards);
         cardDetails = cardDetails.sort((a, b) => a.cardId - b.cardId);
         const honorBonus = await this.deckCalculator.getHonorBonusPower();
-        return BaseDeckRecommend.findBestCards(cardDetails, deckCards => scoreFunc(musicMeta, honorBonus, deckCards), limit, isChallengeLive, member);
+        return BaseDeckRecommend.findBestCards(cardDetails, deckCards => scoreFunc(musicMeta, honorBonus, deckCards), limit, isChallengeLive, member, honorBonus);
     }
     static getLiveScoreFunction(liveType) {
         return (musicMeta, honorBonus, deckCards) => LiveCalculator.getLiveScoreByDeck(deckCards, honorBonus, musicMeta, liveType);
@@ -619,6 +622,7 @@ class ChallengeLiveDeckRecommend {
         return recommend.map(it => {
             return {
                 score: it.score,
+                power: it.power,
                 deck: DeckService.toUserChallengeLiveSoloDeck(it.deckCards, characterId)
             };
         });
@@ -638,6 +642,8 @@ class EventDeckRecommend {
         return recommend.map(it => {
             return {
                 point: it.score,
+                power: it.power,
+                eventBonus: it.eventBonus,
                 deck: DeckService.toUserDeck(it.deckCards)
             };
         });

package/dist/index.d.ts

@@ -256,6 +256,7 @@ declare class ChallengeLiveDeckRecommend {
     constructor(dataProvider: DataProvider);
     recommendChallengeLiveDeck(characterId: number, musicMeta: MusicMeta, limit?: number, member?: number): Promise<Array<{
         score: number;
+        power: number;
         deck: UserChallengeLiveSoloDeck;
     }>>;
 }
@@ -266,6 +267,8 @@ declare class EventDeckRecommend {
     constructor(dataProvider: DataProvider);
     recommendEventDeck(eventId: number, musicMeta: MusicMeta, liveType: LiveType, limit?: number): Promise<Array<{
         point: number;
+        power: number;
+        eventBonus?: number;
         deck: UserDeck;
     }>>;
 }

package/dist/index.mjs

@@ -552,11 +552,14 @@ class BaseDeckRecommend {
         }
         return afterFilter;
     }
-    static findBestCards(cardDetails, scoreFunc, limit = 1, isChallengeLive = false, member = 5, deckCards = [], deckCharacters = []) {
+    static findBestCards(cardDetails, scoreFunc, limit = 1, isChallengeLive = false, member = 5, honorBonus = 0, deckCards = [], deckCharacters = []) {
         if (deckCards.length === member) {
             const score = scoreFunc(deckCards);
+            const deckDetail = DeckCalculator.getDeckDetailByCards(deckCards, honorBonus);
             return [{
                     score,
+                    power: deckDetail.power,
+                    eventBonus: deckDetail.eventBonus,
                     deckCards
                 }];
         }
@@ -577,7 +580,7 @@ class BaseDeckRecommend {
             if (CardCalculator.isCertainlyLessThan(card, preCard))
                 continue;
             preCard = card;
-            const result = BaseDeckRecommend.findBestCards(cardDetails, scoreFunc, limit, isChallengeLive, member, [...deckCards, card], [...deckCharacters, card.characterId]);
+            const result = BaseDeckRecommend.findBestCards(cardDetails, scoreFunc, limit, isChallengeLive, member, honorBonus, [...deckCards, card], [...deckCharacters, card.characterId]);
             ans = [...ans, ...result].sort((a, b) => b.score - a.score);
             if (ans.length > limit)
                 ans = ans.slice(0, limit);
@@ -591,7 +594,7 @@ class BaseDeckRecommend {
         let cardDetails = (isChallengeLive || eventId === 0) ? cards : BaseDeckRecommend.filterCard(cards);
         cardDetails = cardDetails.sort((a, b) => a.cardId - b.cardId);
         const honorBonus = await this.deckCalculator.getHonorBonusPower();
-        return BaseDeckRecommend.findBestCards(cardDetails, deckCards => scoreFunc(musicMeta, honorBonus, deckCards), limit, isChallengeLive, member);
+        return BaseDeckRecommend.findBestCards(cardDetails, deckCards => scoreFunc(musicMeta, honorBonus, deckCards), limit, isChallengeLive, member, honorBonus);
     }
     static getLiveScoreFunction(liveType) {
         return (musicMeta, honorBonus, deckCards) => LiveCalculator.getLiveScoreByDeck(deckCards, honorBonus, musicMeta, liveType);
@@ -617,6 +620,7 @@ class ChallengeLiveDeckRecommend {
         return recommend.map(it => {
             return {
                 score: it.score,
+                power: it.power,
                 deck: DeckService.toUserChallengeLiveSoloDeck(it.deckCards, characterId)
             };
         });
@@ -636,6 +640,8 @@ class EventDeckRecommend {
         return recommend.map(it => {
             return {
                 point: it.score,
+                power: it.power,
+                eventBonus: it.eventBonus,
                 deck: DeckService.toUserDeck(it.deckCards)
             };
         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sekai-calculator",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "Project SEKAI Calculator for deck power, live score, event point and more.",
   "type": "module",
   "types": "dist/index.d.ts",