@rinse-dental/open-dental 3.4.2 → 4.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rinse-dental/open-dental",
-    "version": "3.4.2",
+    "version": "4.0.2",
     "description": "A TypeScript library for easily accessing Open Dental APIs.",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -15,15 +15,16 @@
         "url": "git+https://github.com/getrinsed/open-dental.git"
     },
     "dependencies": {
-        "axios": "^1.13.2",
-        "moment-timezone": "^0.6.0"
+        "axios": "^1.15.2",
+        "moment-timezone": "^0.6.1"
     },
     "devDependencies": {
         "@types/jest": "^30.0.0",
-        "@types/node": "^24.10.1",
-        "jest": "^30.2.0",
-        "prettier": "^3.6.2",
-        "typescript": "^5.9.3"
+        "@types/node": "^25.6.0",
+        "jest": "^30.3.0",
+        "prettier": "^3.8.3",
+        "ts-jest": "^29.4.9",
+        "typescript": "^6.0.3"
     },
     "scripts": {
         "build": "tsc",

package/release.sh

@@ -40,8 +40,6 @@ git push origin "$NEW_TAG"
 gh release create "$NEW_TAG" --title "Release $NEW_TAG" --notes "$COMMIT_MSG"
 
 
-#example ./release.sh "updated axios error return" patch 
-#example ./release.sh "Added PayPlans API" minor
-#example ./release.sh "Some commit message" major 
-
-#./release.sh "Added readme" patch
+#example ./release.sh "Some commit message" patch 
+#example ./release.sh "Some commit message" minor
+#example ./release.sh "Some commit message" major 

package/tsconfig.test.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "rootDir": ".",
+    "types": ["jest", "node"]
+  },
+  "include": ["src/**/*", "__tests__/**/*"]
+}

package/__tests__/example.test.ts

@@ -1,6 +0,0 @@
-describe('Example Test', () => {
-    it('should pass', () => {
-      expect(1 + 1).toBe(2);
-    });
-  });
-  

package/dist/types/appoinmentTypesType.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"appoinmentTypesType.d.ts","sourceRoot":"","sources":["../../src/types/appoinmentTypesType.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB"}

package/src/api/accountModules.ts

@@ -1,61 +0,0 @@
-import HttpClient from "../utils/httpClient";
-import {
-  ServiceDateView,
-  PatientBalance,
-  Aging,
-} from "../types/accountModuleTypes";
-
-export default class AccountModules {
-  private httpClient: HttpClient;
-
-  constructor(httpClient: HttpClient) {
-    this.httpClient = httpClient;
-  }
-
-  /**
-   * Fetch a patient's ServiceDateView by their ID.
-   * @param {number} PatNum - Required in the URL, patient.PatNum.
-   * @param {"true" | "false"} isFamily - Optional. Either "true" or "false". Return data for the entire patient's family. Default "false".
-   * @returns {Promise<ServiceDateView[]>} - The ServiceDateView return object.
-   * @throws {Error} - If `ServiceDateView` is not valid or the API returns an error.
-   */
-  public async getServiceDateView(PatNum: number, isFamily?: "true" | "false"): Promise<ServiceDateView[]> {
-    if (!PatNum || typeof PatNum !== "number") {
-      throw new Error("Invalid parameter: PatNum must be a valid number.");
-    }
-
-    const params = {
-      isFamily,
-    };
-
-    return await this.httpClient.get<ServiceDateView[]>(`/accountmodules/${PatNum}/ServiceDateView`, params);
-  }
-
-  /**
-   * Fetch a patient's balance and family balances by their ID.
-   * @param {number} PatNum - Required in the URL, patient.PatNum.
-   * @returns {Promise<PatientBalance[]>} - The PatientBalance return object.
-   * @throws {Error} - If `PatNum` is not valid or the API returns an error.
-   */
-  public async getPatientBalance(PatNum: number): Promise<PatientBalance[]> {
-    if (!PatNum || typeof PatNum !== "number") {
-      throw new Error("Invalid parameter: PatNum must be a valid number.");
-    }
-
-    return await this.httpClient.get<PatientBalance[]>(`/accountmodules/${PatNum}/PatientBalances`);
-  }
-
-  /**
-   * Fetch a patient's aging information by their ID.
-   * @param {number} PatNum - Required in the URL, patient.PatNum.
-   * @returns {Promise<Aging>} - The Aging return object.
-   * @throws {Error} - If `PatNum` is not valid or the API returns an error.
-   */
-  public async getAging(PatNum: number): Promise<Aging> {
-    if (!PatNum || typeof PatNum !== "number") {
-      throw new Error("Invalid parameter: PatNum must be a valid number.");
-    }
-
-    return await this.httpClient.get<Aging>(`/accountmodules/${PatNum}/Aging`);
-  }
-}

