@unbound-app/api 0.9.0 → 1.1.0

package/src/global.d.ts

@@ -1,126 +1,527 @@
 // Auto-generated by generate-plugin-sdk.ts - DO NOT EDIT
 
+/// <reference path="../ambient/image-modules.d.ts" />
+
 export type {
-	ADDON_TYPES,
+	ADDON_KINDS,
+	ADDON_SCOPE_GLOBALS,
+	AIGlyphTextProps,
+	AILoaderComponent,
+	AILoaderProps,
+	AIShimmerComponent,
+	AIShimmerInnerProps,
+	AIShimmerProps,
+	AccessibilityAnnouncerLiveRegionComponent,
+	AccessibilityAnnouncerLiveRegionProps,
+	AccessibilityViewComponent,
+	AccessibilityViewProps,
+	ActionSheetCloseButtonComponent,
+	ActionSheetCloseButtonProps,
+	ActionSheetComponent,
+	ActionSheetHeaderBarComponent,
+	ActionSheetHeaderBarProps,
+	ActionSheetHeaderPressableTextComponent,
+	ActionSheetHeaderPressableTextProps,
+	ActionSheetIconHeaderComponent,
+	ActionSheetIconHeaderProps,
+	ActionSheetPresenterComponent,
+	ActionSheetPresenterProps,
 	ActionSheetProps,
+	ActionSheetRowComponent,
+	ActionSheetRowGroupComponent,
+	ActionSheetRowGroupProps,
+	ActionSheetRowIconComponent,
+	ActionSheetRowIconProps,
 	ActionSheetRowProps,
-	Addon,
+	ActionSheetRowStatics,
+	ActionSheetSwitchRowComponent,
+	ActionSheetSwitchRowProps,
+	AddonAsset,
 	AddonAuthor,
+	AddonHandle,
+	AddonKind,
+	AddonLogger,
 	AddonManifest,
-	AddonResolveable,
-	AddonType,
+	AddonPlatform,
+	AddonPlatforms,
+	AddonTrust,
+	AlertActionButtonComponent,
 	AlertActionButtonProps,
+	AlertActionsProps,
+	AlertModalComponent,
+	AlertModalContainerComponent,
+	AlertModalContainerProps,
 	AlertModalProps,
+	AssetName,
+	AssetType,
 	AssetsModule,
-	ButtonComponent,
-	ButtonProps,
-	ButtonSize,
-	ButtonVariant,
-	CardProps,
-	CheckboxProps,
-	ContextMenuItem,
+	AuthoredAddonManifest,
+	AvatarDuoPileComponent,
+	AvatarDuoPileProps,
+	AvatarPileComponent,
+	AvatarPileProps,
+	BackdropComponent,
+	BackdropProps,
+	BackgroundBlurFillProps,
+	BackgroundBlurFillWithPressProps,
+	BackgroundBlurViewComponentComponent,
+	BackgroundBlurViewComponentProps,
+	BadgeProps,
+	BadgeVariant,
+	BaseIconButtonProps,
+	BaseNavigationContainerProps,
+	BaseTextButtonComponent,
+	BaseTextButtonIconProps,
+	BaseTextButtonProps,
+	BaseTextButtonStatics,
+	BaseTextFieldProps,
+	BottomSheetBackdropComponentProps,
+	BottomSheetTextInputComponent,
+	BottomSheetTextInputProps,
+	BottomSheetTitleHeaderComponent,
+	BottomSheetTitleHeaderProps,
+	ButtonBaseButtonProps,
+	ButtonEllipsisComponent,
+	ButtonEllipsisProps,
+	ButtonGroupComponent,
+	ButtonGroupProps,
+	ButtonIconButtonComponent,
+	ButtonIconButtonProps,
+	ButtonPillProps,
+	ButtonSchema,
+	ButtonShineProps,
+	CORE_SETTINGS_STORE,
+	Callback,
+	CameraLottieComponent,
+	CameraLottieProps,
+	ChoiceSettingSchema,
+	CoachmarkComponent,
+	CoachmarkProps,
+	CollapsingTextProps,
+	ContextMenuComponent,
+	ContextMenuContainerComponent,
+	ContextMenuContainerProps,
 	ContextMenuProps,
 	CreateStyles,
+	DESIGN_COMPONENTS,
+	DesignActivityIndicatorComponent,
+	DesignActivityIndicatorProps,
+	DesignBarrelComponents,
+	DesignCardComponent,
+	DesignCardProps,
+	DesignCheckboxComponent,
+	DesignCheckboxProps,
+	DesignComponentName,
+	DesignComponents,
+	DesignHelpers,
+	DesignModalComponent,
+	DesignModalProps,
 	DesignModule,
+	DesignRowGroupComponent,
+	DesignRowGroupProps,
+	DesignTextComponent,
+	DesignTextInputComponent,
+	DesignTextInputProps,
+	DesignTextProps,
+	DialogComponent,
+	DialogProps,
+	DisableCustomThemeComponent,
+	DisableCustomThemeProps,
 	DiscordAsset,
+	DiscordAssetName,
+	DiscordAssetNames,
+	DiscordAssetType,
 	DiscordFunction,
+	DiscordIconProps,
+	DiscordIconSize,
+	DurationUnit,
+	EllipsisCircleProps,
+	EntityDisplay,
 	EnumLike,
+	ErrorTextProps,
+	ExpressiveGradientComponent,
+	ExpressiveGradientProps,
+	FauxHeaderComponent,
+	FauxHeaderProps,
+	FloatingActionButtonComponent,
 	FloatingActionButtonProps,
-	FontDescriptor,
 	FontEntity,
+	FormLabelProps,
+	FormRowProps,
+	FormSubLabelProps,
+	FormsFormCheckboxComponent,
+	FormsFormCheckboxProps,
+	FormsFormRadioComponent,
+	FormsFormRadioProps,
+	FormsFormSwitchComponent,
+	FormsFormSwitchProps,
+	GhostInputComponent,
 	GhostInputProps,
-	IconButtonProps,
+	GlyphBandProps,
+	GuildIconPileComponent,
+	GuildIconPileProps,
+	HeaderActionButtonComponent,
+	HeaderActionButtonProps,
+	HeaderBackImageComponent,
+	HeaderBackImageProps,
+	HeaderSubmittingIndicatorComponent,
+	HeaderSubmittingIndicatorProps,
+	IconInput,
 	IconPack,
 	IconPackManifest,
-	IconSlot,
-	InputSize,
-	InputStatus,
+	ImageButtonComponent,
+	ImageButtonProps,
+	InlineNoticeComponent,
+	InlineNoticeProps,
+	InputComponent,
+	InputFieldContainerComponent,
+	InputFieldContainerProps,
+	InputProps,
+	InputTextInputProps,
 	InternalToastOptions,
+	LayerScopeComponent,
+	LayerScopeProps,
+	LoaderObjCBridge,
+	LoadingButtonPillProps,
+	LooseComponent,
+	LooseModule,
+	LoosePropValue,
+	LooseProps,
+	LottieIconProps,
+	ManaContextProviderComponent,
+	ManaContextProviderProps,
+	MarkdownNestedParse,
+	MarkdownNode,
+	MarkdownOutput,
+	MarkdownParserModule,
+	MarkdownReactParser,
+	MarkdownRule,
+	MarkdownRules,
+	MarkdownState,
+	MenuComponent,
+	MenuGroupComponent,
+	MenuGroupProps,
+	MenuItemComponent,
+	MenuItemProps,
+	MenuPopoutComponent,
+	MenuPopoutProps,
+	MenuProps,
+	MessageRequestLottieComponent,
+	MessageRequestLottieProps,
+	MessagesTabLottieComponent,
+	MessagesTabLottieProps,
+	MicrophoneLottieComponent,
+	MicrophoneLottieProps,
+	ModalActionButtonComponent,
+	ModalActionButtonProps,
+	ModalContentComponent,
+	ModalContentProps,
+	ModalDisclaimerComponent,
+	ModalDisclaimerProps,
+	ModalFloatingActionComponent,
+	ModalFloatingActionProps,
+	ModalFloatingActionSpacerComponent,
+	ModalFloatingActionSpacerProps,
+	ModalFooterComponent,
+	ModalFooterProps,
+	ModalScreenComponent,
+	ModalScreenProps,
+	ModalStepIndicatorComponent,
+	ModalStepIndicatorProps,
 	NATIVE_PLUGIN_CAPABILITIES,
+	NATIVE_PLUGIN_METHOD_CAPABILITIES,
+	NATIVE_PLUGIN_PLATFORMS,
+	NATIVE_PLUGIN_PLATFORM_CAPABILITIES,
+	NEWER_DESIGN_COMPONENTS,
+	NativeAddonVerification,
+	NativeAndroidInstallPhase,
+	NativeAndroidInstallProgress,
+	NativeAndroidInstallSplit,
+	NativeAndroidInstallerAvailability,
+	NativeAndroidInstallerStatus,
 	NativeAssociationKey,
+	NativeBatchReference,
+	NativeBatchStep,
 	NativeCallOptions,
+	NativeCancelablePromise,
 	NativeClassHandle,
+	NativeCompiledPlugin,
+	NativeCrashPhase,
+	NativeCrashedAddon,
+	NativeDebugBridge,
+	NativeDebugEnvironment,
+	NativeDebugEnvironmentOptions,
+	NativeDebugEvaluation,
+	NativeDebugEvaluationLog,
 	NativeFFIBridge,
 	NativeFFISignature,
 	NativeFFIType,
 	NativeFFITypeName,
 	NativeFabricBridge,
 	NativeFabricFrame,
+	NativeFabricMountOptions,
 	NativeFabricSize,
 	NativeFabricSurface,
+	NativeFontEntry,
+	NativeFontSource,
+	NativeGarbageCollection,
 	NativeHandle,
 	NativeHookContext,
 	NativeHookHandlers,
 	NativeHookOptions,
+	NativeHookPayload,
 	NativeHookToken,
+	NativeJavaArgument,
+	NativeJavaAssociationKey,
+	NativeJavaBatchOperation,
+	NativeJavaBridge,
+	NativeJavaCallPlan,
+	NativeJavaClassDescription,
+	NativeJavaFieldDescription,
+	NativeJavaHandle,
+	NativeJavaHandleValue,
+	NativeJavaHookEvent,
+	NativeJavaHookOptions,
+	NativeJavaHookToken,
+	NativeJavaHooksBridge,
+	NativeJavaMethodDescription,
+	NativeJavaReference,
+	NativeJavaValue,
+	NativeMainWaitCounts,
+	NativeMainWorkCounts,
 	NativeObjCBridge,
+	NativeObjCCallPlan,
+	NativeObjCResult,
 	NativeObjectHandle,
+	NativePlatformAddons,
+	NativePlatformAndroidBridge,
+	NativePlatformAndroidInstaller,
 	NativePlatformApp,
 	NativePlatformBridge,
+	NativePlatformCrashGuard,
 	NativePlatformDevice,
+	NativePlatformFiles,
+	NativePlatformFonts,
+	NativePlatformIOSBridge,
+	NativePlatformProfiler,
+	NativePlatformSettings,
 	NativePluginBridge,
 	NativePluginCapability,
 	NativePluginError,
 	NativePluginErrorCode,
+	NativePluginMethod,
+	NativePluginNamespace,
+	NativePluginPlatform,
+	NativePluginPlatformCapability,
+	NativePluginRuntimeBridge,
 	NativePointer,
+	NativeResourceCounts,
+	NativeRuntimeBridge,
+	NativeRuntimeEventName,
+	NativeRuntimeEventToken,
 	NativeSerializable,
 	NativeSerializableObject,
+	NativeSettingsChange,
 	NativeStruct,
 	NativeStructField,
 	NativeStructFields,
 	NativeThreadPolicy,
+	NativeUIArgument,
+	NativeUIBridge,
+	NativeUICallback,
+	NativeUIScope,
+	NativeUIScopeFactory,
+	NativeViewSearchOptions,
+	NativeViewSnapshotNode,
+	NativeViewSnapshotOptions,
+	NavScrimComponent,
+	NavScrimProps,
 	Navigation,
+	NavigationContainerInnerProps,
 	NavigationOptions,
+	NavigationStackProps,
+	NavigatorComponent,
+	NavigatorHeaderComponent,
+	NavigatorHeaderProps,
+	NavigatorProps,
+	NavigatorScreenComponent,
+	NavigatorScreenProps,
+	NewInlineNoticeProps,
+	NewerDesignComponents,
+	NitroGem12LottieComponent,
+	NitroGem12LottieProps,
+	NitroGem15LottieComponent,
+	NitroGem15LottieProps,
+	NitroGem18LottieComponent,
+	NitroGem18LottieProps,
+	NitroGem1LottieComponent,
+	NitroGem1LottieProps,
+	NitroGem24LottieComponent,
+	NitroGem24LottieProps,
+	NitroGem2LottieComponent,
+	NitroGem2LottieProps,
+	NitroGem3LottieComponent,
+	NitroGem3LottieProps,
+	NitroGem6LottieComponent,
+	NitroGem6LottieProps,
+	NitroGem9LottieComponent,
+	NitroGem9LottieProps,
+	NoticeSchema,
+	NotificationsTabLottieComponent,
+	NotificationsTabLottieProps,
+	PileComponent,
+	PileOverflowComponent,
+	PileOverflowProps,
+	PileProps,
+	PillWrapperProps,
+	PlainTextExperimentProviderComponent,
+	PlainTextExperimentProviderProps,
 	Plugin,
 	PluginContext,
-	PluginEntity,
+	PluginSelfTestResult,
+	PostponeRenderProps,
+	PressableBaseProps,
+	PressableHighlightProps,
+	PressableOpacityProps,
+	Primitive,
+	PromoSheetComponent,
+	PromoSheetProps,
+	PushedManifest,
+	RedesignBottomSheetTitleHeaderBaseProps,
+	RedesignCompatComponent,
+	RedesignCompatProps,
 	ResolvedStyles,
+	RowButtonComponent,
 	RowButtonProps,
+	RowButtonStatics,
+	RowButtonWrapperProps,
+	SceneLoadingIndicatorComponent,
+	SceneLoadingIndicatorProps,
+	SearchFieldComponent,
+	SearchFieldProps,
+	SegmentedControlComponent,
 	SegmentedControlItem,
+	SegmentedControlItemProps,
+	SegmentedControlPagesComponent,
 	SegmentedControlPagesProps,
 	SegmentedControlProps,
 	SegmentedControlState,
 	SegmentedControlStateOptions,
+	SemanticColorToken,
+	ServerTabLottieComponent,
+	ServerTabLottieProps,
+	SettingChoice,
+	SettingCommon,
+	SettingCondition,
+	SettingPrimitive,
+	SettingSchema,
+	SettingValue,
 	SettingsEntry,
+	SettingsGroupSchema,
 	SettingsObject,
+	SettingsSchema,
 	SettingsScreen,
 	SettingsValue,
+	SheetBottomSheetComponent,
+	SheetBottomSheetProps,
+	ShimmerLayersProps,
+	ShimmerTextSlotProps,
+	SimpleActionSheetComponent,
+	SimpleActionSheetProps,
+	SimpleMarkdownModule,
+	SimpleMarkdownParser,
+	SliderComponent,
 	SliderProps,
+	SlotProps,
+	SplitTextFieldProps,
+	SplitTextInputComponent,
 	SplitTextInputProps,
+	StackComponent,
 	StackProps,
+	StepModalComponent,
+	StepModalProps,
+	StepPillProps,
+	StickyWrapperComponent,
+	StickyWrapperProps,
+	StorelessSchema,
+	StringDisplay,
+	StringSettingSchema,
 	StyleSheetSpec,
 	StyleSheetSpecOrFactory,
-	SwitchProps,
+	SubtitleProps,
+	TabItemCountProps,
+	TabItemProps,
+	TableCheckboxRowComponent,
 	TableCheckboxRowProps,
+	TableRadioGroupComponent,
 	TableRadioGroupProps,
+	TableRadioRowComponent,
 	TableRadioRowProps,
+	TableRowArrowComponent,
+	TableRowArrowProps,
 	TableRowComponent,
+	TableRowDividerProps,
+	TableRowGroupComponent,
 	TableRowGroupProps,
+	TableRowGroupTitleComponent,
 	TableRowGroupTitleProps,
+	TableRowIconComponent,
 	TableRowIconProps,
+	TableRowInnerProps,
 	TableRowProps,
+	TableRowStatics,
+	TableRowTrailingTextComponent,
+	TableRowTrailingTextProps,
+	TableSwitchRowComponent,
 	TableSwitchRowProps,
+	TabsComponent,
+	TabsProps,
+	TagGroupComponent,
+	TagGroupProps,
+	TextAreaComponent,
+	TextAreaFieldComponent,
+	TextAreaFieldProps,
 	TextAreaProps,
+	TextButtonIconComponent,
+	TextButtonIconProps,
+	TextFieldComponent,
 	TextFieldProps,
-	TextInputPassthrough,
-	TextInputProps,
-	TextProps,
+	TextHeadingComponent,
+	TextHeadingProps,
 	TextVariant,
 	TextWeight,
 	Theme,
-	ThemeEntity,
+	ThemeContextProviderRootThemeContextProviderComponent,
+	ThemeContextProviderRootThemeContextProviderProps,
+	ThemeProviderProps,
 	ThemeSemanticColor,
+	TitleProps,
 	ToastButton,
+	ToastComponent,
+	ToastContainerComponent,
+	ToastContainerProps,
+	ToastEntityContentProps,
+	ToastEntityProps,
 	ToastHandle,
 	ToastOptions,
+	ToastProps,
 	ToastStoreState,
-	TrailingTextProps,
+	ToggleIconButtonComponent,
+	ToggleIconButtonProps,
 	TransitionState,
+	UnboundAppIcon,
 	UnboundAsset,
+	UncertainValue,
+	VisualEffectViewProps,
+	VoidIconProps,
+	VoidTextInputProps,
+	WrappedNavigationStackProps,
+	YouTabLottieComponent,
+	YouTabLottieProps,
 } from './_internal';
