mirror of
https://github.com/owncast/owncast.git
synced 2025-10-30 17:47:32 +08:00
383b80851b
* Initial plan * Add localization support to admin form status and error messages Co-authored-by: gabek <414923+gabek@users.noreply.github.com> * Format updated files with prettier Co-authored-by: gabek <414923+gabek@users.noreply.github.com> * Replace t() with Translation component in admin page JSX Co-authored-by: gabek <414923+gabek@users.noreply.github.com> * update package-lock.json * Update web/i18n/en/translation.json Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: gabek <414923+gabek@users.noreply.github.com> Co-authored-by: Gabe Kangas <gabek@real-ity.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
356 lines
13 KiB
TypeScript
356 lines
13 KiB
TypeScript
/**
|
|
* Centralized localization keys for type-safe translation handling.
|
|
* This provides a single source of truth for all translation keys used in the application.
|
|
* Keys are organized by logical sections using TypeScript namespaces.
|
|
*/
|
|
export const Localization = {
|
|
/**
|
|
* Frontend keys used in the main user-facing web application
|
|
*/
|
|
Frontend: {
|
|
// Chat interface
|
|
chatOffline: 'Chat is offline',
|
|
chatDisabled: 'Chat is disabled',
|
|
chatWillBeAvailable: 'Chat will be available when the stream is live',
|
|
|
|
// Stream information and statistics
|
|
lastLiveAgo: 'Last live {{timeAgo}} ago',
|
|
currentViewers: 'Current viewers',
|
|
maxViewers: 'Max viewers this stream',
|
|
noStreamActive: 'No stream is active',
|
|
healthyStream: 'Healthy Stream',
|
|
playbackHealth: 'Playback Health',
|
|
|
|
// User actions and interactions
|
|
notify: 'Notify',
|
|
follow: 'Follow',
|
|
connected: 'Connected',
|
|
|
|
// Navigation and accessibility
|
|
skipToPlayer: 'Skip to player',
|
|
skipToContent: 'Skip to page content',
|
|
skipToFooter: 'Skip to footer',
|
|
|
|
// Social and external services
|
|
stayUpdated: 'Stay updated!',
|
|
fediverse: 'Add your Owncast instance to the Fediverse',
|
|
owncastDirectory: 'Find an audience on the Owncast Directory',
|
|
|
|
// Streaming setup and integration
|
|
useBroadcastingSoftware: 'Use your broadcasting software',
|
|
embedVideo: 'Embed your video onto other sites',
|
|
|
|
// Complex HTML translations with variables
|
|
helloWorld: 'Frontend.helloWorld',
|
|
complexMessage: 'Frontend.complexMessage',
|
|
|
|
// Errors
|
|
componentError: 'Frontend.componentError',
|
|
|
|
// Browser notifications - organized by component
|
|
BrowserNotifyModal: {
|
|
unsupported: 'Frontend.BrowserNotifyModal.unsupported',
|
|
unsupportedLocal: 'Frontend.BrowserNotifyModal.unsupportedLocal',
|
|
iosTitle: 'Frontend.BrowserNotifyModal.iosTitle',
|
|
iosDescription: 'Frontend.BrowserNotifyModal.iosDescription',
|
|
iosShareButton: 'Frontend.BrowserNotifyModal.iosShareButton',
|
|
iosAddToHomeScreen: 'Frontend.BrowserNotifyModal.iosAddToHomeScreen',
|
|
iosAddButton: 'Frontend.BrowserNotifyModal.iosAddButton',
|
|
iosNameAndTap: 'Frontend.BrowserNotifyModal.iosNameAndTap',
|
|
iosComeBack: 'Frontend.BrowserNotifyModal.iosComeBack',
|
|
iosAllowPrompt: 'Frontend.BrowserNotifyModal.iosAllowPrompt',
|
|
permissionWantsTo: 'Frontend.BrowserNotifyModal.permissionWantsTo',
|
|
showNotifications: 'Frontend.BrowserNotifyModal.showNotifications',
|
|
allowButton: 'Frontend.BrowserNotifyModal.allowButton',
|
|
blockButton: 'Frontend.BrowserNotifyModal.blockButton',
|
|
enabledTitle: 'Frontend.BrowserNotifyModal.enabledTitle',
|
|
enabledDescription: 'Frontend.BrowserNotifyModal.enabledDescription',
|
|
deniedTitle: 'Frontend.BrowserNotifyModal.deniedTitle',
|
|
deniedDescription: 'Frontend.BrowserNotifyModal.deniedDescription',
|
|
mainDescription: 'Frontend.BrowserNotifyModal.mainDescription',
|
|
learnMore: 'Frontend.BrowserNotifyModal.learnMore',
|
|
errorTitle: 'Frontend.BrowserNotifyModal.errorTitle',
|
|
errorMessage: 'Frontend.BrowserNotifyModal.errorMessage',
|
|
},
|
|
|
|
// Name change modal - organized by component
|
|
NameChangeModal: {
|
|
description: 'Frontend.NameChangeModal.description',
|
|
placeholder: 'Frontend.NameChangeModal.placeholder',
|
|
buttonText: 'Frontend.NameChangeModal.buttonText',
|
|
colorLabel: 'Frontend.NameChangeModal.colorLabel',
|
|
authInfo: 'Frontend.NameChangeModal.authInfo',
|
|
overLimit: 'Frontend.NameChangeModal.overLimit',
|
|
},
|
|
|
|
// Header component
|
|
Header: {
|
|
skipToPlayer: 'Frontend.Header.skipToPlayer',
|
|
skipToOfflineMessage: 'Frontend.Header.skipToOfflineMessage',
|
|
skipToContent: 'Frontend.Header.skipToContent',
|
|
skipToFooter: 'Frontend.Header.skipToFooter',
|
|
chatWillBeAvailable: 'Frontend.Header.chatWillBeAvailable',
|
|
chatOffline: 'Frontend.Header.chatOffline',
|
|
},
|
|
|
|
// Footer component
|
|
Footer: {
|
|
documentation: 'Frontend.Footer.documentation',
|
|
contribute: 'Frontend.Footer.contribute',
|
|
source: 'Frontend.Footer.source',
|
|
},
|
|
|
|
// Chat message components
|
|
Chat: {
|
|
userJoined: 'Frontend.Chat.userJoined',
|
|
userLeft: 'Frontend.Chat.userLeft',
|
|
nameChangeText: 'Frontend.Chat.nameChangeText',
|
|
moderatorNotification: 'Frontend.Chat.moderatorNotification',
|
|
},
|
|
|
|
// Follow modal component
|
|
FollowModal: {
|
|
description: 'Frontend.FollowModal.description',
|
|
learnFediverse: 'Frontend.FollowModal.learnFediverse',
|
|
newToYou: 'Frontend.FollowModal.newToYou',
|
|
instructions: 'Frontend.FollowModal.instructions',
|
|
placeholder: 'Frontend.FollowModal.placeholder',
|
|
redirectMessage: 'Frontend.FollowModal.redirectMessage',
|
|
joinFediverse: 'Frontend.FollowModal.joinFediverse',
|
|
followButton: 'Frontend.FollowModal.followButton',
|
|
followError: 'Frontend.FollowModal.followError',
|
|
unableToFollow: 'Frontend.FollowModal.unableToFollow',
|
|
},
|
|
|
|
// Offline banner messages
|
|
offlineBasic: 'Frontend.offlineBasic',
|
|
offlineNotifyOnly: 'Frontend.offlineNotifyOnly',
|
|
offlineFediverseOnly: 'Frontend.offlineFediverseOnly',
|
|
offlineNotifyAndFediverse: 'Frontend.offlineNotifyAndFediverse',
|
|
},
|
|
|
|
/**
|
|
* Admin keys used in the admin interface
|
|
*/
|
|
Admin: {
|
|
// Emoji management
|
|
emojis: 'Admin.emojis',
|
|
emojiPageDescription: 'Admin.emojiPageDescription',
|
|
emojiUploadBulkGuide: 'Admin.emojiUploadBulkGuide',
|
|
uploadNewEmoji: 'Admin.uploadNewEmoji',
|
|
deleteEmoji: 'Admin.deleteEmoji',
|
|
|
|
// Settings and configuration
|
|
settings: 'Admin.settings',
|
|
overriddenViaCommandLine: 'Admin.overriddenViaCommandLine',
|
|
|
|
Chat: {
|
|
moderationMessagesSent: 'Admin.Chat.moderationMessagesSent',
|
|
moderationMessagesSent_one: 'Admin.Chat.moderationMessagesSent_one',
|
|
},
|
|
|
|
// EditInstanceDetails component specific keys
|
|
EditInstanceDetails: {
|
|
offlineMessageDescription: 'Admin.EditInstanceDetails.offlineMessageDescription',
|
|
directoryDescription: 'Admin.EditInstanceDetails.directoryDescription',
|
|
serverUrlRequiredForDirectory: 'Admin.EditInstanceDetails.serverUrlRequiredForDirectory',
|
|
},
|
|
|
|
// VideoVariantForm component specific keys
|
|
VideoVariantForm: {
|
|
bitrateDisabledPassthrough: 'Admin.VideoVariantForm.bitrateDisabledPassthrough',
|
|
bitrateValueKbps: 'Admin.VideoVariantForm.bitrateValueKbps',
|
|
bitrateGoodForSlow: 'Admin.VideoVariantForm.bitrateGoodForSlow',
|
|
bitrateGoodForMost: 'Admin.VideoVariantForm.bitrateGoodForMost',
|
|
bitrateGoodForHigh: 'Admin.VideoVariantForm.bitrateGoodForHigh',
|
|
},
|
|
|
|
// Hardware monitoring page
|
|
HardwareInfo: {
|
|
title: 'Admin.HardwareInfo.title',
|
|
pleaseWait: 'Admin.HardwareInfo.pleaseWait',
|
|
noDetails: 'Admin.HardwareInfo.noDetails',
|
|
cpu: 'Admin.HardwareInfo.cpu',
|
|
memory: 'Admin.HardwareInfo.memory',
|
|
disk: 'Admin.HardwareInfo.disk',
|
|
used: 'Admin.HardwareInfo.used',
|
|
},
|
|
|
|
// Help page
|
|
Help: {
|
|
title: 'Admin.Help.title',
|
|
configureInstance: 'Admin.Help.configureInstance',
|
|
learnMore: 'Admin.Help.learnMore',
|
|
configureBroadcasting: 'Admin.Help.configureBroadcasting',
|
|
embedStream: 'Admin.Help.embedStream',
|
|
customizeWebsite: 'Admin.Help.customizeWebsite',
|
|
tweakVideo: 'Admin.Help.tweakVideo',
|
|
useStorage: 'Admin.Help.useStorage',
|
|
foundBug: 'Admin.Help.foundBug',
|
|
bugPlease: 'Admin.Help.bugPlease',
|
|
letUsKnow: 'Admin.Help.letUsKnow',
|
|
generalQuestion: 'Admin.Help.generalQuestion',
|
|
generalAnswered: 'Admin.Help.generalAnswered',
|
|
faq: 'Admin.Help.faq',
|
|
orExist: 'Admin.Help.orExist',
|
|
discussions: 'Admin.Help.discussions',
|
|
buildAddons: 'Admin.Help.buildAddons',
|
|
buildTools: 'Admin.Help.buildTools',
|
|
developerApis: 'Admin.Help.developerApis',
|
|
troubleshooting: 'Admin.Help.troubleshooting',
|
|
fixProblems: 'Admin.Help.fixProblems',
|
|
documentation: 'Admin.Help.documentation',
|
|
readDocs: 'Admin.Help.readDocs',
|
|
commonTasks: 'Admin.Help.commonTasks',
|
|
other: 'Admin.Help.other',
|
|
},
|
|
|
|
// Log table component
|
|
LogTable: {
|
|
level: 'Admin.LogTable.level',
|
|
info: 'Admin.LogTable.info',
|
|
warning: 'Admin.LogTable.warning',
|
|
error: 'Admin.LogTable.error',
|
|
timestamp: 'Admin.LogTable.timestamp',
|
|
message: 'Admin.LogTable.message',
|
|
logs: 'Admin.LogTable.logs',
|
|
},
|
|
|
|
// News feed component
|
|
NewsFeed: {
|
|
link: 'Admin.NewsFeed.link',
|
|
noNews: 'Admin.NewsFeed.noNews',
|
|
title: 'Admin.NewsFeed.title',
|
|
},
|
|
|
|
// Viewer info page
|
|
ViewerInfo: {
|
|
title: 'Admin.ViewerInfo.title',
|
|
currentStream: 'Admin.ViewerInfo.currentStream',
|
|
last12Hours: 'Admin.ViewerInfo.last12Hours',
|
|
last24Hours: 'Admin.ViewerInfo.last24Hours',
|
|
last7Days: 'Admin.ViewerInfo.last7Days',
|
|
last30Days: 'Admin.ViewerInfo.last30Days',
|
|
last3Months: 'Admin.ViewerInfo.last3Months',
|
|
last6Months: 'Admin.ViewerInfo.last6Months',
|
|
currentViewers: 'Admin.ViewerInfo.currentViewers',
|
|
maxViewersThisStream: 'Admin.ViewerInfo.maxViewersThisStream',
|
|
maxViewersLastStream: 'Admin.ViewerInfo.maxViewersLastStream',
|
|
maxViewers: 'Admin.ViewerInfo.maxViewers',
|
|
pleaseWait: 'Admin.ViewerInfo.pleaseWait',
|
|
noData: 'Admin.ViewerInfo.noData',
|
|
viewers: 'Admin.ViewerInfo.viewers',
|
|
},
|
|
|
|
// Logging and monitoring
|
|
info: 'Admin.info',
|
|
warning: 'Admin.warning',
|
|
error: 'Admin.error',
|
|
level: 'Admin.level',
|
|
timestamp: 'Admin.timestamp',
|
|
message: 'Admin.message',
|
|
logs: 'Admin.logs',
|
|
|
|
// Form status messages
|
|
StatusMessages: {
|
|
updated: 'Admin.StatusMessages.updated',
|
|
tagsUpdated: 'Admin.StatusMessages.tagsUpdated',
|
|
variantsUpdated: 'Admin.StatusMessages.variantsUpdated',
|
|
videoCodecUpdated: 'Admin.StatusMessages.videoCodecUpdated',
|
|
latencyBufferUpdated: 'Admin.StatusMessages.latencyBufferUpdated',
|
|
deletingEmoji: 'Admin.StatusMessages.deletingEmoji',
|
|
emojiDeleted: 'Admin.StatusMessages.emojiDeleted',
|
|
convertingEmoji: 'Admin.StatusMessages.convertingEmoji',
|
|
uploadingEmoji: 'Admin.StatusMessages.uploadingEmoji',
|
|
emojiUploadedSuccessfully: 'Admin.StatusMessages.emojiUploadedSuccessfully',
|
|
thereWasAnError: 'Admin.StatusMessages.thereWasAnError',
|
|
fileSizeTooBig: 'Admin.StatusMessages.fileSizeTooBig',
|
|
fileTypeNotSupported: 'Admin.StatusMessages.fileTypeNotSupported',
|
|
pleaseEnterTag: 'Admin.StatusMessages.pleaseEnterTag',
|
|
tagAlreadyUsed: 'Admin.StatusMessages.tagAlreadyUsed',
|
|
},
|
|
|
|
// Actions page
|
|
Actions: {
|
|
title: 'Admin.Actions.title',
|
|
description: 'Admin.Actions.description',
|
|
readMoreLink: 'Admin.Actions.readMoreLink',
|
|
createNewAction: 'Admin.Actions.createNewAction',
|
|
createNewActionTitle: 'Admin.Actions.createNewActionTitle',
|
|
editActionTitle: 'Admin.Actions.editActionTitle',
|
|
modalDescription: 'Admin.Actions.modalDescription',
|
|
onlyHttpsSupported: 'Admin.Actions.onlyHttpsSupported',
|
|
readMoreAboutActions: 'Admin.Actions.readMoreAboutActions',
|
|
selectActionType: 'Admin.Actions.selectActionType',
|
|
linkOrEmbedUrl: 'Admin.Actions.linkOrEmbedUrl',
|
|
customHtml: 'Admin.Actions.customHtml',
|
|
htmlEmbedPlaceholder: 'Admin.Actions.htmlEmbedPlaceholder',
|
|
urlPlaceholder: 'Admin.Actions.urlPlaceholder',
|
|
titlePlaceholder: 'Admin.Actions.titlePlaceholder',
|
|
descriptionPlaceholder: 'Admin.Actions.descriptionPlaceholder',
|
|
iconPlaceholder: 'Admin.Actions.iconPlaceholder',
|
|
optionalBackgroundColor: 'Admin.Actions.optionalBackgroundColor',
|
|
openExternally: 'Admin.Actions.openExternally',
|
|
},
|
|
|
|
// Webhooks page
|
|
Webhooks: {
|
|
createNewWebhook: 'Admin.Webhooks.createNewWebhook',
|
|
webhookUrlPlaceholder: 'Admin.Webhooks.webhookUrlPlaceholder',
|
|
selectEvents: 'Admin.Webhooks.selectEvents',
|
|
selectAll: 'Admin.Webhooks.selectAll',
|
|
},
|
|
|
|
// Access Tokens page
|
|
AccessTokens: {
|
|
createNewAccessToken: 'Admin.AccessTokens.createNewAccessToken',
|
|
nameDescription: 'Admin.AccessTokens.nameDescription',
|
|
namePlaceholder: 'Admin.AccessTokens.namePlaceholder',
|
|
selectPermissions: 'Admin.AccessTokens.selectPermissions',
|
|
cannotEditAfterCreated: 'Admin.AccessTokens.cannotEditAfterCreated',
|
|
selectAll: 'Admin.AccessTokens.selectAll',
|
|
},
|
|
},
|
|
|
|
/**
|
|
* Common keys shared across both frontend and admin interfaces
|
|
*/
|
|
Common: {
|
|
// Branding
|
|
poweredByOwncastVersion: 'Common.poweredByOwncastVersion',
|
|
},
|
|
|
|
/**
|
|
* Testing keys used for development and testing purposes
|
|
*/
|
|
Testing: {
|
|
testing: 'testing_string',
|
|
another: 'another_test',
|
|
simpleKey: 'Testing.simpleKey',
|
|
itemCount: 'Testing.itemCount',
|
|
messageCount: 'Testing.messageCount',
|
|
noPluralKey: 'Testing.noPluralKey',
|
|
},
|
|
} as const;
|
|
|
|
/**
|
|
* Helper type to extract all nested values from the Localization object
|
|
*/
|
|
type NestedValues<T> = T extends object
|
|
? {
|
|
[K in keyof T]: T[K] extends string ? T[K] : NestedValues<T[K]>;
|
|
}[keyof T]
|
|
: never;
|
|
|
|
/**
|
|
* Type representing all valid localization keys.
|
|
* This ensures type safety when using translation keys with nested structure.
|
|
*/
|
|
export type LocalizationKey = NestedValues<typeof Localization>;
|
|
|
|
/**
|
|
* Helper type to get the actual string value from a localization key.
|
|
* This can be useful for type inference in components.
|
|
*/
|
|
export type LocalizationValue<T extends LocalizationKey> = T;
|