@healthcloudai/hc-settings-connector 0.0.6 → 0.0.8

package/README.md

@@ -728,4 +728,21 @@ The client returns the raw backend response from the authenticated `PUT` request
 - `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`.
-- Live verification showed the canned URL methods returning `ImageURL`, `FileName`, and `Extension` keys from the backend response.
+
+
+## API Key
+
+All outgoing requests from `HCSettingsClient` can include an optional API key header.
+
+```ts
+const apiKey = process.env.HEALTHCLOUD_API_KEY;
+
+if (apiKey) {
+  settingsClient.setApiKey("x-api-key", apiKey);
+}
+```
+
+- Header name should be `x-api-key`.
+- API key is optional unless required by the backend.
+- If not set, behavior remains unchanged and the header is omitted.
+- The API key is also included on the internal patient header lookup used to resolve the active `EHR`.

package/dist/index.cjs

@@ -34,16 +34,20 @@ var HCSettingsClient = class {
     this.http = httpClient;
     this.auth = authClient;
   }
+  setApiKey(headerName, value) {
+    this.apiKeyHeaderName = headerName;
+    this.apiKeyValue = value;
+  }
   async getUserInfo() {
     return this.http.get(
-      `${this.auth.getBaseUrl()}/patient/header`,
-      this.auth.getAuthHeader()
+      `${this.getBaseUrl()}/patient/header`,
+      this.getAuthHeaders()
     );
   }
   async getDashboard() {
     return this.http.get(
-      `${this.auth.getBaseUrl()}/patient/dashboard`,
-      this.auth.getAuthHeader()
+      `${this.getBaseUrl()}/patient/dashboard`,
+      this.getAuthHeaders()
     );
   }
   async getUserImageCannedUrl(extension) {
@@ -54,12 +58,9 @@ var HCSettingsClient = class {
       }
     };
     const response = await this.http.put(
-      `${this.auth.getBaseUrl()}/patient/image/cannedurl`,
+      `${this.getBaseUrl()}/patient/image/cannedurl`,
       payload,
-      {
-        ...this.auth.getAuthHeader(),
-        "Content-Type": "application/json"
-      }
+      this.getJsonHeaders()
     );
     return (_a = response.Data) != null ? _a : response;
   }
@@ -71,12 +72,9 @@ var HCSettingsClient = class {
       }
     };
     const response = await this.http.put(
-      `${this.auth.getBaseUrl()}/patient/id/cannedurl`,
+      `${this.getBaseUrl()}/patient/id/cannedurl`,
       payload,
-      {
-        ...this.auth.getAuthHeader(),
-        "Content-Type": "application/json"
-      }
+      this.getJsonHeaders()
     );
     return (_a = response.Data) != null ? _a : response;
   }
@@ -88,12 +86,9 @@ var HCSettingsClient = class {
       }
     };
     const response = await this.http.put(
-      `${this.auth.getBaseUrl()}/patient/insurance/cannedurl`,
+      `${this.getBaseUrl()}/patient/insurance/cannedurl`,
       payload,
-      {
-        ...this.auth.getAuthHeader(),
-        "Content-Type": "application/json"
-      }
+      this.getJsonHeaders()
     );
     return (_a = response.Data) != null ? _a : response;
   }
