@vencord/types 0.1.2 → 1.8.4

package/Vencord.d.ts

@@ -1,28 +1,28 @@
-/*!
- * Vencord, a modification for Discord's desktop app
- * Copyright (c) 2022 Vendicated and contributors
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <https://www.gnu.org/licenses/>.
-*/
-export * as Api from "./api";
-export * as Plugins from "./plugins";
-export * as Util from "./utils";
-export * as QuickCss from "./utils/quickCss";
-export * as Updater from "./utils/updater";
-export * as Webpack from "./webpack";
-export { PlainSettings, Settings };
-import "./utils/quickCss";
-import "./webpack/patchWebpack";
-import { PlainSettings, Settings } from "./api/settings";
-export declare let Components: any;
+/*!
+ * Vencord, a modification for Discord's desktop app
+ * Copyright (c) 2022 Vendicated and contributors
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+*/
+export * as Api from "./api";
+export * as Components from "./components";
+export * as Plugins from "./plugins";
+export * as Util from "./utils";
+export * as QuickCss from "./utils/quickCss";
+export * as Updater from "./utils/updater";
+export * as Webpack from "./webpack";
+export { PlainSettings, Settings };
+import "./utils/quickCss";
+import "./webpack/patchWebpack";
+import { PlainSettings, Settings } from "./api/Settings";

package/VencordNative.d.ts

@@ -1,14 +1,42 @@
-/// <reference types="standalone-electron-types" />
-/// <reference types="node" />
-import { IpcRenderer } from "electron";
-declare const _default: {
-    getVersions: () => NodeJS.ProcessVersions;
-    ipc: {
-        send(event: string, ...args: any[]): void;
-        sendSync<T = any>(event: string, ...args: any[]): T;
-        on(event: string, listener: Parameters<IpcRenderer["on"]>[1]): void;
-        off(event: string, listener: Parameters<IpcRenderer["off"]>[1]): void;
-        invoke<T_1 = any>(event: string, ...args: any[]): Promise<T_1>;
-    };
-};
-export default _default;
+/// <reference types="standalone-electron-types" />
+/// <reference types="node" />
+import type { UserThemeHeader } from "./main/themes";
+import { IpcEvents } from "./shared/IpcEvents";
+import { IpcRes } from "./utils/types";
+import type { Settings } from "api/Settings";
+export declare function sendSync<T = any>(event: IpcEvents, ...args: any[]): T;
+declare const _default: {
+    themes: {
+        uploadTheme: (fileName: string, fileData: string) => Promise<void>;
+        deleteTheme: (fileName: string) => Promise<void>;
+        getThemesDir: () => Promise<string>;
+        getThemesList: () => Promise<UserThemeHeader[]>;
+        getThemeData: (fileName: string) => Promise<string | undefined>;
+        getSystemValues: () => Promise<Record<string, string>>;
+    };
+    updater: {
+        getUpdates: () => Promise<IpcRes<Record<"author" | "message" | "hash", string>[]>>;
+        update: () => Promise<IpcRes<boolean>>;
+        rebuild: () => Promise<IpcRes<boolean>>;
+        getRepo: () => Promise<IpcRes<string>>;
+    };
+    settings: {
+        get: () => Settings;
+        set: (settings: Settings, pathToNotify?: string) => Promise<void>;
+        getSettingsDir: () => Promise<string>;
+    };
+    quickCss: {
+        get: () => Promise<string>;
+        set: (css: string) => Promise<void>;
+        addChangeListener(cb: (newCss: string) => void): void;
+        addThemeChangeListener(cb: () => void): void;
+        openFile: () => Promise<void>;
+        openEditor: () => Promise<void>;
+    };
+    native: {
+        getVersions: () => Partial<NodeJS.ProcessVersions>;
+        openExternal: (url: string) => Promise<void>;
+    };
+    pluginHelpers: Record<string, Record<string, (...args: any[]) => Promise<any>>>;
+};
+export default _default;

package/api/Badges.d.ts

