@ovok/core 0.3.24 → 0.4.0

package/README.md

@@ -282,6 +282,35 @@ if ("nextStep" in result && result.nextStep === "mfa") {
 }
 ```
 
+## Patient registration invitations
+
+When a project invites people with a business email address to join as clinicians,
+`register()` can return a clinician-invite step instead of an authenticated session. Check
+`nextStep` before reading tokens or setting the active login:
+
+```typescript
+const result = await client.register(registerBody);
+
+if ("nextStep" in result && result.nextStep === "clinician-invite") {
+  showCheckYourEmailMessage();
+  return;
+}
+
+await client.setActiveLogin(result);
+```
+
+The invitation email's “continue as patient” link includes a
+`continueAsPatientToken` query parameter. The host app owns its deep-link and universal-link
+configuration: read that parameter from the incoming URL and pass it to `register()` to finish
+registration as a patient:
+
+```typescript
+await client.register({ ...registerBody, continueAsPatientToken });
+```
+
+The token is optional and is sent only when provided. An invalid or expired token is rejected
+with HTTP 400 and the message “The continue-as-patient link is invalid or has expired.”
+
 ## Large measurements
 
 `saveMeasurement` and `saveObservations` use conditional creates for idempotent saves. Medplum

package/dist/client/auth/methods/register.d.ts

@@ -1,4 +1,4 @@
 import { OvokClient } from "../../ovok-client";
-import { AuthResponse } from "../types/AuthResponse";
 import { RegisterBody } from "../types/RegisterBody";
-export declare function register(this: OvokClient, body: RegisterBody): Promise<AuthResponse>;
+import { RegisterResponse } from "../types/RegisterResponse";
+export declare function register(this: OvokClient, body: RegisterBody): Promise<RegisterResponse>;

package/dist/client/auth/methods/register.js

@@ -11,5 +11,8 @@ async function register(body) {
         name: body.name,
         surname: body.surname,
         tenantCode: body.tenantCode,
+        ...(body.continueAsPatientToken !== undefined
+            ? { continueAsPatientToken: body.continueAsPatientToken }
+            : {}),
     }, "application/json");
 }

package/dist/client/auth/types/RegisterBody.d.ts

@@ -5,4 +5,5 @@ export interface RegisterBody {
     name: string;
     surname: string;
     tenantCode: string;
+    continueAsPatientToken?: string;
 }

package/dist/client/auth/types/RegisterResponse.d.ts

@@ -0,0 +1,5 @@
+import { AuthResponse } from "./AuthResponse";
+export type ClinicianInviteStep = {
+    nextStep: "clinician-invite";
+};
+export type RegisterResponse = AuthResponse | ClinicianInviteStep;

package/dist/client/auth/types/RegisterResponse.js

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

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

@@ -68,7 +68,7 @@ export type OvokProjectFeatures = {
 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 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", "CLINICIAN_INVITE_ON_BUSINESS_EMAIL"];
 export type OvokProjectSettingKey = (typeof OVOK_PROJECT_SETTING_KEYS)[number];
 export type OvokProjectSettings = {
     projectId: string;

package/dist/client/platform/types.js

@@ -24,4 +24,5 @@ exports.OVOK_PROJECT_SETTING_KEYS = [
     "PRACTITIONER_REGISTRATION_ENABLED",
     "PRACTITIONER_LOGIN_ENABLED",
     "IOT_ENABLED",
+    "CLINICIAN_INVITE_ON_BUSINESS_EMAIL",
 ];

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

package/dist/types/index.d.ts

@@ -2,6 +2,7 @@ export * from "../client/auth/types/AuthResponse";
 export * from "../client/auth/types/LoginResponse";
 export * from "../client/auth/types/LoginBody";
 export * from "../client/auth/types/RegisterBody";
+export * from "../client/auth/types/RegisterResponse";
 export * from "../client/auth/types/ChangePasswordBody";
 export * from "../client/auth/types/ChangePasswordResponse";
 export * from "../client/auth/types/RequestDeleteUserBody";

package/dist/types/index.js

@@ -19,6 +19,7 @@ __exportStar(require("../client/auth/types/AuthResponse"), exports);
 __exportStar(require("../client/auth/types/LoginResponse"), exports);
 __exportStar(require("../client/auth/types/LoginBody"), exports);
 __exportStar(require("../client/auth/types/RegisterBody"), exports);
+__exportStar(require("../client/auth/types/RegisterResponse"), exports);
 __exportStar(require("../client/auth/types/ChangePasswordBody"), exports);
 __exportStar(require("../client/auth/types/ChangePasswordResponse"), exports);
 __exportStar(require("../client/auth/types/RequestDeleteUserBody"), exports);

package/package.json

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