@healthcloudai/hc-settings-connector 0.0.3 → 0.0.4

package/README.md

@@ -6,11 +6,19 @@ It is built on top of the shared Healthcheck HTTP and Login connectors.
 ---
 
 ## Features
-1. Submit user insurance
-2. Generate a pre-signed URL for user image upload
-3. Update user profile image URL
-4. Self deactivate user
-5. Built on shared Healthcheck HttpClient and authentication layer
+1. Retrieve patient dashboard data
+2. Generate a pre-signed URL for user selfie upload
+3. Capture user selfie from uploaded file key
+4. Generate a pre-signed URL for driving license / ID upload
+5. Capture driving license / ID data from uploaded file key
+6. Submit driving license / ID data
+7. Generate a pre-signed URL for insurance upload
+8. Capture insurance data from uploaded file key
+9. Submit user insurance
+10. Retrieve patient insurances
+11. Update user profile image URL
+12. Self deactivate user
+13. Built on shared Healthcheck HttpClient and authentication layer
 
 ---
 
@@ -40,7 +48,10 @@ import { FetchClient } from "@healthcloudai/hc-http";
 
 ```ts
 const httpClient = new FetchClient();
-const authClient = new HCLoginClient(/* auth configuration */);
+const authClient = new HCLoginClient(httpClient);
+
+authClient.configure("tenant-id", "dev");
+await authClient.login("john.doe@test.com", "password");
 
 const settingsClient = new HCSettingsClient(
   httpClient,
@@ -64,6 +75,18 @@ const userInfo = await settingsClient.getUserInfo();
 
 ---
 
+### Get Dashboard
+
+Public signature: `settingsClient.getDashboard()`
+
+Returns the current patient dashboard response.
+
+```ts
+const dashboard = await settingsClient.getDashboard();
+```
+
+---
+
 ### Submit Insurance
 
 Public signature: `settingsClient.submitInsurance(payload)`
@@ -81,14 +104,99 @@ await settingsClient.submitInsurance({
 });
 ```
 
-### Upload User Image
+### Get User Image Canned URL
+
+Public signature: `settingsClient.getUserImageCannedUrl(extension)`
+
+Generates a pre-signed upload URL for a user selfie file.
+
+```ts
+const selfieUpload = await settingsClient.getUserImageCannedUrl("jpg");
+```
+
+### Capture User Photo
 
-Public signature: `settingsClient.uploadUserImage(extension)`
+Public signature: `settingsClient.captureUserPhoto(fileKey)`
 
-Generates a pre-signed upload URL for uploading a user profile image.
+Captures a user selfie through `POST /patient/capture`.
+The client internally sends `Type: "userphoto"` and `FileID: fileKey`.
 
 ```ts
-const image = await settingsClient.uploadUserImage("jpg");
+const capturedSelfie = await settingsClient.captureUserPhoto(
+  "selfie_639064123637965380.jpg"
+);
+```
+
+### Get Driving License Canned URL
+
+Public signature: `settingsClient.getDrivingLicenseCannedUrl(extension)`
+
+Generates a pre-signed upload URL for a driving license / ID file.
+
+```ts
+const idUpload = await settingsClient.getDrivingLicenseCannedUrl("jpg");
+```
+
+### Capture Driving License
+
+Public signature: `settingsClient.captureDrivingLicense(fileKey)`
+
+Captures and extracts patient identification data through `POST /patient/capture`.
+The client internally sends `Type: "identification"` and `FileID: fileKey`.
+
+```ts
+const capturedLicense = await settingsClient.captureDrivingLicense(
+  "drivers-license-front.jpg"
+);
+```
+
+### Submit Driving License
+
+Public signature: `settingsClient.submitDrivingLicense(payload)`
+
+Submits patient driving license data through the wrapper-backed EHR route.
+The client resolves the current patient's `EHR` internally from `authClient.getUserInfo()`
+and sends the payload inside the backend `Data` wrapper.
+
+```ts
+await settingsClient.submitDrivingLicense({
+  Number: "DL-123456",
+  State: "CA"
+});
+```
+
+### Get Insurance Canned URL
+
+Public signature: `settingsClient.getInsuranceCannedUrl(extension)`
+
+Generates a pre-signed upload URL for an insurance file.
+
+```ts
+const insuranceUpload = await settingsClient.getInsuranceCannedUrl("jpg");
+```
+
+### Capture Insurance
+
+Public signature: `settingsClient.captureInsurance(fileKey)`
+
+Captures and extracts insurance data through `POST /patient/capture`.
+The client internally sends `Type: "healthinsurance"` and `FileID: fileKey`.
+
+```ts
+const capturedInsurance = await settingsClient.captureInsurance(
+  "insurance-card-front.jpg"
+);
+```
+
+### Get Insurances
+
+Public signature: `settingsClient.getInsurances()`
+
+Returns patient insurances through the wrapper-backed EHR route.
+The client resolves the current patient's `EHR` internally from `authClient.getUserInfo()`.
+
+```ts
+const insurances = await settingsClient.getInsurances();
 ```
 
 ### Update User Image URL
