@ovok/core 0.3.7 → 0.3.9

package/README.md

@@ -89,6 +89,48 @@ const alerts = await client.listCarehubMedicalNotifications({ count: 25 });
 CareHub is intentionally represented as typed application APIs rather than changing the FHIR
 observation save/offline behavior used by native integrations.
 
+## Application APIs
+
+The client also exposes typed application APIs for consent signatures, document upload credentials,
+document download endpoints, CMS content, LiveKit video calls, translation, AI chat, and AI FHIR
+search. These methods are additive and do not change the native observation or offline contracts.
+
+```ts
+const content = await client.searchContent("blog", "en-US", { search: "welcome" });
+const appointment = await client.createVideoCallAppointment({
+  start: "2026-01-01T10:00:00.000Z",
+  end: "2026-01-01T11:00:00.000Z",
+  comment: "Check-in",
+  videoCallParticipants: [{ email: "patient@example.com" }],
+});
+const translation = await client.translate({
+  sourceLanguage: "en",
+  targetLanguage: "de",
+  text: ["Welcome"],
+});
+```
+
+Document download methods return the backend endpoint URL so applications can use it in media or
+download elements; the backend remains responsible for authorization and signed redirects.
+
+## React hooks
+
+The package exports additive hooks for capability discovery, project configuration, CareHub lists,
+telemetry, and notifications. Every request hook returns `data`, `loading`, `error`, and `reload`.
+
+```tsx
+const { data: patients, loading, error } = useCarehubPatients({
+  residentState: "active",
+});
+
+const saveSettings = useOvokMutation((client, settings: OvokProjectSettings) =>
+  client.updateProjectSetting("PATIENT_LOGIN_ENABLED", settings.settings.PATIENT_LOGIN_ENABLED),
+);
+```
+
+Hooks are additive to the existing `OvokProvider`, observation hooks, auth methods, and offline
+queue. Billing remains outside the SDK contract.
+
 ## Offline measurements
 
 Pass a durable Medplum storage adapter and opt in to queue measurements while offline:

package/dist/client/experience/methods.d.ts

@@ -0,0 +1,53 @@
+import { OvokClient } from "../ovok-client";
+import { OvokChatMessage, OvokChatMessageInput, OvokChatMessageQuery, OvokChatMessagesResponse, OvokChatSession, OvokChatSessionQuery, OvokChatSessionsResponse, OvokConsentSignatureResponse, OvokContent, OvokContentBody, OvokContentQuery, OvokContentSearchResponse, OvokCreateChatSession, OvokDocumentFile, OvokDocumentMetadataUpdate, OvokDocumentReplacement, OvokDocumentSearchQuery, OvokDocumentSearchResponse, OvokDocumentUploadRequest, OvokMappedContentSearchResponse, OvokTranslationRequest, OvokTranslationResponse, OvokVideoCallAccess, OvokVideoCallAppointment, OvokVideoCallAppointmentInput, OvokVideoCallAppointmentQuery, OvokVideoCallGuestAccess, OvokVideoCallMailRequest, OvokVideoCallMailResponse } from "./types";
+export declare function requestConsentSignature(this: OvokClient, consentId: string): Promise<OvokConsentSignatureResponse>;
+export declare function createDocumentUpload(this: OvokClient, body: OvokDocumentUploadRequest): Promise<OvokDocumentFile>;
+export declare function listDocuments(this: OvokClient, params?: OvokDocumentSearchQuery): Promise<OvokDocumentSearchResponse>;
+/** Returns the authenticated document endpoint; navigating/fetching it follows the backend redirect. */
+export declare function getDocumentDownloadUrl(this: OvokClient, documentId: string, params?: {
+    width?: string | number;
+    height?: string | number;
+    fit?: string;
+}): Promise<string>;
+/** Returns a public document endpoint for use in an image, download, or media element. */
+export declare function getPublicDocumentDownloadUrl(this: OvokClient, token: string, params?: {
+    width?: string | number;
+    height?: string | number;
+    fit?: string;
+}): Promise<string>;
+export declare function deleteDocument(this: OvokClient, documentId: string): Promise<{
+    message: string;
+}>;
+export declare function updateDocumentMetadata(this: OvokClient, documentId: string, body: OvokDocumentMetadataUpdate): Promise<OvokDocumentFile>;
+export declare function generateDocumentReplacementUpload(this: OvokClient, documentId: string, body: OvokDocumentReplacement): Promise<OvokDocumentFile>;
+export declare function searchMappedContent(this: OvokClient, type: string, language: string, params?: OvokContentQuery): Promise<OvokMappedContentSearchResponse>;
+export declare function copyContentsFromParent(this: OvokClient, type: string, language: string): Promise<{
+    success: boolean;
+}>;
+export declare function copyContentFromParent(this: OvokClient, type: string, language: string, key: string): Promise<{
+    success: boolean;
+}>;
+export declare function createContent(this: OvokClient, type: string, language: string, body: OvokContentBody): Promise<OvokContent>;
+export declare function updateContent(this: OvokClient, type: string, language: string, key: string, body: OvokContentBody): Promise<OvokContent>;
+export declare function getContent(this: OvokClient, type: string, language: string, key: string): Promise<OvokContent>;
+export declare function deleteContent(this: OvokClient, type: string, language: string, key: string): Promise<void>;
+export declare function searchContent(this: OvokClient, type: string, language: string, params?: OvokContentQuery): Promise<OvokContentSearchResponse>;
+export declare function createVideoCallAppointment(this: OvokClient, body: OvokVideoCallAppointmentInput): Promise<OvokVideoCallAppointment>;
+export declare function updateVideoCallAppointment(this: OvokClient, appointmentId: string, body: OvokVideoCallAppointmentInput): Promise<OvokVideoCallAppointment>;
+export declare function listVideoCallAppointments(this: OvokClient, params?: OvokVideoCallAppointmentQuery): Promise<OvokVideoCallAppointment[]>;
+export declare function getVideoCallAccessPermission(this: OvokClient, appointmentId: string): Promise<Record<string, unknown>>;
+export declare function createVideoCallGuestAccess(this: OvokClient, appointmentId: string, body: OvokVideoCallGuestAccess): Promise<OvokVideoCallAccess>;
+export declare function createVideoCallUserAccess(this: OvokClient, appointmentId: string): Promise<OvokVideoCallAccess>;
+export declare function sendVideoCallInvite(this: OvokClient, body: OvokVideoCallMailRequest): Promise<OvokVideoCallMailResponse>;
+export declare function sendVideoCallUpdate(this: OvokClient, body: OvokVideoCallMailRequest): Promise<OvokVideoCallMailResponse>;
+export declare function sendVideoCallCancellation(this: OvokClient, body: OvokVideoCallMailRequest): Promise<OvokVideoCallMailResponse>;
+export declare function sendVideoCallActiveNotification(this: OvokClient, appointmentId: string): Promise<Record<string, unknown>>;
+export declare function translate(this: OvokClient, body: OvokTranslationRequest): Promise<OvokTranslationResponse>;
+export declare function createChatSession(this: OvokClient, body: OvokCreateChatSession): Promise<OvokChatSession>;
+export declare function sendChatMessage(this: OvokClient, sessionId: string, body: OvokChatMessageInput): Promise<OvokChatMessage>;
+export declare function listChatSessions(this: OvokClient, params?: OvokChatSessionQuery): Promise<OvokChatSessionsResponse>;
+export declare function getChatSession(this: OvokClient, sessionId: string, params?: {
+    messageCount?: number;
+}): Promise<OvokChatSession>;
+export declare function listChatMessages(this: OvokClient, sessionId: string, params?: OvokChatMessageQuery): Promise<OvokChatMessagesResponse>;
+export declare function searchAIFhir(this: OvokClient, request: Record<string, unknown>): Promise<Record<string, unknown>>;