@@ -1,62 +1,44 @@
-import { User } from "discord-types/general";
-import { ComponentType, HTMLProps } from "react";
-export declare enum BadgePosition {
-    START = 0,
-    END = 1
-}
-export interface ProfileBadge {
-    /** The tooltip to show on hover. Required for image badges */
-    description?: string;
-    /** Custom component for the badge (tooltip not included) */
-    component?: ComponentType<ProfileBadge & BadgeUserArgs>;
-    /** The custom image to use */
-    image?: string;
-    link?: string;
-    /** Action to perform when you click the badge */
-    onClick?(): void;
-    /** Should the user display this badge? */
-    shouldShow?(userInfo: BadgeUserArgs): boolean;
-    /** Optional props (e.g. style) for the badge, ignored for component badges */
-    props?: HTMLProps<HTMLImageElement>;
-    /** Insert at start or end? */
-    position?: BadgePosition;
-    /** The badge name to display, Discord uses this. Required for component badges */
-    key?: string;
-}
-/**
- * Register a new badge with the Badges API
- * @param badge The badge to register
- */
-export declare function addBadge(badge: ProfileBadge): void;
-/**
- * Unregister a badge from the Badges API
- * @param badge The badge to remove
- */
-export declare function removeBadge(badge: ProfileBadge): boolean;
-/**
- * Inject badges into the profile badges array.
- * You probably don't need to use this.
- */
-export declare function _getBadges(args: BadgeUserArgs): ProfileBadge[];
-export interface BadgeUserArgs {
-    user: User;
-    profile: Profile;
-    premiumSince: Date;
-    premiumGuildSince?: Date;
-}
-interface ConnectedAccount {
-    type: string;
-    id: string;
-    name: string;
-    verified: boolean;
-}
-interface Profile {
-    connectedAccounts: ConnectedAccount[];
-    premiumType: number;
-    premiumSince: string;
-    premiumGuildSince?: any;
-    lastFetched: number;
-    profileFetchFailed: boolean;
-    application?: any;
-}
-export {};
+import { User } from "discord-types/general";
+import { ComponentType, HTMLProps } from "react";
+export declare const enum BadgePosition {
+    START = 0,
+    END = 1
+}
+export interface ProfileBadge {
+    /** The tooltip to show on hover. Required for image badges */
+    description?: string;
+    /** Custom component for the badge (tooltip not included) */
+    component?: ComponentType<ProfileBadge & BadgeUserArgs>;
+    /** The custom image to use */
+    image?: string;
+    link?: string;
+    /** Action to perform when you click the badge */
+    onClick?(event: React.MouseEvent<HTMLButtonElement, MouseEvent>, props: BadgeUserArgs): void;
+    /** Should the user display this badge? */
+    shouldShow?(userInfo: BadgeUserArgs): boolean;
+    /** Optional props (e.g. style) for the badge, ignored for component badges */
+    props?: HTMLProps<HTMLImageElement>;
+    /** Insert at start or end? */
+    position?: BadgePosition;
+    /** The badge name to display, Discord uses this. Required for component badges */
+    key?: string;
+}
+/**
+ * Register a new badge with the Badges API
+ * @param badge The badge to register
+ */
+export declare function addBadge(badge: ProfileBadge): void;
+/**
+ * Unregister a badge from the Badges API
+ * @param badge The badge to remove
+ */
+export declare function removeBadge(badge: ProfileBadge): boolean;
+/**
+ * Inject badges into the profile badges array.
+ * You probably don't need to use this.
+ */
+export declare function _getBadges(args: BadgeUserArgs): ProfileBadge[];
+export interface BadgeUserArgs {
+    user: User;
+    guildId: string;
+}

package/api/ChatButtons.d.ts