@@ -119,6 +227,7 @@ await settingsClient.deactivateUser();
   - Handles authentication
   - Resolves base API URL
   - Provides authorization headers
+  - Resolves the current user's `EHR` for EHR-backed settings methods
 
 - **HttpClient**
   - Performs all HTTP requests
@@ -126,4 +235,17 @@ await settingsClient.deactivateUser();
 - **HCSettingsClient**
   - Exposes user settings and profile-related endpoints
 
+---
+
+## Notes
+
+- `HCLoginClient` must be configured and logged in before calling settings methods
+- `getUserImageCannedUrl()` uses `PUT /patient/image/cannedurl`
+- `getDrivingLicenseCannedUrl()` uses `PUT /patient/id/cannedurl`
+- `getInsuranceCannedUrl()` uses `PUT /patient/insurance/cannedurl`
+- `captureUserPhoto()` sends `Type: "userphoto"` and `FileID` to `/patient/capture`
+- `captureDrivingLicense()` sends `Type: "identification"` and `FileID` to `/patient/capture`
+- `captureInsurance()` sends `Type: "healthinsurance"` and `FileID` to `/patient/capture`
+- `getInsurances()` and `submitDrivingLicense()` internally resolve the current patient's `EHR`
+
 

package/dist/index.cjs

@@ -30,6 +30,7 @@ module.exports = __toCommonJS(index_exports);
 // src/client.ts
 var HCSettingsClient = class {
   constructor(httpClient, authClient) {
+    this.resolvedEhr = null;
     this.http = httpClient;
     this.auth = authClient;
   }
@@ -39,20 +40,30 @@ var HCSettingsClient = class {
       this.auth.getAuthHeader()
     );
   }
