@healthcloudai/hc-settings-connector 0.0.4 → 0.0.5

package/README.md

@@ -146,25 +146,27 @@ The client internally sends `Type: "identification"` and `FileID: fileKey`.
 
 ```ts
 const capturedLicense = await settingsClient.captureDrivingLicense(
-  "drivers-license-front.jpg"
+  "idcard_639064123637965380.jpg"
 );
 ```
 
-### Submit Driving License
+### Update Driving License
 
-Public signature: `settingsClient.submitDrivingLicense(payload)`
+Public signature: `settingsClient.updateDrivingLicense(payload)`
 
-Submits patient driving license data through the wrapper-backed EHR route.
+Updates 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.
+`Image` should be the uploaded file key / path, not a raw file.
 
 ```ts
-await settingsClient.submitDrivingLicense({
-  Number: "DL-123456",
-  State: "CA"
+const response = await settingsClient.updateDrivingLicense({
+  Image: "idcard_639064123637965380.jpg"
 });
 ```
 
+`submitDrivingLicense(payload)` is still available as a backward-compatible alias.
+
 ### Get Insurance Canned URL
 
 Public signature: `settingsClient.getInsuranceCannedUrl(extension)`
@@ -184,7 +186,7 @@ The client internally sends `Type: "healthinsurance"` and `FileID: fileKey`.
 
 ```ts
 const capturedInsurance = await settingsClient.captureInsurance(
-  "insurance-card-front.jpg"
+  "insurance_639064123637965380.jpg"
 );
 ```
 
@@ -246,6 +248,6 @@ await settingsClient.deactivateUser();
 - `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`
-
+- `updateDrivingLicense()` and `submitDrivingLicense()` send `{ Data: { Image: fileKey } }`
+- `getInsurances()`, `updateDrivingLicense()` and `submitDrivingLicense()` internally resolve the current patient's `EHR`
 

package/dist/index.cjs

@@ -164,7 +164,7 @@ var HCSettingsClient = class {
       this.auth.getAuthHeader()
     );
   }
-  async submitDrivingLicense(payload) {
+  async updateDrivingLicense(payload) {
     const requestPayload = {
       Data: payload
     };
@@ -177,6 +177,9 @@ var HCSettingsClient = class {
       }
     );
   }
