diff options
| author | Beebles <102569435+beebls@users.noreply.github.com> | 2024-08-31 16:41:58 -0600 |
|---|---|---|
| committer | Beebles <102569435+beebls@users.noreply.github.com> | 2025-08-01 06:54:40 -0600 |
| commit | 1a231bf03e5db38ba99edb6903757ce2f8172b8f (patch) | |
| tree | 333f3a6fcfe49e89129cfca14c456ae28955493a | |
| parent | edf6b54db4bff465020a49ea4a50b3283723f55e (diff) | |
| download | decky-loader-1a231bf03e5db38ba99edb6903757ce2f8172b8f.tar.gz decky-loader-1a231bf03e5db38ba99edb6903757ce2f8172b8f.zip | |
rename motd to announcements and implement new API
| -rw-r--r-- | frontend/src/components/AnnouncementsDisplay.tsx (renamed from frontend/src/components/MotdDisplay.tsx) | 57 | ||||
| -rw-r--r-- | frontend/src/components/PluginView.tsx | 4 | ||||
| -rw-r--r-- | frontend/src/store.ts | 33 |
3 files changed, 48 insertions, 46 deletions
diff --git a/frontend/src/components/MotdDisplay.tsx b/frontend/src/components/AnnouncementsDisplay.tsx index d5236d88..6e0eeb70 100644 --- a/frontend/src/components/MotdDisplay.tsx +++ b/frontend/src/components/AnnouncementsDisplay.tsx @@ -2,7 +2,7 @@ import { DialogButton, Focusable, PanelSection } from '@decky/ui'; import { useEffect, useMemo, useState } from 'react'; import { FaTimes } from 'react-icons/fa'; -import { Motd, getMotd } from '../store'; +import { Announcement, getLatestAnnouncement } from '../store'; import { useSetting } from '../utils/hooks/useSetting'; const SEVERITIES = { @@ -20,50 +20,51 @@ const SEVERITIES = { }, }; -const welcomeMotd: Motd = { - id: 'welcomeMotd', - name: 'Welcome to Decky!', - date: Date.now().toString(), - description: 'We hope you enjoy using Decky! If you have any questions or feedback, please let us know.', - severity: 'Low', +const welcomeAnnouncement: Announcement = { + id: 'welcomeAnnouncement', + title: 'Welcome to Decky!', + text: 'We hope you enjoy using Decky! If you have any questions or feedback, please let us know.', + created: Date.now().toString(), + updated: Date.now().toString(), }; -export function MotdDisplay() { - const [motd, setMotd] = useState<Motd | null>(null); +export function AnnouncementsDisplay() { + const [announcement, setAnnouncement] = useState<Announcement | null>(null); // showWelcome will display a welcome motd, the welcome motd has an id of "welcome" and once that is saved to hiddenMotdId, it will not show again - const [hiddenMotdId, setHiddenMotdId] = useSetting('hiddenMotdId', 'showWelcome'); + const [hiddenAnnouncementId, setHiddenAnnouncementId] = useSetting('hiddenAnnouncementId', 'showWelcome'); - async function fetchMotd() { - const motd = await getMotd(); - motd && setMotd(motd); + async function fetchAnnouncement() { + const announcement = await getLatestAnnouncement(); + announcement && setAnnouncement(announcement); } useEffect(() => { - void fetchMotd(); + void fetchAnnouncement(); }, []); useEffect(() => { - if (hiddenMotdId === 'showWelcome') { - setMotd(welcomeMotd); + if (hiddenAnnouncementId === 'showWelcome') { + setAnnouncement(welcomeAnnouncement); } - }, [hiddenMotdId]); + }, [hiddenAnnouncementId]); - function hideMotd() { - if (motd) { - setHiddenMotdId(motd.id); - void fetchMotd(); + function hideAnnouncement() { + if (announcement) { + setHiddenAnnouncementId(announcement.id); + void fetchAnnouncement(); } } const hidden = useMemo(() => { - return hiddenMotdId === motd?.id; - }, [hiddenMotdId, motd]); + return hiddenAnnouncementId === announcement?.id; + }, [hiddenAnnouncementId, announcement]); - if (!motd || !motd?.name || hidden) { + if (!announcement || !announcement.title || hidden) { return null; } - const severity = SEVERITIES[motd?.severity || 'Low']; + // Severity is not implemented in the API currently + const severity = SEVERITIES['Low']; return ( <PanelSection> @@ -82,7 +83,7 @@ export function MotdDisplay() { }} > <div style={{ display: 'flex', justifyContent: 'space-between' }}> - <span style={{ fontWeight: 'bold' }}>{motd?.name}</span> + <span style={{ fontWeight: 'bold' }}>{announcement.title}</span> <DialogButton style={{ width: '1rem', @@ -96,7 +97,7 @@ export function MotdDisplay() { top: '.75rem', right: '.75rem', }} - onClick={hideMotd} + onClick={hideAnnouncement} > <FaTimes style={{ @@ -105,7 +106,7 @@ export function MotdDisplay() { /> </DialogButton> </div> - <span style={{ fontSize: '0.75rem', whiteSpace: 'pre-line' }}>{motd?.description}</span> + <span style={{ fontSize: '0.75rem', whiteSpace: 'pre-line' }}>{announcement.text}</span> </Focusable> </PanelSection> ); diff --git a/frontend/src/components/PluginView.tsx b/frontend/src/components/PluginView.tsx index 88b43b51..13ee33e1 100644 --- a/frontend/src/components/PluginView.tsx +++ b/frontend/src/components/PluginView.tsx @@ -3,8 +3,8 @@ import { FC, useMemo } from 'react'; import { useTranslation } from 'react-i18next'; import { FaEyeSlash } from 'react-icons/fa'; +import { AnnouncementsDisplay } from './AnnouncementsDisplay'; import { useDeckyState } from './DeckyState'; -import { MotdDisplay } from './MotdDisplay'; import NotificationBadge from './NotificationBadge'; import { useQuickAccessVisible } from './QuickAccessVisibleState'; import TitleView from './TitleView'; @@ -42,7 +42,7 @@ const PluginView: FC = () => { paddingTop: '16px', }} > - <MotdDisplay /> + <AnnouncementsDisplay /> <PanelSection> {pluginList.map(({ name, icon }) => ( <PanelSectionRow key={name}> diff --git a/frontend/src/store.ts b/frontend/src/store.ts index e64de8d5..1cfe36cd 100644 --- a/frontend/src/store.ts +++ b/frontend/src/store.ts @@ -42,12 +42,12 @@ export interface PluginInstallRequest { installType: InstallType; } -export interface Motd { +export interface Announcement { id: string; - name: string; - description: string; - date: string; - severity: 'High' | 'Medium' | 'Low'; + title: string; + text: string; + created: string; + updated: string; } // name: version @@ -57,10 +57,13 @@ export async function getStore(): Promise<Store> { return await getSetting<Store>('store', Store.Default); } -export async function getMotd(): Promise<Motd> { +export async function getLatestAnnouncement(): Promise<Announcement | null> { let version = await window.DeckyPluginLoader.updateVersion(); let store = await getSetting<Store | null>('store', null); - let customURL = await getSetting<string>('motd-url', 'https://plugins.deckbrew.xyz/v1/motd'); + let customURL = await getSetting<string>( + 'announcements-url', + 'https://plugins.deckbrew.xyz/v1/announcements/-/current', + ); if (store === null) { console.log('Could not get store, using Default.'); @@ -71,30 +74,28 @@ export async function getMotd(): Promise<Motd> { let resolvedURL; switch (store) { case Store.Default: - resolvedURL = 'https://plugins.deckbrew.xyz/v1/motd'; + resolvedURL = 'https://plugins.deckbrew.xyz/v1/announcements/-/current'; break; case Store.Testing: - resolvedURL = 'https://testing.deckbrew.xyz/v1/motd'; + resolvedURL = 'https://testing.deckbrew.xyz/v1/announcements/-/current'; break; case Store.Custom: resolvedURL = customURL; break; default: console.error('Somehow you ended up without a standard URL, using the default URL.'); - resolvedURL = 'https://plugins.deckbrew.xyz/v1/motd'; + resolvedURL = 'https://plugins.deckbrew.xyz/v1/announcements/-/current'; break; } - return fetch(resolvedURL, { + const res = await fetch(resolvedURL, { method: 'GET', headers: { 'X-Decky-Version': version.current, }, - }).then((r) => { - if (r.status === 200) { - return r.json(); - } - return null; }); + if (res.status !== 200) return null; + const json = await res.json(); + return json?.[0] ?? null; } export async function getPluginList( |
