Add types

packages/design-system/src/components/table/useTable/useAllowedList/index.ts

@@ -18,7 +18,10 @@
  */
 import { useRef, useEffect, useCallback, useState } from 'react';
 import { CookieTableData } from '@ps-analysis-tool/common';
-import { CookieStore } from '@ps-analysis-tool/extension/src/localStore';
+import {
+  CookieStore,
+  type AllowedDomainObject,
+} from '@ps-analysis-tool/extension/src/localStore';
 
 /**
  * Internal dependencies.
@@ -60,7 +63,7 @@ const useAllowedList = (
         '/*';
 
       const scope = isIncognito.current ? 'incognito_session_only' : 'regular';
-      const domainObject = {
+      const domainObject: AllowedDomainObject = {
         primaryDomain: domainForAllowList,
         primaryPattern,
         secondaryPattern,
@@ -74,8 +77,8 @@ const useAllowedList = (
 
         CookieStore.removeDomainFromAllowList(domainObject).then(() => {
           // Set remaining settings after removing one setting.
-          CookieStore.getDomainsInAllowList().then((listOfDomainObject) => {
-            listOfDomainObject.forEach((domainObjectItem) => {
+          CookieStore.getDomainsInAllowList().then((allowedDomainObjects) => {
+            allowedDomainObjects.forEach((domainObjectItem) => {
               chrome.contentSettings.cookies
                 .set({
                   primaryPattern: domainObjectItem.primaryPattern,
@@ -102,9 +105,9 @@ const useAllowedList = (
       }
 
       CookieStore.getDomainsInAllowList()
-        .then((listOfDomainObject) => {
-          console.log(listOfDomainObject, domainForAllowList);
-          listOfDomainObject.forEach((domainObjectItem) => {
+        .then((allowedDomainObjects) => {
+          console.log(allowedDomainObjects, domainForAllowList);
+          allowedDomainObjects.forEach((domainObjectItem) => {
             // Check if more specific patterns was added to allow-list,
             // and remove it as the general pattern will be applied.
             if (
@@ -118,8 +121,8 @@ const useAllowedList = (
                 () => {
                   // Set remaining settings after removing one setting.
                   CookieStore.getDomainsInAllowList().then(
-                    (newListOfDomainObject) => {
-                      newListOfDomainObject.forEach((newDomainObjectItem) => {
+                    (newallowedDomainObjects) => {
+                      newallowedDomainObjects.forEach((newDomainObjectItem) => {
                         chrome.contentSettings.cookies
                           .set({
                             primaryPattern: newDomainObjectItem.primaryPattern,
@@ -232,26 +235,29 @@ const useAllowedList = (
     );
 
     // Set whether the domain is a subdomain match or the exact match.
-    allowListSessionStorage.then((listOfDomainObject) => {
-      let parentDomainValue = '';
-      const numberOfDomainsInAllowList = listOfDomainObject
-        ? listOfDomainObject.length
-        : 0;
+    allowListSessionStorage.then(
+      (allowedDomainObjects: AllowedDomainObject[]) => {
+        let parentDomainValue = '';
 
-      for (let i = 0; i < numberOfDomainsInAllowList; i++) {
-        if (
-          domain.endsWith(listOfDomainObject[i].primaryDomain) &&
-          domain !== listOfDomainObject[i].primaryDomain
-        ) {
-          parentDomainValue = listOfDomainObject[i].primaryDomain;
-          break;
+        if (!allowedDomainObjects || allowedDomainObjects?.length === 0) {
+          return;
         }
-      }
 
-      if (parentDomain !== parentDomainValue) {
-        setParentDomain(parentDomainValue);
+        for (let i = 0; i < allowedDomainObjects.length; i++) {
+          if (
+            domain.endsWith(allowedDomainObjects[i].primaryDomain) &&
+            domain !== allowedDomainObjects[i].primaryDomain
+          ) {
+            parentDomainValue = allowedDomainObjects[i].primaryDomain;
+            break;
+          }
+        }
+
+        if (parentDomain !== parentDomainValue) {
+          setParentDomain(parentDomainValue);
+        }
       }
-    });
+    );
   }, [
     row,
     domain,

packages/extension/src/localStore/cookieStore.ts

@@ -27,12 +27,14 @@ import type { Protocol } from 'devtools-protocol';
  * Internal dependencies.
  */
 import updateStorage from './utils/updateStorage';
