@rinse-dental/open-dental 0.0.6 → 0.1.0

package/src/utils/httpClient.ts

@@ -16,16 +16,11 @@ class HttpClient {
   /**
    * GET request
    * @param {string} url - The endpoint URL
-   * @param {object} params - Optional query parameters
+   * @param {object} [params] - Optional query parameters
    * @returns {Promise<T>} - The API response
    */
   public async get<T>(url: string, params?: object): Promise<T> {
-    try {
-      const response: AxiosResponse<T> = await this.client.get<T>(url, { params });
-      return response.data;
-    } catch (error) {
-      this.handleError(error);
-    }
+    return this.handleRequest<T>(() => this.client.get<T>(url, { params }));
   }
 
   /**
@@ -35,12 +30,7 @@ class HttpClient {
    * @returns {Promise<T>} - The API response
    */
   public async post<T>(url: string, data: object): Promise<T> {
-    try {
-      const response: AxiosResponse<T> = await this.client.post<T>(url, data);
-      return response.data;
-    } catch (error) {
-      this.handleError(error);
-    }
+    return this.handleRequest<T>(() => this.client.post<T>(url, data));
   }
 
   /**
@@ -50,12 +40,7 @@ class HttpClient {
    * @returns {Promise<T>} - The API response
    */
   public async put<T>(url: string, data: object): Promise<T> {
-    try {
-      const response: AxiosResponse<T> = await this.client.put<T>(url, data);
-      return response.data;
-    } catch (error) {
-      this.handleError(error);
-    }
+    return this.handleRequest<T>(() => this.client.put<T>(url, data));
   }
 
   /**
@@ -64,8 +49,18 @@ class HttpClient {
    * @returns {Promise<T>} - The API response
    */
   public async delete<T>(url: string): Promise<T> {
+    return this.handleRequest<T>(() => this.client.delete<T>(url));
+  }
+
+  /**
+   * Handles requests and errors consistently across methods.
+   * @param {Function} requestFn - The Axios request function to execute.
+   * @returns {Promise<T>} - The API response or an error message.
+   * @throws {Error} - Throws an error with a formatted message.
+   */
+  private async handleRequest<T>(requestFn: () => Promise<AxiosResponse<T>>): Promise<T> {
     try {
-      const response: AxiosResponse<T> = await this.client.delete<T>(url);
+      const response = await requestFn();
       return response.data;
     } catch (error) {
       this.handleError(error);
@@ -73,37 +68,38 @@ class HttpClient {
   }
 
   /**
-   * Error handler to provide detailed error information
-   * @param {AxiosError} error - The error object from Axios
+   * Error handler to provide detailed error information.
+   * @param {unknown} error - The error object from Axios or another source.
+   * @throws {Error} - A formatted error with API details or a general message.
    */
   private handleError(error: unknown): never {
     if (axios.isAxiosError(error)) {
-      // Handle Axios-specific error
       if (error.response) {
-        // The request was made, and the server responded with a status code
+        // The server responded with a status code outside 2xx
+        const { status, data } = error.response;
         console.error("API Response Error:", {
-          status: error.response.status,
-          data: error.response.data,
+          status,
+          data,
           headers: error.response.headers,
         });
         throw new Error(
-          `Request failed with status ${error.response.status}: ${JSON.stringify(error.response.data)}`
+          `API Error (Status ${status}): ${data?.message || JSON.stringify(data)}`
         );
       } else if (error.request) {
-        // The request was made, but no response was received
+        // The request was made, but no response received
         console.error("No Response Error:", error.request);
         throw new Error("No response received from the server.");
       } else {
-        // Something happened in setting up the request
+        // Something went wrong in setting up the request
         console.error("Request Setup Error:", error.message);
         throw new Error(`Request setup failed: ${error.message}`);
       }
     } else {
-      // Handle non-Axios errors
+      // Handle non-Axios-specific errors
       console.error("Unexpected Error:", error);
       throw new Error("An unexpected error occurred.");
     }
   }
-}  
+}
 
 export default HttpClient;

package/tsconfig.json

@@ -6,7 +6,8 @@
         "rootDir": "./src",
         "strict": true,
         "esModuleInterop": true,
-        "skipLibCheck": true
+        "skipLibCheck": true, 
+        "declaration": true
     },
     "include": ["src/**/*"],
     "exclude": ["node_modules", "dist"]

