npm - @adobe/spacecat-shared-html-analyzer - Versions diffs - 1.0.0 - Mend

@adobe/spacecat-shared-html-analyzer 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (18) hide show

package/src/utils.js ADDED Viewed

@@ -0,0 +1,62 @@
+/*
+ * Copyright 2025 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.
+ */
+/**
+ * Utility functions for the HTML visibility analyzer
+ */
+/**
+ * Generate DJB2 hash for content comparison
+ * @param {string} str - String to hash
+ * @returns {string} Hex hash string
+ */
+export function hashDJB2(str) {
+  if (!str) return '';
+  let h = 5381;
+  for (let i = 0; i < str.length; i += 1) {
+    // eslint-disable-next-line no-bitwise
+    h = ((h << 5) + h) + str.charCodeAt(i);
+  }
+  // eslint-disable-next-line no-bitwise
+  return (h >>> 0).toString(16);
+}
+/**
+ * Format percentage with 1 decimal place
+ * @param {number} n - Number to format as percentage
+ * @returns {string} Formatted percentage string
+ */
+export function pct(n) {
+  return (Number.isFinite(n) ? `${(n * 100).toFixed(1)}%` : '–');
+}
+/**
+ * Format number to K/M format for readability
+ * @param {number} num - Number to format
+ * @returns {string} Formatted number string
+ */
+export function formatNumberToK(num) {
+  if (num >= 1000000) {
+    return `${(num / 1000000).toFixed(1).replace(/\.0$/, '')}M`;
+  } else if (num >= 10000) {
+    return `${(num / 1000).toFixed(1).replace(/\.0$/, '')}K`;
+  }
+  return num.toString();
+}
+/**
+ * Check if code is running in browser environment
+ * @returns {boolean} True if in browser
+ */
+export function isBrowser() {
+  return typeof window !== 'undefined' && typeof document !== 'undefined';
+}

package/test/index.test.js ADDED Viewed

@@ -0,0 +1,109 @@
+/*
+ * Copyright 2025 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 { expect } from 'chai';
+import {
+  analyzeTextComparison,
+  calculateStats,
+  calculateBothScenarioStats,
+  stripTagsToText,
+} from '../src/index.js';
+describe('HTML Visibility Analyzer', () => {
+  const simpleHtml = '<html><body><h1>Title</h1><p>Content here</p></body></html>';
+  const richHtml = '<html><body><h1>Title</h1><p>Content here</p><script>console.log("loaded")</script><div class="dynamic">Dynamic content</div></body></html>';
+  describe('analyzeTextComparison', () => {
+    it('should analyze content differences', async () => {
+      const result = await analyzeTextComparison(simpleHtml, richHtml);
+      expect(result).to.have.property('initialText');
+      expect(result).to.have.property('finalText');
+      expect(result).to.have.property('textRetention');
+      expect(result).to.have.property('wordDiff');
+      expect(result).to.have.property('lineDiff');
+    });
+    it('should handle identical content', async () => {
+      const result = await analyzeTextComparison(simpleHtml, simpleHtml);
+      expect(result.textRetention).to.equal(1);
+      expect(result.initialText).to.equal(result.finalText);
+    });
+    it('should handle empty content', async () => {
+      const result = await analyzeTextComparison('', richHtml);
+      expect(result.initialText).to.equal('');
+      expect(result.finalText.length).to.be.greaterThan(0);
+    });
+  });
+  describe('calculateStats', () => {
+    it('should provide basic comparison statistics', async () => {
+      const result = await calculateStats(simpleHtml, richHtml);
+      expect(result).to.have.property('wordDiff');
+      expect(result).to.have.property('contentIncreaseRatio');
+      expect(result).to.have.property('citationReadability');
+      expect(result.wordDiff).to.be.a('number');
+      expect(result.contentIncreaseRatio).to.be.a('number');
+      expect(result.citationReadability).to.be.a('number');
+    });
+  });
+  describe('calculateBothScenarioStats', () => {
+    it('should provide statistics for both scenarios', async () => {
+      const result = await calculateBothScenarioStats(simpleHtml, richHtml);
+      expect(result).to.have.property('withNavFooterIgnored');
+      expect(result).to.have.property('withoutNavFooterIgnored');
+      expect(result.withNavFooterIgnored).to.have.property('contentGain');
+      expect(result.withoutNavFooterIgnored).to.have.property('missingWords');
+    });
+  });
+  describe('stripTagsToText', () => {
+    it('should extract text content from HTML', async () => {
+      const html = '<div><h1>Title</h1><p>Content with <strong>bold</strong> text</p></div>';
+      const text = await stripTagsToText(html);
+      expect(text).to.include('Title');
+      expect(text).to.include('Content with');
+      expect(text).to.include('bold');
+      expect(text).to.include('text');
+      expect(text).to.not.include('<');
+      expect(text).to.not.include('>');
+    });
+    it('should remove navigation elements when ignoreNavFooter is true', async () => {
+      const html = '<html><body><nav>Navigation</nav><h1>Title</h1><p>Content</p><footer>Footer</footer></body></html>';
+      const text = await stripTagsToText(html, true);
+      expect(text).to.include('Title');
+      expect(text).to.include('Content');
+      expect(text).to.not.include('Navigation');
+      expect(text).to.not.include('Footer');
+    });
+    it('should keep navigation elements when ignoreNavFooter is false', async () => {
+      const html = '<html><body><nav>Navigation</nav><h1>Title</h1><p>Content</p><footer>Footer</footer></body></html>';
+      const text = await stripTagsToText(html, false);
+      expect(text).to.include('Title');
+      expect(text).to.include('Content');
+      expect(text).to.include('Navigation');
+      expect(text).to.include('Footer');
+    });
+  });
+});

package/test/setup-env.js ADDED Viewed

@@ -0,0 +1,21 @@
+/*
+ * Copyright 2025 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.
+ */
+// eslint-disable-next-line import/no-extraneous-dependencies
+import { use } from 'chai';
+// eslint-disable-next-line import/no-extraneous-dependencies
+import chaiAsPromised from 'chai-as-promised';
+// eslint-disable-next-line import/no-extraneous-dependencies
+import sinonChai from 'sinon-chai';
+use(chaiAsPromised);
+use(sinonChai);