@adobe/spacecat-shared-tokowaka-client 1.3.1 → 1.4.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-tokowaka-client-v1.4.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tokowaka-client-v1.3.2...@adobe/spacecat-shared-tokowaka-client-v1.4.0) (2025-12-11)
+
+
+### Features
+
+* Generic mapper hast ([#1236](https://github.com/adobe/spacecat-shared/issues/1236)) ([9791ca6](https://github.com/adobe/spacecat-shared/commit/9791ca6fd2b7a5880ac0ca99897da87631bbc25a))
+
+# [@adobe/spacecat-shared-tokowaka-client-v1.3.2](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tokowaka-client-v1.3.1...@adobe/spacecat-shared-tokowaka-client-v1.3.2) (2025-12-11)
+
+
+### Bug Fixes
+
+* tokowaka url header for preview ([#1235](https://github.com/adobe/spacecat-shared/issues/1235)) ([f265db8](https://github.com/adobe/spacecat-shared/commit/f265db821a9ea54809850e7fc771fdf3554f324f))
+
 # [@adobe/spacecat-shared-tokowaka-client-v1.3.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tokowaka-client-v1.3.0...@adobe/spacecat-shared-tokowaka-client-v1.3.1) (2025-12-10)
 
 

package/package.json

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

package/src/mappers/generic-mapper.js

@@ -57,7 +57,7 @@ export default class GenericMapper extends BaseOpportunityMapper {
         ...this.createBasePatch(suggestion, opportunityId),
         op: transformRules.action,
         selector: transformRules.selector,
-        value: data.patchValue,
+        value: data.format === 'hast' ? JSON.parse(data.patchValue) : data.patchValue,
         valueFormat: data.format || 'text',
         target: TARGET_USER_AGENTS_CATEGORIES.AI_BOTS,
       };

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

@@ -138,14 +138,8 @@ export async function fetchHtmlWithWarmup(
 
   // Parse the URL to extract path and construct full URL
   const urlObj = new URL(url);
-  const urlPath = urlObj.pathname + urlObj.search;
-
-  // Add tokowakaPreview param for optimized HTML
+  const urlPath = urlObj.pathname;
   let fullUrl = `${tokowakaEdgeUrl}${urlPath}`;
-  if (isOptimized) {
-    const separator = urlPath.includes('?') ? '&' : '?';
-    fullUrl = `${fullUrl}${separator}tokowakaPreview=true`;
-  }
 
   const headers = {
     'x-forwarded-host': forwardedHost,
@@ -153,6 +147,12 @@ export async function fetchHtmlWithWarmup(
     'x-tokowaka-url': urlPath,
   };
 
+  if (isOptimized) {
+    // Add tokowakaPreview param for optimized HTML
+    fullUrl = `${fullUrl}?tokowakaPreview=true`;
+    headers['x-tokowaka-url'] = `${urlPath}?tokowakaPreview=true`;
+  }
+
   const fetchOptions = {
     method: 'GET',
     headers,

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

@@ -586,7 +586,6 @@ describe('GenericMapper', () => {
             selector: '#selector',
           },
           patchValue: 'Content with tag',
-          format: 'hast',
           tag: 'div',
           url: 'https://example.com/page',
         }),
@@ -601,7 +600,7 @@ describe('GenericMapper', () => {
         op: 'insertAfter',
         selector: '#selector',
         value: 'Content with tag',
-        valueFormat: 'hast',
+        valueFormat: 'text',
         tag: 'div',
         opportunityId: 'opp-tag',
         suggestionId: 'sugg-with-tag',
@@ -633,6 +632,60 @@ describe('GenericMapper', () => {
       expect(patch.valueFormat).to.equal('text');
     });
 
+    it('should parse JSON patchValue when format is hast', () => {
+      const hastValue = {
+        type: 'element',
+        tagName: 'div',
+        properties: { className: ['test-class'] },
+        children: [{ type: 'text', value: 'Test content' }],
+      };
+
+      const suggestion = {
+        getId: () => 'sugg-hast-json',
+        getUpdatedAt: () => '2025-01-15T10:00:00.000Z',
+        getData: () => ({
+          transformRules: {
+            action: 'insertAfter',
+            selector: '#selector',
+          },
+          patchValue: JSON.stringify(hastValue),
+          format: 'hast',
+          url: 'https://example.com/page',
+        }),
+      };
+
+      const patches = mapper.suggestionsToPatches('/page', [suggestion], 'opp-hast');
+
+      expect(patches.length).to.equal(1);
+      const patch = patches[0];
+
+      expect(patch.value).to.deep.equal(hastValue);
+      expect(patch.valueFormat).to.equal('hast');
+    });
+
+    it('should use raw patchValue when format is not hast', () => {
+      const suggestion = {
+        getId: () => 'sugg-text',
+        getUpdatedAt: () => '2025-01-15T10:00:00.000Z',
+        getData: () => ({
+          transformRules: {
+            action: 'insertAfter',
+            selector: '#selector',
+          },
+          patchValue: 'Plain text content',
+          url: 'https://example.com/page',
+        }),
+      };
+
+      const patches = mapper.suggestionsToPatches('/page', [suggestion], 'opp-text');
+
+      expect(patches.length).to.equal(1);
+      const patch = patches[0];
+
+      expect(patch.value).to.equal('Plain text content');
+      expect(patch.valueFormat).to.equal('text');
+    });
+
     it('should not include UI-only fields in patch', () => {
       const suggestion = {
         getId: () => 'sugg-ui',

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

@@ -123,7 +123,7 @@ describe('HTML Utils', () => {
       expect(fetchStub.callCount).to.equal(2); // warmup + actual
     });
 
-    it('should handle URL with existing query parameters when fetching optimized HTML', async () => {
+    it('should drop query parameters from URL when fetching optimized HTML', async () => {
       fetchStub.resolves({
         ok: true,
         status: 200,
@@ -147,11 +147,11 @@ describe('HTML Utils', () => {
       expect(html).to.equal('<html>Optimized HTML</html>');
       expect(fetchStub.callCount).to.equal(2); // warmup + actual
 
-      // Verify the URL includes & for the preview param (not ?)
+      // Verify original query params are dropped and only tokowakaPreview is present
       const actualUrl = fetchStub.secondCall.args[0];
-      expect(actualUrl).to.include('param=value');
-      expect(actualUrl).to.include('&tokowakaPreview=true');
-      expect(actualUrl).to.not.include('?tokowakaPreview=true');
+      expect(actualUrl).to.not.include('param=value');
+      expect(actualUrl).to.include('?tokowakaPreview=true');
+      expect(actualUrl).to.equal('https://edge.example.com/page?tokowakaPreview=true');
     });
 
     it('should throw error when HTTP response is not ok', async () => {