@ovok/core 0.3.5 → 0.3.6

package/README.md

@@ -15,6 +15,7 @@ Core TypeScript SDK for healthcare applications. Provides authentication, AI-FHI
 - 📋 Questionnaire responses
 - 📥 Opt-in durable offline measurement queue with idempotent retries
 - 🧭 Runtime discovery of the backend FHIR and public API capabilities
+- 🧩 Typed accounts, projects, localization, and patient-observation APIs
 
 ## Installation
 
@@ -55,6 +56,22 @@ The exported `OVOK_CORE_REQUIREMENTS` describes the FHIR operations used by the
 `OVOK_CORE_API_REQUIREMENTS` describes its ordinary HTTP dependencies. Billing is intentionally
 not part of this SDK contract yet.
 
+## Platform APIs
+
+The client includes typed methods for application-level account and project flows already served
+by Ovok: project switching and membership, project settings and feature flags, locales and
+localization, and the existing patient-observation read surface.
+
+```typescript
+const projects = await client.listAdministeredProjects();
+const settings = await client.getProjectSettings();
+const features = await client.getProjectFeatures();
+const locales = await client.getLocales();
+```
+
+All methods preserve the backend HTTP verbs and return the backend response shapes. Billing is
+not included until Ovok publishes a supported billing contract.
+
 ## Offline measurements
 
 Pass a durable Medplum storage adapter and opt in to queue measurements while offline:

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

@@ -8,6 +8,7 @@ import * as aiMethods from "./chat/ai/methods";
 import * as observationMethods from "./observation/methods";
 import { GenerateObservationBodyParams } from "./observation/types/generate-observation-body/GenerateObservationBodyParams";
 import { OfflineMeasurementFlushOptions, OfflineMeasurementFlushResult, OfflineMeasurementQueueOptions } from "./offline";
+import * as platformMethods from "./platform/methods";
 import * as questionnaireResponseMethods from "./questionnaire-response/methods";
 export declare const MAX_CONDITIONAL_OBSERVATION_ENTRIES = 8;
 export { MAX_OBSERVATION_BUNDLE_BYTES } from "./observation/observation-bundle-utils";
@@ -54,7 +55,7 @@ export declare class OvokClient extends MedplumClient {
      */
     getSubscriptionManager(): SubscriptionManager;
 }
