# Public API map

Canonical page: https://docs.ovok.com/native-sdk/guide/public-api

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 [#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](./modules/ui.md) and [Reusable flows](./how-to/reusable-flows.md) for the UI surfaces.

{/* BEGIN GENERATED API MAP */}

| Surface | Import path | Also exported from root | Source entry |
| --- | --- | --- | --- |
| SDK root | `@ovok/native` | — | `src/index.tsx` |
| auth | `@ovok/native/auth` | No | `src/modules/auth/index.tsx` |
| background-sync | `@ovok/native/background-sync` | No | `src/modules/background-sync/index.ts` |
| bluetooth | `@ovok/native/bluetooth` | No | `src/modules/bluetooth/index.ts` |
| breathing-exercise | `@ovok/native/breathing-exercise` | No | `src/modules/breathing-exercise/index.ts` |
| cms | `@ovok/native/cms` | No | `src/modules/cms/index.ts` |
| content | `@ovok/native/content` | No | `src/modules/content/index.ts` |
| data-sync | `@ovok/native/data-sync` | No | `src/modules/data-sync/index.ts` |
| diary | `@ovok/native/diary` | No | `src/modules/diary/index.ts` |
| helpers | `@ovok/native/helpers` | No | `src/modules/helpers/index.tsx` |
| image | `@ovok/native/image` | No | `src/modules/image/index.ts` |
| journal | `@ovok/native/journal` | No | `src/modules/journal/index.ts` |
| language-switcher | `@ovok/native/language-switcher` | No | `src/modules/language-switcher/index.ts` |
| measurement | `@ovok/native/measurement` | No | `src/modules/measurement/index.ts` |
| next | `@ovok/native/next` | Yes | `src/modules/next/index.ts` |
| observation-detail | `@ovok/native/observation-detail` | No | `src/modules/observation-detail/index.ts` |
| patient | `@ovok/native/patient` | No | `src/modules/patient/index.ts` |
| pdf | `@ovok/native/pdf` | No | `src/modules/pdf/index.ts` |
| picker-sheet | `@ovok/native/picker-sheet` | No | `src/modules/picker-sheet/index.ts` |
| progress-bar | `@ovok/native/progress-bar` | No | `src/modules/progress-bar/index.ts` |
| progress-ring | `@ovok/native/progress-ring` | No | `src/modules/progress-ring/index.ts` |
| questionnaire-response-form | `@ovok/native/questionnaire-response-form` | No | `src/modules/questionnaire-response-form/index.ts` |
| setting | `@ovok/native/setting` | No | `src/modules/setting/index.ts` |
| socket | `@ovok/native/socket` | No | `src/modules/socket/index.ts` |
| tab | `@ovok/native/tab` | No | `src/modules/tab/index.ts` |
| theme | `@ovok/native/theme` | No | `src/modules/theme/index.ts` |
| tile | `@ovok/native/tile` | No | `src/modules/tile/index.ts` |
| ui | `@ovok/native/ui` | No | `src/modules/ui/index.ts` |
| wearables | `@ovok/native/wearables` | No | `src/modules/wearables/index.ts` |
| next/background-sync | `@ovok/native/next/background-sync` | No | `src/modules/next/background-sync/index.ts` |
| next/bluetooth | `@ovok/native/next/bluetooth` | No | `src/modules/next/bluetooth/index.ts` |
| next/bluetooth/sqlite | `@ovok/native/next/bluetooth/sqlite` | No | `src/modules/next/bluetooth/sqlite/index.ts` |
| next/bluetooth/web | `@ovok/native/next/bluetooth/web` | No | `src/modules/next/bluetooth/web/index.ts` |
| next/breathing-exercise | `@ovok/native/next/breathing-exercise` | No | `src/modules/next/breathing-exercise/index.ts` |
| next/cms | `@ovok/native/next/cms` | No | `src/modules/next/cms/index.ts` |
| next/content | `@ovok/native/next/content` | No | `src/modules/next/content/index.ts` |
| next/data-sync | `@ovok/native/next/data-sync` | No | `src/modules/next/data-sync/index.ts` |
| next/diary | `@ovok/native/next/diary` | No | `src/modules/next/diary/index.ts` |
| next/image | `@ovok/native/next/image` | No | `src/modules/next/image/index.ts` |
| next/journal | `@ovok/native/next/journal` | No | `src/modules/next/journal/index.ts` |
| next/language-switcher | `@ovok/native/next/language-switcher` | No | `src/modules/next/language-switcher/index.ts` |
| next/measurement | `@ovok/native/next/measurement` | No | `src/modules/next/measurement/index.ts` |
| next/observation-detail | `@ovok/native/next/observation-detail` | No | `src/modules/next/observation-detail/index.ts` |
| next/patient | `@ovok/native/next/patient` | No | `src/modules/next/patient/index.ts` |
| next/pdf | `@ovok/native/next/pdf` | No | `src/modules/next/pdf/index.ts` |
| next/picker-sheet | `@ovok/native/next/picker-sheet` | No | `src/modules/next/picker-sheet/index.ts` |
| next/progress-bar | `@ovok/native/next/progress-bar` | No | `src/modules/next/progress-bar/index.ts` |
| next/progress-ring | `@ovok/native/next/progress-ring` | No | `src/modules/next/progress-ring/index.ts` |
| next/setting | `@ovok/native/next/setting` | No | `src/modules/next/setting/index.ts` |
| next/tab | `@ovok/native/next/tab` | No | `src/modules/next/tab/index.ts` |
| next/theme | `@ovok/native/next/theme` | No | `src/modules/next/theme/index.ts` |
| next/tile | `@ovok/native/next/tile` | No | `src/modules/next/tile/index.ts` |
| next/ui | `@ovok/native/next/ui` | No | `src/modules/next/ui/index.ts` |
| polyfills | `@ovok/native/polyfills` | No | `src/polyfills/index.ts` |
| Package metadata | `@ovok/native/package.json` | No | `package.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](./components/polyfills/index.md) for the Expo Router entry
pattern.

## Root examples [#root-examples]

```ts
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 [#subpath-examples]

```ts
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 [#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.