package/dist/client/experience/methods.js

@@ -0,0 +1,149 @@
+"use strict";
+/* eslint-disable max-lines -- the experience facade keeps related app APIs discoverable. */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.requestConsentSignature = requestConsentSignature;
+exports.createDocumentUpload = createDocumentUpload;
+exports.listDocuments = listDocuments;
+exports.getDocumentDownloadUrl = getDocumentDownloadUrl;
+exports.getPublicDocumentDownloadUrl = getPublicDocumentDownloadUrl;
+exports.deleteDocument = deleteDocument;
+exports.updateDocumentMetadata = updateDocumentMetadata;
+exports.generateDocumentReplacementUpload = generateDocumentReplacementUpload;
+exports.searchMappedContent = searchMappedContent;
+exports.copyContentsFromParent = copyContentsFromParent;
+exports.copyContentFromParent = copyContentFromParent;
+exports.createContent = createContent;
+exports.updateContent = updateContent;
+exports.getContent = getContent;
+exports.deleteContent = deleteContent;
+exports.searchContent = searchContent;
+exports.createVideoCallAppointment = createVideoCallAppointment;
+exports.updateVideoCallAppointment = updateVideoCallAppointment;
+exports.listVideoCallAppointments = listVideoCallAppointments;
+exports.getVideoCallAccessPermission = getVideoCallAccessPermission;
+exports.createVideoCallGuestAccess = createVideoCallGuestAccess;
+exports.createVideoCallUserAccess = createVideoCallUserAccess;
+exports.sendVideoCallInvite = sendVideoCallInvite;
+exports.sendVideoCallUpdate = sendVideoCallUpdate;
+exports.sendVideoCallCancellation = sendVideoCallCancellation;
+exports.sendVideoCallActiveNotification = sendVideoCallActiveNotification;
+exports.translate = translate;
+exports.createChatSession = createChatSession;
+exports.sendChatMessage = sendChatMessage;
+exports.listChatSessions = listChatSessions;
+exports.getChatSession = getChatSession;
+exports.listChatMessages = listChatMessages;
+exports.searchAIFhir = searchAIFhir;
+const segment = (value) => encodeURIComponent(value);
+const query = (params) => {
+    const values = new URLSearchParams();
+    for (const [key, value] of Object.entries(params)) {
+        if (value !== undefined) {
+            values.set(key, String(value));
+        }
+    }
+    const encoded = values.toString();
+    return encoded === "" ? "" : `?${encoded}`;
+};
+const documentUrl = (client, path, params) => `${client.getBaseUrl().replace(/\/$/, "")}${path}${query(params)}`;
+async function requestConsentSignature(consentId) {
+    return this.post(`/consent/signature/${segment(consentId)}`);
+}
+async function createDocumentUpload(body) {
+    return this.post("/document", body);
+}
+async function listDocuments(params = {}) {
+    return this.get(`/document${query(params)}`);
+}
+/** Returns the authenticated document endpoint; navigating/fetching it follows the backend redirect. */
+async function getDocumentDownloadUrl(documentId, params = {}) {
+    return documentUrl(this, `/document/${segment(documentId)}`, params);
+}
+/** Returns a public document endpoint for use in an image, download, or media element. */
+async function getPublicDocumentDownloadUrl(token, params = {}) {
+    return documentUrl(this, `/document/public/${segment(token)}`, params);
+}
+async function deleteDocument(documentId) {
+    return (await this.delete(`/document/${segment(documentId)}`));
+}
+async function updateDocumentMetadata(documentId, body) {
+    return (await this.patch(`/document/${segment(documentId)}`, body));
+}
+async function generateDocumentReplacementUpload(documentId, body) {
+    return this.post(`/document/${segment(documentId)}`, body);
+}
+async function searchMappedContent(type, language, params = {}) {
+    return this.get(`/cms/${segment(type)}/map/${segment(language)}${query(params)}`);
+}
+async function copyContentsFromParent(type, language) {
+    return this.post(`/cms/${segment(type)}/${segment(language)}/copy-from-parent-project`);
+}
+async function copyContentFromParent(type, language, key) {
+    return this.post(`/cms/${segment(type)}/${segment(language)}/${segment(key)}/copy-from-parent-project`);
+}
+async function createContent(type, language, body) {
+    return this.post(`/cms/${segment(type)}/${segment(language)}`, body);
+}
+async function updateContent(type, language, key, body) {
+    return (await this.put(`/cms/${segment(type)}/${segment(language)}/${segment(key)}`, body));
+}
+async function getContent(type, language, key) {
+    return this.get(`/cms/${segment(type)}/${segment(language)}/${segment(key)}`);
+}
+async function deleteContent(type, language, key) {
+    await this.delete(`/cms/${segment(type)}/${segment(language)}/${segment(key)}`);
+}
+async function searchContent(type, language, params = {}) {
+    return this.get(`/cms/${segment(type)}/${segment(language)}${query(params)}`);
+}
+async function createVideoCallAppointment(body) {
+    return this.post("/video-call/livekit/appointment", body);
+}
+async function updateVideoCallAppointment(appointmentId, body) {
+    return (await this.put(`/video-call/livekit/appointment/${segment(appointmentId)}`, body));
+}
+async function listVideoCallAppointments(params = {}) {
+    return this.get(`/video-call/livekit/appointment${query(params)}`);
+}
+async function getVideoCallAccessPermission(appointmentId) {
+    return this.get(`/video-call/livekit/access-permission/${segment(appointmentId)}`);
+}
+async function createVideoCallGuestAccess(appointmentId, body) {
+    return this.post(`/video-call/livekit/guest-access/${segment(appointmentId)}`, body);
+}
+async function createVideoCallUserAccess(appointmentId) {
+    return this.post(`/video-call/livekit/user-access/${segment(appointmentId)}`);
+}
+async function sendVideoCallInvite(body) {
+    return this.post("/video-call/livekit/mail/invite", body);
+}
+async function sendVideoCallUpdate(body) {
+    return this.post("/video-call/livekit/mail/update", body);
+}
+async function sendVideoCallCancellation(body) {
+    return this.post("/video-call/livekit/mail/cancel", body);
+}
+async function sendVideoCallActiveNotification(appointmentId) {
+    return this.post(`/video-call/livekit/notification/active-call/${segment(appointmentId)}`);
+}
+async function translate(body) {
+    return this.post("/ai/translation", body);
+}
+async function createChatSession(body) {
+    return this.post("/ai/session", body);
+}
+async function sendChatMessage(sessionId, body) {
+    return this.post(`/ai/session/${segment(sessionId)}/message`, body);
+}
+async function listChatSessions(params = {}) {
+    return this.get(`/ai/session${query(params)}`);
+}
+async function getChatSession(sessionId, params = {}) {
+    return this.get(`/ai/session/${segment(sessionId)}${query(params)}`);
+}
+async function listChatMessages(sessionId, params = {}) {
+    return this.get(`/ai/session/${segment(sessionId)}/message${query(params)}`);
+}
+async function searchAIFhir(request) {
+    return this.post("/ai/fhir/search", request);
+}