-import type { NativePlatformBridge } from './_internal';
-import * as ReactModule from 'react';
-import * as ReactNativeModule from 'react-native';
+import type { AddonHandle, AddonLogger, NativePlatformBridge } from './_internal';
+import * as React$1 from 'react';
+import * as RN from 'react-native';
 
 declare global {
 	/**
@@ -129,26 +530,108 @@ declare global {
 	 */
 	var $$DEV$$: boolean;
 	var NativePlatform: NativePlatformBridge | undefined;
-	var React: typeof ReactModule;
-	var ReactNative: typeof ReactNativeModule;
+	/**
+	 * The message keys command text takes, one member per key. A plugin's generated `src/unbound-i18n.d.ts` fills it
+	 * from its `i18n/en-US.json` and the client from Unbound's; an interface so each declaration merges into it.
+	 */
+	// oxlint-disable-next-line typescript/consistent-type-definitions -- only an interface merges across files.
+	interface UnboundMessageKeys {}
+
+	var React: typeof React$1;
+	var ReactNative: typeof RN;
+}
+
+/** The globals a plugin runs with, keyed by name. Plugin code reads them without an import. */
+export type AddonScope = {
+	/** Discord's React, whose `createElement` keeps a reloaded plugin's components matched to their mounted ones. */ React: typeof React;
+	/** The Unbound API, with the `metro`, `storage`, `flux`, `patcher`, `commands`, `settings` and `assets` registrations scoped to this plugin, and `toasts`, `dialogs` and `i18n` reading its own messages. */ unbound: UnboundGlobal;
+	/** This plugin's handle: its manifest and state. */ addon: AddonHandle;
+	/** The patcher, tagging each patch with this plugin's id; Unbound removes them when it stops. */ patcher: UnboundGlobal['patcher'];
+	/** A logger that prefixes each line with this plugin's name. */ logger: AddonLogger;
+	/** `setTimeout`, cleared when this plugin stops. */ setTimeout: typeof setTimeout;
+	/** `setInterval`, cleared when this plugin stops. */ setInterval: typeof setInterval;
+	/** Clears a timer this plugin set with `setTimeout`. */ clearTimeout: typeof clearTimeout;
+	/** Clears a timer this plugin set with `setInterval`. */ clearInterval: typeof clearInterval;
+	/** The commands API, registering each command under this plugin's id; Unbound removes them when it stops. */ commands: Omit<
+		ReturnType<UnboundGlobal['commands']['createCommands']>,
+		keyof UnboundGlobal['commands']
+	> &
+		UnboundGlobal['commands'];
+};
+
+/** The lifecycle entry points, all the global `unbound` object keeps after {@link shutdown}. */
+export interface UnboundLifecycle {
+	/**
+	 * @description Brings up the client, initialising the built-ins, plugins, and themes managers in turn. Twin of
+	 * {@link shutdown}.
+	 */
+	initialize(): void;
+	/**
+	 * @description Tears the client back down, shutting down the built-ins, plugins, and themes managers and persisting
+	 * settings before clearing the global down to the lifecycle entry points. Twin of {@link initialize}.
+	 * @returns A promise that resolves once settings have been persisted and shutdown is complete.
+	 */
+	shutdown(): Promise<void>;
 }
 
