@healthcloudai/hc-settings-connector 0.0.9 → 0.0.11

package/README.md

@@ -7,16 +7,15 @@ It is built on top of the shared Healthcheck HTTP and Login connectors.
 ---
 
 ## Features
-1. Retrieve the authenticated patient profile
-2. Retrieve the authenticated patient dashboard
-3. Generate canned upload URLs for selfie, ID, and insurance images
-4. Capture selfie, identification, and insurance documents from uploaded file keys
-5. Update or submit driving license data through the resolved EHR route
-6. Submit patient insurance coverage details
-7. Retrieve patient insurances through the resolved EHR route
-8. Update the stored user image file reference
-9. Deactivate the authenticated user
-10. Built on the shared Healthcheck HttpClient and authentication layer
+1. Retrieve the authenticated patient dashboard
+2. Generate canned upload URLs for selfie, ID, and insurance images
+3. Submit uploaded identification and insurance file keys for capture
+4. Submit patient insurance coverage details
+5. Retrieve patient insurances
+6. Submit driving license data
+7. Update the stored user image file reference
+8. Deactivate the authenticated user
+9. Built on the shared Healthcheck HttpClient and authentication layer
 
 ---
 
@@ -59,79 +58,42 @@ const settingsClient = new HCSettingsClient(
 
 ---
 
-## Methods
-
-### Get User Info
 
-Public signature: `settingsClient.getUserInfo()`
+## API Key
 
-Returns the current authenticated patient profile.
+Use `setApiKey(...)` to attach an API key header to requests from `HCSettingsClient`.
 
 ```ts
-const userInfo = await settingsClient.getUserInfo();
-```
+const apiKey = process.env.HEALTHCLOUD_API_KEY;
 
-#### Full API request
+if (!apiKey) {
+  throw new Error("HEALTHCLOUD_API_KEY is required.");
+}
 
-This method performs an authenticated request internally and does not send a request body.
+settingsClient.setApiKey("x-api-key", apiKey);
+```
 
-#### API response
+- Header name should be `x-api-key`.
 
-Status:
+## Methods
 
-```txt
-200
-```
+The Settings connector methods are grouped by the main usage flow:
 
-```json
-{
-  "Data": {
-    "Record": {
-      "ID": "record-id-example",
-      "TenantID": "demo-tenant",
-      "FirstName": "John",
-      "LastName": "Doe",
-      "Email": "john.doe@example.com",
-      "Phone": null,
-      "BirthDate": "0001-01-01T00:00:00",
-      "HasInsurance": false,
-      "HasIDCard": false,
-      "HasSelfie": true,
-      "Address": {
-        "StreetAndNumber": null,
-        "Extension": null,
-        "City": null,
-        "State": null,
-        "PostalCode": null,
-        "Country": null
-      },
-      "Attributes": {
-        "FHIRPatientID": "patient-id-example",
-        "CompositeID": "composite-id-example",
-        "PatientImageURL": "https://storage.example.com/selfie_example.jpeg"
-      },
-      "CompositeID": "composite-id-example",
-      "FHIRID": "fhir-id-example"
-    },
-    "Encounters": null,
-    "EHR": "fhir",
-    "PendingActions": [
-      "ADD_ID",
-      "IMPORT_VITALS"
-    ]
-  },
-  "ErrorMessage": null,
-  "IsOK": true
-}
-```
+1. Dashboard
+2. Profile image upload and update
+3. ID document upload, capture, and submit
+4. Insurance upload, capture, submit, and retrieval
+5. Account actions
 
 ---
 
+## Dashboard methods
+
 ### Get Dashboard
 
 Public signature: `settingsClient.getDashboard()`
 
-Returns the current authenticated patient dashboard response.
+Returns the authenticated patient dashboard.
 
 ```ts
 const dashboard = await settingsClient.getDashboard();
@@ -153,102 +115,78 @@ Status:
 {
   "Data": {
     "Record": {
-      "ID": "record-id-example",
-      "TenantID": "demo-tenant",
-      "FirstName": "John",
-      "LastName": "Doe",
-      "Email": "john.doe@example.com",
-      "HasInsurance": false,
-      "HasIDCard": false,
+      "Status": 0,
+      "Sex": "Male",
+      "GenderIdentity": "Male",
+      "HasInsurance": true,
+      "HasIDCard": true,
       "HasSelfie": true,
-      "Attributes": {
-        "FHIRPatientID": "patient-id-example",
-        "CompositeID": "composite-id-example",
-        "PatientImageURL": "https://storage.example.com/selfie_example.jpeg"
+      "Flags": {
+        "IsVerified": "true",
+        "NeedsInsurance": "false"
       }
     },
-    "Encounters": [],
-    "EHR": "fhir",
+    "Encounters": [
+      {
+        "FHIRID": "test-fhir-id-001",
+        "AthenaID": "test-athena-id-001",
+        "Status": 0,
+        "Patient": null,
+        "EncounterClass": "ambulatory",
+        "EHR": "athena",
+        "EHRType": "Athena Health",
+        "EHRVisitName": "Office Visit",
+        "EHRAppointmentID": "test-appointment-id-001",
+        "EHRProviderID": "test-provider-id-001",
+        "EHRProviderName": "Test Provider",
+        "EHRDate": "04/22/2026",
+        "EHRStatus": "Finished",
+        "EHRStage": "completed"
+      }
+    ],
+    "EHR": "athena",
     "PendingActions": [
+      "ADD_INSURANCE",
       "ADD_ID",
       "IMPORT_VITALS"
     ]
   },
-  "ErrorMessage": null,
-  "IsOK": true
+  "IsOK": true,
+  "ErrorMessage": null
 }
 ```
 
 ---
 
-### Submit Insurance
+## Upload and capture flow
 
-Public signature: `settingsClient.submitInsurance(payload)`
+Image-related methods follow an upload-first flow. Profile image uses `updateUserImage(...)` after upload, while driver license and insurance use capture methods after upload.
 
-Submits patient insurance coverage details.
-The client forwards the provided payload into the backend `Data` wrapper.
+1. Request upload information by calling the matching canned URL method.
+2. Upload the file bytes to the returned upload URL outside this package.
+3. Include any signed headers required by the upload URL, such as `x-amz-acl: public-read` when provided.
+4. Submit the returned file name or file key through the matching capture or update method.
 
-```ts
-await settingsClient.submitInsurance({
-  InsurancePackageId: "693245",
-  MemberId: "member-id-example",
-  FirstName: "John",
-  LastName: "Doe",
-  Sex: "",
-  Image: "insurancecard_example.jpeg"
-});
-```
-
-#### Full API request
+The connector does not upload file bytes. It requests upload information and then submits the uploaded file reference after the upload is complete.
 
-```json
-{
-  "Data": {
-    "InsurancePackageId": "693245",
-    "MemberId": "member-id-example",
-    "FirstName": "John",
-    "LastName": "Doe",
-    "Sex": "",
-    "Image": "insurancecard_example.jpeg"
-  }
-}
-```
+---
 
-#### API response
+## Profile image methods
 
-Status:
+Profile image methods follow this flow:
 
-```txt
-200
-```
-
-```json
-{
-  "Data": {
-    "InsuranceId": "insurance-id-example",
-    "InsurancePackageId": 693245,
-    "InsurancePolicyHolder": "John Doe",
-    "InsuranceType": "Insurance",
-    "IssueDate": "01/01/2030",
-    "MemberId": "member-id-example",
-    "Image": "insurancecard_example.jpeg"
-  },
-  "ErrorMessage": null,
-  "IsOK": true
-}
-```
-
----
+1. Call `getUserImageCannedUrl(extension)` to request upload information.
+2. Upload the image file to the returned `ImageURL` outside this package.
+3. Include any signed headers required by the upload URL, such as `x-amz-acl: public-read` when provided.
+4. Call `updateUserImage(fileName)` using the returned `FileName`.
 
 ### Get User Image Canned URL
 
 Public signature: `settingsClient.getUserImageCannedUrl(extension)`
 
-Generates a canned upload URL for a user selfie file.
-The connector returns the raw backend response object for the generated file.
-The package does not upload the file bytes for you.
-When you upload to the returned S3 URL, you must preserve any signed headers that the URL expects.
-In live verification, uploads succeeded only when the S3 request included `x-amz-acl: public-read`.
+Generates upload information for a user profile image.
+
+Use the returned `ImageURL` to upload the image file outside this package. After upload, pass the returned `FileName` to `updateUserImage(...)`.
 
 ```ts
 const selfieUpload = await settingsClient.getUserImageCannedUrl("jpeg");
@@ -274,25 +212,28 @@ Status:
 
 ```json
 {
-  "ImageURL": "https://storage.example.com/selfie_example.jpeg?signature=example",
-  "FileName": "selfie_example.jpeg",
-  "Extension": "jpeg"
+  "Data": {
+    "ImageURL": "https://storage.example.com/selfie_example.jpeg?signature=example",
+    "FileName": "selfie_example.jpeg",
+    "Extension": "jpeg"
+  },
+  "ErrorMessage": null,
+  "IsOK": true
 }
 ```
 
 ---
 
-### Capture User Photo
+### Update User Image URL
+
+Public signature: `settingsClient.updateUserImage(fileName)`
 
-Public signature: `settingsClient.captureUserPhoto(fileKey)`
+Updates the stored user image reference using the `FileName` returned by `getUserImageCannedUrl(...)`.
 
-Convenience wrapper around the patient capture endpoint.
-The client sends `Type: "userphoto"` and the uploaded file key inside the backend `Data` wrapper.
-This method expects the file to have already been uploaded to the canned URL returned by `getUserImageCannedUrl(...)`.
-If the canned URL requires signed S3 headers, the upload must include them before capture can succeed.
+Call this method after uploading the image file to the returned `ImageURL`.
 
 ```ts
-const capturedSelfie = await settingsClient.captureUserPhoto(
+const updated = await settingsClient.updateUserImage(
   "selfie_example.jpeg"
 );
 ```
@@ -302,27 +243,34 @@ const capturedSelfie = await settingsClient.captureUserPhoto(
 ```json
 {
   "Data": {
-    "Type": "userphoto",
-    "FileID": "selfie_example.jpeg"
+    "FileName": "selfie_example.jpeg"
   }
 }
 ```
 
 #### API response
 
-Direct success response for a selfie image was not verified in the latest live run.
-The same upload prerequisite applies here as for the ID and insurance flows: the file must exist at the canned URL upload target, and any signed S3 headers such as `x-amz-acl: public-read` must be preserved during upload.
+Status:
+
+```txt
+200
+```
+
+```json
+true
+```
 
 ---
 
+## ID document methods
+
 ### Get Driving License Canned URL
 
 Public signature: `settingsClient.getDrivingLicenseCannedUrl(extension)`
 
-Generates a canned upload URL for a driving license or identification file.
-The package does not upload the file bytes for you.
-When you upload to the returned S3 URL, you must preserve any signed headers that the URL expects.
-In live verification, uploads succeeded only when the S3 request included `x-amz-acl: public-read`.
+Generates upload information for an ID document image.
+
+Use the returned upload information to upload the image file outside this package. If the upload URL requires signed headers, include them in the upload request.
 
 ```ts
 const idUpload = await settingsClient.getDrivingLicenseCannedUrl("jpeg");
@@ -348,9 +296,13 @@ Status:
 
 ```json
 {
-  "ImageURL": "https://storage.example.com/idcard_example.jpeg?signature=example",
-  "FileName": "idcard_example.jpeg",
-  "Extension": "jpeg"
+  "Data": {
+    "ImageURL": "https://storage.example.com/idcard_example.jpeg?signature=example",
+    "FileName": "idcard_example.jpeg",
+    "Extension": "jpeg"
+  },
+  "ErrorMessage": null,
+  "IsOK": true
 }
 ```
 
@@ -360,9 +312,9 @@ Status:
 
 Public signature: `settingsClient.captureDrivingLicense(fileKey)`
 
-Convenience wrapper around the patient capture endpoint.
-The client sends `Type: "identification"` and the uploaded file key inside the backend `Data` wrapper.
-This method expects the file to have already been uploaded to the canned URL returned by `getDrivingLicenseCannedUrl(...)`.
+Submits the uploaded ID document file key after the image has been uploaded.
+
+This method should be called after uploading the file using the upload information returned by `getDrivingLicenseCannedUrl(...)`.
 
 ```ts
 const capturedLicense = await settingsClient.captureDrivingLicense(
@@ -414,15 +366,14 @@ Status:
 
 ---
 
-### Update Driving License
+### Submit Driving License
 
-Public signature: `settingsClient.updateDrivingLicense(payload)`
+Public signature: `settingsClient.submitDrivingLicense(payload)`
 
-Updates patient driving license data through the EHR-backed route.
-The client resolves the current `EHR` internally from `authClient.getUserInfo()` and sends the payload inside the backend `Data` wrapper.
+Submits patient driving license data.
 
 ```ts
-const response = await settingsClient.updateDrivingLicense({
+const response = await settingsClient.submitDrivingLicense({
   Image: "idcard_example.jpeg"
 });
 ```
@@ -453,23 +404,19 @@ Status:
 }
 ```
 
-`Data` was observed as the string `"true"` in the live test environment after a successful upload and capture flow.
-
-`submitDrivingLicense(payload)` is still available as a backward-compatible alias.
-
 ---
+## Insurance methods
 
-### Submit Driving License
+### Get Insurance Canned URL
 
-Public signature: `settingsClient.submitDrivingLicense(payload)`
+Public signature: `settingsClient.getInsuranceCannedUrl(extension)`
 
-Backward-compatible alias for `updateDrivingLicense(payload)`.
-It sends the same request payload and currently calls the same implementation internally.
+Generates upload information for an insurance card image.
+
+Use the returned upload information to upload the image file outside this package. If the upload URL requires signed headers, include them in the upload request.
 
 ```ts
-const response = await settingsClient.submitDrivingLicense({
-  Image: "idcard_example.jpeg"
-});
+const insuranceUpload = await settingsClient.getInsuranceCannedUrl("jpeg");
 ```
 
 #### Full API request
@@ -477,7 +424,7 @@ const response = await settingsClient.submitDrivingLicense({
 ```json
 {
   "Data": {
-    "Image": "idcard_example.jpeg"
+    "Extension": "jpeg"
   }
 }
 ```
@@ -492,7 +439,11 @@ Status:
 
 ```json
 {
-  "Data": "true",
+  "Data": {
+    "ImageURL": "https://storage.example.com/insurancecard_example.jpeg?signature=example",
+    "FileName": "insurancecard_example.jpeg",
+    "Extension": "jpeg"
+  },
   "ErrorMessage": null,
   "IsOK": true
 }
@@ -500,17 +451,18 @@ Status:
 
 ---
 
-### Get Insurance Canned URL
+### Capture Insurance
 
-Public signature: `settingsClient.getInsuranceCannedUrl(extension)`
+Public signature: `settingsClient.captureInsurance(fileKey)`
 
-Generates a canned upload URL for an insurance file.
-The package does not upload the file bytes for you.
-When you upload to the returned S3 URL, you must preserve any signed headers that the URL expects.
-In live verification, uploads succeeded only when the S3 request included `x-amz-acl: public-read`.
+Submits the uploaded insurance file key after the image has been uploaded.
+
+This method should be called after uploading the file using the upload information returned by `getInsuranceCannedUrl(...)`.
 
 ```ts
-const insuranceUpload = await settingsClient.getInsuranceCannedUrl("jpeg");
+const capturedInsurance = await settingsClient.captureInsurance(
+  "insurancecard_example.jpeg"
+);
 ```
 
 #### Full API request
@@ -518,7 +470,8 @@ const insuranceUpload = await settingsClient.getInsuranceCannedUrl("jpeg");
 ```json
 {
   "Data": {
-    "Extension": "jpeg"
+    "Type": "healthinsurance",
+    "FileID": "insurancecard_example.jpeg"
   }
 }
 ```
@@ -533,26 +486,43 @@ Status:
 
 ```json
 {
-  "ImageURL": "https://storage.example.com/insurancecard_example.jpeg?signature=example",
-  "FileName": "insurancecard_example.jpeg",
-  "Extension": "jpeg"
+  "Data": {
+    "CapturedData": {
+      "FirstName": "John",
+      "LastName": "Doe",
+      "MemberId": "member-id-example",
+      "GroupNumber": "group-number-example",
+      "EffectiveDate": "",
+      "RxBIN": "",
+      "RxPCN": "",
+      "RxGRP": "",
+      "Carrier": "Carrier Example"
+    },
+    "IsCaptured": true,
+    "InsurancePackages": null
+  },
+  "ErrorMessage": null,
+  "IsOK": true
 }
 ```
 
 ---
 
-### Capture Insurance
+### Submit Insurance
 
-Public signature: `settingsClient.captureInsurance(fileKey)`
+Public signature: `settingsClient.submitInsurance(payload)`
 
-Convenience wrapper around the patient capture endpoint.
-The client sends `Type: "healthinsurance"` and the uploaded file key inside the backend `Data` wrapper.
-This method expects the file to have already been uploaded to the canned URL returned by `getInsuranceCannedUrl(...)`.
+Submits patient insurance coverage details.
 
 ```ts
-const capturedInsurance = await settingsClient.captureInsurance(
-  "insurancecard_example.jpeg"
-);
+await settingsClient.submitInsurance({
+  InsurancePackageId: "693245",
+  MemberId: "member-id-example",
+  FirstName: "John",
+  LastName: "Doe",
+  Sex: "",
+  Image: "insurancecard_example.jpeg"
+});
 ```
 
 #### Full API request
@@ -560,8 +530,12 @@ const capturedInsurance = await settingsClient.captureInsurance(
 ```json
 {
   "Data": {
-    "Type": "healthinsurance",
-    "FileID": "insurancecard_example.jpeg"
+    "InsurancePackageId": "693245",
+    "MemberId": "member-id-example",
+    "FirstName": "John",
+    "LastName": "Doe",
+    "Sex": "",
+    "Image": "insurancecard_example.jpeg"
   }
 }
 ```
@@ -577,19 +551,13 @@ Status:
 ```json
 {
   "Data": {
-    "CapturedData": {
-      "FirstName": "John",
-      "LastName": "Doe",
-      "MemberId": "member-id-example",
-      "GroupNumber": "group-number-example",
-      "EffectiveDate": "",
-      "RxBIN": "",
-      "RxPCN": "",
-      "RxGRP": "",
-      "Carrier": "Carrier Example"
-    },
-    "IsCaptured": true,
-    "InsurancePackages": null
+    "InsuranceId": "insurance-id-example",
+    "InsurancePackageId": 693245,
+    "InsurancePolicyHolder": "John Doe",
+    "InsuranceType": "Insurance",
+    "IssueDate": "01/01/2030",
+    "MemberId": "member-id-example",
+    "Image": "insurancecard_example.jpeg"
   },
   "ErrorMessage": null,
   "IsOK": true
@@ -602,8 +570,7 @@ Status:
 
 Public signature: `settingsClient.getInsurances()`
 
-Returns patient insurances through the EHR-backed route.
-The client resolves the current `EHR` internally from `authClient.getUserInfo()`.
+Returns patient insurances.
 
 ```ts
 const insurances = await settingsClient.getInsurances();
@@ -645,41 +612,7 @@ Status:
 
 ---
 
-### Update User Image URL
-
-Public signature: `settingsClient.updateUserImage(fileName)`
-
-Updates the stored user image file reference using a file name returned from `getUserImageCannedUrl(...)`.
-
-```ts
-const updated = await settingsClient.updateUserImage(
-  "selfie_example.jpeg"
-);
-```
-
-#### Full API request
-
-```json
-{
-  "Data": {
-    "FileName": "selfie_example.jpeg"
-  }
-}
-```
-
-#### API response
-
-Status:
-
-```txt
-200
-```
-
-```json
-true
-```
-
----
+## Account methods
 
 ### Deactivate User
 
@@ -701,43 +634,36 @@ await settingsClient.deactivateUser();
 
 #### API response
 
-This method was not directly verified in the live environment because it would deactivate the authenticated test user.
-The client returns the raw backend response from the authenticated `PUT` request.
+The client returns the backend response from the authenticated request.
+
+```json
+{
+  "Data": true,
+  "ErrorMessage": null,
+  "IsOK": true
+}
+```
 
 ---
 
 ## How It Works
 
 - `HCLoginClient` handles tenant configuration, authentication, and authenticated headers.
-- `HCSettingsClient` uses the authenticated login client to call patient settings and profile-related endpoints.
-- Canned URL methods return a backend-generated upload URL and file name, but the caller is responsible for uploading the file bytes and preserving any signed S3 headers required by that URL.
-- Capture, insurance, and EHR-backed settings methods all use the authenticated patient context from the shared login client.
-- `getInsurances()`, `updateDrivingLicense()`, and `submitDrivingLicense()` resolve the active patient's `EHR` internally before building the final route.
+- `HCSettingsClient` uses the authenticated login client for the base API URL and authenticated request headers.
+- If configured through `setApiKey(...)`, `HCSettingsClient` also includes its configured API key header with Settings connector requests.
+- Profile image methods use `getUserImageCannedUrl(...)` to request upload information and `updateUserImage(...)` to store the uploaded image reference.
+- Upload URL methods return generated upload information. The caller is responsible for uploading the actual file bytes outside this package.
+- Driver license and insurance capture methods submit the uploaded file key after the file has already been uploaded.
 
 ---
 
 ## Notes
 
-- `HCLoginClient` must be configured and logged in before calling settings methods.
-- `getUserImageCannedUrl()`, `getDrivingLicenseCannedUrl()`, and `getInsuranceCannedUrl()` return the backend canned URL response and do not upload the file contents.
-- After requesting a canned URL, the file must be uploaded outside this package before capture methods can succeed.
-- Live verification showed that the S3 upload must preserve signed headers from the canned URL; when `x-amz-acl` was signed, uploads succeeded with `x-amz-acl: public-read`.
-- `captureUserPhoto()` sends `Type: "userphoto"` and `FileID` to the patient capture endpoint.
-- `captureDrivingLicense()` sends `Type: "identification"` and `FileID` to the patient capture endpoint.
-- `captureInsurance()` sends `Type: "healthinsurance"` and `FileID` to the patient capture endpoint.
-- `updateDrivingLicense()` and `submitDrivingLicense()` send `{ "Data": { "Image": "..." } }` to the resolved EHR patient route.
-- `submitDrivingLicense()` is a backward-compatible alias of `updateDrivingLicense()`.
-- `getInsurances()`, `updateDrivingLicense()`, and `submitDrivingLicense()` internally resolve the current patient's `EHR`.
-
-
-## API Key
-
-Use `setApiKey(...)` to attach an API key header to requests from `HCSettingsClient`.
-
-```ts
-const apiKey = process.env.HEALTHCLOUD_API_KEY;
-settingsClient.setApiKey("x-api-key", apiKey);
-```
-
-- Header name should be `x-api-key`.
-- The API key is also included on the internal patient header lookup used to resolve the active `EHR`.
+- `HCLoginClient` must be configured and logged in before calling Settings connector methods.
+- Canned URL methods return the backend response containing upload information in `Data`.
+- Profile image upload uses `getUserImageCannedUrl(...)` followed by `updateUserImage(...)`.
+- After requesting upload information, the file must be uploaded outside this package before capture methods can succeed.
+- When uploading to the returned storage URL, include any signed headers required by that URL, such as `x-amz-acl: public-read` when provided.
+- `captureDrivingLicense()` sends the ID document file key using `Type: "identification"` and `FileID` inside the request body.
+- `captureInsurance()` sends `Type: "healthinsurance"` and `FileID` inside the request body.
+- `submitDrivingLicense()` submits the driving license data payload.

package/dist/index.cjs

@@ -27,22 +27,44 @@ __export(index_exports, {
 });
 module.exports = __toCommonJS(index_exports);
 
+// src/errors.ts
+var ConfigError = class extends Error {
+  constructor(message) {
+    super(message);
+    this.name = "ConfigError";
+  }
+};
+var AuthError = class extends Error {
+  constructor(message) {
+    super(message);
+    this.name = "AuthError";
+  }
+};
+var HttpError = class extends Error {
+  constructor(status, message) {
+    super(message);
+    this.name = "HttpError";
+    this.status = status;
+  }
+};
+
 // src/client.ts
 var HCSettingsClient = class {
   constructor(httpClient, authClient) {
-    this.resolvedEhr = null;
     this.http = httpClient;
     this.auth = authClient;
   }
   setApiKey(headerName, value) {
-    this.apiKeyHeaderName = headerName;
-    this.apiKeyValue = value;
-  }
-  async getUserInfo() {
-    return this.http.get(
-      `${this.getBaseUrl()}/patient/header`,
-      this.getAuthHeaders()
-    );
+    const trimmedHeaderName = headerName == null ? void 0 : headerName.trim();
+    const trimmedValue = value == null ? void 0 : value.trim();
+    if (!trimmedHeaderName) {
+      throw new ConfigError("API key header name is required.");
+    }
+    if (!trimmedValue) {
+      throw new ConfigError("API key value is required.");
+    }
+    this.apiKeyHeaderName = trimmedHeaderName;
+    this.apiKeyValue = trimmedValue;
   }
   async getDashboard() {
     return this.http.get(
@@ -51,59 +73,40 @@ var HCSettingsClient = class {
     );
   }
   async getUserImageCannedUrl(extension) {
-    var _a;
     const payload = {
       Data: {
         Extension: extension
       }
     };
-    const response = await this.http.put(
+    return this.http.put(
       `${this.getBaseUrl()}/patient/image/cannedurl`,
       payload,
       this.getJsonHeaders()
     );
-    return (_a = response.Data) != null ? _a : response;
   }
   async getDrivingLicenseCannedUrl(extension) {
-    var _a;
     const payload = {
       Data: {
         Extension: extension
       }
     };
-    const response = await this.http.put(
+    return this.http.put(
       `${this.getBaseUrl()}/patient/id/cannedurl`,
       payload,
       this.getJsonHeaders()
     );
-    return (_a = response.Data) != null ? _a : response;
   }
   async getInsuranceCannedUrl(extension) {
-    var _a;
     const payload = {
       Data: {
         Extension: extension
       }
     };
-    const response = await this.http.put(
+    return this.http.put(
       `${this.getBaseUrl()}/patient/insurance/cannedurl`,
       payload,
       this.getJsonHeaders()
     );
-    return (_a = response.Data) != null ? _a : response;
-  }
-  async captureUserPhoto(fileKey) {
-    const payload = {
-      Data: {
-        Type: "userphoto",
-        FileID: fileKey
-      }
-    };
-    return this.http.post(
-      `${this.getBaseUrl()}/patient/capture`,
-      payload,
-      this.getJsonHeaders()
-    );
   }
   async captureDrivingLicense(fileKey) {
     const payload = {
@@ -143,36 +146,31 @@ var HCSettingsClient = class {
   }
   async getInsurances() {
     return this.http.get(
-      await this.buildEhrPatientUrl("insurances"),
+      `${this.getBaseUrl()}/ehr/patient/insurances`,
       this.getAuthHeaders()
     );
   }
-  async updateDrivingLicense(payload) {
+  async submitDrivingLicense(payload) {
     const requestPayload = {
       Data: payload
     };
     return this.http.put(
-      await this.buildEhrPatientUrl("drivinglicense"),
+      `${this.getBaseUrl()}/ehr/patient/drivinglicense`,
       requestPayload,
       this.getJsonHeaders()
     );
   }
-  async submitDrivingLicense(payload) {
-    return this.updateDrivingLicense(payload);
-  }
   async updateUserImage(fileName) {
-    var _a;
     const payload = {
       Data: {
         FileName: fileName
       }
     };
-    const response = await this.http.put(
+    return this.http.put(
       `${this.getBaseUrl()}/patient/image/url`,
       payload,
       this.getJsonHeaders()
     );
-    return (_a = response.Data) != null ? _a : response;
   }
   async deactivateUser() {
     const payload = {
@@ -184,26 +182,6 @@ var HCSettingsClient = class {
       this.getJsonHeaders()
     );
   }
-  async buildEhrPatientUrl(path) {
-    const ehr = await this.getResolvedEhr();
-    return `${this.getBaseUrl()}/ehr/${ehr}/patient/${path}`;
-  }
-  async getResolvedEhr() {
-    var _a, _b, _c;
-    if (this.resolvedEhr) {
-      return this.resolvedEhr;
-    }
-    const userInfo = await this.http.get(
-      `${this.getBaseUrl()}/patient/header`,
-      this.getAuthHeaders()
-    );
-    const ehr = ((_b = (_a = userInfo == null ? void 0 : userInfo.Data) == null ? void 0 : _a.EHR) == null ? void 0 : _b.trim()) || ((_c = userInfo == null ? void 0 : userInfo.EHR) == null ? void 0 : _c.trim());
-    if (!ehr) {
-      throw new Error("Could not resolve EHR from patient header response.");
-    }
-    this.resolvedEhr = ehr;
-    return ehr;
-  }
   getBaseUrl() {
     return this.auth.getBaseUrl();
   }
@@ -224,31 +202,10 @@ var HCSettingsClient = class {
       return {};
     }
     return {
-      "x-api-key": this.apiKeyValue
+      [this.apiKeyHeaderName]: this.apiKeyValue
     };
   }
 };
-
-// src/errors.ts
-var ConfigError = class extends Error {
-  constructor(message) {
-    super(message);
-    this.name = "ConfigError";
-  }
-};
-var AuthError = class extends Error {
-  constructor(message) {
-    super(message);
-    this.name = "AuthError";
-  }
-};
-var HttpError = class extends Error {
-  constructor(status, message) {
-    super(message);
-    this.name = "HttpError";
-    this.status = status;
-  }
-};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   AuthError,

package/dist/index.d.cts

@@ -10,21 +10,6 @@ interface UserImage {
     fileName?: string;
     extension?: string;
 }
-interface UserInfo {
-    ID?: string;
-    Email?: string;
-    TenantID?: string;
-    HasInsurance?: boolean;
-    HasIDCard?: boolean;
-    HasSelfie?: boolean;
-    Attributes?: Record<string, any>;
-}
-interface UserInfoResponse {
-    Data?: {
-        EHR?: string;
-    };
-    EHR?: string;
-}
 interface APIRequest<T> {
     Data: T;
 }
@@ -42,7 +27,7 @@ interface CoverageRequest {
     Image: string;
 }
 type CoveragePayload = APIRequest<CoverageRequest>;
-type CaptureType = "identification" | "healthinsurance" | "userphoto";
+type CaptureType = "identification" | "healthinsurance";
 interface CaptureData {
     Type: CaptureType;
     FileID: string;
@@ -63,32 +48,25 @@ interface DrivingLicenseData {
 type DrivingLicenseRequest = APIRequest<DrivingLicenseData>;
 type DrivingLicenseResponse = APIResponse<string>;
 type HCUserImage = UserImage;
-type HCUserInfo = UserInfo;
 
 declare class HCSettingsClient {
     private http;
     private auth;
-    private resolvedEhr;
     private apiKeyHeaderName?;
     private apiKeyValue?;
     constructor(httpClient: HttpClient, authClient: HCLoginClient);
     setApiKey(headerName: string, value: string): void;
-    getUserInfo(): Promise<any>;
     getDashboard(): Promise<any>;
     getUserImageCannedUrl(extension: string): Promise<UserImage>;
     getDrivingLicenseCannedUrl(extension: string): Promise<UserImage>;
     getInsuranceCannedUrl(extension: string): Promise<UserImage>;
-    captureUserPhoto(fileKey: string): Promise<any>;
     captureDrivingLicense(fileKey: string): Promise<any>;
     captureInsurance(fileKey: string): Promise<any>;
     submitInsurance(payload: CoverageRequest): Promise<any>;
     getInsurances(): Promise<any>;
-    updateDrivingLicense(payload: DrivingLicenseData): Promise<DrivingLicenseResponse>;
     submitDrivingLicense(payload: DrivingLicenseData): Promise<DrivingLicenseResponse>;
     updateUserImage(fileName: string): Promise<any>;
     deactivateUser(): Promise<any>;
-    private buildEhrPatientUrl;
-    private getResolvedEhr;
     private getBaseUrl;
     private getAuthHeaders;
     private getJsonHeaders;
@@ -106,4 +84,4 @@ declare class HttpError extends Error {
     constructor(status: number, message: string);
 }
 
-export { type APIRequest, type APIResponse, AuthError, type CaptureData, type CaptureRequest, type CaptureType, ConfigError, type CoveragePayload, type CoverageRequest, type DrivingLicenseData, type DrivingLicenseRequest, type DrivingLicenseResponse, type EmptyRequest, type Environment, HCSettingsClient, type HCUserImage, type HCUserInfo, HttpError, type UpdateImageData, type UpdateImageRequest, type UploadImageData, type UploadImageRequest, type UserImage, type UserInfo, type UserInfoResponse };
+export { type APIRequest, type APIResponse, AuthError, type CaptureData, type CaptureRequest, type CaptureType, ConfigError, type CoveragePayload, type CoverageRequest, type DrivingLicenseData, type DrivingLicenseRequest, type DrivingLicenseResponse, type EmptyRequest, type Environment, HCSettingsClient, type HCUserImage, HttpError, type UpdateImageData, type UpdateImageRequest, type UploadImageData, type UploadImageRequest, type UserImage };

package/dist/index.d.ts

@@ -10,21 +10,6 @@ interface UserImage {
     fileName?: string;
     extension?: string;
 }
-interface UserInfo {
-    ID?: string;
-    Email?: string;
-    TenantID?: string;
-    HasInsurance?: boolean;
-    HasIDCard?: boolean;
-    HasSelfie?: boolean;
-    Attributes?: Record<string, any>;
-}
-interface UserInfoResponse {
-    Data?: {
-        EHR?: string;
-    };
-    EHR?: string;
-}
 interface APIRequest<T> {
     Data: T;
 }
@@ -42,7 +27,7 @@ interface CoverageRequest {
     Image: string;
 }
 type CoveragePayload = APIRequest<CoverageRequest>;
-type CaptureType = "identification" | "healthinsurance" | "userphoto";
+type CaptureType = "identification" | "healthinsurance";
 interface CaptureData {
     Type: CaptureType;
     FileID: string;
@@ -63,32 +48,25 @@ interface DrivingLicenseData {
 type DrivingLicenseRequest = APIRequest<DrivingLicenseData>;
 type DrivingLicenseResponse = APIResponse<string>;
 type HCUserImage = UserImage;
-type HCUserInfo = UserInfo;
 
 declare class HCSettingsClient {
     private http;
     private auth;
-    private resolvedEhr;
     private apiKeyHeaderName?;
     private apiKeyValue?;
     constructor(httpClient: HttpClient, authClient: HCLoginClient);
     setApiKey(headerName: string, value: string): void;
-    getUserInfo(): Promise<any>;
     getDashboard(): Promise<any>;
     getUserImageCannedUrl(extension: string): Promise<UserImage>;
     getDrivingLicenseCannedUrl(extension: string): Promise<UserImage>;
     getInsuranceCannedUrl(extension: string): Promise<UserImage>;
-    captureUserPhoto(fileKey: string): Promise<any>;
     captureDrivingLicense(fileKey: string): Promise<any>;
     captureInsurance(fileKey: string): Promise<any>;
     submitInsurance(payload: CoverageRequest): Promise<any>;
     getInsurances(): Promise<any>;
-    updateDrivingLicense(payload: DrivingLicenseData): Promise<DrivingLicenseResponse>;
     submitDrivingLicense(payload: DrivingLicenseData): Promise<DrivingLicenseResponse>;
     updateUserImage(fileName: string): Promise<any>;
     deactivateUser(): Promise<any>;
-    private buildEhrPatientUrl;
-    private getResolvedEhr;
     private getBaseUrl;
     private getAuthHeaders;
     private getJsonHeaders;
@@ -106,4 +84,4 @@ declare class HttpError extends Error {
     constructor(status: number, message: string);
 }
 
-export { type APIRequest, type APIResponse, AuthError, type CaptureData, type CaptureRequest, type CaptureType, ConfigError, type CoveragePayload, type CoverageRequest, type DrivingLicenseData, type DrivingLicenseRequest, type DrivingLicenseResponse, type EmptyRequest, type Environment, HCSettingsClient, type HCUserImage, type HCUserInfo, HttpError, type UpdateImageData, type UpdateImageRequest, type UploadImageData, type UploadImageRequest, type UserImage, type UserInfo, type UserInfoResponse };
+export { type APIRequest, type APIResponse, AuthError, type CaptureData, type CaptureRequest, type CaptureType, ConfigError, type CoveragePayload, type CoverageRequest, type DrivingLicenseData, type DrivingLicenseRequest, type DrivingLicenseResponse, type EmptyRequest, type Environment, HCSettingsClient, type HCUserImage, HttpError, type UpdateImageData, type UpdateImageRequest, type UploadImageData, type UploadImageRequest, type UserImage };

package/dist/index.js

@@ -1,19 +1,41 @@
+// src/errors.ts
+var ConfigError = class extends Error {
+  constructor(message) {
+    super(message);
+    this.name = "ConfigError";
+  }
+};
+var AuthError = class extends Error {
+  constructor(message) {
+    super(message);
+    this.name = "AuthError";
+  }
+};
+var HttpError = class extends Error {
+  constructor(status, message) {
+    super(message);
+    this.name = "HttpError";
+    this.status = status;
+  }
+};
+
 // src/client.ts
 var HCSettingsClient = class {
   constructor(httpClient, authClient) {
-    this.resolvedEhr = null;
     this.http = httpClient;
     this.auth = authClient;
   }
   setApiKey(headerName, value) {
-    this.apiKeyHeaderName = headerName;
-    this.apiKeyValue = value;
-  }
-  async getUserInfo() {
-    return this.http.get(
-      `${this.getBaseUrl()}/patient/header`,
-      this.getAuthHeaders()
-    );
+    const trimmedHeaderName = headerName == null ? void 0 : headerName.trim();
+    const trimmedValue = value == null ? void 0 : value.trim();
+    if (!trimmedHeaderName) {
+      throw new ConfigError("API key header name is required.");
+    }
+    if (!trimmedValue) {
+      throw new ConfigError("API key value is required.");
+    }
+    this.apiKeyHeaderName = trimmedHeaderName;
+    this.apiKeyValue = trimmedValue;
   }
   async getDashboard() {
     return this.http.get(
@@ -22,59 +44,40 @@ var HCSettingsClient = class {
     );
   }
   async getUserImageCannedUrl(extension) {
-    var _a;
     const payload = {
       Data: {
         Extension: extension
       }
     };
-    const response = await this.http.put(
+    return this.http.put(
       `${this.getBaseUrl()}/patient/image/cannedurl`,
       payload,
       this.getJsonHeaders()
     );
-    return (_a = response.Data) != null ? _a : response;
   }
   async getDrivingLicenseCannedUrl(extension) {
-    var _a;
     const payload = {
       Data: {
         Extension: extension
       }
     };
-    const response = await this.http.put(
+    return this.http.put(
       `${this.getBaseUrl()}/patient/id/cannedurl`,
       payload,
       this.getJsonHeaders()
     );
-    return (_a = response.Data) != null ? _a : response;
   }
   async getInsuranceCannedUrl(extension) {
-    var _a;
     const payload = {
       Data: {
         Extension: extension
       }
     };
-    const response = await this.http.put(
+    return this.http.put(
       `${this.getBaseUrl()}/patient/insurance/cannedurl`,
       payload,
       this.getJsonHeaders()
     );
-    return (_a = response.Data) != null ? _a : response;
-  }
-  async captureUserPhoto(fileKey) {
-    const payload = {
-      Data: {
-        Type: "userphoto",
-        FileID: fileKey
-      }
-    };
-    return this.http.post(
-      `${this.getBaseUrl()}/patient/capture`,
-      payload,
-      this.getJsonHeaders()
-    );
   }
   async captureDrivingLicense(fileKey) {
     const payload = {
@@ -114,36 +117,31 @@ var HCSettingsClient = class {
   }
   async getInsurances() {
     return this.http.get(
-      await this.buildEhrPatientUrl("insurances"),
+      `${this.getBaseUrl()}/ehr/patient/insurances`,
       this.getAuthHeaders()
     );
   }
-  async updateDrivingLicense(payload) {
+  async submitDrivingLicense(payload) {
     const requestPayload = {
       Data: payload
     };
     return this.http.put(
-      await this.buildEhrPatientUrl("drivinglicense"),
+      `${this.getBaseUrl()}/ehr/patient/drivinglicense`,
       requestPayload,
       this.getJsonHeaders()
     );
   }
-  async submitDrivingLicense(payload) {
-    return this.updateDrivingLicense(payload);
-  }
   async updateUserImage(fileName) {
-    var _a;
     const payload = {
       Data: {
         FileName: fileName
       }
     };
-    const response = await this.http.put(
+    return this.http.put(
       `${this.getBaseUrl()}/patient/image/url`,
       payload,
       this.getJsonHeaders()
     );
-    return (_a = response.Data) != null ? _a : response;
   }
   async deactivateUser() {
     const payload = {
@@ -155,26 +153,6 @@ var HCSettingsClient = class {
       this.getJsonHeaders()
     );
   }
-  async buildEhrPatientUrl(path) {
-    const ehr = await this.getResolvedEhr();
-    return `${this.getBaseUrl()}/ehr/${ehr}/patient/${path}`;
-  }
-  async getResolvedEhr() {
-    var _a, _b, _c;
-    if (this.resolvedEhr) {
-      return this.resolvedEhr;
-    }
-    const userInfo = await this.http.get(
-      `${this.getBaseUrl()}/patient/header`,
-      this.getAuthHeaders()
-    );
-    const ehr = ((_b = (_a = userInfo == null ? void 0 : userInfo.Data) == null ? void 0 : _a.EHR) == null ? void 0 : _b.trim()) || ((_c = userInfo == null ? void 0 : userInfo.EHR) == null ? void 0 : _c.trim());
-    if (!ehr) {
-      throw new Error("Could not resolve EHR from patient header response.");
-    }
-    this.resolvedEhr = ehr;
-    return ehr;
-  }
   getBaseUrl() {
     return this.auth.getBaseUrl();
   }
@@ -195,31 +173,10 @@ var HCSettingsClient = class {
       return {};
     }
     return {
-      "x-api-key": this.apiKeyValue
+      [this.apiKeyHeaderName]: this.apiKeyValue
     };
   }
 };
-
-// src/errors.ts
-var ConfigError = class extends Error {
-  constructor(message) {
-    super(message);
-    this.name = "ConfigError";
-  }
-};
-var AuthError = class extends Error {
-  constructor(message) {
-    super(message);
-    this.name = "AuthError";
-  }
-};
-var HttpError = class extends Error {
-  constructor(status, message) {
-    super(message);
-    this.name = "HttpError";
-    this.status = status;
-  }
-};
 export {
   AuthError,
   ConfigError,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@healthcloudai/hc-settings-connector",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "description": "Healthcheck Settings SDK with TypeScript",
   "author": "Healthcheck Systems Inc",
   "license": "MIT",