mirror of
https://github.com/ZeppelinBot/Zeppelin.git
synced 2025-03-15 22:01:50 +00:00
102 lines
2.4 KiB
TypeScript
102 lines
2.4 KiB
TypeScript
import * as t from "io-ts";
|
|
import { BaseConfig, Knub } from "knub";
|
|
|
|
export interface ZeppelinGuildConfig extends BaseConfig<any> {
|
|
success_emoji?: string;
|
|
error_emoji?: string;
|
|
|
|
// Deprecated
|
|
timezone?: string;
|
|
date_formats?: any;
|
|
}
|
|
|
|
export const ZeppelinGuildConfigSchema = t.type({
|
|
// From BaseConfig
|
|
prefix: t.string,
|
|
levels: t.record(t.string, t.number),
|
|
plugins: t.record(t.string, t.unknown),
|
|
|
|
// From ZeppelinGuildConfig
|
|
success_emoji: t.string,
|
|
error_emoji: t.string,
|
|
|
|
// Deprecated
|
|
timezone: t.string,
|
|
date_formats: t.unknown,
|
|
});
|
|
export const PartialZeppelinGuildConfigSchema = t.partial(ZeppelinGuildConfigSchema.props);
|
|
|
|
export interface ZeppelinGlobalConfig extends BaseConfig<any> {
|
|
url: string;
|
|
owners?: string[];
|
|
}
|
|
|
|
export const ZeppelinGlobalConfigSchema = t.type({
|
|
url: t.string,
|
|
owners: t.array(t.string),
|
|
plugins: t.record(t.string, t.unknown),
|
|
});
|
|
|
|
export type TZeppelinKnub = Knub<ZeppelinGuildConfig, ZeppelinGlobalConfig>;
|
|
|
|
/**
|
|
* Wrapper for the string type that indicates the text will be parsed as Markdown later
|
|
*/
|
|
export type TMarkdown = string;
|
|
|
|
export interface ZeppelinPluginInfo {
|
|
prettyName: string;
|
|
description?: TMarkdown;
|
|
usageGuide?: TMarkdown;
|
|
configurationGuide?: TMarkdown;
|
|
}
|
|
|
|
export interface CommandInfo {
|
|
description?: TMarkdown;
|
|
basicUsage?: TMarkdown;
|
|
examples?: TMarkdown;
|
|
usageGuide?: TMarkdown;
|
|
parameterDescriptions?: {
|
|
[key: string]: TMarkdown;
|
|
};
|
|
optionDescriptions?: {
|
|
[key: string]: TMarkdown;
|
|
};
|
|
}
|
|
|
|
export enum ChannelTypeStrings {
|
|
TEXT = "GUILD_TEXT",
|
|
DM = "DM",
|
|
VOICE = "GUILD_VOICE",
|
|
GROUP = "GROUP_DM",
|
|
CATEGORY = "GUILD_CATEGORY",
|
|
NEWS = "GUILD_NEWS",
|
|
STORE = "GUILD_STORE",
|
|
NEWS_THREAD = "GUILD_NEWS_THREAD",
|
|
PUBLIC_THREAD = "GUILD_PUBLIC_THREAD",
|
|
PRIVATE_THREAD = "GUILD_PRIVATE_THREAD",
|
|
STAGE = "GUILD_STAGE_VOICE",
|
|
UNKNOWN = "UNKNOWN",
|
|
}
|
|
|
|
export enum MessageTypeStrings {
|
|
"DEFAULT",
|
|
"RECIPIENT_ADD",
|
|
"RECIPIENT_REMOVE",
|
|
"CALL",
|
|
"CHANNEL_NAME_CHANGE",
|
|
"CHANNEL_ICON_CHANGE",
|
|
"PINS_ADD",
|
|
"GUILD_MEMBER_JOIN",
|
|
"USER_PREMIUM_GUILD_SUBSCRIPTION",
|
|
"USER_PREMIUM_GUILD_SUBSCRIPTION_TIER_1",
|
|
"USER_PREMIUM_GUILD_SUBSCRIPTION_TIER_2",
|
|
"USER_PREMIUM_GUILD_SUBSCRIPTION_TIER_3",
|
|
"CHANNEL_FOLLOW_ADD",
|
|
"GUILD_DISCOVERY_DISQUALIFIED",
|
|
"GUILD_DISCOVERY_REQUALIFIED",
|
|
"GUILD_DISCOVERY_GRACE_PERIOD_INITIAL_WARNING",
|
|
"GUILD_DISCOVERY_GRACE_PERIOD_FINAL_WARNING",
|
|
"REPLY",
|
|
"APPLICATION_COMMAND",
|
|
}
|