@@ -105,12 +100,9 @@ var HCSettingsClient = class {
       }
     };
     return this.http.post(
-      `${this.auth.getBaseUrl()}/patient/capture`,
+      `${this.getBaseUrl()}/patient/capture`,
       payload,
-      {
-        ...this.auth.getAuthHeader(),
-        "Content-Type": "application/json"
-      }
+      this.getJsonHeaders()
     );
   }
   async captureDrivingLicense(fileKey) {
@@ -121,12 +113,9 @@ var HCSettingsClient = class {
       }
     };
     return this.http.post(
-      `${this.auth.getBaseUrl()}/patient/capture`,
+      `${this.getBaseUrl()}/patient/capture`,
       payload,
-      {
-        ...this.auth.getAuthHeader(),
-        "Content-Type": "application/json"
-      }
+      this.getJsonHeaders()
     );
   }
   async captureInsurance(fileKey) {
@@ -137,12 +126,9 @@ var HCSettingsClient = class {
       }
     };
     return this.http.post(
-      `${this.auth.getBaseUrl()}/patient/capture`,
+      `${this.getBaseUrl()}/patient/capture`,
       payload,
-      {
-        ...this.auth.getAuthHeader(),
-        "Content-Type": "application/json"
-      }
+      this.getJsonHeaders()
     );
   }
   async submitInsurance(payload) {
@@ -150,18 +136,15 @@ var HCSettingsClient = class {
       Data: payload
     };
     return this.http.put(
-      `${this.auth.getBaseUrl()}/patient/coverage`,
+      `${this.getBaseUrl()}/patient/coverage`,
       requestPayload,
-      {
-        ...this.auth.getAuthHeader(),
-        "Content-Type": "application/json"
-      }
+      this.getJsonHeaders()
     );
   }
   async getInsurances() {
     return this.http.get(
       await this.buildEhrPatientUrl("insurances"),
-      this.auth.getAuthHeader()
+      this.getAuthHeaders()
     );
   }
   async updateDrivingLicense(payload) {
@@ -171,10 +154,7 @@ var HCSettingsClient = class {
     return this.http.put(
       await this.buildEhrPatientUrl("drivinglicense"),
       requestPayload,
-      {
-        ...this.auth.getAuthHeader(),
-        "Content-Type": "application/json"
-      }
+      this.getJsonHeaders()
     );
   }
   async submitDrivingLicense(payload) {
@@ -188,12 +168,9 @@ var HCSettingsClient = class {
       }
     };
     const response = await this.http.put(
-      `${this.auth.getBaseUrl()}/patient/image/url`,
+      `${this.getBaseUrl()}/patient/image/url`,
       payload,
-      {
-        ...this.auth.getAuthHeader(),
-        "Content-Type": "application/json"
-      }
+      this.getJsonHeaders()
     );
     return (_a = response.Data) != null ? _a : response;
   }
@@ -202,31 +179,54 @@ var HCSettingsClient = class {
       Data: {}
     };
     return this.http.put(
-      `${this.auth.getBaseUrl()}/patient/deactivate`,
+      `${this.getBaseUrl()}/patient/deactivate`,
       payload,
-      {
-        ...this.auth.getAuthHeader(),
-        "Content-Type": "application/json"
-      }
+      this.getJsonHeaders()
     );
   }
   async buildEhrPatientUrl(path) {
     const ehr = await this.getResolvedEhr();
-    return `${this.auth.getBaseUrl()}/ehr/${ehr}/patient/${path}`;
+    return `${this.getBaseUrl()}/ehr/${ehr}/patient/${path}`;
   }
   async getResolvedEhr() {
     var _a, _b, _c;
     if (this.resolvedEhr) {
       return this.resolvedEhr;
     }
-    const userInfo = await this.auth.getUserInfo();
+    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 loginClient.getUserInfo()");
+      throw new Error("Could not resolve EHR from patient header response.");
     }
     this.resolvedEhr = ehr;
     return ehr;
   }
+  getBaseUrl() {
+    return this.auth.getBaseUrl();
+  }
+  getAuthHeaders() {
+    return {
+      ...this.auth.getAuthHeader(),
+      ...this.getApiKeyHeader()
+    };
+  }
+  getJsonHeaders() {
+    return {
+      ...this.getAuthHeaders(),
+      "Content-Type": "application/json"
+    };
+  }
+  getApiKeyHeader() {
+    if (!this.apiKeyHeaderName || !this.apiKeyValue) {
+      return {};
+    }
+    return {
+      "x-api-key": this.apiKeyValue
+    };
+  }
 };
 
 // src/errors.ts

package/dist/index.d.cts

