@healthcloudai/hc-settings-connector 0.2.0 → 0.2.2

package/README.md

@@ -13,7 +13,8 @@ This connector gives authenticated patients access to account information and do
 3. Submit uploaded identification and insurance images for capture.
 4. Submit and retrieve insurance information.
 5. Update the patient profile image.
-6. Deactivate the authenticated patient account.
+6. Capture registration documents before the patient is authenticated.
+7. Deactivate the authenticated patient account.
 
 ---
 
@@ -59,7 +60,7 @@ const settingsClient = new HCSettingsClient(
 );
 ```
 
-`HCLoginClient` must be configured and authenticated before calling Settings methods.
+`HCLoginClient` must be configured before creating the Settings client. Most Settings methods require an authenticated patient session. `captureRegistrationDocument(...)` is intended for unauthenticated registration flows and does not send the auth token.
 
 ---
 
@@ -677,6 +678,77 @@ console.log(response);
 
 ---
 
+# Registration Document Capture
+
+Registration document capture is used during registration, before the user is authenticated. It sends the same capture request shape as patient capture, but it does not attach the patient authorization token.
+
+## Capture Registration Document
+
+Public signature:
+
+```ts
+settingsClient.captureRegistrationDocument(
+  fileKey,
+  type
+)
+```
+
+`type` must be one of:
+
+```ts
+"identification" | "healthinsurance"
+```
+
+Only `loginClient.configure(...)` is required for this method so the connector can resolve the API base URL.
+
+```ts
+const response =
+  await settingsClient.captureRegistrationDocument(
+    "idcard_example.jpeg",
+    "identification"
+  );
+
+console.log(response);
+```
+
+### API request
+
+```json
+{
+  "Data": {
+    "Type": "identification",
+    "FileID": "idcard_example.jpeg"
+  }
+}
+```
+
+### API response
+
+```json
+{
+  "Data": {
+    "CapturedData": {
+      "FirstName": "John",
+      "LastName": "Doe",
+      "StreetAddress": "123 Main St",
+      "City": "Springfield",
+      "ZipCode": "90210",
+      "State": "California",
+      "IssuedDate": "01/01/2024",
+      "ExpiresDate": "01/01/2028",
+      "Dob": "01/01/1990",
+      "IDNumber": null
+    },
+    "IsCaptured": true,
+    "InsurancePackages": null
+  },
+  "ErrorMessage": null,
+  "IsOK": true
+}
+```
+
+---
+
 # Account
 
 ## Deactivate User
@@ -726,6 +798,7 @@ console.log(response);
 * `captureDrivingLicense(...)` internally sends `Type: "identification"`.
 * `captureInsurance(...)` internally sends `Type: "healthinsurance"`.
 * `captureUserPhoto(...)` internally sends `Type: "userphoto"`.
+* `captureRegistrationDocument(...)` does not send the patient auth token.
 
 ```
 ```
@@ -735,7 +808,7 @@ console.log(response);
 
 ## Prerequisites
 
-`HCLoginClient` must be configured and the patient must be logged in before calling any method on this connector.
+`HCLoginClient` must be configured before using this connector. Most methods require the patient to be logged in. `captureRegistrationDocument(...)` is the unauthenticated exception and does not send the auth token.
 
 ```ts
 import { HCLoginClient } from "@healthcloudai/hc-login-connector";

package/dist/index.cjs

