Skip to content

Commit 317d09e

Browse files
jeremy-rifkinjeremy-rifkin
committed
Rename button/modal metadata parameters
1 parent 771be28 commit 317d09e

5 files changed

Lines changed: 46 additions & 46 deletions

File tree

‎src/command-abstractions/button.ts‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8,26 +8,26 @@ import { BaseBuilder } from "./interaction-base.js";
88
export type ButtonParameterType = "string" | "number" | "boolean" | "user_id";
99

1010
export class BotButtonHandler<Args extends unknown[] = []> {
11-
private readonly parameter_types: ButtonParameterType[] = [];
11+
private readonly metadata_fields: ButtonParameterType[] = [];
1212

1313
constructor(
1414
public readonly base_custom_id: string,
1515
public readonly handler: (interaction: Discord.ButtonInteraction, ...args: Args) => Promise<void>,
1616
public readonly permissions?: bigint,
17-
parameter_types: ButtonParameterType[] = [],
17+
metadata_fields: ButtonParameterType[] = [],
1818
) {
19-
this.parameter_types = parameter_types;
19+
this.metadata_fields = metadata_fields;
2020
}
2121

2222
parse_arguments(raw_args: string[]): Args {
2323
assert(
24-
raw_args.length === this.parameter_types.length,
25-
`Expected ${this.parameter_types.length} arguments, got ${raw_args.length} ` +
24+
raw_args.length === this.metadata_fields.length,
25+
`Expected ${this.metadata_fields.length} arguments, got ${raw_args.length} ` +
2626
`for button ${this.base_custom_id}`,
2727
);
2828

2929
return raw_args.map((arg, index) => {
30-
const type = this.parameter_types[index];
30+
const type = this.metadata_fields[index];
3131
try {
3232
if (type === "string" || type === "user_id") {
3333
return arg;
@@ -77,17 +77,17 @@ export class BotButtonHandler<Args extends unknown[] = []> {
7777
export class BotButton<Args extends unknown[] = []> {
7878
constructor(
7979
public readonly base_custom_id: string,
80-
private readonly parameter_types: ButtonParameterType[] = [],
80+
private readonly metadata_fields: ButtonParameterType[] = [],
8181
) {}
8282

8383
generate_custom_id(...args: Args): string {
8484
assert(
85-
args.length === this.parameter_types.length,
86-
`Expected ${this.parameter_types.length} arguments, got ${args.length} for button ${this.base_custom_id}`,
85+
args.length === this.metadata_fields.length,
86+
`Expected ${this.metadata_fields.length} arguments, got ${args.length} for button ${this.base_custom_id}`,
8787
);
8888

8989
const serialized_args = args.map((arg, index) => {
90-
const type = this.parameter_types[index];
90+
const type = this.metadata_fields[index];
9191
try {
9292
if (type === "string" || type === "user_id") {
9393
return String(arg);
@@ -131,30 +131,30 @@ export class ButtonInteractionBuilder<
131131
Args extends unknown[] = [],
132132
HasHandler extends boolean = false,
133133
> extends BaseBuilder<HasHandler, [Discord.ButtonInteraction, ...Args]> {
134-
private readonly parameter_types: ButtonParameterType[] = [];
134+
private readonly metadata_fields: ButtonParameterType[] = [];
135135
private permissions?: bigint;
136136

137137
constructor(public readonly base_custom_id: string) {
138138
super();
139139
}
140140

141-
add_string_parameter(): ButtonInteractionBuilder<[...Args, string], HasHandler> {
142-
this.parameter_types.push("string");
141+
add_string_metadata(): ButtonInteractionBuilder<[...Args, string], HasHandler> {
142+
this.metadata_fields.push("string");
143143
return this as unknown as ButtonInteractionBuilder<[...Args, string], HasHandler>;
144144
}
145145

146-
add_number_parameter(): ButtonInteractionBuilder<[...Args, number], HasHandler> {
147-
this.parameter_types.push("number");
146+
add_number_metadata(): ButtonInteractionBuilder<[...Args, number], HasHandler> {
147+
this.metadata_fields.push("number");
148148
return this as unknown as ButtonInteractionBuilder<[...Args, number], HasHandler>;
149149
}
150150

151-
add_boolean_parameter(): ButtonInteractionBuilder<[...Args, boolean], HasHandler> {
152-
this.parameter_types.push("boolean");
151+
add_boolean_metadata(): ButtonInteractionBuilder<[...Args, boolean], HasHandler> {
152+
this.metadata_fields.push("boolean");
153153
return this as unknown as ButtonInteractionBuilder<[...Args, boolean], HasHandler>;
154154
}
155155

156-
add_user_id_parameter(): ButtonInteractionBuilder<[...Args, string], HasHandler> {
157-
this.parameter_types.push("user_id");
156+
add_user_id_metadata(): ButtonInteractionBuilder<[...Args, string], HasHandler> {
157+
this.metadata_fields.push("user_id");
158158
return this as unknown as ButtonInteractionBuilder<[...Args, string], HasHandler>;
159159
}
160160

@@ -179,11 +179,11 @@ export class ButtonInteractionBuilder<
179179
this.base_custom_id,
180180
this.handler,
181181
this.permissions,
182-
this.parameter_types,
182+
this.metadata_fields,
183183
) as ConditionalOptional<HasHandler, BotButtonHandler<Args>>;
184184
}
185185

186186
build_button(): BotButton<Args> {
187-
return new BotButton(this.base_custom_id, this.parameter_types);
187+
return new BotButton(this.base_custom_id, this.metadata_fields);
188188
}
189189
}

‎src/command-abstractions/modal.ts‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,17 @@ export type ModalField = {
2222
};
2323

2424
export class BotModalHandler<Args extends unknown[] = []> {
25-
private readonly parameter_types: ModalParameterType[] = [];
25+
private readonly metadata_fields: ModalParameterType[] = [];
2626
private readonly field_configs: ModalField[] = [];
2727

2828
constructor(
2929
public readonly base_custom_id: string,
3030
public readonly handler: (interaction: Discord.ModalSubmitInteraction, ...args: Args) => Promise<void>,
3131
public readonly permissions?: bigint,
32-
parameter_types: ModalParameterType[] = [],
32+
metadata_fields: ModalParameterType[] = [],
3333
field_configs: ModalField[] = [],
3434
) {
35-
this.parameter_types = parameter_types;
35+
this.metadata_fields = metadata_fields;
3636
this.field_configs = field_configs;
3737
}
3838

@@ -42,13 +42,13 @@ export class BotModalHandler<Args extends unknown[] = []> {
4242

4343
parse_arguments(raw_args: string[]): Args {
4444
assert(
45-
raw_args.length === this.parameter_types.length,
46-
`Expected ${this.parameter_types.length} arguments, got ${raw_args.length} ` +
45+
raw_args.length === this.metadata_fields.length,
46+
`Expected ${this.metadata_fields.length} arguments, got ${raw_args.length} ` +
4747
`for modal ${this.base_custom_id}`,
4848
);
4949

5050
return raw_args.map((arg, index) => {
51-
const type = this.parameter_types[index];
51+
const type = this.metadata_fields[index];
5252
try {
5353
if (type === "string" || type === "user_id") {
5454
return arg;
@@ -99,18 +99,18 @@ export class BotModal<Args extends unknown[] = []> {
9999
constructor(
100100
public readonly base_custom_id: string,
101101
private readonly title: string,
102-
private readonly parameter_types: ModalParameterType[] = [],
102+
private readonly metadata_fields: ModalParameterType[] = [],
103103
private readonly field_configs: ModalField[] = [],
104104
) {}
105105

106106
generate_custom_id(...args: Args): string {
107107
assert(
108-
args.length === this.parameter_types.length,
109-
`Expected ${this.parameter_types.length} arguments, got ${args.length} for modal ${this.base_custom_id}`,
108+
args.length === this.metadata_fields.length,
109+
`Expected ${this.metadata_fields.length} arguments, got ${args.length} for modal ${this.base_custom_id}`,
110110
);
111111

112112
const serialized_args = args.map((arg, index) => {
113-
const type = this.parameter_types[index];
113+
const type = this.metadata_fields[index];
114114
try {
115115
if (type === "string" || type === "user_id") {
116116
return String(arg);
@@ -210,7 +210,7 @@ export class ModalInteractionBuilder<
210210
Args extends unknown[] = [],
211211
HasHandler extends boolean = false,
212212
> extends BaseBuilder<HasHandler, [Discord.ModalSubmitInteraction, ...Args]> {
213-
private readonly parameter_types: ModalParameterType[] = [];
213+
private readonly metadata_fields: ModalParameterType[] = [];
214214
private permissions?: bigint;
215215
private title = "Modal";
216216
private readonly field_configs: ModalField[] = [];
@@ -224,23 +224,23 @@ export class ModalInteractionBuilder<
224224
return this;
225225
}
226226

227-
add_string_parameter(): ModalInteractionBuilder<[...Args, string], HasHandler> {
228-
this.parameter_types.push("string");
227+
add_string_metadata(): ModalInteractionBuilder<[...Args, string], HasHandler> {
228+
this.metadata_fields.push("string");
229229
return this as unknown as ModalInteractionBuilder<[...Args, string], HasHandler>;
230230
}
231231

232-
add_number_parameter(): ModalInteractionBuilder<[...Args, number], HasHandler> {
233-
this.parameter_types.push("number");
232+
add_number_metadata(): ModalInteractionBuilder<[...Args, number], HasHandler> {
233+
this.metadata_fields.push("number");
234234
return this as unknown as ModalInteractionBuilder<[...Args, number], HasHandler>;
235235
}
236236

237-
add_boolean_parameter(): ModalInteractionBuilder<[...Args, boolean], HasHandler> {
238-
this.parameter_types.push("boolean");
237+
add_boolean_metadata(): ModalInteractionBuilder<[...Args, boolean], HasHandler> {
238+
this.metadata_fields.push("boolean");
239239
return this as unknown as ModalInteractionBuilder<[...Args, boolean], HasHandler>;
240240
}
241241

242-
add_user_id_parameter(): ModalInteractionBuilder<[...Args, string], HasHandler> {
243-
this.parameter_types.push("user_id");
242+
add_user_id_metadata(): ModalInteractionBuilder<[...Args, string], HasHandler> {
243+
this.metadata_fields.push("user_id");
244244
return this as unknown as ModalInteractionBuilder<[...Args, string], HasHandler>;
245245
}
246246

@@ -296,12 +296,12 @@ export class ModalInteractionBuilder<
296296
this.base_custom_id,
297297
this.handler,
298298
this.permissions,
299-
this.parameter_types,
299+
this.metadata_fields,
300300
this.field_configs,
301301
) as ConditionalOptional<HasHandler, BotModalHandler<Args>>;
302302
}
303303

304304
build_modal(): BotModal<Args> {
305-
return new BotModal(this.base_custom_id, this.title, this.parameter_types, this.field_configs);
305+
return new BotModal(this.base_custom_id, this.title, this.metadata_fields, this.field_configs);
306306
}
307307
}

‎src/components/moderation/modlogs.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ export default class Modlogs extends BotComponent {
5555
// Register button handler for modlogs pagination
5656
this.modlogs_page_button = commands.add(
5757
new ButtonInteractionBuilder("modlogs_page")
58-
.add_user_id_parameter() // user_id: string
59-
.add_number_parameter() // page: number
58+
.add_user_id_metadata() // user_id: string
59+
.add_number_metadata() // page: number
6060
.set_permissions(Discord.PermissionFlagsBits.BanMembers)
6161
.set_handler(this.handle_modlogs_page.bind(this)),
6262
);

‎src/components/moderation/purge.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ export default class Purge extends BotComponent {
144144

145145
this.abort_purge_button = commands.add(
146146
new ButtonInteractionBuilder("abort_purge")
147-
.add_string_parameter()
147+
.add_string_metadata()
148148
.set_permissions(Discord.PermissionFlagsBits.ManageMessages)
149149
.set_handler(this.abort_purge_handler.bind(this)),
150150
);

‎src/components/report.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export default class Report extends BotComponent {
3232
this.report_modal = commands.add(
3333
new ModalInteractionBuilder("report-modal")
3434
.set_title("Report Message")
35-
.add_string_parameter()
35+
.add_string_metadata()
3636
.add_paragraph_field("report-modal-message", "Message", {
3737
placeholder: "Optional message / additional info",
3838
required: false,

0 commit comments

Comments
 (0)