@ovok/core 0.3.4 → 0.3.5

package/README.md

@@ -14,6 +14,7 @@ Core TypeScript SDK for healthcare applications. Provides authentication, AI-FHI
 - 🤖 Bot execution framework
 - 📋 Questionnaire responses
 - 📥 Opt-in durable offline measurement queue with idempotent retries
+- 🧭 Runtime discovery of the backend FHIR and public API capabilities
 
 ## Installation
 
@@ -40,6 +41,20 @@ const client = new OvokClient({
 
 Full documentation and examples available at **[sdk.ovok.com](https://sdk.ovok.com/)**
 
+## Backend capability discovery
+
+`@ovok/core` can read the capability statement composed by `../ovok-core` and expose the
+non-FHIR public routes published in Ovok's `ovok-public-api` extension:
+
+```typescript
+const statement = await client.getCapabilityStatement();
+const publicEndpoints = await client.getPublicApiEndpoints();
+```
+
+The exported `OVOK_CORE_REQUIREMENTS` describes the FHIR operations used by the SDK, while
+`OVOK_CORE_API_REQUIREMENTS` describes its ordinary HTTP dependencies. Billing is intentionally
+not part of this SDK contract yet.
+
 ## Offline measurements
 
 Pass a durable Medplum storage adapter and opt in to queue measurements while offline:

package/dist/client/ovok-client.d.ts

@@ -1,5 +1,6 @@
 import { IClientStorage, MedplumClient, MedplumClientOptions, SubscriptionManager } from "@medplum/core";
-import { Bundle, Observation } from "@medplum/fhirtypes";
+import { Bundle, CapabilityStatement, Observation } from "@medplum/fhirtypes";
+import { OvokPublicApiEndpoint } from "../conformance/capability";
 import * as aiFhirMethods from "./ai-fhir/methods";
 import * as authMethods from "./auth/methods";
 import * as botMethods from "./bot/methods";
@@ -17,6 +18,7 @@ export type SaveObservationsResult = {
     status: "queued";
     queueId: string;
 };
+export type OvokFhirVersion = "R4" | "R5";
 export declare class OvokClient extends MedplumClient {
     protected socialLoginClientId: string;
     clientStorage: IClientStorage | undefined;
@@ -32,6 +34,10 @@ export declare class OvokClient extends MedplumClient {
     });
     /** Saves a measurement immediately, or durably queues it when the opt-in queue is enabled. */
     saveMeasurement(params: GenerateObservationBodyParams): Promise<SaveObservationsResult>;
+    /** Reads Ovok's composed FHIR and public-route capability statement. */
+    getCapabilityStatement(version?: OvokFhirVersion): Promise<CapabilityStatement>;
+    /** Returns the non-FHIR public routes published by the backend statement. */
+    getPublicApiEndpoints(version?: OvokFhirVersion): Promise<OvokPublicApiEndpoint[]>;
     /** Saves observations with conditional creates so a retry cannot create a duplicate. */
     saveObservations(observations: Observation[]): Promise<SaveObservationsResult>;
     /** Flushes measurements queued while offline. Call this on connectivity/app-resume events. */

package/dist/client/ovok-client.js

@@ -36,6 +36,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.OvokClient = exports.MAX_OBSERVATION_BUNDLE_BYTES = exports.MAX_CONDITIONAL_OBSERVATION_ENTRIES = void 0;
 /* eslint-disable @typescript-eslint/no-unsafe-function-type */ // TODO: fix this whenever find time
 const core_1 = require("@medplum/core");
+const capability_1 = require("../conformance/capability");
 const aiFhirMethods = __importStar(require("./ai-fhir/methods"));
 const authMethods = __importStar(require("./auth/methods"));
 const botMethods = __importStar(require("./bot/methods"));
@@ -72,6 +73,14 @@ class OvokClient extends core_1.MedplumClient {
         const observations = await this.generateObservationBodiesByMeasurement(params);
         return this.saveObservations(observations);
     }
+    /** Reads Ovok's composed FHIR and public-route capability statement. */
+    async getCapabilityStatement(version = "R4") {
+        return this.get(`/fhir/${version}/metadata`);
+    }
+    /** Returns the non-FHIR public routes published by the backend statement. */
+    async getPublicApiEndpoints(version = "R4") {
+        return (0, capability_1.getOvokPublicApiEndpoints)(await this.getCapabilityStatement(version));
+    }
     /** Saves observations with conditional creates so a retry cannot create a duplicate. */
     async saveObservations(observations) {
         const linkedObservations = (0, observation_bundle_utils_1.linkObservationMembers)(observations);

package/dist/conformance/api-requirements.d.ts

@@ -0,0 +1,34 @@
+export type OvokHttpMethod = "DELETE" | "GET" | "PATCH" | "POST" | "PUT";
+export type OvokApiRequirement = {
+    method: OvokHttpMethod;
+    path: string;
+    group: string;
+};
+/**
+ * The non-FHIR HTTP routes used by @ovok/core itself.
+ *
+ * This is deliberately separate from OVOK_CORE_REQUIREMENTS: a FHIR
+ * CapabilityStatement cannot describe ordinary auth, AI, or bot routes.
+ * Billing is intentionally absent until Ovok has a supported billing SDK
+ * contract.
+ */
+export declare const OVOK_CORE_API_REQUIREMENTS: {
+    readonly capability: {
+        readonly method: "GET";
+        readonly path: "/fhir/{version}/metadata";
+        readonly group: "FHIR";
+    };
+    readonly nonFhir: ({
+        method: "POST";
+        path: string;
+        group: string;
+    } | {
+        method: "GET";
+        path: string;
+        group: string;
+    } | {
+        method: "DELETE";
+        path: string;
+        group: string;
+    })[];
+};

package/dist/conformance/api-requirements.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OVOK_CORE_API_REQUIREMENTS = void 0;
+/**
+ * The non-FHIR HTTP routes used by @ovok/core itself.
+ *
+ * This is deliberately separate from OVOK_CORE_REQUIREMENTS: a FHIR
+ * CapabilityStatement cannot describe ordinary auth, AI, or bot routes.
+ * Billing is intentionally absent until Ovok has a supported billing SDK
+ * contract.
+ */
+exports.OVOK_CORE_API_REQUIREMENTS = {
+    capability: {
+        method: "GET",
+        path: "/fhir/{version}/metadata",
+        group: "FHIR",
+    },
+    nonFhir: [
+        { method: "POST", path: "/auth/tenant/Patient/login/start", group: "Auth" },
+        { method: "POST", path: "/auth/tenant/Practitioner/login/start", group: "Auth" },
+        { method: "POST", path: "/auth/tenant/Patient/login/token", group: "Auth" },
+        { method: "POST", path: "/auth/tenant/Practitioner/login/token", group: "Auth" },
+        { method: "POST", path: "/auth/tenant/Practitioner/login/mfa", group: "Auth" },
+        { method: "POST", path: "/auth/tenant/Patient/register", group: "Auth" },
+        { method: "POST", path: "/auth/external/google", group: "Auth" },
+        { method: "POST", path: "/auth/external/apple", group: "Auth" },
+        { method: "POST", path: "/auth/change-password", group: "Auth" },
+        { method: "POST", path: "/v2/auth/reset-password", group: "Auth" },
+        { method: "POST", path: "/v2/auth/reset-password/process", group: "Auth" },
+        { method: "GET", path: "/auth/session", group: "Auth" },
+        { method: "DELETE", path: "/auth/session/current", group: "Auth" },
+        { method: "DELETE", path: "/auth/session/:option", group: "Auth" },
+        { method: "DELETE", path: "/auth/delete", group: "Auth" },
+        { method: "POST", path: "/ai/session", group: "AI" },
+        { method: "POST", path: "/ai/fhir/search", group: "AI" },
+        { method: "POST", path: "/bots", group: "Bots" },
+    ],
+};

package/dist/conformance/capability-requirements.js

@@ -43,12 +43,12 @@ exports.OVOK_CORE_REQUIREMENTS = {
      * report change where there is none. Bump it with `software.version` when
      * the declared surface actually moves.
      */
-    date: "2026-09-19",
+    date: "2026-09-26",
     kind: "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.3.3",
+        version: "0.3.4",
     },
     fhirVersion: "4.0.1",
     format: ["json"],

package/dist/conformance/capability.d.ts

@@ -0,0 +1,15 @@
+import { CapabilityStatement } from "@medplum/fhirtypes";
+/** The extension used by ovok-core to publish non-FHIR public routes. */
+export declare const OVOK_PUBLIC_API_EXTENSION = "https://fhir.ovok.com/fhir/StructureDefinition/ovok-public-api";
+export type OvokPublicApiEndpoint = {
+    method: string;
+    path: string;
+    group: string;
+};
+/**
+ * Reads the public non-FHIR route catalog emitted by ../ovok-core.
+ *
+ * FHIR clients can ignore this extension safely. React applications can use
+ * it to feature-detect the rest of the Ovok API without hard-coding routes.
+ */
+export declare const getOvokPublicApiEndpoints: (statement: CapabilityStatement) => OvokPublicApiEndpoint[];

package/dist/conformance/capability.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getOvokPublicApiEndpoints = exports.OVOK_PUBLIC_API_EXTENSION = void 0;
+/** The extension used by ovok-core to publish non-FHIR public routes. */
+exports.OVOK_PUBLIC_API_EXTENSION = "https://fhir.ovok.com/fhir/StructureDefinition/ovok-public-api";
+const ENDPOINT_EXTENSION = "endpoint";
+const stringValue = (extension) => { var _a; return (_a = extension.valueCode) !== null && _a !== void 0 ? _a : extension.valueString; };
+/**
+ * Reads the public non-FHIR route catalog emitted by ../ovok-core.
+ *
+ * FHIR clients can ignore this extension safely. React applications can use
+ * it to feature-detect the rest of the Ovok API without hard-coding routes.
+ */
+const getOvokPublicApiEndpoints = (statement) => {
+    var _a, _b;
+    const publicApi = (_a = statement.extension) === null || _a === void 0 ? void 0 : _a.find((extension) => extension.url === exports.OVOK_PUBLIC_API_EXTENSION);
+    return ((_b = publicApi === null || publicApi === void 0 ? void 0 : publicApi.extension) !== null && _b !== void 0 ? _b : []).flatMap((endpoint) => {
+        var _a, _b, _c;
+        if (endpoint.url !== ENDPOINT_EXTENSION) {
+            return [];
+        }
+        const method = (_a = endpoint.extension) === null || _a === void 0 ? void 0 : _a.find((extension) => extension.url === "method");
+        const path = (_b = endpoint.extension) === null || _b === void 0 ? void 0 : _b.find((extension) => extension.url === "path");
+        const group = (_c = endpoint.extension) === null || _c === void 0 ? void 0 : _c.find((extension) => extension.url === "group");
+        const methodValue = method === undefined ? undefined : stringValue(method);
+        const pathValue = path === undefined ? undefined : stringValue(path);
+        const groupValue = group === undefined ? undefined : stringValue(group);
+        if (methodValue === undefined || pathValue === undefined || groupValue === undefined) {
+            return [];
+        }
+        return [
+            {
+                method: methodValue.toUpperCase(),
+                path: pathValue,
+                group: groupValue,
+            },
+        ];
+    });
+};
+exports.getOvokPublicApiEndpoints = getOvokPublicApiEndpoints;

package/dist/index.d.ts

@@ -933,3 +933,5 @@ export * from "./client/observation/services";
 export * from "./client/observation/methods";
 export { saveMeasurement } from "./client/observation/methods/saveMeasurement";
 export * from "./conformance/capability-requirements";
+export * from "./conformance/api-requirements";
+export * from "./conformance/capability";

package/dist/index.js

@@ -56,3 +56,5 @@ __exportStar(require("./client/observation/methods"), exports);
 var saveMeasurement_1 = require("./client/observation/methods/saveMeasurement");
 Object.defineProperty(exports, "saveMeasurement", { enumerable: true, get: function () { return saveMeasurement_1.saveMeasurement; } });
 __exportStar(require("./conformance/capability-requirements"), exports);
+__exportStar(require("./conformance/api-requirements"), exports);
+__exportStar(require("./conformance/capability"), exports);

package/package.json

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