chore: add jsdoc comments on util functions

lib/components/option/Option.svelte

@@ -57,6 +57,10 @@
   // reset search query every-time shortcut list changes
   $: resetSearchQuery($shortcuts)
 
+  /**
+   * loads the shortcuts into the store from storage
+   * @returns {Promise<void>}
+   */
   async function loadShortcuts() {
     await shortcuts.init()
   }

lib/utils/browser/constructShortcutRules.ts

@@ -1,7 +1,11 @@
-import { FIREFOX, SAFARI } from "~lib/constants/browserNames"
 import type { Shortcut } from "~lib/types"
 import { isNonChromiumBrowser } from "./getBrowserName"
 
+/** 
+ * construct the declarative net request rules for given shortcuts array
+ * @param {Shortcut[]} shortcuts shortcuts array
+ * @returns {browser.declarativeNetRequest.Rule[] | chrome.declarativeNetRequest.Rule[]} array of shortcut rules
+ */
 export function constructShortcutRules(shortcuts: Shortcut[]) {
   if (isNonChromiumBrowser()) {
     return shortcuts.map((shortcut, index) => {

lib/utils/browser/getBrowserName.ts

@@ -1,9 +1,17 @@
 import { FIREFOX, SAFARI } from "~lib/constants/browserNames";
 
+/** 
+ * gives the browser name
+ * @returns {string} browser name as per plasmo env
+ */
 export function getBrowserName() {
   return process.env.PLASMO_BROWSER
 }
 
+/** 
+ * checks if the browser is a non chromium based one or not
+ * @returns {boolean} true if if not based on chromium. else false
+ */
 export function isNonChromiumBrowser() {
   // For now, only safari and firefox are considered in non chromium browsers
   // More can be added in future if required

lib/utils/browser/getDeclarativeNetRequestRules.ts

@@ -1,5 +1,9 @@
 import { isNonChromiumBrowser } from "./getBrowserName";
 
+/** 
+ * gives the saved declarative net request rules in browser
+ * @returns {browser.declarativeNetRequest.Rule[] | chrome.declarativeNetRequest.Rule[]} declarative net request rules array
+ */
 export async function getDeclarativeNetRequestRules() {
   const browserName = process.env.PLASMO_BROWSER
   if (isNonChromiumBrowser()) {

lib/utils/browser/getFaviconURL.ts

@@ -1,6 +1,11 @@
 import { isNonChromiumBrowser } from "./getBrowserName"
 
-export function getFaviconURL(u: string) {
+/** 
+ * gives the saved favicon url in browser of a given website
+ * @param {string} url the shortlink's url
+ * @returns {browser.declarativeNetRequest.Rule[] | chrome.declarativeNetRequest.Rule[]} declarative net request rules array
+ */
+export function getFaviconURL(shortcutURL: string) {
   let url: URL | null = null
   if (isNonChromiumBrowser()) {
     // NOTE: This is a fallback icon. Firefox does not support accessing cached favicon
@@ -11,7 +16,7 @@ export function getFaviconURL(u: string) {
   }
 
   if (url) {
-    url.searchParams.set("pageUrl", u)
+    url.searchParams.set("pageUrl", shortcutURL)
     url.searchParams.set("size", "32")
     return url.toString()
   }

lib/utils/browser/getTabUrl.ts

@@ -1,9 +1,17 @@
 import { isNonChromiumBrowser } from "./getBrowserName"
 
+/** 
+ * gives the active/current tab url
+ * @returns {Promise<string>} url string of the active/current tab
+ */
 export async function getActiveTabURL() {
   return await getTabURL()
 }
 
+/** 
+ * utility function to get current tab url using browser APIs
+ * @returns {Promise<string>} url string of the active/current tab
+ */
 function getTabURL() {
   return new Promise<string>((resolve) => {
     try {

lib/utils/browser/storageUtils.ts

@@ -1,6 +1,11 @@
 import { Storage } from "@plasmohq/storage";
 import type { Shortcut } from "~lib/types";
 
+/** 
+ * gives the browser local storage data for a given key
+ * @param {string} key key for the stored data
+ * @returns {Promise<T>} stored data with given type
+ */
 export async function getDataFromStorage<T>(key) {
   const storage = new Storage({
     area: "local"

lib/utils/browser/tabOperations.ts

@@ -1,5 +1,10 @@
 import { isNonChromiumBrowser } from "./getBrowserName"
 
+/** 
+ * opens new tab
+ * @param {chrome.tabs.CreateProperties | browser.tabs._CreateCreateProperties} props properties for creating new tab
+ * @returns {void}
+ */
 export function openNewTab(props: chrome.tabs.CreateProperties | browser.tabs._CreateCreateProperties) {
   if (isNonChromiumBrowser()) {
     browser.tabs.create(props)
@@ -9,6 +14,11 @@ export function openNewTab(props: chrome.tabs.CreateProperties | browser.tabs._C
   }
 }
 
+/** 
+ * updates the current tab
+ * @param {chrome.tabs.UpdateProperties | browser.tabs._UpdateUpdateProperties} props properties for updating the tab
+ * @returns {void}
+ */
 export function updateTab(props: chrome.tabs.UpdateProperties | browser.tabs._UpdateUpdateProperties) {
   if (isNonChromiumBrowser()) {
     browser.tabs.update(props)

lib/utils/browser/updateDeclarativeNetRequestRules.ts

@@ -1,5 +1,11 @@
 import { isNonChromiumBrowser } from "./getBrowserName";
 
+/** 
+ * updates the declarative net request rules of the browser
+ * @param { browser.declarativeNetRequest.Rule[] | chrome.declarativeNetRequest.Rule[]} addRules rules that need to be added
+ * @param {number[]} removeRuleIds IDs of rules that need to be removed
+ * @returns {void}
+ */
 export async function updateDeclarativeNetRequestRules(
   addRules: browser.declarativeNetRequest.Rule[]
     | chrome.declarativeNetRequest.Rule[],

lib/utils/constructShortcutsFromCSVData.ts

@@ -35,8 +35,8 @@ export async function constructShortcutsFromCSVData(csvData: string[][], savedSh
       const shortcut: Shortcut = {
         shortlink: shortcutRow[0],
         url: shortcutRow[1],
-        createdAt: new Date(),
-        updatedAt: new Date(),
+        createdAt: new Date().toISOString(),
+        updatedAt: new Date().toISOString(),
       };
       return shortcut;
     }

lib/utils/copyToClipboard.ts

@@ -1,3 +1,8 @@
+/** 
+ * copies the given text to clipboard
+ * @param {string} text text to be copied
+ * @returns {void}
+ */
 export function copyToClipboard(text: string): void {
 	if (navigator.clipboard && navigator.clipboard.writeText) {
 		navigator.clipboard

lib/utils/isNotNull.ts

@@ -1,3 +1,8 @@
+/** 
+ * checks if value is null or not
+ * @param {T | null} value value to be checked
+ * @returns {boolean} true if value is not null. else false
+ */
 export function isNotNull<T>(value: T | null): value is T {
   return value !== null;
 }

lib/utils/setShortcutsToStorage.ts

@@ -2,6 +2,11 @@ import type { Shortcut } from "~lib/types"
 import { setDataToStorage } from "./browser/storageUtils"
 import { SHORTCUTS_STORAGE_KEY } from "~lib/constants/keys"
 
+/** 
+ * set/store given shortcuts to storage
+ * @param {Shortcut[]} shortcuts shortcuts to be stored
+ * @returns {Promise<void>}
+ */
 export async function setShortcutsToStorage(shortcuts: Shortcut[]) {
   await setDataToStorage(SHORTCUTS_STORAGE_KEY, shortcuts)
 }

tsconfig.json

@@ -6,7 +6,7 @@
   "include": [
     ".plasmo/index.d.ts",
     "./**/*.ts",
-    "./**/*.svelte"
+    "./**/*.svelte",
   ],
   "compilerOptions": {
     "paths": {
@@ -15,6 +15,6 @@
       ]
     },
     "baseUrl": ".",
-    "types": ["svelte", "chrome", "firefox-webext-browser"]
+    "types": ["svelte", "chrome", "firefox-webext-browser", "node"]
   }
 }