@rinse-dental/open-dental 3.4.2 → 4.0.2

package/src/types/referralTypes.ts

@@ -1,102 +0,0 @@
-/**
- * Represents an Referral in the Open Dental system. These can be either a provider, patient, or non-person. The description of non-patient sources is stored in the LName field.
- * @see https://www.opendental.com/site/apireferrals.html
- */
-export interface Referral {
-    ReferralNum?: number; //PK
-    LName?: string; //
-    FName?: string; //
-    MName?: string; //
-    SSN?: string; //
-    UsingTIN?: "true" | "false"; //Either "true" or "false". 
-    Specialty?: number; //definition.DefNum where definition.Category=35 (ProviderSpecialty). If set, NotPerson will default to "false", IsDoctor will default to "true", and isPatient will be false.
-    specialty?: string; //Only set this if the Referral source is a Provider. This is a definition.ItemName where the DefCat is ProviderSpecialty(35). If this is set, IsDoctor will default to "true", NotPerson will default to "false", and isPatient will be false.
-    ST?: string; // 2 char max
-    Telephone?: string; // must be 10 digits
-    Address?: string; //
-    Address2?: string; //
-    City?: number; //
-    Zip?: string; //
-    Note?: string; //
-    Phone2?: string; //
-    IsHidden?: "true" | "false"; //Either "true" or "false". 
-    NotPerson?: string; //
-    Title?: string; //
-    EMail?: string; //
-    PatNum?: string; //
-    IsDoctor?: "true" | "false"; //Either "true" or "false". 
-    DateTStamp?: string; //String in "yyyy-MM-dd HH:mm:ss" format
-    IsPreferred?: "true" | "false"; //Either "true" or "false". 
-    BusinessName?: string; //
-    DisplayNote?: string; //
-    isPatient?: "true" | "false"; //Either "true" or "false". 
-  }
-
-  
-  export interface GetReferralsParams {
-    IsHidden?: "true" | "false"; //Optional. Filter hidden responses. Either "true" or "false"
-    NotPerson?: "true" | "false"; //Optional. Filter referrals that are marked NotPerson. Either "true" or "false".
-    IsDoctor?: "true" | "false"; //Optional. Filter referrals that are marked IsDoctor. Either "true" or "false".
-    IsPreferred?: "true" | "false"; //Optional. Filter referrals that are marked IsPreferred. Either "true" or "false".
-    isPatient?: "true" | "false"; //Optional. Filter referrals that are marked isPatient. Either "true" or "false".
-    BusinessName?: string; //Optional. Filter referrals by business name. Supports partial string matching.
-    Offset?: number; // Pagination offset for results.
-  }
-
-  /**
-   * Creates a new Referral. Referrals can be for patients (provide PatNum), providers (provide specialty) or non-persons (provide neither PatNum or specialty). 
-   * In the last case, isPatient and IsDoctor will be set false automatically while NotPerson will be set to true. 
-   * If you wish to create an associated RefAttach please see RefAttaches POST.
-   */
-  export interface CreateReferralParams {
-    LName?: string; //Required. The last name of a referral source or referral source description.
-    PatNum?: string; //Optional. Only set this if the referral source is a patient. The provided LName must match the patient for whom the PatNum is given. This automatically populates the rest of the referral based on the given patient. If this is set, IsDoctor and NotPerson are set to "false", while isPatient will be true.
-    FName?: string; //Optional. The referral source's first name.
-    MName?: string; //Optional. The referral source's middle name or initial.
-    SSN?: string; //Optional. SSN, or TIN if UsingTIN is true. No punctuation.
-    UsingTIN?: "true" | "false"; //Optional. Either "true" or "false". Dictates whether SSN contains an SSN or TIN. Default "false".
-    Specialty?: number; //Optional. definition.DefNum where definition.Category=35 (ProviderSpecialty). If set, NotPerson will default to "false", IsDoctor will default to "true", and isPatient will be false.
-    specialty?: string; //Optional. Only set this if the Referral source is a Provider. This is a definition.ItemName where the DefCat is ProviderSpecialty(35). If this is set, IsDoctor will default to "true", NotPerson will default to "false", and isPatient will be false.
-    ST?: string; //Optional. The referral source's state. Two characters maximum.
-    Telephone?: string; //Optional. The referral source's phone number. Must be ten digits.
-    Address?: string; //Optional. The referral source's mailing address.
-    Address2?: string; //Optional. Additional info regarding the referral source's mailing address.
-    City?: string; //Optional. The referral source's city.
-    Zip?: string; //Optional. The referral source's ZIP code.
-    Note?: string; //Optional.
-    Phone2?: string; //Optional. Additional phone.
-    NotPerson?: string; //Optional. Either "true" or "false". Default "false", unless neither PatNum nor Specialty were supplied.
-    Title?: string; //Optional. The referral source's title.
-    EMail?: string; //Optional. The email address for the referral.
-    IsDoctor?: "true" | "false"; //Optional. Either "true" or "false". Default "false", unless a Specialty was supplied.
-    BusinessName?: string; //Optional. Name of the business that the referral works for.
-    DisplayNote?: string; //Optional. Shows in the Family Module's Patient Info grid.
-  }
-  
-  /**
-   * Updates an existing Referral. All fields are optional. Referrals for a patient can only have the Note and DisplayNote fields modified.
-   */
-  export interface UpdateReferralParams {
-    ReferralNum?: number; //PK of the referral
-    LName?: string; //Required. The last name of a referral source or referral source description.
-    FName?: string; //Optional. The referral source's first name.
-    MName?: string; //Optional. The referral source's middle name or initial.
-    SSN?: string; //Optional. SSN, or TIN if UsingTIN is true. No punctuation.
-    UsingTIN?: "true" | "false"; //Optional. Either "true" or "false". Dictates whether SSN contains an SSN or TIN. Default "false".
-    Specialty?: number; //Optional. definition.DefNum where definition.Category=35 (ProviderSpecialty). If set, NotPerson will default to "false", IsDoctor will default to "true", and isPatient will be false.
-    ST?: string; //Optional. The referral source's state. Two characters maximum.
-    Telephone?: string; //Optional. The referral source's phone number. Must be ten digits.
-    Address?: string; //Optional. The referral source's mailing address.
-    Address2?: string; //Optional. Additional info regarding the referral source's mailing address.
-    City?: number; //Optional. The referral source's city.
-    Zip?: string; //Optional. The referral source's ZIP code.
-    Note?: string; //Optional.
-    Phone2?: string; //Optional. Additional phone.
-    NotPerson?: string; //Optional. Either "true" or "false". Default "false", unless neither PatNum nor Specialty were supplied.
-    Title?: string; //Optional. The referral source's title.
-    EMail?: string; //Optional. The email address for the referral.
-    IsDoctor?: "true" | "false"; //Optional. Either "true" or "false". Default "false", unless a Specialty was supplied.
-    BusinessName?: string; //Optional. Name of the business that the referral works for.
-    DisplayNote?: string; //Optional. Shows in the Family Module's Patient Info grid.
-  }
-  

