@rinse-dental/open-dental 2.4.10 → 2.4.12

package/dist/api/index.d.ts

@@ -20,4 +20,5 @@ export { default as Allergies } from "./allergies";
 export { default as MedicationPats } from "./medicationPats";
 export { default as ProcTPs } from "./procTPs";
 export { default as ProcNotes } from "./procNotes";
+export { default as Queries } from "./queries";
 //# sourceMappingURL=index.d.ts.map

package/dist/api/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC1D,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,cAAc,CAAC;AACzD,OAAO,EAAE,OAAO,IAAI,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACjE,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,EAAE,OAAO,IAAI,IAAI,EAAE,MAAM,QAAQ,CAAC;AACzC,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC1D,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,cAAc,CAAC;AACzD,OAAO,EAAE,OAAO,IAAI,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACjE,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,EAAE,OAAO,IAAI,IAAI,EAAE,MAAM,QAAQ,CAAC;AACzC,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,WAAW,CAAC"}

package/dist/api/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProcNotes = exports.ProcTPs = exports.MedicationPats = exports.Allergies = exports.Diseases = exports.Fees = exports.DiscountPlans = exports.DiscountPlanSubs = exports.Definitions = exports.Payments = exports.Operatories = exports.Providers = exports.Schedules = exports.TreatmentPlanAttaches = exports.TreatmentPlans = exports.Recalls = exports.ProcedureLogs = exports.Patients = exports.PatFields = exports.CommLogs = exports.ChartModules = exports.Appointments = void 0;
+exports.Queries = exports.ProcNotes = exports.ProcTPs = exports.MedicationPats = exports.Allergies = exports.Diseases = exports.Fees = exports.DiscountPlans = exports.DiscountPlanSubs = exports.Definitions = exports.Payments = exports.Operatories = exports.Providers = exports.Schedules = exports.TreatmentPlanAttaches = exports.TreatmentPlans = exports.Recalls = exports.ProcedureLogs = exports.Patients = exports.PatFields = exports.CommLogs = exports.ChartModules = exports.Appointments = void 0;
 var appointments_1 = require("./appointments");
 Object.defineProperty(exports, "Appointments", { enumerable: true, get: function () { return __importDefault(appointments_1).default; } });
 var chartModules_1 = require("./chartModules");
@@ -48,4 +48,6 @@ var procTPs_1 = require("./procTPs");
 Object.defineProperty(exports, "ProcTPs", { enumerable: true, get: function () { return __importDefault(procTPs_1).default; } });
 var procNotes_1 = require("./procNotes");
 Object.defineProperty(exports, "ProcNotes", { enumerable: true, get: function () { return __importDefault(procNotes_1).default; } });
+var queries_1 = require("./queries");
+Object.defineProperty(exports, "Queries", { enumerable: true, get: function () { return __importDefault(queries_1).default; } });
 // Add other APIs as needed

package/dist/api/queries.d.ts

@@ -0,0 +1,21 @@
+import HttpClient from "../utils/httpClient";
+import { ShortQueryParams, ShortQueryResult, RowParser } from "../types/queryTypes";
+export default class Queries {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Execute a ShortQuery (arbitrary read-only SQL).
+     * Open Dental: PUT /queries/ShortQuery?Offset=#
+     * Body: { SqlCommand }
+     * Returns at most 100 rows (use Queries POST for longer results).
+     *
+     * Example:
+     *   queries.shortQuery<{ PayPeriodNum: number; DateStart: string; DateStop: string; DatePaycheck: string }>({
+     *     SqlCommand: "SELECT * FROM payperiod"
+     *   })
+     */
+    shortQuery<Row = unknown>({ SqlCommand, Offset }: ShortQueryParams, opts?: {
+        parse?: RowParser<Row>;
+    }): Promise<ShortQueryResult<Row>>;
+}
+//# sourceMappingURL=queries.d.ts.map

