Summaries — FiveCord

index.tsx

Download

Source

src/plugins/seeSummaries/index.tsx

1import * as DataStore from "@api/DataStore";

2import { definePluginSettings } from "@api/Settings";

3import { Devs } from "@utils/constants";

4import { hasGuildFeature } from "@utils/discord";

5import definePlugin, { OptionType } from "@utils/types";

6import { findByPropsLazy } from "@webpack";

7import { ChannelStore, GuildStore } from "@webpack/common";

9const SummaryStore = findByPropsLazy("allSummaries", "findSummary");

11const settings = definePluginSettings({

12 summaryExpiryThresholdDays: {

13 type: OptionType.SLIDER,

        description: "The time in days before a summary is removed. Note that only up to 50 summaries are kept per channel",

15 markers: [1, 3, 5, 7, 10, 15, 20, 25, 30],

16 stickToMarkers: false,

17 default: 3,

18 }

19});

21interface Summary {

22 count: number;

23 end_id: string;

24 id: string;

25 message_ids: string[];

26 people: string[];

27 source: number;

28 start_id: string;

29 summ_short: string;

30 topic: string;

31 type: number;

32 unsafe: boolean;

33}

35interface ChannelSummary {

36 type: string;

37 channel_id: string;

38 guild_id: string;

39 summaries: Summary[];

41 // custom property

42 time?: number;

43}

44// TODO: these types are wrong and evil and incorrect

45function createChannelSummaryFromServer(s: Summary, channelId: string): ChannelSummary {

46 return {

47 id: s.id,

48 topic: s.topic,

49 summShort: s.summ_short,

50 people: Array.from(new Set(s.people)),

51 startId: s.start_id,

52 endId: s.end_id,

53 count: s.count,

54 channelId,

55 source: s.source,

56 type: s.type as any,

57 } as any as ChannelSummary;

58}

60export default definePlugin({

61 name: "Summaries",

    description: "Enables Discord&#039;s experimental Summaries feature on every server, displaying AI generated summaries of conversations",

63 tags: ["Chat", "Fun"],

64 authors: [Devs.mantikafasi],

65 settings,

66 patches: [

67 {

68 find: "SUMMARIZEABLE.has",

69 replacement: {

70 match: /\i\.features\.has$\i\.\i\.SUMMARIES_ENABLED\w+?$/g,

71 replace: "true"

72 }

73 },

74 {

75 find: "RECEIVE_CHANNEL_SUMMARY(",

76 replacement: {

77 match: /shouldFetch$(\i),\i${/,

78 replace: "$& if(!$self.shouldFetch($1)) return false;"

79 }

80 }

81 ],

83 flux: {

84 CONVERSATION_SUMMARY_UPDATE(data) {

85 const incomingSummaries: ChannelSummary[] = data.summaries.map((summary: any) => ({

86 ...createChannelSummaryFromServer(summary, undefined!),

87 time: Date.now()

88 }));

90 // idk if this is good for performance but it doesnt seem to be a problem in my experience

91 DataStore.update("summaries-data", summaries => {

92 summaries ??= {};

                summaries[data.channel_id] ? summaries[data.channel_id].unshift(...incomingSummaries) : (summaries[data.channel_id] = incomingSummaries);

94 if (summaries[data.channel_id].length > 50)

95 summaries[data.channel_id] = summaries[data.channel_id].slice(0, 50);

97 return summaries;

98 });

99 }

100 },

101

102 async start() {

103 await DataStore.update("summaries-data", summaries => {

104 summaries ??= {};

105 for (const key of Object.keys(summaries)) {

106 for (let i = summaries[key].length - 1; i >= 0; i--) {

107

                    if (summaries[key][i].time < Date.now() - 1000 * 60 * 60 * 24 * settings.store.summaryExpiryThresholdDays) {

108 summaries[key].splice(i, 1);

109 }

110 }

111

112 if (summaries[key].length === 0) {

113 delete summaries[key];

114 }

115 }

116

117 Object.assign(SummaryStore.allSummaries(), summaries);

118 return summaries;

119 });

120 },

121

122 shouldFetch(channelId: string) {

123 const channel = ChannelStore.getChannel(channelId);

124 // SUMMARIES_ENABLED feature is not in discord-types

125 const guild = GuildStore.getGuild(channel.guild_id);

126

127 return hasGuildFeature(guild, "SUMMARIES_ENABLED_GA");

128 }

129});

130

import * as DataStore from "@api/DataStore";
import { definePluginSettings } from "@api/Settings";
import { Devs } from "@utils/constants";
import { hasGuildFeature } from "@utils/discord";
import definePlugin, { OptionType } from "@utils/types";
import { findByPropsLazy } from "@webpack";
import { ChannelStore, GuildStore } from "@webpack/common";

const SummaryStore = findByPropsLazy("allSummaries", "findSummary");

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 ChannelSummary {
    type: string;
    channel_id: string;
    guild_id: string;
    summaries: Summary[];

    // custom property
    time?: number;
}
// TODO: these types are wrong and evil and incorrect
function createChannelSummaryFromServer(s: Summary, channelId: string): ChannelSummary {
    return {
        id: s.id,
        topic: s.topic,
        summShort: s.summ_short,
        people: Array.from(new Set(s.people)),
        startId: s.start_id,
        endId: s.end_id,
        count: s.count,
        channelId,
        source: s.source,
        type: s.type as any,
    } as any as ChannelSummary;
}

export default definePlugin({
    name: "Summaries",
    description: "Enables Discord's experimental Summaries feature on every server, displaying AI generated summaries of conversations",
    tags: ["Chat", "Fun"],
    authors: [Devs.mantikafasi],
    settings,
    patches: [
        {
            find: "SUMMARIZEABLE.has",
            replacement: {
                match: /\i\.features\.has\(\i\.\i\.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: ChannelSummary[] = data.summaries.map((summary: any) => ({
                ...createChannelSummaryFromServer(summary, undefined!),
                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 => {
            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);

        return hasGuildFeature(guild, "SUMMARIES_ENABLED_GA");
    }
});

Source

FiveCord for Windows