package/src/types/scheduleTypes.ts

@@ -1,32 +0,0 @@
-/**
- * Parameters for fetching multiple patients.
- * @see https://www.opendental.com/site/apischedules.html
- */
-export interface Schedule {
-    ScheduleNum?: number; //Unique identifier for schedule row
-    SchedDate?: string; //"YYYY-MM-DD" 
-    StartTime?: string; //"HH:mm:ss"
-    StopTime?: string; //"HH:mm:ss"
-    SchedType?: "Practice" | "Provider" | "Blockout" | "Employee" | "WebSchedASAP"; //Either "Practice", "Provider", "Blockout", "Employee", or "WebSchedASAP".
-    ProvNum?: string; //FK to provider.ProvNum.
-    BlockoutType?: string; //Definition.DefNum where definition.Category=25.
-    blockoutType?: string; //Definition.ItemName where Definition.DefNum == BlockoutType
-    Note?: string; //
-    operatories?: string; //String array of operatory.OperatoryNum
-    EmployeeNum?: string; //FK to employee.EmployeeNum.
-  }
-
-/**
- * Parameters for fetching schedule records; 
- * @see https://www.opendental.com/site/apischedules.html
- */
-export interface GetSchedulesParams {
-    date?: string; //"YYYY-MM-DD", For a single day. Today's date by default.
-    dateStart?: string; //"YYYY-MM-DD" For a date range, inclusive of both dates.
-    dateEnd?: string; //"YYYY-MM-DD" For a date range, inclusive of both dates.
-    SchedType?: "Practice" | "Provider" | "Blockout" | "Employee" | "WebSchedASAP"; //Either "Practice", "Provider", "Blockout", "Employee", or "WebSchedASAP".
-    BlockoutDefNum?: string; //Definition.DefNum where definition.Category=25.
-    ProvNum?: number; //FK to provider.ProvNum.
-    EmployeeNum?: number; //FK to employee.EmployeeNum.
-    Offset?: number; //pagination
-  }

