Revenge/src/def.d.ts

285 lines
7.3 KiB
TypeScript
Raw Normal View History

2022-10-18 22:04:55 +00:00
import * as _spitroast from "spitroast";
2022-10-22 17:59:01 +00:00
import _React from "react";
import _RN from "react-native";
2023-01-30 00:40:56 +00:00
import { Events } from "@lib/emitter";
2022-10-18 22:04:55 +00:00
type MetroModules = { [id: number]: any };
// Helper types for API functions
type PropIntellisense<P extends string | symbol> = Record<P, any> & Record<PropertyKey, any>;
type PropsFinder = <T extends string | symbol>(...props: T[]) => PropIntellisense<T>;
type PropsFinderAll = <T extends string | symbol>(...props: T[]) => PropIntellisense<T>[];
type LoggerFunction = (...messages: any[]) => void;
interface Logger {
2022-10-22 17:59:01 +00:00
log: LoggerFunction;
info: LoggerFunction;
warn: LoggerFunction;
error: LoggerFunction;
time: LoggerFunction;
trace: LoggerFunction;
verbose: LoggerFunction;
2022-10-18 22:04:55 +00:00
}
2022-10-18 22:21:58 +00:00
type SearchFilter = (tree: any) => boolean;
interface FindInTreeOptions {
walkable?: string[];
ignore?: string[];
maxDepth?: number;
}
2022-10-22 22:26:06 +00:00
interface Asset {
name: string;
id: number;
}
2023-01-04 22:39:28 +00:00
interface PluginAuthor {
name: string;
id: string;
}
// See https://github.com/vendetta-mod/polymanifest
interface PluginManifest {
name: string;
description: string;
2023-01-04 22:39:28 +00:00
authors: PluginAuthor[];
main: string;
hash: string;
// Vendor-specific field, contains our own data
2023-01-16 08:11:46 +00:00
vendetta?: {
icon?: string;
2023-01-04 22:39:28 +00:00
};
}
interface Plugin {
id: string;
manifest: PluginManifest;
enabled: boolean;
2023-01-07 23:05:14 +00:00
update: boolean;
js: string;
}
2023-01-10 08:05:56 +00:00
interface Settings {
debuggerUrl: string;
developerSettings: boolean;
}
2023-01-30 00:40:56 +00:00
interface ApplicationCommand {
description: string;
name: string;
options: ApplicationCommandOption[];
execute: (args: any[], ctx: CommandContext) => CommandResult | void | Promise<CommandResult> | Promise<void>;
id?: string;
applicationId: string;
displayName: string;
displayDescription: string;
inputType: ApplicationCommandInputType;
type: ApplicationCommandType;
}
2023-01-30 00:40:56 +00:00
declare enum ApplicationCommandInputType {
BUILT_IN,
BUILT_IN_TEXT,
BUILT_IN_INTEGRATION,
BOT,
PLACEHOLDER,
}
2023-01-30 00:40:56 +00:00
interface ApplicationCommandOption {
name: string;
description: string;
required?: boolean;
type: ApplicationCommandOptionType;
displayName: string;
displayDescription: string;
}
2023-01-30 00:40:56 +00:00
declare enum ApplicationCommandOptionType {
SUB_COMMAND = 1,
SUB_COMMAND_GROUP,
STRING,
INTEGER,
BOOLEAN,
USER,
CHANNEL,
ROLE,
MENTIONABLE,
NUMBER,
ATTACHMENT,
}
2023-01-30 00:40:56 +00:00
declare enum ApplicationCommandType {
CHAT = 1,
USER,
MESSAGE,
}
2023-01-30 00:40:56 +00:00
interface CommandContext {
channel: any;
guild: any;
}
2023-01-30 00:40:56 +00:00
interface CommandResult {
content: string;
tts?: boolean;
}
interface RNConstants extends _RN.PlatformConstants {
// Android
Version: number;
Release: string;
Serial: string;
Fingerprint: string;
Model: string;
Brand: string;
Manufacturer: string;
ServerHost?: string;
// iOS
forceTouchAvailable: boolean;
interfaceIdiom: string;
osVersion: string;
systemName: string;
}
2023-01-16 23:52:20 +00:00
/**
* A key-value storage based upon `SharedPreferences` on Android.
*
* These types are based on Android though everything should be the same between
* platforms.
*/
interface MMKVManager {
/**
* Get the value for the given `key`, or null
* @param key The key to fetch
*/
getItem: (key: string) => Promise<string | null>;
/**
* Deletes the value for the given `key`
* @param key The key to delete
*/
removeItem: (key: string) => void;
/**
* Sets the value of `key` to `value`
*/
setItem: (key: string, value: string) => void;
/**
* Goes through every item in storage and returns it, excluding the
* keys specified in `exclude`.
* @param exclude A list of items to exclude from result
*/
refresh: (exclude: string[]) => Promise<Record<string, string>>;
/**
* You will be murdered if you use this function.
* Clears ALL of Discord's settings.
*/
clear: () => void;
}
type Indexable<Type> = { [index: string]: Type }
type EmitterEvent = (keyof typeof Events) & string;
interface EmitterListenerData {
path: string[];
value?: any;
}
type EmitterListener = (
event: EmitterEvent,
data: EmitterListenerData | any
) => any;
type EmitterListeners = Indexable<Set<EmitterListener>>;
interface Emitter {
listeners: EmitterListeners;
on: (event: EmitterEvent, listener: EmitterListener) => void;
off: (event: EmitterEvent, listener: EmitterListener) => void;
once: (event: EmitterEvent, listener: EmitterListener) => void;
emit: (event: EmitterEvent, data: EmitterListenerData) => void;
}
2022-10-18 22:04:55 +00:00
interface VendettaObject {
patcher: {
after: typeof _spitroast.after;
before: typeof _spitroast.before;
instead: typeof _spitroast.instead;
unpatchAll: typeof _spitroast.unpatchAll;
2022-10-22 17:59:01 +00:00
};
2022-10-18 22:04:55 +00:00
metro: {
findByProps: PropsFinder;
findByPropsAll: PropsFinderAll;
findByDisplayName: (name: string, defaultExp: boolean) => any;
findByDisplayNameAll: (name: string, defaultExp: boolean) => any[];
2022-10-22 17:59:01 +00:00
common: {
constants: PropIntellisense<"API_HOST">;
channels: PropIntellisense<"getVoiceChannelId">;
i18n: PropIntellisense<"Messages">;
url: PropIntellisense<"openURL">;
toasts: PropIntellisense<"open" | "close">;
2022-10-22 17:59:01 +00:00
React: typeof _React;
ReactNative: typeof _RN;
};
};
constants: {
DISCORD_SERVER: string;
GITHUB: string;
};
utils: {
copyText: (content: string) => void;
findInReactTree: (tree: { [key: string]: any }, filter: SearchFilter) => void;
findInTree: (tree: { [key: string]: any }, filter: SearchFilter, options: FindInTreeOptions) => any;
};
debug: {
connectToDebugger: (url: string) => void;
}
2022-10-22 22:26:06 +00:00
ui: {
components: {
Forms: PropIntellisense<"Form" | "FormSection">;
General: PropIntellisense<"Button" | "Text" | "View">;
}
toasts: {
showToast: (content: string, asset: number) => void;
};
2022-10-22 22:26:06 +00:00
assets: {
2023-01-07 23:06:36 +00:00
all: Indexable<Asset>;
2022-10-22 22:26:06 +00:00
find: (filter: (a: any) => void) => Asset | null | undefined;
getAssetByName: (name: string) => Asset;
2022-10-22 23:05:04 +00:00
getAssetByID: (id: number) => Asset;
2022-10-22 22:26:06 +00:00
getAssetIDByName: (name: string) => number;
};
2022-10-22 22:26:06 +00:00
};
2023-01-08 23:24:00 +00:00
plugins: {
plugins: Indexable<Plugin>;
2023-01-30 00:40:56 +00:00
fetchPlugin: (id: string, enabled: boolean) => void;
2023-01-08 23:27:10 +00:00
evalPlugin: (plugin: Plugin) => void;
2023-01-08 23:24:00 +00:00
stopPlugin: (id: string) => void;
removePlugin: (id: string) => void;
getSettings: (id: string) => JSX.Element;
};
commands: {
registerCommand: (command: ApplicationCommand) => () => void;
};
storage: {
createProxy: <T>(target: T) => { proxy: T, emitter: Emitter };
useProxy: <T>(storage: T) => T;
createStorage: <T>(storeName: string) => Promise<Awaited<T>>;
wrapSync: <T extends Promise<any>>(store: T) => Awaited<T>;
awaitSyncWrapper: (store: any) => Promise<void>;
};
settings: Settings;
2022-10-18 22:04:55 +00:00
logger: Logger;
2023-01-10 23:30:46 +00:00
version: string;
2022-10-18 22:04:55 +00:00
}
declare global {
type React = typeof _React;
2022-10-18 22:04:55 +00:00
interface Window {
[key: PropertyKey]: any;
modules: MetroModules;
vendetta: VendettaObject;
React: typeof _React;
2022-10-18 22:04:55 +00:00
}
2022-10-22 17:59:01 +00:00
}