-import type { TabData } from './types';
+import type {
+  TabData,
+  AllowedDomainObject,
+  AllowedDomainStorage,
+} from './types';
 import fetchTopicsTaxonomy from '../utils/fetchTopicsTaxonomy';
 import updateCookieBadgeText from './utils/updateCookieBadgeText';
-import getIndexForAllowListedItem, {
-  type AllowListedStorage,
-} from './utils/getIndexForAllowListedItem';
+import getIndexForAllowListedItem from './utils/getIndexForAllowListedItem';
 
 const CookieStore = {
   /**
@@ -347,17 +349,17 @@ const CookieStore = {
 
   /**
    * Add domain to allow-list.
-   * @param {Record<string, string>} domainObject The domain to be added to allow-list.
+   * @param {AllowedDomainObject} domainObject The domain to be added to allow-list.
    */
-  async addDomainToAllowList(domainObject: Record<string, string>) {
+  async addDomainToAllowList(domainObject: AllowedDomainObject) {
     const storage = await chrome.storage.session.get();
 
     if (!storage.allowList) {
       storage.allowList = [];
     }
 
     const index = getIndexForAllowListedItem(
-      storage as AllowListedStorage,
+      storage as AllowedDomainStorage,
       domainObject
     );
 
@@ -370,17 +372,17 @@ const CookieStore = {
 
   /**
    * Remove domain from allow-list.
-   * @param {Record<string, string>} domainObject The domain to be removed from allow-list.
+   * @param {AllowedDomainObject} domainObject The domain to be removed from allow-list.
    */
-  async removeDomainFromAllowList(domainObject: Record<string, string>) {
+  async removeDomainFromAllowList(domainObject: AllowedDomainObject) {
     const storage = await chrome.storage.session.get();
 
     if (!storage?.allowList || storage?.allowList?.length === 0) {
       return;
     }
 
     const indexToRemove = getIndexForAllowListedItem(
-      storage as AllowListedStorage,
+      storage as AllowedDomainStorage,
       domainObject
     );
 
@@ -395,7 +397,7 @@ const CookieStore = {
    * Get domains in allow-list.
    * @returns {Promise<Record<string, string>>} Set of domains in allow-list.
    */
-  async getDomainsInAllowList(): Promise<Record<string, string>[]> {
+  async getDomainsInAllowList(): Promise<AllowedDomainObject[] | []> {
     const storage = await chrome.storage.session.get();
 
     return storage.allowList ?? [];

packages/extension/src/localStore/types.ts

@@ -38,3 +38,14 @@ export type TabData = {
 export type Storage = {
   [tabId: string]: TabData;
 };
+
+export type AllowedDomainObject = {
+  primaryDomain: string;
+  primaryPattern: string;
+  secondaryPattern: string;
+  scope: string;
+};
+
+export type AllowedDomainStorage = {
+  allowList: AllowedDomainObject[];
+};

packages/extension/src/localStore/utils/getIndexForAllowListedItem.ts

@@ -13,14 +13,14 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
-export interface AllowListedStorage {
-  allowList: Record<string, string>[];
-}
+/**
+ * Internal dependencies.
+ */
+import type { AllowedDomainObject, AllowedDomainStorage } from '../types';
 
 const getIndexForAllowListedItem = (
-  storage: AllowListedStorage,
-  domainObject: Record<string, string>
+  storage: AllowedDomainStorage,
+  domainObject: AllowedDomainObject
 ): number => {
   let index = -1;