package/src/types/securityLogTypes.ts

@@ -1,24 +0,0 @@
-/**
- * Represents a securityLogs in Open Dental
- * @see https://www.opendental.com/site/apisecuritylogs.html
- */
-export interface SecurityLog {
-  SecurityLogNum: number; // Primary key.
-  PermType: string; // Audit trail permission name (e.g., "PatientCreate", "PatientEdit").
-  UserNum: number; // FK to userod.UserNum (often 0 for API actions).
-  LogDateTime: string; // Date/time string of the log entry (server local).
-  LogText: string; // Description (e.g., "Created by API ...").
-  PatNum?: number; // Optional. FK to patient.PatNum when applicable.
-  CompName?: string; // Optional. Workstation/computer name (e.g., "JUSTINE").
-  LogSource?: string; // Optional. Source of the entry (e.g., "API").
-}
-
-/**
- * Parameters for GET /securitylogs
- * Filters logs for the requesting API developer.
- * @see https://www.opendental.com/site/apisecuritylogs.html
- */
-export interface GetSecurityLogsParams {
-  PermType?: string; // Optional. Filter by permission type (see Audit Trail Permissions doc).
-  Offset?: number; // Optional. For pagination.
-}

package/src/types/treatPlanAttachTypes.ts

@@ -1,39 +0,0 @@
-/**
-* TreatPlanAttaches object.
-* @see https://www.opendental.com/site/apitreatplanattaches.html
-*/
-export interface TreatPlanAttach {
-    TreatPlanAttachNum?: number; // Primary key
-    TreatPlanNum?: number; // FK to treatplan.TreatPlanNum
-    ProcNum?: number; // FK to procedurelog.ProcNum
-    Priority?: number; // definition.DefNum where definition.Category=20. Default 0
-    priority?: string;
-}
-
-/**
- * Get TreatPlanAttaches Params. Returns TreatPlanAttaches object
- * @see https://www.opendental.com/site/apitreatplanattaches.html
- */
-export interface GetTreatPlanAttachesParams {
-    TreatPlanNum?: number; // FK to treatplan.TreatPlanNum
-    Offset?: number; //pagination
-}
-
-/**
- * POST TreatPlanAttaches Params. Returns TreatPlanAttaches object
- * @see https://www.opendental.com/site/apitreatplanattaches.html
- */
-export interface CreateTreatPlanAttachesParams {
-    TreatPlanNum: number; // Required. FK to treatplan.TreatPlanNum
-    ProcNum: number; // Required. FK to procedurelog.ProcNum
-    Priority?: number; // Optional. definition.DefNum where definition.Category=20. Default 0
-}
-
-/**
-* PUT TreatPlanAttaches Params. Returns TreatPlanAttaches object.
-* @see https://www.opendental.com/site/apitreatplanattaches.html
-*/
-export interface UpdateTreatPlanAttachesParams {
-    TreatPlanAttachNum: number; // Required. Primary key
-    Priority: number; // Required. definition.DefNum where definition.Category=20. Default 0
-}