-export interface UnboundGlobal {
+/** The global `unbound` object while the client is initialized: the API plus the lifecycle. */
+export interface UnboundGlobal extends UnboundLifecycle {
+	/** The `assets` module, which plugins also import from `@unbound-app/api/assets`. */
 	assets: typeof import('./assets.d.ts');
+	/** The `builtins` module, which plugins also import from `@unbound-app/api/builtins`. */
+	builtins: typeof import('./builtins.d.ts');
+	/** The `commands` module, which plugins also import from `@unbound-app/api/commands`. */
+	commands: typeof import('./commands.d.ts');
+	/** The `dialogs` module, which plugins also import from `@unbound-app/api/dialogs`. */
+	dialogs: typeof import('./dialogs.d.ts');
+	/** The `flux` module, which plugins also import from `@unbound-app/api/flux`. */
+	flux: typeof import('./flux.d.ts');
+	/** The `fonts` module, which plugins also import from `@unbound-app/api/fonts`. */
+	fonts: typeof import('./fonts.d.ts');
+	/** The `fs` module, which plugins also import from `@unbound-app/api/fs`. */
 	fs: typeof import('./fs.d.ts');
+	/** The `i18n` module, which plugins also import from `@unbound-app/api/i18n`. */
 	i18n: typeof import('./i18n.d.ts');
+	/** The `iconPacks` module, which plugins also import from `@unbound-app/api/iconPacks`. */
+	iconPacks: typeof import('./iconPacks.d.ts');
+	/** The `marketplace` module, which plugins also import from `@unbound-app/api/marketplace`. */
+	marketplace: typeof import('./marketplace.d.ts');
+	/** The `metro` module, which plugins also import from `@unbound-app/api/metro`. */
 	metro: typeof import('./metro/index.d.ts');
+	/** The `native` module, which plugins also import from `@unbound-app/api/native`. */
 	native: typeof import('./native.d.ts');
+	/** The `patcher` module, which plugins also import from `@unbound-app/api/patcher`. */
 	patcher: typeof import('./patcher.d.ts');
+	/** The `plugins` module, which plugins also import from `@unbound-app/api/plugins`. */
+	plugins: typeof import('./plugins.d.ts');
+	/** The `settings` module, which plugins also import from `@unbound-app/api/settings`. */
 	settings: typeof import('./settings.d.ts');
+	/** The `shims` module, which plugins also import from `@unbound-app/api/shims`. */
+	shims: typeof import('./shims.d.ts');
+	/** The `storage` module, which plugins also import from `@unbound-app/api/storage`. */
 	storage: typeof import('./storage.d.ts');
+	/** The `sync` module, which plugins also import from `@unbound-app/api/sync`. */
+	sync: typeof import('./sync.d.ts');
+	/** The `themes` module, which plugins also import from `@unbound-app/api/themes`. */
+	themes: typeof import('./themes.d.ts');
+	/** The `toasts` module, which plugins also import from `@unbound-app/api/toasts`. */
 	toasts: typeof import('./toasts.d.ts');
+	/** The `ui` module, which plugins also import from `@unbound-app/api/ui`. */
+	ui: typeof import('./ui.d.ts');
+	/** The `updates` module, which plugins also import from `@unbound-app/api/updates`. */
+	updates: typeof import('./updates.d.ts');
+	/** The `utils` module, which plugins also import from `@unbound-app/api/utils`. */
+	utils: typeof import('./utils/index.d.ts');
 }
 
 declare global {
 	interface Window {
-		unbound: UnboundGlobal;
+		unbound: UnboundGlobal | UnboundLifecycle;
 	}
 
-	const unbound: Window['unbound'];
+	const unbound: AddonScope['unbound'];
+	const addon: AddonScope['addon'];
+	const patcher: AddonScope['patcher'];
+	const logger: AddonScope['logger'];
+	const commands: AddonScope['commands'];
 }