Equicord/src/api/index.ts

/*
 * 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/>.
*/

import * as $AudioPlayer from "./AudioPlayer";
import * as $Badges from "./Badges";
import * as $ChatButtons from "./ChatButtons";
import * as $Commands from "./Commands";
import * as $ContextMenu from "./ContextMenu";
import * as $DataStore from "./DataStore";
import * as $HeaderBar from "./HeaderBar";
import * as $MemberListDecorators from "./MemberListDecorators";
import * as $MessageAccessories from "./MessageAccessories";
import * as $MessageDecorations from "./MessageDecorations";
import * as $MessageEventsAPI from "./MessageEvents";
import * as $MessagePopover from "./MessagePopover";
import * as $MessageUpdater from "./MessageUpdater";
import * as $NicknameIcons from "./NicknameIcons";
import * as $Notices from "./Notices";
import * as $Notifications from "./Notifications";
import * as $UserArea from "./UserArea";
export * as PluginManager from "./PluginManager";
import * as $ProfileCollections from "./ProfileCollections";
import * as $ProfileSections from "./ProfileSections";
import * as $ServerList from "./ServerList";
import * as $Settings from "./Settings";
import * as $Styles from "./Styles";
import * as $Themes from "./Themes";
import * as $UserSettings from "./UserSettings";

/**
 * An API allowing you to listen to Message Clicks or run your own logic
 * before a message is sent.
 *
 * If your plugin uses this, you must add MessageEventsAPI to its dependencies.
 */
export const MessageEvents = $MessageEventsAPI;

/**
 * An API allowing you to create custom notices
 * (snackbars on the top, like the Update prompt).
 */
export const Notices = $Notices;

/**
 * An API allowing you to register custom commands.
 */
export const Commands = $Commands;

/**
 * A wrapper around IndexedDB. This can store arbitrarily
 * large data and supports a lot of datatypes (Blob, Map, ...).
 * For a full list, see the mdn link below.
 *
 * This should always be preferred over the Settings API if possible, as
 * localstorage has very strict size restrictions and blocks the event loop.
 *
 * Make sure your keys are unique (tip: prefix them with ur plugin name)
 * and please clean up no longer needed entries.
 *
 * This is actually just idb-keyval, so if you're familiar with that, you're golden!
 * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm#supported_types}
 */
export const DataStore = $DataStore;

/**
 * An API allowing you to add custom components as message accessories.
 */
export const MessageAccessories = $MessageAccessories;

/**
 * An API allowing you to add custom buttons in the message popover.
 */
export const MessagePopover = $MessagePopover;

/**
 * An API allowing you to add badges to user profiles.
 */
export const Badges = $Badges;

/**
 * An API allowing you to add custom elements to the server list.
 */
export const ServerList = $ServerList;

/**
 * An API allowing you to add components as message accessories.
 */
export const MessageDecorations = $MessageDecorations;

/**
 * An API allowing you to add components to member list users, in both DM's and servers.
 */
export const MemberListDecorators = $MemberListDecorators;

/**
 * An API allowing you to persist data.
 */
export const Settings = $Settings;

/**
 * An API allowing you to dynamically load styles.
 * a
 */
export const Styles = $Styles;

/**
 * An API allowing you to display notifications.
 */
export const Notifications = $Notifications;

/**
 * An api allowing you to patch and add/remove items to/from context menus.
 */
export const ContextMenu = $ContextMenu;

/**
 * An API allowing you to add buttons to the chat input.
 */
export const ChatButtons = $ChatButtons;

/**
 * An API allowing you to add buttons to the header bar or channel toolbar.
 */
export const HeaderBar = $HeaderBar;

/**
 * An API allowing you to update and re-render messages.
 */
export const MessageUpdater = $MessageUpdater;

/**
 * An API allowing you to get an user setting.
 */
export const UserSettings = $UserSettings;

/**
 * Don't use this
 */
export const Themes = $Themes;

/**
 * An API allowing you to add icons to the nickname, in profiles.
 */
export const NicknameIcons = $NicknameIcons;

/**
 * An API allowing you to play internal Discord audio files or external audio URLs/URIs.
 */
export const AudioPlayer = $AudioPlayer;

/**
 * An API allowing you to add buttons to the user area panel.
 */
export const UserArea = $UserArea;

/**
 * Just used to identify if user is on Equicord as Vencord doesn't have this.
 */
export const isEquicord = true;

/**
 * An API allowing you to add other collections where discords game collection is.
 */
export const ProfileCollections = $ProfileCollections;

/**
 * An API allowing you to add sections near the 'Member Since' area of user profile panels.
 */
export const ProfileSections = $ProfileSections;