@adobe/spacecat-shared-tokowaka-client 1.5.0 → 1.5.1

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-tokowaka-client-v1.5.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tokowaka-client-v1.5.0...@adobe/spacecat-shared-tokowaka-client-v1.5.1) (2026-01-20)
+
+
+### Bug Fixes
+
+* rename tokowaka to edge-optimize in preview api ([#1269](https://github.com/adobe/spacecat-shared/issues/1269)) ([d40caa4](https://github.com/adobe/spacecat-shared/commit/d40caa46d2bb72506e45081a263f4513fce4ce41))
+
 # [@adobe/spacecat-shared-tokowaka-client-v1.5.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tokowaka-client-v1.4.7...@adobe/spacecat-shared-tokowaka-client-v1.5.0) (2026-01-15)
 
 

package/package.json

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

package/src/index.js

@@ -306,7 +306,7 @@ class TokowakaClient {
       siteId,
       apiKeys: [apiKey],
       tokowakaEnabled: options.tokowakaEnabled ?? true,
-      enhancements: false,
+      enhancements: options.enhancements ?? false,
     };
 
     const s3Path = await this.uploadMetaconfig(url, metaconfig);
@@ -810,8 +810,8 @@ class TokowakaClient {
     }
 
     // TOKOWAKA_EDGE_URL is mandatory for preview
-    const tokowakaEdgeUrl = this.env.TOKOWAKA_EDGE_URL;
-    if (!hasText(tokowakaEdgeUrl)) {
+    const edgeUrl = this.env.TOKOWAKA_EDGE_URL;
+    if (!hasText(edgeUrl)) {
       throw this.#createError(
         'TOKOWAKA_EDGE_URL is required for preview functionality',
         HTTP_INTERNAL_SERVER_ERROR,
@@ -931,7 +931,7 @@ class TokowakaClient {
         previewUrl,
         apiKey,
         forwardedHost,
-        tokowakaEdgeUrl,
+        edgeUrl,
         this.log,
         false,
         options,
@@ -941,7 +941,7 @@ class TokowakaClient {
         previewUrl,
         apiKey,
         forwardedHost,
-        tokowakaEdgeUrl,
+        edgeUrl,
         this.log,
         true,
         options,

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

@@ -25,7 +25,7 @@ function sleep(ms) {
 
 /**
  * Makes an HTTP request with retry logic
- * Retries until max retries are exhausted or x-tokowaka-cache header is present
+ * Retries until max retries are exhausted or x-edge-optimize-cache header is present
  * @param {string} url - URL to fetch
  * @param {Object} options - Fetch options
  * @param {number} maxRetries - Maximum number of retries
@@ -48,10 +48,10 @@ async function fetchWithRetry(url, options, maxRetries, retryDelayMs, log, fetch
         throw new Error(`HTTP ${response.status}: ${response.statusText}`);
       }
 
-      // Check for x-tokowaka-cache header - if present, stop retrying
-      const cacheHeader = response.headers.get('x-tokowaka-cache');
+      // Check for x-edge-optimize-cache header - if present, stop retrying
+      const cacheHeader = response.headers.get('x-edge-optimize-cache');
       if (cacheHeader) {
-        log.debug(`Cache header found (x-tokowaka-cache: ${cacheHeader}), stopping retry logic`);
+        log.debug(`Cache header found (x-edge-optimize-cache: ${cacheHeader}), stopping retry logic`);
         return response;
       }
 
@@ -65,7 +65,7 @@ async function fetchWithRetry(url, options, maxRetries, retryDelayMs, log, fetch
       } else {
         // Last attempt without cache header - throw error
         log.error(`Max retries (${maxRetries}) exhausted without cache header`);
-        throw new Error(`Cache header (x-tokowaka-cache) not found after ${maxRetries} retries`);
+        throw new Error(`Cache header (x-edge-optimize-cache) not found after ${maxRetries} retries`);
       }
     } catch (error) {
       log.warn(`Attempt ${attempt} failed for ${fetchType} HTML, error: ${error.message}`);
@@ -86,12 +86,12 @@ async function fetchWithRetry(url, options, maxRetries, retryDelayMs, log, fetch
 }
 
 /**
- * Fetches HTML content from Tokowaka edge with warmup call and retry logic
+ * Fetches HTML content from edge with warmup call and retry logic
  * Makes an initial warmup call, waits, then makes the actual call with retries
  * @param {string} url - Full URL to fetch
- * @param {string} apiKey - Tokowaka API key
+ * @param {string} apiKey - Edge Optimize API key
  * @param {string} forwardedHost - Host to forward in x-forwarded-host header
- * @param {string} tokowakaEdgeUrl - Tokowaka edge URL
+ * @param {string} edgeUrl - Edge URL
  * @param {boolean} isOptimized - Whether to fetch optimized HTML (with preview param)
  * @param {Object} log - Logger instance
  * @param {Object} options - Additional options
@@ -105,7 +105,7 @@ export async function fetchHtmlWithWarmup(
   url,
   apiKey,
   forwardedHost,
-  tokowakaEdgeUrl,
+  edgeUrl,
   log,
   isOptimized = false,
   options = {},
@@ -116,14 +116,14 @@ export async function fetchHtmlWithWarmup(
   }
 
   if (!hasText(apiKey)) {
-    throw new Error('Tokowaka API key is required for fetching HTML');
+    throw new Error('Edge Optimize API key is required for fetching HTML');
   }
 
   if (!hasText(forwardedHost)) {
     throw new Error('Forwarded host is required for fetching HTML');
   }
 
-  if (!hasText(tokowakaEdgeUrl)) {
+  if (!hasText(edgeUrl)) {
     throw new Error('TOKOWAKA_EDGE_URL is not configured');
   }
 
@@ -139,18 +139,18 @@ export async function fetchHtmlWithWarmup(
   // Parse the URL to extract path and construct full URL
   const urlObj = new URL(url);
   const urlPath = urlObj.pathname;
-  let fullUrl = `${tokowakaEdgeUrl}${urlPath}`;
+  let fullUrl = `${edgeUrl}${urlPath}`;
 
   const headers = {
     'x-forwarded-host': forwardedHost,
-    'x-tokowaka-api-key': apiKey,
-    'x-tokowaka-url': urlPath,
+    'x-edge-optimize-api-key': apiKey,
+    'x-edge-optimize-url': urlPath,
   };
 
   if (isOptimized) {
     // Add tokowakaPreview param for optimized HTML
     fullUrl = `${fullUrl}?tokowakaPreview=true`;
-    headers['x-tokowaka-url'] = `${urlPath}?tokowakaPreview=true`;
+    headers['x-edge-optimize-url'] = `${urlPath}?tokowakaPreview=true`;
   }
 
   const fetchOptions = {

package/test/index.test.js

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

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

@@ -744,7 +744,6 @@ Overall, Bulk positions itself as a better choice for sports nutrition through i
               question: 'Old Q?',
               answer: 'Old A.',
             },
-            tokowakaDeployed: 1704884400000,
             transformRules: {
               action: 'appendChild',
               selector: 'main',
@@ -1154,7 +1153,7 @@ Overall, Bulk positions itself as a better choice for sports nutrition through i
     });
   });
 
-  describe('tokowakaDeployed filtering', () => {
+  describe('edgeDeployed filtering', () => {
     it('should always create heading patch even when FAQ already deployed for URL', () => {
       const newSuggestion = {
         getId: () => 'sugg-new-1',

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

@@ -94,7 +94,7 @@ describe('HTML Utils', () => {
         );
         expect.fail('Should have thrown error');
       } catch (error) {
-        expect(error.message).to.equal('Tokowaka API key is required for fetching HTML');
+        expect(error.message).to.equal('Edge Optimize API key is required for fetching HTML');
       }
     });
 
@@ -104,7 +104,7 @@ describe('HTML Utils', () => {
         status: 200,
         statusText: 'OK',
         headers: {
-          get: (name) => (name === 'x-tokowaka-cache' ? 'HIT' : null),
+          get: (name) => (name === 'x-edge-optimize-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-tokowaka-cache' ? 'HIT' : null),
+          get: (name) => (name === 'x-edge-optimize-cache' ? 'HIT' : null),
         },
         text: async () => '<html>Optimized HTML</html>',
       });
@@ -285,7 +285,7 @@ describe('HTML Utils', () => {
       }
     });
 
-    it('should stop retrying when x-tokowaka-cache header is found', async () => {
+    it('should stop retrying when x-edge-optimize-cache header is found', async () => {
       // Warmup succeeds
       fetchStub.onCall(0).resolves({
         ok: true,
@@ -312,7 +312,7 @@ describe('HTML Utils', () => {
         status: 200,
         statusText: 'OK',
         headers: {
-          get: (name) => (name === 'x-tokowaka-cache' ? 'HIT' : null),
+          get: (name) => (name === 'x-edge-optimize-cache' ? 'HIT' : null),
         },
         text: async () => '<html>Cached HTML</html>',
       });
@@ -385,7 +385,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-tokowaka-cache) not found after 2 retries');
+        expect(error.message).to.include('Cache header (x-edge-optimize-cache) not found after 2 retries');
       }
 
       // Should have tried 3 times (initial + 2 retries) plus warmup
@@ -409,7 +409,7 @@ describe('HTML Utils', () => {
         status: 200,
         statusText: 'OK',
         headers: {
-          get: (name) => (name === 'x-tokowaka-cache' ? 'HIT' : null),
+          get: (name) => (name === 'x-edge-optimize-cache' ? 'HIT' : null),
         },
         text: async () => '<html>Cached HTML</html>',
       });