Skip to content

fix(GuildAuditLogsEntry): correct mapped AuditLogChange objects #10438

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 20, 2024
Merged

fix(GuildAuditLogsEntry): correct mapped AuditLogChange objects #10438

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1578bf8
refactor(GuildAuditLogsEntry): correct mapped AuditLogChange objects
Renegade334 Aug 8, 2024
abd67be
test: check union narrowing behaviour of AuditLogChange
Renegade334 Aug 8, 2024
1d9ebb7
Merge branch 'main' into auditlogchange-correct-mapped-objects
kodiakhq[bot] Aug 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion packages/discord.js/src/structures/GuildAuditLogsEntry.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,11 @@ class GuildAuditLogsEntry {
* @type {AuditLogChange[]}
*/
this.changes =
data.changes?.map(change => ({ key: change.key, old: change.old_value, new: change.new_value })) ?? [];
data.changes?.map(change => ({
key: change.key,
...('old_value' in change ? { old: change.old_value } : {}),
...('new_value' in change ? { new: change.new_value } : {}),
})) ?? [];

/**
* The entry's id
Expand Down
12 changes: 7 additions & 5 deletions packages/discord.js/typings/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4991,11 +4991,13 @@ export interface ApplicationRoleConnectionMetadataEditOptions {
type: ApplicationRoleConnectionMetadataType;
}

export interface AuditLogChange {
key: APIAuditLogChange['key'];
old?: APIAuditLogChange['old_value'];
new?: APIAuditLogChange['new_value'];
}
export type AuditLogChange = {
[SourceElement in APIAuditLogChange as SourceElement['key']]: {
key: SourceElement['key'];
old?: SourceElement['old_value'];
new?: SourceElement['new_value'];
};
}[APIAuditLogChange['key']];

export interface AutoModerationAction {
type: AutoModerationActionType;
Expand Down
11 changes: 11 additions & 0 deletions packages/discord.js/typings/index.test-d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@ import {
Collector,
GuildAuditLogsEntry,
GuildAuditLogs,
type AuditLogChange,
StageInstance,
ActionRowBuilder,
ButtonComponent,
Expand Down Expand Up @@ -2171,6 +2172,16 @@ expectType<Promise<User | undefined>>(
guild.fetchAuditLogs({ type: AuditLogEvent.MessageDelete }).then(al => al.entries.first()?.target),
);

declare const AuditLogChange: AuditLogChange;
// @ts-expect-error
expectType<boolean | undefined>(AuditLogChange.old);
// @ts-expect-error
expectType<boolean | undefined>(AuditLogChange.new);
if (AuditLogChange.key === 'available') {
expectType<boolean | undefined>(AuditLogChange.old);
expectType<boolean | undefined>(AuditLogChange.new);
}

declare const TextBasedChannel: TextBasedChannel;
declare const TextBasedChannelTypes: TextBasedChannelTypes;
declare const VoiceBasedChannel: VoiceBasedChannel;
Expand Down