package/src/api/adjustments.ts

@@ -1,126 +0,0 @@
-import HttpClient from "../utils/httpClient";
-import {
-  Adjustment,
-  GetAdjustmentsParams,
-  CreateAdjustmentParams,
-  UpdateAdjustmentParams,
-} from "../types/adjustmentTypes";
-
-export default class Adjustments {
-  private httpClient: HttpClient;
-
-  constructor(httpClient: HttpClient) {
-    this.httpClient = httpClient;
-  }
-
-  /**
-    * Fetch multiple adjustments with filtering and pagination.
-    * @param {Object} params - The parameters for filtering and pagination.
-    * @param {number} params.PatNum - Required. FK to patient.PatNum. 
-    * @param {number} [params.AdjType] - Optional. definition.DefNum where definition.Category=1.
-    * @param {number} [params.ProcNum] - Optional. FK to procedure.ProcNum.
-    * @param {number} [params.Offset] - Pagination offset for results.
-    * @returns {Promise<Adjustment[]>} - A list of adjustments.
-    */
-  public async getAdjustments({
-    PatNum,
-    AdjType,
-    ProcNum,
-    Offset,
-
-  } : GetAdjustmentsParams): Promise<Adjustment> {
-    if (!PatNum || typeof PatNum !== "number") {
-      throw new Error("Invalid data: A Valid PatNum is required.");
-    }
-
-    return this.httpClient.get<Adjustment>("/adjustments", {
-      PatNum,
-      AdjType,
-      ProcNum,
-      Offset,
-    });
-  }
-
-  /**
-   * This adds an adjustments to a patient's account.
-   * @param {Object} data - The details of the adjustment to create.
-   * @param {number} data.PatNum - Required. FK to patient.PatNum
-   * @param {number} data.AdjType - Required. definition.DefNum where definition.Category=1, and definition.ItemValue="+" or "-".
-   * @param {number} data.AdjAmt - Required. Must be positive if AdjType has an ItemValue of "+", or negative if it has an ItemValue of "-".
-   * @param {string} data.AdjDate - Required. Cannot be a future date. String in "yyyy-MM-dd" format.
-   * @param {string} [data.ProvNum] - Optional. FK to provider.ProvNum
-   * @param {string} [data.ProcNum] - Optional. Only used if attaching this adjustment to a procedure. The procedure must be associated to the patient. Default 0.
-   * @param {string} [data.ClinicNum] - Optional. Default patient.ClinicNum.
-   * @param {string} [data.ProcDate] - Optional. String in "yyyy-MM-dd" format. If attaching to a procedure then this will default to the procedure's ProcDate. Otherwise, defaults to today's date.
-   * @param {string} [data.AdjNote] - Optional. Note for the adjustment.
-   * @returns {Promise<Adjustment>} - The created adjustment.
-   * @throws {Error} - If required fields are missing or the API returns an error.
-   */
-  public async createAdjustment({
-    PatNum,
-    AdjType,
-    AdjAmt,
-    AdjDate,
-    ProvNum,
-    ProcNum,
-    ClinicNum,
-    ProcDate,
-    AdjNote,
-  } : CreateAdjustmentParams): Promise<Adjustment> {
-    if (!PatNum || !AdjType || !AdjAmt || !AdjDate) {
-      throw new Error("Invalid data: PatNum, AdjType, AdjAmt, and AdjDate are required.");
-    }
-
-    return this.httpClient.post<Adjustment>("/adjustments", {
-      PatNum,
-      AdjType,
-      AdjAmt,
-      AdjDate,
-      ProvNum,
-      ProcNum,
-      ClinicNum,
-      ProcDate,
-      AdjNote,
-    });
-  }
-
-  /**
-   * Update an adjustment.
-   * @param {Object} data - The details of adjustment to update.
-   * @param {number} data.AdjNum - Required. Primary key.
-   * @param {string} data.AdjDate - Cannot be a future date. String in "yyyy-MM-dd" format.
-   * @param {number} data.AdjAmt - Must be positive if AdjType has an ItemValue of "+", or negative if it has an ItemValue of "-".
-   * @param {number} data.AdjType - definition.DefNum where definition.Category=1, and definition.ItemValue="+" or "-".
-   * @param {string} [data.ProvNum] - Optional. FK to provider.ProvNum
-   * @param {string} [data.AdjNote] - Optional. Note for the adjustment.
-   * @param {string} [data.ProcNum] - Optional. Only used if attaching this adjustment to a procedure. The procedure must be associated to the patient. Default 0.
-   * @param {string} [data.ClinicNum] - Optional. Default patient.ClinicNum.
-   * @returns {Promise<Adjustment>} - The updated adjustment.
-   * @throws {Error} - If required fields are missing or the API returns an error.
-   */
-  public async updateAdjustment({
-    AdjNum,
-    AdjDate,
-    AdjAmt,
-    AdjType,
-    ProvNum,
-    AdjNote,
-    ProcNum,
-    ClinicNum,
-  } : UpdateAdjustmentParams): Promise<Adjustment> {
-    if (!AdjNum || typeof AdjNum !== "number") {
-      throw new Error("Invalid data: A valid AdjNum is required.");
-    }
-
-    return this.httpClient.put<Adjustment>(`/adjustments/${AdjNum}`, {
-      AdjNum,
-      AdjDate,
-      AdjAmt,
-      AdjType,
-      ProvNum,
-      AdjNote,
-      ProcNum,
-      ClinicNum,
-    });
-  }
-}