package/dist/api/queries.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../src/api/queries.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,gBAAgB,EAChB,gBAAgB,EAChB,SAAS,EACV,MAAM,qBAAqB,CAAC;AAE7B,MAAM,CAAC,OAAO,OAAO,OAAO;IAC1B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;OAUG;IACU,UAAU,CAAC,GAAG,GAAG,OAAO,EACnC,EAAE,UAAU,EAAE,MAAM,EAAE,EAAE,gBAAgB,EACxC,IAAI,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,SAAS,CAAC,GAAG,CAAC,CAAA;KAAE,GAChC,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;CAclC"}

package/dist/api/queries.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Queries {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Execute a ShortQuery (arbitrary read-only SQL).
+     * Open Dental: PUT /queries/ShortQuery?Offset=#
+     * Body: { SqlCommand }
+     * Returns at most 100 rows (use Queries POST for longer results).
+     *
+     * Example:
+     *   queries.shortQuery<{ PayPeriodNum: number; DateStart: string; DateStop: string; DatePaycheck: string }>({
+     *     SqlCommand: "SELECT * FROM payperiod"
+     *   })
+     */
+    async shortQuery({ SqlCommand, Offset }, opts) {
+        let path = "/queries/ShortQuery";
+        if (typeof Offset === "number") {
+            path += `?Offset=${encodeURIComponent(String(Offset))}`;
+        }
+        // HttpClient.put(url, data) per your implementation
+        const data = await this.httpClient.put(path, { SqlCommand });
+        if (opts?.parse) {
+            return data.map(opts.parse);
+        }
+        return data;
+    }
+}
+exports.default = Queries;

package/dist/openDental.d.ts

@@ -32,6 +32,7 @@ import Allergies from "./api/allergies";
 import MedicationPats from "./api/medicationPats";
 import ProcTPs from "./api/procTPs";
 import ProcNotes from "./api/procNotes";