-type Methods = typeof authMethods & typeof observationMethods & typeof questionnaireResponseMethods & typeof aiMethods & typeof aiFhirMethods & typeof botMethods;
+type Methods = typeof authMethods & typeof observationMethods & typeof questionnaireResponseMethods & typeof aiMethods & typeof aiFhirMethods & typeof botMethods & typeof platformMethods;
 type Omitted<T> = Omit<T, "executeBot">;
 declare module "./ovok-client" {
     interface OvokClient extends Omitted<Methods> {

package/dist/client/ovok-client.js

@@ -45,6 +45,7 @@ const rate_limit_error_1 = require("./errors/rate-limit-error");
 const observationMethods = __importStar(require("./observation/methods"));
 const observation_bundle_utils_1 = require("./observation/observation-bundle-utils");
 const offline_1 = require("./offline");
+const platformMethods = __importStar(require("./platform/methods"));
 const questionnaireResponseMethods = __importStar(require("./questionnaire-response/methods"));
 exports.MAX_CONDITIONAL_OBSERVATION_ENTRIES = 8;
 var observation_bundle_utils_2 = require("./observation/observation-bundle-utils");
@@ -65,6 +66,7 @@ class OvokClient extends core_1.MedplumClient {
         this.bindMethods(aiMethods);
         this.bindMethods(aiFhirMethods);
         this.bindMethods(botMethods);
+        this.bindMethods(platformMethods);
         this.clientStorage = config.storage;
         this.offlineQueueOptions = (_b = config.offlineQueue) !== null && _b !== void 0 ? _b : {};
     }

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

@@ -0,0 +1,41 @@
+import { OvokClient } from "../ovok-client";
+import { OvokAccount, OvokAdministeredProject, OvokCreateProject, OvokCreatedProject, OvokI18nDocument, OvokI18nValue, OvokInviteProjectMember, OvokLocalization, OvokLocalizationQuery, OvokLocalizationUpdate, OvokLocales, OvokPage, OvokPatientObservations, OvokProjectFeature, OvokProjectFeatures, OvokProjectMember, OvokProjectMemberResponse, OvokProjectSettings, OvokProjectSettingKey, OvokRemoveProjectMemberResponse, OvokUpdateProjectMember } from "./types";
+export declare function getAccounts(this: OvokClient): Promise<OvokAccount[]>;
+export declare function listAdministeredProjects(this: OvokClient, params?: {
+    page?: number;
+    count?: number;
+}): Promise<OvokPage<OvokAdministeredProject>>;
+export declare function createProject(this: OvokClient, body: OvokCreateProject): Promise<OvokCreatedProject>;
+export declare function bootstrapProject(this: OvokClient, body: OvokCreateProject): Promise<OvokCreatedProject>;
+export declare function getProjectTenantCode(this: OvokClient): Promise<{
+    tenantCode: string;
+}>;
+export declare function listProjectMembers(this: OvokClient, params?: {
+    accessPolicyId?: string;
+    profileId?: string;
+    userId?: string;
+    page?: number;
+    count?: number;
+}): Promise<OvokPage<OvokProjectMember>>;
+export declare function inviteProjectMember(this: OvokClient, body: OvokInviteProjectMember): Promise<OvokProjectMemberResponse>;
+export declare function updateProjectMember(this: OvokClient, membershipId: string, body: OvokUpdateProjectMember): Promise<OvokProjectMemberResponse>;
+export declare function removeProjectMember(this: OvokClient, membershipId: string): Promise<OvokRemoveProjectMemberResponse>;
+export declare function getProjectFeatures(this: OvokClient): Promise<OvokProjectFeatures>;
+export declare function updateProjectFeatures(this: OvokClient, features: OvokProjectFeature[]): Promise<OvokProjectFeatures>;
+export declare function getProjectSettings(this: OvokClient): Promise<OvokProjectSettings>;
+export declare function updateProjectSetting(this: OvokClient, key: OvokProjectSettingKey, enabled: boolean): Promise<OvokProjectSettings>;
+export declare function getLocales(this: OvokClient): Promise<OvokLocales>;
+export declare function updateLocales(this: OvokClient, locales: OvokLocales): Promise<OvokLocales>;
+export declare function listLocalizations(this: OvokClient, language: string, params?: OvokLocalizationQuery): Promise<{
+    total: number;
+    resources: OvokLocalization[];
+}>;
+export declare function getLocalization(this: OvokClient, language: string, key: string): Promise<OvokLocalization>;
+export declare function updateLocalization(this: OvokClient, language: string, key: string, body: OvokLocalizationUpdate): Promise<OvokLocalization>;
+export declare function deleteLocalization(this: OvokClient, language: string, key: string): Promise<void>;
+export declare function getI18nextDocument(this: OvokClient, language: string): Promise<OvokI18nDocument>;
+export declare function updateI18nextDocument(this: OvokClient, language: string, document: Record<string, OvokI18nValue>): Promise<void>;
+export declare function getPatientLastObservations(this: OvokClient, patientId: string, params: {
+    code: string;
+    max?: number;
+}): Promise<OvokPatientObservations>;

package/dist/client/platform/methods.js

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAccounts = getAccounts;
+exports.listAdministeredProjects = listAdministeredProjects;
+exports.createProject = createProject;
+exports.bootstrapProject = bootstrapProject;
+exports.getProjectTenantCode = getProjectTenantCode;
+exports.listProjectMembers = listProjectMembers;
+exports.inviteProjectMember = inviteProjectMember;
+exports.updateProjectMember = updateProjectMember;
+exports.removeProjectMember = removeProjectMember;
+exports.getProjectFeatures = getProjectFeatures;
+exports.updateProjectFeatures = updateProjectFeatures;
+exports.getProjectSettings = getProjectSettings;
+exports.updateProjectSetting = updateProjectSetting;
+exports.getLocales = getLocales;
+exports.updateLocales = updateLocales;
+exports.listLocalizations = listLocalizations;
+exports.getLocalization = getLocalization;
+exports.updateLocalization = updateLocalization;
+exports.deleteLocalization = deleteLocalization;
+exports.getI18nextDocument = getI18nextDocument;
+exports.updateI18nextDocument = updateI18nextDocument;
+exports.getPatientLastObservations = getPatientLastObservations;
+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 segment = (value) => encodeURIComponent(value);
+async function getAccounts() {
+    return this.get("/accounts");
+}
+async function listAdministeredProjects(params = {}) {
+    return this.get(`/v1/projects${query(params)}`);
+}
+async function createProject(body) {
+    return this.post("/v1/projects", body);
+}
+async function bootstrapProject(body) {
+    return this.post("/v1/projects/bootstrap", body);
+}
+async function getProjectTenantCode() {
+    return this.get("/v1/projects/me/tenant-code");
+}
+async function listProjectMembers(params = {}) {
+    return this.get(`/v1/projects/me/members${query(params)}`);
+}
+async function inviteProjectMember(body) {
+    return this.post("/v1/projects/me/members", body);
+}
+async function updateProjectMember(membershipId, body) {
+    return (await this.patch(`/v1/projects/me/members/${segment(membershipId)}`, body));
+}
+async function removeProjectMember(membershipId) {
+    return (await this.delete(`/v1/projects/me/members/${segment(membershipId)}`));
+}
+async function getProjectFeatures() {
+    return this.get("/v1/projects/me/features");
+}
+async function updateProjectFeatures(features) {
+    const body = { features };
+    return (await this.patch("/v1/projects/me/features", body));
+}
+async function getProjectSettings() {
+    return this.get("/v1/project/settings");
+}
+async function updateProjectSetting(key, enabled) {
+    return (await this.put(`/v1/project/settings/${segment(key)}`, { enabled }));
+}
+async function getLocales() {
+    return this.get("/locales");
+}
+async function updateLocales(locales) {
+    return (await this.patch("/locales", locales));
+}
+async function listLocalizations(language, params = {}) {
+    return this.get(`/localization/${segment(language)}${query(params)}`);
+}
+async function getLocalization(language, key) {
+    return this.get(`/localization/${segment(language)}/${segment(key)}`);
+}
+async function updateLocalization(language, key, body) {
+    return (await this.put(`/localization/${segment(language)}/${segment(key)}`, body));
+}
+async function deleteLocalization(language, key) {
+    await this.delete(`/localization/${segment(language)}/${segment(key)}`);
+}
+async function getI18nextDocument(language) {
+    return this.get(`/localization/i18next/${segment(language)}`);
+}
+async function updateI18nextDocument(language, document) {
+    await this.patch(`/localization/i18next/${segment(language)}`, document);
+}
+async function getPatientLastObservations(patientId, params) {
+    return this.get(`/patient/${segment(patientId)}/observation${query(params)}`);
+}

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

@@ -0,0 +1,114 @@
+import { Bundle, Observation } from "@medplum/fhirtypes";
+export type OvokPage<T> = {
+    total: number;
+    page: number;
+    count: number;
+    resources: T[];
+};
+export type OvokAccount = {
+    email: string;
+    name: string;
+};
+export type OvokAdministeredProject = {
+    projectId: string;
+    name: string | null;
+    tenantCode: string | null;
+    isMainProject: boolean | null;
+    parentProjectId: string | null;
+};
+export type OvokCreateProject = {
+    name: string;
+};
+export type OvokCreatedProject = {
+    projectId: string;
+    tenantCode: string;
+    name: string;
+};
+export type OvokProjectMemberReference = {
+    reference?: string;
+    display?: string;
+    [key: string]: unknown;
+};
+export type OvokProjectMember = {
+    membershipId: string;
+    userId?: string;
+    profile?: OvokProjectMemberReference;
+    accessPolicy?: OvokProjectMemberReference;
+    admin?: boolean;
+};
+export type OvokInviteProjectMember = {
+    email: string;
+    firstName: string | null;
+    lastName: string | null;
+    admin: boolean | null;
+};
+export type OvokUpdateProjectMember = {
+    admin: boolean | null;
+};
+export type OvokProjectMemberResponse = {
+    id: string;
+    email: string | null;
+    displayName: string | null;
+    firstName: string | null;
+    lastName: string | null;
+    admin: boolean;
+    profileType: "Practitioner" | "Patient" | "RelatedPerson" | null;
+    profileId: string | null;
+    pending: boolean;
+    invitedAt: string | null;
+};
+export type OvokRemoveProjectMemberResponse = {
+    success: true;
+};
+export declare const OVOK_PROJECT_FEATURE_VALUES: readonly ["ai", "aws-comprehend", "aws-textract", "bots", "cron", "email", "google-auth-required", "graphql-introspection", "websocket-subscriptions", "transaction-bundles", "validate-terminology"];
+export type OvokProjectFeature = (typeof OVOK_PROJECT_FEATURE_VALUES)[number];
+export type OvokProjectFeatures = {
+    features: string[];
+};
+export type OvokProjectFeaturesUpdate = {
+    features: OvokProjectFeature[];
+};
+export declare const OVOK_PROJECT_SETTING_KEYS: readonly ["CONTENT_ENABLED", "MAILING_ENABLED", "PATIENT_INVITATION_ENABLED", "PATIENT_REGISTRATION_ENABLED", "PATIENT_LOGIN_ENABLED", "PRACTITIONER_INVITATION_ENABLED", "PRACTITIONER_REGISTRATION_ENABLED", "PRACTITIONER_LOGIN_ENABLED", "IOT_ENABLED"];
+export type OvokProjectSettingKey = (typeof OVOK_PROJECT_SETTING_KEYS)[number];
+export type OvokProjectSettings = {
+    projectId: string;
+    settings: Record<OvokProjectSettingKey, boolean>;
+};
+export type OvokLocales = {
+    languages: string[];
+    defaultLanguage: string;
+};
+export type OvokLocalization = {
+    id?: string;
+    key: string;
+    language: string;
+    value: string;
+    author: {
+        reference: string;
+        display?: string;
+    };
+    date?: string;
+    projectId?: string;
+};
+export type OvokLocalizationQuery = {
+    _count?: number;
+    _offset?: number;
+    _sort?: string;
+    search?: string;
+};
+export type OvokLocalizationUpdate = {
+    value: string;
+};
+export type OvokI18nValue = string | {
+    [key: string]: OvokI18nValue;
+};
+export type OvokI18nDocument = {
+    key: string;
+    language: string;
+    [key: string]: unknown;
+};
+export type OvokPatientObservationQuery = {
+    code: string;
+    max?: number;
+};
+export type OvokPatientObservations = Bundle<Observation>;

package/dist/client/platform/types.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OVOK_PROJECT_SETTING_KEYS = exports.OVOK_PROJECT_FEATURE_VALUES = void 0;
+exports.OVOK_PROJECT_FEATURE_VALUES = [
+    "ai",
+    "aws-comprehend",
+    "aws-textract",
+    "bots",
+    "cron",
+    "email",
+    "google-auth-required",
+    "graphql-introspection",
+    "websocket-subscriptions",
+    "transaction-bundles",
+    "validate-terminology",
+];
+exports.OVOK_PROJECT_SETTING_KEYS = [
+    "CONTENT_ENABLED",
+    "MAILING_ENABLED",
+    "PATIENT_INVITATION_ENABLED",
+    "PATIENT_REGISTRATION_ENABLED",
+    "PATIENT_LOGIN_ENABLED",
+    "PRACTITIONER_INVITATION_ENABLED",
+    "PRACTITIONER_REGISTRATION_ENABLED",
+    "PRACTITIONER_LOGIN_ENABLED",
+    "IOT_ENABLED",
+];

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

@@ -30,5 +30,13 @@ export declare const OVOK_CORE_API_REQUIREMENTS: {
         method: "DELETE";
         path: string;
         group: string;
+    } | {
+        method: "PATCH";
+        path: string;
+        group: string;
+    } | {
+        method: "PUT";
+        path: string;
+        group: string;
     })[];
 };

