@adobe/spacecat-shared-tokowaka-client 1.10.1 → 1.11.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [@adobe/spacecat-shared-tokowaka-client-v1.11.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tokowaka-client-v1.10.2...@adobe/spacecat-shared-tokowaka-client-v1.11.0) (2026-03-10)
+
+### Features
+
+* **tokowaka-client:** add HTML-to-HAST converter to generic mapper ([#1416](https://github.com/adobe/spacecat-shared/issues/1416)) ([510ce3b](https://github.com/adobe/spacecat-shared/commit/510ce3b267d0b68011b677e8e493a56aaaeebb87))
+
+## [@adobe/spacecat-shared-tokowaka-client-v1.10.2](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tokowaka-client-v1.10.1...@adobe/spacecat-shared-tokowaka-client-v1.10.2) (2026-03-07)
+
+### Bug Fixes
+
+* **deps:** update external fixes ([#1410](https://github.com/adobe/spacecat-shared/issues/1410)) ([e5b5634](https://github.com/adobe/spacecat-shared/commit/e5b5634f788a8f440ef49218c0b2fa1ccb42fb8a))
+
 ## [@adobe/spacecat-shared-tokowaka-client-v1.10.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tokowaka-client-v1.10.0...@adobe/spacecat-shared-tokowaka-client-v1.10.1) (2026-03-02)
 
 ### Bug Fixes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-tokowaka-client",
-  "version": "1.10.1",
+  "version": "1.11.0",
   "description": "Tokowaka Client for SpaceCat - Edge optimization config management",
   "type": "module",
   "engines": {
@@ -35,8 +35,8 @@
   },
   "dependencies": {
     "@adobe/spacecat-shared-utils": "1.81.1",
-    "@aws-sdk/client-cloudfront": "3.1000.0",
-    "@aws-sdk/client-s3": "3.1000.0",
+    "@aws-sdk/client-cloudfront": "3.1004.0",
+    "@aws-sdk/client-s3": "3.1004.0",
     "hast-util-from-html": "2.0.3",
     "mdast-util-from-markdown": "2.0.3",
     "mdast-util-to-hast": "13.2.1",

package/src/mappers/commerce-page-enrichment-mapper.js

@@ -14,50 +14,18 @@ import { hasText } from '@adobe/spacecat-shared-utils';
 import { TARGET_USER_AGENTS_CATEGORIES } from '../constants.js';
 import BaseOpportunityMapper from './base-mapper.js';
 
-const SCHEMA_ORG_DIRECT_FIELDS = {
-  sku: 'sku',
-  name: 'name',
-  material: 'material',
-  category: 'category',
-  color_family: 'color',
-  'pdp.description_plain': 'description',
-};
-
 const EXCLUDED_FIELDS = new Set([
   'rationale',
 ]);
 
-function toJsonLd(enrichmentData) {
-  const jsonLd = {
-    '@context': 'https://schema.org',
-    '@type': 'Product',
-  };
-
-  const additionalProperties = [];
-
+function filterEnrichmentData(enrichmentData) {
+  const filtered = {};
   for (const [key, value] of Object.entries(enrichmentData)) {
     if (!EXCLUDED_FIELDS.has(key) && value != null) {
-      if (key === 'brand' && typeof value === 'string') {
-        jsonLd.brand = { '@type': 'Brand', name: value };
-      } else if (key === 'facts.facets.category_path' && Array.isArray(value)) {
-        jsonLd.category = value.join(' > ');
-      } else if (SCHEMA_ORG_DIRECT_FIELDS[key]) {
-        jsonLd[SCHEMA_ORG_DIRECT_FIELDS[key]] = value;
-      } else {
-        additionalProperties.push({
-          '@type': 'PropertyValue',
-          name: key,
-          value,
-        });
-      }
+      filtered[key] = value;
     }
   }
-
-  if (additionalProperties.length > 0) {
-    jsonLd.additionalProperty = additionalProperties;
-  }
-
-  return jsonLd;
+  return filtered;
 }
 
 export default class CommercePageEnrichmentMapper extends BaseOpportunityMapper {
@@ -108,18 +76,17 @@ export default class CommercePageEnrichmentMapper extends BaseOpportunityMapper
 
       const data = suggestion.getData();
       const enrichmentData = JSON.parse(data.patchValue);
-
-      const jsonLd = toJsonLd(enrichmentData);
+      const value = filterEnrichmentData(enrichmentData);
 
       patches.push({
         ...this.createBasePatch(suggestion, opportunityId),
         op: 'appendChild',
         selector: 'head',
-        value: jsonLd,
+        value,
         valueFormat: 'json',
         target: TARGET_USER_AGENTS_CATEGORIES.AI_BOTS,
         tag: 'script',
-        attrs: { type: 'application/ld+json' },
+        attrs: { type: 'application/json' },
       });
     });
 

package/src/mappers/generic-mapper.js

@@ -12,6 +12,7 @@
 
 import { hasText } from '@adobe/spacecat-shared-utils';
 import { TARGET_USER_AGENTS_CATEGORIES } from '../constants.js';
+import { htmlToHast } from '../utils/html-utils.js';
 import BaseOpportunityMapper from './base-mapper.js';
 
 /**
@@ -33,6 +34,13 @@ export default class GenericMapper extends BaseOpportunityMapper {
     return this.prerenderRequired;
   }
 
+  // eslint-disable-next-line class-methods-use-this
+  #resolveValue(data) {
+    if (data.format === 'html') return htmlToHast(data.patchValue);
+    if (data.format === 'hast' || data.format === 'json') return JSON.parse(data.patchValue);
+    return data.patchValue;
+  }
+
   /**
    * Converts suggestions to Tokowaka patches
    * @param {string} urlPath - URL path for the suggestions
@@ -53,12 +61,15 @@ export default class GenericMapper extends BaseOpportunityMapper {
       const data = suggestion.getData();
       const { transformRules } = data;
 
+      const value = this.#resolveValue(data);
+      const valueFormat = data.format === 'html' ? 'hast' : (data.format || 'text');
+
       const patch = {
         ...this.createBasePatch(suggestion, opportunityId),
         op: transformRules.action,
         selector: transformRules.selector,
-        value: (data.format === 'hast' || data.format === 'json') ? JSON.parse(data.patchValue) : data.patchValue,
-        valueFormat: data.format || 'text',
+        value,
+        valueFormat,
         target: TARGET_USER_AGENTS_CATEGORIES.AI_BOTS,
       };
 

package/test/mappers/commerce-page-enrichment-mapper.test.js

@@ -194,7 +194,7 @@ describe('CommercePageEnrichmentMapper', () => {
       };
     }
 
-    it('should produce a JSON-LD patch appended to head', () => {
+    it('should produce a key:value patch appended to head', () => {
       const suggestion = makeSuggestion({
         patchValue: JSON.stringify({
           sku: 'HT5695',
@@ -219,14 +219,14 @@ describe('CommercePageEnrichmentMapper', () => {
       expect(patch.valueFormat).to.equal('json');
       expect(patch.target).to.equal('ai-bots');
       expect(patch.tag).to.equal('script');
-      expect(patch.attrs).to.deep.equal({ type: 'application/ld+json' });
+      expect(patch.attrs).to.deep.equal({ type: 'application/json' });
       expect(patch.opportunityId).to.equal(opportunityId);
       expect(patch.suggestionId).to.equal(suggestionId);
       expect(patch.prerenderRequired).to.be.true;
       expect(patch.lastUpdated).to.be.a('number');
     });
 
-    it('should produce valid schema.org Product JSON-LD', () => {
+    it('should pass through enrichment data as-is', () => {
       const suggestion = makeSuggestion({
         patchValue: JSON.stringify({
           sku: 'HT5695',
@@ -246,45 +246,14 @@ describe('CommercePageEnrichmentMapper', () => {
         opportunityId,
       );
 
-      const jsonLd = patches[0].value;
-      expect(jsonLd['@context']).to.equal('https://schema.org');
-      expect(jsonLd['@type']).to.equal('Product');
-      expect(jsonLd.sku).to.equal('HT5695');
-      expect(jsonLd.name).to.equal('Seat Cover Set');
-      expect(jsonLd.brand).to.deep.equal({ '@type': 'Brand', name: 'Lovesac' });
-      expect(jsonLd.description).to.equal('A great product.');
-      expect(jsonLd.material).to.equal('100% polyester chenille');
-      expect(jsonLd.category).to.equal('Home > Sactionals > Covers');
-      expect(jsonLd.color).to.equal('Blue');
-    });
-
-    it('should map unmapped fields to additionalProperty', () => {
-      const suggestion = makeSuggestion({
-        patchValue: JSON.stringify({
-          sku: 'HT5695',
-          'pdp.feature_bullets': ['Bullet 1', 'Bullet 2'],
-          'facts.attributes.fabric_care': 'Machine washable',
-          audience_tags: ['homeowners', 'families'],
-        }),
-        url: 'https://www.lovesac.com/products/seat-cover-set',
-      });
-
-      const patches = mapper.suggestionsToPatches(
-        '/products/seat-cover-set',
-        [suggestion],
-        opportunityId,
-      );
-
-      const jsonLd = patches[0].value;
-      expect(jsonLd.additionalProperty).to.be.an('array');
-
-      const bulletsProp = jsonLd.additionalProperty.find((p) => p.name === 'pdp.feature_bullets');
-      expect(bulletsProp).to.exist;
-      expect(bulletsProp.value).to.deep.equal(['Bullet 1', 'Bullet 2']);
-
-      const careProp = jsonLd.additionalProperty.find((p) => p.name === 'facts.attributes.fabric_care');
-      expect(careProp).to.exist;
-      expect(careProp.value).to.equal('Machine washable');
+      const { value } = patches[0];
+      expect(value.sku).to.equal('HT5695');
+      expect(value.name).to.equal('Seat Cover Set');
+      expect(value.brand).to.equal('Lovesac');
+      expect(value['pdp.description_plain']).to.equal('A great product.');
+      expect(value.material).to.equal('100% polyester chenille');
+      expect(value['facts.facets.category_path']).to.deep.equal(['Home', 'Sactionals', 'Covers']);
+      expect(value.color_family).to.equal('Blue');
     });
 
     it('should handle minimal enrichment data (only sku)', () => {
@@ -300,33 +269,32 @@ describe('CommercePageEnrichmentMapper', () => {
       );
 
       expect(patches).to.have.length(1);
-      const jsonLd = patches[0].value;
-      expect(jsonLd['@context']).to.equal('https://schema.org');
-      expect(jsonLd['@type']).to.equal('Product');
-      expect(jsonLd.sku).to.equal('MINIMAL');
+      expect(patches[0].value).to.deep.equal({ sku: 'MINIMAL' });
     });
 
-    it('should handle rich enrichment data with all field types', () => {
+    it('should preserve all enrichment fields without transformation', () => {
+      const enrichment = {
+        sku: '4Seats5Sides',
+        name: '4 Seats + 5 Sides Sactional',
+        category: 'Sectional / Modular Sofa',
+        brand: 'Lovesac',
+        'pdp.description_plain': 'A modular sofa configuration.',
+        'pdp.feature_bullets': ['Includes 4 Seats', 'StealthTech eligible'],
+        'facts.facets.category_path': ['Furniture', 'Sectionals', 'Sactionals'],
+        'facts.variants.summary': ['Multiple fabric options'],
+        material: 'Corded Velvet',
+        dimensions_or_capacity: '35" W x 29" D',
+        care_instructions: ['Machine washable'],
+        color_family: 'Grey',
+        audience_tags: ['homeowners'],
+        use_context: ['living room'],
+        style_tags: ['modern'],
+        keyword_synonyms: ['modular couch'],
+        persona_phrases: ['for families'],
+      };
+
       const suggestion = makeSuggestion({
-        patchValue: JSON.stringify({
-          sku: '4Seats5Sides',
-          name: '4 Seats + 5 Sides Sactional',
-          category: 'Sectional / Modular Sofa',
-          brand: 'Lovesac',
-          'pdp.description_plain': 'A modular sofa configuration.',
-          'pdp.feature_bullets': ['Includes 4 Seats', 'StealthTech eligible'],
-          'facts.facets.category_path': ['Furniture', 'Sectionals', 'Sactionals'],
-          'facts.variants.summary': ['Multiple fabric options'],
-          material: 'Corded Velvet',
-          dimensions_or_capacity: '35" W x 29" D',
-          care_instructions: ['Machine washable'],
-          color_family: 'Grey',
-          audience_tags: ['homeowners'],
-          use_context: ['living room'],
-          style_tags: ['modern'],
-          keyword_synonyms: ['modular couch'],
-          persona_phrases: ['for families'],
-        }),
+        patchValue: JSON.stringify(enrichment),
         url: 'https://www.lovesac.com/products/4-seats-5-sides',
       });
 
@@ -337,16 +305,7 @@ describe('CommercePageEnrichmentMapper', () => {
       );
 
       expect(patches).to.have.length(1);
-      const jsonLd = patches[0].value;
-      expect(jsonLd.sku).to.equal('4Seats5Sides');
-      expect(jsonLd.name).to.equal('4 Seats + 5 Sides Sactional');
-      expect(jsonLd.category).to.equal('Furniture > Sectionals > Sactionals');
-      expect(jsonLd.brand).to.deep.equal({ '@type': 'Brand', name: 'Lovesac' });
-      expect(jsonLd.description).to.equal('A modular sofa configuration.');
-      expect(jsonLd.material).to.equal('Corded Velvet');
-      expect(jsonLd.color).to.equal('Grey');
-      expect(jsonLd.additionalProperty).to.be.an('array');
-      expect(jsonLd.additionalProperty.length).to.be.greaterThan(0);
+      expect(patches[0].value).to.deep.equal(enrichment);
     });
 
     it('should skip ineligible suggestions and log warning', () => {
@@ -393,7 +352,7 @@ describe('CommercePageEnrichmentMapper', () => {
       expect(patches[1].suggestionId).to.equal('id-2');
     });
 
-    it('should not include rationale field in JSON-LD output', () => {
+    it('should exclude rationale field from output', () => {
       const suggestion = makeSuggestion({
         patchValue: JSON.stringify({
           sku: 'HT5695',
@@ -408,35 +367,16 @@ describe('CommercePageEnrichmentMapper', () => {
         opportunityId,
       );
 
-      const jsonLd = patches[0].value;
-      expect(jsonLd.rationale).to.be.undefined;
-      const rationaleProp = (jsonLd.additionalProperty || []).find((p) => p.name === 'rationale');
-      expect(rationaleProp).to.be.undefined;
+      expect(patches[0].value.rationale).to.be.undefined;
+      expect(patches[0].value.sku).to.equal('HT5695');
     });
 
-    it('should join category_path array with > separator', () => {
+    it('should exclude null values from output', () => {
       const suggestion = makeSuggestion({
         patchValue: JSON.stringify({
           sku: 'TEST',
-          'facts.facets.category_path': ['Home', 'Furniture', 'Sofas'],
-        }),
-        url: 'https://example.com/page',
-      });
-
-      const patches = mapper.suggestionsToPatches(
-        '/page',
-        [suggestion],
-        opportunityId,
-      );
-
-      expect(patches[0].value.category).to.equal('Home > Furniture > Sofas');
-    });
-
-    it('should use category field directly when facts.facets.category_path is absent', () => {
-      const suggestion = makeSuggestion({
-        patchValue: JSON.stringify({
-          sku: 'TEST',
-          category: 'Sectional / Modular Sofa',
+          name: null,
+          brand: 'Lovesac',
         }),
         url: 'https://example.com/page',
       });
@@ -447,7 +387,7 @@ describe('CommercePageEnrichmentMapper', () => {
         opportunityId,
       );
 
-      expect(patches[0].value.category).to.equal('Sectional / Modular Sofa');
+      expect(patches[0].value).to.deep.equal({ sku: 'TEST', brand: 'Lovesac' });
     });
   });
 });

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

@@ -12,9 +12,18 @@
 
 /* eslint-env mocha */
 
+import { readFileSync } from 'fs';
+import { dirname, join } from 'path';
+import { fileURLToPath } from 'url';
 import { expect } from 'chai';
 import GenericMapper from '../../src/mappers/generic-mapper.js';
 
+const filename = fileURLToPath(import.meta.url);
+const fixturesPath = join(dirname(filename), '../fixtures/semantic-value-visibility');
+const carahsoftFixture = JSON.parse(
+  readFileSync(join(fixturesPath, 'Carahsoft.json'), 'utf8'),
+);
+
 describe('GenericMapper', () => {
   let mapper;
   let log;
@@ -768,6 +777,62 @@ describe('GenericMapper', () => {
       expect(patch.attrs).to.be.undefined;
     });
 
+    it('should convert HTML patchValue to HAST when format is html', () => {
+      const suggestion = {
+        getId: () => 'sugg-html',
+        getUpdatedAt: () => '2025-01-15T10:00:00.000Z',
+        getData: () => ({
+          transformRules: {
+            action: 'insertAfter',
+            selector: 'img[src="test.jpg"]',
+          },
+          patchValue: '<section data-llm-context="image"><h2>Title</h2><p>Description</p></section>',
+          format: 'html',
+          url: 'https://example.com/page',
+        }),
+      };
+
+      const patches = mapper.suggestionsToPatches('/page', [suggestion], 'opp-html');
+
+      expect(patches.length).to.equal(1);
+      const patch = patches[0];
+
+      expect(patch.valueFormat).to.equal('hast');
+      expect(patch.value).to.be.an('object');
+      expect(patch.value.type).to.equal('root');
+      const section = patch.value.children.find((c) => c.tagName === 'section');
+      expect(section).to.exist;
+      expect(section.properties.dataLlmContext).to.equal('image');
+      const h2 = section.children.find((c) => c.tagName === 'h2');
+      expect(h2).to.exist;
+    });
+
+    it('should convert HTML to HAST using real fixture data', () => {
+      const fixtureData = carahsoftFixture.suggestions[0].data;
+      const suggestion = {
+        getId: () => 'sugg-fixture',
+        getUpdatedAt: () => '2025-01-15T10:00:00.000Z',
+        getData: () => ({
+          transformRules: fixtureData.transformRules,
+          patchValue: fixtureData.semanticHtml,
+          format: 'html',
+          url: carahsoftFixture.url,
+        }),
+      };
+
+      const patches = mapper.suggestionsToPatches('/', [suggestion], 'opp-fixture');
+
+      expect(patches.length).to.equal(1);
+      const patch = patches[0];
+
+      expect(patch.valueFormat).to.equal('hast');
+      expect(patch.value.type).to.equal('root');
+      const section = patch.value.children.find((c) => c.tagName === 'section');
+      expect(section).to.exist;
+      expect(section.properties.dataLlmContext).to.equal('image');
+      expect(section.properties.dataLlmShadow).to.equal('image-text');
+    });
+
     it('should not include UI-only fields in patch', () => {
       const suggestion = {
         getId: () => 'sugg-ui',