Files
Nexumi/packages/shared/src/owner.ts
smueller c7fb3d7041 Add global /about command and configuration
- Introduced `BotAboutConfig` model for managing the global `/about` message in the owner panel.
- Implemented the `/about` command with localization support and integrated it into the help catalog.
- Enhanced the dashboard with a new owner section for configuring the `/about` message type and content.
- Updated components to handle the new command and its interactions, including support for different message formats (TEXT, EMBED, COMPONENTS_V2).
- Added localization entries for the `/about` command in English and German, improving accessibility for users.
- Documented the implementation in the phase tracking documentation for future reference.
2026-07-24 12:26:00 +02:00

142 lines
4.4 KiB
TypeScript

import { z } from 'zod';
import { MessageComponentsV2Schema } from './components-v2.js';
import { WelcomeEmbedSchema } from './phase2.js';
const snowflake = z.string().regex(/^\d{17,20}$/);
export const OwnerRoleSchema = z.enum(['VIEWER', 'SUPPORT', 'ADMIN', 'OWNER']);
export type OwnerRole = z.infer<typeof OwnerRoleSchema>;
export const OWNER_ROLE_RANK: Record<OwnerRole, number> = {
VIEWER: 1,
SUPPORT: 2,
ADMIN: 3,
OWNER: 4
};
export function ownerRoleAtLeast(role: OwnerRole, minimum: OwnerRole): boolean {
return OWNER_ROLE_RANK[role] >= OWNER_ROLE_RANK[minimum];
}
export const BotPresenceStatusSchema = z.enum(['online', 'idle', 'dnd', 'invisible']);
export const BotActivityTypeSchema = z.enum(['Playing', 'Listening', 'Watching', 'Competing']);
export const BotPresenceConfigSchema = z.object({
status: BotPresenceStatusSchema,
activityType: BotActivityTypeSchema,
activityText: z.string().min(1).max(128),
rotatingMessages: z.array(z.string().min(1).max(128)).max(20),
maintenanceMode: z.boolean(),
maintenanceMessage: z.string().max(500).nullable()
});
export type BotPresenceConfig = z.infer<typeof BotPresenceConfigSchema>;
export const BotPresenceConfigPatchSchema = BotPresenceConfigSchema.partial().refine(
(value) => Object.keys(value).length > 0,
{ message: 'At least one field is required' }
);
export const OwnerTeamMemberSchema = z.object({
id: z.string().optional(),
userId: snowflake,
role: OwnerRoleSchema,
note: z.string().max(500).nullable().optional()
});
export type OwnerTeamMember = z.infer<typeof OwnerTeamMemberSchema>;
export const OwnerTeamUpsertSchema = OwnerTeamMemberSchema;
export const FeatureFlagSchema = z.object({
id: z.string().optional(),
key: z
.string()
.min(1)
.max(64)
.regex(/^[a-z0-9._-]+$/i),
enabled: z.boolean(),
rolloutPercent: z.number().int().min(0).max(100),
whitelistGuildIds: z.array(snowflake)
});
export type FeatureFlag = z.infer<typeof FeatureFlagSchema>;
export const FeatureFlagUpsertSchema = FeatureFlagSchema;
export const GlobalUserBlacklistSchema = z.object({
id: z.string().optional(),
userId: snowflake,
reason: z.string().max(500).nullable().optional(),
note: z.string().max(1000).nullable().optional()
});
export type GlobalUserBlacklist = z.infer<typeof GlobalUserBlacklistSchema>;
export const GuildBlacklistSchema = z.object({
id: z.string().optional(),
guildId: snowflake,
reason: z.string().max(500).nullable().optional()
});
export type GuildBlacklist = z.infer<typeof GuildBlacklistSchema>;
/** Enriched guild row for the Owner panel guild manager. */
export const OwnerGuildListItemSchema = z.object({
id: snowflake,
name: z.string().nullable(),
iconUrl: z.string().url().nullable(),
memberCount: z.number().int().nonnegative().nullable(),
locale: z.string().min(1).max(16),
createdAt: z.string(),
blacklisted: z.boolean()
});
export type OwnerGuildListItem = z.infer<typeof OwnerGuildListItemSchema>;
export const ChangelogEntrySchema = z.object({
id: z.string().optional(),
version: z.string().min(1).max(32),
title: z.string().min(1).max(200),
body: z.string().min(1).max(10000),
publishedAt: z.string().datetime().optional()
});
export type ChangelogEntry = z.infer<typeof ChangelogEntrySchema>;
export const OwnerAuditEntrySchema = z.object({
id: z.string(),
actorUserId: z.string(),
action: z.string(),
targetType: z.string().nullable(),
targetId: z.string().nullable(),
createdAt: z.string()
});
export type OwnerAuditEntry = z.infer<typeof OwnerAuditEntrySchema>;
export const PRESENCE_REDIS_KEY = 'bot:presence';
export const BotAboutMessageTypeSchema = z.enum(['TEXT', 'EMBED', 'COMPONENTS_V2']);
export type BotAboutMessageType = z.infer<typeof BotAboutMessageTypeSchema>;
/** Global `/about` reply configured in the Owner panel. */
export const BotAboutConfigSchema = z.object({
enabled: z.boolean(),
messageType: BotAboutMessageTypeSchema,
content: z.string().max(2000).nullable(),
embed: WelcomeEmbedSchema.nullable(),
components: MessageComponentsV2Schema.nullable()
});
export type BotAboutConfig = z.infer<typeof BotAboutConfigSchema>;
export const BotAboutConfigPatchSchema = BotAboutConfigSchema.partial().refine(
(value) => Object.keys(value).length > 0,
{ message: 'At least one field is required' }
);
export type BotAboutConfigPatch = z.infer<typeof BotAboutConfigPatchSchema>;
export const ABOUT_REDIS_KEY = 'bot:about';