+import Queries from "./api/queries";
 import * as Transformers from './transformers';
 declare class OpenDental {
     private static httpClient;
@@ -175,6 +176,10 @@ declare class OpenDental {
      * Create a new instance of the ProcNotes API.
      */
     static ProcNotes(): ProcNotes;
+    /**
+     * Create a new instance of the ProcNotes API.
+     */
+    static Queries(): Queries;
     /**
      * Access stateless Transformers (no initialization needed)
      */

package/dist/openDental.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"openDental.d.ts","sourceRoot":"","sources":["../src/openDental.ts"],"names":[],"mappings":"AACA,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAC/C,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,qBAAqB,MAAM,yBAAyB,CAAC;AAC5D,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAChD,OAAO,gBAAgB,MAAM,wBAAwB,CAAC;AACtD,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAChD,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,UAAU,MAAM,kBAAkB,CAAC;AAC1C,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAClD,OAAO,IAAI,MAAM,YAAY,CAAC;AAC9B,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAClD,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AAGxC,OAAO,KAAK,YAAY,MAAM,gBAAgB,CAAC;AAE/C,cAAM,UAAU;IACd,OAAO,CAAC,MAAM,CAAC,UAAU,CAAa;IAEtC;;OAEG;WACW,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAWlE;;OAEG;WACa,YAAY;IAQ5B;;OAEG;WACa,QAAQ;IAOxB;;OAEG;WACW,YAAY;IAO1B;;SAEK;WACS,SAAS;IAOvB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,aAAa;IAO3B;;OAEG;WACW,OAAO;IAOrB;;OAEG;WACW,cAAc;IAO5B;;OAEG;WACW,qBAAqB;IAOnC;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,WAAW;IAOzB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,WAAW;IAOzB;;OAEG;WACW,aAAa;IAO3B;;OAEG;WACW,gBAAgB;IAO9B;;OAEG;WACW,aAAa;IAO3B;;OAEG;WACW,OAAO;IAOrB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,WAAW;IAOzB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,UAAU;IAOxB;;OAEG;WACW,WAAW;IAOzB;;OAEG;WACW,cAAc;IAO5B;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,IAAI;IAOlB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,cAAc;IAO5B;;OAEG;WACW,OAAO;IAOrB;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,YAAY;CAI3B;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}
+{"version":3,"file":"openDental.d.ts","sourceRoot":"","sources":["../src/openDental.ts"],"names":[],"mappings":"AACA,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAC/C,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,qBAAqB,MAAM,yBAAyB,CAAC;AAC5D,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAChD,OAAO,gBAAgB,MAAM,wBAAwB,CAAC;AACtD,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAChD,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,UAAU,MAAM,kBAAkB,CAAC;AAC1C,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAClD,OAAO,IAAI,MAAM,YAAY,CAAC;AAC9B,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAClD,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,OAAO,MAAM,eAAe,CAAC;AAGpC,OAAO,KAAK,YAAY,MAAM,gBAAgB,CAAC;AAE/C,cAAM,UAAU;IACd,OAAO,CAAC,MAAM,CAAC,UAAU,CAAa;IAEtC;;OAEG;WACW,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAWlE;;OAEG;WACa,YAAY;IAQ5B;;OAEG;WACa,QAAQ;IAOxB;;OAEG;WACW,YAAY;IAO1B;;SAEK;WACS,SAAS;IAOvB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,aAAa;IAO3B;;OAEG;WACW,OAAO;IAOrB;;OAEG;WACW,cAAc;IAO5B;;OAEG;WACW,qBAAqB;IAOnC;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,WAAW;IAOzB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,WAAW;IAOzB;;OAEG;WACW,aAAa;IAO3B;;OAEG;WACW,gBAAgB;IAO9B;;OAEG;WACW,aAAa;IAO3B;;OAEG;WACW,OAAO;IAOrB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,WAAW;IAOzB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,UAAU;IAOxB;;OAEG;WACW,WAAW;IAOzB;;OAEG;WACW,cAAc;IAO5B;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,IAAI;IAOlB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,cAAc;IAO5B;;OAEG;WACW,OAAO;IAOrB;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,OAAO;IAOrB;;OAEG;WACW,YAAY;CAI3B;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/dist/openDental.js

@@ -72,6 +72,7 @@ const allergies_1 = __importDefault(require("./api/allergies"));
 const medicationPats_1 = __importDefault(require("./api/medicationPats"));
 const procTPs_1 = __importDefault(require("./api/procTPs"));
 const procNotes_1 = __importDefault(require("./api/procNotes"));
+const queries_1 = __importDefault(require("./api/queries"));
 const Transformers = __importStar(require("./transformers"));
 class OpenDental {
     static httpClient;
@@ -392,6 +393,15 @@ class OpenDental {
         }
         return new procNotes_1.default(this.httpClient);
     }
+    /**
+     * Create a new instance of the ProcNotes API.
+     */
+    static Queries() {
+        if (!this.httpClient) {
+            throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+        }
+        return new queries_1.default(this.httpClient);
+    }
     /**
      * Access stateless Transformers (no initialization needed)
      */

package/dist/types/queryTypes.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Parameters for Queries PUT ShortQuery
+ * Endpoint: PUT /queries/ShortQuery?Offset=#
+ * Body: { SqlCommand: string }
+ * Returns: up to 100 rows; use Queries POST for longer results.
+ * @see https://www.opendental.com/site/apiqueries.html
+ */
+export interface ShortQueryParams {
+    SqlCommand: string;
+    Offset?: number;
+}
+/** Generic result rows for ShortQuery; supply Row when you know the shape */
+export type ShortQueryResult<Row = unknown> = Row[];
+/** Optional runtime validator for rows (e.g., Zod) */
+export type RowParser<Row> = (value: unknown) => Row;
+//# sourceMappingURL=queryTypes.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"queryTypes.d.ts","sourceRoot":"","sources":["../../src/types/queryTypes.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,6EAA6E;AAC7E,MAAM,MAAM,gBAAgB,CAAC,GAAG,GAAG,OAAO,IAAI,GAAG,EAAE,CAAC;AAEpD,sDAAsD;AACtD,MAAM,MAAM,SAAS,CAAC,GAAG,IAAI,CAAC,KAAK,EAAE,OAAO,KAAK,GAAG,CAAC"}

package/dist/types/queryTypes.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rinse-dental/open-dental",
-    "version": "2.4.10",
+    "version": "2.4.12",
     "description": "A TypeScript library for easily accessing Open Dental APIs.",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",

package/src/api/index.ts

@@ -20,4 +20,5 @@ export { default as Allergies } from "./allergies";
 export { default as MedicationPats } from "./medicationPats"; 
 export { default as ProcTPs } from "./procTPs";
 export { default as ProcNotes } from "./procNotes"; 
+export { default as Queries } from "./queries"; 
 // Add other APIs as needed

package/src/api/queries.ts

@@ -0,0 +1,43 @@
+import HttpClient from "../utils/httpClient";
+import {
+  ShortQueryParams,
+  ShortQueryResult,
+  RowParser,
+} from "../types/queryTypes";
+
+export default class Queries {
+  private httpClient: HttpClient;
+
+  constructor(httpClient: HttpClient) {
+    this.httpClient = httpClient;
+  }
+
+  /**
+   * Execute a ShortQuery (arbitrary read-only SQL).
+   * Open Dental: PUT /queries/ShortQuery?Offset=#
+   * Body: { SqlCommand }
+   * Returns at most 100 rows (use Queries POST for longer results).
+   *
+   * Example:
+   *   queries.shortQuery<{ PayPeriodNum: number; DateStart: string; DateStop: string; DatePaycheck: string }>({
+   *     SqlCommand: "SELECT * FROM payperiod"
+   *   })
+   */
+  public async shortQuery<Row = unknown>(
+    { SqlCommand, Offset }: ShortQueryParams,
+    opts?: { parse?: RowParser<Row> }
+  ): Promise<ShortQueryResult<Row>> {
+    let path = "/queries/ShortQuery";
+    if (typeof Offset === "number") {
+      path += `?Offset=${encodeURIComponent(String(Offset))}`;
+    }
+
+    // HttpClient.put(url, data) per your implementation
+    const data = await this.httpClient.put<unknown[]>(path, { SqlCommand });
+
+    if (opts?.parse) {
+      return (data as unknown[]).map(opts.parse);
+    }
+    return data as Row[];
+  }
+}

package/src/openDental.ts

@@ -33,6 +33,7 @@ import Allergies from "./api/allergies";
 import MedicationPats from "./api/medicationPats";
 import ProcTPs from "./api/procTPs";
 import ProcNotes from "./api/procNotes";
+import Queries from "./api/queries";
 
 
 import * as Transformers from './transformers';
@@ -395,6 +396,16 @@ class OpenDental {
     return new ProcNotes(this.httpClient);
   }
 
+  /**
+   * Create a new instance of the ProcNotes API.
+   */
+  public static Queries() {
+    if (!this.httpClient) {
+      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+    }
+    return new Queries(this.httpClient);
+  }
+
   /**
    * Access stateless Transformers (no initialization needed)
    */

package/src/types/queryTypes.ts

@@ -0,0 +1,17 @@
+/**
+ * Parameters for Queries PUT ShortQuery
+ * Endpoint: PUT /queries/ShortQuery?Offset=#
+ * Body: { SqlCommand: string }
+ * Returns: up to 100 rows; use Queries POST for longer results.
+ * @see https://www.opendental.com/site/apiqueries.html
+ */
+export interface ShortQueryParams {
+  SqlCommand: string;   // Required (in request body)
+  Offset?: number;      // Optional (in query string)
+}
+
+/** Generic result rows for ShortQuery; supply Row when you know the shape */
+export type ShortQueryResult<Row = unknown> = Row[];
+
+/** Optional runtime validator for rows (e.g., Zod) */
+export type RowParser<Row> = (value: unknown) => Row;