@@ -0,0 +1,74 @@
+import "./ChatButton.css";
+import { Channel } from "discord-types/general";
+import { HTMLProps, MouseEventHandler, ReactNode } from "react";
+export interface ChatBarProps {
+    channel: Channel;
+    disabled: boolean;
+    isEmpty: boolean;
+    type: {
+        analyticsName: string;
+        attachments: boolean;
+        autocomplete: {
+            addReactionShortcut: boolean;
+            forceChatLayer: boolean;
+            reactions: boolean;
+        };
+        commands: {
+            enabled: boolean;
+        };
+        drafts: {
+            type: number;
+            commandType: number;
+            autoSave: boolean;
+        };
+        emojis: {
+            button: boolean;
+        };
+        gifs: {
+            button: boolean;
+            allowSending: boolean;
+        };
+        gifts: {
+            button: boolean;
+        };
+        permissions: {
+            requireSendMessages: boolean;
+        };
+        showThreadPromptOnReply: boolean;
+        stickers: {
+            button: boolean;
+            allowSending: boolean;
+            autoSuggest: boolean;
+        };
+        users: {
+            allowMentioning: boolean;
+        };
+        submit: {
+            button: boolean;
+            ignorePreference: boolean;
+            disableEnterToSubmit: boolean;
+            clearOnSubmit: boolean;
+            useDisabledStylesOnSubmit: boolean;
+        };
+        uploadLongMessages: boolean;
+        upsellLongMessages: {
+            iconOnly: boolean;
+        };
+        showCharacterCount: boolean;
+        sedReplace: boolean;
+    };
+}
+export type ChatBarButton = (props: ChatBarProps & {
+    isMainChat: boolean;
+}) => JSX.Element | null;
+export declare function _injectButtons(buttons: ReactNode[], props: ChatBarProps): void;
+export declare const addChatBarButton: (id: string, button: ChatBarButton) => Map<string, ChatBarButton>;
+export declare const removeChatBarButton: (id: string) => boolean;
+export interface ChatBarButtonProps {
+    children: ReactNode;
+    tooltip: string;
+    onClick: MouseEventHandler<HTMLButtonElement>;
+    onContextMenu?: MouseEventHandler<HTMLButtonElement>;
+    buttonProps?: Omit<HTMLProps<HTMLButtonElement>, "size" | "onClick" | "onContextMenu">;
+}
+export declare const ChatBarButton: import("react").FunctionComponent<ChatBarButtonProps>;

package/api/Commands/commandHelpers.d.ts

@@ -1,20 +1,20 @@
-import { Message } from "discord-types/general";
-import type { PartialDeep } from "type-fest";
-import { Argument } from "./types";
-export declare function generateId(): string;
-/**
- * Send a message as Clyde
- * @param {string} channelId ID of channel to send message to
- * @param {Message} message Message to send
- * @returns {Message}
- */
-export declare function sendBotMessage(channelId: string, message: PartialDeep<Message>): Message;
-/**
- * Get the value of an option by name
- * @param args Arguments array (first argument passed to execute)
- * @param name Name of the argument
- * @param fallbackValue Fallback value in case this option wasn't passed
- * @returns Value
- */
-export declare function findOption<T>(args: Argument[], name: string): T & {} | undefined;
-export declare function findOption<T>(args: Argument[], name: string, fallbackValue: T): T & {};
+import { Message } from "discord-types/general";
+import type { PartialDeep } from "type-fest";
+import { Argument } from "./types";
+export declare function generateId(): string;
+/**
+ * Send a message as Clyde
+ * @param {string} channelId ID of channel to send message to
+ * @param {Message} message Message to send
+ * @returns {Message}
+ */
+export declare function sendBotMessage(channelId: string, message: PartialDeep<Message>): Message;
+/**
+ * Get the value of an option by name
+ * @param args Arguments array (first argument passed to execute)
+ * @param name Name of the argument
+ * @param fallbackValue Fallback value in case this option wasn't passed
+ * @returns Value
+ */
+export declare function findOption<T>(args: Argument[], name: string): T & {} | undefined;
+export declare function findOption<T>(args: Argument[], name: string, fallbackValue: T): T & {};

package/api/Commands/index.d.ts