package/dist/client/experience/types.d.ts

@@ -0,0 +1,207 @@
+export type OvokConsentSignatureResponse = {
+    numberOfPages: number;
+    title: string;
+    author: string;
+    subject: string;
+    documentId: string;
+    email: string;
+};
+export type OvokDocumentUploadRequest = {
+    fileName: string;
+    contentType: string;
+    isPublic?: boolean;
+};
+export type OvokDocumentUploadOptions = {
+    url: string;
+    fields: Record<string, string>;
+};
+export type OvokDocumentFile = {
+    id: string;
+    meta?: {
+        lastUpdated: string;
+    };
+    author?: {
+        reference?: string;
+        display?: string;
+    };
+    fileName?: string;
+    contentType?: string;
+    uploadOptions?: OvokDocumentUploadOptions;
+    publicToken?: string;
+};
+export type OvokDocumentSearchQuery = {
+    _count?: number;
+    _offset?: number;
+    _sort?: string;
+};
+export type OvokDocumentSearchResponse = {
+    total: number;
+    resources: OvokDocumentFile[];
+};
+export type OvokDocumentMetadataUpdate = {
+    fileName?: string;
+    isPublic?: boolean;
+    contentType?: string;
+};
+export type OvokDocumentReplacement = {
+    fileName: string;
+    contentType: string;
+    isPublic?: boolean;
+};
+export type OvokContentType = "blog" | "video" | "audio" | "template" | "export-template";
+export type OvokContentSection = {
+    title?: string;
+    text?: string;
+    extension?: Record<string, string>;
+    code?: string[];
+};
+export type OvokContent = {
+    id?: string;
+    title: string;
+    author: {
+        reference: string;
+        display?: string;
+    };
+    key: string;
+    language: string;
+    date: string;
+    projectId?: string;
+    type: OvokContentType;
+    code?: string;
+    category?: string[];
+    section?: OvokContentSection[];
+};
+export type OvokContentBody = Pick<OvokContent, "title" | "category" | "section" | "code">;
+export type OvokContentQuery = {
+    search?: string;
+    code?: string;
+    _count?: number;
+    _offset?: number;
+};
+export type OvokContentSearchResponse = {
+    total: number;
+    resources: OvokContent[];
+};
+export type OvokMappedContent = {
+    source?: OvokContent;
+    target?: OvokContent;
+};
+export type OvokMappedContentSearchResponse = {
+    total: number;
+    resources: OvokMappedContent[];
+};
+export type OvokVideoCallAppointmentInput = {
+    id?: string;
+    start: string;
+    end: string;
+    comment: string;
+    description?: string;
+    videoCallParticipants: {
+        email: string;
+    }[];
+};
+export type OvokVideoCallAppointmentStatus = "proposed" | "pending" | "booked" | "arrived" | "fulfilled" | "cancelled" | "noshow" | "entered-in-error" | "checked-in" | "waitlist";
+export type OvokVideoCallAppointment = {
+    id: string;
+    resourceType: "Appointment";
+    status: OvokVideoCallAppointmentStatus;
+    start: string;
+    end: string;
+    comment: string;
+    description?: string;
+    videoCallParticipants: {
+        email: string;
+        status: "accepted" | "declined" | "tentative" | "needs-action";
+        profileRef: string;
+    }[];
+    passphrase: string;
+};
+export type OvokVideoCallAppointmentQuery = {
+    startDate?: string;
+    endDate?: string;
+};
+export type OvokVideoCallGuestAccess = {
+    guestEmail: string;
+};
+export type OvokVideoCallAccess = {
+    videoCallUrl: string;
+    livekitJwt: string;
+    passphrase: string;
+};
+export type OvokVideoCallMailRequest = {
+    appointmentId: string;
+    emailRecipients: {
+        email: string;
+        profileRef: string;
+    }[];
+};
+export type OvokVideoCallMailResponse = {
+    appointmentId: string;
+    emailRecipientsResult: {
+        email: string;
+        profileRef: string;
+        isEmailSent: boolean;
+    }[];
+};
+export type OvokTranslationRequest = {
+    sourceLanguage: string;
+    targetLanguage: string;
+    text: string[];
+};
+export type OvokTranslationResponse = OvokTranslationRequest;
+export type OvokChatMessage = {
+    reference: string;
+    sender: string;
+    content: string;
+    sentAt: string;
+    mode: "assistant" | "user" | "system";
+};
+export type OvokChatAssistant = {
+    system: string;
+    context?: string[];
+    history?: number;
+    participant: string;
+};
+export type OvokCreateChatSession = {
+    assistant: OvokChatAssistant;
+    participant: string;
+    title?: string;
+    messages: {
+        sender: string;
+        content: string;
+        mode?: "assistant" | "user" | "system";
+    }[];
+};
+export type OvokChatSession = {
+    reference?: string;
+    participant: string;
+    title?: string;
+    assistant: OvokChatAssistant;
+    messages?: OvokChatMessage[];
+};
+export type OvokChatSessionsResponse = {
+    sessions: OvokChatSession[];
+};
+export type OvokChatMessagesResponse = {
+    messages: OvokChatMessage[];
+};
+export type OvokChatSessionQuery = {
+    _id?: string;
+    _sort?: "-sent" | "sent";
+    _count?: number;
+    _offset?: number;
+    messageCount?: number;
+};
+export type OvokChatMessageInput = {
+    content: string;
+    sender: string;
+    mode?: "assistant" | "user" | "system";
+    replyTo?: string;
+};
+export type OvokChatMessageQuery = {
+    _sort?: "-sent" | "sent";
+    _count?: number;
+    _offset?: number;
+};
+export type OvokAIFhirRequest = Record<string, unknown>;
+export type OvokAIFhirResponse = Record<string, unknown>;

