From 26a029d407be480d791972afb5975cf62c9360a6 Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Fri, 19 Apr 2024 02:47:55 +0200
Subject: Adding upstream version 124.0.1.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 browser/components/shopping/content/highlights.mjs | 124 +++++++++++++++++++++
 1 file changed, 124 insertions(+)
 create mode 100644 browser/components/shopping/content/highlights.mjs

(limited to 'browser/components/shopping/content/highlights.mjs')

diff --git a/browser/components/shopping/content/highlights.mjs b/browser/components/shopping/content/highlights.mjs
new file mode 100644
index 0000000000..09ed055b28
--- /dev/null
+++ b/browser/components/shopping/content/highlights.mjs
@@ -0,0 +1,124 @@
+/* -*- indent-tabs-mode: nil; js-indent-level: 2 -*-
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+import { html } from "chrome://global/content/vendor/lit.all.mjs";
+
+import { MozLitElement } from "chrome://global/content/lit-utils.mjs";
+
+// eslint-disable-next-line import/no-unassigned-import
+import "chrome://browser/content/shopping/highlight-item.mjs";
+// eslint-disable-next-line import/no-unassigned-import
+import "chrome://browser/content/shopping/shopping-card.mjs";
+
+const VALID_HIGHLIGHT_L10N_IDs = new Map([
+  ["price", "shopping-highlight-price"],
+  ["quality", "shopping-highlight-quality"],
+  ["shipping", "shopping-highlight-shipping"],
+  ["competitiveness", "shopping-highlight-competitiveness"],
+  ["packaging/appearance", "shopping-highlight-packaging"],
+]);
+
+/**
+ * Class for displaying all available highlight categories for a product and any
+ * highlight reviews per category.
+ */
+class ReviewHighlights extends MozLitElement {
+  /**
+   * highlightsMap is a map of highlight categories to an array of reviews per category.
+   * It is possible for a category to have no reviews.
+   */
+  #highlightsMap;
+
+  static properties = {
+    highlights: { type: Object },
+    lang: { type: String, reflect: true },
+  };
+
+  static get queries() {
+    return {
+      reviewHighlightsListEl: "#review-highlights-list",
+    };
+  }
+
+  updateHighlightsMap() {
+    let availableKeys;
+    this.#highlightsMap = null;
+
+    try {
+      if (!this.highlights) {
+        return;
+      }
+
+      // Filter highlights that have data.
+      let keys = Object.keys(this.highlights);
+      availableKeys = keys.filter(
+        key => Object.values(this.highlights[key]).flat().length !== 0
+      );
+
+      // Filter valid highlight category types. Valid types are guaranteed to have data-l10n-ids.
+      availableKeys = availableKeys.filter(key =>
+        VALID_HIGHLIGHT_L10N_IDs.has(key)
+      );
+
+      // If there are no highlights to show in the end, stop here and don't render content.
+      if (!availableKeys.length) {
+        return;
+      }
+    } catch (e) {
+      return;
+    }
+
+    this.#highlightsMap = new Map();
+
+    for (let key of availableKeys) {
+      // Ignore negative,neutral,positive sentiments and simply append review strings into one array.
+      let reviews = Object.values(this.highlights[key]).flat();
+      this.#highlightsMap.set(key, reviews);
+    }
+  }
+
+  createHighlightElement(type, reviews) {
+    let highlightEl = document.createElement("highlight-item");
+    // We already verify highlight type and its l10n id in updateHighlightsMap.
+    let l10nId = VALID_HIGHLIGHT_L10N_IDs.get(type);
+    highlightEl.id = type;
+    highlightEl.l10nId = l10nId;
+    highlightEl.highlightType = type;
+    highlightEl.reviews = reviews;
+    highlightEl.lang = this.lang;
+    return highlightEl;
+  }
+
+  render() {
+    this.updateHighlightsMap();
+
+    if (!this.#highlightsMap) {
+      this.hidden = true;
+      return null;
+    }
+
+    this.hidden = false;
+
+    let highlightsTemplate = [];
+    for (let [key, value] of this.#highlightsMap) {
+      let highlightEl = this.createHighlightElement(key, value);
+      highlightsTemplate.push(highlightEl);
+    }
+
+    return html`
+      <shopping-card
+        data-l10n-id="shopping-highlights-label"
+        data-l10n-attrs="label"
+        type="show-more"
+      >
+        <div slot="content" id="review-highlights-wrapper">
+          <dl id="review-highlights-list">${highlightsTemplate}</dl>
+        </div>
+      </shopping-card>
+    `;
+  }
+}
+
+customElements.define("review-highlights", ReviewHighlights);
-- 
cgit v1.2.3