Moved constants and functions related to projects from common_storage.ts to project.ts.

Author: lizlooney

src/App.tsx

@@ -39,6 +39,7 @@ import { extendedPythonGenerator } from './editor/extended_python_generator';
 
 import * as commonStorage from './storage/common_storage';
 import * as storageModule from './storage/module';
+import * as storageProject from './storage/project';
 import * as clientSideStorage from './storage/client_side_storage';
 
 import * as CustomBlocks from './blocks/setup_custom_blocks';
@@ -130,7 +131,7 @@ const App: React.FC = (): React.JSX.Element => {
  * App wrapper that manages project state and provides it to UserSettingsProvider.
  */
 const AppWithUserSettings: React.FC<{ storage: commonStorage.Storage }> = ({ storage }) => {
-  const [project, setProject] = React.useState<commonStorage.Project | null>(null);
+  const [project, setProject] = React.useState<storageProject.Project | null>(null);
 
   return (
     <UserSettingsProvider
@@ -146,8 +147,8 @@ const AppWithUserSettings: React.FC<{ storage: commonStorage.Storage }> = ({ sto
  * Inner application content component that has access to UserSettings context.
  */
 interface AppContentProps {
-  project: commonStorage.Project | null;
-  setProject: React.Dispatch<React.SetStateAction<commonStorage.Project | null>>;
+  project: storageProject.Project | null;
+  setProject: React.Dispatch<React.SetStateAction<storageProject.Project | null>>;
 }
 
 const AppContent: React.FC<AppContentProps> = ({ project, setProject }): React.JSX.Element => {
@@ -360,7 +361,7 @@ const AppContent: React.FC<AppContentProps> = ({ project, setProject }): React.J
   };
 
   /** Creates tab items from project data. */
-  const createTabItemsFromProject = (projectData: commonStorage.Project): Tabs.TabItem[] => {
+  const createTabItemsFromProject = (projectData: storageProject.Project): Tabs.TabItem[] => {
     const tabs: Tabs.TabItem[] = [
       {
         key: projectData.robot.modulePath,

src/editor/editor.ts

@@ -26,6 +26,7 @@ import { GeneratorContext } from './generator_context';
 import * as commonStorage from '../storage/common_storage';
 import * as storageModule from '../storage/module';
 import * as storageNames from '../storage/names';
+import * as storageProject from '../storage/project';
 import * as eventHandler from '../blocks/mrc_event_handler';
 import * as classMethodDef from '../blocks/mrc_class_method_def';
 import * as mechanismComponentHolder from '../blocks/mrc_mechanism_component_holder';
@@ -48,7 +49,7 @@ export class Editor {
   private generatorContext: GeneratorContext;
   private storage: commonStorage.Storage;
   private currentModule: storageModule.Module | null = null;
-  private currentProject: commonStorage.Project | null = null;
+  private currentProject: storageProject.Project | null = null;
   private modulePath: string = '';
   private robotPath: string = '';
   private moduleContentText: string = '';
@@ -122,7 +123,7 @@ export class Editor {
 
   public async loadModuleBlocks(
       currentModule: storageModule.Module | null,
-      currentProject: commonStorage.Project | null) {
+      currentProject: storageProject.Project | null) {
     this.generatorContext.setModule(currentModule);
     this.currentModule = currentModule;
     this.currentProject = currentProject;

src/reactComponents/AddTabDialog.tsx

@@ -25,6 +25,7 @@ import * as I18Next from 'react-i18next';
 import * as React from 'react';
 import * as commonStorage from '../storage/common_storage';
 import * as storageModule from '../storage/module';
+import * as storageProject from '../storage/project';
 import ClassNameComponent from './ClassNameComponent';
 
 /** Represents a module item in the dialog. */
@@ -39,8 +40,8 @@ interface AddTabDialogProps {
   isOpen: boolean;
   onOk: (newTabs: TabItem[]) => void;
   onCancel: () => void;
-  project: commonStorage.Project | null;
-  setProject: (project: commonStorage.Project | null) => void;
+  project: storageProject.Project | null;
+  setProject: (project: storageProject.Project | null) => void;
   currentTabs: TabItem[];
   storage: commonStorage.Storage | null;
 }
@@ -132,10 +133,10 @@ export default function AddTabDialog(props: AddTabDialogProps) {
       storageModule.MODULE_TYPE_MECHANISM :
       storageModule.MODULE_TYPE_OPMODE;
 
-    await commonStorage.addModuleToProject(
+    await storageProject.addModuleToProject(
         props.storage, props.project, storageType, newClassName);
 
-    const newModule = commonStorage.findModuleByClassName(props.project, newClassName);
+    const newModule = storageProject.findModuleByClassName(props.project, newClassName);
     if (newModule) {
       const module: Module = {
         path: newModule.modulePath,

src/reactComponents/ClassNameComponent.tsx

@@ -24,14 +24,15 @@ import * as Antd from 'antd';
 import * as I18Next from 'react-i18next';
 import * as React from 'react';
 import * as commonStorage from '../storage/common_storage';
+import * as storageProject from '../storage/project';
 
 /** Props for the ClassNameComponent. */
 interface ClassNameComponentProps {
   tabType: TabType;
   newItemName: string;
   setNewItemName: (name: string) => void;
   onAddNewItem: () => void;
-  project: commonStorage.Project | null;
+  project: storageProject.Project | null;
   storage: commonStorage.Storage | null;
   buttonLabel: string;
 }
@@ -65,7 +66,7 @@ export default function ClassNameComponent(props: ClassNameComponentProps): Reac
       return;
     }
 
-    const {ok, error} = commonStorage.isClassNameOk(props.project, newClassName);
+    const {ok, error} = storageProject.isClassNameOk(props.project, newClassName);
     if (ok) {
       clearError();
       props.onAddNewItem();

src/reactComponents/FileManageModal.tsx

@@ -24,6 +24,7 @@ import * as I18Next from 'react-i18next';
 import * as React from 'react';
 import * as commonStorage from '../storage/common_storage';
 import * as storageModule from '../storage/module';
+import * as storageProject from '../storage/project';
 import {EditOutlined, DeleteOutlined, CopyOutlined} from '@ant-design/icons';
 import ClassNameComponent from './ClassNameComponent';
 
@@ -38,8 +39,8 @@ interface Module {
 interface FileManageModalProps {
   isOpen: boolean;
   onCancel: () => void;
-  project: commonStorage.Project | null;
-  setProject: (project: commonStorage.Project | null) => void;
+  project: storageProject.Project | null;
+  setProject: (project: storageProject.Project | null) => void;
   gotoTab: (path: string) => void;
   setAlertErrorMessage: (message: string) => void;
   storage: commonStorage.Storage | null;
@@ -107,7 +108,7 @@ export default function FileManageModal(props: FileManageModalProps) {
     }
 
     try {
-      const newModulePath = await commonStorage.renameModuleInProject(
+      const newModulePath = await storageProject.renameModuleInProject(
           props.storage,
           props.project,
           newClassName,
@@ -138,7 +139,7 @@ export default function FileManageModal(props: FileManageModalProps) {
     }
 
     try {
-      const newModulePath = await commonStorage.copyModuleInProject(
+      const newModulePath = await storageProject.copyModuleInProject(
           props.storage,
           props.project,
           newClassName,
@@ -180,14 +181,14 @@ export default function FileManageModal(props: FileManageModalProps) {
       storageModule.MODULE_TYPE_MECHANISM :
       storageModule.MODULE_TYPE_OPMODE;
 
-    await commonStorage.addModuleToProject(
+    await storageProject.addModuleToProject(
         props.storage,
         props.project,
         storageType,
         newClassName
     );
 
-    const newModule = commonStorage.findModuleByClassName(props.project, newClassName);
+    const newModule = storageProject.findModuleByClassName(props.project, newClassName);
     if (newModule) {
       const module: Module = {
         path: newModule.modulePath,
@@ -206,7 +207,7 @@ export default function FileManageModal(props: FileManageModalProps) {
     setModules(newModules);
 
     if (props.storage && props.project) {
-      await commonStorage.removeModuleFromProject(
+      await storageProject.removeModuleFromProject(
           props.storage,
           props.project,
           record.path

src/reactComponents/Header.tsx

@@ -19,7 +19,7 @@
  * @author [email protected] (Alan Smith)
  */
 import * as Antd from 'antd';
-import * as commonStorage from '../storage/common_storage';
+import * as storageProject from '../storage/project';
 import * as React from 'react';
 import { useTranslation } from 'react-i18next';
 
@@ -30,7 +30,7 @@ type StringFunction = (input: string) => void;
 interface HeaderProps {
   alertErrorMessage: string;
   setAlertErrorMessage: StringFunction;
-  project: commonStorage.Project | null;
+  project: storageProject.Project | null;
 }
 
 /** Height of the logo image in pixels. */

src/reactComponents/Menu.tsx

@@ -23,6 +23,7 @@ import * as React from 'react';
 import { RcFile, UploadRequestOption } from 'rc-upload/lib/interface';
 import * as commonStorage from '../storage/common_storage';
 import * as storageNames from '../storage/names';
+import * as storageProject from '../storage/project';
 import * as createPythonFiles from '../storage/create_python_files';
 import * as I18Next from 'react-i18next';
 import {TabType } from '../types/TabType';
@@ -56,9 +57,9 @@ export interface MenuProps {
   setAlertErrorMessage: (message: string) => void;
   storage: commonStorage.Storage | null;
   gotoTab: (tabKey: string) => void;
-  project: commonStorage.Project | null;
+  project: storageProject.Project | null;
   openWPIToolboxSettings: () => void;
-  setProject: (project: commonStorage.Project | null) => void;
+  setProject: (project: storageProject.Project | null) => void;
   theme: string;
   setTheme: (theme: string) => void;
 }
@@ -100,7 +101,7 @@ function getDivider(): MenuItem {
 /**
  * Generates menu items for a given project.
  */
-function getMenuItems(t: (key: string) => string, project: commonStorage.Project, currentLanguage: string): MenuItem[] {
+function getMenuItems(t: (key: string) => string, project: storageProject.Project, currentLanguage: string): MenuItem[] {
   const mechanisms: MenuItem[] = [];
   const opmodes: MenuItem[] = [];
 
@@ -176,7 +177,7 @@ function getMenuItems(t: (key: string) => string, project: commonStorage.Project
 export function Component(props: MenuProps): React.JSX.Element {
   const {t, i18n} = I18Next.useTranslation();
 
-  const [projects, setProjects] = React.useState<commonStorage.Project[]>([]);
+  const [projects, setProjects] = React.useState<storageProject.Project[]>([]);
   const [menuItems, setMenuItems] = React.useState<MenuItem[]>([]);
   const [fileModalOpen, setFileModalOpen] = React.useState<boolean>(false);
   const [projectModalOpen, setProjectModalOpen] = React.useState<boolean>(false);
@@ -191,7 +192,7 @@ export function Component(props: MenuProps): React.JSX.Element {
   };
 
   /** Fetches the list of projects from storage. */
-  const fetchListOfProjects = async (): Promise<commonStorage.Project[]> => {
+  const fetchListOfProjects = async (): Promise<storageProject.Project[]> => {
     return new Promise(async (resolve, reject) => {
       if (!props.storage) {
         reject(new Error('Storage not available'));
@@ -252,7 +253,7 @@ export function Component(props: MenuProps): React.JSX.Element {
   /** Handles menu item clicks. */
   const handleClick: Antd.MenuProps['onClick'] = ({key}): void => {
     const newModule = props.project ?
-      commonStorage.findModuleByModulePath(props.project, key) :
+      storageProject.findModuleByModulePath(props.project, key) :
       null;
 
     if (newModule) {
@@ -386,7 +387,7 @@ export function Component(props: MenuProps): React.JSX.Element {
             existingProjectNames.push(project.projectName);
           });
           const file = options.file as RcFile;
-          const uploadProjectName = commonStorage.makeUploadProjectName(file.name, existingProjectNames);
+          const uploadProjectName = storageProject.makeUploadProjectName(file.name, existingProjectNames);
           if (props.storage) {
             props.storage.uploadProject(uploadProjectName, dataUrl);
           }