@ovok/core 0.4.7 → 0.4.9

package/README.md

@@ -362,6 +362,60 @@ const { data: translations } = useLocalizations("en-US");
 Hooks are additive to the existing `OvokProvider`, observation hooks, auth methods, and offline
 queue. Billing remains outside the SDK contract.
 
+## CMS content
+
+Published Ovok CMS documents (legal pages, release notes, or any other collection) are read with
+`getCmsDocument(collection, slug)` and `listCmsDocuments(collection)`, or the `useCmsDocument`,
+`useCmsDocuments`, `useLegalPage`, and `useReleaseNotes` hooks. They are separate from the older
+`searchContent` and `useContent` reads.
+
+```tsx
+const { data: terms, error } = useLegalPage("terms-and-conditions", { tenantCode });
+const { data: notes } = useReleaseNotes({ limit: 10 });
+const faq = await client.listCmsDocuments("faq", { page: 2 });
+```
+
+The backend allows three kinds of read:
+
+- **Signed in**: the session reads its own tenant's content with no API key. Naming another
+  tenant without a key is refused with 403.
+- **Legal pages and translations**: no key and no session are needed. Before sign-in, pass the
+  tenant's `tenantCode`.
+- **Anything else**: it needs the public API key, and is a 401 without one. This SDK does not
+  send a key.
+
+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.
+
+`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
+runtime's language (`defaultCmsLocale()`), and `""` counts as unset. A change of language that
+maps to the same CMS locale does not read again. Lists use the CMS envelope (`OvokCmsPage`):
+`prevPage` and `nextPage` are `null` at either end, and `limit` is at most 50. Release notes are
+newest first unless `sort` says otherwise. The backend merges in a shared tenant's documents.
+
+### Translations
+
+`getTranslations()` and `useTranslations()` read the whole `translations` collection as one tree
+(`OvokTranslations`): each document's `slug` is a group, and each of its `strings` rows puts its
+`value` at its `key`, nested at the dots.
+
+```tsx
+const { data: translations } = useTranslations({ tenantCode });
+// { "sign-in": { title: "Anmelden", errors: { required: "Pflichtfeld" } } }
+```
+
+The CMS answers a row with no text in the locale in English. A row with no text at all, and a row
+whose key is taken (or clashes with a nested key), are left out. Nothing is kept on the device, so
+offline the app shows its own and the SDK's built-in text.
+
+These routes ship with an Ovok Core backend release. Deploy that backend before releasing this
+SDK version.
+
 ## Offline measurements
 
 Pass a durable Medplum storage adapter and opt in to queue measurements while offline:

package/dist/client/cms/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./locale";
+export * from "./methods";
+export * from "./types";

package/dist/client/cms/index.js

@@ -0,0 +1,19 @@
+"use strict";
+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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./locale"), exports);
+__exportStar(require("./methods"), exports);
+__exportStar(require("./types"), exports);

package/dist/client/cms/locale.d.ts

@@ -0,0 +1,11 @@
+/** The Ovok CMS locales (the CMS's `CMS_LOCALES`); `en` is its default and fallback. */
+export declare const OVOK_CMS_LOCALES: readonly ["en", "de", "fr", "es"];
+export type OvokCmsLocale = (typeof OVOK_CMS_LOCALES)[number];
+export declare const OVOK_CMS_DEFAULT_LOCALE: OvokCmsLocale;
+/**
+ * The CMS locale for an app language: "de-DE" and "de_CH" read "de"; a
+ * language the CMS doesn't carry reads its default, "en".
+ */
+export declare function toCmsLocale(language?: string | null): OvokCmsLocale;
+/** The runtime's language (browser, device or server), as a CMS locale. */
+export declare function defaultCmsLocale(): OvokCmsLocale;

package/dist/client/cms/locale.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OVOK_CMS_DEFAULT_LOCALE = exports.OVOK_CMS_LOCALES = void 0;
+exports.toCmsLocale = toCmsLocale;
+exports.defaultCmsLocale = defaultCmsLocale;
+/** The Ovok CMS locales (the CMS's `CMS_LOCALES`); `en` is its default and fallback. */
+exports.OVOK_CMS_LOCALES = ["en", "de", "fr", "es"];
+exports.OVOK_CMS_DEFAULT_LOCALE = "en";
+/**
+ * The CMS locale for an app language: "de-DE" and "de_CH" read "de"; a
+ * language the CMS doesn't carry reads its default, "en".
+ */
+function toCmsLocale(language) {
+    const primary = (language !== null && language !== void 0 ? language : "").split(/[-_]/)[0].toLowerCase();
+    return exports.OVOK_CMS_LOCALES.includes(primary)
+        ? primary
+        : exports.OVOK_CMS_DEFAULT_LOCALE;
+}
+/** The runtime's language (browser, device or server), as a CMS locale. */
+function defaultCmsLocale() {
+    try {
+        return toCmsLocale(Intl.DateTimeFormat().resolvedOptions().locale);
+    }
+    catch (_a) {
+        return exports.OVOK_CMS_DEFAULT_LOCALE;
+    }
+}

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

@@ -0,0 +1,26 @@
+import { OvokClient } from "../ovok-client";
+import { OvokCmsDocument, OvokCmsListOptions, OvokCmsOptions, OvokCmsPage, OvokTranslations } from "./types";
+/**
+ * A published document of a CMS collection by slug, the shared tenant's when
+ * the tenant has none of its own. Signed out, it is read only with
+ * `allowSignedOut` and a `tenantCode`; otherwise it rejects with
+ * `SignInRequiredError`.
+ */
+export declare function getCmsDocument<T extends object = OvokCmsDocument>(this: OvokClient, collection: string, slug: string, options?: OvokCmsOptions): Promise<T>;
+/**
+ * A page of a CMS collection's published documents, merged with the shared
+ * tenant's. Signed out, as `getCmsDocument`.
+ */
+export declare function listCmsDocuments<T extends object = OvokCmsDocument>(this: OvokClient, collection: string, options?: OvokCmsListOptions): Promise<OvokCmsPage<T>>;
+/** A legal page ("terms-and-conditions", "data-privacy", …). Readable before sign-in with a tenant code. */
+export declare function getLegalPage(this: OvokClient, slug: string, options?: OvokCmsOptions): Promise<OvokCmsDocument>;
+/** Release notes, newest first unless `sort` says otherwise. Needs a session. */
+export declare function listReleaseNotes(this: OvokClient, options?: OvokCmsListOptions): Promise<OvokCmsPage>;
+/**
+ * The `translations` collection as one tree: a group per document slug, and
+ * each of its `strings` rows' `value` at its `key`, nested at the dots. Rows
+ * without a text, and rows whose path is taken, are left out. Readable before
+ * sign-in with a tenant code. Nothing is kept on the device: on native the
+ * client's storage is SecureStore, read whole at every launch.
+ */
+export declare function getTranslations(this: OvokClient, options?: OvokCmsOptions): Promise<OvokTranslations>;

package/dist/client/cms/methods.js

@@ -0,0 +1,137 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCmsDocument = getCmsDocument;
+exports.listCmsDocuments = listCmsDocuments;
+exports.getLegalPage = getLegalPage;
+exports.listReleaseNotes = listReleaseNotes;
+exports.getTranslations = getTranslations;
+const sign_in_required_error_1 = require("../errors/sign-in-required-error");
+const locale_1 = require("./locale");
+const collectionPath = (collection) => `/v1/public/cms/collections/${encodeURIComponent(collection)}/items`;
+const cmsQuery = ({ locale, tenantCode, environment, page, limit, sort }) => {
+    const params = new URLSearchParams();
+    if (locale) {
+        params.set("locale", (0, locale_1.toCmsLocale)(locale));
+    }
+    if (tenantCode) {
+        params.set("tenant", tenantCode);
+    }
+    if (environment) {
+        params.set("environment", environment);
+    }
+    if (page !== undefined) {
+        params.set("page", String(page));
+    }
+    if (limit !== undefined) {
+        params.set("limit", String(limit));
+    }
+    if (sort) {
+        params.set("sort", sort);
+    }
+    const query = params.toString();
+    return query ? `?${query}` : "";
+};
+/**
+ * Signed out, the backend serves only a few collections, read by tenant code;
+ * any other read is a 401, which MedplumClient answers by clearing its
+ * storage. So a signed-out read is refused here, before a request, unless it
+ * opts in with `allowSignedOut` and names its tenant.
+ */
+const assertReadable = (client, collection, { allowSignedOut, tenantCode }) => {
+    if (!client.getActiveLogin() && !(allowSignedOut && tenantCode)) {
+        throw new sign_in_required_error_1.SignInRequiredError(`Sign in to read the CMS collection "${collection}".`);
+    }
+};
+/**
+ * A published document of a CMS collection by slug, the shared tenant's when
+ * the tenant has none of its own. Signed out, it is read only with
+ * `allowSignedOut` and a `tenantCode`; otherwise it rejects with
+ * `SignInRequiredError`.
+ */
+async function getCmsDocument(collection, slug, options = {}) {
+    if (!slug) {
+        throw new Error("A CMS document read needs a slug.");
+    }
+    assertReadable(this, collection, options);
+    return this.get(`${collectionPath(collection)}/${encodeURIComponent(slug)}${cmsQuery(options)}`);
+}
+/**
+ * A page of a CMS collection's published documents, merged with the shared
+ * tenant's. Signed out, as `getCmsDocument`.
+ */
+async function listCmsDocuments(collection, options = {}) {
+    assertReadable(this, collection, options);
+    return this.get(`${collectionPath(collection)}${cmsQuery(options)}`);
+}
+/** A legal page ("terms-and-conditions", "data-privacy", …). Readable before sign-in with a tenant code. */
+function getLegalPage(slug, options = {}) {
+    var _a;
+    return this.getCmsDocument("legal-pages", slug, { ...options, allowSignedOut: (_a = options.allowSignedOut) !== null && _a !== void 0 ? _a : true });
+}
+/** Release notes, newest first unless `sort` says otherwise. Needs a session. */
+function listReleaseNotes(options = {}) {
+    var _a;
+    return this.listCmsDocuments("release-notes", { ...options, sort: (_a = options.sort) !== null && _a !== void 0 ? _a : "-publishedAt" });
+}
+/** A translations read takes pages of 50 documents, the CMS's most, and at most this many. */
+const MAX_TRANSLATION_PAGES = 20;
+/** Keys that would reach a prototype instead of the tree. */
+const UNSAFE_KEYS = ["__proto__", "constructor", "prototype"];
+const isText = (value) => typeof value === "string" && value !== "";
+const hasOwn = (tree, key) => Object.prototype.hasOwnProperty.call(tree, key);
+/**
+ * Sets `text` at `path` unless something is in the way: a text where a group
+ * is needed, or anything where the text goes, so the first row wins. Keys are
+ * CMS input, so a path through a prototype key is skipped too.
+ */
+const setTranslation = (tree, path, text) => {
+    if (path.some((key) => UNSAFE_KEYS.includes(key))) {
+        return;
+    }
+    let node = tree;
+    for (const key of path.slice(0, -1)) {
+        const next = hasOwn(node, key) ? node[key] : (node[key] = {});
+        if (typeof next === "string") {
+            return;
+        }
+        node = next;
+    }
+    const leaf = path[path.length - 1];
+    if (!hasOwn(node, leaf)) {
+        node[leaf] = text;
+    }
+};
+/** Adds each document's `strings` rows under its slug; a row needs a key and a text. */
+const addTranslations = (translations, docs) => {
+    for (const { slug, strings } of docs) {
+        if (!isText(slug) || !Array.isArray(strings)) {
+            continue;
+        }
+        for (const row of strings) {
+            const { key, value } = (row !== null && row !== void 0 ? row : {});
+            if (isText(key) && isText(value)) {
+                setTranslation(translations, [slug, ...key.split(".")], value);
+            }
+        }
+    }
+};
+/**
+ * The `translations` collection as one tree: a group per document slug, and
+ * each of its `strings` rows' `value` at its `key`, nested at the dots. Rows
+ * without a text, and rows whose path is taken, are left out. Readable before
+ * sign-in with a tenant code. Nothing is kept on the device: on native the
+ * client's storage is SecureStore, read whole at every launch.
+ */
+async function getTranslations(options = {}) {
+    var _a;
+    const readOptions = { ...options, allowSignedOut: (_a = options.allowSignedOut) !== null && _a !== void 0 ? _a : true };
+    const translations = {};
+    for (let page = 1; page <= MAX_TRANSLATION_PAGES; page++) {
+        const { docs, hasNextPage } = await this.listCmsDocuments("translations", { ...readOptions, page, limit: 50 });
+        addTranslations(translations, docs);
+        if (!hasNextPage) {
+            break;
+        }
+    }
+    return translations;
+}

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

@@ -0,0 +1,72 @@
+/**
+ * A published document of an Ovok CMS collection (`legal-pages`,
+ * `release-notes`, …). Fields beyond these depend on the collection.
+ */
+export type OvokCmsDocument = {
+    id: number | string;
+    slug?: string | null;
+    title?: string | null;
+    excerpt?: string | null;
+    /** Lexical rich text (JSON), as the CMS stores it. */
+    body?: unknown;
+    tags?: string[] | null;
+    status: string;
+    publishedAt?: string | null;
+    effectiveAt?: string | null;
+    updatedAt?: string | null;
+    [field: string]: unknown;
+};
+/** A page of published documents (the CMS list envelope). */
+export type OvokCmsPage<T = OvokCmsDocument> = {
+    docs: T[];
+    totalDocs: number;
+    limit: number;
+    totalPages: number;
+    page: number;
+    /** The 1-based position of this page's first document in the whole list. */
+    pagingCounter: number;
+    hasPrevPage: boolean;
+    hasNextPage: boolean;
+    /** `null` on the first page. */
+    prevPage: number | null;
+    /** `null` on the last page. */
+    nextPage: number | null;
+};
+export type OvokCmsOptions = {
+    /**
+     * An app language ("de-DE") or a CMS locale ("de"), mapped with
+     * `toCmsLocale`. Omitted or "", the CMS answers in its default locale; the
+     * hooks send the runtime's language instead.
+     */
+    locale?: string;
+    /**
+     * The tenant's code. Signed out, a read needs this and `allowSignedOut`.
+     * Signed in, the session's own tenant is read; naming another tenant is
+     * refused (403).
+     */
+    tenantCode?: string;
+    /** Omitted, the backend's own. */
+    environment?: "dev" | "staging" | "prod";
+    /**
+     * Read signed out. Only for collections the backend serves without a key or
+     * session: legal pages and translations, which turn it on by default. It
+     * needs `tenantCode`; without both, a signed-out read is refused before a
+     * request, because a 401 makes MedplumClient clear its storage.
+     */
+    allowSignedOut?: boolean;
+};
+/** Translation keys, nested at their dots, down to the text in one locale. */
+export type OvokTranslationTree = {
+    [key: string]: string | OvokTranslationTree;
+};
+/** The `translations` collection: a tree per group, named by the document's slug ("sign-in"). */
+export type OvokTranslations = {
+    [group: string]: OvokTranslationTree;
+};
+export type OvokCmsListOptions = OvokCmsOptions & {
+    page?: number;
+    /** At most 50. */
+    limit?: number;
+    /** A top-level field, "-" for descending, e.g. "-publishedAt". */
+    sort?: string;
+};

package/dist/client/cms/types.js

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

package/dist/client/errors/sign-in-required-error.d.ts

@@ -0,0 +1,10 @@
+/**
+ * A typed error for a read that needs a signed-in session when there is none.
+ * It is thrown before any request: MedplumClient answers a 401 by clearing
+ * its storage and calling `onUnauthenticated`.
+ */
+export declare class SignInRequiredError extends Error {
+    readonly code: "sign_in_required";
+    constructor(message: string);
+}
+export declare function isSignInRequiredError(error: unknown): error is SignInRequiredError;

package/dist/client/errors/sign-in-required-error.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SignInRequiredError = void 0;
+exports.isSignInRequiredError = isSignInRequiredError;
+/**
+ * A typed error for a read that needs a signed-in session when there is none.
+ * It is thrown before any request: MedplumClient answers a 401 by clearing
+ * its storage and calling `onUnauthenticated`.
+ */
+class SignInRequiredError extends Error {
+    constructor(message) {
+        super(message);
+        this.code = "sign_in_required";
+        this.name = "SignInRequiredError";
+    }
+}
+exports.SignInRequiredError = SignInRequiredError;
+function isSignInRequiredError(error) {
+    return error instanceof SignInRequiredError;
+}

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

@@ -5,6 +5,7 @@ import * as aiFhirMethods from "./ai-fhir/methods";
 import * as authMethods from "./auth/methods";
 import * as botMethods from "./bot/methods";
 import * as aiMethods from "./chat/ai/methods";
+import * as cmsMethods from "./cms/methods";
 import * as emailMethods from "./email";
 import * as experienceMethods from "./experience/methods";
 import * as inviteMethods from "./invites/methods";
@@ -62,7 +63,7 @@ export declare class OvokClient extends MedplumClient {
      */
     getSubscriptionManager(): SubscriptionManager;
 }
-type Methods = typeof authMethods & typeof observationMethods & typeof questionnaireResponseMethods & typeof aiMethods & typeof aiFhirMethods & typeof botMethods & typeof slimMethods & typeof emailMethods & typeof platformMethods & typeof experienceMethods & typeof inviteMethods & typeof patientMethods & typeof patientSharingMethods & typeof signalsMethods;
+type Methods = typeof authMethods & typeof observationMethods & typeof questionnaireResponseMethods & typeof aiMethods & typeof aiFhirMethods & typeof botMethods & typeof slimMethods & typeof emailMethods & typeof cmsMethods & typeof platformMethods & typeof experienceMethods & typeof inviteMethods & typeof patientMethods & typeof patientSharingMethods & typeof signalsMethods;
 type Omitted<T> = Omit<T, "executeBot">;
 declare module "./ovok-client" {
     interface OvokClient extends Omitted<Methods> {

package/dist/client/ovok-client.js

@@ -41,6 +41,7 @@ const aiFhirMethods = __importStar(require("./ai-fhir/methods"));
 const authMethods = __importStar(require("./auth/methods"));
 const botMethods = __importStar(require("./bot/methods"));
 const aiMethods = __importStar(require("./chat/ai/methods"));
+const cmsMethods = __importStar(require("./cms/methods"));
 const emailMethods = __importStar(require("./email"));
 const rate_limit_error_1 = require("./errors/rate-limit-error");
 const experienceMethods = __importStar(require("./experience/methods"));
@@ -76,6 +77,7 @@ class OvokClient extends core_1.MedplumClient {
         this.bindMethods(botMethods);
         this.bindMethods(slimMethods);
         this.bindMethods(emailMethods);
+        this.bindMethods(cmsMethods);
         this.bindMethods(platformMethods);
         this.bindMethods(experienceMethods);
         this.bindMethods(inviteMethods);

package/dist/conformance/api-requirements.js

@@ -57,6 +57,8 @@ exports.OVOK_CORE_API_REQUIREMENTS = {
         { 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: "/v1/public/cms/collections/:collection/items", group: "Cms" },
+        { method: "GET", path: "/v1/public/cms/collections/:collection/items/:slug", group: "Cms" },
         { 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" },

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

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

@@ -0,0 +1,18 @@
+import { OvokCmsDocument, OvokCmsListOptions, OvokCmsOptions, OvokCmsPage, OvokTranslations } from "../client/cms";
+import { OvokRequestState } from "./api-hooks";
+/**
+ * A published CMS document by slug, in `options.locale` or else the runtime's
+ * language. Waits while `slug` is empty; a new CMS locale reads it again.
+ */
+export declare const useCmsDocument: <T extends object = OvokCmsDocument>(collection: string, slug: string | undefined, options?: OvokCmsOptions) => OvokRequestState<T>;
+/** A page of a CMS collection, in `options.locale` or else the runtime's language. */
+export declare const useCmsDocuments: <T extends object = OvokCmsDocument>(collection: string, options?: OvokCmsListOptions) => OvokRequestState<OvokCmsPage<T>>;
+/** A legal page by slug; with `tenantCode`, readable before sign-in. */
+export declare const useLegalPage: (slug: string | undefined, options?: OvokCmsOptions) => OvokRequestState<OvokCmsDocument>;
+/** Release notes, newest first unless `sort` says otherwise. Needs a session. */
+export declare const useReleaseNotes: (options?: OvokCmsListOptions) => OvokRequestState<OvokCmsPage>;
+/**
+ * The `translations` collection as one tree, in `options.locale` or else the
+ * runtime's language; with `tenantCode`, readable before sign-in.
+ */
+export declare const useTranslations: (options?: OvokCmsOptions) => OvokRequestState<OvokTranslations>;

package/dist/hooks/cms-hooks.js

@@ -0,0 +1,80 @@
+"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.useTranslations = exports.useReleaseNotes = exports.useLegalPage = exports.useCmsDocuments = exports.useCmsDocument = void 0;
+const React = __importStar(require("react"));
+const cms_1 = require("../client/cms");
+const api_hooks_1 = require("./api-hooks");
+const index_1 = require("./index");
+/**
+ * A published CMS document by slug, in `options.locale` or else the runtime's
+ * language. Waits while `slug` is empty; a new CMS locale reads it again.
+ */
+const useCmsDocument = (collection, slug, options = {}) => {
+    const client = (0, index_1.useClient)();
+    const { tenantCode, environment, allowSignedOut } = options;
+    const locale = React.useMemo(() => (0, cms_1.toCmsLocale)(options.locale || (0, cms_1.defaultCmsLocale)()), [options.locale]);
+    const load = React.useCallback(() => client.getCmsDocument(collection, slug, { locale, tenantCode, environment, allowSignedOut }), [client, collection, slug, locale, tenantCode, environment, allowSignedOut]);
+    return (0, api_hooks_1.useOvokRequest)(load, Boolean(slug));
+};
+exports.useCmsDocument = useCmsDocument;
+/** A page of a CMS collection, in `options.locale` or else the runtime's language. */
+const useCmsDocuments = (collection, options = {}) => {
+    const client = (0, index_1.useClient)();
+    const { tenantCode, environment, allowSignedOut, page, limit, sort } = options;
+    const locale = React.useMemo(() => (0, cms_1.toCmsLocale)(options.locale || (0, cms_1.defaultCmsLocale)()), [options.locale]);
+    const load = React.useCallback(() => client.listCmsDocuments(collection, { locale, tenantCode, environment, allowSignedOut, page, limit, sort }), [client, collection, locale, tenantCode, environment, allowSignedOut, page, limit, sort]);
+    return (0, api_hooks_1.useOvokRequest)(load);
+};
+exports.useCmsDocuments = useCmsDocuments;
+/** A legal page by slug; with `tenantCode`, readable before sign-in. */
+const useLegalPage = (slug, options = {}) => { var _a; return (0, exports.useCmsDocument)("legal-pages", slug, { ...options, allowSignedOut: (_a = options.allowSignedOut) !== null && _a !== void 0 ? _a : true }); };
+exports.useLegalPage = useLegalPage;
+/** Release notes, newest first unless `sort` says otherwise. Needs a session. */
+const useReleaseNotes = (options = {}) => { var _a; return (0, exports.useCmsDocuments)("release-notes", { ...options, sort: (_a = options.sort) !== null && _a !== void 0 ? _a : "-publishedAt" }); };
+exports.useReleaseNotes = useReleaseNotes;
+/**
+ * The `translations` collection as one tree, in `options.locale` or else the
+ * runtime's language; with `tenantCode`, readable before sign-in.
+ */
+const useTranslations = (options = {}) => {
+    const client = (0, index_1.useClient)();
+    const { tenantCode, environment, allowSignedOut } = options;
+    const locale = React.useMemo(() => (0, cms_1.toCmsLocale)(options.locale || (0, cms_1.defaultCmsLocale)()), [options.locale]);
+    const load = React.useCallback(() => client.getTranslations({ locale, tenantCode, environment, allowSignedOut }), [client, locale, tenantCode, environment, allowSignedOut]);
+    return (0, api_hooks_1.useOvokRequest)(load);
+};
+exports.useTranslations = useTranslations;

package/dist/hooks/index.d.ts

@@ -7,9 +7,11 @@ export declare const OvokProvider: (props: React.PropsWithChildren<{
 }>) => React.JSX.Element;
 export { observationsToMeasurements, useEcgRecording, useObservations, useSaveMeasurement, useUrineTests, } from "./observation-hooks";
 export { useAdministeredProjects, useSlimDeviceTelemetry, useSlimDevices, useSlimNotifications, useSlimPatients, useCapabilityStatement, useOvokMutation, useOvokRequest, useProjectFeatures, useProjectSettings, usePublicApiEndpoints, useRecentSlimNotifications, } from "./api-hooks";
+export type { OvokMutationState, OvokRequestState } from "./api-hooks";
 export { useConsentSignature, useContent, useCreateVideoCallAppointment, useCreateVideoCallUserAccess, useDocuments, useVideoCallAccess, useVideoCallAppointments, } from "./experience-hooks";
 export { useI18nextDocument, useLocales, useLocalizations, useUpdateI18nextDocument, useUpdateLocalization, useUpdateProjectTextSetting, } from "./platform-hooks";
 export { useEmailTemplates } from "./email-hooks";
+export { useCmsDocument, useCmsDocuments, useLegalPage, useReleaseNotes, useTranslations, } from "./cms-hooks";
 export { useAcceptInvite, useInvitePatient, useInvitePractitioner, } from "./invites-hooks";
 export { useCurrentPatientProfile, useExtractQuestionnaireObservations, usePatientAppointments, usePatientCarePlans, usePatientDevices, usePatientDeviceTelemetry, usePatientDeviceTelemetryHistory, usePatientMeasurement, usePatientMeasurementHistory, usePatientDashboard, usePatientLatestObservations, usePatientNotifications, usePatientQuestionnaireResponses, usePatientQuestionnaires, usePatientSchedules, usePatientSlots, usePopulateQuestionnaire, useSubmitQuestionnaireResponse, } from "./patient-hooks";
 export { useCreatePatientSharingInvite, usePatientSharing, usePatientSharingSettings, useRedeemPatientSharingInvite, useRevokePatientSharing, useUpdatePatientSharingSettings, } from "./patient-sharing-hooks";

package/dist/hooks/index.js

@@ -34,8 +34,8 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.usePatientAppointments = exports.useExtractQuestionnaireObservations = exports.useCurrentPatientProfile = exports.useInvitePractitioner = exports.useInvitePatient = exports.useAcceptInvite = exports.useEmailTemplates = exports.useUpdateProjectTextSetting = exports.useUpdateLocalization = exports.useUpdateI18nextDocument = exports.useLocalizations = exports.useLocales = exports.useI18nextDocument = exports.useVideoCallAppointments = exports.useVideoCallAccess = exports.useDocuments = exports.useCreateVideoCallUserAccess = exports.useCreateVideoCallAppointment = exports.useContent = exports.useConsentSignature = exports.useRecentSlimNotifications = exports.usePublicApiEndpoints = exports.useProjectSettings = exports.useProjectFeatures = exports.useOvokRequest = exports.useOvokMutation = exports.useCapabilityStatement = exports.useSlimPatients = exports.useSlimNotifications = exports.useSlimDevices = exports.useSlimDeviceTelemetry = 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;
-exports.useUpdateSignalsSettings = exports.useSignalsThresholds = exports.useSignalsSettings = exports.useSignalsAlerts = exports.useSignalsAlert = exports.useSetSignalsThreshold = exports.useRemoveSignalsThreshold = exports.useEnableSignalsForPatient = exports.useAcknowledgeSignalsAlert = exports.useUpdatePatientSharingSettings = exports.useRevokePatientSharing = exports.useRedeemPatientSharingInvite = exports.usePatientSharingSettings = exports.usePatientSharing = exports.useCreatePatientSharingInvite = exports.useSubmitQuestionnaireResponse = exports.usePopulateQuestionnaire = exports.usePatientSlots = exports.usePatientSchedules = exports.usePatientQuestionnaires = exports.usePatientQuestionnaireResponses = exports.usePatientNotifications = exports.usePatientLatestObservations = exports.usePatientDashboard = exports.usePatientMeasurementHistory = exports.usePatientMeasurement = exports.usePatientDeviceTelemetryHistory = exports.usePatientDeviceTelemetry = exports.usePatientDevices = exports.usePatientCarePlans = void 0;
+exports.useAcceptInvite = exports.useTranslations = exports.useReleaseNotes = exports.useLegalPage = exports.useCmsDocuments = exports.useCmsDocument = exports.useEmailTemplates = exports.useUpdateProjectTextSetting = exports.useUpdateLocalization = exports.useUpdateI18nextDocument = exports.useLocalizations = exports.useLocales = exports.useI18nextDocument = exports.useVideoCallAppointments = exports.useVideoCallAccess = exports.useDocuments = exports.useCreateVideoCallUserAccess = exports.useCreateVideoCallAppointment = exports.useContent = exports.useConsentSignature = exports.useRecentSlimNotifications = exports.usePublicApiEndpoints = exports.useProjectSettings = exports.useProjectFeatures = exports.useOvokRequest = exports.useOvokMutation = exports.useCapabilityStatement = exports.useSlimPatients = exports.useSlimNotifications = exports.useSlimDevices = exports.useSlimDeviceTelemetry = 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;
+exports.useUpdateSignalsSettings = exports.useSignalsThresholds = exports.useSignalsSettings = exports.useSignalsAlerts = exports.useSignalsAlert = exports.useSetSignalsThreshold = exports.useRemoveSignalsThreshold = exports.useEnableSignalsForPatient = exports.useAcknowledgeSignalsAlert = exports.useUpdatePatientSharingSettings = exports.useRevokePatientSharing = exports.useRedeemPatientSharingInvite = exports.usePatientSharingSettings = exports.usePatientSharing = exports.useCreatePatientSharingInvite = exports.useSubmitQuestionnaireResponse = exports.usePopulateQuestionnaire = exports.usePatientSlots = exports.usePatientSchedules = exports.usePatientQuestionnaires = exports.usePatientQuestionnaireResponses = exports.usePatientNotifications = exports.usePatientLatestObservations = exports.usePatientDashboard = exports.usePatientMeasurementHistory = exports.usePatientMeasurement = exports.usePatientDeviceTelemetryHistory = exports.usePatientDeviceTelemetry = exports.usePatientDevices = exports.usePatientCarePlans = exports.usePatientAppointments = exports.useExtractQuestionnaireObservations = exports.useCurrentPatientProfile = exports.useInvitePractitioner = exports.useInvitePatient = void 0;
 /*
  * The only React-dependent module in the package.
  *
@@ -107,6 +107,12 @@ Object.defineProperty(exports, "useUpdateLocalization", { enumerable: true, get:
 Object.defineProperty(exports, "useUpdateProjectTextSetting", { enumerable: true, get: function () { return platform_hooks_1.useUpdateProjectTextSetting; } });
 var email_hooks_1 = require("./email-hooks");
 Object.defineProperty(exports, "useEmailTemplates", { enumerable: true, get: function () { return email_hooks_1.useEmailTemplates; } });
+var cms_hooks_1 = require("./cms-hooks");
+Object.defineProperty(exports, "useCmsDocument", { enumerable: true, get: function () { return cms_hooks_1.useCmsDocument; } });
+Object.defineProperty(exports, "useCmsDocuments", { enumerable: true, get: function () { return cms_hooks_1.useCmsDocuments; } });
+Object.defineProperty(exports, "useLegalPage", { enumerable: true, get: function () { return cms_hooks_1.useLegalPage; } });
+Object.defineProperty(exports, "useReleaseNotes", { enumerable: true, get: function () { return cms_hooks_1.useReleaseNotes; } });
+Object.defineProperty(exports, "useTranslations", { enumerable: true, get: function () { return cms_hooks_1.useTranslations; } });
 var invites_hooks_1 = require("./invites-hooks");
 Object.defineProperty(exports, "useAcceptInvite", { enumerable: true, get: function () { return invites_hooks_1.useAcceptInvite; } });
 Object.defineProperty(exports, "useInvitePatient", { enumerable: true, get: function () { return invites_hooks_1.useInvitePatient; } });

package/dist/index.d.ts

@@ -924,6 +924,7 @@ declare const Medplum: {
 export { Medplum };
 export { OvokClient } from "./client/ovok-client";
 export * from "./client/errors/rate-limit-error";
+export * from "./client/errors/sign-in-required-error";
 export * from "./client/errors/ovok-error";
 export * from "./client/auth/errors";
 export type { RegisterBody } from "./client/auth/types/RegisterBody";
@@ -941,6 +942,7 @@ export * from "./conformance/api-requirements";
 export * from "./conformance/capability";
 export * from "./client/platform/types";
 export * from "./client/email";
+export * from "./client/cms";
 export * from "./client/invites";
 export * from "./client/slim/types";
 export * from "./client/experience/types";

package/dist/index.js

@@ -45,6 +45,7 @@ exports.Medplum = Medplum;
 var ovok_client_1 = require("./client/ovok-client");
 Object.defineProperty(exports, "OvokClient", { enumerable: true, get: function () { return ovok_client_1.OvokClient; } });
 __exportStar(require("./client/errors/rate-limit-error"), exports);
+__exportStar(require("./client/errors/sign-in-required-error"), exports);
 __exportStar(require("./client/errors/ovok-error"), exports);
 __exportStar(require("./client/auth/errors"), exports);
 var ovok_client_2 = require("./client/ovok-client");
@@ -62,6 +63,7 @@ __exportStar(require("./conformance/api-requirements"), exports);
 __exportStar(require("./conformance/capability"), exports);
 __exportStar(require("./client/platform/types"), exports);
 __exportStar(require("./client/email"), exports);
+__exportStar(require("./client/cms"), exports);
 __exportStar(require("./client/invites"), exports);
 __exportStar(require("./client/slim/types"), exports);
 __exportStar(require("./client/experience/types"), exports);

package/package.json

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