@btsd/aitu-bridge 0.7.2-canary.3 → 0.8.0-canary.5

package/dist/buildBridge.d.ts

@@ -0,0 +1,3 @@
+import type { AituBridge } from './types';
+export declare const buildBridge: () => AituBridge;
+//# sourceMappingURL=buildBridge.d.ts.map

package/dist/error.d.ts

@@ -1,13 +1,13 @@
-/**
- * @public
- */
-export declare enum BridgeErrors {
-    PermissionDenyError = 0,
-    PermissionSecurityDenyError = 1,
-    OtherError = 2
-}
-/**
- * @public
- */
-export declare const classifyBridgeError: (e: any) => BridgeErrors;
+/**
+ * @public
+ */
+export declare enum BridgeErrors {
+    PermissionDenyError = 0,
+    PermissionSecurityDenyError = 1,
+    OtherError = 2
+}
+/**
+ * @public
+ */
+export declare const classifyBridgeError: (e: any) => BridgeErrors;
 //# sourceMappingURL=error.d.ts.map

package/dist/index.d.ts

@@ -1,577 +1,16 @@
-/**
- * Aitu Bridge is a JavaScript library designed to simplify integration with the Aitu Superapp.
- * It allows your application to access platform features such as retrieving a user’s phone number or geolocation.
- * {@link https://docs.aitu.io/aituapps/aitu.apps/methods | Read the official documentation to learn more.}
- * @packageDocumentation
- */
-export * from './error';
-/**
- * @public
- */
-export declare enum EInvokeRequest {
-    getMe = "GetMe",
-    getPhone = "GetPhone",
-    getContacts = "GetContacts",
-    getUserProfile = "GetUserProfile",
-    enableNotifications = "AllowNotifications",
-    disableNotifications = "DisableNotifications",
-    enablePrivateMessaging = "EnablePrivateMessaging",
-    disablePrivateMessaging = "DisablePrivateMessaging"
-}
-/**
- * @public
- * Represents a header menu item click handler.
- */
-export type HeaderMenuItemClickHandlerType = (id: string) => Promise<void>;
-/**
- * @public
- * Represents a back arrow click handler.
- */
-export type BackArrowClickHandlerType = () => Promise<void>;
-/**
- * @public
- * Represents an error that can occur during NFC passport operations.
- */
-export interface NFCPassportError {
-    /**
-     * Error code indicating the type of NFC passport issue.
-     *
-     * - `nfc_passport_mismatch` — The passport does not match the requested parameters
-     *   (date of birth, passport number, expiration date).
-     * - `nfc_document_read_failure` — Document reading error
-     *   (read errors, algorithm errors, unknown algorithms, other documents that are not passports, etc.).
-     * - `nfc_session_timeout` — Session timeout: the document reading was not completed
-     *   in time (depends on the OS).
-     * - `nfc_permission_denied` — The user denied NFC permission or the device has no NFC chip.
-     * - `nfc_session_cancelled` — The user cancelled the NFC session (iOS).
-     */
-    code: 'nfc_passport_mismatch' | 'nfc_document_read_failure' | 'nfc_session_timeout' | 'nfc_permission_denied' | 'nfc_session_cancelled';
-    /**
-     * Human-readable error message describing the issue.
-     */
-    msg: string;
-}
-/**
- * @public
- * Represents an error indicating that the app URL does not match the expected value.
- */
-export interface AppUrlDoesntMatchError {
-    code: 'url_does_not_match';
-    msg: string;
-}
-/**
- * @public
- * Represents a permission denied error.
- */
-export interface PermissionDeniedError {
-    code: 'permission_denied';
-    msg: string;
-    meta: {
-        can_retry: boolean;
-    };
-}
-/**
- * @public
- * Represents phone number response.
- */
-export interface GetPhoneResponse {
-    phone: string;
-    sign: string;
-}
-/**
- * @public
- * Represents user information response.
- */
-export interface GetMeResponse {
-    name: string;
-    lastname: string;
-    id: string;
-    avatar?: string;
-    avatarThumb?: string;
-    notifications_allowed: boolean;
-    private_messaging_enabled: boolean;
-    sign: string;
-}
-/**
- * @public
- * Represents a generic response object.
- */
-export interface ResponseObject {
-    phone?: string;
-    name?: string;
-    lastname?: string;
-}
-/**
- * @public
- * Represents a geographic location response.
- */
-export interface GetGeoResponse {
-    latitude: number;
-    longitude: number;
-}
-/**
- * @public
- * Represents a contacts list response.
- */
-export interface GetContactsResponse {
-    contacts: Array<{
-        first_name: string;
-        last_name: string;
-        phone: string;
-    }>;
-    sign: string;
-}
-/**
- * @public
- * Represents a selected contact response.
- */
-export interface SelectContactResponse {
-    phone: string;
-    name: string;
-    lastname: string;
-}
-/**
- * @public
- * Represents a user profile response.
- */
-export interface GetUserProfileResponse {
-    name: string;
-    lastname?: string;
-    phone?: string;
-    avatar?: string;
-    avatarThumb?: string;
-}
-/**
- * @public
- * Represents header menu item icons.
- */
-export declare enum HeaderMenuIcon {
-    Search = "Search",
-    ShoppingCart = "ShoppingCart",
-    Menu = "Menu",
-    Share = "Share",
-    Notifications = "Notifications",
-    Help = "Help",
-    Error = "Error",
-    Person = "Person",
-    Sort = "Sort",
-    Filter = "Filter",
-    Close = "Close",
-    SystemNotifications = "SystemNotifications"
-}
-/**
- * @public
- * Represents navigation item display modes.
- */
-export declare enum NavigationItemMode {
-    SystemBackArrow = "SystemBackArrow",
-    CustomBackArrow = "CustomBackArrow",
-    NoItem = "NoItem",
-    UserProfile = "UserProfile"
-}
-/**
- * @public
- * Represents a header menu item.
- */
-export interface HeaderMenuItem {
-    id: string;
-    icon: HeaderMenuIcon;
-    badge?: string;
-}
-/**
- * @public
- * Represents user steps per day.
- */
-export interface UserStepsPerDay {
-    date: string;
-    steps: number;
-}
-/**
- * @public
- * Represents a user step information response.
- */
-export interface UserStepInfoResponse {
-    steps: UserStepsPerDay[];
-}
-/**
- * @public
- * Represents a successful response.
- */
-export type SuccessResponse = 'success';
-/**
- * @public
- * Represents the status of a response.
- *
- * - `success` — The operation completed successfully.
- * - `failed` — The operation failed.
- */
-export type ResponseType = SuccessResponse | 'failed';
-/**
- * @public
- * Represents biometry check response.
- */
-export type BiometryResponse = ResponseType | 'unavailable' | 'cancelled';
-/**
- * @public
- * Represents passport data read from an NFC chip.
- */
-export interface PassportDataResponse {
-    documentNumber: string;
-    dateOfBirth: string;
-    dateOfExpiry: string;
-    firstName: string;
-    lastName: string;
-    gender: string;
-    nationality: string;
-    documentType: string;
-}
-/**
- * @public
- * Generic bridge invocation type.
- */
-export type BridgeInvoke<T extends EInvokeRequest, R> = (method: T, data?: {}) => Promise<R>;
-/**
- * @public
- * Interface for persistent key-value storage.
- */
-export interface BridgeStorage {
-    setItem: (keyName: string, keyValue: string) => Promise<void>;
-    getItem: (keyName: string) => Promise<string | null>;
-    clear: () => Promise<void>;
-}
-/**
- * @public
- * Main interface for interacting with the Aitu Bridge API.
- */
-export interface AituBridge {
-    /**
-     * Version of the Aitu Bridge API available in SemVer format.
-     */
-    version: string;
-    /**
-     * Low-level bridge invocation method used internally
-     * to communicate with native Aitu functionality.
-     */
-    invoke: BridgeInvoke<EInvokeRequest, ResponseObject>;
-    /**
-     * Provides access to persistent key-value storage
-     * scoped to the current mini-app.
-     */
-    storage: BridgeStorage;
-    /**
-     * Returns basic information about the currently authorized user.
-     * @returns A promise resolving to a {@link GetMeResponse} containing user details.
-     */
-    getMe: () => Promise<GetMeResponse>;
-    /**
-     * Requests the user's phone number after explicit user confirmation.
-     * @returns A promise resolving to a {@link GetPhoneResponse} containing the phone number.
-     */
-    getPhone: () => Promise<GetPhoneResponse>;
-    /**
-     * Requests access to the user's contact list.
-     * @returns A promise resolving to a {@link GetContactsResponse} containing the contacts.
-     */
-    getContacts: () => Promise<GetContactsResponse>;
-    /**
-     * Retrieves the user's current geographic location.
-     * @returns A promise resolving to a {@link GetGeoResponse} containing latitude and longitude.
-     */
-    getGeo: () => Promise<GetGeoResponse>;
-    /**
-     * Opens the native contact picker UI and allows the user
-     * to select a single contact.
-     * @returns A promise resolving to a {@link SelectContactResponse} containing the selected contact details.
-     */
-    selectContact: () => Promise<SelectContactResponse>;
-    /**
-     * Opens the device camera and scans a QR code.
-     * @returns A string with the result of scanning the QR code is returned.
-     */
-    getQr: () => Promise<string>;
-    /**
-     * Requests an SMS verification code from the user.
-     * @returns A string with code is returned.
-     */
-    getSMSCode: () => Promise<string>;
-    /**
-     * Retrieves public profile information for a specific user.
-     *
-     * @param userId - Aitu user identifier
-     * @returns A promise resolving to a {@link GetUserProfileResponse} containing the user's profile data.
-     */
-    getUserProfile: (userId: string) => Promise<GetUserProfileResponse>;
-    /**
-     * Opens the user's profile within the host application.
-     * @returns A promise that resolves with a {@link ResponseType} indicating the result of the operation.
-     */
-    openUserProfile: () => Promise<ResponseType>;
-    /**
-     * Opens the system share dialog with a text payload.
-     *
-     * @param text - Text to share
-     * @returns A promise resolving to a {@link ResponseType} indicating the result of the sharing operation.
-     */
-    share: (text: string) => Promise<ResponseType>;
-    /**
-     * Sets the title displayed in the mini-app header.
-     *
-     * @param text - Header title
-     * @returns A promise resolving to a {@link ResponseType} indicating the result of the operation.
-     */
-    setTitle: (text: string) => Promise<ResponseType>;
-    /**
-     * Copies the specified text to the system clipboard.
-     *
-     * @param text - Text to copy
-     * @returns A promise resolving to a {@link ResponseType} indicating the result of the copy operation.
-     */
-    copyToClipboard: (text: string) => Promise<ResponseType>;
-    /**
-     * Shares an image with an optional text description.
-     *
-     * @deprecated Use {@link AituBridge.shareFile} instead.
-     * @param text - Description text
-     * @param image - Image data encoded in Base64
-     * @returns A promise resolving to a {@link ResponseType} indicating the result of the sharing operation.
-     */
-    shareImage: (text: string, image: string) => Promise<ResponseType>;
-    /**
-     * Shares a file via the system sharing interface.
-     *
-     * @param text - Description text
-     * @param filename - Name of the file
-     * @param base64Data - File data encoded in Base64
-     * @returns A promise resolving to a {@link ResponseType} indicating the result of the sharing operation.
-     */
-    shareFile: (text: string, filename: string, base64Data: string) => Promise<ResponseType>;
-    /**
-     * Enables push notifications for the mini-app.
-     */
-    enableNotifications: () => Promise<{}>;
-    /**
-     * Disables push notifications for the mini-app.
-     */
-    disableNotifications: () => Promise<{}>;
-    /**
-     * Enables private messaging between the mini-app and the user.
-     *
-     * @param appId - Mini-app identifier
-     */
-    enablePrivateMessaging: (appId: string) => Promise<string>;
-    /**
-     * Disables private messaging between the mini-app and the user.
-     *
-     * @param appId - Mini-app identifier
-     */
-    disablePrivateMessaging: (appId: string) => Promise<string>;
-    /**
-     * Opens the Aitu application settings screen.
-     * @returns A promise resolving to a ResponseType indicating the result of the operation.
-     */
-    openSettings: () => Promise<ResponseType>;
-    /**
-     * Closes the current mini-app.
-     * @returns A promise resolving to a ResponseType indicating the result of the operation.
-     */
-    closeApplication: () => Promise<ResponseType>;
-    /**
-     * Registers a handler that is triggered when the device is shaken.
-     * @param handler - Shake event handler
-     */
-    setShakeHandler: (handler: any) => void;
-    /**
-     * Registers a handler that is triggered when a tab becomes active.
-     *
-     * @param handler - Callback with active tab name
-     */
-    setTabActiveHandler: (handler: (tabname: string) => void) => void;
-    /**
-     * Triggers device vibration using a custom vibration pattern.
-     *
-     * @param pattern - Array of vibration durations in milliseconds
-     * @returns A promise resolving to a {@link SuccessResponse} indicating the result of the vibration operation.
-     */
-    vibrate: (pattern: number[]) => Promise<SuccessResponse>;
-    /**
-     * Indicates whether the current environment supports Aitu Bridge.
-     * @returns A boolean indicating support status.
-     */
-    isSupported: () => boolean;
-    /**
-     * Checks whether a specific bridge method is supported.
-     *
-     * @param method - Method name
-     * @returns A boolean indicating support status.
-     */
-    supports: (method: string) => boolean;
-    /**
-     * Subscribes to Aitu Bridge events.
-     */
-    sub: any;
-    /**
-     * Enables protection against screenshots and screen recording.
-     */
-    enableScreenCapture: () => Promise<{}>;
-    /**
-     * Disables protection against screenshots and screen recording.
-     */
-    disableScreenCapture: () => Promise<{}>;
-    /**
-     * Sets custom menu items in the mini-app header.
-     *
-     * @param items - Header menu configuration
-     * @returns A promise resolving to a {@link ResponseType} indicating the result of the operation.
-     */
-    setHeaderMenuItems: (items: Array<HeaderMenuItem>) => Promise<ResponseType>;
-    /**
-     * Registers a click handler for header menu items.
-     * @param handler - Header menu item click handler
-     */
-    setHeaderMenuItemClickHandler: (handler: HeaderMenuItemClickHandlerType) => void;
-    /**
-     * Enables or disables custom back arrow handling.
-     *
-     * @param enabled - Whether custom handling is enabled
-     * @returns A promise resolving to a ResponseType indicating the result of the operation.
-     */
-    setCustomBackArrowMode: (enabled: boolean) => Promise<ResponseType>;
-    /**
-     * Returns whether custom back arrow mode is enabled.
-     * @returns A promise resolving to a boolean indicating the current mode.
-     */
-    getCustomBackArrowMode: () => Promise<boolean>;
-    /**
-     * Controls the visibility of the custom back arrow.
-     *
-     * @param visible - Arrow visibility state
-     * @returns A promise resolving to a {@link ResponseType} indicating the result of the operation.
-     */
-    setCustomBackArrowVisible: (visible: boolean) => Promise<ResponseType>;
-    /**
-     * Opens the payment interface for a specified transaction.
-     * @param transactionId - Transaction identifier
-     * @returns A promise resolving to a {@link ResponseType} indicating the result of the payment operation.
-     */
-    openPayment: (transactionId: string) => Promise<ResponseType>;
-    /**
-     * Sets a custom handler for back arrow click events.
-     * @param handler - Back arrow click handler
-     */
-    setCustomBackArrowOnClickHandler: (handler: BackArrowClickHandlerType) => void;
-    /**
-     * Checks biometric authentication status.
-     * @returns  A promise resolving to a {@link BiometryResponse} indicating the result of the check.
-     */
-    checkBiometry: () => Promise<BiometryResponse>;
-    /**
-     * Opens an external URL outside the mini-app context.
-     *
-     * @param url - External URL to open
-     * @returns A promise resolving to a {@link ResponseType} indicating the result of the operation.
-     */
-    openExternalUrl: (url: string) => Promise<ResponseType>;
-    /**
-     * Enables swipe-back navigation gesture.
-     * @returns A promise resolving to a {@link ResponseType} when the gesture is enabled.
-     */
-    enableSwipeBack: () => Promise<ResponseType>;
-    /**
-     * Disables swipe-back navigation gesture.
-     * @returns A promise resolving to a {@link ResponseType} when the gesture is disabled.
-     */
-    disableSwipeBack: () => Promise<ResponseType>;
-    /**
-     * Sets the navigation item display mode.
-     *
-     * @param mode - Navigation item mode
-     * @returns A promise that resolves when the mode is set.
-     */
-    setNavigationItemMode: (mode: NavigationItemMode) => Promise<void>;
-    /**
-     * Returns the current navigation item mode.
-     * @returns A promise resolving to the current {@link NavigationItemMode}.
-     */
-    getNavigationItemMode: () => Promise<NavigationItemMode>;
-    /**
-     * Retrieves step count data from HealthKit or Google Fit.
-     * @returns A promise resolving to a {@link UserStepInfoResponse} containing the user's step data.
-     */
-    getUserStepInfo: () => Promise<UserStepInfoResponse>;
-    /**
-     * Checks whether eSIM is supported on the device.
-     * @returns A promise resolving to a {@link ResponseType} indicating if eSIM is supported.
-     */
-    isESimSupported: () => Promise<ResponseType>;
-    /**
-     * Activates an eSIM using the provided activation code.
-     *
-     * @param activationCode - eSIM activation code
-     * @returns A promise resolving to a {@link ResponseType} indicating the result of the activation.
-     */
-    activateESim: (activationCode: string) => Promise<ResponseType>;
-    /**
-     * Reads raw data from an NFC tag.
-     * @returns A promise resolving to a string containing the raw NFC data.
-     */
-    readNFCData: () => Promise<string>;
-    /**
-     * Subscribes to user step updates from HealthKit/Google Fit.
-     *
-     * Establishes a real-time subscription that listens for step count changes
-     * from the underlying health data provider. The promise resolves once the
-     * subscription request has been processed. To stop receiving updates, call
-     * {@link AituBridge.unsubscribeUserStepInfo}.
-     *
-     * @returns A promise that resolves with a `ResponseType` indicating
-     *          whether the subscription was successfully created.
-     */
-    subscribeUserStepInfo: () => Promise<ResponseType>;
-    /**
-     * Unsubscribes from user step updates from HealthKit/Google Fit.
-     *
-     * Stops the active step-count subscription created by
-     * {@link AituBridge.subscribeUserStepInfo}. Once unsubscribed, no further step updates
-     * will be delivered.
-     *
-     * @returns A promise that resolves with a `ResponseType` indicating
-     *          whether the unsubscription was successful.
-     */
-    unsubscribeUserStepInfo: () => Promise<ResponseType>;
-    /**
-     * Reads data from the NFC chip of an ePassport using BAC (Basic Access Control).
-     *
-     * Initiates a BAC-protected NFC read operation on an ePassport. The caller must
-     * provide the passport number, date of birth, and expiration date—values taken
-     * from the machine-readable zone (MRZ). These values are used to derive the
-     * cryptographic access keys required by BAC to open a secure session with the
-     * passport’s NFC chip.
-     *
-     * Once BAC is successfully established, the function retrieves data groups
-     * from the chip, typically including the holder’s biographical information
-     * (DG1) and, if supported and permitted, biometric data such as the facial
-     * image (DG2).
-     *
-     * @param passportNumber - Passport number taken from the MRZ.
-     * @param dateOfBirth - Holder’s date of birth (MRZ format: YYMMDD).
-     * @param expirationDate - Passport expiration date (MRZ format: YYMMDD).
-     *
-     * @returns A promise resolving to a `PassportDataResponse` containing the decoded
-     *          data groups read from the passport’s NFC chip.
-     *
-     * @throws {@link NFCPassportError} When an NFC passport operation fails. Possible codes:
-     * - `nfc_passport_mismatch` — Passport does not match the provided MRZ values.
-     * - `nfc_document_read_failure` — General failure to read the document.
-     * - `nfc_session_timeout` — NFC session timed out before completion.
-     * - `nfc_permission_denied` — NFC permission denied or NFC unavailable.
-     * - `nfc_session_cancelled` — User cancelled the NFC session (iOS).
-     */
-    readNFCPassport: (passportNumber: string, dateOfBirth: string, expirationDate: string) => Promise<PassportDataResponse>;
-}
-/**
- * @public
- * AituBridge instance for interacting with the Aitu mini-app environment.
- */
-declare const bridge: AituBridge;
-export default bridge;
+/**
+ * Aitu Bridge is a JavaScript library designed to simplify integration with the Aitu Superapp.
+ * It allows your application to access platform features such as retrieving a user’s phone number or geolocation.
+ * {@link https://docs.aitu.io/aituapps/aitu.apps/methods | Read the official documentation to learn more.}
+ * @packageDocumentation
+ */
+export * from './error';
+export type { BackArrowClickHandlerType, HeaderMenuItemClickHandlerType, NFCPassportError, PermissionDeniedError, AppUrlDoesntMatchError, AituEventHandler, GetPhoneResponse, GetMeResponse, ResponseObject, GetGeoResponse, GetContactsResponse, SelectContactResponse, GetUserProfileResponse, HeaderMenuItem, UserStepsPerDay, UserStepInfoResponse, SuccessResponse, BiometryResponse, PassportDataResponse, BridgeInvoke, BridgeStorage, AituBridge, } from './types';
+export { HeaderMenuIcon, NavigationItemMode, EInvokeRequest } from './types';
+/**
+ * @public
+ * AituBridge instance for interacting with the Aitu mini-app environment.
+ */
+declare const bridge: import("./types").AituBridge;
+export default bridge;
 //# sourceMappingURL=index.d.ts.map