@@ -69,7 +69,10 @@ 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>;
@@ -86,6 +89,10 @@ declare class HCSettingsClient {
     deactivateUser(): Promise<any>;
     private buildEhrPatientUrl;
     private getResolvedEhr;
+    private getBaseUrl;
+    private getAuthHeaders;
+    private getJsonHeaders;
+    private getApiKeyHeader;
 }
 
 declare class ConfigError extends Error {

package/dist/index.d.ts

@@ -69,7 +69,10 @@ 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>;
@@ -86,6 +89,10 @@ declare class HCSettingsClient {
     deactivateUser(): Promise<any>;
     private buildEhrPatientUrl;
     private getResolvedEhr;
+    private getBaseUrl;
+    private getAuthHeaders;
+    private getJsonHeaders;
+    private getApiKeyHeader;
 }
 
 declare class ConfigError extends Error {

package/dist/index.js

@@ -5,16 +5,20 @@ var HCSettingsClient = class {
     this.http = httpClient;
     this.auth = authClient;
   }
+  setApiKey(headerName, value) {
+    this.apiKeyHeaderName = headerName;
+    this.apiKeyValue = value;
+  }
   async getUserInfo() {
     return this.http.get(
-      `${this.auth.getBaseUrl()}/patient/header`,
-      this.auth.getAuthHeader()
+      `${this.getBaseUrl()}/patient/header`,
+      this.getAuthHeaders()
     );
   }
   async getDashboard() {
     return this.http.get(
-      `${this.auth.getBaseUrl()}/patient/dashboard`,
-      this.auth.getAuthHeader()
+      `${this.getBaseUrl()}/patient/dashboard`,
+      this.getAuthHeaders()
     );
   }
   async getUserImageCannedUrl(extension) {
@@ -25,12 +29,9 @@ var HCSettingsClient = class {
       }
     };
     const response = await this.http.put(
-      `${this.auth.getBaseUrl()}/patient/image/cannedurl`,
+      `${this.getBaseUrl()}/patient/image/cannedurl`,
       payload,
-      {
-        ...this.auth.getAuthHeader(),
-        "Content-Type": "application/json"
-      }
+      this.getJsonHeaders()
     );
     return (_a = response.Data) != null ? _a : response;
   }
@@ -42,12 +43,9 @@ var HCSettingsClient = class {
       }
     };
     const response = await this.http.put(
-      `${this.auth.getBaseUrl()}/patient/id/cannedurl`,
+      `${this.getBaseUrl()}/patient/id/cannedurl`,
       payload,
-      {
-        ...this.auth.getAuthHeader(),
-        "Content-Type": "application/json"
-      }
+      this.getJsonHeaders()
     );
     return (_a = response.Data) != null ? _a : response;
   }
@@ -59,12 +57,9 @@ var HCSettingsClient = class {
       }
     };
     const response = await this.http.put(
-      `${this.auth.getBaseUrl()}/patient/insurance/cannedurl`,
+      `${this.getBaseUrl()}/patient/insurance/cannedurl`,
       payload,
-      {
-        ...this.auth.getAuthHeader(),
-        "Content-Type": "application/json"
-      }
+      this.getJsonHeaders()
     );
     return (_a = response.Data) != null ? _a : response;
   }