-  async submitInsurance(payload) {
-    const requestPayload = {
-      Data: payload
+  async getDashboard() {
+    return this.http.get(
+      `${this.auth.getBaseUrl()}/patient/dashboard`,
+      this.auth.getAuthHeader()
+    );
+  }
+  async getUserImageCannedUrl(extension) {
+    var _a;
+    const payload = {
+      Data: {
+        Extension: extension
+      }
     };
-    return this.http.put(
-      `${this.auth.getBaseUrl()}/patient/coverage`,
-      requestPayload,
+    const response = await this.http.put(
+      `${this.auth.getBaseUrl()}/patient/image/cannedurl`,
+      payload,
       {
         ...this.auth.getAuthHeader(),
         "Content-Type": "application/json"
       }
     );
+    return (_a = response.Data) != null ? _a : response;
   }
-  async uploadUserImage(extension) {
+  async getDrivingLicenseCannedUrl(extension) {
     var _a;
     const payload = {
       Data: {
@@ -60,7 +71,7 @@ var HCSettingsClient = class {
       }
     };
     const response = await this.http.put(
-      `${this.auth.getBaseUrl()}/patient/image/cannedurl`,
+      `${this.auth.getBaseUrl()}/patient/id/cannedurl`,
       payload,
       {
         ...this.auth.getAuthHeader(),
@@ -69,6 +80,103 @@ var HCSettingsClient = class {
     );
     return (_a = response.Data) != null ? _a : response;
   }
+  async getInsuranceCannedUrl(extension) {
+    var _a;
+    const payload = {
+      Data: {
+        Extension: extension
+      }
+    };
+    const response = await this.http.put(
+      `${this.auth.getBaseUrl()}/patient/insurance/cannedurl`,
+      payload,
+      {
+        ...this.auth.getAuthHeader(),
+        "Content-Type": "application/json"
+      }
+    );
+    return (_a = response.Data) != null ? _a : response;
+  }
+  async captureUserPhoto(fileKey) {
+    const payload = {
+      Data: {
+        Type: "userphoto",
+        FileID: fileKey
+      }
+    };
+    return this.http.post(
+      `${this.auth.getBaseUrl()}/patient/capture`,
+      payload,
+      {
+        ...this.auth.getAuthHeader(),
+        "Content-Type": "application/json"
+      }
+    );
+  }
+  async captureDrivingLicense(fileKey) {
+    const payload = {
+      Data: {
+        Type: "identification",
+        FileID: fileKey
+      }
+    };
+    return this.http.post(
+      `${this.auth.getBaseUrl()}/patient/capture`,
+      payload,
+      {
+        ...this.auth.getAuthHeader(),
+        "Content-Type": "application/json"
+      }
+    );
+  }
+  async captureInsurance(fileKey) {
+    const payload = {
+      Data: {
+        Type: "healthinsurance",
+        FileID: fileKey
+      }
+    };
+    return this.http.post(
+      `${this.auth.getBaseUrl()}/patient/capture`,
+      payload,
+      {
+        ...this.auth.getAuthHeader(),
+        "Content-Type": "application/json"
+      }
+    );
+  }
+  async submitInsurance(payload) {
+    const requestPayload = {
+      Data: payload
+    };
+    return this.http.put(
+      `${this.auth.getBaseUrl()}/patient/coverage`,
+      requestPayload,
+      {
+        ...this.auth.getAuthHeader(),
+        "Content-Type": "application/json"
+      }
+    );
+  }
+  async getInsurances() {
+    return this.http.get(
+      await this.buildEhrPatientUrl("insurances"),
+      this.auth.getAuthHeader()
+    );
+  }
+  async submitDrivingLicense(payload) {
+    const requestPayload = {
+      Data: payload
+    };
+    return this.http.put(
+      await this.buildEhrPatientUrl("drivinglicense"),
+      requestPayload,
+      {
+        ...this.auth.getAuthHeader(),
+        "Content-Type": "application/json"
+      }
+    );
+  }
   async updateUserImage(fileName) {
     var _a;
     const payload = {
@@ -99,6 +207,23 @@ var HCSettingsClient = class {
       }
     );
   }
+  async buildEhrPatientUrl(path) {
+    const ehr = await this.getResolvedEhr();
+    return `${this.auth.getBaseUrl()}/ehr/${ehr}/patient/${path}`;
+  }
+  async getResolvedEhr() {
+    var _a, _b, _c;
+    if (this.resolvedEhr) {
+      return this.resolvedEhr;
+    }
+    const userInfo = await this.auth.getUserInfo();
+    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 loginClient.getUserInfo()");
+    }
+    this.resolvedEhr = ehr;
+    return ehr;
+  }
 };
 
 // src/errors.ts

package/dist/index.d.cts

@@ -16,6 +16,12 @@ interface UserInfo {
     HasSelfie?: boolean;
     Attributes?: Record<string, any>;
 }
+interface UserInfoResponse {
+    Data?: {
+        EHR?: string;
+    };
+    EHR?: string;
+}
 interface CoverageRequest {
     InsurancePackageId: string;
     MemberId: string;
@@ -27,6 +33,14 @@ interface CoverageRequest {
 interface CoveragePayload {
     Data: CoverageRequest;
 }
+type CaptureType = "identification" | "healthinsurance" | "userphoto";
+interface CaptureData {
+    Type: CaptureType;
+    FileID: string;
+}
+interface CaptureRequest {
+    Data: CaptureData;
+}
 interface UploadImageData {
     Extension: string;
 }
@@ -42,18 +56,33 @@ interface UpdateImageRequest {
 interface EmptyRequest {
     Data: Record<string, never>;
 }
+type DrivingLicenseData = Record<string, string | number | boolean | null>;
+interface DrivingLicenseRequest {
+    Data: DrivingLicenseData;
+}
 type HCUserImage = UserImage;
 type HCUserInfo = UserInfo;
 
 declare class HCSettingsClient {
     private http;
     private auth;
+    private resolvedEhr;
     constructor(httpClient: HttpClient, authClient: HCLoginClient);
     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>;
-    uploadUserImage(extension: string): Promise<UserImage>;
+    getInsurances(): Promise<any>;
+    submitDrivingLicense(payload: DrivingLicenseData): Promise<any>;
     updateUserImage(fileName: string): Promise<UserImage>;
     deactivateUser(): Promise<any>;
+    private buildEhrPatientUrl;
+    private getResolvedEhr;
 }
 
 declare class ConfigError extends Error {
@@ -67,4 +96,4 @@ declare class HttpError extends Error {
     constructor(status: number, message: string);
 }
 
-export { AuthError, ConfigError, type CoveragePayload, type CoverageRequest, type EmptyRequest, type Environment, HCSettingsClient, type HCUserImage, type HCUserInfo, HttpError, type UpdateImageData, type UpdateImageRequest, type UploadImageData, type UploadImageRequest, type UserImage, type UserInfo };
+export { AuthError, type CaptureData, type CaptureRequest, type CaptureType, ConfigError, type CoveragePayload, type CoverageRequest, type DrivingLicenseData, type DrivingLicenseRequest, type EmptyRequest, type Environment, HCSettingsClient, type HCUserImage, type HCUserInfo, HttpError, type UpdateImageData, type UpdateImageRequest, type UploadImageData, type UploadImageRequest, type UserImage, type UserInfo, type UserInfoResponse };

package/dist/index.d.ts

@@ -16,6 +16,12 @@ interface UserInfo {
     HasSelfie?: boolean;
     Attributes?: Record<string, any>;
 }
+interface UserInfoResponse {
+    Data?: {
+        EHR?: string;
+    };
+    EHR?: string;
+}
 interface CoverageRequest {
     InsurancePackageId: string;
     MemberId: string;
@@ -27,6 +33,14 @@ interface CoverageRequest {
 interface CoveragePayload {
     Data: CoverageRequest;
 }
+type CaptureType = "identification" | "healthinsurance" | "userphoto";
+interface CaptureData {
+    Type: CaptureType;
+    FileID: string;
+}
+interface CaptureRequest {
+    Data: CaptureData;
+}
 interface UploadImageData {
     Extension: string;
 }
@@ -42,18 +56,33 @@ interface UpdateImageRequest {
 interface EmptyRequest {
     Data: Record<string, never>;
 }
+type DrivingLicenseData = Record<string, string | number | boolean | null>;
+interface DrivingLicenseRequest {
+    Data: DrivingLicenseData;
+}
 type HCUserImage = UserImage;
 type HCUserInfo = UserInfo;
 
 declare class HCSettingsClient {
     private http;
     private auth;
+    private resolvedEhr;
     constructor(httpClient: HttpClient, authClient: HCLoginClient);
     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>;
-    uploadUserImage(extension: string): Promise<UserImage>;
+    getInsurances(): Promise<any>;
+    submitDrivingLicense(payload: DrivingLicenseData): Promise<any>;
     updateUserImage(fileName: string): Promise<UserImage>;
     deactivateUser(): Promise<any>;
+    private buildEhrPatientUrl;
+    private getResolvedEhr;
 }
 
 declare class ConfigError extends Error {
@@ -67,4 +96,4 @@ declare class HttpError extends Error {
     constructor(status: number, message: string);
 }
 
-export { AuthError, ConfigError, type CoveragePayload, type CoverageRequest, type EmptyRequest, type Environment, HCSettingsClient, type HCUserImage, type HCUserInfo, HttpError, type UpdateImageData, type UpdateImageRequest, type UploadImageData, type UploadImageRequest, type UserImage, type UserInfo };
+export { AuthError, type CaptureData, type CaptureRequest, type CaptureType, ConfigError, type CoveragePayload, type CoverageRequest, type DrivingLicenseData, type DrivingLicenseRequest, type EmptyRequest, type Environment, HCSettingsClient, type HCUserImage, type HCUserInfo, HttpError, type UpdateImageData, type UpdateImageRequest, type UploadImageData, type UploadImageRequest, type UserImage, type UserInfo, type UserInfoResponse };

package/dist/index.js

@@ -1,6 +1,7 @@
 // src/client.ts
 var HCSettingsClient = class {
   constructor(httpClient, authClient) {
+    this.resolvedEhr = null;
     this.http = httpClient;
     this.auth = authClient;
   }
@@ -10,20 +11,30 @@ var HCSettingsClient = class {
       this.auth.getAuthHeader()
     );
   }
-  async submitInsurance(payload) {
-    const requestPayload = {
-      Data: payload
+  async getDashboard() {
+    return this.http.get(
+      `${this.auth.getBaseUrl()}/patient/dashboard`,
+      this.auth.getAuthHeader()
+    );
+  }
+  async getUserImageCannedUrl(extension) {
+    var _a;
+    const payload = {
+      Data: {
+        Extension: extension
+      }
     };
-    return this.http.put(
-      `${this.auth.getBaseUrl()}/patient/coverage`,
-      requestPayload,
+    const response = await this.http.put(
+      `${this.auth.getBaseUrl()}/patient/image/cannedurl`,
+      payload,
       {
         ...this.auth.getAuthHeader(),
         "Content-Type": "application/json"
       }
     );
+    return (_a = response.Data) != null ? _a : response;
   }
-  async uploadUserImage(extension) {
+  async getDrivingLicenseCannedUrl(extension) {
     var _a;
     const payload = {
       Data: {
@@ -31,7 +42,7 @@ var HCSettingsClient = class {
       }
     };
     const response = await this.http.put(
-      `${this.auth.getBaseUrl()}/patient/image/cannedurl`,
+      `${this.auth.getBaseUrl()}/patient/id/cannedurl`,
       payload,
       {
         ...this.auth.getAuthHeader(),
@@ -40,6 +51,103 @@ var HCSettingsClient = class {
     );
     return (_a = response.Data) != null ? _a : response;
   }
+  async getInsuranceCannedUrl(extension) {
+    var _a;
+    const payload = {
+      Data: {
+        Extension: extension
+      }
+    };
+    const response = await this.http.put(
+      `${this.auth.getBaseUrl()}/patient/insurance/cannedurl`,
+      payload,
+      {
+        ...this.auth.getAuthHeader(),
+        "Content-Type": "application/json"
+      }
+    );
+    return (_a = response.Data) != null ? _a : response;
+  }
+  async captureUserPhoto(fileKey) {
+    const payload = {
+      Data: {
+        Type: "userphoto",
+        FileID: fileKey
+      }
+    };
+    return this.http.post(
+      `${this.auth.getBaseUrl()}/patient/capture`,
+      payload,
+      {
+        ...this.auth.getAuthHeader(),
+        "Content-Type": "application/json"
+      }
+    );
+  }
+  async captureDrivingLicense(fileKey) {
+    const payload = {
+      Data: {
+        Type: "identification",
+        FileID: fileKey
+      }
+    };
+    return this.http.post(
+      `${this.auth.getBaseUrl()}/patient/capture`,
+      payload,
+      {
+        ...this.auth.getAuthHeader(),
+        "Content-Type": "application/json"
+      }
+    );
+  }
+  async captureInsurance(fileKey) {
+    const payload = {
+      Data: {
+        Type: "healthinsurance",
+        FileID: fileKey
+      }
+    };
+    return this.http.post(
+      `${this.auth.getBaseUrl()}/patient/capture`,
+      payload,
+      {
+        ...this.auth.getAuthHeader(),
+        "Content-Type": "application/json"
+      }
+    );
+  }
+  async submitInsurance(payload) {
+    const requestPayload = {
+      Data: payload
+    };
+    return this.http.put(
+      `${this.auth.getBaseUrl()}/patient/coverage`,
+      requestPayload,
+      {
+        ...this.auth.getAuthHeader(),
+        "Content-Type": "application/json"
+      }
+    );
+  }
+  async getInsurances() {
+    return this.http.get(
+      await this.buildEhrPatientUrl("insurances"),
+      this.auth.getAuthHeader()
+    );
+  }
+  async submitDrivingLicense(payload) {
+    const requestPayload = {
+      Data: payload
+    };
+    return this.http.put(
+      await this.buildEhrPatientUrl("drivinglicense"),
+      requestPayload,
+      {
+        ...this.auth.getAuthHeader(),
+        "Content-Type": "application/json"
+      }
+    );
+  }
   async updateUserImage(fileName) {
     var _a;
     const payload = {
@@ -70,6 +178,23 @@ var HCSettingsClient = class {
       }
     );
   }
+  async buildEhrPatientUrl(path) {
+    const ehr = await this.getResolvedEhr();
+    return `${this.auth.getBaseUrl()}/ehr/${ehr}/patient/${path}`;
+  }
+  async getResolvedEhr() {
+    var _a, _b, _c;
+    if (this.resolvedEhr) {
+      return this.resolvedEhr;
+    }
+    const userInfo = await this.auth.getUserInfo();
+    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 loginClient.getUserInfo()");
+    }
+    this.resolvedEhr = ehr;
+    return ehr;
+  }
 };
 
 // src/errors.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@healthcloudai/hc-settings-connector",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "Healthcheck Settings SDK with TypeScript",
   "author": "Healthcheck Systems Inc",
   "license": "MIT",
@@ -36,7 +36,7 @@
   },
   "dependencies": {
     "axios": "^1.13.4",
-    "@healthcloudai/hc-login-connector": "^0.0.2",
+    "@healthcloudai/hc-login-connector": "^0.0.7",
     "@healthcloudai/hc-http": "^0.0.3"
   },
   "peerDependencies": {