@unbound-app/api 0.11.0 → 1.1.0

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,12 +1,14 @@
 // Auto-generated by generate-plugin-sdk.ts - DO NOT EDIT
 
-export type { DESIGN_COMPONENTS, DesignComponentName, DesignModule } from '../_internal';
-import type { DesignComponentName, DesignModule, FormsFormSwitchProps } from '../_internal';
+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, ReactNode } 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';
@@ -18,18 +20,36 @@ declare const HelpMessageTypes: {
 	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;
+/** 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;
+/** `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.
@@ -48,28 +68,14 @@ export declare function HelpMessage(
  */
 export declare function Switch(
 	props: SwitchProps,
-): import('react').ReactElement<
-	FormsFormSwitchProps,
-	string | import('react').JSXElementConstructor<any>
->;
-/**
- * @description Checks every design component the SDK exposes against the running Discord build.
- * @returns The components Discord renders itself, the ones a fallback stands in for, and the ones nothing renders.
- */
-export declare function auditDesignComponents(): DesignComponentAudit;
+): 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:
-		| DesignModule[keyof DesignModule]
-		| React$1.ElementType
-		| Record<string, React$1.ComponentType<never>>
-		| undefined,
-): value is React$1.ElementType;
+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.
@@ -80,21 +86,24 @@ export declare function registerDesignFallback<K extends DesignComponentName>(
 	name: K,
 	component: DesignModule[K],
 ): void;
-/** How each design component resolves on the running Discord build. */
-export type DesignComponentAudit = {
-	native: DesignComponentName[];
-	fallback: DesignComponentName[];
-	missing: DesignComponentName[];
-};
+/** 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 };
 

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 {};