package/dist/client/experience/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -6,6 +6,7 @@ import * as authMethods from "./auth/methods";
 import * as botMethods from "./bot/methods";
 import * as carehubMethods from "./carehub/methods";
 import * as aiMethods from "./chat/ai/methods";
+import * as experienceMethods from "./experience/methods";
 import * as observationMethods from "./observation/methods";
 import { GenerateObservationBodyParams } from "./observation/types/generate-observation-body/GenerateObservationBodyParams";
 import { OfflineMeasurementFlushOptions, OfflineMeasurementFlushResult, OfflineMeasurementQueueOptions } from "./offline";
@@ -56,7 +57,7 @@ export declare class OvokClient extends MedplumClient {
      */
     getSubscriptionManager(): SubscriptionManager;
 }
-type Methods = typeof authMethods & typeof observationMethods & typeof questionnaireResponseMethods & typeof aiMethods & typeof aiFhirMethods & typeof botMethods & typeof carehubMethods & typeof platformMethods;
+type Methods = typeof authMethods & typeof observationMethods & typeof questionnaireResponseMethods & typeof aiMethods & typeof aiFhirMethods & typeof botMethods & typeof carehubMethods & typeof platformMethods & typeof experienceMethods;
 type Omitted<T> = Omit<T, "executeBot">;
 declare module "./ovok-client" {
     interface OvokClient extends Omitted<Methods> {

package/dist/client/ovok-client.js

@@ -43,6 +43,7 @@ const botMethods = __importStar(require("./bot/methods"));
 const carehubMethods = __importStar(require("./carehub/methods"));
 const aiMethods = __importStar(require("./chat/ai/methods"));
 const rate_limit_error_1 = require("./errors/rate-limit-error");
+const experienceMethods = __importStar(require("./experience/methods"));
 const observationMethods = __importStar(require("./observation/methods"));
 const observation_bundle_utils_1 = require("./observation/observation-bundle-utils");
 const offline_1 = require("./offline");
@@ -69,6 +70,7 @@ class OvokClient extends core_1.MedplumClient {
         this.bindMethods(botMethods);
         this.bindMethods(carehubMethods);
         this.bindMethods(platformMethods);
+        this.bindMethods(experienceMethods);
         this.clientStorage = config.storage;
         this.offlineQueueOptions = (_b = config.offlineQueue) !== null && _b !== void 0 ? _b : {};
     }

package/dist/conformance/api-requirements.js

@@ -33,7 +33,38 @@ exports.OVOK_CORE_API_REQUIREMENTS = {
         { method: "DELETE", path: "/auth/delete", group: "Auth" },
         { method: "POST", path: "/ai/session", group: "AI" },
         { method: "POST", path: "/ai/fhir/search", group: "AI" },
+        { method: "GET", path: "/ai/session", group: "AI" },
+        { method: "GET", path: "/ai/session/:id", group: "AI" },
+        { method: "GET", path: "/ai/session/:id/message", group: "AI" },
+        { method: "POST", path: "/ai/session/:id/message", group: "AI" },
+        { method: "POST", path: "/ai/translation", group: "AI" },
         { method: "POST", path: "/bots", group: "Bots" },
+        { method: "POST", path: "/consent/signature/:consentId", group: "Consent" },
+        { method: "POST", path: "/document", group: "Documents" },
+        { method: "GET", path: "/document", group: "Documents" },
+        { method: "GET", path: "/document/public/:token", group: "Documents" },
+        { method: "GET", path: "/document/:id", group: "Documents" },
+        { method: "DELETE", path: "/document/:id", group: "Documents" },
+        { method: "PATCH", path: "/document/:id", group: "Documents" },
+        { method: "POST", path: "/document/:id", group: "Documents" },
+        { method: "GET", path: "/cms/:type/map/:language", group: "Content" },
+        { method: "POST", path: "/cms/:type/:language/copy-from-parent-project", group: "Content" },
+        { method: "POST", path: "/cms/:type/:language/:key/copy-from-parent-project", group: "Content" },
+        { method: "POST", path: "/cms/:type/:language", group: "Content" },
+        { method: "PUT", path: "/cms/:type/:language/:key", group: "Content" },
+        { method: "GET", path: "/cms/:type/:language/:key", group: "Content" },
+        { method: "DELETE", path: "/cms/:type/:language/:key", group: "Content" },
+        { method: "GET", path: "/cms/:type/:language", group: "Content" },
+        { method: "GET", path: "/video-call/livekit/access-permission/:appointmentId", group: "Video" },
+        { method: "POST", path: "/video-call/livekit/guest-access/:appointmentId", group: "Video" },
+        { method: "POST", path: "/video-call/livekit/user-access/:appointmentId", group: "Video" },
+        { method: "POST", path: "/video-call/livekit/appointment", group: "Video" },
+        { method: "PUT", path: "/video-call/livekit/appointment/:appointmentId", group: "Video" },
+        { method: "GET", path: "/video-call/livekit/appointment", group: "Video" },
+        { method: "POST", path: "/video-call/livekit/mail/invite", group: "Video" },
+        { method: "POST", path: "/video-call/livekit/mail/update", group: "Video" },
+        { method: "POST", path: "/video-call/livekit/mail/cancel", group: "Video" },
+        { method: "POST", path: "/video-call/livekit/notification/active-call/:appointmentId", group: "Video" },
         { method: "GET", path: "/accounts", group: "Accounts" },
         { method: "GET", path: "/v1/projects", group: "Projects" },
         { method: "POST", path: "/v1/projects", group: "Projects" },

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.3.6",
+        version: "0.3.8",
     },
     fhirVersion: "4.0.1",
     format: ["json"],

package/dist/hooks/api-hooks.d.ts

@@ -0,0 +1,39 @@
+import { CapabilityStatement } from "@medplum/fhirtypes";
+import { CarehubDeviceListItem, CarehubDeviceListQuery, CarehubDeviceTelemetry, CarehubNotificationsQuery, CarehubNotificationsResponse, CarehubPage, CarehubPatientListItem, CarehubPatientListQuery, CarehubRecentNotificationsResponse } from "../client/carehub/types";
+import { OvokClient, OvokFhirVersion } from "../client/ovok-client";
+import { OvokAdministeredProject, OvokProjectFeatures, OvokProjectSettings } from "../client/platform/types";
+import { OvokPublicApiEndpoint } from "../conformance/capability";
+export type OvokRequestState<T> = {
+    data: T | undefined;
+    loading: boolean;
+    error: Error | undefined;
+    reload: () => void;
+};
+export type OvokMutationState<TParams, TData> = {
+    data: TData | undefined;
+    loading: boolean;
+    error: Error | undefined;
+    mutate: (params: TParams) => Promise<TData>;
+    reset: () => void;
+};
+/**
+ * Small request primitive for the typed Ovok hooks. It deliberately does not
+ * add a cache or retry policy: MedplumClient already owns request caching and
+ * the host app owns the retry policy appropriate to its screen.
+ */
+export declare function useOvokRequest<T>(load: () => Promise<T>, enabled?: boolean): OvokRequestState<T>;
+/** Generic mutation hook for any typed OvokClient method. */
+export declare function useOvokMutation<TParams, TData>(mutateRequest: (client: OvokClient, params: TParams) => Promise<TData>): OvokMutationState<TParams, TData>;
+export declare const useCapabilityStatement: (version?: OvokFhirVersion) => OvokRequestState<CapabilityStatement>;
+export declare const usePublicApiEndpoints: (version?: OvokFhirVersion) => OvokRequestState<OvokPublicApiEndpoint[]>;
+export declare const useAdministeredProjects: (params?: {
+    page?: number;
+    count?: number;
+}) => OvokRequestState<CarehubPage<OvokAdministeredProject>>;
+export declare const useProjectSettings: () => OvokRequestState<OvokProjectSettings>;
+export declare const useProjectFeatures: () => OvokRequestState<OvokProjectFeatures>;
+export declare const useCarehubPatients: (params?: CarehubPatientListQuery) => OvokRequestState<CarehubPage<CarehubPatientListItem>>;
+export declare const useCarehubDevices: (params?: CarehubDeviceListQuery) => OvokRequestState<CarehubPage<CarehubDeviceListItem>>;
+export declare const useCarehubDeviceTelemetry: (deviceId?: string) => OvokRequestState<CarehubDeviceTelemetry>;
+export declare const useCarehubNotifications: (params?: CarehubNotificationsQuery) => OvokRequestState<CarehubNotificationsResponse>;
+export declare const useRecentCarehubNotifications: (count?: number) => OvokRequestState<CarehubRecentNotificationsResponse>;

package/dist/hooks/api-hooks.js

@@ -0,0 +1,179 @@
+"use strict";
+"use client";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useRecentCarehubNotifications = exports.useCarehubNotifications = exports.useCarehubDeviceTelemetry = exports.useCarehubDevices = exports.useCarehubPatients = exports.useProjectFeatures = exports.useProjectSettings = exports.useAdministeredProjects = exports.usePublicApiEndpoints = exports.useCapabilityStatement = void 0;
+exports.useOvokRequest = useOvokRequest;
+exports.useOvokMutation = useOvokMutation;
+const React = __importStar(require("react"));
+const index_1 = require("./index");
+const toError = (error) => error instanceof Error ? error : new Error(String(error));
+/**
+ * Small request primitive for the typed Ovok hooks. It deliberately does not
+ * add a cache or retry policy: MedplumClient already owns request caching and
+ * the host app owns the retry policy appropriate to its screen.
+ */
+function useOvokRequest(load, enabled = true) {
+    const [data, setData] = React.useState();
+    const [error, setError] = React.useState();
+    const [loading, setLoading] = React.useState(enabled);
+    const [revision, setRevision] = React.useState(0);
+    React.useEffect(() => {
+        let disposed = false;
+        if (!enabled) {
+            setLoading(false);
+            setError(undefined);
+            return () => {
+                disposed = true;
+            };
+        }
+        setLoading(true);
+        setError(undefined);
+        load()
+            .then((value) => {
+            if (!disposed) {
+                setData(value);
+                setLoading(false);
+            }
+        })
+            .catch((reason) => {
+            if (!disposed) {
+                setError(toError(reason));
+                setLoading(false);
+            }
+        });
+        return () => {
+            disposed = true;
+        };
+    }, [enabled, load, revision]);
+    const reload = React.useCallback(() => setRevision((value) => value + 1), []);
+    return { data, loading, error, reload };
+}
+/** Generic mutation hook for any typed OvokClient method. */
+function useOvokMutation(mutateRequest) {
+    const client = (0, index_1.useClient)();
+    const [data, setData] = React.useState();
+    const [error, setError] = React.useState();
+    const [loading, setLoading] = React.useState(false);
+    const mutate = React.useCallback(async (params) => {
+        setLoading(true);
+        setError(undefined);
+        try {
+            const value = await mutateRequest(client, params);
+            setData(value);
+            return value;
+        }
+        catch (reason) {
+            const requestError = toError(reason);
+            setError(requestError);
+            throw requestError;
+        }
+        finally {
+            setLoading(false);
+        }
+    }, [client, mutateRequest]);
+    const reset = React.useCallback(() => {
+        setData(undefined);
+        setError(undefined);
+        setLoading(false);
+    }, []);
+    return { data, loading, error, mutate, reset };
+}
+const useCapabilityStatement = (version = "R4") => {
+    const client = (0, index_1.useClient)();
+    const load = React.useCallback(() => client.getCapabilityStatement(version), [client, version]);
+    return useOvokRequest(load);
+};
+exports.useCapabilityStatement = useCapabilityStatement;
+const usePublicApiEndpoints = (version = "R4") => {
+    const client = (0, index_1.useClient)();
+    const load = React.useCallback(() => client.getPublicApiEndpoints(version), [client, version]);
+    return useOvokRequest(load);
+};
+exports.usePublicApiEndpoints = usePublicApiEndpoints;
+const useAdministeredProjects = (params = {}) => {
+    const client = (0, index_1.useClient)();
+    const serialized = JSON.stringify(params);
+    const load = React.useCallback(() => client.listAdministeredProjects(params), [client, serialized]);
+    return useOvokRequest(load);
+};
+exports.useAdministeredProjects = useAdministeredProjects;
+const useProjectSettings = () => {
+    const client = (0, index_1.useClient)();
+    const load = React.useCallback(() => client.getProjectSettings(), [client]);
+    return useOvokRequest(load);
+};
+exports.useProjectSettings = useProjectSettings;
+const useProjectFeatures = () => {
+    const client = (0, index_1.useClient)();
+    const load = React.useCallback(() => client.getProjectFeatures(), [client]);
+    return useOvokRequest(load);
+};
+exports.useProjectFeatures = useProjectFeatures;
+const useCarehubPatients = (params = {}) => {
+    const client = (0, index_1.useClient)();
+    const serialized = JSON.stringify(params);
+    const load = React.useCallback(() => client.listCarehubPatients(params), [client, serialized]);
+    return useOvokRequest(load);
+};
+exports.useCarehubPatients = useCarehubPatients;
+const useCarehubDevices = (params = {}) => {
+    const client = (0, index_1.useClient)();
+    const serialized = JSON.stringify(params);
+    const load = React.useCallback(() => client.listCarehubDevices(params), [client, serialized]);
+    return useOvokRequest(load);
+};
+exports.useCarehubDevices = useCarehubDevices;
+const useCarehubDeviceTelemetry = (deviceId) => {
+    const client = (0, index_1.useClient)();
+    const load = React.useCallback(() => deviceId
+        ? client.getCarehubDeviceTelemetry(deviceId)
+        : Promise.reject(new Error("deviceId is required")), [client, deviceId]);
+    return useOvokRequest(load, deviceId !== undefined);
+};
+exports.useCarehubDeviceTelemetry = useCarehubDeviceTelemetry;
+const useCarehubNotifications = (params = {}) => {
+    const client = (0, index_1.useClient)();
+    const serialized = JSON.stringify(params);
+    const load = React.useCallback(() => client.listCarehubNotifications(params), [client, serialized]);
+    return useOvokRequest(load);
+};
+exports.useCarehubNotifications = useCarehubNotifications;
+const useRecentCarehubNotifications = (count) => {
+    const client = (0, index_1.useClient)();
+    const load = React.useCallback(() => client.getRecentCarehubNotifications(count), [client, count]);
+    return useOvokRequest(load);
+};
+exports.useRecentCarehubNotifications = useRecentCarehubNotifications;

package/dist/hooks/index.d.ts

@@ -6,3 +6,4 @@ export declare const OvokProvider: (props: React.PropsWithChildren<{
     client: OvokClient;
 }>) => React.JSX.Element;
 export { observationsToMeasurements, useEcgRecording, useObservations, useSaveMeasurement, useUrineTests, } from "./observation-hooks";
+export { useAdministeredProjects, useCarehubDeviceTelemetry, useCarehubDevices, useCarehubNotifications, useCarehubPatients, useCapabilityStatement, useOvokMutation, useOvokRequest, useProjectFeatures, useProjectSettings, usePublicApiEndpoints, useRecentCarehubNotifications, } from "./api-hooks";

package/dist/hooks/index.js

@@ -34,7 +34,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useUrineTests = exports.useSaveMeasurement = exports.useObservations = exports.useEcgRecording = exports.observationsToMeasurements = exports.OvokProvider = exports.useClient = exports.useCachedBinaryUrl = exports.reactContext = exports.useSubscription = exports.useSearchResources = exports.useSearchOne = exports.useSearch = exports.useResource = exports.usePrevious = exports.useMedplumProfile = exports.useMedplumNavigate = exports.useMedplumContext = void 0;
+exports.useRecentCarehubNotifications = exports.usePublicApiEndpoints = exports.useProjectSettings = exports.useProjectFeatures = exports.useOvokRequest = exports.useOvokMutation = exports.useCapabilityStatement = exports.useCarehubPatients = exports.useCarehubNotifications = exports.useCarehubDevices = exports.useCarehubDeviceTelemetry = exports.useAdministeredProjects = exports.useUrineTests = exports.useSaveMeasurement = exports.useObservations = exports.useEcgRecording = exports.observationsToMeasurements = exports.OvokProvider = exports.useClient = exports.useCachedBinaryUrl = exports.reactContext = exports.useSubscription = exports.useSearchResources = exports.useSearchOne = exports.useSearch = exports.useResource = exports.usePrevious = exports.useMedplumProfile = exports.useMedplumNavigate = exports.useMedplumContext = void 0;
 /*
  * The only React-dependent module in the package.
  *
@@ -76,3 +76,16 @@ Object.defineProperty(exports, "useEcgRecording", { enumerable: true, get: funct
 Object.defineProperty(exports, "useObservations", { enumerable: true, get: function () { return observation_hooks_1.useObservations; } });
 Object.defineProperty(exports, "useSaveMeasurement", { enumerable: true, get: function () { return observation_hooks_1.useSaveMeasurement; } });
 Object.defineProperty(exports, "useUrineTests", { enumerable: true, get: function () { return observation_hooks_1.useUrineTests; } });
+var api_hooks_1 = require("./api-hooks");
+Object.defineProperty(exports, "useAdministeredProjects", { enumerable: true, get: function () { return api_hooks_1.useAdministeredProjects; } });
+Object.defineProperty(exports, "useCarehubDeviceTelemetry", { enumerable: true, get: function () { return api_hooks_1.useCarehubDeviceTelemetry; } });
+Object.defineProperty(exports, "useCarehubDevices", { enumerable: true, get: function () { return api_hooks_1.useCarehubDevices; } });
+Object.defineProperty(exports, "useCarehubNotifications", { enumerable: true, get: function () { return api_hooks_1.useCarehubNotifications; } });
+Object.defineProperty(exports, "useCarehubPatients", { enumerable: true, get: function () { return api_hooks_1.useCarehubPatients; } });
+Object.defineProperty(exports, "useCapabilityStatement", { enumerable: true, get: function () { return api_hooks_1.useCapabilityStatement; } });
+Object.defineProperty(exports, "useOvokMutation", { enumerable: true, get: function () { return api_hooks_1.useOvokMutation; } });
+Object.defineProperty(exports, "useOvokRequest", { enumerable: true, get: function () { return api_hooks_1.useOvokRequest; } });
+Object.defineProperty(exports, "useProjectFeatures", { enumerable: true, get: function () { return api_hooks_1.useProjectFeatures; } });
+Object.defineProperty(exports, "useProjectSettings", { enumerable: true, get: function () { return api_hooks_1.useProjectSettings; } });
+Object.defineProperty(exports, "usePublicApiEndpoints", { enumerable: true, get: function () { return api_hooks_1.usePublicApiEndpoints; } });
+Object.defineProperty(exports, "useRecentCarehubNotifications", { enumerable: true, get: function () { return api_hooks_1.useRecentCarehubNotifications; } });

package/dist/index.d.ts

@@ -937,3 +937,4 @@ export * from "./conformance/api-requirements";
 export * from "./conformance/capability";
 export * from "./client/platform/types";
 export * from "./client/carehub/types";
+export * from "./client/experience/types";

package/dist/index.js

@@ -60,3 +60,4 @@ __exportStar(require("./conformance/api-requirements"), exports);
 __exportStar(require("./conformance/capability"), exports);
 __exportStar(require("./client/platform/types"), exports);
 __exportStar(require("./client/carehub/types"), exports);
+__exportStar(require("./client/experience/types"), exports);

package/package.json

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