-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi.ts
More file actions
187 lines (158 loc) · 4.65 KB
/
Copy pathapi.ts
File metadata and controls
187 lines (158 loc) · 4.65 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
import type { Client, ClientEvents, Interaction } from "discord.js";
import type { SharedSlashCommand } from "@discordjs/builders";
import type { Database } from "./database.types";
import type { NuitConfig } from "./config";
import type { MessageBus } from "./message";
/**
* Minimal structural interface for the Drizzle database instance.
* Kept intentionally small so modules can depend on the shared context shape
* without importing Drizzle implementation details from the bot package.
*/
export interface NuitDb {
select(...args: unknown[]): any;
insert(...args: unknown[]): any;
update(...args: unknown[]): any;
delete(...args: unknown[]): any;
execute(...args: unknown[]): any;
transaction(...args: unknown[]): any;
}
export type { NuitConfig } from "./config";
export type {
Database,
Tables as TableRow,
TablesInsert as TableInsert,
TablesUpdate as TableUpdate,
} from "./database.types";
// ---------------------------------------------------------------------------
// Context types
// ---------------------------------------------------------------------------
export interface BaseCtx {
client: Client;
db: NuitDb;
config: Readonly<NuitConfig>;
bus: MessageBus;
}
export interface ModuleContext extends BaseCtx {
api: NuitAPI;
}
// ---------------------------------------------------------------------------
// Module / command / event types
// ---------------------------------------------------------------------------
export type NuitModuleKind = "internal" | "essential" | "optional";
export interface NuitCommandInput {
/** Slash command builder — any variant (with options, subcommands, etc.) */
data: SharedSlashCommand;
execute: (interaction: Interaction, ctx: BaseCtx) => any;
}
export interface NuitCommand {
module: string;
kind: NuitModuleKind | null;
data: SharedSlashCommand;
execute: (interaction: Interaction, ctx: BaseCtx) => any;
}
export interface NuitEventOptions {
guildScoped?: boolean;
}
export type NuitEventHandler<
K extends keyof ClientEvents = keyof ClientEvents,
> = (...args: ClientEvents[K]) => Promise<void> | void;
export interface NuitEvent<K extends keyof ClientEvents = keyof ClientEvents> {
name: K;
once: boolean;
guildScoped: boolean;
handler: NuitEventHandler<K>;
module: string;
}
export interface ModuleRegistry {
commands: NuitCommand[];
events: NuitEvent[];
config: ConfigField[];
}
// ---------------------------------------------------------------------------
// API surface
// ---------------------------------------------------------------------------
export interface NuitAPI {
registerCommand(cmd: NuitCommandInput): void;
onEvent<K extends keyof ClientEvents>(
name: K,
handler: NuitEventHandler<K>,
options?: NuitEventOptions,
): void;
onceEvent<K extends keyof ClientEvents>(
name: K,
handler: NuitEventHandler<K>,
options?: NuitEventOptions,
): void;
registerConfig(config: ModuleConfigField[]): void;
}
// ---------------------------------------------------------------------------
// Config surface
// ---------------------------------------------------------------------------
export type ConfigFieldType =
| "string"
| "number"
| "boolean"
| "select"
| "channel"
| "role"
| "user"
| "secret";
interface BaseField {
key: string;
label: string;
description?: string;
group?: string;
optional?: boolean;
module: string;
}
interface StringField extends BaseField {
type: "string";
default?: string;
min?: number; // length
max?: number;
}
interface NumberField extends BaseField {
type: "number";
default?: number;
min?: number;
max?: number;
}
interface BooleanField extends BaseField {
type: "boolean";
default?: boolean;
}
interface SelectField extends BaseField {
type: "select";
options: { label: string; value: string }[];
default?: string;
}
interface ChannelField extends BaseField {
type: "channel";
default?: string; // snowflake
}
interface RoleField extends BaseField {
type: "role";
default?: string;
}
interface UserField extends BaseField {
type: "user";
default?: string;
}
interface SecretField extends BaseField {
type: "secret";
}
export type ConfigField =
| StringField
| NumberField
| BooleanField
| SelectField
| ChannelField
| RoleField
| UserField
| SecretField;
export type ModuleConfigField = ConfigField extends infer T
? T extends ConfigField
? Omit<T, "module">
: never
: never;
export type ConfigSchema = Record<string, ConfigField>;