Add obj types as common constants

jsajal · jsajal · commit e631be9c0819 · 2024-03-15T10:02:54.000-07:00
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -21,7 +21,10 @@ module.exports = {
     sourceType: 'module',
   },
   plugins: ['react', 'react-hooks', 'prettier'],
-  rules: {},
+  rules: {
+    'react/prop-types': 'off', // keeping off for first phase
+    'no-unused-vars': 'off', // Getting a lot of Error for: '_' is assigned a value but never used  no-unused-vars. For now disabling this because  need to understand more about the use '_'.
+  },
   settings: {
     'import/resolver': {
       node: {
diff --git a/src/components/molecules/workspaceDirectory/Directories.js b/src/components/molecules/workspaceDirectory/Directories.js
@@ -4,6 +4,7 @@ import Directory from 'components/molecules/workspaceDirectory/Directory';
 import { DirectoryOptionsActions } from 'constants/WorkspaceDirectory';
 import NewLabelModal from '../modals/workspaceDirectory/NewLabelModal';
 import { deleteCollection, deleteFolder, deleteFlowTest } from 'service/collection';
+import { OBJ_TYPES } from 'constants/Common';
 
 const Directories = ({ collections }) => {
   const [newLabelModalOpen, setNewLabelModal] = useState(false);
@@ -12,7 +13,7 @@ const Directories = ({ collections }) => {
   const [selectedCollectionId, setSelectedCollectionId] = useState('');
 
   const handleDeleteMenuItem = (menuItemType, path, collectionId) => {
-    if (menuItemType === 'collection') {
+    if (menuItemType === OBJ_TYPES.collection) {
       deleteCollection(collectionId)
         .then((result) => {
           console.log(`Deleted collection: collectionId = ${collectionId}`);
@@ -23,7 +24,7 @@ const Directories = ({ collections }) => {
         });
     }
 
-    if (menuItemType === 'folder') {
+    if (menuItemType === OBJ_TYPES.folder) {
       deleteFolder(path, collectionId)
         .then((result) => {
           console.log(`Deleted folder: path = ${path}, collectionId = ${collectionId}`);
@@ -34,7 +35,7 @@ const Directories = ({ collections }) => {
         });
     }
 
-    if (menuItemType === 'file') {
+    if (menuItemType === OBJ_TYPES.flowtest) {
       deleteFlowTest(path, collectionId)
         .then((result) => {
           console.log(`Deleted flowtest: path = ${path}, collectionId = ${collectionId}`);
diff --git a/src/components/molecules/workspaceDirectory/Directory.js b/src/components/molecules/workspaceDirectory/Directory.js
@@ -1,6 +1,6 @@
 import React, { useState } from 'react';
 import { PropTypes } from 'prop-types';
-import { FLOW_FILE_SUFFIX_REGEX } from 'constants/Common';
+import { FLOW_FILE_SUFFIX_REGEX, OBJ_TYPES } from 'constants/Common';
 import { ArchiveBoxIcon, FolderIcon, DocumentIcon } from '@heroicons/react/24/outline';
 import OptionsMenu from './OptionsMenu';
 import { readFlowTest } from 'service/collection';
@@ -9,7 +9,7 @@ const Directory = ({ collectionId, item, depth }) => {
   const [isExpanded, setIsExpanded] = useState(false);
 
   const getListDisplayTitle = () => {
-    if (item.type === 'collection') {
+    if (item.type === OBJ_TYPES.collection) {
       // this is for collections tab thus we have archive box icon
       return (
         <div
@@ -29,14 +29,14 @@ const Directory = ({ collectionId, item, depth }) => {
           <OptionsMenu
             data-click-from='options-menu'
             directory={item}
-            data-item-type='collections'
-            itemType={'collection'}
+            data-item-type={OBJ_TYPES.collection}
+            itemType={OBJ_TYPES.collection}
           />
         </div>
       );
     }
 
-    if (item.type === 'flowtest' && item.name.match(FLOW_FILE_SUFFIX_REGEX)) {
+    if (item.type === OBJ_TYPES.flowtest && item.name.match(FLOW_FILE_SUFFIX_REGEX)) {
       return (
         <div
           className='flex items-center justify-between gap-2 text-balance rounded p-0 text-start transition duration-200 ease-out hover:bg-slate-100'
@@ -57,12 +57,17 @@ const Directory = ({ collectionId, item, depth }) => {
             <DocumentIcon className='h-4 w-4' />
             <span>{item.name}</span>
           </div>
-          <OptionsMenu data-click-from='options-menu' directory={item} data-item-type='file' itemType={'file'} />
+          <OptionsMenu
+            data-click-from='options-menu'
+            directory={item}
+            data-item-type={OBJ_TYPES.flowtest}
+            itemType={OBJ_TYPES.flowtest}
+          />
         </div>
       );
     }
 
-    if (item.type === 'folder') {
+    if (item.type === OBJ_TYPES.folder) {
       return (
         <div
           className='flex items-center justify-between gap-2 text-balance rounded p-0 text-start transition duration-200 ease-out hover:bg-slate-100'
@@ -77,7 +82,12 @@ const Directory = ({ collectionId, item, depth }) => {
             <FolderIcon className='h-4 w-4' />
             <span data-type-name={item.type}>{item.name}</span>
           </div>
-          <OptionsMenu data-click-from='options-menu' directory={item} data-item-type='folder' itemType={'folder'} />
+          <OptionsMenu
+            data-click-from='options-menu'
+            directory={item}
+            data-item-type={OBJ_TYPES.folder}
+            itemType={OBJ_TYPES.folder}
+          />
         </div>
       );
     }
diff --git a/src/constants/Common.js b/src/constants/Common.js
@@ -16,3 +16,10 @@ export const BUTTON_TYPES = {
   warning: 'warning',
   error: 'error',
 };
+
+export const OBJ_TYPES = {
+  collection: 'collection',
+  flowtest: 'flowtest',
+  folder: 'folder',
+  environment: 'environment',
+};
diff --git a/src/service/collection.js b/src/service/collection.js
@@ -2,6 +2,7 @@ import useCollectionStore from '../stores/CollectionStore';
 import { v4 as uuidv4 } from 'uuid';
 import { findItemInCollectionByPathname } from 'stores/utils';
 import { useEventStore } from 'stores/EventListenerStore';
+import { OBJ_TYPES } from 'constants/Common';
 
 export const createCollection = (openAPISpecFilePath, collectionFolderPath) => {
   const { ipcRenderer } = window;
@@ -40,7 +41,7 @@ export const createFolder = (folderName, folderPath, collectionId) => {
     const collection = useCollectionStore.getState().collections.find((c) => c.id === collectionId);
     if (collection) {
       const folderPathItem = findItemInCollectionByPathname(collection, folderPath);
-      const sameFolderExists = folderPathItem.items.find((i) => i.type === 'folder' && i.name === folderName);
+      const sameFolderExists = folderPathItem.items.find((i) => i.type === OBJ_TYPES.folder && i.name === folderName);
       if (sameFolderExists) {
         return Promise.reject(new Error('A folder with the same name already exists'));
       } else {
@@ -153,7 +154,9 @@ export const createFlowTest = (name, folderPath, collectionId) => {
     const collection = useCollectionStore.getState().collections.find((c) => c.id === collectionId);
     if (collection) {
       const folderPathItem = findItemInCollectionByPathname(collection, folderPath);
-      const sameFlowTestExists = folderPathItem.items.find((i) => i.type === 'flowtest' && i.name === `${name}.flow`);
+      const sameFlowTestExists = folderPathItem.items.find(
+        (i) => i.type === OBJ_TYPES.flowtest && i.name === `${name}.flow`,
+      );
       if (sameFlowTestExists) {
         return Promise.reject(new Error('A flowtest with the same name already exists'));
       } else {
diff --git a/src/stores/CollectionStore.js b/src/stores/CollectionStore.js
@@ -9,14 +9,15 @@ import {
 } from './utils.js';
 import { useEventStore } from './EventListenerStore.js';
 import { useTabStore } from './TabStore.js';
+import { OBJ_TYPES } from 'constants/Common.js';
 
 const useCollectionStore = create((set, get) => ({
   collections: [],
   createCollection: (id, name, pathname, nodes) => {
     const collectionObj = {
       version: '1',
       id: id,
-      type: 'collection',
+      type: OBJ_TYPES.collection,
       name: name,
       pathname: pathname,
       nodes: nodes,
@@ -44,13 +45,13 @@ const useCollectionStore = create((set, get) => ({
           let currentPath = collection.pathname;
           let currentSubItems = collection.items;
           for (const directoryName of subDirsFromRoot) {
-            let childItem = currentSubItems.find((f) => f.type === 'folder' && f.name === directoryName);
+            let childItem = currentSubItems.find((f) => f.type === OBJ_TYPES.folder && f.name === directoryName);
             if (!childItem) {
               childItem = {
                 id: uuidv4(),
                 pathname: `${currentPath}${PATH_SEPARATOR}${directoryName}`,
                 name: directoryName,
-                type: 'folder',
+                type: OBJ_TYPES.folder,
                 items: [],
               };
               currentSubItems.push(childItem);
@@ -78,7 +79,7 @@ const useCollectionStore = create((set, get) => ({
 
             if (item) {
               const flowTestIds = flattenItems(item.items).map((i) => {
-                if (i.type !== 'folder') {
+                if (i.type !== OBJ_TYPES.folder) {
                   i.id;
                 }
               });
@@ -107,7 +108,7 @@ const useCollectionStore = create((set, get) => ({
         const timestamp = Date.now();
         const env = {
           id: uuidv4(),
-          type: 'environment',
+          type: OBJ_TYPES.environment,
           createdAt: timestamp,
           modifiedAt: timestamp,
           ...file,
@@ -160,13 +161,13 @@ const useCollectionStore = create((set, get) => ({
           let currentPath = collection.pathname;
           let currentSubItems = collection.items;
           for (const directoryName of file.subDirectories) {
-            let childItem = currentSubItems.find((f) => f.type === 'folder' && f.name === directoryName);
+            let childItem = currentSubItems.find((f) => f.type === OBJ_TYPES.folder && f.name === directoryName);
             if (!childItem) {
               childItem = {
                 id: uuidv4(),
                 pathname: `${currentPath}${PATH_SEPARATOR}${directoryName}`,
                 name: directoryName,
-                type: 'folder',
+                type: OBJ_TYPES.folder,
                 items: [],
               };
               currentSubItems.push(childItem);
@@ -180,7 +181,7 @@ const useCollectionStore = create((set, get) => ({
             const timestamp = Date.now();
             const flowtest = {
               id: uuidv4(),
-              type: 'flowtest',
+              type: OBJ_TYPES.flowtest,
               createdAt: timestamp,
               modifiedAt: timestamp,
               name: file.name,