package/src/types/treatPlanTypes.ts

@@ -1,75 +0,0 @@
-/**
-* GET TreatPlans object.
-* @see https://www.opendental.com/site/apitreatplans.html
-*/
-export interface TreatmentPlan {
-    TreatPlanNum?: number; // Primary key
-    PatNum?: number; // FK to Patient table
-    DateTP?: string; // 
-    Heading?: string; // Optional. Default "Inactive Treatment Plan".
-    Note?: string; // A note specific to this treatment plan that shows at the bottom. Overwrites existing note.
-    SigIsTopaz?: "true" | "false"; //
-    ResponsParty?: number; // FK to patient.PatNum. The patient responsible for approving the treatment.
-    DocNum?: number; //
-    TPStatus?: string; // "Saved", "Active" or "Inactive"
-    SecUserNumEntry?: number; //
-    SecDateEntry?: string; //
-    SecDateTEdit?: string; //
-    UserNumPresenter?: number; //
-    TPType?: "Insurance" | "Discount"; // Either "Insurance" or "Discount".
-    DateTSigned?: string; //
-    DateTPracticeSigned?: string; //
-    SignatureText?: string; // The typed name of the person who signed the patient signature.
-    SignaturePracticeText?: string; // The typed name of the person who signed the practice signature.
-    isSigned?: "true" | "false"; //
-    isSignedPractice?: "true" | "false"; //
-}
-
-/**
- * Get TreatPlans Params. Returns TreatPlan object
- * @see https://www.opendental.com/site/apitreatplans.html
- */
-export interface GetTreatmentPlanParams {
-    PatNum?: number; // FK to Patient table
-    SecDateTEdit?: string; // Only include TreatPlans with a SecDateTEdit altered after the specified date and time. String in "yyyy-MM-dd HH:mm:ss" format.
-    TPStatus?: "Saved" | "Active" | "Inactive"; // Either "Saved", "Active", or "Inactive". Default all.
-}
-
-/**
- * POST TreatPlans Params. Returns TreatPlan object
- * @see https://www.opendental.com/site/apitreatplans.html
- */
-export interface CreateTreatmentPlanParams {
-    PatNum: number; // Required. FK to Patient table
-    Heading?: string; // Optional. Defaults to the heading of the supplied Treatment Plan.
-    Note?: string; // A note specific to this treatment plan that shows at the bottom. Overwrites existing note.
-    TPType?: "Insurance" | "Discount"; // Optional. Either "Insurance" or "Discount". If the patient is subscribed to a Discount Plan, this will default to "Discount". Otherwise, defaults to "Insurance".
-}
-
-/**
- * POST Save TreatPlans Params. Returns TreatPlan object. 
- * Creates an unsigned Saved TreatPlan from an existing Active or Inactive TreatPlan.
- * @see https://www.opendental.com/site/apitreatplans.html
- */
-export interface SaveTreatmentPlanParams {
-    TreatPlanNum: number; // Required. PK of treatment plan to be saved
-    Heading?: string; // Optional. Defaults to the heading of the supplied Treatment Plan.
-    UserNumPresenter?: number; // Optional. FK to userod.UserNum. Default 0.
-}
-
-/**
-* PUT TreatPlans object.
-* @see https://www.opendental.com/site/apitreatplans.html
-*/
-export interface UpdateTreatmentPlanParams {
-    TreatPlanNum: number; // Required in the URL.
-    DateTP?: string; // The date of the treatment plan. Can only be set if TPStatus is "Saved". String in "yyyy-MM-dd" format.
-    Heading?: string; // The heading that shows at the top of the treatment plan.
-    Note?: string; // A note specific to this treatment plan that shows at the bottom. Overwrites existing note.
-    ResponsParty?: number; // FK to patient.PatNum. The patient responsible for approving the treatment.
-    TPType?: "Insurance" | "Discount"; // Either "Insurance" or "Discount".
-    SignatureText?: string; // The typed name of the person who signed the patient signature.
-    SignaturePracticeText?: string; // The typed name of the person who signed the practice signature.
-    isSigned?: "true" | "false"; // Either "true" or "false". True updates the treatplan Signature, digitally signs for the patient, and overwrites existing signature. False clears the exisiting treatplan Signature.
-    isSignedPractice?: "true" | "false"; // Either "true" or "false". True updates the treatplan SignaturePractice, digitally signs for the practice, and overwrites existing signature. False clears the exisiting treatplan SignaturePractice.
-}