@@ -1,26 +1,26 @@
-import { Command, Option } from "./types";
-export * from "./commandHelpers";
-export * from "./types";
-export declare let BUILT_IN: Command[];
-export declare const commands: Record<string, Command>;
-/**
- * Optional message option named "message" you can use in commands.
- * Used in "tableflip" or "shrug"
- * @see {@link RequiredMessageOption}
- */
-export declare let OptionalMessageOption: Option;
-/**
- * Required message option named "message" you can use in commands.
- * Used in "me"
- * @see {@link OptionalMessageOption}
- */
-export declare let RequiredMessageOption: Option;
-export declare const _init: never;
-export declare const _handleCommand: never;
-/**
- * Prepare a Command Option for Discord by filling missing fields
- * @param opt
- */
-export declare function prepareOption<O extends Option | Command>(opt: O): O;
-export declare function registerCommand<C extends Command>(command: C, plugin: string): void;
-export declare function unregisterCommand(name: string): boolean;
+import { Command, Option } from "./types";
+export * from "./commandHelpers";
+export * from "./types";
+export declare let BUILT_IN: Command[];
+export declare const commands: Record<string, Command>;
+/**
+ * Optional message option named "message" you can use in commands.
+ * Used in "tableflip" or "shrug"
+ * @see {@link RequiredMessageOption}
+ */
+export declare let OptionalMessageOption: Option;
+/**
+ * Required message option named "message" you can use in commands.
+ * Used in "me"
+ * @see {@link OptionalMessageOption}
+ */
+export declare let RequiredMessageOption: Option;
+export declare const _init: never;
+export declare const _handleCommand: never;
+/**
+ * Prepare a Command Option for Discord by filling missing fields
+ * @param opt
+ */
+export declare function prepareOption<O extends Option | Command>(opt: O): O;
+export declare function registerCommand<C extends Command>(command: C, plugin: string): void;
+export declare function unregisterCommand(name: string): boolean;

package/api/Commands/types.d.ts

