Bump to 1.1.0 (#12)

* Change name of package

* Update package lock

* Apply formatting

---------

Co-authored-by: marksverdhei <>

Author: marksverdhei

manifest.json

@@ -1,7 +1,7 @@
 {
   "manifest_version": 3,
   "name": "Save Me A Click",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "Summarize any link with a right-click",
   "permissions": [
     "contextMenus",

package-lock.json

@@ -1,6 +1,6 @@
 {
-  "name": "syac-extension-2",
-  "version": "1.0.0",
+  "name": "save-me-a-click",
+  "version": "1.1.0",
   "description": "Save Me A Click is a Chrome extension that provides a summary of a webpage when right-clicking on a link. It displays a popup with a title, body, and summary without needing to open the page.",
   "main": "index.js",
   "scripts": {

package.json

@@ -1,42 +1,44 @@
-const Article = require("newspaperjs").Article
-const LanguageDetect = require('languagedetect');
+const Article = require("newspaperjs").Article;
+const LanguageDetect = require("languagedetect");
 const languageDetector = new LanguageDetect();
 
 const PROMPTS = {
-  "english": [
-      {
-          "role": "system",
-          "content": "You are a tool that generates saved-you-a-click summaries when provided clickbait titles and content",
-      },
-      {
-          "role": "user",
-          "content": "Your task is the following: Given the title and the body of a clickbait article, provide the information that one would desire or wonder about upon reading the title.\n" +
-            "* Be exact, on point and provide your answer as a repsonse to the title, and make your answers brief, preferrably in one sentence.\n" +
-            "  Example: Costco shoppers shifting away from specific item; CFO says it’s indicator of recession | Beef and steaks.\n" + 
-            "* If the article is a list of N items, simply list each item and nothing else.\n" +
-            "  Example: 5 Fast-Food Chains That Have Gone From the Best to the Bottom In a Few Years | Burgerim, Quiznos, Boston Market, Red Barn, Burger Chef\n" +
-            "* If there is not sufficient information in the article body to answer the title, state so in the answer.\n" +
-            "  Example: Why Big Tech execs are swapping the boardroom for the dojo | Article doesn't say\n\n"
-      },
+  english: [
+    {
+      role: "system",
+      content:
+        "You are a tool that generates saved-you-a-click summaries when provided clickbait titles and content",
+    },
+    {
+      role: "user",
+      content:
+        "Your task is the following: Given the title and the body of a clickbait article, provide the information that one would desire or wonder about upon reading the title.\n" +
+        "* Be exact, on point and provide your answer as a repsonse to the title, and make your answers brief, preferrably in one sentence.\n" +
+        "  Example: Costco shoppers shifting away from specific item; CFO says it’s indicator of recession | Beef and steaks.\n" +
+        "* If the article is a list of N items, simply list each item and nothing else.\n" +
+        "  Example: 5 Fast-Food Chains That Have Gone From the Best to the Bottom In a Few Years | Burgerim, Quiznos, Boston Market, Red Barn, Burger Chef\n" +
+        "* If there is not sufficient information in the article body to answer the title, state so in the answer.\n" +
+        "  Example: Why Big Tech execs are swapping the boardroom for the dojo | Article doesn't say\n\n",
+    },
   ],
   // Options to enter other languages here
-}
+};
 
 function getMissingLanguagePrompt(language) {
   return [
     {
-        "role": "system",
-        "content": `You are a tool that generates saved-you-a-click summaries when provided clickbait titles and content written in ${language}`,
+      role: "system",
+      content: `You are a tool that generates saved-you-a-click summaries when provided clickbait titles and content written in ${language}`,
     },
     {
-        "role": "user",
-        "content": "Given the title and the body of a clickbait article, please provide the information that one might desire upon reading the title. Make the answer as brief as you can.\n" +
+      role: "user",
+      content:
+        "Given the title and the body of a clickbait article, please provide the information that one might desire upon reading the title. Make the answer as brief as you can.\n" +
         `If there is no information in the article content that answers the title, provide your answer as 'The article doesn't say' in ${language}. Write your response in ${language}`,
     },
-  ]
+  ];
 }
 
-
 chrome.runtime.onInstalled.addListener(() => {
   chrome.contextMenus.create({
     id: "saveMeAClick",
@@ -45,41 +47,47 @@ chrome.runtime.onInstalled.addListener(() => {
   });
 });
 
-
 chrome.contextMenus.onClicked.addListener((info, tab) => {
   if (info.menuItemId === "saveMeAClick") {
-    console.log("Sending saveMeAClick to content.js")
+    console.log("Sending saveMeAClick to content.js");
     chrome.tabs.sendMessage(tab.id, { url: info.linkUrl });
   }
 });
 
-
 chrome.runtime.onMessage.addListener(async (message, sender) => {
   if (message.type === "startSpinner") {
-    chrome.tabs.sendMessage(sender.tab.id, { startSpinner: true, url: message.url });
+    chrome.tabs.sendMessage(sender.tab.id, {
+      startSpinner: true,
+      url: message.url,
+    });
   }
   if (message.type === "fetchSummary") {
-    console.log("Received fetchSummary from content.js. Sending spinnner")
+    console.log("Received fetchSummary from content.js. Sending spinnner");
     // Send the message to start the spinner
 
     try {
       const summary = await getSummary(message.url);
-      console.log("Summary received, sending to content.js")
-      chrome.tabs.sendMessage(sender.tab.id, { summary: summary, overlayId: message.overlayId });
+      console.log("Summary received, sending to content.js");
+      chrome.tabs.sendMessage(sender.tab.id, {
+        summary: summary,
+        overlayId: message.overlayId,
+      });
     } catch (error) {
-      console.log("There was an error, sending to content.js")
-      console.log(error.name); 
+      console.log("There was an error, sending to content.js");
+      console.log(error.name);
       console.log(error.message);
       console.log(error.stack);
-      chrome.tabs.sendMessage(sender.tab.id, { error: error.message, overlayId: message.overlayId });
+      chrome.tabs.sendMessage(sender.tab.id, {
+        error: error.message,
+        overlayId: message.overlayId,
+      });
     }
   }
 });
 
-
 function getApiKey() {
   return new Promise((resolve, reject) => {
-    chrome.storage.sync.get(['apiKey'], function(result) {
+    chrome.storage.sync.get(["apiKey"], function (result) {
       if (chrome.runtime.lastError) {
         return reject(chrome.runtime.lastError);
       }
@@ -88,42 +96,36 @@ function getApiKey() {
   });
 }
 
-
 function getDataContent(data) {
   if (
-    (
-      (!data)
-      || (!data.choices)
-      || (!data.choices[0])
-      || (!data.choices[0].message)
-      || (!data.choices[0].message.content)
-
-    )
+    !data ||
+    !data.choices ||
+    !data.choices[0] ||
+    !data.choices[0].message ||
+    !data.choices[0].message.content
   ) {
     return "Data missing";
   } else {
-    return data.choices[0].message.content
+    return data.choices[0].message.content;
   }
-
 }
 
 /**
- * 
+ *
  * @param {str} url url address of the clickbait article or web page
  * @returns {object} summary of the given clickbait content
  */
 async function getSummary(url) {
   const article = await Article(url);
   const title = article.title;
   const body = article.text;
-  
-  if (!(title && body)) 
-    throw new Error("missing article title or text");
-  
+
+  if (!(title && body)) throw new Error("missing article title or text");
+
   const languages = languageDetector.detect(title + body, 1);
-  console.log(languages)
+  console.log(languages);
   const language = languages[0][0];
-  console.log(language)
+  console.log(language);
 
   if (language in PROMPTS) {
     prePrompt = PROMPTS[language];
@@ -132,11 +134,11 @@ async function getSummary(url) {
   }
 
   fullPrompt = prePrompt.concat([
-    {"role": "user", "content": `<article-title>${title}</article-title>`},
-    {"role": "user", "content": `<article-body>${body}</article-body>`},
-  ])
-  console.log(fullPrompt)
-  
+    { role: "user", content: `<article-title>${title}</article-title>` },
+    { role: "user", content: `<article-body>${body}</article-body>` },
+  ]);
+  console.log(fullPrompt);
+
   let result = {
     title: title,
     body: body,
@@ -151,12 +153,12 @@ async function getSummary(url) {
       method: "POST",
       headers: {
         "Content-Type": "application/json",
-        "Authorization": `Bearer ${apiKey}`
+        Authorization: `Bearer ${apiKey}`,
       },
       body: JSON.stringify({
-        "model": "gpt-3.5-turbo",
-        "messages": fullPrompt,
-        "temperature": 0.7
+        model: "gpt-3.5-turbo",
+        messages: fullPrompt,
+        temperature: 0.7,
       }),
     });
 
@@ -174,4 +176,4 @@ async function getSummary(url) {
     console.error(error);
     throw error;
   }
-}
+}

src/background.js

@@ -7,26 +7,34 @@ document.addEventListener("contextmenu", (event) => {
 
 chrome.runtime.onMessage.addListener((message, sender) => {
   if (message.startSpinner) {
-    const overlay = displayOverlay("Loading...", "", "", lastRightClickPosition.x, lastRightClickPosition.y);
-    chrome.runtime.sendMessage({ url: message.url, type: "fetchSummary", overlayId: overlay.id })
-
+    const overlay = displayOverlay(
+      "Loading...",
+      "",
+      "",
+      lastRightClickPosition.x,
+      lastRightClickPosition.y
+    );
+    chrome.runtime.sendMessage({
+      url: message.url,
+      type: "fetchSummary",
+      overlayId: overlay.id,
+    });
   } else if (message.summary) {
     const { title, body, answer } = message.summary;
     console.log("summary received in content.js. Updating overlay");
     updateOverlay(message.overlayId, answer, body, title);
   } else if (message.error) {
     updateOverlay(message.overlayId, "Error", "", message.error);
   } else {
-    chrome.runtime.sendMessage({ url: message.url, type: "startSpinner" })
+    chrome.runtime.sendMessage({ url: message.url, type: "startSpinner" });
   }
 });
 
-
 function updateOverlay(overlayId, title, body, summary) {
   console.log("Update overlay called");
   const overlay = document.getElementById(overlayId);
-  console.log(overlayId)
-  console.log(overlay)
+  console.log(overlayId);
+  console.log(overlay);
 
   // Remove the spinner
   const spinner = overlay.querySelector(".spinner");
@@ -48,13 +56,11 @@ function updateOverlay(overlayId, title, body, summary) {
   overlayBox.appendChild(summaryEl);
 }
 
-
-
 function displayOverlay(title, body, summary, x, y) {
   // Create the overlay elements
   const overlay = document.createElement("div");
   overlay.className = "overlay";
-  overlay.id = "overlay" + document.querySelectorAll(".overlay").length
+  overlay.id = "overlay" + document.querySelectorAll(".overlay").length;
   overlay.style.left = `${x}px`;
   overlay.style.top = `${y}px`;
 
@@ -86,6 +92,3 @@ function displayOverlay(title, body, summary, x, y) {
 
   return overlay;
 }
-
-
-