@adobe/spacecat-shared-tokowaka-client 1.5.6 → 1.5.8

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-tokowaka-client-v1.5.8](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tokowaka-client-v1.5.7...@adobe/spacecat-shared-tokowaka-client-v1.5.8) (2026-01-27)
+
+
+### Bug Fixes
+
+* rename x-edge-optimize to x-edgeoptimize ([#1284](https://github.com/adobe/spacecat-shared/issues/1284)) ([63ba2ac](https://github.com/adobe/spacecat-shared/commit/63ba2ac9141612a5f581b0162cb1b30343c5980c))
+
+# [@adobe/spacecat-shared-tokowaka-client-v1.5.7](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tokowaka-client-v1.5.6...@adobe/spacecat-shared-tokowaka-client-v1.5.7) (2026-01-22)
+
+
+### Bug Fixes
+
+* headings mapper for invalid headings ([#1281](https://github.com/adobe/spacecat-shared/issues/1281)) ([01734df](https://github.com/adobe/spacecat-shared/commit/01734df0de2f9d43bb6c2ee0636449c26d336ca7))
+
 # [@adobe/spacecat-shared-tokowaka-client-v1.5.6](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tokowaka-client-v1.5.5...@adobe/spacecat-shared-tokowaka-client-v1.5.6) (2026-01-22)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-tokowaka-client",
-  "version": "1.5.6",
+  "version": "1.5.8",
   "description": "Tokowaka Client for SpaceCat - Edge optimization config management",
   "type": "module",
   "engines": {

package/src/mappers/headings-mapper.js

@@ -67,6 +67,10 @@ export default class HeadingsMapper extends BaseOpportunityMapper {
         patch.tag = transformRules.tag;
       }
 
+      if (checkType === 'heading-order-invalid') {
+        patch.value = transformRules.value;
+        patch.valueFormat = transformRules.valueFormat;
+      }
       patches.push(patch);
     });
 

package/src/utils/custom-html-utils.js

@@ -52,14 +52,14 @@ async function fetchWithRetry(url, options, maxRetries, retryDelayMs, log, fetch
       }
 
       // Check for edge optimize headers
-      const cacheHeader = response.headers.get('x-edge-optimize-cache');
-      const proxyHeader = response.headers.get('x-edge-optimize-proxy');
+      const cacheHeader = response.headers.get('x-edgeoptimize-cache');
+      const proxyHeader = response.headers.get('x-edgeoptimize-proxy');
 
       log.debug(`Headers - cache: ${cacheHeader || 'none'}, proxy: ${proxyHeader || 'none'}`);
 
       // Case 1: Cache header present (regardless of proxy) -> Success
       if (cacheHeader) {
-        log.debug(`Cache header found (x-edge-optimize-cache: ${cacheHeader}), stopping retry logic`);
+        log.debug(`Cache header found (x-edgeoptimize-cache: ${cacheHeader}), stopping retry logic`);
         return response;
       }
 
@@ -80,7 +80,7 @@ async function fetchWithRetry(url, options, maxRetries, retryDelayMs, log, fetch
       } else {
         // Last attempt - throw error
         log.error(`Max retries (${maxRetries}) exhausted. Proxy header present but cache header not found`);
-        throw new Error(`Cache header (x-edge-optimize-cache) not found after ${maxRetries} retries`);
+        throw new Error(`Cache header (x-edgeoptimize-cache) not found after ${maxRetries} retries`);
       }
     } catch (error) {
       log.warn(`Attempt ${attempt} failed for ${fetchType} HTML, error: ${error.message}`);
@@ -158,15 +158,15 @@ export async function fetchHtmlWithWarmup(
 
   const headers = {
     'x-forwarded-host': forwardedHost,
-    'x-edge-optimize-api-key': apiKey,
-    'x-edge-optimize-url': urlPath,
+    'x-edgeoptimize-api-key': apiKey,
+    'x-edgeoptimize-url': urlPath,
     'Accept-Encoding': 'identity', // Disable compression to avoid content-length: 0 issue
   };
 
   if (isOptimized) {
     // Add tokowakaPreview param for optimized HTML
     fullUrl = `${fullUrl}?tokowakaPreview=true`;
-    headers['x-edge-optimize-url'] = `${urlPath}?tokowakaPreview=true`;
+    headers['x-edgeoptimize-url'] = `${urlPath}?tokowakaPreview=true`;
   }
 
   const fetchOptions = {

package/test/index.test.js

@@ -2692,7 +2692,7 @@ describe('TokowakaClient', () => {
         status: 200,
         statusText: 'OK',
         headers: {
-          get: (name) => (name === 'x-edge-optimize-cache' ? 'HIT' : null),
+          get: (name) => (name === 'x-edgeoptimize-cache' ? 'HIT' : null),
         },
         text: async () => '<html><body>Test HTML</body></html>',
       });

package/test/mappers/headings-mapper.test.js

@@ -98,11 +98,12 @@ describe('HeadingsMapper', () => {
       const suggestion = {
         getData: () => ({
           checkType: 'heading-order-invalid',
-          recommendedAction: { type: 'element', tagName: 'h2', children: [] },
+          recommendedAction: 'Adjust heading levels to maintain proper hierarchy.',
           transformRules: {
             action: 'replaceWith',
             selector: '.invalid-section',
             valueFormat: 'hast',
+            value: { type: 'element', tagName: 'h2', children: [] },
           },
         }),
       };
@@ -254,11 +255,12 @@ describe('HeadingsMapper', () => {
       const suggestion = {
         getData: () => ({
           checkType: 'heading-order-invalid',
-          recommendedAction: { type: 'element', tagName: 'h2', children: [] },
+          recommendedAction: 'Adjust heading levels to maintain proper hierarchy.',
           transformRules: {
             action: 'replace',
             selector: '.invalid-section',
             valueFormat: 'hast',
+            value: { type: 'element', tagName: 'h2', children: [] },
           },
         }),
       };
@@ -275,10 +277,11 @@ describe('HeadingsMapper', () => {
       const suggestion = {
         getData: () => ({
           checkType: 'heading-order-invalid',
-          recommendedAction: { type: 'element', tagName: 'h2', children: [] },
+          recommendedAction: 'Adjust heading levels to maintain proper hierarchy.',
           transformRules: {
             action: 'replaceWith',
             selector: '.invalid-section',
+            value: { type: 'element', tagName: 'h2', children: [] },
           },
         }),
       };
@@ -295,11 +298,12 @@ describe('HeadingsMapper', () => {
       const suggestion = {
         getData: () => ({
           checkType: 'heading-order-invalid',
-          recommendedAction: { type: 'element', tagName: 'h2', children: [] },
+          recommendedAction: 'Adjust heading levels to maintain proper hierarchy.',
           transformRules: {
             action: 'replaceWith',
             selector: '.invalid-section',
             valueFormat: 'text',
+            value: { type: 'element', tagName: 'h2', children: [] },
           },
         }),
       };
@@ -447,11 +451,12 @@ describe('HeadingsMapper', () => {
         getUpdatedAt: () => '2025-01-15T10:00:00.000Z',
         getData: () => ({
           checkType: 'heading-order-invalid',
-          recommendedAction: hastValue,
+          recommendedAction: 'Adjust heading levels to maintain proper hierarchy.',
           transformRules: {
             action: 'replaceWith',
             selector: '.content-section',
             valueFormat: 'hast',
+            value: hastValue,
           },
         }),
       };
@@ -464,6 +469,7 @@ describe('HeadingsMapper', () => {
         op: 'replaceWith',
         selector: '.content-section',
         value: hastValue,
+        valueFormat: 'hast',
         opportunityId: 'opp-101',
         suggestionId: 'sugg-101',
         prerenderRequired: true,
@@ -477,7 +483,7 @@ describe('HeadingsMapper', () => {
         getId: () => 'sugg-102',
         getData: () => ({
           checkType: 'heading-order-invalid',
-          recommendedAction: { type: 'element', tagName: 'h2', children: [] },
+          recommendedAction: 'Adjust heading levels to maintain proper hierarchy.',
         }),
       };
 
@@ -490,11 +496,12 @@ describe('HeadingsMapper', () => {
         getId: () => 'sugg-103',
         getData: () => ({
           checkType: 'heading-order-invalid',
-          recommendedAction: { type: 'element', tagName: 'h2', children: [] },
+          recommendedAction: 'Adjust heading levels to maintain proper hierarchy.',
           transformRules: {
             action: 'replace',
             selector: '.content-section',
             valueFormat: 'hast',
+            value: { type: 'element', tagName: 'h2', children: [] },
           },
         }),
       };
@@ -503,6 +510,233 @@ describe('HeadingsMapper', () => {
       expect(patches.length).to.equal(0);
     });
 
+    it('should create patch for heading-order-invalid with real-world HAST structure', () => {
+      const hastValue = {
+        type: 'root',
+        children: [
+          {
+            type: 'element',
+            tagName: 'h2',
+            children: [
+              {
+                type: 'text',
+                value: 'Complete Cover Sets',
+              },
+            ],
+            properties: {},
+          },
+        ],
+      };
+
+      const suggestion = {
+        getId: () => 'sugg-104',
+        getUpdatedAt: () => '2026-01-03T06:24:06.229Z',
+        getData: () => ({
+          checkType: 'heading-order-invalid',
+          recommendedAction: 'Adjust heading levels to maintain proper hierarchy.',
+          transformRules: {
+            action: 'replaceWith',
+            selector: 'h4#complete-cover-sets',
+            valueFormat: 'hast',
+            value: hastValue,
+            scrapedAt: '2026-01-03T06:24:06.229Z',
+            currValue: 'Complete Cover Sets',
+          },
+        }),
+      };
+
+      const patches = mapper.suggestionsToPatches('/path', [suggestion], 'opp-104');
+      expect(patches.length).to.equal(1);
+      const patch = patches[0];
+
+      expect(patch).to.deep.include({
+        op: 'replaceWith',
+        selector: 'h4#complete-cover-sets',
+        value: hastValue,
+        valueFormat: 'hast',
+        opportunityId: 'opp-104',
+        suggestionId: 'sugg-104',
+        prerenderRequired: true,
+      });
+      expect(patch.lastUpdated).to.be.a('number');
+    });
+
+    it('should create patch for heading-order-invalid with complex selector', () => {
+      const hastValue = {
+        type: 'root',
+        children: [
+          {
+            type: 'element',
+            tagName: 'h3',
+            properties: { id: 'section-title' },
+            children: [{ type: 'text', value: 'Updated Section' }],
+          },
+        ],
+      };
+
+      const suggestion = {
+        getId: () => 'sugg-105',
+        getUpdatedAt: () => '2025-01-15T10:00:00.000Z',
+        getData: () => ({
+          checkType: 'heading-order-invalid',
+          recommendedAction: 'Fix heading hierarchy from h5 to h3.',
+          transformRules: {
+            action: 'replaceWith',
+            selector: 'body > main > section:nth-child(2) > h5',
+            valueFormat: 'hast',
+            value: hastValue,
+          },
+        }),
+      };
+
+      const patches = mapper.suggestionsToPatches('/path', [suggestion], 'opp-105');
+      expect(patches.length).to.equal(1);
+      const patch = patches[0];
+
+      expect(patch.selector).to.equal('body > main > section:nth-child(2) > h5');
+      expect(patch.value).to.deep.equal(hastValue);
+      expect(patch.valueFormat).to.equal('hast');
+    });
+
+    it('should handle multiple heading-order-invalid suggestions', () => {
+      const suggestions = [
+        {
+          getId: () => 'sugg-106',
+          getUpdatedAt: () => '2025-01-15T10:00:00.000Z',
+          getData: () => ({
+            checkType: 'heading-order-invalid',
+            recommendedAction: 'Fix heading hierarchy.',
+            transformRules: {
+              action: 'replaceWith',
+              selector: 'h4.title',
+              valueFormat: 'hast',
+              value: {
+                type: 'root',
+                children: [
+                  {
+                    type: 'element',
+                    tagName: 'h2',
+                    properties: { class: 'title' },
+                    children: [{ type: 'text', value: 'Title 1' }],
+                  },
+                ],
+              },
+            },
+          }),
+        },
+        {
+          getId: () => 'sugg-107',
+          getUpdatedAt: () => '2025-01-15T10:00:00.000Z',
+          getData: () => ({
+            checkType: 'heading-order-invalid',
+            recommendedAction: 'Fix another heading.',
+            transformRules: {
+              action: 'replaceWith',
+              selector: 'h5.subtitle',
+              valueFormat: 'hast',
+              value: {
+                type: 'root',
+                children: [
+                  {
+                    type: 'element',
+                    tagName: 'h3',
+                    properties: { class: 'subtitle' },
+                    children: [{ type: 'text', value: 'Subtitle' }],
+                  },
+                ],
+              },
+            },
+          }),
+        },
+      ];
+
+      const patches = mapper.suggestionsToPatches('/path', suggestions, 'opp-106');
+      expect(patches.length).to.equal(2);
+      expect(patches[0].selector).to.equal('h4.title');
+      expect(patches[1].selector).to.equal('h5.subtitle');
+      expect(patches[0].valueFormat).to.equal('hast');
+      expect(patches[1].valueFormat).to.equal('hast');
+    });
+
+    it('should not use text valueFormat for heading-order-invalid', () => {
+      const hastValue = {
+        type: 'root',
+        children: [
+          { type: 'element', tagName: 'h2', children: [{ type: 'text', value: 'Heading' }] },
+        ],
+      };
+
+      const suggestion = {
+        getId: () => 'sugg-108',
+        getUpdatedAt: () => '2025-01-15T10:00:00.000Z',
+        getData: () => ({
+          checkType: 'heading-order-invalid',
+          recommendedAction: 'Fix heading hierarchy.',
+          transformRules: {
+            action: 'replaceWith',
+            selector: 'h4',
+            valueFormat: 'hast',
+            value: hastValue,
+          },
+        }),
+      };
+
+      const patches = mapper.suggestionsToPatches('/path', [suggestion], 'opp-108');
+      expect(patches.length).to.equal(1);
+      const patch = patches[0];
+
+      // Verify it uses HAST format, not text
+      expect(patch.valueFormat).to.equal('hast');
+      expect(patch.value).to.be.an('object');
+      expect(patch.value).to.deep.equal(hastValue);
+    });
+
+    it('should include currValue when currentValue is not null for heading-empty', () => {
+      const suggestion = {
+        getId: () => 'sugg-109',
+        getUpdatedAt: () => '2025-01-15T10:00:00.000Z',
+        getData: () => ({
+          checkType: 'heading-empty',
+          recommendedAction: 'New Heading Text',
+          currentValue: 'Old Heading',
+          transformRules: {
+            action: 'replace',
+            selector: 'h2.empty',
+          },
+        }),
+      };
+
+      const patches = mapper.suggestionsToPatches('/path', [suggestion], 'opp-109');
+      expect(patches.length).to.equal(1);
+      const patch = patches[0];
+
+      expect(patch.currValue).to.equal('Old Heading');
+      expect(patch.value).to.equal('New Heading Text');
+    });
+
+    it('should not include currValue when currentValue is null', () => {
+      const suggestion = {
+        getId: () => 'sugg-110',
+        getUpdatedAt: () => '2025-01-15T10:00:00.000Z',
+        getData: () => ({
+          checkType: 'heading-empty',
+          recommendedAction: 'New Heading Text',
+          currentValue: null,
+          transformRules: {
+            action: 'replace',
+            selector: 'h2.empty',
+          },
+        }),
+      };
+
+      const patches = mapper.suggestionsToPatches('/path', [suggestion], 'opp-110');
+      expect(patches.length).to.equal(1);
+      const patch = patches[0];
+
+      expect(patch.currValue).to.be.undefined;
+      expect(patch.value).to.equal('New Heading Text');
+    });
+
     it('should return empty array for heading-missing-h1 without transformRules', () => {
       const suggestion = {
         getId: () => 'sugg-999',

package/test/utils/html-utils.test.js

@@ -104,7 +104,7 @@ describe('HTML Utils', () => {
         status: 200,
         statusText: 'OK',
         headers: {
-          get: (name) => (name === 'x-edge-optimize-cache' ? 'HIT' : null),
+          get: (name) => (name === 'x-edgeoptimize-cache' ? 'HIT' : null),
         },
         text: async () => '<html>Test HTML</html>',
       });
@@ -129,7 +129,7 @@ describe('HTML Utils', () => {
         status: 200,
         statusText: 'OK',
         headers: {
-          get: (name) => (name === 'x-edge-optimize-cache' ? 'HIT' : null),
+          get: (name) => (name === 'x-edgeoptimize-cache' ? 'HIT' : null),
         },
         text: async () => '<html>Optimized HTML</html>',
       });
@@ -208,7 +208,7 @@ describe('HTML Utils', () => {
         status: 200,
         statusText: 'OK',
         headers: {
-          get: (name) => (name === 'x-edge-optimize-proxy' ? 'true' : null),
+          get: (name) => (name === 'x-edgeoptimize-proxy' ? 'true' : null),
         },
         text: async () => '<html>Proxy only 1</html>',
       });
@@ -217,7 +217,7 @@ describe('HTML Utils', () => {
         status: 200,
         statusText: 'OK',
         headers: {
-          get: (name) => (name === 'x-edge-optimize-proxy' ? 'true' : null),
+          get: (name) => (name === 'x-edgeoptimize-proxy' ? 'true' : null),
         },
         text: async () => '<html>Proxy only 2</html>',
       });
@@ -226,7 +226,7 @@ describe('HTML Utils', () => {
         status: 200,
         statusText: 'OK',
         headers: {
-          get: (name) => (name === 'x-edge-optimize-proxy' ? 'true' : null),
+          get: (name) => (name === 'x-edgeoptimize-proxy' ? 'true' : null),
         },
         text: async () => '<html>Proxy only 3</html>',
       });
@@ -244,7 +244,7 @@ describe('HTML Utils', () => {
         expect.fail('Should have thrown error');
       } catch (error) {
         expect(error.message).to.include('Failed to fetch optimized HTML');
-        expect(error.message).to.include('Cache header (x-edge-optimize-cache) not found after 2 retries');
+        expect(error.message).to.include('Cache header (x-edgeoptimize-cache) not found after 2 retries');
       }
 
       // Should have tried 3 times (initial + 2 retries) plus warmup
@@ -268,7 +268,7 @@ describe('HTML Utils', () => {
         status: 200,
         statusText: 'OK',
         headers: {
-          get: (name) => (name === 'x-edge-optimize-proxy' ? 'true' : null),
+          get: (name) => (name === 'x-edgeoptimize-proxy' ? 'true' : null),
         },
         text: async () => '<html>Proxy only</html>',
       });
@@ -278,7 +278,7 @@ describe('HTML Utils', () => {
         status: 200,
         statusText: 'OK',
         headers: {
-          get: (name) => (name === 'x-edge-optimize-cache' ? 'HIT' : null),
+          get: (name) => (name === 'x-edgeoptimize-cache' ? 'HIT' : null),
         },
         text: async () => '<html>Cached HTML</html>',
       });
@@ -483,7 +483,7 @@ describe('HTML Utils', () => {
         status: 200,
         statusText: 'OK',
         headers: {
-          get: (name) => (name === 'x-edge-optimize-proxy' ? 'true' : null),
+          get: (name) => (name === 'x-edgeoptimize-proxy' ? 'true' : null),
         },
         text: async () => '<html>Proxy only</html>',
       });
@@ -494,8 +494,8 @@ describe('HTML Utils', () => {
         statusText: 'OK',
         headers: {
           get: (name) => {
-            if (name === 'x-edge-optimize-cache') return 'HIT';
-            if (name === 'x-edge-optimize-proxy') return 'true';
+            if (name === 'x-edgeoptimize-cache') return 'HIT';
+            if (name === 'x-edgeoptimize-proxy') return 'true';
             return null;
           },
         },
@@ -534,7 +534,7 @@ describe('HTML Utils', () => {
         status: 200,
         statusText: 'OK',
         headers: {
-          get: (name) => (name === 'x-edge-optimize-proxy' ? 'true' : null),
+          get: (name) => (name === 'x-edgeoptimize-proxy' ? 'true' : null),
         },
         text: async () => '<html>Proxy only 1</html>',
       });
@@ -543,7 +543,7 @@ describe('HTML Utils', () => {
         status: 200,
         statusText: 'OK',
         headers: {
-          get: (name) => (name === 'x-edge-optimize-proxy' ? 'true' : null),
+          get: (name) => (name === 'x-edgeoptimize-proxy' ? 'true' : null),
         },
         text: async () => '<html>Proxy only 2</html>',
       });
@@ -552,7 +552,7 @@ describe('HTML Utils', () => {
         status: 200,
         statusText: 'OK',
         headers: {
-          get: (name) => (name === 'x-edge-optimize-proxy' ? 'true' : null),
+          get: (name) => (name === 'x-edgeoptimize-proxy' ? 'true' : null),
         },
         text: async () => '<html>Proxy only 3</html>',
       });
@@ -570,7 +570,7 @@ describe('HTML Utils', () => {
         expect.fail('Should have thrown error');
       } catch (error) {
         expect(error.message).to.include('Failed to fetch original HTML');
-        expect(error.message).to.include('Cache header (x-edge-optimize-cache) not found after 2 retries');
+        expect(error.message).to.include('Cache header (x-edgeoptimize-cache) not found after 2 retries');
       }
 
       // Should have tried 3 times (initial + 2 retries) plus warmup
@@ -594,7 +594,7 @@ describe('HTML Utils', () => {
         status: 200,
         statusText: 'OK',
         headers: {
-          get: (name) => (name === 'x-edge-optimize-cache' ? 'HIT' : null),
+          get: (name) => (name === 'x-edgeoptimize-cache' ? 'HIT' : null),
         },
         text: async () => '<html>Cached HTML</html>',
       });
@@ -632,8 +632,8 @@ describe('HTML Utils', () => {
         statusText: 'OK',
         headers: {
           get: (name) => {
-            if (name === 'x-edge-optimize-cache') return 'HIT';
-            if (name === 'x-edge-optimize-proxy') return 'true';
+            if (name === 'x-edgeoptimize-cache') return 'HIT';
+            if (name === 'x-edgeoptimize-proxy') return 'true';
             return null;
           },
         },
@@ -672,7 +672,7 @@ describe('HTML Utils', () => {
         status: 200,
         statusText: 'OK',
         headers: {
-          get: (name) => (name === 'x-edge-optimize-cache' ? 'HIT' : null),
+          get: (name) => (name === 'x-edgeoptimize-cache' ? 'HIT' : null),
         },
         text: async () => '<html>Cache only HTML</html>',
       });