Public API map

Root exports and subpath imports for @ovok/native

  • Stable unknown
  • Release candidate since 1.16.1-rc.1
  • Development since 1.16.1-dev+97b2473

The public contract is defined by the package export map and source barrels. Import from @ovok/native or a documented @ovok/native/<module> subpath. Do not import from src/ or generated lib/ paths.

Root and subpath imports

The entry-point table below is generated from package.json, src/index.tsx, and the module barrels under src/modules. Run yarn docs:generate after changing package exports or adding a module. The module feature guides remain hand-written: see App UI and Reusable flows for the UI surfaces.

{/* BEGIN GENERATED API MAP */}

SurfaceImport pathAlso exported from rootSource entry
SDK root@ovok/native—src/index.tsx
auth@ovok/native/authNosrc/modules/auth/index.tsx
background-sync@ovok/native/background-syncNosrc/modules/background-sync/index.ts
bluetooth@ovok/native/bluetoothNosrc/modules/bluetooth/index.ts
breathing-exercise@ovok/native/breathing-exerciseNosrc/modules/breathing-exercise/index.ts
cms@ovok/native/cmsNosrc/modules/cms/index.ts
content@ovok/native/contentNosrc/modules/content/index.ts
data-sync@ovok/native/data-syncNosrc/modules/data-sync/index.ts
diary@ovok/native/diaryNosrc/modules/diary/index.ts
helpers@ovok/native/helpersNosrc/modules/helpers/index.tsx
image@ovok/native/imageNosrc/modules/image/index.ts
journal@ovok/native/journalNosrc/modules/journal/index.ts
language-switcher@ovok/native/language-switcherNosrc/modules/language-switcher/index.ts
measurement@ovok/native/measurementNosrc/modules/measurement/index.ts
next@ovok/native/nextYessrc/modules/next/index.ts
observation-detail@ovok/native/observation-detailNosrc/modules/observation-detail/index.ts
patient@ovok/native/patientNosrc/modules/patient/index.ts
pdf@ovok/native/pdfNosrc/modules/pdf/index.ts
picker-sheet@ovok/native/picker-sheetNosrc/modules/picker-sheet/index.ts
progress-bar@ovok/native/progress-barNosrc/modules/progress-bar/index.ts
progress-ring@ovok/native/progress-ringNosrc/modules/progress-ring/index.ts
questionnaire-response-form@ovok/native/questionnaire-response-formNosrc/modules/questionnaire-response-form/index.ts
setting@ovok/native/settingNosrc/modules/setting/index.ts
socket@ovok/native/socketNosrc/modules/socket/index.ts
tab@ovok/native/tabNosrc/modules/tab/index.ts
theme@ovok/native/themeNosrc/modules/theme/index.ts
tile@ovok/native/tileNosrc/modules/tile/index.ts
ui@ovok/native/uiNosrc/modules/ui/index.ts
wearables@ovok/native/wearablesNosrc/modules/wearables/index.ts
next/background-sync@ovok/native/next/background-syncNosrc/modules/next/background-sync/index.ts
next/bluetooth@ovok/native/next/bluetoothNosrc/modules/next/bluetooth/index.ts
next/bluetooth/sqlite@ovok/native/next/bluetooth/sqliteNosrc/modules/next/bluetooth/sqlite/index.ts
next/bluetooth/web@ovok/native/next/bluetooth/webNosrc/modules/next/bluetooth/web/index.ts
next/breathing-exercise@ovok/native/next/breathing-exerciseNosrc/modules/next/breathing-exercise/index.ts
next/cms@ovok/native/next/cmsNosrc/modules/next/cms/index.ts
next/content@ovok/native/next/contentNosrc/modules/next/content/index.ts
next/data-sync@ovok/native/next/data-syncNosrc/modules/next/data-sync/index.ts
next/diary@ovok/native/next/diaryNosrc/modules/next/diary/index.ts
next/image@ovok/native/next/imageNosrc/modules/next/image/index.ts
next/journal@ovok/native/next/journalNosrc/modules/next/journal/index.ts
next/language-switcher@ovok/native/next/language-switcherNosrc/modules/next/language-switcher/index.ts
next/measurement@ovok/native/next/measurementNosrc/modules/next/measurement/index.ts
next/observation-detail@ovok/native/next/observation-detailNosrc/modules/next/observation-detail/index.ts
next/patient@ovok/native/next/patientNosrc/modules/next/patient/index.ts
next/pdf@ovok/native/next/pdfNosrc/modules/next/pdf/index.ts
next/picker-sheet@ovok/native/next/picker-sheetNosrc/modules/next/picker-sheet/index.ts
next/progress-bar@ovok/native/next/progress-barNosrc/modules/next/progress-bar/index.ts
next/progress-ring@ovok/native/next/progress-ringNosrc/modules/next/progress-ring/index.ts
next/setting@ovok/native/next/settingNosrc/modules/next/setting/index.ts
next/tab@ovok/native/next/tabNosrc/modules/next/tab/index.ts
next/theme@ovok/native/next/themeNosrc/modules/next/theme/index.ts
next/tile@ovok/native/next/tileNosrc/modules/next/tile/index.ts
next/ui@ovok/native/next/uiNosrc/modules/next/ui/index.ts
polyfills@ovok/native/polyfillsNosrc/polyfills/index.ts
Package metadata@ovok/native/package.jsonNopackage.json

{/* END GENERATED API MAP */}

The package root is the Ovok client and the @ovok/core client API, the same exports as @ovok/native/next. Runtime helpers such as polyfillOvokWebAPIs are on the @ovok/native/polyfills subpath, which loads only that module, so app entry code can initialize the runtime before importing the app or other SDK modules. See Polyfills and runtime setup for the Expo Router entry pattern.

Root examples

import { Ovok, SecureStoreStorage } from "@ovok/native";

Every app that talks to Ovok imports the client from the root. Install the peer dependencies for the subpaths the application bundle imports.

Subpath examples

import { DataSync } from "@ovok/native/data-sync";
import { SUPPORTED_DEVICES } from "@ovok/native/bt-device";
import { ManualEntryForm } from "@ovok/native/ui";
import { PDFViewer } from "@ovok/native/pdf";

Use subpaths for optional native features, especially when the app does not use HealthKit, Health Connect, PDF rendering, background services, or the integration-flow components.

Protocol API

The bt-management index also exports lower-level protocol types and factories. They are useful for custom integrations and tests, but are more coupled to device wire formats than the UI APIs:

  • defineCustomDevice and custom declaration types;
  • BTManagedDevice, BTManager, and background BLE helpers;
  • standard GATT factories;
  • boso, Visomat, Veroval, AOJ, Lepu, and Viatom declarations;
  • measurement field, device status, error, and result-policy types;
  • fake managers and recorded-frame helpers for tests.

Prefer the catalog and integrated-device values for normal application code. Pin and test the exact SDK version when using protocol factories.

Last updated on

On this page