new plugin Summaries: show Discords AI-generated convo summaries (#2481)
Co-authored-by: Vendicated <vendicated@riseup.net>
This commit is contained in:
parent
a8e18f17e2
commit
4f2c2b8e4a
3 changed files with 122 additions and 1 deletions
7
src/plugins/seeSummaries/README.md
Normal file
7
src/plugins/seeSummaries/README.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
# Summaries
|
||||||
|
|
||||||
|
Enables Discord's experimental Summaries feature on every server, displaying AI generated summaries of conversations.
|
||||||
|
|
||||||
|
Note that this plugin can't fetch old summaries, it can only display ones created while your Discord is running with the plugin enabled.
|
||||||
|
|
||||||
|
![](https://github.com/Vendicated/Vencord/assets/45497981/bd931b0c-2e85-4c10-9f7c-8ba01eb55745)
|
114
src/plugins/seeSummaries/index.tsx
Normal file
114
src/plugins/seeSummaries/index.tsx
Normal file
|
@ -0,0 +1,114 @@
|
||||||
|
/*
|
||||||
|
* Vencord, a Discord client mod
|
||||||
|
* Copyright (c) 2024 Vendicated and contributors
|
||||||
|
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { DataStore } from "@api/index";
|
||||||
|
import { definePluginSettings } from "@api/Settings";
|
||||||
|
import { Devs } from "@utils/constants";
|
||||||
|
import definePlugin, { OptionType } from "@utils/types";
|
||||||
|
import { findByPropsLazy } from "@webpack";
|
||||||
|
import { ChannelStore, GuildStore } from "@webpack/common";
|
||||||
|
|
||||||
|
const SummaryStore = findByPropsLazy("allSummaries", "findSummary");
|
||||||
|
const { createSummaryFromServer } = findByPropsLazy("createSummaryFromServer");
|
||||||
|
|
||||||
|
const settings = definePluginSettings({
|
||||||
|
summaryExpiryThresholdDays: {
|
||||||
|
type: OptionType.SLIDER,
|
||||||
|
description: "The time in days before a summary is removed. Note that only up to 50 summaries are kept per channel",
|
||||||
|
markers: [1, 3, 5, 7, 10, 15, 20, 25, 30],
|
||||||
|
stickToMarkers: false,
|
||||||
|
default: 3,
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
interface Summary {
|
||||||
|
count: number;
|
||||||
|
end_id: string;
|
||||||
|
id: string;
|
||||||
|
message_ids: string[];
|
||||||
|
people: string[];
|
||||||
|
source: number;
|
||||||
|
start_id: string;
|
||||||
|
summ_short: string;
|
||||||
|
topic: string;
|
||||||
|
type: number;
|
||||||
|
unsafe: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ChannelSummaries {
|
||||||
|
type: string;
|
||||||
|
channel_id: string;
|
||||||
|
guild_id: string;
|
||||||
|
summaries: Summary[];
|
||||||
|
|
||||||
|
// custom property
|
||||||
|
time?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export default definePlugin({
|
||||||
|
name: "Summaries",
|
||||||
|
description: "Enables Discord's experimental Summaries feature on every server, displaying AI generated summaries of conversations",
|
||||||
|
authors: [Devs.mantikafasi],
|
||||||
|
settings,
|
||||||
|
patches: [
|
||||||
|
{
|
||||||
|
find: "ChannelTypesSets.SUMMARIZEABLE.has",
|
||||||
|
replacement: {
|
||||||
|
match: /\i\.hasFeature\(\i\.GuildFeatures\.SUMMARIES_ENABLED\w+?\)/g,
|
||||||
|
replace: "true"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
find: "RECEIVE_CHANNEL_SUMMARY(",
|
||||||
|
replacement: {
|
||||||
|
match: /shouldFetch\((\i),\i\){/,
|
||||||
|
replace: "$& if(!$self.shouldFetch($1)) return false;"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
flux: {
|
||||||
|
CONVERSATION_SUMMARY_UPDATE(data) {
|
||||||
|
const incomingSummaries: ChannelSummaries[] = data.summaries.map((summary: any) => ({ ...createSummaryFromServer(summary), time: Date.now() }));
|
||||||
|
|
||||||
|
// idk if this is good for performance but it doesnt seem to be a problem in my experience
|
||||||
|
DataStore.update("summaries-data", summaries => {
|
||||||
|
summaries ??= {};
|
||||||
|
summaries[data.channel_id] ? summaries[data.channel_id].unshift(...incomingSummaries) : (summaries[data.channel_id] = incomingSummaries);
|
||||||
|
if (summaries[data.channel_id].length > 50)
|
||||||
|
summaries[data.channel_id] = summaries[data.channel_id].slice(0, 50);
|
||||||
|
|
||||||
|
return summaries;
|
||||||
|
});
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
async start() {
|
||||||
|
await DataStore.update("summaries-data", summaries => {
|
||||||
|
for (const key of Object.keys(summaries)) {
|
||||||
|
for (let i = summaries[key].length - 1; i >= 0; i--) {
|
||||||
|
if (summaries[key][i].time < Date.now() - 1000 * 60 * 60 * 24 * settings.store.summaryExpiryThresholdDays) {
|
||||||
|
summaries[key].splice(i, 1);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (summaries[key].length === 0) {
|
||||||
|
delete summaries[key];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Object.assign(SummaryStore.allSummaries(), summaries);
|
||||||
|
return summaries;
|
||||||
|
});
|
||||||
|
},
|
||||||
|
|
||||||
|
shouldFetch(channelId: string) {
|
||||||
|
const channel = ChannelStore.getChannel(channelId);
|
||||||
|
// SUMMARIES_ENABLED feature is not in discord-types
|
||||||
|
const guild = GuildStore.getGuild(channel.guild_id);
|
||||||
|
// @ts-ignore
|
||||||
|
return guild.hasFeature("SUMMARIES_ENABLED_GA");
|
||||||
|
}
|
||||||
|
});
|
2
src/webpack/common/types/fluxEvents.d.ts
vendored
2
src/webpack/common/types/fluxEvents.d.ts
vendored
File diff suppressed because one or more lines are too long
Loading…
Reference in a new issue