@healthcloudai/hc-settings-connector 0.0.13 → 0.1.0

package/dist/index.d.ts

@@ -1,24 +1,21 @@
 import { HCLoginClient } from '@healthcloudai/hc-login-connector';
-import { HttpClient } from '@healthcloudai/hc-http';
+import { HttpClient, APIError } from '@healthcloudai/hc-http';
+export { APIError, ConfigError, HCServiceError, NetworkError, ValidationError, errorFromHttpStatus } 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 UserImage {
+    ImageURL: string | null;
+    FileName: string | null;
+    Extension: string | null;
 }
-interface CoverageRequest {
+interface CoverageData {
     InsurancePackageId: string;
     MemberId: string;
     FirstName: string;
@@ -26,62 +23,131 @@ 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>>;
+    protected execute<T>(operation: string, request: () => Promise<APIResponse<T>>): Promise<APIResponse<T>>;
+    protected mapBackendError(operation: string, response: APIResponse<unknown>): APIError;
+    private isApiResponse;
     private getBaseUrl;
     private getAuthHeaders;
     private getJsonHeaders;
     private getApiKeyHeader;
+    private requireValue;
 }
 
-declare class ConfigError extends Error {
-    constructor(message: string);
-}
-declare class AuthError extends Error {
-    constructor(message: string);
-}
-declare class HttpError extends Error {
-    status: number;
-    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, type CaptureResult, type CaptureType, type CoverageData, type Encounter, HCSettingsClient, type IdentificationCaptureData, type InsuranceCaptureData, type InsuranceRecord, type PatientDashboard, type PatientRecord, type UserImage, type UserPhotoCaptureData, UserStatus };

package/dist/index.js

@@ -1,164 +1,314 @@
-// src/errors.ts
-var ConfigError = class extends Error {
-  constructor(message) {
-    super(message);
-    this.name = "ConfigError";
-  }
-};
-var AuthError = class extends Error {
-  constructor(message) {
-    super(message);
-    this.name = "AuthError";
-  }
-};
-var HttpError = class extends Error {
-  constructor(status, message) {
-    super(message);
-    this.name = "HttpError";
-    this.status = status;
-  }
-};
-
 // src/client.ts
+import {
+  APIError,
+  ConfigError,
+  HCServiceError,
+  ValidationError
+} from "@healthcloudai/hc-http";
 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(
-      `${this.getBaseUrl()}/patient/dashboard`,
-      this.getAuthHeaders()
+    return this.execute(
+      "getDashboard",
+      () => this.httpClient.get(
+        `${this.getBaseUrl()}/api/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(
-      `${this.getBaseUrl()}/patient/image/cannedurl`,
-      payload,
-      this.getJsonHeaders()
+    return this.execute(
+      "getUserImageCannedUrl",
+      () => this.httpClient.put(
+        `${this.getBaseUrl()}/api/patient/image/cannedurl`,
+        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,
-      this.getJsonHeaders()
+    return this.execute(
+      "updateUserImage",
+      () => this.httpClient.put(
+        `${this.getBaseUrl()}/api/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,
-      this.getJsonHeaders()
+    return this.execute(
+      "getDrivingLicenseCannedUrl",
+      () => this.httpClient.put(
+        `${this.getBaseUrl()}/api/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(
-      `${this.getBaseUrl()}/patient/capture`,
-      payload,
-      this.getJsonHeaders()
+    return this.execute(
+      "captureDrivingLicense",
+      () => this.httpClient.post(
+        `${this.getBaseUrl()}/api/patient/capture`,
+        requestPayload,
+        this.getJsonHeaders()
+      )
     );
   }
-  async captureInsurance(fileKey) {
-    const payload = {
+  async submitDrivingLicense(image) {
+    const resolvedImage = this.requireValue(
+      image,
+      "image"
+    );
+    const requestPayload = {
       Data: {
-        Type: "healthinsurance",
-        FileID: fileKey
+        Image: resolvedImage
       }
     };
-    return this.http.post(
-      `${this.getBaseUrl()}/patient/capture`,
-      payload,
-      this.getJsonHeaders()
+    return this.execute(
+      "submitDrivingLicense",
+      () => this.httpClient.put(
+        `${this.getBaseUrl()}/api/ehr/patient/drivinglicense`,
+        requestPayload,
+        this.getJsonHeaders()
+      )
     );
   }
-  async submitInsurance(payload) {
+  // ===========================================================================
+  // Insurance
+  // ===========================================================================
+  async getInsuranceCannedUrl(extension) {
+    const resolvedExtension = this.requireValue(
+      extension,
+      "extension"
+    );
     const requestPayload = {
-      Data: payload
+      Data: {
+        Extension: resolvedExtension
+      }
     };
-    return this.http.put(
-      `${this.getBaseUrl()}/patient/coverage`,
-      requestPayload,
-      this.getJsonHeaders()
+    return this.execute(
+      "getInsuranceCannedUrl",
+      () => this.httpClient.put(
+        `${this.getBaseUrl()}/api/patient/insurance/cannedurl`,
+        requestPayload,
+        this.getJsonHeaders()
+      )
     );
   }
-  async getInsurances() {
-    return this.http.get(
-      `${this.getBaseUrl()}/ehr/patient/insurances`,
-      this.getAuthHeaders()
+  async captureInsurance(fileKey) {
+    const resolvedFileKey = this.requireValue(
+      fileKey,
+      "fileKey"
+    );
+    const requestPayload = {
+      Data: {
+        Type: "healthinsurance",
+        FileID: resolvedFileKey
+      }
+    };
+    return this.execute(
+      "captureInsurance",
+      () => this.httpClient.post(
+        `${this.getBaseUrl()}/api/patient/capture`,
+        requestPayload,
+        this.getJsonHeaders()
+      )
     );
   }
-  async submitDrivingLicense(payload) {
+  async submitInsurance(coverage) {
+    if (!coverage) {
+      throw new ValidationError({
+        message: "Insurance coverage data is required.",
+        code: "INVALID_INPUT"
+      });
+    }
     const requestPayload = {
-      Data: payload
+      Data: coverage
     };
-    return this.http.put(
-      `${this.getBaseUrl()}/ehr/patient/drivinglicense`,
-      requestPayload,
-      this.getJsonHeaders()
+    return this.execute(
+      "submitInsurance",
+      () => this.httpClient.put(
+        `${this.getBaseUrl()}/api/patient/coverage`,
+        requestPayload,
+        this.getJsonHeaders()
+      )
     );
   }
-  async updateUserImage(fileName) {
-    const payload = {
+  async getInsurances() {
+    return this.execute(
+      "getInsurances",
+      () => this.httpClient.get(
+        `${this.getBaseUrl()}/api/ehr/patient/insurances`,
+        this.getAuthHeaders()
+      )
+    );
+  }
+  // ===========================================================================
+  // User photo capture
+  // ===========================================================================
+  async captureUserPhoto(fileKey) {
+    const resolvedFileKey = this.requireValue(
+      fileKey,
+      "fileKey"
+    );
+    const requestPayload = {
       Data: {
-        FileName: fileName
+        Type: "userphoto",
+        FileID: resolvedFileKey
       }
     };
-    return this.http.put(
-      `${this.getBaseUrl()}/patient/image/url`,
-      payload,
-      this.getJsonHeaders()
+    return this.execute(
+      "captureUserPhoto",
+      () => this.httpClient.post(
+        `${this.getBaseUrl()}/api/patient/capture`,
+        requestPayload,
+        this.getJsonHeaders()
+      )
     );
   }
+  // ===========================================================================
+  // Account
+  // ===========================================================================
   async deactivateUser() {
-    const payload = {
-      Data: {}
-    };
-    return this.http.put(
-      `${this.getBaseUrl()}/patient/deactivate`,
-      payload,
-      this.getJsonHeaders()
+    return this.execute(
+      "deactivateUser",
+      () => this.httpClient.put(
+        `${this.getBaseUrl()}/api/patient/deactivate`,
+        void 0,
+        this.getJsonHeaders()
+      )
+    );
+  }
+  // ===========================================================================
+  // Helpers
+  // ===========================================================================
+  async execute(operation, request) {
+    let response;
+    try {
+      response = await request();
+    } catch (err) {
+      if (err instanceof APIError) {
+        throw err;
+      }
+      if (err instanceof Error) {
+        throw new APIError({
+          message: `${operation}: ${err.message}`,
+          code: "UNKNOWN_ERROR",
+          details: err
+        });
+      }
+      throw new APIError({
+        message: `${operation}: unexpected runtime failure`,
+        code: "UNKNOWN_ERROR",
+        details: err
+      });
+    }
+    if (response == null) {
+      throw new APIError({
+        message: `${operation}: empty response received`,
+        code: "EMPTY_RESPONSE",
+        details: response
+      });
+    }
+    if (!this.isApiResponse(response)) {
+      throw new APIError({
+        message: `${operation}: invalid API response structure`,
+        code: "INVALID_RESPONSE",
+        details: response
+      });
+    }
+    if (!response.IsOK) {
+      throw this.mapBackendError(operation, response);
+    }
+    return response;
+  }
+  mapBackendError(operation, response) {
+    return new HCServiceError(
+      operation,
+      response.ErrorMessage,
+      response
     );
   }
+  isApiResponse(value) {
+    if (!value || typeof value !== "object") {
+      return false;
+    }
+    const response = value;
+    return "IsOK" in response && typeof response.IsOK === "boolean" && "Data" in response && "ErrorMessage" in response;
+  }
   getBaseUrl() {
-    return this.auth.getBaseUrl();
+    return this.loginClient.getBaseUrl();
   }
   getAuthHeaders() {
     return {
-      ...this.auth.getAuthHeader(),
+      ...this.loginClient.getAuthHeader(),
       ...this.getApiKeyHeader()
     };
   }
@@ -176,10 +326,42 @@ var HCSettingsClient = class {
       [this.apiKeyHeaderName]: this.apiKeyValue
     };
   }
+  requireValue(value, parameterName) {
+    const trimmedValue = value == null ? void 0 : value.trim();
+    if (!trimmedValue) {
+      throw new ValidationError({
+        message: `${parameterName} is required.`,
+        code: "INVALID_INPUT"
+      });
+    }
+    return trimmedValue;
+  }
 };
+
+// src/errors.ts
+import {
+  APIError as APIError2,
+  ConfigError as ConfigError2,
+  HCServiceError as HCServiceError2,
+  NetworkError,
+  ValidationError as ValidationError2,
+  errorFromHttpStatus
+} from "@healthcloudai/hc-http";
+
+// 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,
+  APIError2 as APIError,
+  ConfigError2 as ConfigError,
+  HCServiceError2 as HCServiceError,
   HCSettingsClient,
-  HttpError
+  NetworkError,
+  UserStatus,
+  ValidationError2 as ValidationError,
+  errorFromHttpStatus
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@healthcloudai/hc-settings-connector",
-  "version": "0.0.13",
+  "version": "0.1.0",
   "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.1.0",
-    "@healthcloudai/hc-http": "^0.0.6"
+    "@healthcloudai/hc-login-connector": "^0.2.0",
+    "@healthcloudai/hc-http": "^0.1.0"
   },
   "peerDependencies": {
     "react-native": ">=0.70.0"