@rinse-dental/open-dental 2.4.11 → 2.4.12

package/dist/api/queries.d.ts

@@ -4,14 +4,15 @@ export default class Queries {
     private httpClient;
     constructor(httpClient: HttpClient);
     /**
-     * Execute a ShortQuery (arbitrary SQL). Caller can provide a row type.
+     * 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:
-     *   shortQuery<{ PatNum: number; LName: string }>({
-     *     SqlCommand: "SELECT PatNum,LName FROM patient LIMIT 10"
+     *   queries.shortQuery<{ PayPeriodNum: number; DateStart: string; DateStop: string; DatePaycheck: string }>({
+     *     SqlCommand: "SELECT * FROM payperiod"
      *   })
-     *
-     * Open Dental: PUT /queries/short/{SqlCommand}?Offset=#
-     * @see https://www.opendental.com/site/apiqueries.html
      */
     shortQuery<Row = unknown>({ SqlCommand, Offset }: ShortQueryParams, opts?: {
         parse?: RowParser<Row>;

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

@@ -1 +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;;;;;;;;;OASG;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;CAelC"}
+{"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

@@ -6,23 +6,23 @@ class Queries {
         this.httpClient = httpClient;
     }
     /**
-     * Execute a ShortQuery (arbitrary SQL). Caller can provide a row type.
+     * 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:
-     *   shortQuery<{ PatNum: number; LName: string }>({
-     *     SqlCommand: "SELECT PatNum,LName FROM patient LIMIT 10"
+     *   queries.shortQuery<{ PayPeriodNum: number; DateStart: string; DateStop: string; DatePaycheck: string }>({
+     *     SqlCommand: "SELECT * FROM payperiod"
      *   })
-     *
-     * Open Dental: PUT /queries/short/{SqlCommand}?Offset=#
-     * @see https://www.opendental.com/site/apiqueries.html
      */
     async shortQuery({ SqlCommand, Offset }, opts) {
-        // Build path with encoded SQL and optional Offset
-        let path = `/queries/short/${encodeURIComponent(SqlCommand)}`;
+        let path = "/queries/ShortQuery";
         if (typeof Offset === "number") {
             path += `?Offset=${encodeURIComponent(String(Offset))}`;
         }
-        // Your HttpClient.put only accepts (url, data), so send an empty object body
-        const data = await this.httpClient.put(path, {});
+        // HttpClient.put(url, data) per your implementation
+        const data = await this.httpClient.put(path, { SqlCommand });
         if (opts?.parse) {
             return data.map(opts.parse);
         }

package/dist/types/queryTypes.d.ts

@@ -1,15 +1,16 @@
 /**
- * Parameters for ShortQuery (PUT /queries/short/{SqlCommand}?Offset=#)
+ * 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 {
-    /** Required in the URL path (will be URL-encoded) */
     SqlCommand: string;
-    /** Optional pagination offset (goes in query string) */
     Offset?: number;
 }
 /** Generic result rows for ShortQuery; supply Row when you know the shape */
 export type ShortQueryResult<Row = unknown> = Row[];
-/** Optional runtime row parser if you want validation */
+/** 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

@@ -1 +1 @@
-{"version":3,"file":"queryTypes.d.ts","sourceRoot":"","sources":["../../src/types/queryTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,qDAAqD;IACrD,UAAU,EAAE,MAAM,CAAC;IACnB,wDAAwD;IACxD,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,6EAA6E;AAC7E,MAAM,MAAM,gBAAgB,CAAC,GAAG,GAAG,OAAO,IAAI,GAAG,EAAE,CAAC;AAEpD,yDAAyD;AACzD,MAAM,MAAM,SAAS,CAAC,GAAG,IAAI,CAAC,KAAK,EAAE,OAAO,KAAK,GAAG,CAAC"}
+{"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/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rinse-dental/open-dental",
-    "version": "2.4.11",
+    "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/queries.ts

@@ -13,27 +13,27 @@ export default class Queries {
   }
 
   /**
-   * Execute a ShortQuery (arbitrary SQL). Caller can provide a row type.
+   * 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:
-   *   shortQuery<{ PatNum: number; LName: string }>({
-   *     SqlCommand: "SELECT PatNum,LName FROM patient LIMIT 10"
+   *   queries.shortQuery<{ PayPeriodNum: number; DateStart: string; DateStop: string; DatePaycheck: string }>({
+   *     SqlCommand: "SELECT * FROM payperiod"
    *   })
-   *
-   * Open Dental: PUT /queries/short/{SqlCommand}?Offset=#
-   * @see https://www.opendental.com/site/apiqueries.html
    */
   public async shortQuery<Row = unknown>(
     { SqlCommand, Offset }: ShortQueryParams,
     opts?: { parse?: RowParser<Row> }
   ): Promise<ShortQueryResult<Row>> {
-    // Build path with encoded SQL and optional Offset
-    let path = `/queries/short/${encodeURIComponent(SqlCommand)}`;
+    let path = "/queries/ShortQuery";
     if (typeof Offset === "number") {
       path += `?Offset=${encodeURIComponent(String(Offset))}`;
     }
 
-    // Your HttpClient.put only accepts (url, data), so send an empty object body
-    const data = await this.httpClient.put<unknown[]>(path, {});
+    // 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);

package/src/types/queryTypes.ts

@@ -1,16 +1,17 @@
 /**
- * Parameters for ShortQuery (PUT /queries/short/{SqlCommand}?Offset=#)
+ * 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 {
-  /** Required in the URL path (will be URL-encoded) */
-  SqlCommand: string;
-  /** Optional pagination offset (goes in query string) */
-  Offset?: number;
+  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 row parser if you want validation */
+/** Optional runtime validator for rows (e.g., Zod) */
 export type RowParser<Row> = (value: unknown) => Row;