@@ -76,12 +71,9 @@ var HCSettingsClient = class {
       }
     };
     return this.http.post(
-      `${this.auth.getBaseUrl()}/patient/capture`,
+      `${this.getBaseUrl()}/patient/capture`,
       payload,
-      {
-        ...this.auth.getAuthHeader(),
-        "Content-Type": "application/json"
-      }
+      this.getJsonHeaders()
     );
   }
   async captureDrivingLicense(fileKey) {
@@ -92,12 +84,9 @@ var HCSettingsClient = class {
       }
     };
     return this.http.post(
-      `${this.auth.getBaseUrl()}/patient/capture`,
+      `${this.getBaseUrl()}/patient/capture`,
       payload,
-      {
-        ...this.auth.getAuthHeader(),
-        "Content-Type": "application/json"
-      }
+      this.getJsonHeaders()
     );
   }
   async captureInsurance(fileKey) {
@@ -108,12 +97,9 @@ var HCSettingsClient = class {
       }
     };
     return this.http.post(
-      `${this.auth.getBaseUrl()}/patient/capture`,
+      `${this.getBaseUrl()}/patient/capture`,
       payload,
-      {
-        ...this.auth.getAuthHeader(),
-        "Content-Type": "application/json"
-      }
+      this.getJsonHeaders()
     );
   }
   async submitInsurance(payload) {
@@ -121,18 +107,15 @@ var HCSettingsClient = class {
       Data: payload
     };
     return this.http.put(
-      `${this.auth.getBaseUrl()}/patient/coverage`,
+      `${this.getBaseUrl()}/patient/coverage`,
       requestPayload,
-      {
-        ...this.auth.getAuthHeader(),
-        "Content-Type": "application/json"
-      }
+      this.getJsonHeaders()
     );
   }
   async getInsurances() {
     return this.http.get(
       await this.buildEhrPatientUrl("insurances"),
-      this.auth.getAuthHeader()
+      this.getAuthHeaders()
     );
   }
   async updateDrivingLicense(payload) {
@@ -142,10 +125,7 @@ var HCSettingsClient = class {
     return this.http.put(
       await this.buildEhrPatientUrl("drivinglicense"),
       requestPayload,
-      {
-        ...this.auth.getAuthHeader(),
-        "Content-Type": "application/json"
-      }
+      this.getJsonHeaders()
     );
   }
   async submitDrivingLicense(payload) {
@@ -159,12 +139,9 @@ var HCSettingsClient = class {
       }
     };
     const response = await this.http.put(
-      `${this.auth.getBaseUrl()}/patient/image/url`,
+      `${this.getBaseUrl()}/patient/image/url`,
       payload,
-      {
-        ...this.auth.getAuthHeader(),
-        "Content-Type": "application/json"
-      }
+      this.getJsonHeaders()
     );
     return (_a = response.Data) != null ? _a : response;
   }
@@ -173,31 +150,54 @@ var HCSettingsClient = class {
       Data: {}
     };
     return this.http.put(
-      `${this.auth.getBaseUrl()}/patient/deactivate`,
+      `${this.getBaseUrl()}/patient/deactivate`,
       payload,
-      {
-        ...this.auth.getAuthHeader(),
-        "Content-Type": "application/json"
-      }
+      this.getJsonHeaders()
     );
   }
   async buildEhrPatientUrl(path) {
     const ehr = await this.getResolvedEhr();
-    return `${this.auth.getBaseUrl()}/ehr/${ehr}/patient/${path}`;
+    return `${this.getBaseUrl()}/ehr/${ehr}/patient/${path}`;
   }
   async getResolvedEhr() {
     var _a, _b, _c;
     if (this.resolvedEhr) {
       return this.resolvedEhr;
     }
-    const userInfo = await this.auth.getUserInfo();
+    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 loginClient.getUserInfo()");
+      throw new Error("Could not resolve EHR from patient header response.");
     }
     this.resolvedEhr = ehr;
     return ehr;
   }
+  getBaseUrl() {
+    return this.auth.getBaseUrl();
+  }
+  getAuthHeaders() {
+    return {
+      ...this.auth.getAuthHeader(),
+      ...this.getApiKeyHeader()
+    };
+  }
+  getJsonHeaders() {
+    return {
+      ...this.getAuthHeaders(),
+      "Content-Type": "application/json"
+    };
+  }
+  getApiKeyHeader() {
+    if (!this.apiKeyHeaderName || !this.apiKeyValue) {
+      return {};
+    }
+    return {
+      "x-api-key": this.apiKeyValue
+    };
+  }
 };
 
 // src/errors.ts

package/package.json

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