@unbound-app/api 0.11.0 → 1.1.0

package/src/{utils.d.ts → _types.d.ts}

@@ -4,10 +4,14 @@ import * as ReactModule from 'react';
 import * as ReactNativeModule from 'react-native';
 /** Any supported colour string: a {@link HexColor} or {@link RgbaColor}. */
 export type ColorString = HexColor | RgbaColor;
+/** A Unicode emoji, or a custom emoji's name then `:` and its id. */
+export type EmojiString = string;
 /** The set of all falsy values. */
 export type Falsy = false | 0 | '' | null | undefined;
 /** A hexadecimal colour string prefixed with `#`. */
 export type HexColor = `#${string}`;
+/** An http or https URL, as a `url` setting holds it. */
+export type HttpUrl = `https://${string}` | `http://${string}`;
 /**
  * A string union that keeps `T`'s literals for autocomplete while still accepting any other string,
  * for Discord's open-ended enums (typography variants, colour tokens, sizes).
@@ -17,6 +21,8 @@ export type LiteralUnion<T extends string> = T | (string & {});
 export type PredicateResult = Truthy | false | null | undefined;
 /** An `rgba(...)` colour string. */
 export type RgbaColor = `rgba(${string})`;
+/** A Discord id. */
+export type Snowflake = `${bigint}`;
 /** The set of all truthy values. */
 export type Truthy = true | number | string | object | symbol | bigint;
 /** Widens a literal type to its primitive base (e.g. `'a'` to `string`, `1` to `number`). */
@@ -27,5 +33,9 @@ export type Widen<T> = T extends number
 		: T extends boolean
 			? boolean
 			: T;
+/** `T` without the keys `K`. Unlike `Omit`, it keeps the known keys of a type that also has an index signature. */
+export type Without<T, K extends PropertyKey> = {
+	[Key in keyof T as Key extends K ? never : Key]: T[Key];
+};
 
 export {};

package/src/assets.d.ts

@@ -1,51 +1,89 @@
 // Auto-generated by generate-plugin-sdk.ts - DO NOT EDIT
 
-export type { UnboundAsset } from './_internal';
-import type { UnboundAsset } from './_internal';
-declare const _default: {
-	assets: Map<number, UnboundAsset>;
-	find: typeof find;
-	getByName: typeof getByName;
-	getByID: typeof getByID;
-	getIDByName: typeof getIDByName;
-	getAll: typeof getAll;
-	Icons: Record<string, number | undefined>;
-};
-/** Proxy resolving any property name to its asset id via {@link getIDByName}. */
-export declare const Icons: Record<string, number | undefined>;
-/** Map of discovered asset ids to their resolved {@link UnboundAsset} record. */
+export type { AssetName, AssetType, DiscordAssetName, UnboundAsset } from './_internal';
+import type { AssetName, AssetType, DiscordAssetName, UnboundAsset } from './_internal';
+/** Map of registered asset ids to their {@link UnboundAsset} record. */
 export declare const assets: Map<number, UnboundAsset>;
+/** Proxy resolving any property name to its PNG asset id via {@link getIdByName}; Discord's names are suggested. */
+export declare const icons: Readonly<Partial<Record<DiscordAssetName<'png'>, number>>> &
+	Readonly<Record<string, number | undefined>>;
 /**
- * @description Finds the first known asset matching the given predicate.
+ * @description Finds the first asset matching the given predicate, initializing every asset module first.
  * @param filter Predicate run against each asset.
  * @returns The matched {@link UnboundAsset}, or `undefined` if none match.
  */
 export declare function find(filter: (asset: UnboundAsset) => boolean): UnboundAsset | undefined;
 /**
- * @description Returns every known asset.
+ * @description Returns every asset, initializing every asset module first.
  * @returns An array of all registered {@link UnboundAsset} records.
  */
 export declare function getAll(): UnboundAsset[];
 /**
- * @description Looks up a known asset by its id.
+ * @description Looks up a registered asset by its id.
  * @param id The asset id to look up.
  * @returns The matched {@link UnboundAsset}, or `undefined` if none is registered for that id.
  */
