dynamo-query-engine 1.0.4 → 1.0.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dynamo-query-engine",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "Type-safe DynamoDB query builder for GraphQL with support for filtering, sorting, pagination, and relation expansion",
   "type": "module",
   "main": "index.js",

package/src/core/gridQueryBuilder.js

@@ -9,7 +9,6 @@ import {
   validateFilterField,
   validateSortField,
   validateFilterOperator,
-  validatePaginationModel,
 } from "../utils/validation.js";
 import { decodeCursor, validateCursor } from "../utils/cursor.js";
 
@@ -18,13 +17,13 @@ import { decodeCursor, validateCursor } from "../utils/cursor.js";
  * @param {Object} params - Query parameters
  * @param {FilterModel} params.filterModel - Filter model
  * @param {SortModel} params.sortModel - Sort model
- * @param {number} params.pageSize - Page size
+ * @param {number} params.limit - Query limit
  * @returns {string} SHA256 hash of the query parameters
  */
-function hashQuery({ filterModel, sortModel, pageSize }) {
+function hashQuery({ filterModel, sortModel, limit }) {
   return crypto
     .createHash("sha256")
-    .update(JSON.stringify({ filterModel, sortModel, pageSize }))
+    .update(JSON.stringify({ filterModel, sortModel, limit }))
     .digest("hex");
 }
 
@@ -199,7 +198,7 @@ export function buildGridQuery({
   partitionKeyValue,
   filterModel,
   sortModel,
-  paginationModel,
+  limit = 10,
   cursor,
 }) {
   // Validate inputs
@@ -209,7 +208,21 @@ export function buildGridQuery({
   if (!partitionKeyValue) {
     throw new Error("partitionKeyValue is required");
   }
-  validatePaginationModel(paginationModel);
+  
+  // Validate and normalize limit
+  if (limit !== undefined && limit !== null) {
+    const numLimit = typeof limit === "string" ? Number(limit) : limit;
+    if (Number.isNaN(numLimit) || numLimit < 1) {
+      throw new Error("limit must be a positive number");
+    }
+    if (numLimit > 1000) {
+      throw new Error("limit cannot exceed 1000 (DynamoDB limit)");
+    }
+    limit = numLimit;
+  } else {
+    limit = 10;
+  }
+  
   validateSingleSort(sortModel);
 
   // Extract grid config from schema
@@ -225,7 +238,7 @@ export function buildGridQuery({
   const queryHash = hashQuery({
     filterModel,
     sortModel,
-    pageSize: paginationModel.pageSize,
+    limit,
   });
 
   // Initialize query with partition key
@@ -242,8 +255,8 @@ export function buildGridQuery({
   // Apply sort
   query = applySort(query, sortModel, gridConfig);
 
-  // Apply pagination limit
-  query = query.limit(paginationModel.pageSize);
+  // Apply limit
+  query = query.limit(limit);
 
   // Handle cursor for pagination
   if (cursor) {

package/tests/unit/gridQueryBuilder.test.js

@@ -189,7 +189,7 @@ describe("GridQueryBuilder", () => {
       const { query } = buildGridQuery({
         model: mockModel,
         partitionKeyValue: "ORG#123",
-        paginationModel: { pageSize: 20 },
+        limit: 20,
       });
 
       expect(mockModel.query).toHaveBeenCalledWith("pk");
@@ -203,7 +203,7 @@ describe("GridQueryBuilder", () => {
         buildGridQuery({
           model: null,
           partitionKeyValue: "ORG#123",
-          paginationModel: { pageSize: 20 },
+          limit: 20,
         });
       }).toThrow("model is required");
     });
@@ -213,18 +213,19 @@ describe("GridQueryBuilder", () => {
         buildGridQuery({
           model: mockModel,
           partitionKeyValue: null,
-          paginationModel: { pageSize: 20 },
+          limit: 20,
         });
       }).toThrow("partitionKeyValue is required");
     });
 
-    it("should throw error when paginationModel is missing", () => {
-      expect(() => {
-        buildGridQuery({
-          model: mockModel,
-          partitionKeyValue: "ORG#123",
-        });
-      }).toThrow("paginationModel is required");
+    it("should use default limit when not provided", () => {
+      const { query } = buildGridQuery({
+        model: mockModel,
+        partitionKeyValue: "ORG#123",
+      });
+
+      expect(mockQuery.limit).toHaveBeenCalledWith(10);
+      expect(query).toBe(mockQuery);
     });
 
     it("should use custom hash key name from schema", () => {
@@ -248,7 +249,7 @@ describe("GridQueryBuilder", () => {
       buildGridQuery({
         model: customMockModel,
         partitionKeyValue: "tenant-123",
-        paginationModel: { pageSize: 20 },
+        limit: 20,
       });
 
       // Should query with 'tenantId' not 'pk'
@@ -277,7 +278,7 @@ describe("GridQueryBuilder", () => {
         model: mockModel,
         partitionKeyValue: "ORG#123",
         filterModel,
-        paginationModel: { pageSize: 20 },
+        limit: 20,
       });
 
       expect(mockQuery.where).toHaveBeenCalledWith("status");
@@ -295,7 +296,7 @@ describe("GridQueryBuilder", () => {
         model: mockModel,
         partitionKeyValue: "ORG#123",
         filterModel,
-        paginationModel: { pageSize: 20 },
+        limit: 20,
       });
 
       expect(mockQuery.where).toHaveBeenCalledWith("createdAt");
@@ -317,7 +318,7 @@ describe("GridQueryBuilder", () => {
         model: mockModel,
         partitionKeyValue: "ORG#123",
         filterModel,
-        paginationModel: { pageSize: 20 },
+        limit: 20,
       });
 
       expect(mockQuery.between).toHaveBeenCalledWith("2024-01-01", "2024-12-31");
@@ -332,7 +333,7 @@ describe("GridQueryBuilder", () => {
         model: mockModel,
         partitionKeyValue: "ORG#123",
         filterModel,
-        paginationModel: { pageSize: 20 },
+        limit: 20,
       });
 
       expect(mockQuery.using).toHaveBeenCalledWith("status-createdAt-index");
@@ -348,7 +349,7 @@ describe("GridQueryBuilder", () => {
           model: mockModel,
           partitionKeyValue: "ORG#123",
           filterModel,
-          paginationModel: { pageSize: 20 },
+          limit: 20,
         });
       }).toThrow("Filtering not allowed");
     });
@@ -363,7 +364,7 @@ describe("GridQueryBuilder", () => {
           model: mockModel,
           partitionKeyValue: "ORG#123",
           filterModel,
-          paginationModel: { pageSize: 20 },
+          limit: 20,
         });
       }).toThrow("not allowed");
     });
@@ -387,7 +388,7 @@ describe("GridQueryBuilder", () => {
         model: mockModel,
         partitionKeyValue: "ORG#123",
         sortModel,
-        paginationModel: { pageSize: 20 },
+        limit: 20,
       });
 
       expect(mockQuery.sort).toHaveBeenCalledWith("descending");
@@ -400,7 +401,7 @@ describe("GridQueryBuilder", () => {
         model: mockModel,
         partitionKeyValue: "ORG#123",
         sortModel,
-        paginationModel: { pageSize: 20 },
+        limit: 20,
       });
 
       // Ascending is default, so sort() should not be called
@@ -418,7 +419,7 @@ describe("GridQueryBuilder", () => {
           model: mockModel,
           partitionKeyValue: "ORG#123",
           sortModel,
-          paginationModel: { pageSize: 20 },
+          limit: 20,
         });
       }).toThrow(/sorting by one field/);
     });
@@ -431,13 +432,13 @@ describe("GridQueryBuilder", () => {
           model: mockModel,
           partitionKeyValue: "ORG#123",
           sortModel,
-          paginationModel: { pageSize: 20 },
+          limit: 20,
         });
       }).toThrow("Sorting not allowed");
     });
   });
 
