@dylandepass/helix-product-pipeline 2.2.0 → 2.3.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [2.3.0](https://github.com/adobe-rnd/helix-product-pipeline/compare/v2.2.0...v2.3.0) (2026-02-12)
+
+
+### Features
+
+* add limit/offset pagination and deterministic sort to product index ([#71](https://github.com/adobe-rnd/helix-product-pipeline/issues/71)) ([28499dd](https://github.com/adobe-rnd/helix-product-pipeline/commit/28499dd2140c830ed46ecec03bad4cee1fdd1ba5))
+
 # [2.2.0](https://github.com/adobe-rnd/helix-product-pipeline/compare/v2.1.0...v2.2.0) (2026-02-04)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dylandepass/helix-product-pipeline",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "Helix Product Pipeline",
   "main": "src/index.js",
   "types": "src/index.d.ts",

package/src/product-index-pipe.js

@@ -17,22 +17,33 @@ import initConfig from './steps/init-config.js';
 import fetchProductBusContent from './steps/fetch-productbus.js';
 import { setLastModified } from './utils/last-modified.js';
 import { set404CacheHeaders } from './steps/set-cache-headers.js';
-import { getIncludes } from './steps/utils.js';
+import { getIncludes, getPaginationParams } from './steps/utils.js';
 
 /**
- * Returns index as spreadsheet
+ * Returns index as spreadsheet with pagination support.
  * @param {SharedTypes.StoredIndex} index
  * @param {Record<string, boolean>} includes
+ * @param {{ hasParams?: boolean, limit?: number, offset?: number }} [pagination={}]
+ *   - Pagination options
  * @returns {{
 *   ':type': 'sheet',
+*   total: number,
+*   offset: number,
+*   limit: number,
 *   columns: string[],
 *   data: Record<string, string>[]
 * }}
 */
-export function toSpreadsheet(index, includes) {
+export function toSpreadsheet(index, includes, pagination = {}) {
+  const {
+    limit = pagination.hasParams ? 1000 : Infinity,
+    offset = 0,
+  } = pagination;
+
   const columns = new Set(['sku']);
 
   const products = Object.entries(index)
+    .sort(([a], [b]) => a.localeCompare(b))
     .filter(([_, entry]) => includes.all || !entry.filters?.noindex || includes.noindex)
     .reduce((acc, [sluggedSku, entry]) => {
       const product = entry.data;
@@ -80,10 +91,17 @@ export function toSpreadsheet(index, includes) {
       return acc;
     }, []);
 
+  const total = products.length;
+  const len = Math.min(limit, total - offset);
+  const paginatedData = products.slice(offset, offset + len);
+
   return {
     ':type': 'sheet',
+    total,
+    offset,
+    limit: paginatedData.length,
     columns: Array.from(columns),
-    data: products,
+    data: paginatedData,
   };
 }
 
@@ -135,7 +153,9 @@ export async function productIndexPipe(state, req) {
 
     setLastModified(state, res);
 
-    res.body = JSON.stringify(toSpreadsheet(state.content.data, getIncludes(req)), null, 2);
+    const pagination = getPaginationParams(req);
+    const spreadsheet = toSpreadsheet(state.content.data, getIncludes(req), pagination);
+    res.body = JSON.stringify(spreadsheet, null, 2);
   } catch (e) {
     const errorRes = new PipelineResponse('', {
       /* c8 ignore next 6 */

package/src/steps/utils.js

@@ -125,3 +125,36 @@ export function getIncludes(req) {
   }
   return includes;
 }
+
+/**
+ * Get pagination params from request URL.
+ * @param {PipelineRequest} req
+ * @returns {{ hasParams?: boolean, limit?: number, offset?: number }}
+ */
+export function getPaginationParams(req) {
+  const { searchParams } = req.url;
+  const hasParams = searchParams.has('limit') || searchParams.has('offset');
+  if (!hasParams) {
+    return {};
+  }
+
+  const result = { hasParams: true };
+
+  const limitStr = searchParams.get('limit');
+  if (limitStr !== null) {
+    const limit = parseInt(limitStr, 10);
+    if (!Number.isNaN(limit) && limit >= 0) {
+      result.limit = limit;
+    }
+  }
+
+  const offsetStr = searchParams.get('offset');
+  if (offsetStr !== null) {
+    const offset = parseInt(offsetStr, 10);
+    if (!Number.isNaN(offset) && offset >= 0) {
+      result.offset = offset;
+    }
+  }
+
+  return result;
+}