-export declare function getByID(id: number): UnboundAsset | undefined;
+export declare function getById(id: number): UnboundAsset | undefined;
 /**
- * @description Finds a known asset by its name and type.
+ * @description Finds an asset by its name and type, initializing the module that registers it if needed.
+ * @template T The asset's file type, which picks the names suggested for `name`.
  * @param name The asset name to match.
- * @param type The asset type to match.
+ * @param type The asset type to match, `png` by default.
  * @returns The matched {@link UnboundAsset}, or `undefined` if none match.
  */
-export declare function getByName(name: string, type?: 'svg' | 'png'): UnboundAsset | undefined;
+export declare function getByName<T extends AssetType = 'png'>(
+	name: AssetName<T>,
+	type?: T,
+): UnboundAsset | undefined;
 /**
- * @description Looks up a known asset's id by its name and type.
+ * @description Looks up an asset's id by its name and type, initializing the module that registers it if needed.
+ * @template T The asset's file type, which picks the names suggested for `name`.
  * @param name The asset name to match.
- * @param type The asset type to match.
+ * @param type The asset type to match, `png` by default.
  * @returns The matched asset's id, or `undefined` if none match.
  */
-export declare function getIDByName(name: string, type?: 'svg' | 'png'): number | undefined;
-export { _default as default };
-
+export declare function getIdByName<T extends AssetType = 'png'>(
+	name: AssetName<T>,
+	type?: T,
+): number | undefined;
+/**
+ * @description Calls `listener` with each asset registered from now on.
+ * @param listener Receives the asset and its id.
+ * @returns A function that removes the listener.
+ */
+export declare function onAssetRegistered(listener: AssetRegistrationListener): () => void;
+/**
+ * @description Registers an image generated at runtime, such as a `data:` URI or a file the plugin wrote, with
+ * Discord's asset registry, so `<Image source={id}>` and Discord's icon props draw it. Images a plugin imports
+ * are registered for it. A plugin's names never collide with another's, and its registrations end when it stops.
+ * @param options The image: its name, `uri` or `path`, size in points, type and other `scales`.
+ * @returns The asset's id, and `unregister`.
+ */
+export declare function register(options: AssetRegistration): RegisteredAsset;
+/** An image to register with Discord's asset registry, so `<Image source={id}>` and Discord's icon props draw it. */
+export type AssetRegistration = {
+	/** The asset's name; a plugin's names are kept apart from every other plugin's. */
+	name: string;
+	/** The image's URI at scale 1, such as a `data:` or `file://` URI. */
+	uri?: string;
+	/** The image file at scale 1, as an absolute path such as `${fs.documentsPath}/MyPlugin/star.png`. */
+	path?: string;
+	/** Width in points. */
+	width: number;
+	/** Height in points. */
+	height: number;
+	/** The file type, such as `png`. */
+	type: string;
+	/** The image at other pixel densities, as URIs or absolute paths by scale, such as `{ 2: '/…/star@2x.png' }`. */
+	scales?: Record<number, string>;
+};
+/** Called with each asset Discord registers, and its id. */
+export type AssetRegistrationListener = (asset: UnboundAsset, id: number) => void;
+/** A registered asset: its id, and the function that takes it out of the registry. */
+export type RegisteredAsset = {
+	/** The asset registry id, which an image `source` or an `icon` option takes. */
+	id: number;
+	/** Takes the asset out of the registry; registering its name again reuses the id. */
+	unregister: () => void;
+};
 export {};

package/src/builtins.d.ts

@@ -0,0 +1,17 @@
+// Auto-generated by generate-plugin-sdk.ts - DO NOT EDIT
+
+/** Starts a built-in feature under a name, skipping a name already registered. */
+export declare const register: (name: string, builtin: BuiltIn) => void;
+/** Stops the built-in feature registered under a name. */
+export declare const unregister: (name: string) => void;
+/** A built-in feature exposing optional `start`/`stop` lifecycle hooks. */
+export type BuiltIn = {
+	/** Runs when the built-in is registered; if it throws, the built-in is logged and left inactive. */
+	start?: () => void;
+	/** Runs when the built-in is unregistered or the built-ins shut down, in reverse start order. */
+	stop?: () => void;
+	/** Checked once at initialisation; returning `false` skips registering the built-in. */
+	shouldStart?: () => boolean;
+};
+
+export {};

package/src/commands.d.ts