@@ -60,7 +60,7 @@ var HCSettingsClient = class extends import_hc_http.HCBaseConnector {
    * Extension must be a valid file extension such as "jpg" or "png".
    */
   async getUserImageCannedUrl(extension) {
-    const resolvedExtension = this.requireValue(extension, "Extension");
+    const resolvedExtension = this.requireValue(extension, "Extension", "extension");
     const requestPayload = {
       Data: { Extension: resolvedExtension }
     };
@@ -77,7 +77,7 @@ var HCSettingsClient = class extends import_hc_http.HCBaseConnector {
    * Updates the patient's profile image by confirming the uploaded file name.
    */
   async updateUserImage(fileName) {
-    const resolvedFileName = this.requireValue(fileName, "File name");
+    const resolvedFileName = this.requireValue(fileName, "File name", "fileName");
     const requestPayload = {
       Data: { FileName: resolvedFileName }
     };
@@ -97,7 +97,7 @@ var HCSettingsClient = class extends import_hc_http.HCBaseConnector {
    * Returns a canned URL for uploading the patient's driving licence image.
    */
   async getDrivingLicenseCannedUrl(extension) {
-    const resolvedExtension = this.requireValue(extension, "Extension");
+    const resolvedExtension = this.requireValue(extension, "Extension", "extension");
     const requestPayload = {
       Data: { Extension: resolvedExtension }
     };
@@ -115,7 +115,7 @@ var HCSettingsClient = class extends import_hc_http.HCBaseConnector {
    * fileKey is the storage key of the uploaded image.
    */
   async captureDrivingLicense(fileKey) {
-    const resolvedFileKey = this.requireValue(fileKey, "File key");
+    const resolvedFileKey = this.requireValue(fileKey, "File key", "fileKey");
     const requestPayload = {
       Data: { Type: "identification", FileID: resolvedFileKey }
     };
@@ -132,7 +132,7 @@ var HCSettingsClient = class extends import_hc_http.HCBaseConnector {
    * Submits a base64-encoded driving licence image to the EHR.
    */
   async submitDrivingLicense(image) {
-    const resolvedImage = this.requireValue(image, "Image");
+    const resolvedImage = this.requireValue(image, "Image", "image");
     const requestPayload = {
       Data: { Image: resolvedImage }
     };
@@ -152,7 +152,7 @@ var HCSettingsClient = class extends import_hc_http.HCBaseConnector {
    * Returns a canned URL for uploading the insurance card image.
    */
   async getInsuranceCannedUrl(extension) {
-    const resolvedExtension = this.requireValue(extension, "Extension");
+    const resolvedExtension = this.requireValue(extension, "Extension", "extension");
     const requestPayload = {
       Data: { Extension: resolvedExtension }
     };
@@ -170,7 +170,7 @@ var HCSettingsClient = class extends import_hc_http.HCBaseConnector {
    * fileKey is the storage key of the uploaded image.
    */
   async captureInsurance(fileKey) {
-    const resolvedFileKey = this.requireValue(fileKey, "File key");
+    const resolvedFileKey = this.requireValue(fileKey, "File key", "fileKey");
     const requestPayload = {
       Data: { Type: "healthinsurance", FileID: resolvedFileKey }
     };
@@ -226,7 +226,7 @@ var HCSettingsClient = class extends import_hc_http.HCBaseConnector {
    * fileKey is the storage key of the uploaded image.
    */
   async captureUserPhoto(fileKey) {
-    const resolvedFileKey = this.requireValue(fileKey, "File key");
+    const resolvedFileKey = this.requireValue(fileKey, "File key", "fileKey");
     const requestPayload = {
       Data: { Type: "userphoto", FileID: resolvedFileKey }
     };
@@ -240,6 +240,29 @@ var HCSettingsClient = class extends import_hc_http.HCBaseConnector {
     );
   }
   // ===========================================================================
+  // Registration document capture
+  // ===========================================================================
+  /**
+   * Submits an uploaded registration document for capture without sending
+   * an authenticated patient token.
+   * fileKey is the storage key of the uploaded image.
+   */
+  async captureRegistrationDocument(fileKey, type) {
+    const resolvedFileKey = this.requireValue(fileKey, "File key", "fileKey");
+    const resolvedType = this.requireValue(type, "Capture type", "type");
+    const requestPayload = {
+      Data: { Type: resolvedType, FileID: resolvedFileKey }
+    };
+    return this.execute(
+      "captureRegistrationDocument",
+      () => this.http.post(
+        `${this.auth.getBaseUrl()}/api/registrationdocument/capture`,
+        requestPayload,
+        this.getHeaders()
+      )
+    );
+  }
+  // ===========================================================================
   // Account
   // ===========================================================================
   /**

package/dist/index.d.cts

@@ -51,7 +51,7 @@ interface PatientDashboard {
     EHR: string | null;
     PendingActions: string[];
 }
-type CaptureType = "healthinsurance" | "identification" | "userphoto";
+type CaptureType = "healthinsurance" | "identification";
 interface InsuranceCaptureData {
     FirstName: string | null;
     LastName: string | null;
@@ -83,6 +83,7 @@ interface CaptureResult<T> {
     IsCaptured: boolean;
     InsurancePackages: object[] | null;
 }
+type RegistrationDocumentCaptureResult = CaptureResult<InsuranceCaptureData | IdentificationCaptureData>;
 interface InsuranceRecord {
     LastUpdatedBy: string | null;
     IrcName: string | null;
@@ -164,6 +165,12 @@ declare class HCSettingsClient extends HCBaseConnector {
      * fileKey is the storage key of the uploaded image.
      */
     captureUserPhoto(fileKey: string): Promise<APIResponse<CaptureResult<UserPhotoCaptureData>>>;
+    /**
+     * Submits an uploaded registration document for capture without sending
+     * an authenticated patient token.
+     * fileKey is the storage key of the uploaded image.
+     */
+    captureRegistrationDocument(fileKey: string, type: CaptureType): Promise<APIResponse<RegistrationDocumentCaptureResult>>;
     /**
      * Soft-deactivates the current patient account.
      * The patient record is not permanently deleted.
@@ -172,4 +179,4 @@ declare class HCSettingsClient extends HCBaseConnector {
     private getAuthHeaders;
 }
 
-export { type CaptureResult, type CaptureType, type CoverageData, type Encounter, HCSettingsClient, type IdentificationCaptureData, type InsuranceCaptureData, type InsuranceRecord, type PatientDashboard, type PatientRecord, type UserImage, type UserPhotoCaptureData, UserStatus };
+export { type CaptureResult, type CaptureType, type CoverageData, type Encounter, HCSettingsClient, type IdentificationCaptureData, type InsuranceCaptureData, type InsuranceRecord, type PatientDashboard, type PatientRecord, type RegistrationDocumentCaptureResult, type UserImage, type UserPhotoCaptureData, UserStatus };

package/dist/index.d.ts

@@ -51,7 +51,7 @@ interface PatientDashboard {
     EHR: string | null;
     PendingActions: string[];
 }
-type CaptureType = "healthinsurance" | "identification" | "userphoto";
+type CaptureType = "healthinsurance" | "identification";
 interface InsuranceCaptureData {
     FirstName: string | null;
     LastName: string | null;
@@ -83,6 +83,7 @@ interface CaptureResult<T> {
     IsCaptured: boolean;
     InsurancePackages: object[] | null;
 }
+type RegistrationDocumentCaptureResult = CaptureResult<InsuranceCaptureData | IdentificationCaptureData>;
 interface InsuranceRecord {
     LastUpdatedBy: string | null;
     IrcName: string | null;
@@ -164,6 +165,12 @@ declare class HCSettingsClient extends HCBaseConnector {
      * fileKey is the storage key of the uploaded image.
      */
     captureUserPhoto(fileKey: string): Promise<APIResponse<CaptureResult<UserPhotoCaptureData>>>;
+    /**
+     * Submits an uploaded registration document for capture without sending
+     * an authenticated patient token.
+     * fileKey is the storage key of the uploaded image.
+     */
+    captureRegistrationDocument(fileKey: string, type: CaptureType): Promise<APIResponse<RegistrationDocumentCaptureResult>>;
     /**
      * Soft-deactivates the current patient account.
      * The patient record is not permanently deleted.
@@ -172,4 +179,4 @@ declare class HCSettingsClient extends HCBaseConnector {
     private getAuthHeaders;
 }
 
-export { type CaptureResult, type CaptureType, type CoverageData, type Encounter, HCSettingsClient, type IdentificationCaptureData, type InsuranceCaptureData, type InsuranceRecord, type PatientDashboard, type PatientRecord, type UserImage, type UserPhotoCaptureData, UserStatus };
+export { type CaptureResult, type CaptureType, type CoverageData, type Encounter, HCSettingsClient, type IdentificationCaptureData, type InsuranceCaptureData, type InsuranceRecord, type PatientDashboard, type PatientRecord, type RegistrationDocumentCaptureResult, type UserImage, type UserPhotoCaptureData, UserStatus };

package/dist/index.js

@@ -28,7 +28,7 @@ var HCSettingsClient = class extends HCBaseConnector {
    * Extension must be a valid file extension such as "jpg" or "png".
    */
   async getUserImageCannedUrl(extension) {
-    const resolvedExtension = this.requireValue(extension, "Extension");
+    const resolvedExtension = this.requireValue(extension, "Extension", "extension");
     const requestPayload = {
       Data: { Extension: resolvedExtension }
     };
@@ -45,7 +45,7 @@ var HCSettingsClient = class extends HCBaseConnector {
    * Updates the patient's profile image by confirming the uploaded file name.
    */
   async updateUserImage(fileName) {
-    const resolvedFileName = this.requireValue(fileName, "File name");
+    const resolvedFileName = this.requireValue(fileName, "File name", "fileName");
     const requestPayload = {
       Data: { FileName: resolvedFileName }
     };
@@ -65,7 +65,7 @@ var HCSettingsClient = class extends HCBaseConnector {
    * Returns a canned URL for uploading the patient's driving licence image.
    */
   async getDrivingLicenseCannedUrl(extension) {
-    const resolvedExtension = this.requireValue(extension, "Extension");
+    const resolvedExtension = this.requireValue(extension, "Extension", "extension");
     const requestPayload = {
       Data: { Extension: resolvedExtension }
     };
@@ -83,7 +83,7 @@ var HCSettingsClient = class extends HCBaseConnector {
    * fileKey is the storage key of the uploaded image.
    */
   async captureDrivingLicense(fileKey) {
-    const resolvedFileKey = this.requireValue(fileKey, "File key");
+    const resolvedFileKey = this.requireValue(fileKey, "File key", "fileKey");
     const requestPayload = {
       Data: { Type: "identification", FileID: resolvedFileKey }
     };
@@ -100,7 +100,7 @@ var HCSettingsClient = class extends HCBaseConnector {
    * Submits a base64-encoded driving licence image to the EHR.
    */
   async submitDrivingLicense(image) {
-    const resolvedImage = this.requireValue(image, "Image");
+    const resolvedImage = this.requireValue(image, "Image", "image");
     const requestPayload = {
       Data: { Image: resolvedImage }
     };
@@ -120,7 +120,7 @@ var HCSettingsClient = class extends HCBaseConnector {
    * Returns a canned URL for uploading the insurance card image.
    */
   async getInsuranceCannedUrl(extension) {
-    const resolvedExtension = this.requireValue(extension, "Extension");
+    const resolvedExtension = this.requireValue(extension, "Extension", "extension");
     const requestPayload = {
       Data: { Extension: resolvedExtension }
     };
@@ -138,7 +138,7 @@ var HCSettingsClient = class extends HCBaseConnector {
    * fileKey is the storage key of the uploaded image.
    */
   async captureInsurance(fileKey) {
-    const resolvedFileKey = this.requireValue(fileKey, "File key");
+    const resolvedFileKey = this.requireValue(fileKey, "File key", "fileKey");
     const requestPayload = {
       Data: { Type: "healthinsurance", FileID: resolvedFileKey }
     };
@@ -194,7 +194,7 @@ var HCSettingsClient = class extends HCBaseConnector {
    * fileKey is the storage key of the uploaded image.
    */
   async captureUserPhoto(fileKey) {
-    const resolvedFileKey = this.requireValue(fileKey, "File key");
+    const resolvedFileKey = this.requireValue(fileKey, "File key", "fileKey");
     const requestPayload = {
       Data: { Type: "userphoto", FileID: resolvedFileKey }
     };
@@ -208,6 +208,29 @@ var HCSettingsClient = class extends HCBaseConnector {
     );
   }
   // ===========================================================================
+  // Registration document capture
+  // ===========================================================================
+  /**
+   * Submits an uploaded registration document for capture without sending
+   * an authenticated patient token.
+   * fileKey is the storage key of the uploaded image.
+   */
+  async captureRegistrationDocument(fileKey, type) {
+    const resolvedFileKey = this.requireValue(fileKey, "File key", "fileKey");
+    const resolvedType = this.requireValue(type, "Capture type", "type");
+    const requestPayload = {
+      Data: { Type: resolvedType, FileID: resolvedFileKey }
+    };
+    return this.execute(
+      "captureRegistrationDocument",
+      () => this.http.post(
+        `${this.auth.getBaseUrl()}/api/registrationdocument/capture`,
+        requestPayload,
+        this.getHeaders()
+      )
+    );
+  }
+  // ===========================================================================
   // Account
   // ===========================================================================
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@healthcloudai/hc-settings-connector",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "Healthcheck Settings SDK with TypeScript",
   "author": "Healthcheck Systems Inc",
   "license": "MIT",
@@ -36,8 +36,8 @@
   },
   "dependencies": {
     "axios": "^1.13.4",
-    "@healthcloudai/hc-login-connector": "^0.3.0",
-    "@healthcloudai/hc-http": "^0.2.0"
+    "@healthcloudai/hc-login-connector": "^0.3.1",
+    "@healthcloudai/hc-http": "^0.2.1"
   },
   "peerDependencies": {
     "react-native": ">=0.70.0"