@@ -1,74 +1,74 @@
-import { Channel, Guild } from "discord-types/general";
-import { Promisable } from "type-fest";
-export interface CommandContext {
-    channel: Channel;
-    guild?: Guild;
-}
-export declare enum ApplicationCommandOptionType {
-    SUB_COMMAND = 1,
-    SUB_COMMAND_GROUP = 2,
-    STRING = 3,
-    INTEGER = 4,
-    BOOLEAN = 5,
-    USER = 6,
-    CHANNEL = 7,
-    ROLE = 8,
-    MENTIONABLE = 9,
-    NUMBER = 10,
-    ATTACHMENT = 11
-}
-export declare enum ApplicationCommandInputType {
-    BUILT_IN = 0,
-    BUILT_IN_TEXT = 1,
-    BUILT_IN_INTEGRATION = 2,
-    BOT = 3,
-    PLACEHOLDER = 4
-}
-export interface Option {
-    name: string;
-    displayName?: string;
-    type: ApplicationCommandOptionType;
-    description: string;
-    displayDescription?: string;
-    required?: boolean;
-    options?: Option[];
-    choices?: Array<ChoicesOption>;
-}
-export interface ChoicesOption {
-    label: string;
-    value: string;
-    name: string;
-    displayName?: string;
-}
-export declare enum ApplicationCommandType {
-    CHAT_INPUT = 1,
-    USER = 2,
-    MESSAGE = 3
-}
-export interface CommandReturnValue {
-    content: string;
-    /** TODO: implement */
-    cancel?: boolean;
-}
-export interface Argument {
-    type: ApplicationCommandOptionType;
-    name: string;
-    value: string;
-    focused: undefined;
-    options: Argument[];
-}
-export interface Command {
-    id?: string;
-    applicationId?: string;
-    type?: ApplicationCommandType;
-    inputType?: ApplicationCommandInputType;
-    plugin?: string;
-    isVencordCommand?: boolean;
-    name: string;
-    displayName?: string;
-    description: string;
-    displayDescription?: string;
-    options?: Option[];
-    predicate?(ctx: CommandContext): boolean;
-    execute(args: Argument[], ctx: CommandContext): Promisable<void | CommandReturnValue>;
-}
+import { Channel, Guild } from "discord-types/general";
+import { Promisable } from "type-fest";
+export interface CommandContext {
+    channel: Channel;
+    guild?: Guild;
+}
+export declare const enum ApplicationCommandOptionType {
+    SUB_COMMAND = 1,
+    SUB_COMMAND_GROUP = 2,
+    STRING = 3,
+    INTEGER = 4,
+    BOOLEAN = 5,
+    USER = 6,
+    CHANNEL = 7,
+    ROLE = 8,
+    MENTIONABLE = 9,
+    NUMBER = 10,
+    ATTACHMENT = 11
+}
+export declare const enum ApplicationCommandInputType {
+    BUILT_IN = 0,
+    BUILT_IN_TEXT = 1,
+    BUILT_IN_INTEGRATION = 2,
+    BOT = 3,
+    PLACEHOLDER = 4
+}
+export interface Option {
+    name: string;
+    displayName?: string;
+    type: ApplicationCommandOptionType;
+    description: string;
+    displayDescription?: string;
+    required?: boolean;
+    options?: Option[];
+    choices?: Array<ChoicesOption>;
+}
+export interface ChoicesOption {
+    label: string;
+    value: string;
+    name: string;
+    displayName?: string;
+}
+export declare const enum ApplicationCommandType {
+    CHAT_INPUT = 1,
+    USER = 2,
+    MESSAGE = 3
+}
+export interface CommandReturnValue {
+    content: string;
+    /** TODO: implement */
+    cancel?: boolean;
+}
+export interface Argument {
+    type: ApplicationCommandOptionType;
+    name: string;
+    value: string;
+    focused: undefined;
+    options: Argument[];
+}
+export interface Command {
+    id?: string;
+    applicationId?: string;
+    type?: ApplicationCommandType;
+    inputType?: ApplicationCommandInputType;
+    plugin?: string;
+    isVencordCommand?: boolean;
+    name: string;
+    displayName?: string;
+    description: string;
+    displayDescription?: string;
+    options?: Option[];
+    predicate?(ctx: CommandContext): boolean;
+    execute(args: Argument[], ctx: CommandContext): Promisable<void | CommandReturnValue>;
+}

package/api/ContextMenu.d.ts