package/src/utils/types.ts

@@ -1,134 +0,0 @@
-/**
- * Represents a patient in the Open Dental system.
- * @see https://www.opendental.com/site/apipatients.html
- */
-export interface Patient {
-    PatNum: number; // Unique patient identifier
-    LName: string; // Last name
-    FName: string; // First name
-    MiddleI?: string; // Middle initial
-    Preferred?: string; // Preferred name
-    PatStatus: 'Patient' | 'NonPatient' | 'Inactive' | 'Archived' | 'Deceased' | 'Prospective'; // Patient status
-    Gender: 'Male' | 'Female' | 'Unknown' | 'Other'; // Gender
-    Position: 'Single' | 'Married' | 'Child' | 'Widowed' | 'Divorced'; // Marital status
-    Birthdate: string; // Date of birth in 'yyyy-MM-dd' format
-    SSN?: string; // Social Security Number
-    Address?: string; // Primary address
-    Address2?: string; // Secondary address
-    City?: string; // City
-    State?: string; // State
-    Zip?: string; // ZIP code
-    HmPhone?: string; // Home phone number
-    WkPhone?: string; // Work phone number
-    WirelessPhone?: string; // Mobile phone number
-    Guarantor: number; // Guarantor's PatNum
-    Email?: string; // Email address
-    EstBalance: number; // Estimated balance
-    PriProv: number; // Primary provider number
-    priProvAbbr?: string; // Primary provider abbreviation
-    SecProv?: number; // Secondary provider number
-    secProvAbbr?: string; // Secondary provider abbreviation
-    BillingType?: string; // Billing type description
-    ImageFolder?: string; // Image folder name
-    FamFinUrgNote?: string; // Family financial urgent note
-    ChartNumber?: string; // Chart number
-    MedicaidID?: string; // Medicaid ID
-    BalTotal: number; // Total balance
-    DateFirstVisit?: string; // Date of first visit in 'yyyy-MM-dd' format
-    ClinicNum?: number; // Clinic number
-    clinicAbbr?: string; // Clinic abbreviation
-    Ward?: string; // Ward
-    PreferConfirmMethod?: 'None' | 'Email' | 'TextMessage' | 'PhoneCall'; // Preferred confirmation method
-    PreferContactMethod?: 'None' | 'Email' | 'TextMessage' | 'PhoneCall' | 'Mail'; // Preferred contact method
-    PreferRecallMethod?: 'None' | 'Email' | 'TextMessage' | 'PhoneCall' | 'Mail'; // Preferred recall method
-    Language?: string; // Language code (ISO 639-2 format)
-    AdmitDate?: string; // Admission date in 'yyyy-MM-dd' format
-    siteDesc?: string; // Site description
-    DateTStamp: string; // Timestamp of the last update in 'yyyy-MM-dd HH:mm:ss' format
-    SuperFamily?: number; // Super family number
-    TxtMsgOk?: 'Unknown' | 'Yes' | 'No'; // Text message consent
-    SecDateEntry?: string; // Secondary date entry in 'yyyy-MM-dd' format
-  }
-  
-  /**
-   * Represents an appointment in the Open Dental system.
-   * @see https://www.opendental.com/site/apiappointments.html
-   */
-  export interface Appointment {
-    AptNum: number; // Unique appointment identifier
-    PatNum: number; // Patient's PatNum
-    AptStatus: 'Scheduled' | 'Complete' | 'UnschedList' | 'ASAP' | 'Broken' | 'Planned' | 'PtNote' | 'PtNoteCompleted'; // Appointment status
-    Pattern: string; // Time pattern
-    Confirmed: number; // Confirmation status code
-    confirmed?: string; // Confirmation status description
-    TimeLocked: boolean; // Indicates if the time is locked
-    Op: number; // Operatory number
-    Note?: string; // Appointment note
-    ProvNum: number; // Provider number
-    provAbbr?: string; // Provider abbreviation
-    ProvHyg?: number; // Hygienist provider number
-    AptDateTime: string; // Appointment date and time in 'yyyy-MM-dd HH:mm:ss' format
-    NextAptNum?: number; // Next appointment number
-    UnschedStatus?: number; // Unscheduled status code
-    unschedStatus?: string; // Unscheduled status description
-    IsNewPatient: boolean; // Indicates if the patient is new
-    ProcDescript?: string; // Procedure description
-    ClinicNum?: number; // Clinic number
-    IsHygiene: boolean; // Indicates if it's a hygiene appointment
-    DateTStamp: string; // Timestamp of the last update in 'yyyy-MM-dd HH:mm:ss' format
-    DateTimeArrived?: string; // Arrival time in 'yyyy-MM-dd HH:mm:ss' format
-    DateTimeSeated?: string; // Seated time in 'yyyy-MM-dd HH:mm:ss' format
-    DateTimeDismissed?: string; // Dismissed time in 'yyyy-MM-dd HH:mm:ss' format
-    InsPlan1?: number; // Primary insurance plan number
-    InsPlan2?: number; // Secondary insurance plan number
-    DateTimeAskedToArrive?: string; // Requested arrival time in 'yyyy-MM-dd HH:mm:ss' format
-    colorOverride?: string; // Color override in 'R,G,B' format
-    AppointmentTypeNum?: number; // Appointment type number
-    SecDateTEntry?: string; // Secondary date entry in 'yyyy-MM-dd' format
-    Priority?: 'Normal' | 'ASAP'; // Appointment priority
-    PatternSecondary?: string; // Secondary time pattern
-    ItemOrderPlanned?: number; // Planned item order
-  }
-  
-  /**
- * Represents a procedure log entry in the Open Dental system.
- * @see https://www.opendental.com/site/apiprocedurelogs.html
- */
-export interface ProcedureLog {
-    ProcNum: number; // Unique procedure identifier
-    PatNum: number; // Patient's PatNum
-    AptNum?: number; // Associated appointment number
-    ProcDate: string; // Procedure date in 'yyyy-MM-dd' format
-    ProcFee: number; // Procedure fee
-    Surf?: string; // Tooth surface
-    ToothNum?: string; // Tooth number
-    ToothRange?: string; // Tooth range
-    Priority?: number; // Priority code
-    priority?: string; // Priority description
-    ProcStatus: 'TP' | 'C' | 'EO' | 'R' | 'D' | 'E'; // Procedure status: Treatment Planned (TP), Complete (C), Existing Other Provider (EO), Referred (R), Deleted (D), or Existing Current Provider (E)
-    ProvNum: number; // Provider number
-    provAbbr?: string; // Provider abbreviation
-    Dx?: string; // Diagnosis code
-    dxName?: string; // Diagnosis name
-    PlannedAptNum?: number; // Planned appointment number
-    DateEntryC?: string; // Date the procedure was created in 'yyyy-MM-dd HH:mm:ss' format
-    ClinicNum?: number; // Clinic number
-    MedicalCode?: string; // Medical procedure code
-    DiagnosticCode?: string; // Diagnostic code
-    CodeNum: number; // Procedure code number
-    codeText?: string; // Procedure code description
-    ProcNote?: string; // Procedure note
-    ToothColor?: string; // Tooth color (if applicable)
-    LabFee?: number; // Lab fee
-    IsProsth?: boolean; // Indicates if it's a prosthodontic procedure
-    ProcTime?: string; // Time taken for the procedure
-    PriorityNum?: number; // Priority number
-    Prosthesis?: 'None' | 'Crown' | 'Denture' | 'Bridge'; // Type of prosthesis
-    ProsthesisDate?: string; // Prosthesis delivery date in 'yyyy-MM-dd' format
-    UnitQty?: number; // Quantity of units
-    DateTStamp: string; // Timestamp of the last update in 'yyyy-MM-dd HH:mm:ss' format
-    SecDateTEntry?: string; // Secondary date entry in 'yyyy-MM-dd HH:mm:ss' format
-    MedicalOrderNum?: number; // Medical order number
-    PlaceService?: 'Office' | 'InpatientHospital' | 'OutpatientHospital'; // Place of service
-  }
-