API Reference
Краткий справочник публичного SDK @aurobore/core и пакетов плагинов.
Архитектура: typescript-sdk.md.
@aurobore/core
Мост
| Функция | Описание |
|---|---|
getAurobore() | Возвращает активный мост (globalThis.Aurobore или bound) |
invoke(plugin, method, args?, options?) | Вызов нативного метода → Promise |
on(name, handler) | Подписка на событие; возвращает unsubscribe |
once(name, handler) | Одноразовая подписка |
off(name, handler) | Отписка |
emit(name, data?) | Событие JS → native |
assertBridgeReady() | Бросает, если мост недоступен |
bindAurobore(bridge) | Подмена моста (тесты) |
Lifecycle-события
Тип LifecycleEvent: ready | pause | resume | backbutton | memoryWarning | orientationchange | destroy.
Обложка (cover)
| API | Описание |
|---|---|
cover.setState({ primaryText?, secondaryText? }) | Динамический текст на обложке |
cover.setActions(actions) | Кнопки быстрых действий (до 4) |
cover.reset() | Сброс к имени приложения и actions из конфига |
cover.onAction(handler) | Подписка на cover:action |
См. cover.md.
Ошибки
| Класс | Код |
|---|---|
AuroboreError | базовый |
PermissionDeniedError | BRIDGE_PERMISSION_DENIED |
TimeoutError | BRIDGE_TIMEOUT |
CancelledError | BRIDGE_CANCELLED |
PluginNotFoundError | BRIDGE_PLUGIN_NOT_FOUND |
MethodNotFoundError | BRIDGE_METHOD_NOT_FOUND |
InvalidArgsError | BRIDGE_INVALID_ARGS |
ProtocolMismatchError | BRIDGE_PROTOCOL_MISMATCH |
Утилиты: wrapBridgeError(err), isAuroboreError(value).
Совместимость
checkBridgeProtocol(expected?) — проверка globalThis.Aurobore.__protocolVersion.
Стримы
interface StreamSubscription {
subscriptionId: string;
onData: (payload: unknown) => void;
onError: (error: BridgeError) => void;
onComplete: () => void;
stop: () => void;
}Протокол (низкий уровень)
Экспортируются типы сообщений, BRIDGE_PROTOCOL_VERSION, BRIDGE_ERROR_CODES, фабрики сообщений — для тестов и инструментов.
Пакеты плагинов
Каждый @aurobore/<name> экспортирует объект с методами из манифеста:
import { Device } from "@aurobore/device";
import { Echo } from "@aurobore/echo";
import { Camera } from "@aurobore/camera";Пакеты: @aurobore/echo, device, storage, filesystem, clipboard, network, camera, geolocation, notifications, share, sensors.
Справочник: plugins/README.md — методы, типы, события, коды ошибок.
Каталог: standard-plugins.md. Контракт плагина: plugin-api.md.
CLI
| Команда | Описание |
|---|---|
aurobore create | Новый проект из шаблона |
aurobore dev | Dev server + эмулятор; --web — только браузер с mock-плагинами |
aurobore build | Web + native RPM |
aurobore run | Деплой и запуск |
aurobore plugin add/list/remove | Управление плагинами |
aurobore doctor | Проверка окружения |
Подробнее: cli.md.
Написание плагина
Платформенный гайд: dev/adding-a-plugin.md.