@dylandepass/helix-product-pipeline 2.2.0 → 2.4.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [2.4.0](https://github.com/adobe-rnd/helix-product-pipeline/compare/v2.3.0...v2.4.0) (2026-03-09)
+
+
+### Features
+
+* append optional image filenames in HTML and JSON pipeline output ([#72](https://github.com/adobe-rnd/helix-product-pipeline/issues/72)) ([c87e79c](https://github.com/adobe-rnd/helix-product-pipeline/commit/c87e79c9d74cf045135fd3b8049e7c31e1c9e175))
+
+# [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.4.0",
   "description": "Helix Product Pipeline",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -47,7 +47,7 @@
   "dependencies": {
     "@adobe/helix-html-pipeline": "6.27.9",
     "@adobe/helix-shared-utils": "3.0.2",
-    "@dylandepass/helix-product-shared": "1.5.2",
+    "@dylandepass/helix-product-shared": "1.6.0",
     "dayjs": "1.11.19",
     "github-slugger": "2.0.0",
     "hast-util-from-html": "^2.0.3",

package/src/product-html-pipe.js

@@ -16,6 +16,7 @@ import addHeadingIds from './steps/add-heading-ids.js';
 import { getPathInfo, validatePathInfo } from './utils/path.js';
 import initConfig from './steps/init-config.js';
 import fetchProductBusContent from './steps/fetch-productbus.js';
+import transformImages from './steps/transform-images.js';
 import fetchEdgeContent from './steps/fetch-edge-product.js';
 import { setLastModified } from './utils/last-modified.js';
 import html from './steps/make-html.js';
@@ -71,6 +72,7 @@ export async function productHTMLPipe(state, req) {
       return res;
     }
 
+    transformImages(state);
     state.timer?.update('render');
     await html(state);
 

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/product-json-pipe.js

@@ -15,6 +15,7 @@ import { cleanupHeaderValue } from '@adobe/helix-shared-utils';
 import { validatePathInfo } from './utils/path.js';
 import initConfig from './steps/init-config.js';
 import fetchProductBusContent from './steps/fetch-productbus.js';
+import transformImages from './steps/transform-images.js';
 import { setLastModified } from './utils/last-modified.js';
 import { set404CacheHeaders, setProductCacheHeaders } from './steps/set-cache-headers.js';
 
@@ -60,6 +61,8 @@ export async function productJSONPipe(state, req) {
       throw new PipelineStatusError(res.status, res.error);
     }
 
+    transformImages(state);
+
     // set surrogate keys
     await setProductCacheHeaders(state, req, res);
 

package/src/steps/create-pictures.js

@@ -55,9 +55,8 @@ export function createOptimizedPicture(src, alt = '', title = undefined) {
     height = props.get('height');
   }
 
-  // Extract filename and check if it starts with 'media_'
-  const filename = pathname.substring(pathname.lastIndexOf('/') + 1);
-  const isMediaBusFile = filename.startsWith('media_');
+  // Matches media bus URLs: /media_{sha1hash}.ext or /media_{sha1hash}/filename.ext
+  const isMediaBusFile = /^\/media_[a-f0-9]+(?:\/[^/]+)?\.[a-z0-9]+$/i.test(pathname);
 
   // If not a media file, return a simple picture with just an img tag (no optimization)
   if (!isMediaBusFile) {

package/src/steps/transform-images.js

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2026 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import { appendFilenameToMediaUrl } from '@dylandepass/helix-product-shared';
+
+function transformImage(image) {
+  if (!image || typeof image !== 'object') {
+    return;
+  }
+  image.url = appendFilenameToMediaUrl(image.url, image.filename);
+}
+
+export default function transformImages(state) {
+  const data = state?.content?.data;
+  if (!data || typeof data !== 'object') {
+    return;
+  }
+
+  if (Array.isArray(data.images)) {
+    data.images.forEach(transformImage);
+  }
+  if (Array.isArray(data.variants)) {
+    data.variants.forEach((variant) => (variant?.images || []).forEach(transformImage));
+  }
+}

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;
+}