package/dist/conformance/api-requirements.js

@@ -34,5 +34,27 @@ exports.OVOK_CORE_API_REQUIREMENTS = {
         { method: "POST", path: "/ai/session", group: "AI" },
         { method: "POST", path: "/ai/fhir/search", group: "AI" },
         { method: "POST", path: "/bots", group: "Bots" },
+        { method: "GET", path: "/accounts", group: "Accounts" },
+        { method: "GET", path: "/v1/projects", group: "Projects" },
+        { method: "POST", path: "/v1/projects", group: "Projects" },
+        { method: "POST", path: "/v1/projects/bootstrap", group: "Projects" },
+        { method: "GET", path: "/v1/projects/me/tenant-code", group: "Projects" },
+        { method: "GET", path: "/v1/projects/me/members", group: "Projects" },
+        { method: "POST", path: "/v1/projects/me/members", group: "Projects" },
+        { method: "PATCH", path: "/v1/projects/me/members/:membershipId", group: "Projects" },
+        { method: "DELETE", path: "/v1/projects/me/members/:membershipId", group: "Projects" },
+        { method: "GET", path: "/v1/projects/me/features", group: "Projects" },
+        { method: "PATCH", path: "/v1/projects/me/features", group: "Projects" },
+        { method: "GET", path: "/v1/project/settings", group: "Projects" },
+        { method: "PUT", path: "/v1/project/settings/:key", group: "Projects" },
+        { method: "GET", path: "/locales", group: "Localization" },
+        { method: "PATCH", path: "/locales", group: "Localization" },
+        { method: "GET", path: "/localization/:language", group: "Localization" },
+        { method: "GET", path: "/localization/:language/:key", group: "Localization" },
+        { method: "PUT", path: "/localization/:language/:key", group: "Localization" },
+        { method: "DELETE", path: "/localization/:language/:key", group: "Localization" },
+        { method: "GET", path: "/localization/i18next/:language", group: "Localization" },
+        { method: "PATCH", path: "/localization/i18next/:language", group: "Localization" },
+        { method: "GET", path: "/patient/:id/observation", group: "Patient" },
     ],
 };

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

package/dist/index.d.ts

@@ -935,3 +935,4 @@ export { saveMeasurement } from "./client/observation/methods/saveMeasurement";
 export * from "./conformance/capability-requirements";
 export * from "./conformance/api-requirements";
 export * from "./conformance/capability";
+export * from "./client/platform/types";

package/dist/index.js

@@ -58,3 +58,4 @@ Object.defineProperty(exports, "saveMeasurement", { enumerable: true, get: funct
 __exportStar(require("./conformance/capability-requirements"), exports);
 __exportStar(require("./conformance/api-requirements"), exports);
 __exportStar(require("./conformance/capability"), exports);
+__exportStar(require("./client/platform/types"), exports);

package/package.json

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