Files
eranos/src/contexts/AppContext.ts
T

134 lines
5.6 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 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;
/** Show Streams (kind 30311) link in sidebar */
showStreams: 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;
/** Include Streams in the follows/global feed */
feedIncludeStreams: 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;
}
export interface AppConfig {
/** 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[];
/** Default comment attached to zaps */
defaultZapComment: 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;
}
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);