@ovok/core 0.4.14 → 0.4.16

package/README.md

@@ -41,13 +41,21 @@ const client = new OvokClient({
 });
 ```
 
-`baseUrl` is the Ovok API origin. `fhirUrlPath` selects the FHIR version path for
-the inherited Medplum client; `apiUrl` is not a supported client option.
+`baseUrl` is the Ovok API origin. `fhirUrlPath` selects the FHIR version path
+used by the client; `apiUrl` is not a supported client option.
 
 ## Documentation
 
 Full documentation and examples available at **[sdk.ovok.com](https://sdk.ovok.com/)**
 
+SDK-specific guides are maintained in [`/docs`](./docs/index.mdx) and are written to complement the platform documentation at [docs.ovok.com](https://docs.ovok.com/). The Docusaurus-compatible navigation is in [`docs/sidebars.cjs`](./docs/sidebars.cjs); the package repository does not bundle a docs-site runtime.
+
+### Publish the SDK docs into Ovok Docs
+
+The [sync workflow](./.github/workflows/sync-core-docs.yml) mirrors these pages into `Actimi/ovok-docs` under `docs/production/web-sdk` and updates its production sidebar after changes reach this repository's `main` branch. It pushes a bot commit to the docs repository's `dev` branch.
+
+The workflow requires a dedicated write-enabled deploy key for `Actimi/ovok-docs`: register its public key on that repository with write access, then save the private key in this repository's Actions secrets as `OVOK_DOCS_DEPLOY_KEY`. This key is separate from `DEPLOY_KEY`, which only authenticates this SDK repository.
+
 ## Backend capability discovery
 
 `@ovok/core` can read the capability statement composed by `../ovok-core` and expose the
@@ -102,7 +110,7 @@ The server can return `INVALID_SETTING_VALUE` (422), `APP_URL_NOT_ALLOWED`
 (400), or `UNKNOWN_SETTING` (400; the response lists accepted keys). A code-less
 409 means settings changed and the screen should reload before retrying. A 403
 means the caller is not a project admin. `readOvokError(error)` reads the status,
-code, user-facing message, and validation field errors from a Medplum error.
+code, user-facing message, and validation field errors from an API error.
 `IOT_ENABLED` is not a supported project setting.
 
 The email-template catalog is available to authenticated project practitioners:
@@ -281,7 +289,7 @@ worklist with `acknowledged: false` rather than `status: "ACTIVE"`. Acknowledgin
 alert, and the next breaching reading opens a new one. It is idempotent: an acknowledged alert keeps
 its first `acknowledgedAt` and `acknowledgedActor`.
 
-Filters: `status`, `acknowledged`, `patientId` (a Medplum Patient id), `codes` (LOINC codes), and
+Filters: `status`, `acknowledged`, `patientId` (a FHIR Patient id), `codes` (LOINC codes), and
 `since` (inclusive) and `until` (exclusive) on `createdAt`, as date-times with `Z` or an offset.
 Pages hold at most 50 alerts. As with episodes, a page can be short or empty and still have a
 `nextCursor`, because alerts of residents the caller can't read are left out; page until
@@ -323,7 +331,7 @@ and any missing-baseline details. In particular, reload the affected record befo
 do not automatically replay a stale assignment. A 409 `signals_project_migrating` should be shown
 as a temporary home-migration conflict, not retried in a loop. Threshold writes can return 422
 validation errors or 424 when the baseline has not been collected. Hooks never replay a write with
-a stale body; transient 503 transport retries, when enabled by Medplum, do not clear the session.
+a stale body; transient 503 transport retries do not clear the session.
 The unconfirmed-limit list and repush routes require project-admin access; a 403 remains an error.
 
 `getLegalConsent()` returns the signed-in practitioner's own terms status. If
@@ -420,9 +428,9 @@ The backend allows three kinds of read:
 Signed out, a read rejects with `SignInRequiredError` (`isSignInRequiredError(error)`) before
 any request is sent, unless it passes `allowSignedOut: true` and a `tenantCode`. `getLegalPage`,
 `getTranslations` and their hooks turn `allowSignedOut` on by default; pass it yourself only for
-another collection the backend serves without a key or session. This matters because
-`MedplumClient` answers any 401 by clearing its storage and calling `onUnauthenticated`. A hook
-that rendered before sign-in needs `reload()` once the session exists.
+another collection the backend serves without a key or session. A request that returns 401 can
+clear the session storage and call `onUnauthenticated`. A hook that rendered before sign-in needs
+`reload()` once the session exists.
 
 `locale` takes an app language or a CMS locale (`en`, `de`, `fr`, `es`). `toCmsLocale` maps
 `de-CH` to `de`, and a language the CMS does not carry to `en`. The hooks default to the
@@ -451,13 +459,13 @@ SDK version.
 
 ## Offline measurements
 
-Pass a durable Medplum storage adapter and opt in to queue measurements while offline:
+Pass a durable client storage adapter and opt in to queue measurements while offline:
 
 ```typescript
 const client = new OvokClient({
   storage,
   offlineQueue: { enabled: true },
-  // other Medplum configuration
+  // other Ovok client configuration
 });
 
 const result = await client.saveMeasurement({
@@ -497,8 +505,8 @@ const sessions = await client.getSessions();
 await client.revokeSessions("other");
 ```
 
-Pass `onUnauthenticated` in the normal Medplum client options to react when a request can no
-longer refresh its session.
+Pass `onUnauthenticated` in the client options to react when a request can no longer refresh its
+session.
 
 ## Multi-factor authentication
 
@@ -667,7 +675,7 @@ Render accept failures without attempting to distinguish private cases:
 
 ## Large measurements
 
-`saveMeasurement` and `saveObservations` use conditional creates for idempotent saves. Medplum
+`saveMeasurement` and `saveObservations` use conditional creates for idempotent saves. The API
 limits a serializable transaction with conditional operations to eight entries, so the SDK keeps
 the first observation in a transaction and sends additional observations in a FHIR batch request.
 This supports measurements such as urine strips and long ECG recordings without changing retry
@@ -676,5 +684,5 @@ behavior. The first observation should remain first when supplying observations
 The offline queue applies the same split when it flushes a measurement. A partial retry is safe:
 the first conditional create finds the existing observation and the batch only creates missing
 members. Applications building their own bundles can use the exported
-`MAX_CONDITIONAL_OBSERVATION_ENTRIES` limit. See [FHIR batch requests](https://www.medplum.com/docs/fhir-datastore/fhir-batch-requests)
-for the transaction and batch semantics.
+`MAX_CONDITIONAL_OBSERVATION_ENTRIES` limit. See the [Ovok FHIR documentation](https://docs.ovok.com/api/fhir/r4)
+for the transaction and batch semantics supported by the API.

package/dist/conformance/capability-requirements.js

@@ -48,7 +48,7 @@ exports.OVOK_CORE_REQUIREMENTS = {
     description: "The FHIR surface a server must provide for the @ovok/core client library's own methods to function.",
     software: {
         name: "@ovok/core",
-        version: "0.4.14",
+        version: "0.4.16",
     },
     fhirVersion: "4.0.1",
     format: ["json"],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ovok/core",
-  "version": "0.4.14",
+  "version": "0.4.16",
   "private": false,
   "main": "dist/index.js",
   "types": "dist/index.d.ts",