Add: Add ability to hide unreleased items

src/sonolus/background/info.ts

@@ -1,11 +1,18 @@
 import { Icon, Text } from '@sonolus/core'
+import { BackgroundItemModel } from '@sonolus/express'
 import { randomize } from '../../utils/math.js'
 import { sonolus } from '../index.js'
+import { hideSpoilers } from '../utils/spoiler.js'
 import { backgroundSearches } from './search.js'
 
 export const installBackgroundInfo = () => {
-    sonolus.background.infoHandler = () => {
-        const cardBackgrounds = sonolus.background.items.filter(({ meta }) => meta)
+    sonolus.background.infoHandler = ({ options }) => {
+        const cardBackgrounds = hideSpoilers(
+            options.spoilers,
+            sonolus.background.items.filter(
+                (item): item is BackgroundItemModel & { meta: object } => item.meta !== undefined,
+            ),
+        )
         const otherBackgrounds = sonolus.background.items.filter(({ meta }) => !meta)
 
         return {

src/sonolus/background/item.ts

@@ -60,7 +60,7 @@ export const updateBackgroundItems = (repository: Repository) => {
             rarityIndex: cardRarity.index,
             attributeIndex: attribute.index,
             id: card.id,
-            releaseAt: card.releaseAt,
+            publishedAt: card.releaseAt,
         }
 
         if (cardRarity.hasTraining) {
@@ -96,6 +96,6 @@ export const updateBackgroundItems = (repository: Repository) => {
 
     sonolus.background.items = [
         ...initialBackgrounds,
-        ...backgrounds.sort((a, b) => b.meta.releaseAt - a.meta.releaseAt),
+        ...backgrounds.sort((a, b) => b.meta.publishedAt - a.meta.publishedAt),
     ]
 }

src/sonolus/background/list.ts

@@ -1,16 +1,28 @@
-import { filterBackgrounds, paginateItems } from '@sonolus/express'
+import { BackgroundItemModel, filterBackgrounds, paginateItems } from '@sonolus/express'
 import { sonolus } from '../index.js'
 import { randomizeItems, toIndexes } from '../utils/list.js'
+import { hideSpoilers } from '../utils/spoiler.js'
 import { backgroundSearches } from './search.js'
 
 export const installBackgroundList = () => {
-    sonolus.background.listHandler = ({ search: { type, options }, page }) => {
+    sonolus.background.listHandler = ({
+        search: { type, options },
+        page,
+        options: serverOptions,
+    }) => {
+        const filteredBackgrounds = [
+            ...hideSpoilers(
+                serverOptions.spoilers,
+                sonolus.background.items.filter(
+                    (item): item is BackgroundItemModel & { meta: object } =>
+                        item.meta !== undefined,
+                ),
+            ),
+            ...sonolus.background.items.filter(({ meta }) => !meta),
+        ]
         if (type === 'quick')
             return {
-                ...paginateItems(
-                    filterBackgrounds(sonolus.background.items, options.keywords),
-                    page,
-                ),
+                ...paginateItems(filterBackgrounds(filteredBackgrounds, options.keywords), page),
                 searches: backgroundSearches,
             }
 
@@ -32,7 +44,7 @@ export const installBackgroundList = () => {
         const imageIndexes = toIndexes(options.images)
 
         const items = filterBackgrounds(
-            sonolus.background.items.filter(
+            filteredBackgrounds.filter(
                 ({ meta }) =>
                     meta &&
                     characterIndexes.includes(meta.characterIndex) &&

src/sonolus/background/model.ts

@@ -7,7 +7,7 @@ declare module '@sonolus/express' {
             attributeIndex: number
             imageIndex: number
             id: number
-            releaseAt: number
+            publishedAt: number
         }
     }
 }

src/sonolus/configuration.ts

@@ -0,0 +1,15 @@
+import { ServerOptionsModel } from '@sonolus/express'
+
+export const serverConfiguration = {
+    spoilers: {
+        type: 'toggle',
+        name: {
+            en: 'Spoilers',
+        },
+        def: false,
+        description: {
+            en: 'Whether to show unreleased items.',
+        },
+        required: false,
+    },
+} as const satisfies ServerOptionsModel

src/sonolus/index.ts

@@ -3,6 +3,7 @@ import { config } from '../config.js'
 import { Repository } from '../repository/index.js'
 import { installBackground, updateBackground } from './background/index.js'
 import { backgroundSearches } from './background/search.js'
+import { serverConfiguration } from './configuration.js'
 import { installEngine } from './engine/index.js'
 import { installInfo } from './info/index.js'
 import { installLevel, updateLevel } from './level/index.js'
@@ -25,6 +26,9 @@ export const sonolus = new Sonolus({
     background: {
         searches: backgroundSearches,
     },
+    configuration: {
+        options: serverConfiguration,
+    },
 })
 
 installPack()

src/sonolus/level/info.ts

@@ -2,16 +2,17 @@ import { Icon, Text } from '@sonolus/core'
 import { LevelItemModel } from '@sonolus/express'
 import { randomize } from '../../utils/math.js'
 import { sonolus } from '../index.js'
+import { hideSpoilers } from '../utils/spoiler.js'
 import { levelSearches } from './search.js'
 
 export const installLevelInfo = () => {
-    sonolus.level.infoHandler = () => {
+    sonolus.level.infoHandler = ({ options }) => {
         const randomLevels: Record<string, LevelItemModel> = {}
 
         const newestMusicIds = new Set<number>()
         const newestLevels: LevelItemModel[] = []
 
-        for (const level of sonolus.level.items) {
+        for (const level of hideSpoilers(options.spoilers, sonolus.level.items)) {
             randomLevels[`${level.meta.musicId}-${level.meta.musicVocalId}`] ??= level
 
             if (newestLevels.length >= 5) continue

src/sonolus/level/list.ts

@@ -1,13 +1,20 @@
 import { filterLevels, paginateItems } from '@sonolus/express'
 import { sonolus } from '../index.js'
 import { randomizeItems, toIndexes } from '../utils/list.js'
+import { hideSpoilers } from '../utils/spoiler.js'
 import { levelSearches } from './search.js'
 
 export const installLevelList = () => {
-    sonolus.level.listHandler = ({ search: { type, options }, page }) => {
+    sonolus.level.listHandler = ({ search: { type, options }, page, options: serverOptions }) => {
         if (type === 'quick')
             return {
-                ...paginateItems(filterLevels(sonolus.level.items, options.keywords), page),
+                ...paginateItems(
+                    filterLevels(
+                        hideSpoilers(serverOptions.spoilers, sonolus.level.items),
+                        options.keywords,
+                    ),
+                    page,
+                ),
                 searches: levelSearches,
             }
 
@@ -16,7 +23,7 @@ export const installLevelList = () => {
         const difficultyIndexes = toIndexes(options.difficulties)
 
         const items = filterLevels(
-            sonolus.level.items.filter(
+            hideSpoilers(serverOptions.spoilers, sonolus.level.items).filter(
                 ({ rating, meta }) =>
                     (!meta.characterIndexes.length ||
                         meta.characterIndexes.some((characterIndex) =>

src/sonolus/playlist/details.ts

@@ -5,9 +5,10 @@ import { config } from '../../config.js'
 import { randomize } from '../../utils/math.js'
 import { sonolus } from '../index.js'
 import { nonEmpty } from '../utils/section.js'
+import { hideSpoilers } from '../utils/spoiler.js'
 
 export const installPlaylistDetails = () => {
-    sonolus.playlist.detailsHandler = ({ itemName }) => {
+    sonolus.playlist.detailsHandler = ({ itemName, options }) => {
         if (itemName.startsWith(`${config.sonolus.prefix}-random-`)) {
             const [, , , min, max] = itemName.split('-')
             const minRating = +(min ?? '') || 0
@@ -22,14 +23,15 @@ export const installPlaylistDetails = () => {
                     author: databaseEngineItem.subtitle,
                     tags: [{ title: { en: Text.Random } }],
                     levels: randomize(
-                        sonolus.level.items
+                        hideSpoilers(options.spoilers, sonolus.level.items)
                             .filter(({ rating }) => rating >= minRating && rating <= maxRating)
                             .map(({ name }) => name),
                         20,
                     ),
                     meta: {
                         musicVocalTypeIndexes: new Set(),
                         characterIndexes: new Set(),
+                        publishedAt: Date.now(),
                     },
                 },
                 actions: {},

src/sonolus/playlist/info.ts

@@ -1,23 +1,24 @@
 import { Icon, Text } from '@sonolus/core'
 import { randomize } from '../../utils/math.js'
 import { sonolus } from '../index.js'
+import { hideSpoilers } from '../utils/spoiler.js'
 import { playlistSearches } from './search.js'
 
 export const installPlaylistInfo = () => {
-    sonolus.playlist.infoHandler = () => {
+    sonolus.playlist.infoHandler = ({ options }) => {
         return {
             searches: playlistSearches,
             sections: [
                 {
                     title: { en: Text.Random },
                     icon: Icon.Shuffle,
                     itemType: 'playlist',
-                    items: randomize(sonolus.playlist.items, 5),
+                    items: randomize(hideSpoilers(options.spoilers, sonolus.playlist.items), 5),
                 },
                 {
                     title: { en: Text.Newest },
                     itemType: 'playlist',
-                    items: sonolus.playlist.items.slice(0, 5),
+                    items: hideSpoilers(options.spoilers, sonolus.playlist.items).slice(0, 5),
                 },
             ],
             banner: sonolus.banner,

src/sonolus/playlist/item.ts

@@ -19,6 +19,10 @@ export const updatePlaylistItems = () => {
             for (const characterIndex of level.meta.characterIndexes) {
                 playlist.meta.characterIndexes.add(characterIndex)
             }
+
+            if (level.meta.publishedAt > playlist.meta.publishedAt) {
+                playlist.meta.publishedAt = level.meta.publishedAt
+            }
         } else {
             playlists.set(level.meta.musicId, {
                 name: `${config.sonolus.prefix}-${level.meta.musicId}`,
@@ -32,6 +36,7 @@ export const updatePlaylistItems = () => {
                 meta: {
                     musicVocalTypeIndexes: new Set([level.meta.musicVocalTypeIndex]),
                     characterIndexes: new Set(level.meta.characterIndexes),
+                    publishedAt: level.meta.publishedAt,
                 },
             })
         }

src/sonolus/playlist/list.ts

@@ -4,13 +4,24 @@ import { databaseEngineItem } from 'sonolus-pjsekai-engine'
 import { config } from '../../config.js'
 import { sonolus } from '../index.js'
 import { randomizeItems, toIndexes } from '../utils/list.js'
+import { hideSpoilers } from '../utils/spoiler.js'
 import { playlistSearches } from './search.js'
 
 export const installPlaylistList = () => {
-    sonolus.playlist.listHandler = ({ search: { type, options }, page }) => {
+    sonolus.playlist.listHandler = ({
+        search: { type, options },
+        page,
+        options: serverOptions,
+    }) => {
         if (type === 'quick')
             return {
-                ...paginateItems(filterPlaylists(sonolus.playlist.items, options.keywords), page),
+                ...paginateItems(
+                    filterPlaylists(
+                        hideSpoilers(serverOptions.spoilers, sonolus.playlist.items),
+                        options.keywords,
+                    ),
+                    page,
+                ),
                 searches: playlistSearches,
             }
 
@@ -29,6 +40,7 @@ export const installPlaylistList = () => {
                         meta: {
                             musicVocalTypeIndexes: new Set(),
                             characterIndexes: new Set(),
+                            publishedAt: Date.now(),
                         },
                     },
                 ],
@@ -39,7 +51,7 @@ export const installPlaylistList = () => {
         const musicVocalTypeIndexes = toIndexes(options.categories)
 
         const items = filterPlaylists(
-            sonolus.playlist.items.filter(
+            hideSpoilers(serverOptions.spoilers, sonolus.playlist.items).filter(
                 ({ meta }) =>
                     (!meta.characterIndexes.size ||
                         characterIndexes.some((characterIndex) =>
@@ -50,7 +62,18 @@ export const installPlaylistList = () => {
                     ),
             ),
             options.keywords,
-        )
+        ).map((playlist) => ({
+            ...playlist,
+            levels: hideSpoilers(
+                serverOptions.spoilers,
+                playlist.levels.map((levelName) => {
+                    const level = sonolus.level.items.find((level) => level.name === levelName)
+                    if (!level)
+                        throw new Error(`Unreachable (level not found): ${String(levelName)}`)
+                    return level
+                }),
+            ),
+        }))
 
         return {
             ...(options.random ? randomizeItems(items) : paginateItems(items, page)),

src/sonolus/playlist/model.ts

@@ -4,6 +4,7 @@ declare module '@sonolus/express' {
         meta: {
             musicVocalTypeIndexes: Set<number>
             characterIndexes: Set<number>
+            publishedAt: number
         }
     }
 }

src/sonolus/utils/spoiler.ts

@@ -0,0 +1,9 @@
+export const hideSpoilers = <T extends { meta: { publishedAt: number } }>(
+    passThrough: boolean,
+    items: T[],
+) => {
+    if (passThrough) {
+        return items
+    }
+    return items.filter((level) => level.meta.publishedAt <= Date.now())
+}