@healthcloudai/hc-settings-connector 0.0.13 → 0.0.14

package/dist/index.d.ts

@@ -1,24 +1,20 @@
 import { HCLoginClient } from '@healthcloudai/hc-login-connector';
 import { HttpClient } from '@healthcloudai/hc-http';
 
-type Environment = "dev" | "uat" | "prod";
-interface UserImage {
-    ImageURL: string;
-    FileName: string;
-    Extension: string;
-    imageUrl?: string;
-    fileName?: string;
-    extension?: string;
-}
 interface APIRequest<T> {
     Data: T;
 }
 interface APIResponse<T> {
-    Data: T;
+    Data: T | null;
     IsOK: boolean;
-    ErrorMessage?: string | null;
+    ErrorMessage: string | null;
 }
-interface CoverageRequest {
+interface UserImage {
+    ImageURL: string | null;
+    FileName: string | null;
+    Extension: string | null;
+}
+interface CoverageData {
     InsurancePackageId: string;
     MemberId: string;
     FirstName: string;
@@ -26,51 +22,128 @@ interface CoverageRequest {
     Sex: string;
     Image: string;
 }
-type CoveragePayload = APIRequest<CoverageRequest>;
-type CaptureType = "identification" | "healthinsurance";
-interface CaptureData {
-    Type: CaptureType;
-    FileID: string;
+declare enum UserStatus {
+    INACTIVE = 0,
+    ACTIVE = 1,
+    SUSPENDED = -1
 }
-type CaptureRequest = APIRequest<CaptureData>;
-interface UploadImageData {
-    Extension: string;
+interface PatientRecord {
+    Status: UserStatus;
+    Sex: string | null;
+    GenderIdentity: string | null;
+    HasInsurance: boolean;
+    HasIDCard: boolean;
+    HasSelfie: boolean;
+    Flags: Record<string, string> | null;
 }
-type UploadImageRequest = APIRequest<UploadImageData>;
-interface UpdateImageData {
-    FileName: string;
+interface Encounter {
+    FHIRID: string | null;
+    AthenaID: string | null;
+    Status: number;
+    Patient: PatientRecord | null;
+    EncounterClass: string | null;
+    EHR: string | null;
+    EHRType: string | null;
+    EHRVisitName: string | null;
+    EHRAppointmentID: string | null;
+    EHRProviderID: string | null;
+    EHRProviderName: string | null;
+    EHRDate: string | null;
+    EHRStatus: string | null;
+    EHRStage: string | null;
 }
-type UpdateImageRequest = APIRequest<UpdateImageData>;
-type EmptyRequest = APIRequest<Record<string, never>>;
-interface DrivingLicenseData {
-    Image: string;
+interface PatientDashboard {
+    Record: PatientRecord | null;
+    Encounters: Encounter[];
+    EHR: string | null;
+    PendingActions: string[];
+}
+type CaptureType = "healthinsurance" | "identification" | "userphoto";
+interface InsuranceCaptureData {
+    FirstName: string | null;
+    LastName: string | null;
+    MemberId: string | null;
+    GroupNumber: string | null;
+    EffectiveDate: string | null;
+    RxBIN: string | null;
+    RxPCN: string | null;
+    RxGRP: string | null;
+    Carrier: string | null;
+}
+interface IdentificationCaptureData {
+    FirstName: string | null;
+    LastName: string | null;
+    StreetAddress: string | null;
+    City: string | null;
+    ZipCode: string | null;
+    State: string | null;
+    IssuedDate: string | null;
+    ExpiresDate: string | null;
+    Dob: string | null;
+    IDNumber: string | null;
+}
+interface UserPhotoCaptureData {
+    ImageKey: string | null;
+}
+interface CaptureResult<T> {
+    CapturedData: T | null;
+    IsCaptured: boolean;
+    InsurancePackages: object[] | null;
+}
+interface InsuranceRecord {
+    LastUpdatedBy: string | null;
+    IrcName: string | null;
+    LastUpdated: string | null;
+    RelationshipToInsured: string | null;
+    InsurancePolicyHolder: string | null;
+    EligibilityStatus: string | null;
+    InsurancePolicyHolderCountryIso3166: string | null;
+    ConfidentialityCode: string | null;
+    Created: string | null;
+    InsuranceId: string | null;
+    InsurancePolicyHolderSex: string | null;
+    InsurancePlanName: string | null;
+    InsuranceType: string | null;
+    InsurancePolicyHolderCountryCode: string | null;
+    InsurancePackageId: number | null;
+    InsuredEntityTypeId: number | null;
+    InsurancePolicyHolderFirstName: string | null;
+    SequenceNumber: number | null;
+    IrcId: number | null;
+    CreatedBy: string | null;
+    RelationshipToInsuredId: number | null;
+    InsurancePolicyHolderLastName: string | null;
+    /**
+     * Internal-only fields returned in backend models.
+     */
+    MemberId?: string | null;
+    Image?: string | null;
 }
-type DrivingLicenseRequest = APIRequest<DrivingLicenseData>;
-type DrivingLicenseResponse = APIResponse<string>;
-type HCUserImage = UserImage;
 
 declare class HCSettingsClient {
-    private http;
-    private auth;
+    private readonly httpClient;
+    private readonly loginClient;
     private apiKeyHeaderName?;
     private apiKeyValue?;
-    constructor(httpClient: HttpClient, authClient: HCLoginClient);
+    constructor(httpClient: HttpClient, loginClient: HCLoginClient);
     setApiKey(headerName: string, value: string): void;
-    getDashboard(): Promise<any>;
-    getUserImageCannedUrl(extension: string): Promise<UserImage>;
-    getDrivingLicenseCannedUrl(extension: string): Promise<UserImage>;
-    getInsuranceCannedUrl(extension: string): Promise<UserImage>;
-    captureDrivingLicense(fileKey: string): Promise<any>;
-    captureInsurance(fileKey: string): Promise<any>;
-    submitInsurance(payload: CoverageRequest): Promise<any>;
-    getInsurances(): Promise<any>;
-    submitDrivingLicense(payload: DrivingLicenseData): Promise<DrivingLicenseResponse>;
-    updateUserImage(fileName: string): Promise<any>;
-    deactivateUser(): Promise<any>;
+    getDashboard(): Promise<APIResponse<PatientDashboard>>;
+    getUserImageCannedUrl(extension: string): Promise<APIResponse<UserImage>>;
+    updateUserImage(fileName: string): Promise<APIResponse<boolean>>;
+    getDrivingLicenseCannedUrl(extension: string): Promise<APIResponse<UserImage>>;
+    captureDrivingLicense(fileKey: string): Promise<APIResponse<CaptureResult<IdentificationCaptureData>>>;
+    submitDrivingLicense(image: string): Promise<APIResponse<string>>;
+    getInsuranceCannedUrl(extension: string): Promise<APIResponse<UserImage>>;
+    captureInsurance(fileKey: string): Promise<APIResponse<CaptureResult<InsuranceCaptureData>>>;
+    submitInsurance(coverage: CoverageData): Promise<APIResponse<InsuranceRecord>>;
+    getInsurances(): Promise<APIResponse<InsuranceRecord[]>>;
+    captureUserPhoto(fileKey: string): Promise<APIResponse<CaptureResult<UserPhotoCaptureData>>>;
+    deactivateUser(): Promise<APIResponse<boolean>>;
     private getBaseUrl;
     private getAuthHeaders;
     private getJsonHeaders;
     private getApiKeyHeader;
+    private requireValue;
 }
 
 declare class ConfigError extends Error {
@@ -84,4 +157,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, HttpError, type UpdateImageData, type UpdateImageRequest, type UploadImageData, type UploadImageRequest, type UserImage };
+export { type APIRequest, type APIResponse, AuthError, type CaptureResult, type CaptureType, ConfigError, type CoverageData, type Encounter, HCSettingsClient, HttpError, type IdentificationCaptureData, type InsuranceCaptureData, type InsuranceRecord, type PatientDashboard, type PatientRecord, type UserImage, type UserPhotoCaptureData, UserStatus };

package/dist/index.js

@@ -21,144 +21,218 @@ var HttpError = class extends Error {
 
 // src/client.ts
 var HCSettingsClient = class {
-  constructor(httpClient, authClient) {
-    this.http = httpClient;
-    this.auth = authClient;
+  constructor(httpClient, loginClient) {
+    this.httpClient = httpClient;
+    this.loginClient = loginClient;
   }
   setApiKey(headerName, value) {
     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.");
+      throw new ConfigError(
+        "API key header name is required."
+      );
     }
     if (!trimmedValue) {
-      throw new ConfigError("API key value is required.");
+      throw new ConfigError(
+        "API key value is required."
+      );
     }
     this.apiKeyHeaderName = trimmedHeaderName;
     this.apiKeyValue = trimmedValue;
   }
+  // ===========================================================================
+  // Dashboard
+  // ===========================================================================
   async getDashboard() {
-    return this.http.get(
+    return this.httpClient.get(
       `${this.getBaseUrl()}/patient/dashboard`,
       this.getAuthHeaders()
     );
   }
+  // ===========================================================================
+  // User image
+  // ===========================================================================
   async getUserImageCannedUrl(extension) {
-    const payload = {
+    const resolvedExtension = this.requireValue(
+      extension,
+      "extension"
+    );
+    const requestPayload = {
       Data: {
-        Extension: extension
+        Extension: resolvedExtension
       }
     };
-    return this.http.put(
+    return this.httpClient.put(
       `${this.getBaseUrl()}/patient/image/cannedurl`,
-      payload,
+      requestPayload,
       this.getJsonHeaders()
     );
   }
-  async getDrivingLicenseCannedUrl(extension) {
-    const payload = {
+  async updateUserImage(fileName) {
+    const resolvedFileName = this.requireValue(
+      fileName,
+      "fileName"
+    );
+    const requestPayload = {
       Data: {
-        Extension: extension
+        FileName: resolvedFileName
       }
     };
-    return this.http.put(
-      `${this.getBaseUrl()}/patient/id/cannedurl`,
-      payload,
+    return this.httpClient.put(
+      `${this.getBaseUrl()}/patient/image/url`,
+      requestPayload,
       this.getJsonHeaders()
     );
   }
-  async getInsuranceCannedUrl(extension) {
-    const payload = {
+  // ===========================================================================
+  // Identification
+  // ===========================================================================
+  async getDrivingLicenseCannedUrl(extension) {
+    const resolvedExtension = this.requireValue(
+      extension,
+      "extension"
+    );
+    const requestPayload = {
       Data: {
-        Extension: extension
+        Extension: resolvedExtension
       }
     };
-    return this.http.put(
-      `${this.getBaseUrl()}/patient/insurance/cannedurl`,
-      payload,
+    return this.httpClient.put(
+      `${this.getBaseUrl()}/patient/id/cannedurl`,
+      requestPayload,
       this.getJsonHeaders()
     );
   }
   async captureDrivingLicense(fileKey) {
-    const payload = {
+    const resolvedFileKey = this.requireValue(
+      fileKey,
+      "fileKey"
+    );
+    const requestPayload = {
       Data: {
         Type: "identification",
-        FileID: fileKey
+        FileID: resolvedFileKey
       }
     };
-    return this.http.post(
+    return this.httpClient.post(
       `${this.getBaseUrl()}/patient/capture`,
-      payload,
+      requestPayload,
+      this.getJsonHeaders()
+    );
+  }
+  async submitDrivingLicense(image) {
+    const resolvedImage = this.requireValue(
+      image,
+      "image"
+    );
+    const requestPayload = {
+      Data: {
+        Image: resolvedImage
+      }
+    };
+    return this.httpClient.put(
+      `${this.getBaseUrl()}/ehr/patient/drivinglicense`,
+      requestPayload,
+      this.getJsonHeaders()
+    );
+  }
+  // ===========================================================================
+  // Insurance
+  // ===========================================================================
+  async getInsuranceCannedUrl(extension) {
+    const resolvedExtension = this.requireValue(
+      extension,
+      "extension"
+    );
+    const requestPayload = {
+      Data: {
+        Extension: resolvedExtension
+      }
+    };
+    return this.httpClient.put(
+      `${this.getBaseUrl()}/patient/insurance/cannedurl`,
+      requestPayload,
       this.getJsonHeaders()
     );
   }
   async captureInsurance(fileKey) {
-    const payload = {
+    const resolvedFileKey = this.requireValue(
+      fileKey,
+      "fileKey"
+    );
+    const requestPayload = {
       Data: {
         Type: "healthinsurance",
-        FileID: fileKey
+        FileID: resolvedFileKey
       }
     };
-    return this.http.post(
+    return this.httpClient.post(
       `${this.getBaseUrl()}/patient/capture`,
-      payload,
+      requestPayload,
       this.getJsonHeaders()
     );
   }
-  async submitInsurance(payload) {
+  async submitInsurance(coverage) {
+    if (!coverage) {
+      throw new ConfigError(
+        "Insurance coverage data is required."
+      );
+    }
     const requestPayload = {
-      Data: payload
+      Data: coverage
     };
-    return this.http.put(
+    return this.httpClient.put(
       `${this.getBaseUrl()}/patient/coverage`,
       requestPayload,
       this.getJsonHeaders()
     );
   }
   async getInsurances() {
-    return this.http.get(
+    return this.httpClient.get(
       `${this.getBaseUrl()}/ehr/patient/insurances`,
       this.getAuthHeaders()
     );
   }
-  async submitDrivingLicense(payload) {
-    const requestPayload = {
-      Data: payload
-    };
-    return this.http.put(
-      `${this.getBaseUrl()}/ehr/patient/drivinglicense`,
-      requestPayload,
-      this.getJsonHeaders()
+  // ===========================================================================
+  // User photo capture
+  // ===========================================================================
+  async captureUserPhoto(fileKey) {
+    const resolvedFileKey = this.requireValue(
+      fileKey,
+      "fileKey"
     );
-  }
-  async updateUserImage(fileName) {
-    const payload = {
+    const requestPayload = {
       Data: {
-        FileName: fileName
+        Type: "userphoto",
+        FileID: resolvedFileKey
       }
     };
-    return this.http.put(
-      `${this.getBaseUrl()}/patient/image/url`,
-      payload,
+    return this.httpClient.post(
+      `${this.getBaseUrl()}/patient/capture`,
+      requestPayload,
       this.getJsonHeaders()
     );
   }
+  // ===========================================================================
+  // Account
+  // ===========================================================================
   async deactivateUser() {
-    const payload = {
-      Data: {}
-    };
-    return this.http.put(
+    return this.httpClient.put(
       `${this.getBaseUrl()}/patient/deactivate`,
-      payload,
+      void 0,
       this.getJsonHeaders()
     );
   }
+  // ===========================================================================
+  // Helpers
+  // ===========================================================================
   getBaseUrl() {
-    return this.auth.getBaseUrl();
+    return this.loginClient.getBaseUrl();
   }
   getAuthHeaders() {
     return {
-      ...this.auth.getAuthHeader(),
+      ...this.loginClient.getAuthHeader(),
       ...this.getApiKeyHeader()
     };
   }
@@ -176,10 +250,28 @@ var HCSettingsClient = class {
       [this.apiKeyHeaderName]: this.apiKeyValue
     };
   }
+  requireValue(value, parameterName) {
+    const trimmedValue = value == null ? void 0 : value.trim();
+    if (!trimmedValue) {
+      throw new ConfigError(
+        `${parameterName} is required.`
+      );
+    }
+    return trimmedValue;
+  }
 };
+
+// src/types.ts
+var UserStatus = /* @__PURE__ */ ((UserStatus2) => {
+  UserStatus2[UserStatus2["INACTIVE"] = 0] = "INACTIVE";
+  UserStatus2[UserStatus2["ACTIVE"] = 1] = "ACTIVE";
+  UserStatus2[UserStatus2["SUSPENDED"] = -1] = "SUSPENDED";
+  return UserStatus2;
+})(UserStatus || {});
 export {
   AuthError,
   ConfigError,
   HCSettingsClient,
-  HttpError
+  HttpError,
+  UserStatus
 };

package/package.json

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