@@ -1,57 +1,54 @@
-import type { ReactElement } from "react";
-type ContextMenuPatchCallbackReturn = (() => void) | void;
-/**
- * @param children The rendered context menu elements
- * @param args Any arguments passed into making the context menu, like the guild, channel, user or message for example
- * @returns A callback which is only ran once used to modify the context menu elements (Use to avoid duplicates)
- */
-export type NavContextMenuPatchCallback = (children: Array<React.ReactElement>, ...args: Array<any>) => ContextMenuPatchCallbackReturn;
-/**
- * @param navId The navId of the context menu being patched
- * @param children The rendered context menu elements
- * @param args Any arguments passed into making the context menu, like the guild, channel, user or message for example
- * @returns A callback which is only ran once used to modify the context menu elements (Use to avoid duplicates)
- */
-export type GlobalContextMenuPatchCallback = (navId: string, children: Array<React.ReactElement>, ...args: Array<any>) => ContextMenuPatchCallbackReturn;
-export declare const navPatches: Map<string, Set<NavContextMenuPatchCallback>>;
-export declare const globalPatches: Set<GlobalContextMenuPatchCallback>;
-/**
- * Add a context menu patch
- * @param navId The navId(s) for the context menu(s) to patch
- * @param patch The patch to be applied
- */
-export declare function addContextMenuPatch(navId: string | Array<string>, patch: NavContextMenuPatchCallback): void;
-/**
- * Add a global context menu patch that fires the patch for all context menus
- * @param patch The patch to be applied
- */
-export declare function addGlobalContextMenuPatch(patch: GlobalContextMenuPatchCallback): void;
-/**
- * Remove a context menu patch
- * @param navId The navId(s) for the context menu(s) to remove the patch
- * @param patch The patch to be removed
- * @returns Wheter the patch was sucessfully removed from the context menu(s)
- */
-export declare function removeContextMenuPatch<T extends string | Array<string>>(navId: T, patch: NavContextMenuPatchCallback): T extends string ? boolean : Array<boolean>;
-/**
- * Remove a global context menu patch
- * @param patch The patch to be removed
- * @returns Wheter the patch was sucessfully removed
- */
-export declare function removeGlobalContextMenuPatch(patch: GlobalContextMenuPatchCallback): boolean;
-/**
- * A helper function for finding the children array of a group nested inside a context menu based on the id of one of its childs
- * @param id The id of the child
- * @param children The context menu children
- */
-export declare function findGroupChildrenByChildId(id: string, children: Array<React.ReactElement>, _itemsArray?: Array<React.ReactElement>): Array<React.ReactElement> | null;
-interface ContextMenuProps {
-    contextMenuApiArguments?: Array<any>;
-    navId: string;
-    children: Array<ReactElement>;
-    "aria-label": string;
-    onSelect: (() => void) | undefined;
-    onClose: (callback: (...args: Array<any>) => any) => void;
-}
-export declare function _patchContextMenu(props: ContextMenuProps): void;
-export {};
+import type { ReactElement } from "react";
+/**
+ * @param children The rendered context menu elements
+ * @param args Any arguments passed into making the context menu, like the guild, channel, user or message for example
+ */
+export type NavContextMenuPatchCallback = (children: Array<ReactElement | null>, ...args: Array<any>) => void;
+/**
+ * @param navId The navId of the context menu being patched
+ * @param children The rendered context menu elements
+ * @param args Any arguments passed into making the context menu, like the guild, channel, user or message for example
+ */
+export type GlobalContextMenuPatchCallback = (navId: string, children: Array<ReactElement | null>, ...args: Array<any>) => void;
+export declare const navPatches: Map<string, Set<NavContextMenuPatchCallback>>;
+export declare const globalPatches: Set<GlobalContextMenuPatchCallback>;
+/**
+ * Add a context menu patch
+ * @param navId The navId(s) for the context menu(s) to patch
+ * @param patch The patch to be applied
+ */
+export declare function addContextMenuPatch(navId: string | Array<string>, patch: NavContextMenuPatchCallback): void;
+/**
+ * Add a global context menu patch that fires the patch for all context menus
+ * @param patch The patch to be applied
+ */
+export declare function addGlobalContextMenuPatch(patch: GlobalContextMenuPatchCallback): void;
+/**
+ * Remove a context menu patch
+ * @param navId The navId(s) for the context menu(s) to remove the patch
+ * @param patch The patch to be removed
+ * @returns Whether the patch was successfully removed from the context menu(s)
+ */
+export declare function removeContextMenuPatch<T extends string | Array<string>>(navId: T, patch: NavContextMenuPatchCallback): T extends string ? boolean : Array<boolean>;
+/**
+ * Remove a global context menu patch
+ * @param patch The patch to be removed
+ * @returns Whether the patch was successfully removed
+ */
+export declare function removeGlobalContextMenuPatch(patch: GlobalContextMenuPatchCallback): boolean;
+/**
+ * A helper function for finding the children array of a group nested inside a context menu based on the id(s) of its children
+ * @param id The id of the child. If an array is specified, all ids will be tried
+ * @param children The context menu children
+ */
+export declare function findGroupChildrenByChildId(id: string | string[], children: Array<ReactElement | null>): Array<ReactElement | null> | null;
+interface ContextMenuProps {
+    contextMenuApiArguments?: Array<any>;
+    navId: string;
+    children: Array<ReactElement | null>;
+    "aria-label": string;
+    onSelect: (() => void) | undefined;
+    onClose: (callback: (...args: Array<any>) => any) => void;
+}
+export declare function _usePatchContextMenu(props: ContextMenuProps): ContextMenuProps;
+export {};