@panoptic-it-solutions/quickbooks-client 0.1.1 → 0.1.3

package/dist/index.d.mts

@@ -257,6 +257,12 @@ declare class QuickBooksClient {
      * Execute a query using QuickBooks Query Language
      */
     query<T>(sql: string): Promise<T[]>;
+    /**
+     * Execute a query with automatic pagination to fetch all results
+     * @param sql - Base SQL query (without STARTPOSITION/MAXRESULTS)
+     * @param pageSize - Number of results per page (default 1000, max 1000)
+     */
+    queryAll<T>(sql: string, pageSize?: number): Promise<T[]>;
     getInvoice(id: string): Promise<Invoice>;
     getInvoices(where?: string): Promise<Invoice[]>;
     createInvoice(invoice: Partial<Invoice>): Promise<Invoice>;

package/dist/index.d.ts

@@ -257,6 +257,12 @@ declare class QuickBooksClient {
      * Execute a query using QuickBooks Query Language
      */
     query<T>(sql: string): Promise<T[]>;
+    /**
+     * Execute a query with automatic pagination to fetch all results
+     * @param sql - Base SQL query (without STARTPOSITION/MAXRESULTS)
+     * @param pageSize - Number of results per page (default 1000, max 1000)
+     */
+    queryAll<T>(sql: string, pageSize?: number): Promise<T[]>;
     getInvoice(id: string): Promise<Invoice>;
     getInvoices(where?: string): Promise<Invoice[]>;
     createInvoice(invoice: Partial<Invoice>): Promise<Invoice>;

package/dist/index.js

@@ -384,7 +384,6 @@ var QuickBooksClient = class {
    * Execute a query using QuickBooks Query Language
    */
   async query(sql) {
-    const response = await this.request("POST", "/query", void 0);
     const tokens = await this.getValidTokens();
     const env = this.config.environment || "production";
     const baseUrl = API_BASE[env];
@@ -410,6 +409,50 @@ var QuickBooksClient = class {
     const entityKey = keys[0];
     return entityKey ? data.QueryResponse[entityKey] : [];
   }
+  /**
+   * Execute a query with automatic pagination to fetch all results
+   * @param sql - Base SQL query (without STARTPOSITION/MAXRESULTS)
+   * @param pageSize - Number of results per page (default 1000, max 1000)
+   */
+  async queryAll(sql, pageSize = 1e3) {
+    const allResults = [];
+    let startPosition = 1;
+    const maxResults = Math.min(pageSize, 1e3);
+    while (true) {
+      const paginatedSql = `${sql} STARTPOSITION ${startPosition} MAXRESULTS ${maxResults}`;
+      const tokens = await this.getValidTokens();
+      const env = this.config.environment || "production";
+      const baseUrl = API_BASE[env];
+      const url = `${baseUrl}/v3/company/${tokens.realm_id}/query`;
+      await this.checkRateLimit();
+      const fetchResponse = await fetch(url, {
+        method: "POST",
+        headers: {
+          Authorization: `Bearer ${tokens.access_token}`,
+          Accept: "application/json",
+          "Content-Type": "application/text"
+        },
+        body: paginatedSql
+      });
+      if (!fetchResponse.ok) {
+        const errorData = await fetchResponse.json().catch(() => ({}));
+        throw handleQuickBooksError({ status: fetchResponse.status, ...errorData });
+      }
+      const data = await fetchResponse.json();
+      const keys = Object.keys(data.QueryResponse).filter(
+        (k) => !["startPosition", "maxResults", "totalCount"].includes(k)
+      );
+      const entityKey = keys[0];
+      const pageResults = entityKey ? data.QueryResponse[entityKey] : [];
+      allResults.push(...pageResults);
+      this.log("debug", `Fetched page at position ${startPosition}, got ${pageResults.length} results (total: ${allResults.length})`);
+      if (pageResults.length < maxResults) {
+        break;
+      }
+      startPosition += maxResults;
+    }
+    return allResults;
+  }
   // ============================================
   // Invoice Methods
   // ============================================

package/dist/index.mjs

@@ -348,7 +348,6 @@ var QuickBooksClient = class {
    * Execute a query using QuickBooks Query Language
    */
   async query(sql) {
-    const response = await this.request("POST", "/query", void 0);
     const tokens = await this.getValidTokens();
     const env = this.config.environment || "production";
     const baseUrl = API_BASE[env];
@@ -374,6 +373,50 @@ var QuickBooksClient = class {
     const entityKey = keys[0];
     return entityKey ? data.QueryResponse[entityKey] : [];
   }
+  /**
+   * Execute a query with automatic pagination to fetch all results
+   * @param sql - Base SQL query (without STARTPOSITION/MAXRESULTS)
+   * @param pageSize - Number of results per page (default 1000, max 1000)
+   */
+  async queryAll(sql, pageSize = 1e3) {
+    const allResults = [];
+    let startPosition = 1;
+    const maxResults = Math.min(pageSize, 1e3);
+    while (true) {
+      const paginatedSql = `${sql} STARTPOSITION ${startPosition} MAXRESULTS ${maxResults}`;
+      const tokens = await this.getValidTokens();
+      const env = this.config.environment || "production";
+      const baseUrl = API_BASE[env];
+      const url = `${baseUrl}/v3/company/${tokens.realm_id}/query`;
+      await this.checkRateLimit();
+      const fetchResponse = await fetch(url, {
+        method: "POST",
+        headers: {
+          Authorization: `Bearer ${tokens.access_token}`,
+          Accept: "application/json",
+          "Content-Type": "application/text"
+        },
+        body: paginatedSql
+      });
+      if (!fetchResponse.ok) {
+        const errorData = await fetchResponse.json().catch(() => ({}));
+        throw handleQuickBooksError({ status: fetchResponse.status, ...errorData });
+      }
+      const data = await fetchResponse.json();
+      const keys = Object.keys(data.QueryResponse).filter(
+        (k) => !["startPosition", "maxResults", "totalCount"].includes(k)
+      );
+      const entityKey = keys[0];
+      const pageResults = entityKey ? data.QueryResponse[entityKey] : [];
+      allResults.push(...pageResults);
+      this.log("debug", `Fetched page at position ${startPosition}, got ${pageResults.length} results (total: ${allResults.length})`);
+      if (pageResults.length < maxResults) {
+        break;
+      }
+      startPosition += maxResults;
+    }
+    return allResults;
+  }
   // ============================================
   // Invoice Methods
   // ============================================

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@panoptic-it-solutions/quickbooks-client",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "QuickBooks Online API client with OAuth 2.0, rate limiting, and typed entities",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -20,6 +20,7 @@
     "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
     "test": "vitest",
     "test:run": "vitest run",
+    "test:integration": "tsx test/integration.ts",
     "lint": "biome check src",
     "format": "biome format --write src",
     "prepublishOnly": "npm run build"
@@ -41,11 +42,11 @@
   "engines": {
     "node": ">=18"
   },
-  "dependencies": {},
   "devDependencies": {
     "@biomejs/biome": "^2.3.11",
     "@types/node": "^20",
     "tsup": "^8.0.0",
+    "tsx": "^4.21.0",
     "typescript": "^5",
     "vitest": "^2.0.0"
   }