@@ -1,20 +1,29 @@
 // Auto-generated by generate-plugin-sdk.ts - DO NOT EDIT
 
-declare const _default: {
-	createCommands: typeof createCommands;
-	option: OptionBuilders;
-};
 declare const valueType: unique symbol;
-/** Option builders, one per kind: `option.string({ required: true })`, `option.user()`, `option.choice([...])`. */
+/** Option builders, one per kind: `option.string({ required: true })`, `option.user()`, `option.choice({ ... })`. */
 export declare const option: OptionBuilders;
 /**
  * @description Creates the commands handle for one owner, like `createPatcher` does for patches. A plugin passes
- * its manifest id, so its commands are removed when it stops; a built-in passes `'unbound'`.
+ * its manifest id, so its commands are removed when it stops; a built-in passes `'unbound'`. Text is message keys.
  * @param owner The plugin id, or `'unbound'` for a built-in.
  * @param options The owner's own picker section; omitted, the shared Unbound section.
  * @returns The handle.
  */
 export declare function createCommands(owner: string, options?: CommandsOptions): CommandsHandle;
+/**
+ * @description Adds commands to the shared Unbound section of the `/` picker. Registering a root name again
+ * replaces that whole command; a root name another owner has throws `CommandDefinitionError`.
+ * @template T The command tree, inferred from it.
+ * @param commands The commands, keyed by root name.
+ * @returns A function that removes this call's commands; it is safe to call twice.
+ */
+export declare function register<T>(commands: CommandTree<T>): () => void;
+/**
+ * @description Removes a root command added with `register`, with its subcommands. Does nothing when there is none.
+ * @param name The root command's name.
+ */
+export declare function unregister(name: string): void;
 /** Suggests values for an option while the user types. At most 25 are shown. */
 export type Autocomplete<V extends string | number> = (
 	query: string,
@@ -28,7 +37,9 @@ export type AutocompleteContext = CommandContext & {
 export type Awaitable<T> = T | Promise<T>;
 /** Settings every builder accepts. */
 export type BuilderInput<K extends OptionKind, R extends boolean> = OptionSettings<K> & {
-	description?: string;
+	/** The message key of the text the picker shows for the option; 1 to 100 characters in en-US. Omitted, its name. */
+	description?: CommandMessageKey;
+	/** Whether Discord requires the option. Defaults to `false`. */
 	required?: R;
 };
 /** Settings of `option.channel`. */
@@ -36,52 +47,74 @@ export type ChannelOptionSettings = {
 	/** Discord channel types the picker offers. */
 	channelTypes?: readonly number[];
 };
-/** A choice or suggestion: a bare value, shown as itself, or a value with a label. */
+/** An autocomplete suggestion: a bare value, shown as itself, or a value with a label. */
 export type Choice<V extends string | number> = V | ChoiceWithLabel<V>;
 /** Settings `option.choice` accepts. */
 export type ChoiceInput<R extends boolean> = {
-	description?: string;
+	/** The message key of the text the picker shows for the option; 1 to 100 characters in en-US. Omitted, its name. */
+	description?: CommandMessageKey;
+	/** Whether Discord requires the option. Defaults to `false`. */
 	required?: R;
 };
-/** The kind a choice list maps to: strings are a string option, numbers an integer or number option. */
-export type ChoiceKind<V extends string | number> = V extends string
-	? 'string'
-	: 'integer' | 'number';
-/** A value with the label the picker shows for it. */
+/** Each value `option.choice` allows, mapped to the message key of its label. Labels must differ in en-US. */
+export type ChoiceMap = Readonly<Record<string, CommandMessageKey>>;
+/** An autocomplete suggestion's value with the label the picker shows for it. */
 export type ChoiceWithLabel<V extends string | number> = {
+	/** The text the picker shows: data, such as a name, so it is not a message key. */
 	label: string;
+	/** The value the handler receives when this choice is picked. */
 	value: V;
 };
 /** A Discord channel, as the channel store returns it. */
 export type CommandChannel = {
+	/** The channel's Discord snowflake id. */
 	id: string;
+	/** Discord's numeric channel type, such as `0` for a guild text channel or `1` for a DM. */
 	type: number;
+	/** The channel name; DMs may have none. */
 	name?: string;
+	/** The id of the guild the channel belongs to; `null` or absent for DMs and group DMs. */
 	guild_id?: string | null;
 };
 /** Where a command runs. Discord never runs a command without a channel. */
 export type CommandContext = {
+	/** The channel the command was sent in. */
 	channel: CommandChannel;
+	/** The guild of that channel; `undefined` in DMs and group DMs. */
 	guild: CommandGuild | undefined;
 };
 /** A command that only groups subcommands: `/root sub` or `/root group sub`. */
 export type CommandGroup<S> = {
-	description: string;
+	/** The message key of the text the picker shows under the group name; 1 to 100 characters in en-US. */
+	description: CommandMessageKey;
+	/** The group's commands keyed by name, 1 to 25 of them. */
 	subcommands: CommandTree<S>;
+	/** Never set on a group; only a {@link LeafCommand} takes options. */
 	options?: never;
+	/** Never set on a group; only a {@link LeafCommand} runs. */
 	execute?: never;
 };
 /** A Discord guild. */
 export type CommandGuild = {
+	/** The guild's Discord snowflake id. */
 	id: string;
+	/** The guild's display name. */
 	name: string;
 };
+/**
+ * A key of the owner's `i18n/en-US.json`. The picker shows its message in the user's locale, falling back to en-US;
+ * a plugin's keys come from its generated `src/unbound-i18n.d.ts`.
+ */
+export type CommandMessageKey = Extract<keyof UnboundMessageKeys, string>;
 /** A leaf or a group. */
 export type CommandNode<T> = LeafCommand<T> | CommandGroup<T>;
 /** A Discord guild role. */
 export type CommandRole = {
+	/** The role's Discord snowflake id. */
 	id: string;
+	/** The role's display name. */
 	name: string;
+	/** The role colour as a 24-bit RGB integer; `0` when the role has no colour. */
 	color?: number;
 };
 /**
@@ -93,9 +126,13 @@ export type CommandTree<T> = {
 };
 /** A Discord user, as the user store returns it. Only the fields commands rely on. */
 export type CommandUser = {
+	/** The user's Discord snowflake id. */
 	id: string;
+	/** The unique account name, without the `@`. */
 	username: string;
+	/** The display name the user set; `null` or absent when they set none. */
 	globalName?: string | null;
+	/** `true` for bot accounts. */
 	bot?: boolean;
 };
 /** The handle `createCommands` returns, scoped to one owner. */
@@ -105,6 +142,8 @@ export type CommandsHandle = {
 	 * Returns a function that removes this call's commands; it is safe to call twice or after a sweep.
 	 */
 	register<T>(commands: CommandTree<T>): () => void;
+	/** Removes this owner's root command `name` with its subcommands. Does nothing when there is none. */
+	unregister(name: string): void;
 	/** Removes every command of this owner. */
 	unregisterAll(): void;
 };
@@ -115,8 +154,11 @@ export type CommandsOptions = {
 };
 /** Shown only to the user, as a bot message. */
 export type EphemeralReply = {
+	/** Marks the reply as shown only to the user instead of sent. */
 	ephemeral: true;
+	/** The message text; empty when absent. */
 	content?: string;
+	/** Embeds shown under the text. */
 	embeds?: readonly ReplyEmbed[];
 };
 /** An asset id from `assets.Icons`, or a `data:` or `https:` uri. */
@@ -126,16 +168,24 @@ export type IconSource = number | string;
  * `execute` uses method syntax so its parameter stays bivariant and the registry can hold it erased.
  */
 export type LeafCommand<O> = {
-	description: string;
+	/** The message key of the text the picker shows under the command name; 1 to 100 characters in en-US. */
+	description: CommandMessageKey;
+	/** The command's options keyed by name, made with the `option` builders. At most 25. */
 	options?: O;
+	/** Runs the command with the parsed options. A throw or rejection shows the user an ephemeral error. */
 	execute(args: OptionArgs<O>, context: CommandContext): Awaitable<Reply>;
+	/** Never set on a leaf; a command with `subcommands` is a {@link CommandGroup}. */
 	subcommands?: never;
 };
+/** The settings of an option kind that takes none. */
 export type NoSettings = Record<never, never>;
 /** Settings of `option.integer` and `option.number`. */
 export type NumberOptionSettings = {
+	/** The smallest value Discord accepts, inclusive. */
 	minValue?: number;
+	/** The largest value Discord accepts, inclusive. */
 	maxValue?: number;
+	/** Suggests values while the user types; setting it turns on Discord's autocomplete for the option. */
 	autocomplete?: Autocomplete<number>;
 };
 /** A handler's args, derived from its options: a required option is `V`, an optional one `V | undefined`. */
@@ -155,43 +205,50 @@ export type OptionBuilders = {
 	[K in OptionKind]: OptionBuilder<K>;
 } & {
 	/**
-	 * Restricts an option to listed values; the handler gets their literal union.
-	 * @param choices Values, or `{ label, value }` pairs. 1 to 25, with unique labels.
+	 * Restricts a string option to listed values; the handler gets their literal union.
+	 * @param choices Each value mapped to its label's message key, in picker order: `{ heads: 'COIN_HEADS' }`. 1 to 25.
 	 * @param settings The option's description and whether it is required.
 	 */
-	choice<const V extends string | number, const R extends boolean = false>(
-		choices: readonly Choice<V>[],
+	choice<const M extends ChoiceMap, const R extends boolean = false>(
+		choices: M,
 		settings?: ChoiceInput<R>,
-	): OptionSpec<ChoiceKind<V>, R, V>;
+	): OptionSpec<'string', R, keyof M & string>;
 };
 /** The option kinds: one builder each on `option`. */
 export type OptionKind = keyof OptionKindTypes;
 /** Each option kind's handler value and builder settings. The client's kind table implements every key. */
 export type OptionKindTypes = {
+	/** Free text. */
 	string: {
 		value: string;
 		settings: StringOptionSettings;
 	};
+	/** A whole number; a fractional value fails the command. */
 	integer: {
 		value: number;
 		settings: NumberOptionSettings;
 	};
+	/** Any finite number. */
 	number: {
 		value: number;
 		settings: NumberOptionSettings;
 	};
+	/** True or false. */
 	boolean: {
 		value: boolean;
 		settings: NoSettings;
 	};
+	/** A user, resolved from the picked id through Discord's user store. */
 	user: {
 		value: CommandUser;
 		settings: NoSettings;
 	};
+	/** A channel, resolved from the picked id through Discord's channel store. */
 	channel: {
 		value: CommandChannel;
 		settings: ChannelOptionSettings;
 	};
+	/** A role of the current guild, resolved from the picked id through Discord's role store. */
 	role: {
 		value: CommandRole;
 		settings: NoSettings;
@@ -205,19 +262,28 @@ export type OptionSpec<
 	R extends boolean = boolean,
 	V = OptionValue<K>,
 > = {
+	/** The option kind; `option.choice` derives it from its values. */
 	readonly kind: K;
+	/** Whether Discord requires the option. Defaults to `false`; required options are listed first. */
 	readonly required: R;
+	/** The message key of the text the picker shows for the option; `undefined` shows the option's name. */
 	readonly description: string | undefined;
+	/** The kind-specific settings given to the builder; empty for `option.choice`. */
 	readonly settings: OptionSettings<K>;
-	readonly choices: readonly Choice<string | number>[] | undefined;
+	/** Each value from `option.choice` mapped to its label's message key; `undefined` for every other builder. */
+	readonly choices: Readonly<Record<string, string>> | undefined;
+	/** Carries the handler's value type for inference only; never set at runtime. */
 	readonly [valueType]?: V;
 };
 /** The value a handler receives for a kind. */
 export type OptionValue<K extends OptionKind> = OptionKindTypes[K]['value'];
 /** Sent by Discord as a normal message from the user. */
 export type PublicReply = {
+	/** The message text. An empty string sends nothing. */
 	content: string;
+	/** Sends the message as text-to-speech. */
 	tts?: boolean;
+	/** Absent or `false`; `true` makes the reply an {@link EphemeralReply}. */
 	ephemeral?: false;
 };
 /** An option value as Discord passes it. User, channel and role options arrive as id strings. */
@@ -226,30 +292,40 @@ export type RawOptionValue = string | number | boolean;
 export type Reply = string | PublicReply | EphemeralReply | undefined | void;
 /** An embed in an ephemeral reply. */
 export type ReplyEmbed = {
+	/** The heading at the top of the embed. */
 	title?: string;
+	/** The embed's body text, below the title. */
 	description?: string;
+	/** A link the title opens. */
 	url?: string;
+	/** The colour of the embed's side bar, as a 24-bit RGB integer such as `0x5865f2`. */
 	color?: number;
+	/** Name and value pairs shown below the description. */
 	fields?: readonly ReplyEmbedField[];
 };
 /** A field of an embed in an ephemeral reply. */
 export type ReplyEmbedField = {
+	/** The field's heading. */
 	name: string;
+	/** The field's body text. */
 	value: string;
+	/** Lays the field out beside neighbouring inline fields instead of on its own row. */
 	inline?: boolean;
 };
 /** A section of the `/` picker owned by one owner. */
 export type SectionInput = {
+	/** The section's heading in the picker; also the author name on its ephemeral replies. Must not be blank. */
 	name: string;
+	/** The section's icon and reply avatar. Omitted, Discord's default application command icon. */
 	icon?: IconSource;
 };
 /** Settings of `option.string`. */
 export type StringOptionSettings = {
+	/** The fewest characters Discord accepts for the value. */
 	minLength?: number;
+	/** The most characters Discord accepts for the value. */
 	maxLength?: number;
+	/** Suggests values while the user types; setting it turns on Discord's autocomplete for the option. */
 	autocomplete?: Autocomplete<string>;
 };
-
-export { _default as default };
-
 export {};

package/src/dialogs.d.ts

@@ -1,25 +1,46 @@
 // Auto-generated by generate-plugin-sdk.ts - DO NOT EDIT
 
+import type { MessageKey, FormatVars as MessageVars } from '@unbound-app/i18n';
 import * as React$1 from 'react';
 import { ComponentType } from 'react';
-
-declare const _default: {
-	showDialog: typeof showDialog;
-	confirm: typeof confirm$1;
-	dismissAll: typeof dismissAll;
-	start: typeof start;
-	stop: typeof stop$1;
-};
 /**
- * @description Asks a yes-or-no question with a confirm and a cancel button.
- * @param options The question and the confirm button's label.
- * @returns Whether the user confirmed; closing the dialog any other way counts as no.
+ * @description Tells the user something in a dialog with one button, each text a message key.
+ * @template T The title's key.
+ * @template B The body's key.
+ * @param title The dialog's message key.
+ * @param options The `body` and `confirm` keys, and `titleVars` and `bodyVars` for keys with placeholders.
+ * @returns A promise that resolves once the dialog closes, however it closes.
  */
-declare function confirm$1(options: ConfirmOptions): Promise<boolean>;
-/** Closes any dialog still open. */
-declare function stop$1(): void;
+declare function alert$1<T extends PlainMessageKey, B extends MessageKey = never>(
+	title: T,
+	options?: AlertOptions<T, B>,
+): Promise<void>;
 /**
- * @description Closes every dialog this API opened.
+ * @description Tells the user something in a dialog with one button, titled by a key with placeholders.
+ * @template T The title's key.
+ * @template B The body's key.
+ * @param title The dialog's message key.
+ * @param options `titleVars`, then the `body` and `confirm` keys, and `bodyVars` for a body with placeholders.
+ * @returns A promise that resolves once the dialog closes, however it closes.
+ */
+declare function alert$1<T extends VarsMessageKey, B extends MessageKey = never>(
+	title: T,
+	options: AlertOptions<T, B>,
+): Promise<void>;
+/**
+ * @description Asks a yes-or-no question with a confirm and a cancel button, each text a message key.
+ * @template T The title's key.
+ * @template B The body's key.
+ * @param title The question's message key.
+ * @param options The `body`, `confirm` and `cancel` keys, `titleVars` and `bodyVars` for keys with placeholders, and `destructive`.
+ * @returns Whether the user confirmed; cancel, the backdrop, the back gesture or a dismiss resolve `false`.
+ */
+declare function confirm$1<T extends MessageKey, B extends MessageKey = never>(
+	title: T,
+	options: ConfirmOptions<T, B>,
+): Promise<boolean>;
+/**
+ * @description Closes every dialog this API opened, running each one's `onDismiss`.
  */
 export declare function dismissAll(): void;
 /**
@@ -30,40 +51,84 @@ export declare function dismissAll(): void;
  * @returns The dialog's key and a function that closes it.
  */
 export declare function showDialog(options: AlertDialogProps): DialogHandle;
-/** Starts the dialogs API; it keeps no state until a dialog opens. */
-export declare function start(): void;
+/** What {@link showDialog} shows: a title, an optional body and custom content, and buttons. */
 export type AlertDialogProps = {
+	/** The heading at the top of the dialog. */
 	title: string;
+	/** Text shown below the title. */
 	body?: string;
 	/** A component rendered below the body, given a way to close the dialog. */
 	content?: React$1.ComponentType<DialogContentProps>;
+	/** The action buttons, in order, before the cancel button. */
 	buttons?: DialogButton[];
 	/** Adds a cancel button last; a string sets its label. */
 	cancel?: boolean | string;
 	/** Runs when the cancel button closes the dialog. */
 	onCancel?: () => void;
+	/** Runs when the dialog closes without a button: the backdrop, the back gesture, or its handle's `dismiss`. */
+	onDismiss?: () => void;
 };
-export type ConfirmOptions = {
-	title: string;
-	body?: string;
-	confirmLabel: string;
-	cancelLabel?: string;
-	destructive?: boolean;
-};
+/** What `alert` shows after its title key: the body and button keys, and the title's and body's vars. */
+export type AlertOptions<T extends MessageKey, B extends MessageKey = never> = BodyOptions<B> &
+	KeyVars<T, 'titleVars'> & {
+		/** The key of the button that closes the dialog; Unbound's `OK` when omitted. */
+		confirm?: PlainMessageKey;
+	};
+/** The optional body key of a dialog, and its vars when the message has placeholders. */
+export type BodyOptions<B extends MessageKey> = {
+	/** The key of the text shown below the title. */
+	body?: B;
+} & KeyVars<B, 'bodyVars'>;
+/** What `confirm` asks after its title key: the body and button keys, and the title's and body's vars. */
+export type ConfirmOptions<T extends MessageKey, B extends MessageKey = never> = BodyOptions<B> &
+	KeyVars<T, 'titleVars'> & {
+		/** The key of the button that resolves `true`. */
+		confirm: PlainMessageKey;
+		/** The key of the button that resolves `false`; Unbound's `Cancel` when omitted. */
+		cancel?: PlainMessageKey;
+		/** Styles the confirm button as `destructive` instead of `primary`. Use it whenever confirming loses data. */
+		destructive?: boolean;
+	};
+/** One action button in a dialog opened by {@link showDialog}. */
 export type DialogButton = {
+	/** The text shown on the button. */
 	label: string;
+	/** The button's style; `primary` when omitted. */
 	variant?: DialogButtonVariant;
+	/** Runs after the press closes the dialog. */
 	onPress?: () => void;
 };
+/** A dialog button's style; the system alert fallback only distinguishes `destructive`. */
 export type DialogButtonVariant = 'primary' | 'secondary' | 'destructive';
+/** The props a dialog's custom `content` component receives. */
 export type DialogContentProps = {
+	/** Closes the dialog without running any button's handler. */
 	dismiss: () => void;
 };
+/** An open dialog, as {@link showDialog} returns it. */
 export type DialogHandle = {
+	/** The `unbound-dialog-<uuid>` key the dialog was opened under in Discord's alert stack. */
 	key: string;
+	/** Closes the dialog; does nothing once it is closed or when the system alert fallback showed it. */
 	dismiss: () => void;
 };
+/** An options field holding a key's placeholder values: required when the key has placeholders, absent otherwise. */
+export type KeyVars<K extends MessageKey, Field extends string> = [K] extends [never]
+	? {
+			[P in Field]?: never;
+		}
+	: K extends keyof MessageVars
+		? {
+				[P in Field]: MessageVars[K];
+			}
+		: {
+				[P in Field]?: never;
+			};
+/** A message key whose en-US text has no placeholders. */
+export type PlainMessageKey = Exclude<MessageKey, keyof MessageVars>;
+/** A message key whose en-US text has placeholders. */
+export type VarsMessageKey = Extract<MessageKey, keyof MessageVars>;
 
-export { _default as default, confirm$1 as confirm, stop$1 as stop };
+export { alert$1 as alert, confirm$1 as confirm };
 
 export {};