@unbound-app/api 0.9.0 → 1.1.0

package/src/i18n.d.ts

@@ -1,24 +1,7 @@
 // Auto-generated by generate-plugin-sdk.ts - DO NOT EDIT
 
-declare const _default: {
-	Messages: Record<string, string>;
-	format: typeof format;
-	defineLocalizations: typeof defineLocalizations;
-	init: typeof init;
-	destroy: typeof destroy;
-};
-/** The core `Messages` proxy, resolving Unbound's own UI strings against the active Discord locale. */
-export declare const Messages: Record<string, string>;
-/**
- * @description Creates an isolated, in-memory `Messages`/`format` pair over an addon-supplied string table, sharing the active locale with core.
- * @param table The addon's string store, keyed by locale then message key.
- * @returns A `Messages` proxy and `format` function scoped to the supplied table.
- */
-export declare function defineLocalizations(table: StringStore): Localizations;
-/**
- * @description Drains every active locale-change subscription. Idempotent. Twin of {@link init}.
- */
-export declare function destroy(): void;
+/** The core messages proxy, resolving Unbound's own UI strings against the active Discord locale. */
+export declare const messages: Record<string, string>;
 /**
  * @description Formats a localized string, interpolating ICU `MessageFormat` placeholders.
  * @param key The message key to resolve and format.
@@ -26,19 +9,38 @@ export declare function destroy(): void;
  * @returns The formatted string.
  */
 export declare function format(key: string, vars?: FormatVars): string;