-  describe("buildGridQuery - Pagination", () => {
+  describe("buildGridQuery - Limit and Cursor", () => {
     let mockModel;
     let mockQuery;
 
@@ -448,11 +449,11 @@ describe("GridQueryBuilder", () => {
       mockModel.query = vi.fn(() => mockQuery);
     });
 
-    it("should apply page size limit", () => {
+    it("should apply limit", () => {
       buildGridQuery({
         model: mockModel,
         partitionKeyValue: "ORG#123",
-        paginationModel: { pageSize: 50 },
+        limit: 50,
       });
 
       expect(mockQuery.limit).toHaveBeenCalledWith(50);
@@ -465,7 +466,7 @@ describe("GridQueryBuilder", () => {
       const firstResult = buildGridQuery({
         model: mockModel,
         partitionKeyValue: "ORG#123",
-        paginationModel: { pageSize: 20 },
+        limit: 20,
       });
 
       // Create cursor with the actual queryHash
@@ -477,7 +478,7 @@ describe("GridQueryBuilder", () => {
       buildGridQuery({
         model: mockModel,
         partitionKeyValue: "ORG#123",
-        paginationModel: { pageSize: 20 },
+        limit: 20,
         cursor,
       });
 
@@ -496,7 +497,7 @@ describe("GridQueryBuilder", () => {
         buildGridQuery({
           model: mockModel,
           partitionKeyValue: "ORG#123",
-          paginationModel: { pageSize: 50 }, // Different page size
+          limit: 50, // Different limit
           cursor,
         });
       }).toThrow("Cursor does not match");
@@ -519,7 +520,7 @@ describe("GridQueryBuilder", () => {
           items: [{ field: "status", operator: "eq", value: "active" }],
         },
         sortModel: [{ field: "createdAt", sort: "desc" }],
-        paginationModel: { pageSize: 20 },
+        limit: 20,
       };
 
       const result1 = buildGridQuery(params);
@@ -532,7 +533,7 @@ describe("GridQueryBuilder", () => {
       const baseParams = {
         model: mockModel,
         partitionKeyValue: "ORG#123",
-        paginationModel: { pageSize: 20 },
+        limit: 20,
       };
 
       const result1 = buildGridQuery({
@@ -552,7 +553,7 @@ describe("GridQueryBuilder", () => {
       expect(result1.queryHash).not.toBe(result2.queryHash);
     });
 
-    it("should return different hash when page size changes", () => {
+    it("should return different hash when limit changes", () => {
       const baseParams = {
         model: mockModel,
         partitionKeyValue: "ORG#123",
@@ -560,12 +561,12 @@ describe("GridQueryBuilder", () => {
 
       const result1 = buildGridQuery({
         ...baseParams,
-        paginationModel: { pageSize: 20 },
+        limit: 20,
       });
 
       const result2 = buildGridQuery({
         ...baseParams,
-        paginationModel: { pageSize: 50 },
+        limit: 50,
       });
 
       expect(result1.queryHash).not.toBe(result2.queryHash);
@@ -583,7 +584,7 @@ describe("GridQueryBuilder", () => {
       mockModel.query = vi.fn(() => mockQuery);
     });
 
-    it("should handle query with filter, sort, and pagination", () => {
+    it("should handle query with filter, sort, and limit", () => {
       buildGridQuery({
         model: mockModel,
         partitionKeyValue: "ORG#123",
@@ -591,7 +592,7 @@ describe("GridQueryBuilder", () => {
           items: [{ field: "status", operator: "eq", value: "active" }],
         },
         sortModel: [{ field: "createdAt", sort: "desc" }],
-        paginationModel: { pageSize: 25 },
+        limit: 25,
       });
 
       // Verify all operations were applied
@@ -609,7 +610,7 @@ describe("GridQueryBuilder", () => {
         partitionKeyValue: "ORG#123",
         filterModel: { items: [] },
         sortModel: [],
-        paginationModel: { pageSize: 20 },
+        limit: 20,
       });
 
       expect(query).toBeDefined();