package/src/utils/httpClient.ts

@@ -1,111 +0,0 @@
-import axios, { AxiosInstance, AxiosResponse, AxiosError } from "axios";
-
-class HttpClient {
-  private client: AxiosInstance;
-
-  constructor(baseURL: string, authToken: string) {
-    this.client = axios.create({
-      baseURL,
-      headers: {
-        Authorization: authToken,
-        "Content-Type": "application/json",
-      },
-    });
-  }
-
-  /**
-   * GET request
-   * @param {string} url - The endpoint URL
-   * @param {object} [params] - Optional query parameters
-   * @returns {Promise<T>} - The API response
-   */
-  public async get<T>(url: string, params?: object): Promise<T> {
-    return this.handleRequest<T>(() => this.client.get<T>(url, { params }));
-  }
-
-  /**
-   * POST request
-   * @param {string} url - The endpoint URL
-   * @param {object} data - The payload to send
-   * @returns {Promise<T>} - The API response
-   */
-  public async post<T>(url: string, data: object): Promise<T> {
-    return this.handleRequest<T>(() => this.client.post<T>(url, data));
-  }
-
-  /**
-   * PUT request
-   * @param {string} url - The endpoint URL
-   * @param {object} data - The payload to update
-   * @returns {Promise<T>} - The API response
-   */
-  public async put<T>(url: string, data: object): Promise<T> {
-    return this.handleRequest<T>(() => this.client.put<T>(url, data));
-  }
-
-  /**
-   * DELETE request
-   * @param {string} url - The endpoint URL
-   * @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 = await requestFn();
-      return response.data;
-    } catch (error) {
-      this.handleError(error);
-    }
-  }
-
-  /**
-   * 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)) {
-      if (error.response) {
-        // The server responded with a status code outside 2xx
-        const { status, data } = error.response;
-
-        // Only log if not 404
-        if (status !== 404) {
-          console.error("API Response Error:", {
-            status,
-            data,
-            headers: error.response.headers,
-          });
-        }
-
-        throw error.response; 
-        /*throw new Error(
-          `API Error (Status ${status}): ${data?.message || JSON.stringify(data)}`
-        );*/
-      } else if (error.request) {
-        // 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 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-specific errors
-      console.error("Unexpected Error:", error);
-      throw new Error("An unexpected error occurred.");
-    }
-  }
-}
-
-export default HttpClient;

package/tsconfig.json

@@ -1,16 +0,0 @@
-{
-    "compilerOptions": {
-        "target": "ES2022",
-        "module": "CommonJS",
-        "outDir": "./dist",
-        "rootDir": "./src",
-        "strict": true,
-        "esModuleInterop": true,
-        "skipLibCheck": true, 
-        "declaration": true,
-        "declarationMap": true,
-        "emitDeclarationOnly": false    
-    },
-    "include": ["src/**/*"],
-    "exclude": ["node_modules", "dist", "./release.sh", "./deploy_notes.txt"]
-}