-/**
- * @description Loads the fallback and active locales, then subscribes to Discord locale changes. Fire-and-forget; never blocks startup. Twin of {@link destroy}.
- * @returns A promise that resolves once the initial locales have been ensured and the subscription is wired.
- */
-export declare function init(): Promise<void>;
-export type FormatVars = Record<string, string | number | boolean | Date>;
-export type LocaleStrings = Record<string, string>;
-export type Localizations = {
-	Messages: Record<string, string>;
+/** An addon's `messages`, `format` and `useMessages`, over en-US and at most one other locale. */
+export type AddonLocales = {
+	/** Each message in the active locale, falling back to en-US, then the key itself. */
+	messages: LocaleStrings;
+	/** Formats a message in the active locale, filling its placeholders from `vars`. */
 	format: (key: string, vars?: FormatVars) => string;
+	/**
+	 * Re-renders the component when the locale changes or its table loads. Returns the active locale code,
+	 * a dependency for `useMemo` and `useCallback` over strings.
+	 */
+	useMessages: () => string;
+	/** The en-US messages inlined in the bundle. */
+	source: Readonly<LocaleStrings>;
+	/** Calls the listener when the locale changes or its table loads; returns the remover. */
+	subscribe: (listener: () => void) => () => void;
+	/** The locales held in memory: en-US, and the active one once it loaded. */
+	loadedLocales: () => string[];
+	/** Stops following locale changes and drops the loaded table. */
+	dispose: () => void;
 };
-export type StringStore = Record<string, LocaleStrings>;
-
-export { _default as default };
+/** The values `format` puts into a message's ICU `MessageFormat` placeholders, by placeholder name. */
+export type FormatVars = Record<string, string | number | boolean | Date>;
+/** Where an addon's translations live: the codes its manifest lists, and how to read one. */
+export type LocaleSource = {
+	/** The addon's id, named in errors. */
+	owner: string;
+	/** Every locale the addon ships beside its bundle, en-US aside. */
+	codes: readonly string[];
+	/** Reads one locale's JSON, such as from `<addon folder>/i18n/<code>.json`. */
+	read: (code: string) => Promise<string>;
+};
+/** One locale's messages, keyed by message key. */
+export type LocaleStrings = Record<string, string>;
 
 export {};

package/src/iconPacks.d.ts

@@ -0,0 +1,43 @@
+// Auto-generated by generate-plugin-sdk.ts - DO NOT EDIT
+
+import type { AddonHandle, PushedManifest } from './_internal';
+/** Disables an icon pack and restores the default icons. */
+export declare const disable: (id: string) => void;
+/** Enables an icon pack and applies it. */
+export declare const enable: (id: string) => void | Promise<void>;
+/** Reads one installed icon pack by id. */
+export declare const get: (id: string) => AddonHandle | undefined;
+/** Lists every installed icon pack. */
+export declare const getAll: () => AddonHandle[];
+/** Installs an icon pack from its manifest URL. */
+export declare const install: (url: string, digest?: string) => Promise<AddonHandle | undefined>;
+/** Reports whether an icon pack is enabled. */
+export declare const isEnabled: (id: string) => boolean;
+/** Swaps an icon pack's files in place, keeping its enabled state. */
+export declare const reload: (
+	id: string,
+	bundle: string,
+	manifest: PushedManifest,
+	bytecode?: string,
+) => Promise<ReloadResult>;
+/** Enables a disabled icon pack, or disables an enabled one. */
+export declare const toggle: (id: string) => void;
+/** Removes an installed icon pack. */
+export declare const uninstall: (id: string) => Promise<void>;
+/**
+ * @description Checks for updates, then applies this icon pack's pending update.
+ * @param id The icon pack's id.
+ * @returns Whether the icon pack now runs a newer version.
+ */
+export declare function update(id: string): Promise<boolean>;
+/** The outcome of an addon reload: success, or failure carrying the recorded error. */
+export type ReloadResult =
+	| {
+			ok: true;
+	  }
+	| {
+			ok: false;
+			error: Error;
+	  };
+
+export {};

package/src/index.d.ts

@@ -1,11 +1,27 @@
 // Auto-generated by generate-plugin-sdk.ts - DO NOT EDIT
 
+/// <reference path="../ambient/image-modules.d.ts" />
+
 export * as assets from './assets';
+export * as builtins from './builtins';
+export * as commands from './commands';
+export * as dialogs from './dialogs';
+export * as flux from './flux';
+export * as fonts from './fonts';
 export * as fs from './fs';
 export * as i18n from './i18n';
+export * as iconPacks from './iconPacks';
+export * as marketplace from './marketplace';
 export * as metro from './metro/index';
 export * as native from './native';
 export * as patcher from './patcher';
+export * as plugins from './plugins';
 export * as settings from './settings';
+export * as shims from './shims';
 export * as storage from './storage';
+export * as sync from './sync';
+export * as themes from './themes';
 export * as toasts from './toasts';
+export * as ui from './ui';
+export * as updates from './updates';
+export * as utils from './utils/index';

package/src/marketplace.d.ts

@@ -0,0 +1,50 @@
+// Auto-generated by generate-plugin-sdk.ts - DO NOT EDIT
+
+import type { AddonAuthor, AddonKind } from './_internal';
+/**
+ * @description Installs the latest version of a marketplace addon, with the plugins it depends on once the user agrees.
+ * @param id The addon's id in the catalog.
+ * @returns Whether the addon now runs that version.
+ */
+export declare function install(id: string): Promise<boolean>;
+/**
+ * @description Fetches the marketplace catalog if it changed. Concurrent calls share one request.
+ * @returns Whether the server could be reached.
+ */
+export declare function refresh(): Promise<boolean>;
+/**
+ * @description Lists the catalog's addons of one type that match a query.
+ * @param query The addon type, an optional search text and the sort order.
+ * @returns The matching addons, or none while the catalog has not loaded.
+ */
+export declare function search(query: CatalogQuery): MarketplaceListing[];
+/** What `marketplace.search` filters the catalog by. */
+export type CatalogQuery = {
+	/** Only addons of this kind are returned. */
+	type: AddonKind;
+	/** Matches the name, description, authors or id, case-insensitively. */
+	search?: string;
+	/** The result order; `name` when omitted. */
+	sort?: CatalogSort;
+};
+/** `name` sorts alphabetically, `updated` puts the most recently published versions first. */
+export type CatalogSort = 'name' | 'updated';
+/** One addon the marketplace lists, at its newest version. */
+export type MarketplaceListing = {
+	/** The addon's id from its manifest, which installs and updates key on. */
+	id: string;
+	/** Whether the addon is a plugin, theme, icon pack or font. */
+	type: AddonKind;
+	/** The catalog's display name, or the newest version's manifest name when the catalog has none. */
+	name: string;
+	/** The catalog's description, or the newest version's manifest description when the catalog has none. */
+	description: string;
+	/** The authors listed in the newest version's manifest. */
+	authors: AddonAuthor[];
+	/** The newest published version. */
+	version: string;
+	/** When the newest version was published, as an ISO 8601 date-time. */
+	publishedAt: string;
+};
+
+export {};

package/src/metro/api.d.ts

@@ -1,10 +1,20 @@
 // Auto-generated by generate-plugin-sdk.ts - DO NOT EDIT
 
+/** Discord's action sheet module, with `openLazy` and `hideActionSheet`; found on first access. */
+export declare const ActionSheets: any;
+/** Discord's module with `fetchProfile`, which loads a user's profile from the API; found on first access. */
 export declare const AsyncUsers: any;
+/** Discord's invite actions module, with `acceptInviteAndTransitionToInviteChannel`; found on first access. */
 export declare const Invites: any;
+/** Discord's link opener module, with `openURL` and `openSettings`; found on first access. */
 export declare const Linking: any;
+/** Discord's message actions module, with `sendMessage` and `receiveMessage`; found on first access. */
 export declare const Messages: any;
+/** Discord's module with `openOAuth2Modal`, which opens the app authorize screen; found on first access. */
 export declare const OAuth2: any;
+/** Discord's module with `showUserProfile`, which opens a user's profile; found on first access. */
 export declare const Profiles: any;
+/** Discord's user profile action sheet helpers, such as `getUserProfileActionSheetKey`; found on first access. */
+export declare const UserProfiles: any;
 
 export {};

package/src/metro/common.d.ts

@@ -1,26 +1,55 @@
 // Auto-generated by generate-plugin-sdk.ts - DO NOT EDIT
 
+export type { MarkdownParserModule, SimpleMarkdownModule } from '../_internal';
+import type { MarkdownParserModule, SimpleMarkdownModule } from '../_internal';
+import * as React$1 from 'react';
+import { ReactNode } from 'react';
+import { ImageProps, ImageURISource } from 'react-native';
+
+/** Discord's clipboard module, which reads and writes strings and images; found on first access. */
 declare const Clipboard$1: any;
 declare const React$1: typeof import('react');
+/** The React Native instance Discord bundles, read from `window.ReactNative`. */
 declare const ReactNative$1: typeof import('react-native');
+/** React Native's asset registry, with `registerAsset`; found on first access. */
 export declare const Assets: any;
+/** Discord's module with `createBotMessage`, which builds a local message from Clyde; found on first access. */
 export declare const Clyde: any;
+/** Discord's slash command module, with `getBuiltInCommands`; found on first access. */
 export declare const Commands: any;
+/** Discord's constants module, with `Fonts`, `Endpoints` and more; found on first access. */
 export declare const Constants: any;
-export declare const Dispatcher: any;
-export declare const Flux: any;
-export declare const FluxHooks: any;
+/** Discord's copy of `react-native-gesture-handler`; found on first access. */
 export declare const Gestures: any;
-export declare const MarkdownParser: any;
+/** React Native's image source resolver; patching it changes the source every `Image` renders. */
+export declare const ImageSources: ImageSourcesModule;
+/** Discord's markdown parser, which turns message text into an AST or React nodes; found on first access. */
+export declare const MarkdownParser: MarkdownParserModule;
+/** Discord's copy of Moment.js; found on first access. */
 export declare const Moment: any;
+/** Discord's HTTP client for its API, with `getAPIBaseURL`; found on first access. */
 export declare const REST: any;
+/** Discord's module exporting its `Radius` corner radius tokens; found on first access. */
 export declare const Radius: any;
+/** Discord's copy of `react-native-reanimated`; found on first access. */
 export declare const Reanimated: any;
+/** Discord's copy of `react-native-svg`, with `Svg` and `Path`; found on first access. */
 export declare const SVG: any;
+/** Discord's copy of `react-native-screens`, with `FullWindowOverlay`; found on first access. */
 export declare const Screens: any;
+/** Discord's copy of `simple-markdown`, whose block rules parse whole documents; found on first access. */
+export declare const SimpleMarkdown: SimpleMarkdownModule;
+/** Discord's design tokens, with `colors` and `internal`; found on first access. */
+export declare const Theme: any;
+/** Discord's `util` module, with `inspect` for printing values; found on first access. */
 export declare const Util: any;
+/** Discord's localisation module, with `getLanguages`, `getSystemLocale` and `intl`; found on first access. */
 export declare const i18n: any;
-
+/** React Native's `ImageSourceUtils`, which every `Image` render resolves its source through. */
+export type ImageSourcesModule = {
+	/** Resolves the source or sources an `Image` with these props loads, or `null` for none. */
+	getImageSourcesFromImageProps: (props: ImageProps) => ImageURISource | ImageURISource[] | null;
+};
 export { Clipboard$1 as Clipboard, React$1 as React, ReactNative$1 as ReactNative };
 
 export {};

package/src/metro/components.d.ts

@@ -1,26 +1,110 @@
 // Auto-generated by generate-plugin-sdk.ts - DO NOT EDIT
 
-export type { DesignModule, SwitchProps } from '../_internal';
-import type { DesignModule, SwitchProps } from '../_internal';
-import * as ReactModule from 'react';
-import { ComponentType, ReactNode } from 'react';
-import {
-	AccessibilityState,
-	ImageStyle,
-	PressableProps,
-	StyleProp,
-	TextInputProps as RNTextInputProps,
-	TextStyle,
-	ViewProps,
-	ViewStyle,
-} from 'react-native';
+export type { DesignComponentName, DesignModule } from '../_internal';
+export { DESIGN_COMPONENTS } from '../_internal';
+import type { DesignComponentName, DesignModule } from '../_internal';
+import * as React$1 from 'react';
+import { ComponentProps, ComponentType, ElementType, FunctionComponent, ReactNode } from 'react';
+import * as RN from 'react-native';
+import { ColorValue, ImageStyle, TextStyle, ViewStyle } from 'react-native';
+
+/** The `messageType` values for `HelpMessage`, from Discord or else Unbound's fallback; `{}` when neither loads. */
+declare const HelpMessageTypes$1: any;
+declare const HelpMessageTypes: {
+	readonly 0: 'WARNING';
+	readonly 1: 'INFO';
+	readonly 2: 'ERROR';
+	readonly 3: 'SUCCESS';
+	readonly WARNING: 0;
+	readonly INFO: 1;
+	readonly ERROR: 2;
+	readonly SUCCESS: 3;
+};
+/** Discord's stacked avatar components, `AvatarPile` and `AvatarDuoPile`; found on first access. */
+export declare const AvatarPiles: any;
+/** Discord's avatar module, with `Avatar` and `AvatarSizes`; found on first access. */
+export declare const Avatars: any;
+/** Discord's blur backdrop components, with `BackgroundBlurFill`; found on first access. */
 export declare const BackdropFilters: any;
+/** Discord's bottom sheet components, with `ActionSheet` and `BottomSheetTitleHeader`; found on first access. */
+export declare const BottomSheets: any;
+/** Discord's default avatar images, `DEFAULT_AVATARS` and `DEFAULT_AVATARS_SMALL`; found on first access. */
+export declare const DefaultAvatars: any;
+/** Discord's design module, with Unbound's fallbacks standing in for components a build lacks. */
 export declare const Discord: DesignModule;
+/** Discord's copy of Shopify's `FlashList` module; found on first access. */
 export declare const FlashList: any;
+/** Discord's legacy form components, such as `FormRow` and `FormSection`; `{}` on builds without them. */
 export declare const Forms: any;
-export declare const HelpMessage: any;
+/** The `@gorhom/bottom-sheet` Discord bundles, whose `BottomSheetScrollView` scrolls inside a `scrollable` sheet; found on first access. */
+export declare const GorhomSheet: any;
+/** Discord's media viewer module, with `openMediaModal`; found on first access. */
 export declare const Media: any;
+/** Discord's portal components, `Portal` and `PortalHost`, for rendering outside the tree; found on first access. */
 export declare const Portal: any;
+/** Discord's safe area components, with `SafeAreaPaddingView`; found on first access. */
 export declare const SafeArea: any;
-export declare const Switch: ReactModule.ComponentType<SwitchProps>;
+/** `react-native-safe-area-context`, with `useSafeAreaInsets`; found on first access. */
+export declare const SafeAreaContext: any;
+/** Discord's `TableRowDivider`, the hairline `TableRowGroup` draws between rows; found on first access. */
+export declare const TableRowDividers: any;
+/** Discord's video player module, with `VideoComponent` and `createVideoControls`; found on first access. */
+export declare const Video: any;
+/**
+ * @description Discord's help message, or Unbound's own on Discord builds that no longer ship one, picked on first render.
+ * @param props The message, its type, text styling, corner radius and an optional trailing button.
+ * @returns The help message element.
+ */
+export declare function HelpMessage(
+	props: HelpMessageProps,
+): import('react').ReactElement<
+	HelpMessageProps,
+	string | import('react').JSXElementConstructor<any>
+>;
+/**
+ * @description Discord's switch, or its form switch, or React Native's, picked on first render.
+ * @param props The switch props.
+ * @returns The switch element.
+ */
+export declare function Switch(
+	props: SwitchProps,
+): import('react').ReactElement<SwitchProps, string | import('react').JSXElementConstructor<any>>;
+/**
+ * @description Tells whether a value can be rendered as a React element type: a function or class
+ * component, or a `memo`/`forwardRef`/`lazy` object.
+ * @param value The value to check.
+ * @returns Whether React can render it.
+ */
+export declare function isRenderable(value: unknown): value is React$1.ElementType;
+/**
+ * @description Registers the component the design module returns when a Discord build lacks the
+ * named one or ships something React can't render.
+ * @param name The design component to stand in for.
+ * @param component The fallback.
+ */
+export declare function registerDesignFallback<K extends DesignComponentName>(
+	name: K,
+	component: DesignModule[K],
+): void;
+/** Props for `HelpMessage`; the defaults named here are those of Unbound's fallback. */
+export type HelpMessageProps = {
+	/** The message; a string or number is rendered as text, any other node as given. */
+	children?: React$1.ReactNode;
+	/** A `HelpMessageTypes` value that picks the icon and feedback colors; `WARNING` when omitted. */
+	messageType?: HelpMessageType;
+	/** Discord's text variant for string children; `text-sm/medium` when omitted. */
+	textVariant?: string;
+	/** The color of string children; the theme's default text color when omitted. */
+	textColor?: ColorValue;
+	/** The corner radius in density-independent pixels; `8` when omitted. */
+	borderRadius?: number;
+	/** A node, usually a button, rendered after the message. */
+	button?: React$1.ReactNode;
+};
+/** A `HelpMessage` style: one of the `HelpMessageTypes` values. */
+export type HelpMessageType = (typeof HelpMessageTypes)[keyof typeof HelpMessageTypes & string];
+/** The props of Discord's `FormSwitch`, which the switch fallback accepts. */
+export type SwitchProps = React$1.ComponentProps<DesignModule['FormSwitch']>;
+export { HelpMessageTypes$1 as HelpMessageTypes };
+
 export {};

package/src/metro/filters.d.ts

@@ -1,15 +1,19 @@
 // Auto-generated by generate-plugin-sdk.ts - DO NOT EDIT
 
-import type { PredicateResult } from '../utils';
+import type { PredicateResult } from '../_types';
 declare const CACHE_KEY: unique symbol;
-declare const _default: {
-	byProps: typeof byProps;
-	byDisplayName: typeof byDisplayName;
-	byPrototypes: typeof byPrototypes;
-	byName: typeof byName;
-	byStore: typeof byStore;
-	byFilePath: typeof byFilePath;
-};
+/**
+ * @description Builds a filter matching a module every part matches, testing the parts in order.
+ * @param parts The filters to combine; none may be a raw filter such as `byFilePath`.
+ * @returns A {@link MetroFilter} keyed by its parts' keys in any order, or unkeyed when a part is.
+ */
+export declare function all(...parts: MetroFilter[]): MetroFilter;
+/**
+ * @description Builds a filter matching a module any part matches, testing the parts in order.
+ * @param parts The filters to combine; none may be a raw filter such as `byFilePath`.
+ * @returns A {@link MetroFilter} keyed by its parts' keys in any order, or unkeyed when a part is.
+ */
+export declare function any(...parts: MetroFilter[]): MetroFilter;
 /**
  * @description Builds a filter matching a module whose `displayName` equals the given name.
  * @param name The `displayName` the module must have.
@@ -22,6 +26,13 @@ export declare function byDisplayName(name: string): MetroFilter;
  * @returns A {@link MetroFilter} matching the module loaded from that file path.
  */
 export declare function byFilePath(path: string): MetroFilter;
+/**
+ * @description Builds a filter matching a flux store by name, appending `Store` when `short` is set.
+ * @param name The store name to match against.
+ * @param short Whether to append `Store` to `name` before matching.
+ * @returns A {@link MetroFilter} matching the flux store with that name.
+ */
+export declare function byFluxStore(name: string, short?: boolean): MetroFilter;
 /**
  * @description Builds a filter matching a module whose `name` equals the given name.
  * @param name The `name` the module must have.
@@ -41,17 +52,21 @@ export declare function byProps(...props: string[]): MetroFilter;
  */
 export declare function byPrototypes(...prototypes: string[]): MetroFilter;
 /**
- * @description Builds a filter matching a flux store by name, appending `Store` when `short` is set.
- * @param name The store name to match against.
- * @param short Whether to append `Store` to `name` before matching.
- * @returns A {@link MetroFilter} matching the flux store with that name.
+ * @description Builds a filter matching a wrapped component, like one from `React.memo`, whose inner `type` has the given name.
+ * @param name The `name` of the wrapped component's `type`.
+ * @returns A {@link MetroFilter} matching the module whose `type` has that name.
+ */
+export declare function byTypeName(name: string): MetroFilter;
+/**
+ * @description Builds a filter matching a module the given filter does not match.
+ * @param part The filter to negate; it may not be a raw filter such as `byFilePath`.
+ * @returns A {@link MetroFilter} keyed by the part's key, or unkeyed when the part is.
  */
-export declare function byStore(name: string, short?: boolean): MetroFilter;
+export declare function not(part: MetroFilter): MetroFilter;
 /** A module predicate, carrying its cache key and a `raw` flag, produced by every `by*` helper. */
 export type MetroFilter = ((mdl: any, id: number | string) => PredicateResult) & {
 	[CACHE_KEY]?: string;
 	isRaw?: boolean;
+	filePath?: string;
 };
-export { _default as default };
-
 export {};