package/src/api/allergies.ts

@@ -1,114 +0,0 @@
-import HttpClient from "../utils/httpClient";
-import {
-  Allergy,
-  GetAllergiesParams,
-  AddAllergyParams,
-  UpdateAllergyParams,
-} from "../types/allergyTypes";
-
-export default class Allergies {
-  private httpClient: HttpClient;
-
-  constructor(httpClient: HttpClient) {
-    this.httpClient = httpClient;
-  }
-
-  /**
-   * Fetch patient's allergies with optional pagination.
-   * @param {Object} params - The parameters for filtering and pagination.
-   * @param {number} params.PatNum - Required. Filter by patient.
-   * @param {number} [params.Offset] - pagination.
-   * @returns {Promise<Allergy>} - A list of a patient's allergies.
-   */
-  public async getAllergies({
-    PatNum,
-    Offset,
-  }: GetAllergiesParams): Promise<Allergy[]> {
-    if (!PatNum || typeof PatNum !== "number") {
-      throw new Error("PatNum is required to fetch allergies.");
-    }
-    
-    const params = {
-      PatNum,
-      Offset,
-    };
-
-    return this.httpClient.get<Allergy[]>("/allergies", params);
-  }
-
-  /**
-   * Add an allergy to a patient.
-   * @param {Object} data - The details of allergy to add.
-   * @param {number} data.PatNum - Required: FK to patient.
-   * @param {number} [data.AllergyDefNum] - Rarely used. Just use defDescription instead, which handles insertion of AllergyDef automatically.
-   * @param {string} [data.defDescription] - Required unless you choose to use AllergyDefNum.
-   * @param {string} [data.Reaction] - Optional. String describing the adverse reaction.
-   * @param {string} [data.DateAdverseReaction] - Optional. String in "yyyy-MM-dd" format. Default "0001-01-01".
-   * @param {'true' | 'false'} [data.StatusIsActive] - Optional. Either "true" or "false". Default "true".
-   * @returns {Promise<Allergy>} - The attached allergy.
-   * @throws {Error} - If required fields are missing or the API returns an error.
-   */
-  public async addAllergy({
-    PatNum,
-    AllergyDefNum,
-    defDescription,
-    Reaction,
-    DateAdverseReaction,
-    StatusIsActive,
-  } : AddAllergyParams): Promise<Allergy> {
-    if (!PatNum || (!AllergyDefNum && !defDescription)) {
-      throw new Error("Invalid data: PatNum and either AllergyDefNum or defDescription are required.");
-    }
-
-    return this.httpClient.post<Allergy>("/allergies", {
-      PatNum,
-      AllergyDefNum,
-      defDescription,
-      Reaction,
-      DateAdverseReaction,
-      StatusIsActive,
-    });
-  }
-
-  /**
-   * update an allergy attached to a patient.
-   * @param {Object} data - The details of allergy to update.
-   * @param {number} data.AllergyNum - Required: PK
-   * @param {string} [data.Reaction] - Optional. String describing the adverse reaction.
-   * @param {string} [data.DateAdverseReaction] - Optional. String in "yyyy-MM-dd" format.
-   * @param {'true' | 'false'} [data.StatusIsActive] - Optional. Either "true" or "false".
-   * @returns {Promise<Allergy>} - The updated allergy.
-   * @throws {Error} - If required fields are missing or the API returns an error.
-   */
-  public async updateAllergy({
-    AllergyNum,
-    Reaction,
-    DateAdverseReaction,
-    StatusIsActive,
-  }: UpdateAllergyParams): Promise<Allergy> {
-    if (!AllergyNum || typeof AllergyNum !== "number") {
-      throw new Error("Invalid data: AllergyNum is required.");
-    }
-
-    return this.httpClient.put<Allergy>(`/allergies/${AllergyNum}`, {
-      AllergyNum,
-      Reaction,
-      DateAdverseReaction,
-      StatusIsActive,
-    });
-  }
-
-  /**
-   * Deletes an allergy for a patient.
-   * @param {number} AllergyNum - Required: The unique identifier of the patient allergy to delete.
-   * @returns {Promise<void>} - Resolves when the Allergy is deleted.
-   * @throws {Error} - If `AllergyNum` is not valid or the API returns an error.
-   */
-  public async deleteAllergy(AllergyNum: number): Promise<void> {
-    if (!AllergyNum || typeof AllergyNum !== "number") {
-      throw new Error("Invalid parameter: AllergyNum must be a valid number.");
-    }
-
-    return this.httpClient.delete<void>(`/allergies/${AllergyNum}`);
-  }
-}

package/src/api/appointmentTypes.ts

@@ -1,21 +0,0 @@
-import HttpClient from "../utils/httpClient";
-import {
-  AppointmentType,
-} from "../types/appoinmentTypesType";
-
-export default class AppointmentTypes {
-  private httpClient: HttpClient;
-
-  constructor(httpClient: HttpClient) {
-    this.httpClient = httpClient;
-  }
-
-  /**
-   * Fetch all AppointmentTypes.
-   * @returns {Promise<AppointmentType[]>} - A list of appointment types.
-   * @throws {Error} - If the API returns an error.
-   */
-  public async getAppointmentTypes(): Promise<AppointmentType[]> {
-    return await this.httpClient.get<AppointmentType[]>("/appointmenttypes");
-  }
-}