Dirk Rost
b9c590598d
Resolve merge conflicts from badges, books, help, and emojis rename. Fix biome lint: add type="button" to all buttons, use template literals, format new components with project conventions.
227 lines
9.7 KiB
TypeScript
227 lines
9.7 KiB
TypeScript
import { createContext } from "react";
|
|
import type { ThemeConfig, ThemesConfig } from "@/themes";
|
|
|
|
/**
|
|
* A builtin theme whose colors are defined at build time.
|
|
* "system" resolves to "light" or "dark" based on OS preference.
|
|
* "custom" uses user-defined token values stored in `customTheme`.
|
|
*/
|
|
export type Theme = "light" | "dark" | "system" | "custom";
|
|
|
|
/**
|
|
* How to handle events with a NIP-36 content-warning tag.
|
|
* - "blur": Show a warning overlay; media is not loaded until the user reveals.
|
|
* - "hide": Remove the event from view entirely.
|
|
* - "show": Ignore the content-warning tag and display normally.
|
|
*/
|
|
export type ContentWarningPolicy = "blur" | "hide" | "show";
|
|
|
|
/** How to handle events with a NIP-36 content-warning tag. */
|
|
export type NsfwPolicy = "blur" | "hide" | "show";
|
|
|
|
export interface RelayMetadata {
|
|
/** List of relays with read/write permissions */
|
|
relays: { url: string; read: boolean; write: boolean }[];
|
|
/** Unix timestamp of when the relay list was last updated */
|
|
updatedAt: number;
|
|
}
|
|
|
|
/** Which "Other Stuff" content types to show in the sidebar nav and include in feeds. */
|
|
export interface FeedSettings {
|
|
/** Include text posts (kind 1) in the feed */
|
|
feedIncludePosts: boolean;
|
|
/** Include reposts (kind 6) in the feed */
|
|
feedIncludeReposts: boolean;
|
|
/** Include long-form articles (kind 30023) in the feed */
|
|
feedIncludeArticles: boolean;
|
|
/** Show Articles (kind 30023) link in sidebar */
|
|
showArticles: boolean;
|
|
/** Show Events (kind 31922/31923) link in sidebar */
|
|
showEvents: boolean;
|
|
/** Include calendar events in the follows/global feed */
|
|
feedIncludeEvents: boolean;
|
|
/** Show Vines (kind 34236) link in sidebar */
|
|
showVines: boolean;
|
|
/** Show Polls (kind 1068) link in sidebar */
|
|
showPolls: boolean;
|
|
/** Show Treasures link in sidebar */
|
|
showTreasures: boolean;
|
|
/** Show Geocache listings (kind 37516) in Treasures */
|
|
showTreasureGeocaches: boolean;
|
|
/** Show Found logs (kind 7516) in Treasures */
|
|
showTreasureFoundLogs: boolean;
|
|
/** Show Colors (kind 3367) link in sidebar */
|
|
showColors: boolean;
|
|
/** Show Follow Packs (kind 39089) link in sidebar */
|
|
showPacks: boolean;
|
|
/** Include Vines in the follows/global feed */
|
|
feedIncludeVines: boolean;
|
|
/** Include Polls in the follows/global feed */
|
|
feedIncludePolls: boolean;
|
|
/** Include Treasure geocaches in the follows/global feed */
|
|
feedIncludeTreasureGeocaches: boolean;
|
|
/** Include Treasure found logs in the follows/global feed */
|
|
feedIncludeTreasureFoundLogs: boolean;
|
|
/** Include Colors in the follows/global feed */
|
|
feedIncludeColors: boolean;
|
|
/** Include Follow Packs in the follows/global feed */
|
|
feedIncludePacks: boolean;
|
|
/** Show Magic Decks (kind 37381) link in sidebar */
|
|
showDecks: boolean;
|
|
/** Include Magic Decks in the follows/global feed */
|
|
feedIncludeDecks: boolean;
|
|
/** Show Webxdc apps (NIP-94 kind 1063 with m=application/x-webxdc) link in sidebar */
|
|
showWebxdc: boolean;
|
|
/** Include Webxdc apps in the follows/global feed */
|
|
feedIncludeWebxdc: boolean;
|
|
/** Show Themes link in sidebar */
|
|
showProfileThemes: boolean;
|
|
/** Include Profile Theme updates in the follows/global feed (legacy key, maps to feedIncludeThemeDefinitions + feedIncludeProfileThemeUpdates) */
|
|
feedIncludeProfileThemes: boolean;
|
|
/** Show theme definitions (kind 36767) on Themes page */
|
|
showThemeDefinitions: boolean;
|
|
/** Include theme definitions in the follows/global feed */
|
|
feedIncludeThemeDefinitions: boolean;
|
|
/** Show profile theme updates (kind 16767) on Themes page */
|
|
showProfileThemeUpdates: boolean;
|
|
/** Include profile theme updates in the follows/global feed */
|
|
feedIncludeProfileThemeUpdates: boolean;
|
|
/** Show custom profile themes when visiting other users' profiles */
|
|
showCustomProfileThemes: boolean;
|
|
/** Include voice messages (kind 1222 + 1244) in the follows/global feed */
|
|
feedIncludeVoiceMessages: boolean;
|
|
/** Show NIP-30 custom emojis in the emoji picker */
|
|
showCustomEmojis: boolean;
|
|
/** Show Emoji Packs (kind 30030) link in sidebar */
|
|
showEmojiPacks: boolean;
|
|
/** Include Emoji Packs in the follows/global feed */
|
|
feedIncludeEmojiPacks: boolean;
|
|
/** Show Photos (NIP-68, kind 20) link in sidebar */
|
|
showPhotos: boolean;
|
|
/** Include Photos in the follows/global feed */
|
|
feedIncludePhotos: boolean;
|
|
/** Show Videos page (NIP-71 kinds 21/22) link in sidebar */
|
|
showVideos: boolean;
|
|
/** Include normal videos (kind 21) in the follows/global feed */
|
|
feedIncludeNormalVideos: boolean;
|
|
/** Include short videos (kind 22) in the follows/global feed */
|
|
feedIncludeShortVideos: boolean;
|
|
/** Show NIP-38 user statuses on profiles and note cards */
|
|
showUserStatuses: boolean;
|
|
/** Show Music (kind 36787 tracks + kind 34139 playlists) link in sidebar */
|
|
showMusic: boolean;
|
|
/** Include music tracks (kind 36787) in the follows/global feed */
|
|
feedIncludeMusicTracks: boolean;
|
|
/** Include music playlists (kind 34139) in the follows/global feed */
|
|
feedIncludeMusicPlaylists: boolean;
|
|
/** Show Podcasts (kind 30054 episodes + kind 30055 trailers) link in sidebar */
|
|
showPodcasts: boolean;
|
|
/** Include podcast episodes (kind 30054) in the follows/global feed */
|
|
feedIncludePodcastEpisodes: boolean;
|
|
/** Include podcast trailers (kind 30055) in the follows/global feed */
|
|
feedIncludePodcastTrailers: boolean;
|
|
/** Show Development (NIP-34 repos, patches, PRs, custom NIPs, app submissions) link in sidebar */
|
|
showDevelopment: boolean;
|
|
/** Include Development content in the follows/global feed */
|
|
feedIncludeDevelopment: boolean;
|
|
/** Show Badges (NIP-58 kind 30009) link in sidebar */
|
|
showBadges: boolean;
|
|
/** Show badge definitions (kind 30009) on the Badges page */
|
|
showBadgeDefinitions: boolean;
|
|
/** Show profile badges (kind 30008) on the Badges page */
|
|
showProfileBadges: boolean;
|
|
/** Include badge definitions (kind 30009) in the follows/global feed */
|
|
feedIncludeBadgeDefinitions: boolean;
|
|
/** Include profile badges (kind 30008) in the follows/global feed */
|
|
feedIncludeProfileBadges: boolean;
|
|
/** Include replies in the follows feed (default: true) */
|
|
followsFeedShowReplies: boolean;
|
|
}
|
|
|
|
/**
|
|
* A standard NIP-01 filter object that may contain variable placeholders
|
|
* (`$name`) in string positions. After resolution, becomes a `NostrFilter`.
|
|
*/
|
|
export type TabFilter = Record<string, unknown>;
|
|
|
|
/** A variable definition for tab filters (extracted from `var` tags). */
|
|
export interface TabVarDef {
|
|
/** Variable name including the `$` prefix, e.g. `"$follows"`. */
|
|
name: string;
|
|
/** Tag name to extract from the referenced event, e.g. `"p"`. */
|
|
tagName: string;
|
|
/** Event pointer: `e:<id>` or `a:<kind>:<pubkey>:<d-tag>`. May contain variables. */
|
|
pointer: string;
|
|
}
|
|
|
|
/** A named feed tab saved from the search page. */
|
|
export interface SavedFeed {
|
|
id: string;
|
|
label: string;
|
|
filter: TabFilter;
|
|
vars: TabVarDef[];
|
|
createdAt: number;
|
|
}
|
|
|
|
export interface AppConfig {
|
|
/** Application display name used in page titles, UI text, and branding. Default: "Ditto". */
|
|
appName: string;
|
|
/** Application identifier used as a prefix for application-specific metadata (NIP-78 d-tags, etc). Default: "ditto". */
|
|
appId: string;
|
|
/** Sidebar item ID to display on the homepage ("/"). Default: "feed". */
|
|
homePage: string;
|
|
/** NIP-89 addr (`31990:<pubkey>:<d-tag>`) identifying this client's handler event. Included as the third element of the "client" tag. */
|
|
client?: string;
|
|
/** Enable Magic Mouse mode: cursor/finger emanates magical fire in the primary color */
|
|
magicMouse: boolean;
|
|
/** Current theme */
|
|
theme: Theme;
|
|
/** Custom theme config (colors, fonts, background). Only used when theme === "custom". */
|
|
customTheme?: ThemeConfig;
|
|
/** Automatically publish custom theme changes to profile (kind 16767). Default: true. */
|
|
autoShareTheme: boolean;
|
|
/** Configured light and dark themes. Overrides the builtin themes when set. */
|
|
themes?: ThemesConfig;
|
|
/** NIP-65 relay list metadata */
|
|
relayMetadata: RelayMetadata;
|
|
/** Whether to use app default relays in addition to user relays */
|
|
useAppRelays: boolean;
|
|
/** Feed and sidebar content settings */
|
|
feedSettings: FeedSettings;
|
|
/** Ordered list of sidebar item IDs (built-in + extra-kind). */
|
|
sidebarOrder: string[];
|
|
/** NIP-85 stats pubkey source (hex format) */
|
|
nip85StatsPubkey: string;
|
|
/** Blossom file upload server URLs */
|
|
blossomServers: string[];
|
|
/** Favicon URI template. Supports RFC 6570 variables: {href}, {origin}, {hostname}, etc. */
|
|
faviconUrl: string;
|
|
/** Link preview URI template. Supports RFC 6570 variables: {url}, {href}, {origin}, {hostname}, etc. Returns OEmbed JSON. */
|
|
linkPreviewUrl: string;
|
|
/** CORS proxy URI template. Use {href} as placeholder for the target URL (URL-encoded). */
|
|
corsProxy: string;
|
|
/** How to handle NIP-36 content-warning events (blur, hide, or show). Default: "blur". */
|
|
contentWarningPolicy: ContentWarningPolicy;
|
|
/** Sentry DSN for error reporting (empty string = disabled). */
|
|
sentryDsn: string;
|
|
/** Whether the user has enabled Sentry error reporting. */
|
|
sentryEnabled: boolean;
|
|
/** Plausible Analytics domain (empty string = disabled). */
|
|
plausibleDomain: string;
|
|
/** Plausible Analytics API endpoint (empty string = use default). */
|
|
plausibleEndpoint: string;
|
|
/** Saved home feed tabs. Cached locally so they appear instantly on load. */
|
|
savedFeeds: SavedFeed[];
|
|
}
|
|
|
|
export interface AppContextType {
|
|
/** Current application configuration */
|
|
config: AppConfig;
|
|
/** Update configuration using a callback that receives current config and returns new config */
|
|
updateConfig: (
|
|
updater: (currentConfig: Partial<AppConfig>) => Partial<AppConfig>,
|
|
) => void;
|
|
}
|
|
|
|
export const AppContext = createContext<AppContextType | undefined>(undefined);
|