@healthcloudai/hc-settings-connector 0.0.10 → 0.0.12

package/README.md

@@ -9,7 +9,7 @@ It is built on top of the shared Healthcheck HTTP and Login connectors.
 ## Features
 1. Retrieve the authenticated patient dashboard
 2. Generate canned upload URLs for selfie, ID, and insurance images
-3. Submit uploaded selfie, identification, and insurance file keys to backend capture endpoints
+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
@@ -160,7 +160,7 @@ Status:
 
 ## Upload and capture flow
 
-Image-related methods follow the same upload flow:
+Image-related methods follow an upload-first flow. Profile image uses `updateUserImage(...)` after upload, while driver license and insurance use capture methods after upload.
 
 1. Request upload information by calling the matching canned URL method.
 2. Upload the file bytes to the returned upload URL outside this package.
@@ -173,13 +173,20 @@ The connector does not upload file bytes. It requests upload information and the
 
 ## Profile image methods
 
+Profile image methods follow this flow:
+
+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 upload information for a user profile 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.
+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");
@@ -217,54 +224,13 @@ Status:
 
 ---
 
-### Capture User Photo
-
-Public signature: `settingsClient.captureUserPhoto(fileKey)`
-
-Submits the uploaded profile image file key after the image has been uploaded.
-
-This method should be called after uploading the file using the upload information returned by `getUserImageCannedUrl(...)`.
-
-```ts
-const capturedSelfie = await settingsClient.captureUserPhoto(
-  "selfie_example.jpeg"
-);
-```
-
-#### Full API request
-
-```json
-{
-  "Data": {
-    "Type": "userphoto",
-    "FileID": "selfie_example.jpeg"
-  }
-}
-```
-
-#### API response
-
-The client returns the backend response from the capture request.
-
-```json
-{
-  "Data": {
-    "CapturedData": null,
-    "IsCaptured": true,
-    "InsurancePackages": null
-  },
-  "ErrorMessage": null,
-  "IsOK": true
-}
-```
-
----
-
 ### Update User Image URL
 
 Public signature: `settingsClient.updateUserImage(fileName)`
 
-Updates the stored user image reference using a file name returned from `getUserImageCannedUrl(...)`.
+Updates the stored user image reference using the `FileName` returned by `getUserImageCannedUrl(...)`.
+
+Call this method after uploading the image file to the returned `ImageURL`.
 
 ```ts
 const updated = await settingsClient.updateUserImage(
@@ -685,8 +651,9 @@ The client returns the backend response from the authenticated request.
 - `HCLoginClient` handles tenant configuration, authentication, and authenticated headers.
 - `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.
-- Capture methods submit the uploaded file key after the file has already been uploaded.
+- Driver license and insurance capture methods submit the uploaded file key after the file has already been uploaded.
 
 ---
 
@@ -694,9 +661,9 @@ The client returns the backend response from the authenticated request.
 
 - `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.
-- `captureUserPhoto()` sends `Type: "userphoto"` and `FileID` inside the request body.
 - `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

@@ -108,19 +108,6 @@ var HCSettingsClient = class {
       this.getJsonHeaders()
     );
   }
-  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 = {
       Data: {

package/dist/index.d.cts

@@ -27,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;
@@ -60,7 +60,6 @@ declare class HCSettingsClient {
     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>;

package/dist/index.d.ts

@@ -27,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;
@@ -60,7 +60,6 @@ declare class HCSettingsClient {
     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>;

package/dist/index.js

@@ -79,19 +79,6 @@ var HCSettingsClient = class {
       this.getJsonHeaders()
     );
   }
-  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 = {
       Data: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@healthcloudai/hc-settings-connector",
-  "version": "0.0.10",
+  "version": "0.0.12",
   "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.0.7",
-    "@healthcloudai/hc-http": "^0.0.3"
+    "@healthcloudai/hc-login-connector": "^0.0.15",
+    "@healthcloudai/hc-http": "^0.0.4"
   },
   "peerDependencies": {
     "react-native": ">=0.70.0"