@unbound-app/api 0.5.1 → 0.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@unbound-app/api",
-	"version": "0.5.1",
+	"version": "0.6.0",
 	"author": {
 		"name": "Mario P.",
 		"email": "contact@marioparaschiv.com",

package/src/_internal.d.ts

@@ -26,6 +26,7 @@ declare const TRANSITION_STATE_KEYS: readonly ['MOUNTED', 'ENTERED', 'YEETED'];
 export interface Addon {
 	started: boolean;
 	instance: any;
+	context?: PluginContext;
 	id: string;
 	failed: boolean;
 	data: AddonManifest;
@@ -50,6 +51,8 @@ export interface AddonManifest {
 	folder: string;
 	path: string;
 	url: string;
+	capabilities?: NativePluginCapability[];
+	minNativePluginApi?: string;
 }
 /** The native module used to register and resolve {@link DiscordAsset}s by id. */
 export interface AssetsModule {
@@ -188,6 +191,146 @@ export interface InternalToastOptions extends ToastOptions {
 	closing?: boolean;
 	date?: number;
 }
+export interface NativeCallOptions {
+	thread?: NativeThreadPolicy;
+}
+export interface NativeFFIBridge {
+	symbol(name: string, image?: string): NativePointer | null;
+	call(pointer: NativePointer, signature: NativeFFISignature, ...args: unknown[]): unknown;
+}
+export interface NativeFFISignature {
+	returnType: NativeFFIType;
+	args: NativeFFIType[];
+}
+export interface NativeFabricBridge {
+	mount(
+		container: NativeObjectHandle,
+		moduleName: string,
+		properties?: Record<string, unknown>,
+	): NativeFabricSurface;
+	update(surface: NativeFabricSurface, properties: Record<string, unknown>): void;
+	setSize(
+		surface: NativeFabricSurface,
+		minimumSize: NativeFabricSize,
+		maximumSize: NativeFabricSize,
+	): void;
+	setFrame(surface: NativeFabricSurface, frame: NativeFabricFrame): void;
+	measure(view: NativeObjectHandle): NativeFabricFrame;
+	unmount(surface: NativeFabricSurface): void;
+}
+export interface NativeFabricFrame {
+	x: number;
+	y: number;
+	width: number;
+	height: number;
+}
+export interface NativeFabricSize {
+	width: number;
+	height: number;
+}
+export interface NativeHookContext {
+	self: NativeObjectHandle;
+	selector: string;
+	args: unknown[];
+	original: (...args: unknown[]) => unknown;
+	replaceObjectArgument(index: number, value: NativeObjectHandle | null): void;
+}
+export interface NativeHookHandlers {
+	before?: (context: NativeHookContext) => void | Promise<void>;
+	after?: (context: NativeHookContext) => void | Promise<void>;
+	replace?: (context: NativeHookContext) => unknown;
+}
+export interface NativeHookOptions extends NativeCallOptions {
+	cacheOnly?: boolean;
+	instance?: NativeObjectHandle;
+	once?: boolean;
+}
+export interface NativeHookToken {
+	readonly active: boolean;
+	setReturnValue(self: NativeObjectHandle, args: unknown[], value: unknown): void;
+	removeReturnValue(self: NativeObjectHandle, args: unknown[]): void;
+	clearReturnValues(): void;
+	remove(): void;
+}
+export interface NativeObjCBridge {
+	getClass(name: string): NativeClassHandle | null;
+	alloc(classOrName: string | NativeClassHandle): NativeObjectHandle;
+	className(handle: NativeHandle): string | null;
+	respondsTo(handle: NativeHandle, selector: string): boolean;
+	call(handle: NativeHandle, selector: string, ...args: unknown[]): unknown;
+	callSuper(
+		handle: NativeObjectHandle,
+		currentClass: NativeClassHandle | string,
+		selector: string,
+		...args: unknown[]
+	): unknown;
+	invoke(
+		handle: NativeObjectHandle,
+		selector: string,
+		args: unknown[],
+		options?: NativeCallOptions,
+	): unknown;
+	invokeSuper(
+		handle: NativeObjectHandle,
+		currentClass: NativeClassHandle | string,
+		selector: string,
+		args: unknown[],
+		options?: NativeCallOptions,
+	): unknown;
+	getIvar(handle: NativeObjectHandle, name: string): unknown;
+	setIvar(handle: NativeObjectHandle, name: string, value: unknown): void;
+	createAssociationKey(): NativeAssociationKey;
+	getAssociatedObject(handle: NativeObjectHandle, key: NativeAssociationKey): unknown;
+	setAssociatedObject(
+		handle: NativeObjectHandle,
+		key: NativeAssociationKey,
+		value: unknown,
+		policy?: string,
+	): void;
+	struct<T extends object = Record<string, unknown>>(name: string, fields: T): NativeStruct<T>;
+	array(handle: NativeObjectHandle): unknown[];
+	data(value: ArrayBuffer | Uint8Array): NativeObjectHandle;
+	hook(
+		className: string,
+		selector: string,
+		handlers: NativeHookHandlers,
+		options?: NativeHookOptions,
+	): NativeHookToken;
+}
+export interface NativePlatformApp {
+	getAppSource(): string;
+}
+export interface NativePlatformBridge {
+	evaluateBytecode(bytecode: ArrayBuffer, tag?: string): unknown;
+	readonly device: NativePlatformDevice;
+	readonly app: NativePlatformApp;
+}
+export interface NativePlatformDevice {
+	getDeviceModel(): string;
+	getiOSVersionString(): string;
+	isJailbroken(): boolean;
+	isSystemApp(): boolean;
+	isVerifiedBuild(): boolean;
+	getEntitlements(): Record<string, any>;
+	getEntitlementsAsPlist(): string;
+}
+export interface NativePluginBridge {
+	readonly apiVersion: string;
+	readonly abiVersion: string;
+	readonly capabilities: readonly NativePluginCapability[];
+	readonly objc: NativeObjCBridge;
+	readonly ffi: NativeFFIBridge;
+	readonly fabric: NativeFabricBridge;
+}
+export interface NativePluginError {
+	code: NativePluginErrorCode;
+	message: string;
+	capability?: NativePluginCapability;
+}
+export interface NativeStruct<T extends object = Record<string, unknown>> extends NativeHandle {
+	readonly name: string;
+	readonly value?: T;
+}
 export interface Navigation<T = any> {
 	push: (route: string, params?: T) => void;
 	pop: () => void;
@@ -197,6 +340,13 @@ export interface Navigation<T = any> {
 	addListener: (event: string, callback: Fn) => Fn<void>;
 	[key: string]: any;
 }
+export interface PluginContext {
+	readonly manifest: AddonManifest;
+	readonly id: string;
+	readonly capabilities: readonly NativePluginCapability[];
+	readonly native: NativePluginBridge;
+	dispose(): void;
+}
 export interface RowButtonProps {
 	label?: ReactNode;
 	icon?: ReactNode;
@@ -536,6 +686,51 @@ export type IconSlot = ReactNode | ComponentType<any> | Fn<ReactNode>;
 export type InputSize = LiteralUnion<'sm' | 'md' | 'lg'>;
 /** Input status. `focused` is an internal state and is not user-settable. */
 export type InputStatus = LiteralUnion<'default' | 'error'>;
+export type NativeAssociationKey = NativeHandle;
+export type NativeClassHandle = NativeHandle;
+export type NativeFFIType =
+	| NativeFFITypeName
+	| {
+			struct: string;
+	  };
+export type NativeFFITypeName =
+	| 'void'
+	| 'bool'
+	| 'i8'
+	| 'u8'
+	| 'i16'
+	| 'u16'
+	| 'i32'
+	| 'u32'
+	| 'i64'
+	| 'u64'
+	| 'float'
+	| 'double'
+	| 'cstring'
+	| 'pointer'
+	| 'object'
+	| 'class'
+	| 'selector';
+export type NativeFabricSurface = NativeHandle;
+export type NativeHandle = object;
+export type NativeObjectHandle = NativeHandle;
+export type NativePluginCapability =
+	| 'native.objc.classes'
+	| 'native.objc.invoke'
+	| 'native.objc.ivars'
+	| 'native.objc.associations'
+	| 'native.objc.hooks'
+	| 'native.ffi.symbols'
+	| 'native.ffi.call'
+	| 'native.fabric.mount';
+export type NativePluginErrorCode =
+	| 'NATIVE_BRIDGE_ERROR'
+	| 'NATIVE_PLUGIN_API_VERSION_UNSUPPORTED'
+	| 'NATIVE_PLUGIN_CAPABILITY_DENIED'
+	| 'NATIVE_PLUGIN_SCOPE_DISPOSED'
+	| 'NATIVE_PLUGIN_UNAVAILABLE';
+export type NativePointer = NativeHandle;
+export type NativeThreadPolicy = 'current' | 'main';
 /** An {@link Addon} whose instance is a {@link Plugin}. */
 export type PluginEntity = Addon & {
 	instance: Plugin$1 | null;
@@ -621,7 +816,7 @@ export type UnboundAsset = DiscordAsset & {
 
 /** The lifecycle and settings contract implemented by a plugin. */
 interface Plugin$1 {
-	start?(): void;
+	start?(context?: PluginContext): void;
 	stop?(): void;
 	getSettingsPanel?(): ReactNode;
 }

package/src/global.d.ts

@@ -27,8 +27,37 @@ export type {
 	InputSize,
 	InputStatus,
 	InternalToastOptions,
+	NativeAssociationKey,
+	NativeCallOptions,
+	NativeClassHandle,
+	NativeFFIBridge,
+	NativeFFISignature,
+	NativeFFIType,
+	NativeFFITypeName,
+	NativeFabricBridge,
+	NativeFabricFrame,
+	NativeFabricSize,
+	NativeFabricSurface,
+	NativeHandle,
+	NativeHookContext,
+	NativeHookHandlers,
+	NativeHookOptions,
+	NativeHookToken,
+	NativeObjCBridge,
+	NativeObjectHandle,
+	NativePlatformApp,
+	NativePlatformBridge,
+	NativePlatformDevice,
+	NativePluginBridge,
+	NativePluginCapability,
+	NativePluginError,
+	NativePluginErrorCode,
+	NativePointer,
+	NativeStruct,
+	NativeThreadPolicy,
 	Navigation,
 	Plugin,
+	PluginContext,
 	PluginEntity,
 	ResolvedStyles,
 	RowButtonProps,
@@ -68,127 +97,15 @@ export type {
 	TransitionState,
 	UnboundAsset,
 } from './_internal';
-import type { ColorString } from './utils';
+import type { NativePlatformBridge } from './_internal';
 declare global {
-	/** A feature name published by the native module's capability table. */
-	type UnboundNativeFeature =
-		| 'device.info'
-		| 'device.entitlements'
-		| 'app.source'
-		| 'notifications'
-		| 'pip.video'
-		| 'chat.avatar'
-		| 'chat.messageBubbles'
-		| 'toolbox.menu'
-		| 'native.evaluateBytecode';
-	/**
-	 * The lifecycle status of a native feature on the running build. `unknown` and `unavailable`
-	 * both mean "do not call"; only `supported` and `deprecated` are safe.
-	 */
-	type UnboundNativeFeatureStatus =
-		| 'unknown'
-		| 'removed'
-		| 'deprecated'
-		| 'supported'
-		| 'unavailable';
-	/**
-	 * The full metadata record for a native feature. Everything but `name` and `known` is absent
-	 * when the feature is not in this build's table.
-	 */
-	type UnboundNativeFeatureInfo = {
-		name: string;
-		known: boolean;
-		status: UnboundNativeFeatureStatus;
-		supported?: boolean;
-		introducedIn?: string;
-		deprecatedIn?: string;
-		removedIn?: string;
-		replacement?: UnboundNativeFeature;
-	};
-	/** Hardware, OS, and install-integrity details for the device Unbound is running on. */
-	type UnboundNativeDevice = {
-		getModel(): string;
-		getiOSVersionString(): string;
-		isJailbroken(): boolean;
-		isSystemApp(): boolean;
-		isVerifiedBuild(): boolean;
-		getEntitlements(): Record<string, any>;
-		getEntitlementsAsPlist(): string;
-	};
-	/** How this copy of the app was installed. */
-	type UnboundNativeApp = {
-		getSource(): string;
-	};
-	/** Local notification scheduling. */
-	type UnboundNativeNotifications = {
-		show(
-			title?: string,
-			body?: string,
-			timeDelay?: number,
-			soundEnabled?: boolean,
-			identifier?: string,
-		): string;
-	};
-	/** Picture-in-picture video playback. */
-	type UnboundNativePiP = {
-		playVideo(url: string): string | null;
-	};
-	/**
-	 * Native chat appearance controls. The getters read synchronously; every setter hops to the
-	 * main queue and returns immediately, so a value read back on the next line may still be stale.
-	 */
-	type UnboundNativeChat = {
-		getAvatarCornerRadius(): number;
-		setAvatarCornerRadius(radius?: number): void;
-		resetAvatarCornerRadius(): void;
-		getMessageBubblesEnabled(): boolean;
-		getMessageBubbleLightColor(): ColorString;
-		getMessageBubbleDarkColor(): ColorString;
-		getMessageBubbleCornerRadius(): number;
-		setMessageBubblesEnabled(
-			enabled: boolean,
-			lightColor?: ColorString,
-			darkColor?: ColorString,
-		): void;
-		setMessageBubbleColors(lightColor?: ColorString, darkColor?: ColorString): void;
-		setMessageBubbleCornerRadius(radius?: number): void;
-		resetMessageBubbles(): void;
-	};
-	/** The native toolbox menu, drawn natively so it survives a broken JS bundle. */
-	type UnboundNativeToolbox = {
-		showMenu(): void;
-	};
-	/** The raw `UnboundNative` JSI bridge the tweak installs directly on the JS global. */
-	type UnboundNativeModule = {
-		getNativeModuleVersion(): string;
-		supportsFeature(name: UnboundNativeFeature): boolean;
-		getFeatureInfo(name: UnboundNativeFeature): UnboundNativeFeatureInfo;
-		isFeatureDeprecated(name: UnboundNativeFeature): boolean;
-		isFeatureRemoved(name: UnboundNativeFeature): boolean;
-		getSupportedFeatures(): UnboundNativeFeature[];
-		getDeprecatedFeatures(): UnboundNativeFeature[];
-		getRemovedFeatures(): UnboundNativeFeature[];
-		/**
-		 * Runs Hermes bytecode in the app's JS runtime and returns whatever it evaluates to.
-		 * Throws when the buffer is not an `ArrayBuffer`, is empty, or is not Hermes bytecode;
-		 * anything the bytecode itself throws propagates too.
-		 */
-		evaluateBytecode(bytecode: ArrayBuffer, tag?: string): any;
-		device: UnboundNativeDevice;
-		app: UnboundNativeApp;
-		notifications: UnboundNativeNotifications;
-		pip: UnboundNativePiP;
-		chat: UnboundNativeChat;
-		toolbox: UnboundNativeToolbox;
-	};
 	/**
 	 * Build-time token, replaced with a boolean literal by the build's `transform.define`. Folds at
 	 * the module-graph level so `if ($$DEV$$)` branches (and any imports inside them) are dead-code
 	 * eliminated from production bundles entirely. Use it (not a runtime check) to gate dev-only code.
 	 */
 	var $$DEV$$: boolean;
-	/** The raw `UnboundNative` JSI bridge, installed on the global by the platform loader. */
-	var UnboundNative: UnboundNativeModule | undefined;
+	var NativePlatform: NativePlatformBridge | undefined;
 	var React: typeof import('react');
 	var ReactNative: typeof import('react-native');
 

package/src/metro/index.d.ts

@@ -20,7 +20,7 @@ export declare const on: typeof addListener;
  * @param listener Callback receiving the module exports and its id.
  * @returns A function that removes the listener.
  */
-export declare function addListener(listener: (mdl: any, id: string) => void): () => boolean;
+export declare function addListener(listener: (mdl: any, id: number) => void): () => boolean;
 /**
  * @description Runs several filters in a single registry pass, returning one result per item.
  * @param items The filters to resolve, each with its own per-item options.
@@ -108,7 +108,7 @@ export declare function initializeModule(id: number): boolean;
  * @description Removes a previously registered module listener.
  * @param listener The listener to remove.
  */
-export declare function removeListener(listener: (mdl: any, id: string) => void): void;
+export declare function removeListener(listener: (mdl: any, id: number) => void): void;
 
 /** A single entry in a {@link bulk} search: a filter plus its per-item options. */
 export interface MetroBulkItem extends Omit<MetroSearchOptions, 'initial' | 'cache'> {
@@ -191,6 +191,7 @@ export type MetroSearchOptions = {
 	lazy?: boolean;
 	raw?: boolean;
 	all?: boolean;
+	cacheOnly?: boolean;
 	initialize?: boolean;
 };
 /** Result shape of a by-name search: the matched function (or its default export). */

package/src/native.d.ts

@@ -1,8 +1,55 @@
 // Auto-generated by generate-plugin-sdk.ts - DO NOT EDIT
 
+export type {
+	NativeAssociationKey,
+	NativeCallOptions,
+	NativeClassHandle,
+	NativeFFIBridge,
+	NativeFFISignature,
+	NativeFFIType,
+	NativeFFITypeName,
+	NativeFabricBridge,
+	NativeFabricFrame,
+	NativeFabricSize,
+	NativeFabricSurface,
+	NativeHandle,
+	NativeHookContext,
+	NativeHookHandlers,
+	NativeHookOptions,
+	NativeHookToken,
+	NativeObjCBridge,
+	NativeObjectHandle,
+	NativePlatformBridge,
+	NativePluginBridge,
+	NativePluginCapability,
+	NativePluginError,
+	NativePluginErrorCode,
+	NativePointer,
+	NativeStruct,
+	NativeThreadPolicy,
+	PluginContext,
+} from './_internal';
+import type { NativePlatformBridge, NativePluginCapability } from './_internal';
 import type { Fn, PromiseFn } from './utils';
-/** The raw `UnboundNative` JSI bridge installed on the global by the platform loader. */
-declare const UnboundNative$1: UnboundNativeModule | undefined;
+declare const NativePlatform$1: NativePlatformBridge | undefined;
+export declare class NativePluginCapabilityError extends Error {
+	readonly code = 'NATIVE_PLUGIN_CAPABILITY_DENIED';
+	readonly capability: NativePluginCapability;
+	constructor(capability: NativePluginCapability);
+}
+export declare class NativePluginDisposedError extends Error {
+	readonly code = 'NATIVE_PLUGIN_SCOPE_DISPOSED';
+	constructor();
+}
+export declare class NativePluginUnavailableError extends Error {
+	readonly code = 'NATIVE_PLUGIN_UNAVAILABLE';
+}
+export declare class NativePluginVersionError extends Error {
+	readonly code = 'NATIVE_PLUGIN_API_VERSION_UNSUPPORTED';
+	readonly installedApi: string;
+	readonly requiredApi: string;
+	constructor(requiredApi: string, installedApi: string);
+}
 /** The resolved native client info module, exposing build and release metadata. */
 export declare const BundleInfo: BundleInfoType;
 /** The resolved native bundle updater module, used to check for updates and reload the bundle. */
@@ -27,6 +74,7 @@ export declare function getRuntimeProperties(): Record<string, any>;
  * @description Persists pending settings to storage, then reloads the native bundle.
  */
 export declare function reload(): Promise<void>;
+
 /** Build and release metadata reported by the native client info module. */
 export interface BundleInfoType {
 	Version: string;
@@ -90,6 +138,7 @@ export interface DeviceInfoType {
 	ramSize: string;
 	device: string;
 }
+
 /** The text encodings accepted by the native `DCDFileManager` read/write operations. */
 export type DCDFileManagerEncoding = 'utf-8' | 'utf8' | 'base64';
-export { UnboundNative$1 as UnboundNative };
+export { NativePlatform$1 as NativePlatform };