+  async submitDrivingLicense(payload) {
+    return this.updateDrivingLicense(payload);
+  }
   async updateUserImage(fileName) {
     var _a;
     const payload = {

package/dist/index.d.cts

@@ -22,6 +22,14 @@ interface UserInfoResponse {
     };
     EHR?: string;
 }
+interface APIRequest<T> {
+    Data: T;
+}
+interface APIResponse<T> {
+    Data: T;
+    IsOK: boolean;
+    ErrorMessage?: string | null;
+}
 interface CoverageRequest {
     InsurancePackageId: string;
     MemberId: string;
@@ -30,36 +38,27 @@ interface CoverageRequest {
     Sex: string;
     Image: string;
 }
-interface CoveragePayload {
-    Data: CoverageRequest;
-}
+type CoveragePayload = APIRequest<CoverageRequest>;
 type CaptureType = "identification" | "healthinsurance" | "userphoto";
 interface CaptureData {
     Type: CaptureType;
     FileID: string;
 }
-interface CaptureRequest {
-    Data: CaptureData;
-}
+type CaptureRequest = APIRequest<CaptureData>;
 interface UploadImageData {
     Extension: string;
 }
-interface UploadImageRequest {
-    Data: UploadImageData;
-}
+type UploadImageRequest = APIRequest<UploadImageData>;
 interface UpdateImageData {
     FileName: string;
 }
-interface UpdateImageRequest {
-    Data: UpdateImageData;
-}
-interface EmptyRequest {
-    Data: Record<string, never>;
-}
-type DrivingLicenseData = Record<string, string | number | boolean | null>;
-interface DrivingLicenseRequest {
-    Data: DrivingLicenseData;
+type UpdateImageRequest = APIRequest<UpdateImageData>;
+type EmptyRequest = APIRequest<Record<string, never>>;
+interface DrivingLicenseData {
+    Image: string;
 }
+type DrivingLicenseRequest = APIRequest<DrivingLicenseData>;
+type DrivingLicenseResponse = APIResponse<string>;
 type HCUserImage = UserImage;
 type HCUserInfo = UserInfo;
 
@@ -78,7 +77,8 @@ declare class HCSettingsClient {
     captureInsurance(fileKey: string): Promise<any>;
     submitInsurance(payload: CoverageRequest): Promise<any>;
     getInsurances(): Promise<any>;
-    submitDrivingLicense(payload: DrivingLicenseData): Promise<any>;
+    updateDrivingLicense(payload: DrivingLicenseData): Promise<DrivingLicenseResponse>;
+    submitDrivingLicense(payload: DrivingLicenseData): Promise<DrivingLicenseResponse>;
     updateUserImage(fileName: string): Promise<UserImage>;
     deactivateUser(): Promise<any>;
     private buildEhrPatientUrl;
@@ -96,4 +96,4 @@ declare class HttpError extends Error {
     constructor(status: number, message: string);
 }
 
-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 };
+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 };

package/dist/index.d.ts

@@ -22,6 +22,14 @@ interface UserInfoResponse {
     };
     EHR?: string;
 }
+interface APIRequest<T> {
+    Data: T;
+}
+interface APIResponse<T> {
+    Data: T;
+    IsOK: boolean;
+    ErrorMessage?: string | null;
+}
 interface CoverageRequest {
     InsurancePackageId: string;
     MemberId: string;
@@ -30,36 +38,27 @@ interface CoverageRequest {
     Sex: string;
     Image: string;
 }
-interface CoveragePayload {
-    Data: CoverageRequest;
-}
+type CoveragePayload = APIRequest<CoverageRequest>;
 type CaptureType = "identification" | "healthinsurance" | "userphoto";
 interface CaptureData {
     Type: CaptureType;
     FileID: string;
 }
-interface CaptureRequest {
-    Data: CaptureData;
-}
+type CaptureRequest = APIRequest<CaptureData>;
 interface UploadImageData {
     Extension: string;
 }
-interface UploadImageRequest {
-    Data: UploadImageData;
-}
+type UploadImageRequest = APIRequest<UploadImageData>;
 interface UpdateImageData {
     FileName: string;
 }
-interface UpdateImageRequest {
-    Data: UpdateImageData;
-}
-interface EmptyRequest {
-    Data: Record<string, never>;
-}
-type DrivingLicenseData = Record<string, string | number | boolean | null>;
-interface DrivingLicenseRequest {
-    Data: DrivingLicenseData;
+type UpdateImageRequest = APIRequest<UpdateImageData>;
+type EmptyRequest = APIRequest<Record<string, never>>;
+interface DrivingLicenseData {
+    Image: string;
 }
+type DrivingLicenseRequest = APIRequest<DrivingLicenseData>;
+type DrivingLicenseResponse = APIResponse<string>;
 type HCUserImage = UserImage;
 type HCUserInfo = UserInfo;
 
@@ -78,7 +77,8 @@ declare class HCSettingsClient {
     captureInsurance(fileKey: string): Promise<any>;
     submitInsurance(payload: CoverageRequest): Promise<any>;
     getInsurances(): Promise<any>;
-    submitDrivingLicense(payload: DrivingLicenseData): Promise<any>;
+    updateDrivingLicense(payload: DrivingLicenseData): Promise<DrivingLicenseResponse>;
+    submitDrivingLicense(payload: DrivingLicenseData): Promise<DrivingLicenseResponse>;
     updateUserImage(fileName: string): Promise<UserImage>;
     deactivateUser(): Promise<any>;
     private buildEhrPatientUrl;
@@ -96,4 +96,4 @@ declare class HttpError extends Error {
     constructor(status: number, message: string);
 }
 
-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 };
+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 };

package/dist/index.js

@@ -135,7 +135,7 @@ var HCSettingsClient = class {
       this.auth.getAuthHeader()
     );
   }
-  async submitDrivingLicense(payload) {
+  async updateDrivingLicense(payload) {
     const requestPayload = {
       Data: payload
     };
@@ -148,6 +148,9 @@ var HCSettingsClient = class {
       }
     );
   }
+  async submitDrivingLicense(payload) {
+    return this.updateDrivingLicense(payload);
+  }
   async updateUserImage(fileName) {
     var _a;
     const payload = {

package/package.json

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