poi-plugin-quest-info-2 0.5.4 → 0.5.5

package/README.md

@@ -5,14 +5,29 @@
 
 A [poi](https://github.com/poooi/poi) plugin that helps you view quest info. Data maintained by [kcanotify-gamedata](https://github.com/antest1/kcanotify-gamedata) & [kc3-translations](https://github.com/KC3Kai/kc3-translations) & [kcQuests](https://github.com/kcwikizh/kcQuests).
 
+![image](https://user-images.githubusercontent.com/18554747/143771661-00965277-5c45-454d-b4f0-57083ec3065d.png)
+
 ## Installation
 
 Paste `poi-plugin-quest-info-2` in the plugins tab and click the install button.
 
+## Features
+
+- Translated quest info.(English/Simplified Chinese/Traditional Chinese/Korean)
+- Task panel translation.
+- Quest search and filter.
+- Sync with game quest data.
+- Auto switch to quest tab when enter quest views.
+
 ## Thanks
 
 - [poi](https://github.com/poooi/poi)
-- [kcanotify-gamedata](https://github.com/antest1/kcanotify-gamedata)
-- [poi-plugin-tabex](https://github.com/momocow/poi-plugin-tabex)
 - [plugin-quest](https://github.com/poooi/plugin-quest)
+- [kcanotify-gamedata](https://github.com/antest1/kcanotify-gamedata)
 - [kcQuests](https://github.com/kcwikizh/kcQuests)
+- [舰娘百科](https://zh.kcwiki.cn/wiki/%E8%88%B0%E5%A8%98%E7%99%BE%E7%A7%91)
+- [poi-plugin-tabex](https://github.com/momocow/poi-plugin-tabex)
+
+## License
+
+MIT

package/build/kcQuestsData/DATA_VERSION

@@ -1 +1 @@
-a89f6893478705a9b710472ffeafb5a45122b9ce
+004638c4fa18cf4d37e45f3a8704bffe7cdaa49e

package/build/kcQuestsData/index.ts

@@ -4,4 +4,4 @@ export const KcwikiQuestData = {
   'zh-CN': zh_CN,
 }
 
-export const version = 'a89f6893478705a9b710472ffeafb5a45122b9ce'
+export const version = '004638c4fa18cf4d37e45f3a8704bffe7cdaa49e'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "poi-plugin-quest-info-2",
-  "version": "0.5.4",
+  "version": "0.5.5",
   "private": false,
   "description": "show quest info",
   "homepage": "https://github.com/lawvs/poi-plugin-quest-2/",

package/src/Toolbar.tsx

@@ -12,7 +12,7 @@ import {
   CATEGORY_TAGS,
   ALL_TAGS,
 } from './tags'
-import type { KcanotifyQuestExt } from './questHelper'
+import type { UnionQuest } from './questHelper'
 import { usePluginTranslation } from './poi/hooks'
 import { IN_POI } from './poi/env'
 
@@ -158,10 +158,10 @@ const useToolbarFilter = () => {
     .map((i) => i.toUpperCase())
 
   const stringFilter = useCallback(
-    (quest: KcanotifyQuestExt) => {
-      const text = `${quest.code} ${quest.name} ${quest.desc} ${
-        quest.memo ?? ''
-      }`
+    (quest: UnionQuest) => {
+      const text = `${quest.docQuest.code} ${quest.docQuest.name} ${
+        quest.docQuest.desc
+      } ${quest.docQuest.memo ?? ''}`
       if (!searchKeywords) {
         return true
       }
@@ -173,7 +173,7 @@ const useToolbarFilter = () => {
   )
 
   const toolbarFilter = useCallback(
-    (quest: KcanotifyQuestExt) => {
+    (quest: UnionQuest) => {
       return [...tagsFilter, stringFilter].every((filter) => filter(quest))
     },
     [stringFilter, tagsFilter]

package/src/__tests__/kcwikiData.spec.ts

@@ -2,7 +2,7 @@ import { version, KcwikiQuestData } from '../../build/kcQuestsData'
 
 test('should KcwikiQuestData Game data version correct', () => {
   expect(version).toMatchInlineSnapshot(
-    `"a89f6893478705a9b710472ffeafb5a45122b9ce"`
+    `"004638c4fa18cf4d37e45f3a8704bffe7cdaa49e"`
   )
 })
 

package/src/components/QuestCard.tsx

@@ -75,7 +75,7 @@ const questIconMap = {
 } as const
 
 const questStatusMap: Record<QUEST_STATUS, React.FC> = {
-  [QUEST_STATUS.Locked]: function Locked() {
+  [QUEST_STATUS.LOCKED]: function Locked() {
     const { t } = usePluginTranslation()
     return (
       <Tooltip content={t('Locked')}>
@@ -84,8 +84,8 @@ const questStatusMap: Record<QUEST_STATUS, React.FC> = {
     )
   },
   // Display nothing
-  [QUEST_STATUS.Default]: () => null,
-  [QUEST_STATUS.InProgress]: function InProgress() {
+  [QUEST_STATUS.DEFAULT]: () => null,
+  [QUEST_STATUS.IN_PROGRESS]: function InProgress() {
     const { t } = usePluginTranslation()
     return (
       <Tooltip content={t('In Progress')}>
@@ -93,7 +93,7 @@ const questStatusMap: Record<QUEST_STATUS, React.FC> = {
       </Tooltip>
     )
   },
-  [QUEST_STATUS.Completed]: function Completed() {
+  [QUEST_STATUS.COMPLETED]: function Completed() {
     const { t } = usePluginTranslation()
     return (
       <Tooltip content={t('Completed')}>
@@ -101,7 +101,7 @@ const questStatusMap: Record<QUEST_STATUS, React.FC> = {
       </Tooltip>
     )
   },
-  [QUEST_STATUS.AlreadyCompleted]: function AlreadyCompleted() {
+  [QUEST_STATUS.ALREADY_COMPLETED]: function AlreadyCompleted() {
     const { t } = usePluginTranslation()
     return (
       <Tooltip content={t('Already Completed')}>
@@ -126,7 +126,7 @@ export const LargeQuestCard: React.FC<QuestCardProps> = ({
   name,
   desc,
   tips,
-  status = QUEST_STATUS.Default,
+  status = QUEST_STATUS.DEFAULT,
   onClick,
   style,
 }) => {
@@ -159,7 +159,7 @@ export const MinimalQuestCard: React.FC<QuestCardProps> = ({
   name,
   desc,
   tips,
-  status = QUEST_STATUS.Default,
+  status = QUEST_STATUS.DEFAULT,
   onClick,
   style,
 }) => {

package/src/components/QuestList.tsx

@@ -9,10 +9,12 @@ import {
 } from 'react-virtualized'
 import type { ListRowProps } from 'react-virtualized'
 import styled from 'styled-components'
-import { KcanotifyQuestExt, QUEST_STATUS } from '../questHelper'
+import { QUEST_STATUS } from '../questHelper'
+import type { UnionQuest } from '../questHelper'
 import { useLargeCard } from '../store'
 import { QuestCard } from './QuestCard'
 import { useIsQuestPluginTab } from '../poi/hooks'
+import { QUEST_API_STATE } from '../poi/types'
 
 const QuestListWrapper = styled.div`
   flex: 1;
@@ -25,10 +27,29 @@ const cache = new CellMeasurerCache({
   fixedWidth: true,
 })
 
-const useQuestsRowRenderer = (quests: KcanotifyQuestExt[]) => {
+const questStateToQuestStatus = (
+  state: QUEST_API_STATE | undefined
+): QUEST_STATUS => {
+  switch (state) {
+    case QUEST_API_STATE.DEFAULT:
+      return QUEST_STATUS.DEFAULT
+    case QUEST_API_STATE.COMPLETED:
+      return QUEST_STATUS.COMPLETED
+    case QUEST_API_STATE.IN_PROGRESS:
+      return QUEST_STATUS.IN_PROGRESS
+    default:
+      return QUEST_STATUS.DEFAULT
+  }
+}
+
+const useQuestsRowRenderer = (quests: UnionQuest[]) => {
   const rowRenderer = useCallback(
     ({ key, index, style, parent }: ListRowProps) => {
-      const { gameId, code, name, desc, memo, active } = quests[index]
+      const quest = quests[index]
+      const { gameId } = quest
+      const { code, name, desc, memo } = quest.docQuest
+      const questStatus = questStateToQuestStatus(quest.gameQuest?.api_state)
+
       return (
         <CellMeasurer
           cache={cache}
@@ -45,7 +66,7 @@ const useQuestsRowRenderer = (quests: KcanotifyQuestExt[]) => {
               name={name}
               desc={desc}
               tips={memo}
-              status={active ? QUEST_STATUS.InProgress : QUEST_STATUS.Default}
+              status={questStatus}
             ></QuestCard>
           </div>
         </CellMeasurer>
@@ -56,12 +77,11 @@ const useQuestsRowRenderer = (quests: KcanotifyQuestExt[]) => {
   return rowRenderer
 }
 
-export const QuestList: React.FC<{ quests: KcanotifyQuestExt[] }> = ({
-  quests,
-}) => {
+export const QuestList: React.FC<{ quests: UnionQuest[] }> = ({ quests }) => {
   const { largeCard } = useLargeCard()
   const activeTab = useIsQuestPluginTab()
   const listRef = useRef<List>(null)
+  const rowRenderer: ListRowRenderer = useQuestsRowRenderer(quests)
 
   useEffect(() => {
     const largeCardIdx = quests.findIndex((i) => i.gameId === largeCard)
@@ -81,8 +101,6 @@ export const QuestList: React.FC<{ quests: KcanotifyQuestExt[] }> = ({
     listRef.current?.recomputeRowHeights()
   }, [])
 
-  const rowRenderer: ListRowRenderer = useQuestsRowRenderer(quests)
-
   if (!quests.length) {
     // Prevent Uncaught Error: Requested index 0 is outside of range 0..0
     // See https://github.com/bvaughn/react-virtualized/issues/1016

package/src/poi/hooks.ts

@@ -25,9 +25,9 @@ export const usePluginTranslation = () => {
 }
 
 export const useGameQuest = () => {
-  const [quests, setQuests] = useState<GameQuest[] | null>(null)
+  const [quests, setQuests] = useState<GameQuest[]>([])
   useEffect(() => {
-    const listener = (quests: GameQuest[] | null) => setQuests(quests)
+    const listener = (quests: GameQuest[] | null) => setQuests(quests ?? [])
     // See reducer.ts
     return observePluginStore(listener, (i) => i?._?.questList)
   }, [])

package/src/poi/types.ts

@@ -1,11 +1,14 @@
 import type { PluginState } from '../reducer'
 
+export enum QUEST_API_STATE {
+  DEFAULT = 1,
+  IN_PROGRESS = 2,
+  COMPLETED = 3,
+}
+
 // See https://github.com/poooi/poi/blob/master/views/redux/info/quests.es
 export type GameQuest = {
-  // 1 Default
-  // 2 In progress
-  // 3 Completed
-  api_state: 1 | 2 | 3
+  api_state: QUEST_API_STATE
   api_no: number
   api_title: string
   api_detail: string

package/src/questHelper.ts

@@ -1,6 +1,7 @@
 import { QuestData } from '../build/kcanotifyGamedata'
+import { GameQuest, QUEST_API_STATE } from './poi/types'
 
-type KcanotifyQuest = {
+type DocQuest = {
   code: string
   name: string
   desc: string
@@ -9,9 +10,10 @@ type KcanotifyQuest = {
   tracking?: number[][]
 }
 
-export type KcanotifyQuestExt = KcanotifyQuest & {
+export type UnionQuest = {
   gameId: string
-  active?: boolean
+  gameQuest?: GameQuest
+  docQuest: DocQuest
 }
 
 const questStartsFilter = (str: string) =>
@@ -26,16 +28,18 @@ export const quarterlyQuest = questStartsFilter('(季任)')
 // (年任) (年任 / x 月)
 export const yearlyQuest = questStartsFilter('(年任')
 
-export const isInProgressQuest = (quest: KcanotifyQuestExt) => quest.active
-export const isDailyQuest = (quest: KcanotifyQuestExt) =>
+export const isInProgressQuest = (quest: UnionQuest) =>
+  quest.gameQuest?.api_state === QUEST_API_STATE.IN_PROGRESS ||
+  quest.gameQuest?.api_state === QUEST_API_STATE.COMPLETED
+export const isDailyQuest = (quest: UnionQuest) =>
   dailyQuest.includes(quest.gameId)
-export const isWeeklyQuest = (quest: KcanotifyQuestExt) =>
+export const isWeeklyQuest = (quest: UnionQuest) =>
   weeklyQuest.includes(quest.gameId)
-export const isMonthlyQuest = (quest: KcanotifyQuestExt) =>
+export const isMonthlyQuest = (quest: UnionQuest) =>
   monthlyQuest.includes(quest.gameId)
-export const isQuarterlyQuest = (quest: KcanotifyQuestExt) =>
+export const isQuarterlyQuest = (quest: UnionQuest) =>
   quarterlyQuest.includes(quest.gameId)
-export const isYearlyQuest = (quest: KcanotifyQuestExt) =>
+export const isYearlyQuest = (quest: UnionQuest) =>
   yearlyQuest.includes(quest.gameId)
 
 export enum QUEST_CATEGORY {
@@ -154,28 +158,28 @@ export const guessQuestCategory = (
   }
 }
 
-export const isCompositionQuest = ({ code }: KcanotifyQuestExt) =>
+export const isCompositionQuest = ({ code }: DocQuest) =>
   guessQuestCategory(code).type === QUEST_CATEGORY.Composition
-export const isSortieQuest = ({ code }: KcanotifyQuestExt) =>
+export const isSortieQuest = ({ code }: DocQuest) =>
   guessQuestCategory(code).type === QUEST_CATEGORY.Sortie
-export const isExerciseQuest = ({ code }: KcanotifyQuestExt) =>
+export const isExerciseQuest = ({ code }: DocQuest) =>
   guessQuestCategory(code).type === QUEST_CATEGORY.Exercise
-export const isExpeditionQuest = ({ code }: KcanotifyQuestExt) =>
+export const isExpeditionQuest = ({ code }: DocQuest) =>
   guessQuestCategory(code).type === QUEST_CATEGORY.Expedition
-export const isSupplyOrDockingQuest = ({ code }: KcanotifyQuestExt) =>
+export const isSupplyOrDockingQuest = ({ code }: DocQuest) =>
   guessQuestCategory(code).type === QUEST_CATEGORY.SupplyOrDocking
-export const isArsenalQuest = ({ code }: KcanotifyQuestExt) =>
+export const isArsenalQuest = ({ code }: DocQuest) =>
   guessQuestCategory(code).type === QUEST_CATEGORY.Arsenal
-export const isModernizationQuest = ({ code }: KcanotifyQuestExt) =>
+export const isModernizationQuest = ({ code }: DocQuest) =>
   guessQuestCategory(code).type === QUEST_CATEGORY.Modernization
-export const isUnknownCategoryQuest = ({ code }: KcanotifyQuestExt) =>
+export const isUnknownCategoryQuest = ({ code }: DocQuest) =>
   // Starts with unknown character
   /^[^ABCDEFG]/.test(code)
 
 export enum QUEST_STATUS {
-  Locked,
-  Default,
-  InProgress,
-  Completed,
-  AlreadyCompleted,
+  LOCKED,
+  DEFAULT,
+  IN_PROGRESS,
+  COMPLETED,
+  ALREADY_COMPLETED,
 }

package/src/store/quest.ts

@@ -1,13 +1,9 @@
 import { useCallback } from 'react'
-import { checkIsKcwikiSupportedLanguages } from '.'
 import { QuestData } from '../../build/kcanotifyGamedata'
-import {
-  useActiveQuest,
-  useGameQuest,
-  usePluginTranslation,
-} from '../poi/hooks'
-import { getCategory, KcanotifyQuestExt } from '../questHelper'
-import { useKcwikiData } from './kcwiki'
+import { useGameQuest, usePluginTranslation } from '../poi/hooks'
+import { getCategory } from '../questHelper'
+import type { UnionQuest } from '../questHelper'
+import { useKcwikiData, checkIsKcwikiSupportedLanguages } from './kcwiki'
 import { useStore } from './store'
 
 const DEFAULT_LANG = 'ja-JP'
@@ -41,27 +37,21 @@ const useQuestMap = () => {
   return QuestData[lang]
 }
 
-export const useQuest = (): KcanotifyQuestExt[] => {
-  const activeQuest = useActiveQuest()
-  const questMap = useQuestMap()
+export const useQuest = (): UnionQuest[] => {
+  const docQuestMap = useQuestMap()
   const gameQuest = useGameQuest()
   const {
     store: { syncWithGame },
   } = useStore()
 
-  if (syncWithGame) {
-    if (gameQuest == null) {
-      // TODO tip use to sync quest data
-      return []
-    }
+  if (syncWithGame && gameQuest.length) {
     return gameQuest.map((quest) => {
       const gameId = String(quest.api_no)
-      const active = gameId in activeQuest
-      if (gameId in questMap) {
+      if (gameId in docQuestMap) {
         return {
           gameId,
-          active,
-          ...questMap[gameId as unknown as keyof typeof questMap],
+          gameQuest: quest,
+          docQuest: docQuestMap[gameId as keyof typeof docQuestMap],
         }
       }
 
@@ -69,18 +59,21 @@ export const useQuest = (): KcanotifyQuestExt[] => {
       // May be a new quest
       return {
         gameId,
-        active,
-        code: `${getCategory(quest.api_category).wikiSymbol}?`,
-        name: quest.api_title,
-        desc: quest.api_detail,
+        gameQuest: quest,
+        docQuest: {
+          code: `${getCategory(quest.api_category).wikiSymbol}?`,
+          name: quest.api_title,
+          desc: quest.api_detail,
+        },
       }
     })
   } else {
     // Return all recorded quests
-    return Object.entries(questMap).map(([gameId, val]) => ({
+    return Object.entries(docQuestMap).map(([gameId, val]) => ({
       gameId,
-      active: gameId in activeQuest,
-      ...val,
+      // Maybe empty
+      gameQuest: gameQuest.find((quest) => quest.api_no === Number(gameId))!,
+      docQuest: val,
     }))
   }
 }

package/src/tags.ts

@@ -15,6 +15,7 @@ import {
   isUnknownCategoryQuest,
   isInProgressQuest,
 } from './questHelper'
+import type { UnionQuest } from './questHelper'
 
 const yes = () => true as const
 
@@ -25,16 +26,21 @@ export const ALL_CATEGORY_TAG = {
 
 export const ALL_TYPE_TAG = ALL_CATEGORY_TAG
 
+const withDocQuest =
+  (filterFn: (q: UnionQuest['docQuest']) => boolean) =>
+  (unionQuest: UnionQuest) =>
+    filterFn(unionQuest.docQuest)
+
 export const CATEGORY_TAGS = [
   ALL_CATEGORY_TAG,
-  { name: 'Composition', filter: isCompositionQuest },
-  { name: 'Sortie', filter: isSortieQuest },
-  { name: 'Exercise', filter: isExerciseQuest },
-  { name: 'Expedition', filter: isExpeditionQuest },
-  { name: 'Supply / Docking', filter: isSupplyOrDockingQuest },
-  { name: 'Arsenal', filter: isArsenalQuest },
-  { name: 'Modernization', filter: isModernizationQuest },
-  { name: 'Others', filter: isUnknownCategoryQuest },
+  { name: 'Composition', filter: withDocQuest(isCompositionQuest) },
+  { name: 'Sortie', filter: withDocQuest(isSortieQuest) },
+  { name: 'Exercise', filter: withDocQuest(isExerciseQuest) },
+  { name: 'Expedition', filter: withDocQuest(isExpeditionQuest) },
+  { name: 'Supply / Docking', filter: withDocQuest(isSupplyOrDockingQuest) },
+  { name: 'Arsenal', filter: withDocQuest(isArsenalQuest) },
+  { name: 'Modernization', filter: withDocQuest(isModernizationQuest) },
+  { name: 'Others', filter: withDocQuest(isUnknownCategoryQuest) },
 ] as const
 
 export const TYPE_TAGS = [